Wallet API


The Exchange handlers facilitates various exchange operations such as starting the exchange process, completing swap, sell, and fund transactions using Ledger Live.

request handlers:

"exchange.start" - Start Exchange

Start the exchange process by generating a nonce on Ledger device. This method is typically called before completing the exchange process.

parameter (in req.params)required?note
exchangeTypeType of exchange, "SWAP", "SELL" or "FUND"
walletHandler usednote
  • Returns: A promise that resolves with an object containing the transactionId which is used to complete the exchange process.

"exchange.complete" - Complete Exchange

Complete an exchange process (swap, sell, or fund) by passing the exchange content and its signature.

parameter (in req.params)required?note
providerA string used to verify the signature.
fromAccountIdIdentifier of the account used as a source for the transaction.
rawTransactionA RawTransaction object containing the transaction details.
hexBinaryPayloadHexadecimal string representing the blueprint of the data that will be allowed for signing.
hexSignatureHexadecimal string ensuring the source of the payload.
feeStrategyA string representing the fee strategy ("SLOW", "MEDIUM", or "FAST").
exchangeTypeA string specifying the type of exchange operation ("SWAP", "SELL", or "FUND").
toAccountIdIdentifier of the account used as a destination (required for "SWAP").
swapIdIdentifier of the backend swap used (required for "SWAP").
rateSwap rate used in the transaction (required for "SWAP").
tokenCurrencySwap tokenCurrency is used when we want point a new token, as id does not exists in wallet-api (optional for "SWAP" and "FUND").
walletHandler usednote
  • Returns: A promise that resolves with an object containing the transactionHash of the broadcasted transaction.
Copyright © Ledger SAS. All rights reserved. Ledger, Ledger Nano S, Ledger Vault, Bolos are registered trademarks of Ledger SAS