WalletConnect | @disco3/connect-wallet

Hierarchy

Connector
- WalletConnect

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WalletConnect(actions: Actions, options: IWCEthRpcConnectionOptions, connectEagerly?: boolean, treatModalCloseAsError?: boolean): WalletConnect

Overrides Connector.__constructor
- Defined in packages/walletconnect/src/index.ts:21
Parameters
- actions: Actions
- options: IWCEthRpcConnectionOptions
  
  Options to pass to @walletconnect/ethereum-provider
- Default value connectEagerly: boolean = true
  
  A flag indicating whether connection should be initiated when the class is constructed.
- Default value treatModalCloseAsError: boolean = true
Returns WalletConnect

Properties

Protected Readonly actions

actions: Actions

provider

provider: MockWalletConnectProvider | undefined

{@inheritdoc Connector.provider}

Methods

activate

activate(desiredChainId?: undefined | number): Promise<void>

Overrides Connector.activate
- Defined in packages/walletconnect/src/index.ts:103
Initiates a connection.

Parameters
- Optional desiredChainId: undefined | number
  
  If defined, indicates the desired chain to connect to. If the user is already connected to this chain, no additional steps will be taken. Otherwise, the user will be prompted to switch to the chain, if their wallet supports it.
Returns Promise<void>

deactivate

deactivate(error?: Error): Promise<void>

Overrides EIP1193.deactivate
- Defined in packages/walletconnect/src/index.ts:177
{@inheritdoc Connector.deactivate}

Parameters
- Optional error: Error
Returns Promise<void>

Generated using TypeDoc