QuaiHDWallet
The Quai HD wallet is a BIP44-compliant hierarchical deterministic wallet used for managing a set of addresses in the Quai ledger. This is the easiest way to manage the interaction of managing accounts and addresses on the Quai network, however, if your use case requires a single address Quai address, you can use the Wallet class.
The Quai HD wallet supports:
- Adding accounts to the wallet heierchy
- Generating addresses for a specific account in any Zone
- Signing and sending transactions for any address in the wallet
- Signing and verifying EIP1193 typed data for any address in the wallet.
- Serializing the wallet to JSON and deserializing it back to a wallet instance.
Example
import { QuaiHDWallet, Zone } from 'quais';
const wallet = new QuaiHDWallet();
const cyrpus1Address = await wallet.getNextAddress(0, Zone.Cyrpus1); // get the first address in the Cyrpus1 zone
await wallet.sendTransaction({ from: address, to: '0x...', value: 100 }); // send a transaction
const serializedWallet = wallet.serialize(); // serialize current (account/address) state of the wallet
.
.
.
const deserializedWallet = QuaiHDWallet.deserialize(serializedWallet); // create a new wallet instance from the serialized data
Extends
AbstractHDWallet
Constructors
new QuaiHDWallet()
new QuaiHDWallet(
guard,
root,
provider?): QuaiHDWallet
Create a QuaiHDWallet instance.
Parameters
Parameter | Type | Description |
---|---|---|
guard | any | - |
root | HDNodeWallet | The root HD node wallet. |
provider ? | Provider | The provider. |
Returns
Overrides
AbstractHDWallet.constructor
Source
Accessors
xPub
get xPub(): string
Returns the extended public key of the root node of the HD wallet.
Returns
string
The extended public key.
Source
Methods
addAddress()
addAddress(
account,
addressIndex,
isChange?): NeuteredAddressInfo
Adds an address to the wallet.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
account | number | undefined | The account number. |
addressIndex | number | undefined | The address index. |
isChange ? | boolean | false | Whether the address is a change address. Default is false |
Returns
NeuteredAddressInfo
The added address info.
Inherited from
AbstractHDWallet.addAddress
Source
connect()
connect(provider): void
Connects the wallet to a provider.
Parameters
Parameter | Type | Description |
---|---|---|
provider | Provider | The provider. |
Returns
void
Inherited from
AbstractHDWallet.connect
Source
getAddressInfo()
getAddressInfo(address): null | NeuteredAddressInfo
Gets the address info for a given address.
Parameters
Parameter | Type | Description |
---|---|---|
address | string | The address. |
Returns
null
| NeuteredAddressInfo
The address info or null if not found.
Inherited from
AbstractHDWallet.getAddressInfo
Source
getAddressesForAccount()
getAddressesForAccount(account): NeuteredAddressInfo[]
Gets the addresses for a given account.
Parameters
Parameter | Type | Description |
---|---|---|
account | number | The account number. |
Returns
NeuteredAddressInfo
[]
The addresses for the account.
Inherited from
AbstractHDWallet.getAddressesForAccount
Source
getAddressesForZone()
getAddressesForZone(zone): NeuteredAddressInfo[]
Gets the addresses for a given zone.
Parameters
Parameter | Type | Description |
---|---|---|
zone | Zone | The zone. |
Returns
NeuteredAddressInfo
[]
The addresses for the zone.
Inherited from
AbstractHDWallet.getAddressesForZone
Source
getNextAddress()
getNextAddress(account, zone): Promise<NeuteredAddressInfo>
Promise that resolves to the next address for the specified account and zone.
Parameters
Parameter | Type | Description |
---|---|---|
account | number | The index of the account for which to retrieve the next address. |
zone | Zone | The zone in which to retrieve the next address. |
Returns
Promise
<NeuteredAddressInfo
>
The next neutered address information.
Inherited from
AbstractHDWallet.getNextAddress
Source
getNextAddressSync()
getNextAddressSync(account, zone): NeuteredAddressInfo
Synchronously retrieves the next address for the specified account and zone.
Parameters
Parameter | Type | Description |
---|---|---|
account | number | The index of the account for which to retrieve the next address. |
zone | Zone | The zone in which to retrieve the next address. |
Returns
NeuteredAddressInfo
The next neutered address information.
Inherited from
AbstractHDWallet.getNextAddressSync
Source
getPrivateKey()
getPrivateKey(address): string
Returns the private key for a given address. This method should be used with caution as it exposes the private key to the user.
Parameters
Parameter | Type | Description |
---|---|---|
address | string | The address associated with the desired private key. |
Returns
string
The private key.
Inherited from
AbstractHDWallet.getPrivateKey
Source
sendTransaction()
sendTransaction(tx): Promise<TransactionResponse>
Send a transaction.
Parameters
Parameter | Type | Description |
---|---|---|
tx | QuaiTransactionRequest | The transaction request. |
Returns
Promise
<TransactionResponse
>
A promise that resolves to the transaction response.
Overrides
AbstractHDWallet.sendTransaction
Throws
If the provider is not set.
Source
serialize()
serialize(): SerializedHDWallet
Serializes the HD wallet state into a format suitable for storage or transmission.
Returns
SerializedHDWallet
An object representing the serialized state of the HD wallet, including version, mnemonic phrase, coin type, and addresses.
Inherited from
AbstractHDWallet.serialize
Source
signMessage()
signMessage(address, message): Promise<string>
Sign a message.
Parameters
Parameter | Type | Description |
---|---|---|
address | string | The address. |
message | string | Uint8Array | The message to sign. |
Returns
Promise
<string
>
A promise that resolves to the signed message.
Overrides
AbstractHDWallet.signMessage
Source
signTransaction()
signTransaction(tx): Promise<string>
Sign a transaction.
Parameters
Parameter | Type | Description |
---|---|---|
tx | QuaiTransactionRequest | The transaction request. |
Returns
Promise
<string
>
A promise that resolves to the signed transaction.
Overrides
AbstractHDWallet.signTransaction
Source
signTypedData()
signTypedData(
address,
domain,
types,
value): Promise<string>
Signs typed data using the private key associated with the given address.
Parameters
Parameter | Type | Description |
---|---|---|
address | string | The address for which the typed data is to be signed. |
domain | TypedDataDomain | The domain information of the typed data, defining the scope of the signature. |
types | Record <string , TypedDataField []> | The types of the data to be signed, mapping each data type name to its fields. |
value | Record <string , unknown > | The actual data to be signed. |
Returns
Promise
<string
>
A promise that resolves to the signed data in string format.
Throws
If the address does not correspond to a valid HD node or if signing fails.
Source
createRandom()
static createRandom<T>(
this,
password?,
wordlist?): T
Creates a random HD wallet.
Type parameters
Type parameter |
---|
T extends AbstractHDWallet <T > |
Parameters
Parameter | Type | Description |
---|---|---|
this | Object | The constructor of the HD wallet. |
password ? | string | The password. |
wordlist ? | Wordlist | The wordlist. |
Returns
T
The created instance.
Inherited from
AbstractHDWallet.createRandom
Source
deserialize()
static deserialize(serialized): Promise<QuaiHDWallet>
Deserializes the given serialized HD wallet data into an instance of QuaiHDWallet.
Parameters
Parameter | Type | Description |
---|---|---|
serialized | SerializedHDWallet | The serialized wallet data to be deserialized. |
Returns
Promise
<QuaiHDWallet
>
A promise that resolves to an instance of QuaiHDWallet.
Overrides
AbstractHDWallet.deserialize
Async
Throws
If validation of the serialized wallet data fails or if deserialization fails.
Static
Source
fromMnemonic()
static fromMnemonic<T>(this, mnemonic): T
Creates an HD wallet from a mnemonic.
Type parameters
Type parameter |
---|
T extends AbstractHDWallet <T > |
Parameters
Parameter | Type | Description |
---|---|---|
this | Object | The constructor of the HD wallet. |
mnemonic | Mnemonic | The mnemonic. |
Returns
T
The created instance.
Inherited from
AbstractHDWallet.fromMnemonic
Source
fromPhrase()
static fromPhrase<T>(
this,
phrase,
password?,
wordlist?): T
Creates an HD wallet from a phrase.
Type parameters
Type parameter |
---|
T extends AbstractHDWallet <T > |
Parameters
Parameter | Type | Description |
---|---|---|
this | Object | The constructor of the HD wallet. |
phrase | string | The phrase. |
password ? | string | The password. |
wordlist ? | Wordlist | The wordlist. |
Returns
T
The created instance.
Inherited from
AbstractHDWallet.fromPhrase
Source
Was this page helpful?