Skip to content

Commit f357171

Browse files
committed
Add minor documentation improvements
Clarifies two ETH test cases and adds/improves documentation to various functions.
1 parent 8935531 commit f357171

File tree

3 files changed

+10
-2
lines changed

3 files changed

+10
-2
lines changed

app/admin.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ const validateKey = function(key, type) {
208208
if (process.config.verificationPub) {
209209

210210
if (!key.signature) {
211-
console.log(`Key ${key.pub} requires a signature and does not have one.`);
211+
console.log(`Key ${key.pub} has a verification public key but no signature.`);
212212
return false;
213213
}
214214

app/sign.js

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,12 @@ const confirmRecovery = function(backupKey, outputs, customMessage, skipConfirm)
7878
}
7979
};
8080

81+
/**
82+
* Verifies that input is a valid HD key and parses it into HDNode object.
83+
* @param xprv Base58 representation of extended private key
84+
* @param expectedXpub The corresponding extended public key
85+
* @returns The HDNode object representing the extended private key
86+
*/
8187
const getHDNodeAndVerify = function(xprv, expectedXpub) {
8288
let node;
8389

@@ -99,7 +105,7 @@ const getHDNodeAndVerify = function(xprv, expectedXpub) {
99105
};
100106

101107
/**
102-
* Prints the recovery transaction information and prompt for the confirmation as well as the key, if needed to.
108+
* Prints the recovery transaction information and prompt the user for the confirmation as well as the key, if needed to.
103109
* @param recoveryRequest The recovery transansaction request object.
104110
* @param outputs The outputs of the transaction.
105111
* @param skipConfirm The boolean value that indicates to whether or not to prompt the user to confirm the transaction.

test/sign.js

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)