Skip to content

accountInfo

function accountInfo(client, options): Promise<AccountInfoResult>;

Defined in: packages/synapse-core/src/pay/payments.ts:62

Get the account info from the payments contract.

ParameterTypeDescription
clientClient<Transport, Chain>The client to use.
optionsAccountInfoOptionsThe options to use.

Promise<AccountInfoResult>

The account info including funds, lockup details, and available balance.

  • ReadContractErrorType if the read contract fails.
  • GetBlockNumberErrorType if the get block number fails.