Class PhantomWallet

type

walletId

autoConnect

• autoConnect(connectOptions?): Promise<string>

• tries to auto connect to the wallet

  Parameters

  • Optional connectOptions: {
        chainId?: number;
    }

    • Optional chainId?: number

  Returns Promise<string>

connect

• connect(connectOptions?): Promise<string>

• connect to the wallet

  Parameters

  • Optional connectOptions: {
        chainId?: number;
    }

    • Optional chainId?: number

  Returns Promise<string>

disconnect

• disconnect(): Promise<void>

• Returns Promise<void>

getAddress

• getAddress(): Promise<string>

• Returns Promise<string>

  the account address from connected wallet

getBalance

• getBalance(currencyAddress?): Promise<{
      decimals: number;
      displayValue: string;
      name: string;
      symbol: string;
      value: BigNumber;
  }>

• Parameters

  • currencyAddress: string = NATIVE_TOKEN_ADDRESS

  Returns Promise<{
      decimals: number;
      displayValue: string;
      name: string;
      symbol: string;
      value: BigNumber;
  }>

  the native token balance of the connected wallet

getChainId

• getChainId(): Promise<number>

• Returns Promise<number>

  the chain id from connected wallet

getConnectParams

• getConnectParams(): undefined | {
      chainId?: number;
  }

• Returns undefined | {
      chainId?: number;
  }

getMeta

• getMeta(): WalletMeta

• Returns WalletMeta

getOptions

• getOptions(): undefined | {
      analytics?: "enabled" | "disabled";
      chains?: Chain[];
      clientId?: string;
      dappMetadata?: DAppMetaData;
      walletId?: string;
      walletStorage?: AsyncStorage;
  }

• Returns undefined | {
      analytics?: "enabled" | "disabled";
      chains?: Chain[];
      clientId?: string;
      dappMetadata?: DAppMetaData;
      walletId?: string;
      walletStorage?: AsyncStorage;
  }

getPersonalWallet

• getPersonalWallet(): undefined | EVMWallet

• If the wallet uses a personal wallet under the hood, return it

  Returns undefined | EVMWallet

getSigner

• getSigner(): Promise<Signer>

• Returns Promise<Signer>

signMessage

• signMessage(message): Promise<string>

• Parameters

  • message: string | Bytes

  Returns Promise<string>

  the signature of the message

switchChain

• switchChain(chainId): Promise<void>

• Parameters

  • chainId: number

  Returns Promise<void>

transfer

• transfer(to, amount, currencyAddress?): Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>

• Parameters

  • to: string

  • amount: string | number

  • currencyAddress: string = NATIVE_TOKEN_ADDRESS

  Returns Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>

updateChains

• updateChains(chains): Promise<void>

• Parameters

  • chains: Chain[]

  Returns Promise<void>

verifySignature

• verifySignature(message, signature, address, chainId?): Promise<boolean>

• verify the signature of a message

  Parameters

  • message: string

  • signature: string

  • address: string

  • Optional chainId: number

  Returns Promise<boolean>

  true if the signature is valid, false otherwise