Skip to content

Latest commit

 

History

History
19 lines (11 loc) · 4.79 KB

GeneralWallet.md

File metadata and controls

19 lines (11 loc) · 4.79 KB

GeneralWallet

The wallet authentication information used to sign and submit the transaction. Click the > arrow next to "wallet" on the left to see more details. See our Security section <a href="#section/Security">here.

Properties

Name Type Description Notes
secretRecoveryPhrase String The 12, 15, 18, 21, or 24 word phrase that can be used to derive many public key addresses (e.g., bottom army bless castle alter habit dish embody child flame smooth zone). To derive a wallet identifier (e.g., public key, public address, etc.), you need a secret recovery phrase, a derivation path, and an optional passphrase. Alternatively, you can derive a wallet identifier with a private key. Default Lengths: - Avalanche (C): 24 - Avalanche (X, P): 24 - Binance: 12 - Ethereum: 12 - Near: 12 - Solana: 12 You can use `secret_recovery_phrase` for Chains: `avalanche`, `binance`, `ethereum`, `near`, `solana`.
derivationPath String Derivation paths are used to derive the wallet identifier from the secret recovery phrase. Only correctly typed paths are accepted. Defaults: - Avalanche (C): m/44'/60'/0'/0/0 - Avalanche (X, P): m/44'/60'/0'/0/0 - Binance: m/44'/60'/0'/0/0 - Ethereum: m/44'/60'/0'/0/0 - Near: m/44/397/0 - Solana: m/44/501/0/0 Solana Behavior If you provide the empty string &quot;&quot; as the value for the derivation path, then we will derive your public key with the same behavior as the default behavior of the Solana CLI. By default, we use &quot;m/44/501/0/0&quot;. This is the path that the Phantom and Sollet wallets use. You can also arbitrarily increment the default path (&quot;m/44/501/0/0&quot;) to generate more wallets (e.g., &quot;m/44/501/0/1&quot;, &quot;m/44/501/0/2&quot;, ... AND/OR &quot;m/44/501/1/0&quot;, &quot;m/44/501/2/0&quot;, ...). Phantom's Wallet increments the first digit (e.g., &quot;m/44/501/0/0&quot;, &quot;m/44/501/1/0&quot;, &quot;m/44/501/2/0&quot;, ...) to generate more public key addresses. The SolFlare recommended path is &quot;m/44/501/0&quot;. To learn more about derivation paths, check out <a href=&quot;https://learnmeabitcoin.com/technical/derivation-paths\" target=&quot;_blank&quot;>this tutorial</a>. [optional]
passphrase String PASSPHRASE != PASSWORD. This is NOT your Phantom password or any other password. It is an optional string you use when creating a wallet. This provides an additional layer of security because a hacker would need both the secret recovery phrase and the passphrase to access the output public key. By default, most wallet UI extensions do not use a passphrase. (You probably did not use a passphrase.) Limited to 500 characters. [optional]
hexPrivateKey String A hex private key is the typical private key used on Ethereum, for example. It looks like this: `0x200b9e5baa38b0dc7551645be11b394e9bf2b04532e4af8824bed2b3de2e0dc0`. You can use `hex_private_key` for chains: `avalanche`, `binance_smart_chain`, `ethereum`.
privateKey Object A private key corresponds to exactly one public key address. A private key can be used to move assets out of the wallet and sign transaction with the corresponding public key. A private key is an array of integers (e.g., `[185,108,153,165,57,193,166,167,58,148,133,121,92,252,242,13,233,246,35,103,185,20,27,56,111,169,12,50,50,36,83,156,173,195,143,75,135,78,204,129,217,231,58,129,69,180,185,86,119,43,200,193,94,112,31,135,68,128,207,26,85,150,68,181]`). <a href=&quot;https://solflare.com\" target=&quot;_blank&quot;>Solflare</a> is a popular wallet interface on Solana that allows you to export your private key in this format. You can use `private_key` for Chains: `avalanche`, `binance_smart_chain`, `ethereum`, `solana`, `near`.
b58PrivateKey String A private key corresponds to exactly one public key address. A private key can be used to move assets out of the wallet and sign transaction with the corresponding public key. A base58-encoded private key is a base58-encoded version of the typical private key. It is represented as a string (e.g., `4waBTVeAVWEAczSdx36uMrR19668ACgQDs7r386vrUes3UCzvXCQ2FPSCVGb1zJrwcULgpNzgABreyQaWSpGBwfx`). <a href=&quot;https://phantom.app\" target=&quot;_blank&quot;>Phantom</a> is a popular wallet interface on Solana that allows you to export your private key in this format. You can use `b58_private_key` for Chains: `solana`, `near`