Class CapsuleConnector

Readonly chains

Readonly id

Readonly name

Readonly options

Readonly ready

Static prefixed

addListener

• addListener<T>(event, fn, context?): CapsuleConnector

• Type Parameters

  • T extends keyof ConnectorEvents

  Parameters

  • event: T

  • fn: ((...args) => void)

    • • (...args): void

      • Parameters

        • Rest ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]

        Returns void

  • Optional context: any

  Returns CapsuleConnector

connect

• connect(__namedParameters?): Promise<{
      account: `0x${string}`;
      chain: {
          id: number;
          unsupported: boolean;
      };
  }>

• Parameters

  • Optional __namedParameters: {
        chainId?: number;
    }

    • Optional chainId?: number

  Returns Promise<{
      account: `0x${string}`;
      chain: {
          id: number;
          unsupported: boolean;
      };
  }>

emit

• emit<T>(event, ...args): boolean

• Calls each of the listeners registered for a given event.

  Type Parameters

  • T extends keyof ConnectorEvents

  Parameters

  • event: T

  • Rest ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]

  Returns boolean

eventNames

• eventNames(): (keyof ConnectorEvents)[]

• Return an array listing the events for which the emitter has registered listeners.

  Returns (keyof ConnectorEvents)[]

getAccount

• getAccount(): Promise<`0x${string}`>

• Returns Promise<`0x${string}`>

getChainId

• getChainId(): Promise<number>

• Returns Promise<number>

getProvider

• getProvider(): Promise<WindowProvider>

• Returns Promise<WindowProvider>

getWalletClient

• getWalletClient(__namedParameters?): Promise<{
      account: Account;
      addChain: ((args) => Promise<void>);
      batch?: {
          multicall?: boolean | ({ batchSize?: number; wait?: number; });
      };
      cacheTime: number;
      chain: Chain;
      deployContract: (<const TAbi, TChainOverride>(args) => Promise<`0x${string}`>);
      extend: (<const client>(fn) => Client<Transport, Chain, Account, WalletRpcSchema, ({ [K in keyof client]: client[K]; }) & WalletActions<Chain, Account>>);
      getAddresses: (() => Promise<GetAddressesReturnType>);
      getChainId: (() => Promise<number>);
      getPermissions: (() => Promise<GetPermissionsReturnType>);
      key: string;
      name: string;
      pollingInterval: number;
      prepareTransactionRequest: (<TChainOverride>(args) => Promise<any>);
      request: EIP1193RequestFn<WalletRpcSchema>;
      requestAddresses: (() => Promise<RequestAddressesReturnType>);
      requestPermissions: ((args) => Promise<RequestPermissionsReturnType>);
      sendRawTransaction: ((args) => Promise<`0x${string}`>);
      sendTransaction: (<TChainOverride>(args) => Promise<`0x${string}`>);
      signMessage: ((args) => Promise<`0x${string}`>);
      signTransaction: (<TChainOverride>(args) => Promise<`0x${string}`>);
      signTypedData: (<const TTypedData, TPrimaryType>(args) => Promise<`0x${string}`>);
      switchChain: ((args) => Promise<void>);
      transport: TransportConfig<string, EIP1193RequestFn> & Record<string, any>;
      type: string;
      uid: string;
      watchAsset: ((args) => Promise<boolean>);
      writeContract: (<const TAbi, TFunctionName, TChainOverride>(args) => Promise<`0x${string}`>);
  }>

