Merge pull request #1045 from eordano/fix/jsdocs/hdpublickey
Fix JSDocs on HDPublicKey
This commit is contained in:
commit
9a7097a172
|
@ -91,7 +91,7 @@ HDPublicKey.isValidPath = function(arg) {
|
|||
*
|
||||
* If the first argument is a string, it's parsed as the full path of
|
||||
* derivation. Valid values for this argument include "m" (which returns the
|
||||
* same private key), "m/0/1/40/2/1000".
|
||||
* same public key), "m/0/1/40/2/1000".
|
||||
*
|
||||
* Note that hardened keys can't be derived from a public extended key.
|
||||
*
|
||||
|
@ -167,10 +167,10 @@ HDPublicKey.prototype._deriveFromString = function (path) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Verifies that a given serialized private key in base58 with checksum format
|
||||
* Verifies that a given serialized public key in base58 with checksum format
|
||||
* is valid.
|
||||
*
|
||||
* @param {string|Buffer} data - the serialized private key
|
||||
* @param {string|Buffer} data - the serialized public key
|
||||
* @param {string|Network=} network - optional, if present, checks that the
|
||||
* network provided matches the network serialized.
|
||||
* @return {boolean}
|
||||
|
@ -180,10 +180,10 @@ HDPublicKey.isValidSerialized = function (data, network) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Checks what's the error that causes the validation of a serialized private key
|
||||
* Checks what's the error that causes the validation of a serialized public key
|
||||
* in base58 with checksum to fail.
|
||||
*
|
||||
* @param {string|Buffer} data - the serialized private key
|
||||
* @param {string|Buffer} data - the serialized public key
|
||||
* @param {string|Network=} network - optional, if present, checks that the
|
||||
* network provided matches the network serialized.
|
||||
* @return {errors|null}
|
||||
|
|
Loading…
Reference in New Issue