Web3ModalService class

Inheritance

• Object
• ChangeNotifier
• Web3ModalService

Implemented types

• IWeb3ModalService

Constructors

Web3ModalService({IWeb3App? web3App, String? projectId, PairingMetadata? metadata, Map<String, RequiredNamespace>? requiredNamespaces, IExplorerService? explorerService, Set<String>? recommendedWalletIds, ExcludedWalletState excludedWalletState = ExcludedWalletState.list, Set<String>? excludedWalletIds})

Creates a new instance of Web3ModalService. web3App is optional and can be used to pass in an already created Web3App. projectId and metadata are optional and can be used to create a new Web3App. You must provide either a projectId and metadata or an already created web3App, or this will throw an ArgumentError. requiredNamespaces is optional and can be used to pass in a custom set of required namespaces. explorerService is optional and can be used to pass in a custom IExplorerService. recommendedWalletIds is optional and can be used to pass in a custom set of recommended wallet IDs. excludedWalletState is optional and can be used to pass in a custom ExcludedWalletState. excludedWalletIds is optional and can be used to pass in a custom set of excluded wallet IDs.

Properties

address → String?

The address of the currently connected account.

no setter, override

connectResponse ↔ ConnectResponse?

getter/setter pair

context ↔ BuildContext?

getter/setter pair

didDispose → Future<Null>

A Future that will complete when this object has been disposed.

no setter, inherited

disposableTypeName → String

A type name, similar to runtimeType but intended to work with minified code.

no setter, inherited

disposalTreeSize → int

The total size of the disposal tree rooted at the current Disposable instance.

no setter, inherited

explorerService ↔ IExplorerService

The service used to fetch wallet listings from the explorer API.

getter/setter pair, override-getter

hashCode → int

The hash code for this object.

no setter, inherited

hasListeners → bool

Whether any listeners are currently registered.

no setter, inherited

isConnected → bool

Variable that can be used to check if the web3App is connected

no setter, override

isDisposed → bool

Whether this object has been disposed.

no setter, inherited

isInitialized → bool

Whether or not this object has been initialized.

no setter, override

isLeakFlagSet → bool

Whether the leak flag for this object has been set.

no setter, inherited

isOpen → bool

Variable that can be used to check if the modal is visible on screen.

no setter, override

isOrWillBeDisposed → bool

Whether the disposal of this object has been requested, is in progress, or is complete.

no setter, inherited

projectId → String

The project ID used to initialize the web3App.

no setter, override

requiredNamespaces → Map<String, RequiredNamespace>

The required namespaces that will be used when connecting to the wallet

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

session → SessionData?

The current session's data.

no setter, override

wcUri → String?

The URI that can be used to connect to this dApp. This is only available after the open function is called.

no setter, override

web3App → IWeb3App?

The object that manages sessions, authentication, events, and requests for WalletConnect.

no setter, override

Methods

addListener(VoidCallback listener) → void

Register a closure to be called when the object changes.

inherited

awaitBeforeDispose<T>(Future<T> future) → Future<T>

Add future to a list of futures that will be awaited before the object is disposed.

inherited

close() → void

Closes the modal.

override

disconnect() → Future<void>

Disconnects the session and pairing, if any. If there is no session, this does nothing.

override

dispose() → Future<Null>

Dispose of the object, cleaning up to prevent memory leaks.

inherited

flagLeak([String? description]) → void

Flag the object as having been disposed in a way that allows easier profiling.

inherited

getManagedDelayedFuture<T>(Duration duration, T callback()) → Future<T>

Creates a Future that will complete, with the value returned by callback, after the given amount of time has elapsed.

inherited

getManagedDisposer(Disposer disposer) → ManagedDisposer

Automatically handle arbitrary disposals using a callback.

inherited

getManagedPeriodicTimer(Duration duration, void callback(Timer timer)) → Timer

Creates a periodic Timer that will be cancelled if active upon disposal.

inherited

getManagedTimer(Duration duration, void callback()) → Timer

Creates a Timer instance that will be cancelled if active upon disposal.

inherited

getReferer() → String

Gets the name of the currently connected wallet.

override

init() → Future<void>

The current connection state of the modal. Used by the connect button to render the correct UI. The current state of the modal. The list of wallets from the explorer API. Sets up the explorer and the web3App if they already been initialized.

override

launchCurrentWallet() → void

override

listenToStream<T>(Stream<T> stream, void onData(T event), {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<T>

Returns a StreamSubscription which handles events from the stream using the provided onData, onError and onDone handlers.

inherited

manageAndReturnTypedDisposable<T extends Disposable>(T disposable) → T

Automatically dispose another object when this object is disposed.

inherited

manageCompleter<T>(Completer<T> completer) → Completer<T>

Ensure that a completer is completed when the object is disposed.

inherited

manageDisposable(Disposable disposable) → void

inherited

manageStreamController(StreamController controller) → void

Automatically cancel a stream controller when this object is disposed.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notifyListeners() → void

Call all the registered listeners.

inherited

onDispose() → Future<Null>

Callback to allow arbitrary cleanup on dispose.

onWillDispose() → Future<Null>

Callback to allow arbitrary cleanup as soon as disposal is requested (i.e. dispose is called) but prior to disposal actually starting.

inherited

open({required BuildContext context, Web3ModalState? startState}) → Future<void>

Opens the modal with the provided startState. If none is provided, the default state will be used based on platform.

override

removeListener(VoidCallback listener) → void

Remove a previously registered closure from the list of closures that are notified when the object changes.

inherited

setDefaultChain({Web3ModalChains? web3modalChain, Map<String, RequiredNamespace>? requiredNamespaces}) → void

Sets the default chain to use for the session. web3modalChain or requiredNamespaces must be provided, if both are null this function will do nothing.

override

setRequiredNamespaces(Map<String, RequiredNamespace> namespaces) → void

Sets the required namespaces that will be used when connecting to the wallet The default is set to the NamespaceConstants.ethereum namespace.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited