@disco3/connect-wallet
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Connector
    • WalletLink

Index

Constructors

Properties

Methods

Constructors

constructor

  • new WalletLink(actions: Actions, options: WalletLinkOptions & { url: string }, connectEagerly?: boolean): WalletLink

  • Parameters

    • actions: Actions
    • options: WalletLinkOptions & { url: string }

      Options to pass to walletlink

    • Default value connectEagerly: boolean = true

      A flag indicating whether connection should be initiated when the class is constructed.

    Returns WalletLink

Properties

Protected Readonly actions

actions: Actions

provider

provider: ReturnType<WalletLinkInstance["makeWeb3Provider"]> | undefined

{@inheritdoc Connector.provider}

walletLink

walletLink: WalletLinkInstance | undefined

A walletlink instance.

Methods

activate

  • activate(desiredChainIdOrChainParameters?: number | AddEthereumChainParameter): Promise<void>

  • Initiates a connection.

    Parameters

    • Optional desiredChainIdOrChainParameters: number | AddEthereumChainParameter

      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 one of two conditions is met: either they already have it added, or the argument is of type AddEthereumChainParameter, in which case the user will be prompted to add the chain with the specified parameters first, before being prompted to switch.

    Returns Promise<void>

deactivate

  • deactivate(): void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Protected property
  • Static property

Generated using TypeDoc