LedgerHQ
GitHub, Ledger Devs Discord, Developer Portal
@ledgerhq/hw-app-solana
Ledger Hardware Wallet Solana JavaScript bindings.
Are you adding Ledger support to your software wallet?
You may be using this package to communicate with the Solana Nano App.
For a smooth and quick integration:
- See the developers’ documentation on the Developer Portal and
- Go on Discord to chat with developer support and the developer community.
Notes
To run speculos-smoke test make sure Speculos running (apdu port 9999 and api rest endpoint http://0.0.0.0:5000) with Solana app installed on it. Then run the command from root workspace:
$ yarn run ts-node packages/hw-app-solana/tests/speculos-smoke.tsTroubleshooting
If ledger returns error 6808 - enable blind signature in settings (not needed for unit testing).
API
Table of Contents
Solana
Solana API
Parameters
transportTransport a transport for sending commands to a devicescrambleKeystring a scramble key (optional, default"solana_default_scramble_key")
Examples
import Solana from "@ledgerhq/hw-app-solana";
const solana = new Solana(transport);getAddress
Get Solana address (public key) for a BIP32 path.
Because Solana uses Ed25519 keypairs, as per SLIP-0010 all derivation-path indexes will be promoted to hardened indexes.
Parameters
Examples
solana.getAddress("44'/501'/0'").then(r => r.address)Returns Promise<{address: Buffer}> an object with the address field
provideTrustedDynamicDescriptor
Provides trusted dynamic and signed coin metadata
Parameters
dataDescriptorInput An object containing the descriptor and its signature from the CAL
Returns Promise[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
signTransaction
Sign a Solana transaction.
Parameters
Examples
solana.signTransaction("44'/501'/0'", txBuffer).then(r => r.signature)Returns Promise<{signature: Buffer}> an object with the signature field
signOffchainMessage
Sign a Solana off-chain message.
Parameters
Examples
solana.signOffchainMessage("44'/501'/0'", msgBuffer).then(r => r.signature)Returns Promise<{signature: Buffer}> an object with the signature field
getAppConfiguration
Get application configuration.
Examples
solana.getAppConfiguration().then(r => r.version)Returns Promise\<AppConfig> application config object
getChallenge
Method returning a 4 bytes TLV challenge as an hex string
Returns Promise[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
provideTrustedName
Provides a trusted name to be displayed during transactions in place of the token address it is associated to. It shall be run just before a transaction involving the associated address that would be displayed on the device.
Parameters
datastring a stringified buffer of some TLV encoded data to represent the trusted name
Returns Promise[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean) a boolean