ReownAppKit class

Base class that containes Core and SIgn used dapps developers to create UI-less interaction with WalletConnect protocol

Implemented types

Constructors

ReownAppKit({required IReownCore core, required PairingMetadata metadata})

Properties

authKeys → IGenericStore<AuthPublicKey>
no setteroverride
core → IReownCore
final
hashCode → int
The hash code for this object.
no setterinherited
metadata → PairingMetadata
final
onProposalExpire → Event<SessionProposalEvent>
no setteroverride
onSessionAuthResponse → Event<SessionAuthResponse>
no setteroverride
onSessionConnect → Event<SessionConnect>
no setteroverride
onSessionDelete → Event<SessionDelete>
no setteroverride
onSessionEvent → Event<SessionEvent>
no setteroverride
onSessionExpire → Event<SessionExpire>
no setteroverride
onSessionExtend → Event<SessionExtend>
no setteroverride
onSessionPing → Event<SessionPing>
no setteroverride
onSessionUpdate → Event<SessionUpdate>
no setteroverride
pairings → IPairingStore
no setteroverride
pairingTopics → IGenericStore<String>
no setteroverride
pendingRequests → IGenericStore<SessionRequest>
no setteroverride
proposals → IGenericStore<ProposalData>
no setteroverride
protocol → String
---------- GENERIC ----------///
final
reOwnSign ↔ IReownSign
---------- SIGN ENGINE ----------///
getter/setter pairoverride-getter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sessions → ISessions
no setteroverride
version → int
final

Methods

authenticate({required SessionAuthRequestParams params, String? pairingTopic, String? walletUniversalLink, List<List<String>>? methods = const [[MethodConstants.WC_SESSION_AUTHENTICATE]]}) → Future<SessionAuthRequestResponse>
override
connect({Map<String, RequiredNamespace>? requiredNamespaces, Map<String, RequiredNamespace>? optionalNamespaces, Map<String, String>? sessionProperties, String? pairingTopic, List<Relay>? relays, List<SessionAuthRequestParams>? authentication, List<List<String>>? methods = DEFAULT_METHODS}) → Future<ConnectResponse>
override
disconnectSession({required String topic, required ReownSignError reason}) → Future<void>
override
dispatchEnvelope(String url) → Future<void>
override
formatAuthMessage({required String iss, required CacaoRequestPayload cacaoPayload}) → String
override
getActiveSessions() → Map<String, SessionData>
override
getExchangeDepositStatus({required GetExchangeDepositStatusParams params}) → Future<GetExchangeDepositStatusResult>
ℹ️ Check the status of the deposit/transaction Better to call this in a loop
override
getExchanges({required GetExchangesParams params}) → Future<GetExchangesResult>
ℹ️ Get a list of Exchanges supporting the given configuration Use includeOnly, exclude to filter the results
override
getExchangeUrl({required GetExchangeUrlParams params}) → Future<GetExchangeUrlResult>
ℹ️ Get the deposit/payment URL on the selected exchange
override
getPaymentAssetsForNetwork({String? chainId, bool includeNative = true, bool includeTest = true}) → List<ExchangeAsset>
ℹ️ Get supported assets on the given chainId (CAIP-2) Null value will return all supported assets in all networks
override
getPendingSessionProposals() → Map<String, ProposalData>
override
getSessionsForPairing({required String pairingTopic}) → Map<String, SessionData>
override
init() → Future<void>
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
ping({required String topic}) → Future<void>
override
redirectToWallet({required String topic, required Redirect? redirect}) → Future<bool>
override
registerEventHandler({required String chainId, required String event, void handler(String, dynamic)?}) → void
override
request({int? requestId, required String topic, required String chainId, required SessionRequestParams request}) → Future
override
toString() → String
A string representation of this object.
inherited
validateSignedCacao({required Cacao cacao, required String projectId}) → Future<bool>
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

createInstance({required String projectId, String relayUrl = ReownConstants.DEFAULT_RELAY_URL, required PairingMetadata metadata, bool memoryStore = false, LogLevel logLevel = LogLevel.nothing, HttpWrapper httpClient = const HttpWrapper()}) → Future<ReownAppKit>
Creates a instance of ReownAppKit to be used alone or to pass to ReownAppKitModal

Constants

DEFAULT_METHODS → const List<List<String>>