Interface IWalletClient

Interface for WalletClient objects

See

setBaseAccount - set base account for wallet
getBaseAccount - get base account for wallet
getWalletAccounts - get all accounts in wallet
cleanWallet - delete all accounts from wallet
getWalletAccountByAddress - get account by address
addSecretKeysToWallet - add accounts to wallet by secret keys
addAccountsToWallet - add accounts to wallet
removeAddressesFromWallet - remove accounts from wallet
walletInfo - get all accounts info
signMessage - sign message by account
getAccountBalance - get account balance
sendTransaction - send transaction
buyRolls - buy rolls
sellRolls - sell rolls

interface IWalletClient {
    clientConfig: IClientConfig;
    addAccountsToWallet(accounts): Promise<IAccount[]>;
    addSecretKeysToWallet(secretKeys): Promise<IAccount[]>;
    buyRolls(txData, executor?): Promise<string[]>;
    cleanWallet(): void;
    compactBytesForOperation(data, opTypeId, expirePeriod): Buffer;
    getAccountBalance(address): Promise<IBalance>;
    getBaseAccount(): IBaseAccount;
    getPrivateProviders(): IProvider[];
    getPublicProviders(): IProvider[];
    getWalletAccountByAddress(address): IAccount;
    getWalletAccounts(): IAccount[];
    removeAddressesFromWallet(addresses): void;
    sellRolls(txData, executor): Promise<string[]>;
    sendJsonRPCRequest<T>(resource, params): Promise<T>;
    sendTransaction(txData, executor?): Promise<string[]>;
    setBaseAccount(baseAccount): void;
    setProviders(providers): void;
    signMessage(data, chainId, accountSignerAddress): Promise<ISignature>;
    verifySignature(data, signature, signerPublicKey): Promise<boolean>;
    walletInfo(): Promise<IFullAddressInfo[]>;
}

Hierarchy

BaseClient
- IWalletClient

Implemented by

WalletClient

Properties

clientConfig

clientConfig: IClientConfig

Methods

addAccountsToWallet

addAccountsToWallet(accounts): Promise<IAccount[]>
Add accounts to the wallet.
Parameters
- accounts: IAccount[]
  An array of IAccount objects.
Returns Promise<IAccount[]>
A promise that resolves to an array of IAccount objects.
- Defined in packages/massa-web3/src/interfaces/IWalletClient.ts:80

addSecretKeysToWallet

addSecretKeysToWallet(secretKeys): Promise<IAccount[]>
Add accounts to the wallet by secret keys.
Parameters
- secretKeys: string[]
  An array of secret keys.
Returns Promise<IAccount[]>
A promise that resolves to an array of IAccount.
- Defined in packages/massa-web3/src/interfaces/IWalletClient.ts:71

buyRolls

buyRolls(txData, executor?): Promise<string[]>
Buy rolls.
Parameters
- txData: IRollsData
  The transaction data.
- Optional executor: IBaseAccount
  The account used to send the transaction.
Returns Promise<string[]>
A promise that resolves to an array of operation ids as strings.
- Defined in packages/massa-web3/src/interfaces/IWalletClient.ts:156

cleanWallet

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

Returns void
- Defined in packages/massa-web3/src/interfaces/IWalletClient.ts:53

`Protected` compactBytesForOperation

compactBytesForOperation(data, opTypeId, expirePeriod): Buffer
Compacts bytes payload per operation.
Parameters
- data: DataType
  The operation data.
- opTypeId: OperationTypeId
  The operation type id.
- expirePeriod: number
  The expire period.
Returns Buffer
The compacted bytes payload.
Inherited from BaseClient.compactBytesForOperation
- Defined in packages/massa-web3/src/web3/BaseClient.ts:260

getAccountBalance

getAccountBalance(address): Promise<IBalance>
Get the account balance.
Parameters
- address: string
  The address of the account.
Returns Promise<IBalance>
A promise that resolves to an IBalance object or null if not found.
- Defined in packages/massa-web3/src/interfaces/IWalletClient.ts:133

getBaseAccount

getBaseAccount(): IBaseAccount
Get the base account.

Returns IBaseAccount
The base account (or null if the base account is not set).
- Defined in packages/massa-web3/src/interfaces/IWalletClient.ts:41

`Protected` getPrivateProviders

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

Returns IProvider[]
An array of IProvider containing all the private providers.
Inherited from BaseClient.getPrivateProviders
- Defined in packages/massa-web3/src/web3/BaseClient.ts:93

`Protected` getPublicProviders

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

Returns IProvider[]
An array of IProvider containing all the public providers.
Inherited from BaseClient.getPublicProviders
- Defined in packages/massa-web3/src/web3/BaseClient.ts:104

getWalletAccountByAddress

getWalletAccountByAddress(address): IAccount
Get an account by its address.
Parameters
- address: string
  The address of the account.
Returns IAccount
An IAccount object or undefined if not found.
- Defined in packages/massa-web3/src/interfaces/IWalletClient.ts:62

getWalletAccounts

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

