Skip to content
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.

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

Add extended public & private key accessor methods for AbstractHDWallet #227

Merged
merged 1 commit into from
Jun 26, 2024
Merged
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions src/wallet/hdwallet.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,15 @@ export abstract class AbstractHDWallet {
return (this.constructor as typeof AbstractHDWallet)._coinType!;
}

/**
* Returns the extended public key of the root node of the HD wallet.
*
* @returns {string} The extended public key.
*/
get xPub(): string {
return this._root.extendedKey;
}

/**
* Derives the next valid address node for a specified account, starting index, and zone. The method ensures the
* derived address belongs to the correct shard and ledger, as defined by the Quai blockchain specifications.
Expand Down Expand Up @@ -223,6 +232,18 @@ export abstract class AbstractHDWallet {
return addressInfo;
}

/**
* Returns the private key for a given address. This method should be used with caution as it exposes the private
* key to the user.
*
* @param {string} address - The address associated with the desired private key.
* @returns {string} The private key.
*/
public getPrivateKey(address: string): string {
const hdNode = this._getHDNodeForAddress(address);
return hdNode.privateKey;
}

/**
* Gets the addresses for a given account.
*
Expand Down
Loading