• Parameters

  • Optional __namedParameters: {
        chainId?: number;
    }

    • Optional chainId?: number

  Returns Promise<{
      account: Account;
      addChain: ((args) => Promise<void>);
      batch?: {
          multicall?: boolean | ({ batchSize?: number; wait?: number; });
      };
      cacheTime: number;
      chain: Chain;
      deployContract: (<const TAbi, TChainOverride>(args) => Promise<`0x${string}`>);
      extend: (<const client>(fn) => Client<Transport, Chain, Account, WalletRpcSchema, ({ [K in keyof client]: client[K]; }) & WalletActions<Chain, Account>>);
      getAddresses: (() => Promise<GetAddressesReturnType>);
      getChainId: (() => Promise<number>);
      getPermissions: (() => Promise<GetPermissionsReturnType>);
      key: string;
      name: string;
      pollingInterval: number;
      prepareTransactionRequest: (<TChainOverride>(args) => Promise<any>);
      request: EIP1193RequestFn<WalletRpcSchema>;
      requestAddresses: (() => Promise<RequestAddressesReturnType>);
      requestPermissions: ((args) => Promise<RequestPermissionsReturnType>);
      sendRawTransaction: ((args) => Promise<`0x${string}`>);
      sendTransaction: (<TChainOverride>(args) => Promise<`0x${string}`>);
      signMessage: ((args) => Promise<`0x${string}`>);
      signTransaction: (<TChainOverride>(args) => Promise<`0x${string}`>);
      signTypedData: (<const TTypedData, TPrimaryType>(args) => Promise<`0x${string}`>);
      switchChain: ((args) => Promise<void>);
      transport: TransportConfig<string, EIP1193RequestFn> & Record<string, any>;
      type: string;
      uid: string;
      watchAsset: ((args) => Promise<boolean>);
      writeContract: (<const TAbi, TFunctionName, TChainOverride>(args) => Promise<`0x${string}`>);
  }>

isAuthorized

• isAuthorized(): Promise<boolean>

• Returns Promise<boolean>

listenerCount

• listenerCount(event): number

• Return the number of listeners listening to a given event.

  Parameters

  • event: keyof ConnectorEvents

  Returns number

listeners

• listeners<T>(event): ((...args) => void)[]

• Return the listeners registered for a given event.

  Type Parameters

  • T extends keyof ConnectorEvents

  Parameters

  • event: T

  Returns ((...args) => void)[]

off

• off<T>(event, fn?, context?, once?): CapsuleConnector

• Type Parameters

  • T extends keyof ConnectorEvents

  Parameters

  • event: T

  • Optional fn: ((...args) => void)

    • • (...args): void

      • Parameters

        • Rest ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]

        Returns void

  • Optional context: any

  • Optional once: boolean

  Returns CapsuleConnector

on

• on<T>(event, fn, context?): CapsuleConnector

• Add a listener for a given event.

  Type Parameters

  • T extends keyof ConnectorEvents

  Parameters

  • event: T

  • fn: ((...args) => void)

    • • (...args): void

      • Parameters

        • Rest ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]

        Returns void

  • Optional context: any

  Returns CapsuleConnector

once

• once<T>(event, fn, context?): CapsuleConnector

• Add a one-time listener for a given event.

  Type Parameters

  • T extends keyof ConnectorEvents

  Parameters

  • event: T

  • fn: ((...args) => void)

    • • (...args): void

      • Parameters

        • Rest ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]

        Returns void

  • Optional context: any

  Returns CapsuleConnector

removeAllListeners

• removeAllListeners(event?): CapsuleConnector

• Remove all listeners, or those of the specified event.

  Parameters

  • Optional event: keyof ConnectorEvents

  Returns CapsuleConnector

removeListener

• removeListener<T>(event, fn?, context?, once?): CapsuleConnector

• Remove the listeners of a given event.

  Type Parameters

  • T extends keyof ConnectorEvents

  Parameters

  • event: T

  • Optional fn: ((...args) => void)

    • • (...args): void

      • Parameters

        • Rest ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]

        Returns void

  • Optional context: any

  • Optional once: boolean

  Returns CapsuleConnector

setStorage

• setStorage(storage): void

• Parameters

  • storage: Storage

  Returns void

switchChain

• switchChain(chainId): Promise<Chain>

• Parameters

  • chainId: number

  Returns Promise<Chain>

watchAsset

• watchAsset(__namedParameters): Promise<boolean>

• Parameters

  • __namedParameters: {
        address: `0x${string}`;
        decimals?: number;
        image?: string;
        symbol: string;
    }

    • address: `0x${string}`

    • Optional decimals?: number

    • Optional image?: string

    • symbol: string

  Returns Promise<boolean>