Class WalletClient

A client class for interacting with wallets, which can seamlessly work with WebExtensions.

Remarks

The WalletClient manages multiple accounts and handles operations such as transaction signing, fetching account information, and interacting with the blockchain. It extends the BaseClient class and implements the IWalletClient interface.

Hierarchy

BaseClient
- WalletClient

Implements

IWalletClient

Constructors

constructor

new WalletClient(clientConfig: IClientConfig, publicApiClient: PublicApiClient, baseAccount?: IBaseAccount): WalletClient
Constructor of the WalletClient class.
Parameters
- clientConfig: IClientConfig
  
  Configuration parameters for the client.
- publicApiClient: PublicApiClient
  
  A PublicApiClient instance used for making API calls.
- Optional baseAccount: IBaseAccount
  
  (Optional) An IAccount to set as the base account for the wallet.
Returns WalletClient
Overrides BaseClient.constructor
- Defined in src/web3/WalletClient.ts:49

Properties

`Private` `Optional` baseAccount

baseAccount?: IBaseAccount

clientConfig

clientConfig: IClientConfig

`Private` `Readonly` publicApiClient

publicApiClient: PublicApiClient

A PublicApiClient instance used for making API calls.

`Private` wallet

wallet: IAccount[] = []

Methods

addAccountsToWallet

addAccountsToWallet(accounts: IAccount[]): Promise<IAccount[]>
Adds a set of accounts to the wallet.

Throws
- If the number of accounts exceeds the MAX_WALLET_ACCOUNTS limit
- If an account is missing a private key
- If a submitted public key doesn't correspond to the associated private key
- If an account address doesn't correspond to the private key-derived address
Returns
A Promise that resolves to an array of IAccount objects.
Parameters
- accounts: IAccount[]
  
  An array of accounts (IAccount objects) to be added to the wallet.
Returns Promise<IAccount[]>
Implementation of IWalletClient.addAccountsToWallet
- Defined in src/web3/WalletClient.ts:191

addSecretKeysToWallet

addSecretKeysToWallet(secretKeys: string[]): Promise<IAccount[]>
Adds a set of private keys to the wallet.

Throws
if the number of private keys exceeds the maximum limit.

Returns
A Promise that resolves to an array of IAccount objects.
Parameters
- secretKeys: string[]
  
  An array of base58 encoded private keys to be added to the wallet.
Returns Promise<IAccount[]>
Implementation of IWalletClient.addSecretKeysToWallet
- Defined in src/web3/WalletClient.ts:143

buyRolls

buyRolls(txData: IRollsData, executor?: IBaseAccount): Promise<string[]>
Buy rolls with wallet address.

Throws
if no sender account is available for the transaction.

Returns
a promise that resolves to an array of operations ids.
Parameters
- txData: IRollsData
  
  The transaction data
- Optional executor: IBaseAccount
  
  (Optional) The account that will execute the transaction. If not specified, the base account is used by default.
Returns Promise<string[]>
Implementation of IWalletClient.buyRolls
- Defined in src/web3/WalletClient.ts:532

cleanWallet

cleanWallet(): void
Removes all accounts from the wallet.

Returns void
Implementation of IWalletClient.cleanWallet
- Defined in src/web3/WalletClient.ts:115

`Protected` compactBytesForOperation

compactBytesForOperation(data: DataType, opTypeId: OperationTypeId, expirePeriod: number): Buffer
Compacts bytes payload per operation.

Returns
The compacted bytes payload.
Parameters
- data: DataType
  
  The operation data.
- opTypeId: OperationTypeId
  
  The operation type id.
- expirePeriod: number
  
  The expire period.
Returns Buffer
Implementation of IWalletClient.compactBytesForOperation

Inherited from BaseClient.compactBytesForOperation
- Defined in src/web3/BaseClient.ts:277

getAccountBalance

getAccountBalance(address: string): Promise<IBalance>
Retrieves the balance of an account.

Returns
A Promise that resolves to an IBalance. If the address is not found, it returns null.
Parameters
- address: string
  
  The address to get the balance from.
Returns Promise<IBalance>
Implementation of IWalletClient.getAccountBalance
- Defined in src/web3/WalletClient.ts:481

getBaseAccount

getBaseAccount(): IBaseAccount
Retrieves the default (base) account of the wallet.

Returns
The default IAccount of the wallet. If no default account is set, it returns null.

Returns IBaseAccount
Implementation of IWalletClient.getBaseAccount
- Defined in src/web3/WalletClient.ts:99

`Protected` getPrivateProviders

getPrivateProviders(): IProvider[]
Returns all the private providers.

Returns
An array of IProvider containing all the private providers.

Returns IProvider[]
Implementation of IWalletClient.getPrivateProviders

