Class Web3RPCClient

Minimal version of Web3 RPC client For smart contract interaction

Index

Constructors

Properties

Methods

estimateGas gasPrice getBalance getBlockByNumber getLogs getNetworkId getTransactionCount getTransactionReceipt msgCall rpcRequest sendRawTransaction getInstance

Constructors

constructor

new Web3RPCClient(): Web3RPCClient
Returns Web3RPCClient

Properties

`Static` `Private` instance

instance: Web3RPCClient

Methods

estimateGas

estimateGas(callOptions, tag, options): Promise<bigint>
Estimates gas for a transaction This can be used to set the gas limit
Parameters
- callOptions: MessageCallOptions
  Calling options
- tag: BlockTag
  Tag that can be latest=last block or pending=last pending transaction
- options: RPCOptions
  RPC options
Returns Promise<bigint>
The estimated gas used by the transaction
- Defined in src/rpc-client.ts:153

gasPrice

gasPrice(options): Promise<bigint>
Gets the current gas price in wei
Parameters
- options: RPCOptions
  RPC options
Returns Promise<bigint>
The gas price
- Defined in src/rpc-client.ts:140

getBalance

getBalance(address, tag, options): Promise<bigint>
Get account balance
Parameters
- address: string
  Address (0x...)
- tag: BlockTag
  Tag that can be latest=last block or pending=last pending transaction
- options: RPCOptions
  RPC options
Returns Promise<bigint>
The account balance
- Defined in src/rpc-client.ts:184

getBlockByNumber

getBlockByNumber(num, options): Promise<BlockData>
Gets a block by number (required for certain calls)
Parameters
- num: string | number | bigint
  Block number
- options: RPCOptions
  RPC options
Returns Promise<BlockData>
The block data
- Defined in src/rpc-client.ts:77

getLogs

getLogs(filter, options): Promise<TransactionLog[]>
Gets transaction logs
Parameters
- filter: TransactionLogFilterOptions
  Block range and filter
- options: RPCOptions
  RPC options
Returns Promise<TransactionLog[]>
The array of transaction logs
- Defined in src/rpc-client.ts:281

getNetworkId

getNetworkId(options): Promise<bigint>
Gets the network ID This is used by default if the chain ID is not specified
Parameters
- options: RPCOptions
  RPC options
Returns Promise<bigint>
The network ID
- Defined in src/rpc-client.ts:130

getTransactionCount

getTransactionCount(address, tag, options): Promise<bigint>
Get transaction count (for next nonce)
Parameters
- address: string
  Address (0x...)
- tag: BlockTag
  Tag that can be latest=last block or pending=last pending transaction
- options: RPCOptions
  RPC options
Returns Promise<bigint>
The transaction count
- Defined in src/rpc-client.ts:172

getTransactionReceipt

getTransactionReceipt(txHash, options): Promise<TransactionReceipt>
Gets transaction receipt
Parameters
- txHash: BytesLike
  The transaction hash
- options: RPCOptions
  RPC options
Returns Promise<TransactionReceipt>
The transaction receipt, or null if the transaction is not mined yet
- Defined in src/rpc-client.ts:225

msgCall

msgCall(callOptions, tag, options): Promise<Buffer>
Performs a message call (for pure and view methods)
Parameters
- callOptions: MessageCallOptions
  Calling options
- tag: BlockTag
  Tag that can be latest=last block or pending=last pending transaction
- options: RPCOptions
  RPC options
Returns Promise<Buffer>
The results (ABI encoded)
- Defined in src/rpc-client.ts:196

rpcRequest

rpcRequest(method, params, options): Promise<any>
Performs a JSON-RPC request
Parameters
- method: string
  RPC Method
- params: any[]
  Method parameters
- options: RPCOptions
  Request options
Returns Promise<any>
The JSON RPC result
- Defined in src/rpc-client.ts:34

sendRawTransaction

sendRawTransaction(txData, options): Promise<Buffer>
Sends raw transaction
Parameters
- txData: BytesLike
  Signed transaction
- options: RPCOptions
  RPC options
Returns Promise<Buffer>
The transaction hash
- Defined in src/rpc-client.ts:214

`Static` getInstance

getInstance(): Web3RPCClient
Creates a singleton instance of Web3RPCClient

Returns Web3RPCClient
A singleton instance
- Defined in src/rpc-client.ts:20

Generated using TypeDoc