update docs pertaining to address maps.
This commit is contained in:
parent
1bc60a3e0e
commit
8d5d6dbd88
@ -207,8 +207,8 @@ Input.prototype.isCoinbase = function isCoinbase() {
|
||||
|
||||
/**
|
||||
* Test the input against an address, an
|
||||
* array of addresses, or a map of addresses.
|
||||
* @param {String|String[]|Object} addressMap
|
||||
* array of addresses, or a map of hashes.
|
||||
* @param {Hash|Hash[]|AddressHashMap} addressMap
|
||||
* @returns {Boolean} Whether the input matched.
|
||||
*/
|
||||
|
||||
|
||||
@ -99,7 +99,7 @@ Output.prototype.getHash = function getHash() {
|
||||
/**
|
||||
* Test the output against an address, an
|
||||
* array of addresses, or a map of addresses.
|
||||
* @param {String|String[]|Object} addressMap
|
||||
* @param {Hash|Hash[]|AddressHashMap} addressMap
|
||||
* @returns {Boolean} Whether the output matched.
|
||||
*/
|
||||
|
||||
|
||||
@ -835,8 +835,8 @@ TX.prototype.getHashes = function getHashes() {
|
||||
|
||||
/**
|
||||
* Test the inputs against an address, an
|
||||
* array of addresses, or a map of addresses.
|
||||
* @param {Base58Address|Base58Address[]|Object} addressMap
|
||||
* array of address hashes, or a map of address hashes.
|
||||
* @param {Hash|Hash[]|AddressHashMap} addressMap
|
||||
* @param {Number?} index
|
||||
* @returns {Boolean} Whether the transaction matched.
|
||||
*/
|
||||
@ -866,8 +866,8 @@ TX.prototype.testInputs = function testInputs(addressMap, index) {
|
||||
|
||||
/**
|
||||
* Test the outputs against an address, an
|
||||
* array of addresses, or a map of addresses.
|
||||
* @param {Base58Address|Base58Address[]|Object} addressMap
|
||||
* array of address hashes, or a map of address hashes.
|
||||
* @param {Hash|Hash[]|AddressHashMap} addressMap
|
||||
* @param {Number?} index
|
||||
* @returns {Boolean} Whether the transaction matched.
|
||||
*/
|
||||
|
||||
@ -47,6 +47,18 @@
|
||||
* @global
|
||||
*/
|
||||
|
||||
/**
|
||||
* A map of addresses ({@link Base58Address} -> value).
|
||||
* @typedef {Object} AddressMap
|
||||
* @global
|
||||
*/
|
||||
|
||||
/**
|
||||
* A map of address hashes ({@link Hash} -> value).
|
||||
* @typedef {Object} AddressHashMap
|
||||
* @global
|
||||
*/
|
||||
|
||||
/**
|
||||
* @typedef {Object} ParsedURI
|
||||
* @property {Base58Address} address
|
||||
@ -107,8 +119,8 @@
|
||||
* A satoshi amount. This is technically a
|
||||
* JS double float, but it is regularly
|
||||
* enforced to be less than 53 bits and
|
||||
* less than MAX_MONEY regularly in
|
||||
* various functions.
|
||||
* less than MAX_MONEY in various
|
||||
* functions.
|
||||
* @typedef {Number} Amount
|
||||
* @global
|
||||
*/
|
||||
|
||||
@ -21,7 +21,8 @@ var BufferWriter = require('./writer');
|
||||
* present, no coins will be available.
|
||||
* @param {(HDPrivateKey|HDPublicKey)?} options.master - Master HD key. If not
|
||||
* present, it will be generated.
|
||||
* @param {Object?} options.addressMap - Map of addresses to paths (internal).
|
||||
* @param {AddressHashMap?} options.addressMap - Map of address
|
||||
* hashes to paths (internal).
|
||||
* @param {Boolean?} options.witness - Whether to use witness programs.
|
||||
* @param {Number?} options.accountIndex - The BIP44 account index (default=0).
|
||||
* @param {Number?} options.receiveDepth - The index of the _next_ receiving
|
||||
|
||||
Loading…
Reference in New Issue
Block a user