Inherited from BaseClient.getPrivateProviders
- Defined in src/web3/BaseClient.ts:113

`Protected` getPublicProviders

getPublicProviders(): IProvider[]
Returns all the public providers.

Returns
An array of IProvider containing all the public providers.

Returns IProvider[]
Implementation of IWalletClient.getPublicProviders

Inherited from BaseClient.getPublicProviders
- Defined in src/web3/BaseClient.ts:124

getWalletAccountByAddress

getWalletAccountByAddress(address: string): IAccount
Retrieves a wallet account based on its address.

Returns
The IAccount associated with the provided address or undefined if no account with the given address is found in the wallet.
Parameters
- address: string
  
  The address of the account to retrieve.
Returns IAccount
Implementation of IWalletClient.getWalletAccountByAddress
- Defined in src/web3/WalletClient.ts:128

getWalletAccounts

getWalletAccounts(): IAccount[]
Retrieves all accounts stored in the wallet.

Returns
An array of IAccount objects.

Returns IAccount[]
Implementation of IWalletClient.getWalletAccounts
- Defined in src/web3/WalletClient.ts:108

`Private` getWalletAddressesInfo

getWalletAddressesInfo(addresses: string[]): Promise<IAddressInfo[]>
Retrieves information about specified wallet addresses.

Returns
A Promise that resolves to an array of IAddressInfo objects, each containing information about a corresponding wallet address.
Parameters
- addresses: string[]
  
  An array of wallet addresses for which information is to be retrieved.
Returns Promise<IAddressInfo[]>
- Defined in src/web3/WalletClient.ts:380

removeAddressesFromWallet

removeAddressesFromWallet(addresses: string[]): void
Remove a list of addresses from the wallet.
Parameters
- addresses: string[]
  
  An array of addresses to remove from the wallet.
Returns void
Implementation of IWalletClient.removeAddressesFromWallet
- Defined in src/web3/WalletClient.ts:244

sellRolls

sellRolls(txData: IRollsData, executor?: IBaseAccount): Promise<string[]>
Sell rolls with wallet address.

Throws
if no sender account is available for the transaction.

Returns
a promise that resolves to an array of operations ids.
Parameters
- txData: IRollsData
  
  The transaction data.
- Optional executor: IBaseAccount
  
  (Optional) The account that will execute the transaction. If not specified, the base account is used by default.
Returns Promise<string[]>
Implementation of IWalletClient.sellRolls
- Defined in src/web3/WalletClient.ts:555

`Protected` sendJsonRPCRequest

sendJsonRPCRequest<T>(resource: JSON_RPC_REQUEST_METHOD, params: object): Promise<T>
Sends a post JSON rpc request to the node.

Throws
An error if the rpc method returns an error.

Returns
A promise that resolves as the result of the rpc method.
Type Parameters
- T
Parameters
- resource: JSON_RPC_REQUEST_METHOD
  
  The rpc method to call.
- params: object
  
  The parameters to pass to the rpc method.
Returns Promise<T>
Implementation of IWalletClient.sendJsonRPCRequest

Inherited from BaseClient.sendJsonRPCRequest
- Defined in src/web3/BaseClient.ts:252

sendTransaction

sendTransaction(txData: ITransactionData, executor?: IBaseAccount): Promise<string[]>
Sends native MAS from a wallet address to another.

Throws
if no sender account is available for the transaction.

Returns
a promise that resolves to an array of operations ids.
Parameters
- txData: ITransactionData
  
  The transaction data.
- Optional executor: IBaseAccount
  
  (Optional) The account that will execute the transaction. If not provided, the base account is used.
Returns Promise<string[]>
Implementation of IWalletClient.sendTransaction
- Defined in src/web3/WalletClient.ts:509

setBaseAccount

setBaseAccount(baseAccount: IBaseAccount): Promise<void>
Sets a provided account as the default (base) account for the wallet.

Returns
A Promise that resolves to void when the base account has been set successfully.
Parameters
- baseAccount: IBaseAccount
  
  An IAccount to be set as the base account.
Returns Promise<void>
Implementation of IWalletClient.setBaseAccount
- Defined in src/web3/WalletClient.ts:86

setProviders

setProviders(providers: IProvider[]): void
Set new providers as IProvider.

Throws
Will throw an error if no public providers are included in the given array of providers.

Throws
Will throw an error if no private providers are included in the given array of providers.
Parameters
- providers: IProvider[]
  
  The new providers to set as an array of IProvider.
Returns void
Implementation of IWalletClient.setProviders

Inherited from BaseClient.setProviders
- Defined in src/web3/BaseClient.ts:94

signMessage

