Get a bitcoin receive address at a given index
the index of the address
address
Get the private key hex-string for a given bitcoin receive address
the index of the address
the hex-string. this will be either 64 characters long to denote an uncompressed bitcoin address, or 66 characters long for a compressed bitcoin address.
Get the root node for the bitcoin public keychain
base58-encoding of the public node
Get the keypair information for a given identity index. This information is used to obtain the private key for an identity address and derive application specific keys for that address.
the identity index
if true, always return a private-key hex string corresponding to the uncompressed address
an IdentityKeyPair type object with keys: .key {String} - the private key hex-string .keyID {String} - the public key hex-string .address {String} - the identity address .appsNodeKey {String} - the base-58 encoding of the applications node .salt {String} - the salt used for creating app-specific addresses
Get the root node for the identity public keychain
base58-encoding of the public node
Get a salt for use with creating application specific addresses
the salt
Encrypt a mnemonic phrase with a password
Raw mnemonic phrase
Password to encrypt mnemonic with
Hex-encoded encrypted mnemonic
Initialize a blockstack wallet from a base58 string
the Base58 string used to initialize the root node of the hierarchical wallet
the constructed wallet
Initialize a blockstack wallet from an encrypted phrase & password. Throws if the password is incorrect. Supports all formats of Blockstack phrases.
The encrypted phrase as a hex-encoded string
The plain password
the constructed wallet
Initialize a blockstack wallet from a seed buffer
the input seed for initializing the root node of the hierarchical wallet
the constructed wallet
Generate a BIP-39 12 word mnemonic
space-separated 12 word phrase
Get a bitcoin address given a base-58 encoded bitcoin node (usually called the account node)
base58-encoding of the node
index of the address to get
either 'EXTERNAL_ADDRESS' (for a "receive" address) or 'CHANGE_ADDRESS'
the address
Get a ECDSA private key hex-string for an application-specific address.
the base58-encoded private key for
applications node (the appsNodeKey
return in getIdentityKeyPair())
a string, used to salt the application-specific addresses
the appDomain to generate a key for
the private key hex-string. this will be a 64 character string
Get a ECDSA private key hex-string for an application-specific address.
the base58-encoded private key for
applications node (the appsNodeKey
return in getIdentityKeyPair())
a string, used to salt the application-specific addresses
the appDomain to generate a key for
the private key hex-string. this will be a 64 character string
Generated using TypeDoc
The BlockstackWallet class manages the hierarchical derivation paths for a standard blockstack client wallet. This includes paths for bitcoin payment address, blockstack identity addresses, blockstack application specific addresses. @private