Skip to content

docs: fix jsdocs #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
leonardotc wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix jsdocs #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions modules/address.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ function _sanitizeDerivationPath(path) {
* @param {string} [path] - Optional derivation path. Defaults to "m/918'/0'/0'/0'".
* @returns {Promise<{publicKey: Buffer, secretKey: Buffer, mnemonic: string}>} Resolves to an object containing the public key, secret key, and mnemonic used.
*/
async function _generateKeyPair(masterPathSegments, mnemonic = null, path = null) {
async function _generateKeyPair(masterPathSegments, mnemonic = null, path = DEFAULT_DERIVATION_PATH) {
const node = loadSLIP10Node();

let safeMnemonic;
Expand All @@ -130,10 +130,6 @@ async function _generateKeyPair(masterPathSegments, mnemonic = null, path = null
safeMnemonic = mnemonicUtils.sanitize(mnemonic); // Will throw if the mnemonic is invalid
}

if (path === null) {
path = DEFAULT_DERIVATION_PATH;
}

let masterPath = [`bip39:${safeMnemonic}`];
for (let i = 0; i < masterPathSegments.length; i++) {
masterPath.push(`slip10:${masterPathSegments[i]}'`);
Expand Down Expand Up @@ -291,9 +287,10 @@ function canDecode(address) {
* Generates a new keypair and address.
* @param {string} hrp - The human-readable part (HRP) for the address (prefix).
* @param {string} [mnemonic] - Optional BIP39 mnemonic phrase. If not provided, a new one is generated.
* @returns {Promise<{address: string, publicKey: Buffer, secretKey: Buffer, mnemonic: string}>} Resolves to an object containing the address, public key, secret key, and mnemonic used.
* @param {string} [derivationPath] - Optional derivation path. Defaults to "m/918'/0'/0'/0'"
* @returns {Promise<{address: string, publicKey: Buffer, secretKey: Buffer, mnemonic: string, derivationPath: string}>} Resolves to an object containing the address, public key, secret key, and mnemonic used.
*/
async function generate(hrp, mnemonic = null, derivationPath = null) {
async function generate(hrp, mnemonic = null, derivationPath = DEFAULT_DERIVATION_PATH) {
_validateHrp(hrp);
const masterPathSegments = b4a.from(hrp, 'utf8'); // The master path segments used in address generation are derived from the HRP
const keypair = await _generateKeyPair(masterPathSegments, mnemonic, derivationPath);
Expand Down