Class PhantomConnector

_providerName

allowedAccounts

provider

providerErrorLog

providerInfo

rawProvider

chainId

• get chainId(): number | undefined

  Returns number | undefined

chainName

• get chainName(): string | undefined

  Returns string | undefined

connectWallet

• connectWallet(): Promise<string[] | null | undefined>

  Request to enable accounts in the wallet Note: This call is not wrapped in a try/catch by design. Errors from connecting to a wallet can be intentional behavior (i.e. the user rejected the request to connect). Handle errors in the calling code.

  Returns Promise<string[] | null | undefined>

currentAccounts

• currentAccounts(): Promise<string[] | undefined>

  Request the current active allowed from the wallet

  Returns Promise<string[] | undefined>

currentChainId

• currentChainId(): Promise<string | undefined>

  Request the current chain id selection on the wallet

  Returns Promise<string | undefined>

onAccountsChanged

• onAccountsChanged(listener: Listener): void

  Parameters

  • listener: Listener

  Returns void

onChainChanged

• onChainChanged(listener: Listener): void

  Parameters

  • listener: Listener

  Returns void

onConnect

• onConnect(listener: Listener): void

  Parameters

  • listener: Listener

  Returns void

onDisconnect

• onDisconnect(listener: Listener): void

  Parameters

  • listener: Listener

  Returns void

removeEIP11193Listener

• removeEIP11193Listener(event: EIP1193EventNames, listener: Listener): void

  Parameters

  • event: EIP1193EventNames
  • listener: Listener

  Returns void

removeEIP11193Listeners

• removeEIP11193Listeners(): void

  Returns void

signerFromAddress

• signerFromAddress(address?: string): Promise<JsonRpcSigner | undefined>

  Get a signer from a given address

  Parameters

  • Optionaladdress: string

    Fetch a signer for a given address

  Returns Promise<JsonRpcSigner | undefined>

signMessage

• signMessage(
      message: string,
      allowedAccount?: string,
  ): Promise<string | undefined>

  Sign a string with a specific account enabled in the wallet

  Parameters

  • message: string

    Message to sign with the signer

  • OptionalallowedAccount: string

    Account being used to sign the message

  Returns Promise<string | undefined>

signTypedMessage

• signTypedMessage(
      domain: TypedDataDomain,
      types: TypedDataTypes,
      value: TypedDataValues,
      allowedAccount?: string,
  ): Promise<string | undefined>

  Sign a typed message with a specific account enabled in the wallet according to EIP-712

  Parameters

  • domain: TypedDataDomain

    eip712Domain

  • types: TypedDataTypes

    A specific field of a structured eip-712 type.

  • value: TypedDataValues

    The contents of the message to sign

  • OptionalallowedAccount: string

    Account being used to sign the message

  Returns Promise<string | undefined>

  see - https://eips.ethereum.org/EIPS/eip-712

subscribeToAccountsChanges

• subscribeToAccountsChanges(listener: () => void): () => void

  Pass a callback to be notified when accounts are changed Note: This is a notifier so it does not return updated values so check the allowed accounts after the passed listener is invoked

  Parameters

  • listener: () => void

    A notify function that will be called when allowed accounts change

  Returns () => void

subscribeToChainChanges

• subscribeToChainChanges(listener: () => void): () => void

  Pass a callback to be notified when chainId is changed Note: This is a notifier so it does not return updated values so check the chainId after the passed listener is invoked

  Parameters

  • listener: () => void

    A notify function that will be called when chainId changes

  Returns () => void

verifyTypedDataSignature

• verifyTypedDataSignature(
      domain: TypedDataDomain,
      types: TypedDataTypes,
      value: TypedDataValues,
      signature: string,
      expectedSignerAddress: string,
  ): boolean

  Verify a typed data signature according to EIP-712

  Parameters

  • domain: TypedDataDomain

    eip712Domain

  • types: TypedDataTypes

    A specific field of a structured eip-712 type.

  • value: TypedDataValues

    The contents of the message to sign

  • signature: string

    Signature produced by signTypedMessage

  • expectedSignerAddress: string

    Expected signer address to verify against

  Returns boolean

  boolean indicating if the signature is valid