Returns IAccount[]
An array of IAccount objects.
- Defined in packages/massa-web3/src/interfaces/IWalletClient.ts:48

removeAddressesFromWallet

removeAddressesFromWallet(addresses): void
Remove accounts from the wallet using their addresses.
Parameters
- addresses: string[]
  An array of addresses.
Returns void
- Defined in packages/massa-web3/src/interfaces/IWalletClient.ts:87

sellRolls

sellRolls(txData, executor): Promise<string[]>
Sell rolls.
Parameters
- txData: IRollsData
  The transaction data.
- executor: IBaseAccount
  The account used to send the transaction.
Returns Promise<string[]>
A promise that resolves to an array of operation ids as strings.
- Defined in packages/massa-web3/src/interfaces/IWalletClient.ts:166

`Protected` sendJsonRPCRequest

sendJsonRPCRequest<T>(resource, params): Promise<T>
Sends a post JSON rpc request to the node.
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>
A promise that resolves as the result of the rpc method.

Throws
An error if the rpc method returns an error.
Inherited from BaseClient.sendJsonRPCRequest
- Defined in packages/massa-web3/src/web3/BaseClient.ts:235

sendTransaction

sendTransaction(txData, executor?): Promise<string[]>
Send a transaction.
Parameters
- txData: ITransactionData
  The transaction data.
- Optional executor: IBaseAccount
  The account used to send the transaction.
Returns Promise<string[]>
A promise that resolves to an array of operation ids as strings.
- Defined in packages/massa-web3/src/interfaces/IWalletClient.ts:143

setBaseAccount

setBaseAccount(baseAccount): void
Set the base account.
Parameters
- baseAccount: IBaseAccount
  The base account as an IAccount object.
Returns void
- Defined in packages/massa-web3/src/interfaces/IWalletClient.ts:34

setProviders

setProviders(providers): void
Set new providers as IProvider.
Parameters
- providers: IProvider[]
  The new providers to set as an array of IProvider.
Returns void
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.
Inherited from BaseClient.setProviders
- Defined in packages/massa-web3/src/web3/BaseClient.ts:74

signMessage

signMessage(data, chainId, accountSignerAddress): Promise<ISignature>
Sign a message using a specific account.
Parameters
- data: string | Buffer
  The message to sign.
- chainId: bigint
- accountSignerAddress: string
  The address of the account used to sign the message.
Returns Promise<ISignature>
A promise that resolves to the signed data as an ISignature object.
- Defined in packages/massa-web3/src/interfaces/IWalletClient.ts:104

verifySignature

verifySignature(data, signature, signerPublicKey): Promise<boolean>
Verify a signature.
Parameters
- data: string | Buffer
  The message to verify.
- signature: ISignature
  The signature to verify.
- signerPublicKey: string
  The public key of the signer.
Returns Promise<boolean>
A promise that resolves to a boolean (true if the signature is valid, false otherwise).
- Defined in packages/massa-web3/src/interfaces/IWalletClient.ts:120

walletInfo

walletInfo(): Promise<IFullAddressInfo[]>
Get all accounts info.

Returns Promise<IFullAddressInfo[]>
A promise that resolves to an array of IFullAddressInfo objects.
- Defined in packages/massa-web3/src/interfaces/IWalletClient.ts:94

Interface IWalletClient

See

Hierarchy

Implemented by

Index

Properties

Methods

Properties

clientConfig

Methods

addAccountsToWallet

Parameters

accounts: IAccount[]

Returns Promise<IAccount[]>

addSecretKeysToWallet

Parameters

secretKeys: string[]

Returns Promise<IAccount[]>

buyRolls

Parameters

txData: IRollsData

Optional executor: IBaseAccount

Returns Promise<string[]>

cleanWallet

Returns void

Protected compactBytesForOperation

Parameters

data: DataType

opTypeId: OperationTypeId

expirePeriod: number

Returns Buffer

getAccountBalance

Parameters

address: string

Returns Promise<IBalance>

getBaseAccount

Returns IBaseAccount

Protected getPrivateProviders

Returns IProvider[]

Protected getPublicProviders

Returns IProvider[]

getWalletAccountByAddress

Parameters

address: string

Returns IAccount

getWalletAccounts

Returns IAccount[]

removeAddressesFromWallet

Parameters

addresses: string[]

Returns void

sellRolls

Parameters

txData: IRollsData

executor: IBaseAccount

Returns Promise<string[]>

Protected sendJsonRPCRequest

Type Parameters

T

Parameters

resource: JSON_RPC_REQUEST_METHOD

params: object

Returns Promise<T>

Throws

sendTransaction

Parameters

txData: ITransactionData

Optional executor: IBaseAccount

Returns Promise<string[]>

setBaseAccount

Parameters

baseAccount: IBaseAccount

Returns void

setProviders

Parameters

providers: IProvider[]

Returns void

Throws

Throws

signMessage

`Optional` executor: IBaseAccount

`Protected` compactBytesForOperation

`Protected` getPrivateProviders

`Protected` getPublicProviders

`Protected` sendJsonRPCRequest

`Optional` executor: IBaseAccount