Class Web3Controller

Readonly options

connected

• get connected(): boolean

• Returns if the controller is connected to a signer

  Returns boolean

isCached

• get isCached(): boolean

• Returns if a provider is cached for the modal

  Returns boolean

name

• get name(): string

• Returns the current application name

  Returns string

provider

• get provider(): Provider

• Returns the currently connected provider interface

  Returns Provider

signer

• get signer(): undefined | Signer

• Returns the signer if available

  Returns undefined | Signer

addChain

• addChain(chainId?, options?): Promise<void>

• Requests to add the specified chain/network to the web3 provider

  Parameters

  • chainId: number = ...

  • options: Partial<ChainOptions> = {}

  Returns Promise<void>

chainId

• chainId(): Promise<number>

• Returns the currently connected chain ID

  Returns Promise<number>

connectWallet

• connectWallet(wallet): Promise<void>

• Connects a wallet directly to the controller

  Parameters

  • wallet: Wallet

  Returns Promise<void>

disconnect

• disconnect(code?, message?, clearCacheProvider?): Promise<void>

• Disconnects the connected instance

  Parameters

  • code: number = -1

  • message: string = 'Disconnected from wallet provider'

  • clearCacheProvider: boolean = true

  Returns Promise<void>

explorers

• explorers(): Promise<string[]>

• Returns the explorer URLs (if available) for the currently connected chain

  Returns Promise<string[]>

fetchABI

• fetchABI(contract_address, options?): Promise<string>

• Attempts to fetch the ABI information for the specified contract from an explorer

  Parameters

  • contract_address: `0x${string}`

  • options: Partial<ContractFetchAbiOptions> = {}

  Returns Promise<string>

loadContract

• loadContract(contract_address, contract_abi?, options?): Promise<Contract>

• Loads the specified contract using the connected or specified signer || provider

  Parameters

  • contract_address: `0x${string}`

  • Optional contract_abi: ContractInterface

  • options: Partial<ContractLoadOptions> = {}

  Returns Promise<Contract>

multicall

• multicall<Type>(calls): Promise<Type>

• Execute the specified mutlicall commands

  Type Parameters

  • Type extends any[] = any[]

  Parameters

  • calls: ContractCall[]

  Returns Promise<Type>

on

• on(event, listener): Web3Controller

• Parameters

  • event: "accountsChanged"

  • listener: ((accounts) => void)

    • • (accounts): void

      • Parameters

        • accounts: string[]

        Returns void

  Returns Web3Controller

• on(event, listener): Web3Controller

• Parameters

  • event: "chainChanged"

  • listener: ((chainId) => void)

    • • (chainId): void

      • Parameters

        • chainId: number

        Returns void

  Returns Web3Controller

• on(event, listener): Web3Controller

• Parameters

  • event: "connect"

  • listener: ((chainId) => void)

    • • (chainId): void

      • Parameters

        • chainId: number

        Returns void

  Returns Web3Controller

• on(event, listener): Web3Controller

• Parameters

  • event: "disconnect"

  • listener: ((error) => void)

    • • (error): void

      • Parameters

        • error: {
              code: number;
              message: string;
          }

          • code: number

          • message: string

        Returns void

  Returns Web3Controller

• on(event, listener): Web3Controller

• Parameters

  • event: "error"

  • listener: ((error) => void)

    • • (error): void

      • Parameters

        • error: Error

        Returns void

  Returns Web3Controller

showWeb3Modal

• showWeb3Modal(forceNetwork?): Promise<void>

• Displays a modal to allow a user to connect their wallet

  Parameters

  • forceNetwork: boolean = false

  Returns Promise<void>

signMessage

• signMessage(message): Promise<string>

• Signs a message using the connected signer

  Parameters

  • message: string | Bytes

  Returns Promise<string>

switchChain

• switchChain(chainId?): Promise<void>

• Requests to switch to the specified chain/network

  Parameters

  • chainId: number = ...

  Returns Promise<void>

watchAsset

• watchAsset(contract_address, options?): Promise<void>

• Requests to add an asset for tracking to the connected wallet

  Parameters

  • contract_address: `0x${string}`

  • options: Partial<AssetOptions> = {}

  Returns Promise<void>

Static getExplorers

• getExplorers(chainId, standard?): Promise<string[]>

• Retrieves the explorer URL for the provided chain

  Parameters

  • chainId: number

  • standard: "all" | "none" | "EIP3091" = 'EIP3091'

  Returns Promise<string[]>

Static load

• load(appName?, options?): Promise<Web3Controller>

• Loads a singleton of the controller object

  Parameters

  • appName: string = 'Unknown Application'

  • options: Partial<Web3ControllerOptions> = {}

  Returns Promise<Web3Controller>