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

​

Returns

QuaiHDWallet

​

Overrides

AbstractHDWallet.constructor

​

Source

wallet/quai-hdwallet.ts:66

​

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

wallet/hdwallet.ts:94

​

Methods

​

addAddress()

addAddress(
   account, 
   addressIndex, 
   isChange?): NeuteredAddressInfo

Adds an address to the wallet.

​

Parameters

​

Returns

NeuteredAddressInfo

The added address info.

​

Inherited from

AbstractHDWallet.addAddress

​

Source

wallet/hdwallet.ts:152

​

connect()

connect(provider): void

Connects the wallet to a provider.

​

Parameters

​

Returns

void

​

Inherited from

AbstractHDWallet.connect

​

Source

wallet/hdwallet.ts:385

​

getAddressInfo()

getAddressInfo(address): null | NeuteredAddressInfo

Gets the address info for a given address.

​

Parameters

​

Returns

null | NeuteredAddressInfo

The address info or null if not found.

​

Inherited from

AbstractHDWallet.getAddressInfo

​

Source

wallet/hdwallet.ts:243

​

getAddressesForAccount()

getAddressesForAccount(account): NeuteredAddressInfo[]

Gets the addresses for a given account.

​

Parameters

​

Returns

NeuteredAddressInfo[]

The addresses for the account.

​

Inherited from

AbstractHDWallet.getAddressesForAccount

​

Source

wallet/hdwallet.ts:269

​

getAddressesForZone()

getAddressesForZone(zone): NeuteredAddressInfo[]

Gets the addresses for a given zone.

​

Parameters

​

Returns

NeuteredAddressInfo[]

The addresses for the zone.

​

Inherited from

AbstractHDWallet.getAddressesForZone

​

Source

wallet/hdwallet.ts:280

​

getNextAddress()

getNextAddress(account, zone): Promise<NeuteredAddressInfo>

Promise that resolves to the next address for the specified account and zone.

​

Parameters

​

Returns

Promise<NeuteredAddressInfo>

The next neutered address information.

​

Inherited from

AbstractHDWallet.getNextAddress

​

Source

wallet/hdwallet.ts:200

​

getNextAddressSync()

getNextAddressSync(account, zone): NeuteredAddressInfo

Synchronously retrieves the next address for the specified account and zone.

​

Parameters

​

Returns

NeuteredAddressInfo

The next neutered address information.

​

Inherited from

AbstractHDWallet.getNextAddressSync

​

Source

wallet/hdwallet.ts:211

​

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

​

Returns

string

The private key.

​

Inherited from

AbstractHDWallet.getPrivateKey

​

Source

wallet/hdwallet.ts:258

​

sendTransaction()

sendTransaction(tx): Promise<TransactionResponse>

Send a transaction.

​

Parameters

​

Returns

Promise<TransactionResponse>

A promise that resolves to the transaction response.

​

Throws

If the provider is not set.

​

Source

wallet/quai-hdwallet.ts:90

​

serialize()

serialize(): SerializedQuaiHDWallet

Serializes the QuaiHDWallet state into a format suitable for storage or transmission.

This method extends the serialization from the parent class (AbstractHDWallet) and includes additional QuaiHDWallet-specific data, such as the addresses.

​

Returns

SerializedQuaiHDWallet

An object representing the serialized state of the QuaiHDWallet, including addresses and other inherited properties from the parent wallet.

​

Overrides

AbstractHDWallet.serialize

​

Example

const wallet = new QuaiHDWallet(); const serializedData = wallet.serialize(); // serializedData can now
be stored or transmitted

​

Source

wallet/quai-hdwallet.ts:124

​

signMessage()

signMessage(address, message): Promise<string>

Sign a message.

​

Parameters

​

Returns

Promise<string>

A promise that resolves to the signed message.

​

Overrides

AbstractHDWallet.signMessage

​

Source

wallet/quai-hdwallet.ts:107

​

signTransaction()

signTransaction(tx): Promise<string>

Sign a transaction.

​

Parameters

​

Returns

Promise<string>

A promise that resolves to the signed transaction.

​

Overrides

AbstractHDWallet.signTransaction

​

Source

wallet/quai-hdwallet.ts:76

​

signTypedData()

signTypedData(
   address, 
   domain, 
   types, 
value): Promise<string>

Signs typed data using the private key associated with the given address.

​

Parameters

​

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

wallet/quai-hdwallet.ts:168

​

createRandom()

static createRandom<T>(
   this, 
   password?, 
   wordlist?): T

Creates a random HD wallet.

​

Type parameters

​

Parameters

​

Returns

T

The created instance.

​

Inherited from

AbstractHDWallet.createRandom

​

Source

wallet/hdwallet.ts:324

​

deserialize()

static deserialize(serialized): Promise<QuaiHDWallet>

Deserializes the given serialized HD wallet data into an instance of QuaiHDWallet.

​

Parameters

​

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

wallet/quai-hdwallet.ts:143

​

fromMnemonic()

static fromMnemonic<T>(this, mnemonic): T

Creates an HD wallet from a mnemonic.

​

Type parameters

​

Parameters

​

Returns

T

The created instance.

​

Inherited from

AbstractHDWallet.fromMnemonic

​

Source

wallet/hdwallet.ts:309

​

fromPhrase()

static fromPhrase<T>(
   this, 
   phrase, 
   password?, 
   wordlist?): T

Creates an HD wallet from a phrase.

​

Type parameters

​

Parameters

​

Returns

T

The created instance.

​

Inherited from

AbstractHDWallet.fromPhrase

​

Source

wallet/hdwallet.ts:348