signMessage(data: string | Buffer, accountSignerAddress: string): Promise<ISignature>
Signs a random message data using a wallet account that has already been added.

Throws
Will throw an error if the account associated with the provided address is not found in the wallet.

Returns
A Promise that resolves to an ISignature object representing the signature.
Parameters
- data: string | Buffer
  
  The data to be signed.
- accountSignerAddress: string
  
  The address of the wallet account that will sign the data.
Returns Promise<ISignature>
Implementation of IWalletClient.signMessage
- Defined in src/web3/WalletClient.ts:349

verifySignature

verifySignature(data: string | Buffer, signature: ISignature): Promise<boolean>
Verify a signature.

Returns
A Promise that resolves to true if the signature is valid, false otherwise.
Parameters
- data: string | Buffer
  
  The signed data to verify.
- signature: ISignature
  
  The signature to verify.
Returns Promise<boolean>
Implementation of IWalletClient.verifySignature
- Defined in src/web3/WalletClient.ts:430

walletInfo

walletInfo(): Promise<IFullAddressInfo[]>
Retrieves detailed information about the wallet.

Throws
Will throw an error if the number of retrieved wallets does not match the number of addresses in the wallet.

Returns
A Promise that resolves to an array of IFullAddressInfo objects.

Returns Promise<IFullAddressInfo[]>
Implementation of IWalletClient.walletInfo
- Defined in src/web3/WalletClient.ts:260

`Static` getAccountFromSecretKey

getAccountFromSecretKey(secretKeyBase58: string): Promise<IAccount>
Generates an account from a given private key.

Returns
A Promise that resolves to an IAccount object.
Parameters
- secretKeyBase58: string
  
  A base58 encoded private key from which the account will be generated.
Returns Promise<IAccount>
- Defined in src/web3/WalletClient.ts:321

`Static` walletGenerateNewAccount

walletGenerateNewAccount(): Promise<IAccount>
Generates a new wallet account.

Returns
A Promise that resolves to an IAccount object, which represents the newly created account.

Returns Promise<IAccount>
- Defined in src/web3/WalletClient.ts:291

`Static` walletSignMessage

walletSignMessage(data: string | Buffer, signer: IBaseAccount): Promise<ISignature>
Signs the provided data with the given address.

Remarks
The address must be present in the wallet.

Throws
- if no private key is available for signing the message.
- if no public key is available for verifying the signed message.
- if the length of the generated signature is not valid.
- if the signature could not be verified with the public key.
Returns
A Promise that resolves to an ISignature object representing the signature.
Parameters
- data: string | Buffer
  
  The data to be signed.
- signer: IBaseAccount
  
  The account that will be used to sign the data.
Returns Promise<ISignature>
- Defined in src/web3/WalletClient.ts:414

Class WalletClient

Remarks

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

clientConfig: IClientConfig

publicApiClient: PublicApiClient

Optional baseAccount: IBaseAccount

Returns WalletClient

Properties

Private Optional baseAccount

clientConfig

Private Readonly publicApiClient

Private wallet

Methods

addAccountsToWallet

Throws

Returns

Parameters

accounts: IAccount[]

Returns Promise<IAccount[]>

addSecretKeysToWallet

Throws

Returns

Parameters

secretKeys: string[]

Returns Promise<IAccount[]>

buyRolls

Throws

Returns

Parameters

txData: IRollsData

Optional executor: IBaseAccount

Returns Promise<string[]>

cleanWallet

Returns void

Protected compactBytesForOperation

Returns

Parameters

data: DataType

opTypeId: OperationTypeId

expirePeriod: number

Returns Buffer

getAccountBalance

Returns

Parameters

address: string

Returns Promise<IBalance>

getBaseAccount

Returns

Returns IBaseAccount

Protected getPrivateProviders

Returns

Returns IProvider[]

Protected getPublicProviders

Returns

Returns IProvider[]

getWalletAccountByAddress

Returns

Parameters

address: string

Returns IAccount

getWalletAccounts

Returns

Returns IAccount[]

Private getWalletAddressesInfo

Returns

Parameters

addresses: string[]

Returns Promise<IAddressInfo[]>

removeAddressesFromWallet

Parameters

addresses: string[]

Returns void

`Optional` baseAccount: IBaseAccount

`Private` `Optional` baseAccount

`Private` `Readonly` publicApiClient

`Private` wallet

`Optional` executor: IBaseAccount

`Protected` compactBytesForOperation

`Protected` getPrivateProviders

`Protected` getPublicProviders

`Private` getWalletAddressesInfo

`Optional` executor: IBaseAccount

`Protected` sendJsonRPCRequest

`Optional` executor: IBaseAccount

`Static` getAccountFromSecretKey

`Static` walletGenerateNewAccount

`Static` walletSignMessage