Wallet handlers

The wallet handlers expose information about the connected wallet itself: which methods it supports, the user identifier, and a name/version pair. All three are served by the server and never delegate to the wallet, so a wallet implementation does not need to register matching walletHandlers.

Method IDs

Method IDDirectionPurpose
wallet.capabilitiesLive App → WalletList the method IDs available on this wallet (built-ins + handlers).
wallet.userIdLive App → WalletGet the user identifier configured on the wallet.
wallet.infoLive App → WalletGet the wallet name, version, and tracking flag.

wallet.capabilities

Lists every JSON-RPC method the wallet exposes. The server merges:

  • the IDs of every walletHandler registered on the server, and
  • five built-ins that always work without a wallet handler: account.list, currency.list, wallet.capabilities, wallet.info, wallet.userId.

Parameters

None.

Result

{
  methodIds: string[]
}

wallet.userId

Returns the user ID stored in walletContext.config. The value is set when the server is constructed with config.userId.

Parameters

None.

Result

{
  userId: string
}

wallet.info

Returns the wallet metadata stored in walletContext.config.

Parameters

None.

Result

{
  tracking: boolean,
  wallet: {
    name: string,
    version: string,
  }
}

tracking reflects whether the wallet has consented to analytics; wallet.name and wallet.version are set from config.wallet at server construction.

See also

Ledger
Copyright © Ledger SAS. All rights reserved. Ledger, Ledger Stax, Ledger Flex, Ledger Nano, Ledger Nano S, Ledger OS, Ledger Wallet, [LEDGER] (logo), [L] (logo) are trademarks owned by Ledger SAS.