SignClient class

Implemented types

• ISignClient

Constructors

SignClient({required ICore core, required PairingMetadata metadata})

Properties

core → ICore

no setter, override

engine ↔ ISignEngine

getter/setter pair, override-getter

hashCode → int

The hash code for this object.

no setter, inherited

metadata → PairingMetadata

no setter, override

onProposalExpire → Event<SessionProposalEvent>

no setter, override

onSessionConnect → Event<SessionConnect>

no setter, override

onSessionDelete → Event<SessionDelete>

no setter, override

onSessionEvent → Event<SessionEvent>

no setter, override

onSessionExpire → Event<SessionExpire>

no setter, override

onSessionExtend → Event<SessionExtend>

no setter, override

onSessionPing → Event<SessionPing>

no setter, override

onSessionProposal → Event<SessionProposalEvent>

no setter, override

onSessionProposalError → Event<SessionProposalErrorEvent>

no setter, override

onSessionRequest → Event<SessionRequestEvent>

no setter, override

onSessionUpdate → Event<SessionUpdate>

no setter, override

pairings → IPairingStore

no setter, override

pendingRequests → IGenericStore<SessionRequest>

no setter, override

proposals → IGenericStore<ProposalData>

no setter, override

protocol → String

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sessions → ISessions

no setter, override

version → int

final

Methods

approve({required int id, required Map<String, Namespace> namespaces, String? relayProtocol}) → Future<ApproveResponse>

override

connect({Map<String, RequiredNamespace>? requiredNamespaces, Map<String, RequiredNamespace>? optionalNamespaces, Map<String, String>? sessionProperties, String? pairingTopic, List<Relay>? relays, List<List<String>>? methods = SignEngine.DEFAULT_METHODS}) → Future<ConnectResponse>

override

disconnect({required String topic, required WalletConnectError reason}) → Future<void>

override

emit({required String topic, required String chainId, required SessionEventParams event}) → Future<void>

override

extend({required String topic}) → Future<void>

override

find({required Map<String, RequiredNamespace> requiredNamespaces}) → SessionData?

override

getActiveSessions() → Map<String, SessionData>

override

getPendingSessionProposals() → Map<String, ProposalData>

override

getPendingSessionRequests() → Map<String, SessionRequest>

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

pair({required Uri uri}) → Future<PairingInfo>

override

ping({required String topic}) → Future<void>

override

registerAccount({required String chainId, required String accountAddress}) → void

Register accounts for a given namespace or chainId. Used to construct the Namespaces map for the session proposal. Each account must follow the namespace:chainId:address format or this will throw an error.

override

registerEventEmitter({required String chainId, required String event}) → void

Register event emitters for a given namespace or chainId Used to construct the Namespaces map for the session proposal

override

registerEventHandler({required String chainId, required String event, dynamic handler(String, dynamic)?}) → void

override

registerRequestHandler({required String chainId, required String method, void handler(String, dynamic)?}) → void

override

reject({required int id, required WalletConnectError reason}) → Future<void>

override

request({required String topic, required String chainId, required SessionRequestParams request}) → Future

override

respond({required String topic, required JsonRpcResponse response}) → Future<void>

override

toString() → String

A string representation of this object.

inherited

update({required String topic, required Map<String, Namespace> namespaces}) → Future<void>

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

createInstance({required String projectId, String relayUrl = WalletConnectConstants.DEFAULT_RELAY_URL, required PairingMetadata metadata, bool memoryStore = false}) → Future<SignClient>