Class EthereumClient

Hierarchy

EthereumClient

Constructors

constructor

new EthereumClient(options: EthereumClientOptions, accountSignatureDAL?: EthereumAccountTransactionHistoryStorage, logBloomDAL?: EthereumLogBloomStorage, blockchainId?: Blockchain): EthereumClient
Parameters
- options: EthereumClientOptions
- Optional accountSignatureDAL: EthereumAccountTransactionHistoryStorage
- Optional logBloomDAL: EthereumLogBloomStorage
- blockchainId: Blockchain = Blockchain.Ethereum
Returns EthereumClient
- Defined in packages/ethereum/src/sdk/client.ts:99

Properties

`Protected` `Optional` accountSignatureDAL

accountSignatureDAL?: EthereumAccountTransactionHistoryStorage

`Protected` blockchainId

blockchainId: Blockchain = Blockchain.Ethereum

`Protected` `Optional` logBloomDAL

logBloomDAL?: EthereumLogBloomStorage

`Protected` options

options: EthereumClientOptions

`Protected` sdk

sdk: default

Methods

`Protected` batchRequest

batchRequest<T, A, S, R>(method: keyof Eth, args: A[], options?: {
swallowErrors?: S;
}): Promise<R>
Type Parameters
- T
- A extends unknown[]
- S extends boolean
- R = S extends false ? T[] : (null | T)[]
Parameters
- method: keyof Eth
- args: A[]
- Optional options: {
  swallowErrors?: S;
  }
  - Optional swallowErrors?: S
Returns Promise<R>
- Defined in packages/ethereum/src/sdk/client.ts:481

`Protected` completeBlocksInfo

completeBlocksInfo<S, R>(block: null | Block, swallowErrors?: S): R
Type Parameters
- S extends boolean
- R = S extends false ? EthereumRawBlock : null | EthereumRawBlock
Parameters
- block: null | Block
- Optional swallowErrors: S
Returns R
- Defined in packages/ethereum/src/sdk/client.ts:719

`Protected` completeLogsWithBlockInfo

completeLogsWithBlockInfo<S, R>(log: null | Log, swallowErrors?: S): Promise<R>
Type Parameters
- S extends boolean
- R = S extends false ? EthereumRawLog : null | EthereumRawLog
Parameters
- log: null | Log
- Optional swallowErrors: S
Returns Promise<R>
- Defined in packages/ethereum/src/sdk/client.ts:773

`Protected` completeTransactionsWithBlockInfo

completeTransactionsWithBlockInfo<S, R>(tx: null | Transaction, swallowErrors?: S): Promise<R>
Type Parameters
- S extends boolean
- R = S extends false ? EthereumRawTransaction : null | EthereumRawTransaction
Parameters
- tx: null | Transaction
- Optional swallowErrors: S
Returns Promise<R>
- Defined in packages/ethereum/src/sdk/client.ts:735

getBalance

getBalance(account: string): Promise<string>
Parameters
- account: string
Returns Promise<string>
- Defined in packages/ethereum/src/sdk/client.ts:112

`Protected` getBlockHistoryChunk

getBlockHistoryChunk(__namedParameters: EthereumBlocksChunkOptions): Promise<EthereumBlocksChunkResponse>
Parameters
- __namedParameters: EthereumBlocksChunkOptions
Returns Promise<EthereumBlocksChunkResponse>
- Defined in packages/ethereum/src/sdk/client.ts:547

`Protected` getBlockLogs

getBlockLogs<S, R>(blockHashOrBlockNumber: (string | number)[], swallowErrors?: S, address?: string): Promise<R[]>
Type Parameters
- S extends boolean
- R = S extends false ? EthereumRawLog : null | EthereumRawLog
Parameters
- blockHashOrBlockNumber: (string | number)[]
- Optional swallowErrors: S
- Optional address: string
Returns Promise<R[]>
- Defined in packages/ethereum/src/sdk/client.ts:455

`Protected` getBlocks

getBlocks(blockHashOrBlockNumber: (string | number)[], returnTransactionObjects?: boolean): Promise<EthereumRawBlock[]>
Parameters
- blockHashOrBlockNumber: (string | number)[]
- returnTransactionObjects: boolean = true
Returns Promise<EthereumRawBlock[]>
- Defined in packages/ethereum/src/sdk/client.ts:434

`Protected` getLogHistoryChunk

getLogHistoryChunk(__namedParameters: EthereumLogsChunkOptions): Promise<EthereumLogsChunkResponse>
Parameters
- __namedParameters: EthereumLogsChunkOptions
Returns Promise<EthereumLogsChunkResponse>
- Defined in packages/ethereum/src/sdk/client.ts:641

getLogs

getLogs(ids: string[], options?: {
swallowErrors: boolean;
}): Promise<(null | EthereumRawLog)[]>
Parameters
- ids: string[]
- Optional options: {
  swallowErrors: boolean;
  }
  - swallowErrors: boolean
Returns Promise<(null | EthereumRawLog)[]>
- Defined in packages/ethereum/src/sdk/client.ts:135

getSDK

getSDK(): default
Returns default
- Defined in packages/ethereum/src/sdk/client.ts:108

`Protected` getTransactionHistoryChunk

getTransactionHistoryChunk(__namedParameters: EthereumSignaturesChunkOptions): Promise<EthereumSignaturesChunkResponse>
Parameters
- __namedParameters: EthereumSignaturesChunkOptions
Returns Promise<EthereumSignaturesChunkResponse>
- Defined in packages/ethereum/src/sdk/client.ts:590

getTransactions

getTransactions(signatures: string[], options?: {
swallowErrors: boolean;
}): Promise<(null | EthereumRawTransaction)[]>
Parameters
- signatures: string[]
- Optional options: {
  swallowErrors: boolean;
  }
  - swallowErrors: boolean
Returns Promise<(null | EthereumRawTransaction)[]>
- Defined in packages/ethereum/src/sdk/client.ts:116

indexBlockAccountTransactions

indexBlockAccountTransactions(blocks: EthereumRawBlock[]): Promise<void>
Parameters
- blocks: EthereumRawBlock[]
Returns Promise<void>
- Defined in packages/ethereum/src/sdk/client.ts:391

indexBlockLogBloom

indexBlockLogBloom(blocks: EthereumRawBlock[]): Promise<void>
Parameters
- blocks: EthereumRawBlock[]
Returns Promise<void>
- Defined in packages/ethereum/src/sdk/client.ts:419

isContractAddress

isContractAddress(address: string): Promise<boolean>
Parameters
- address: string
Returns Promise<boolean>
- Defined in packages/ethereum/src/sdk/client.ts:180

parseLog

parseLog(rawLog: EthereumRawLog, abi?: any): EthereumParsedLog
Parameters
- rawLog: EthereumRawLog
- Optional abi: any
Returns EthereumParsedLog
- Defined in packages/ethereum/src/sdk/client.ts:203

parseTransaction

parseTransaction(rawTx: EthereumRawTransaction, abi?: any): EthereumParsedTransaction
Parameters
- rawTx: EthereumRawTransaction
- Optional abi: any
Returns EthereumParsedTransaction
- Defined in packages/ethereum/src/sdk/client.ts:187

`Protected` processJsonRpcResult

processJsonRpcResult<T>(result: T | T[], swallowErrors?: boolean): null | T | (null | T)[]
Type Parameters
- T extends {
      error?: Error;
      id: string;
      jsonrpc: string;
      result: any;
  }
Parameters
- result: T | T[]
- swallowErrors: boolean = false
Returns null | T | (null | T)[]
- Defined in packages/ethereum/src/sdk/client.ts:503

Class EthereumClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: EthereumClientOptions

Optional accountSignatureDAL: EthereumAccountTransactionHistoryStorage

Optional logBloomDAL: EthereumLogBloomStorage

blockchainId: Blockchain = Blockchain.Ethereum

Returns EthereumClient

Properties

Protected Optional accountSignatureDAL

Protected blockchainId

Protected Optional logBloomDAL

Protected options

Protected sdk

Methods

Protected batchRequest

Type Parameters

T

A extends unknown[]

S extends boolean

R = S extends false ? T[] : (null | T)[]

Parameters

method: keyof Eth

args: A[]

Optional options: { swallowErrors?: S; }

Optional swallowErrors?: S

Returns Promise<R>

Protected completeBlocksInfo

Type Parameters

S extends boolean

R = S extends false ? EthereumRawBlock : null | EthereumRawBlock

Parameters

block: null | Block

Optional swallowErrors: S

Returns R

Protected completeLogsWithBlockInfo

Type Parameters

S extends boolean

R = S extends false ? EthereumRawLog : null | EthereumRawLog

Parameters

log: null | Log

Optional swallowErrors: S

Returns Promise<R>

Protected completeTransactionsWithBlockInfo

Type Parameters

S extends boolean

R = S extends false ? EthereumRawTransaction : null | EthereumRawTransaction

Parameters

tx: null | Transaction

Optional swallowErrors: S

Returns Promise<R>

fetchBlockHistory

Parameters

args: EthereumFetchBlocksOptions

Returns AsyncGenerator<EthereumBlockPaginationResponse, any, unknown>

fetchLogHistory

Parameters

args: EthereumFetchLogsOptions

Returns AsyncGenerator<EthereumLogHistoryPaginationResponse, any, unknown>

fetchTransactionHistory

Parameters

args: EthereumFetchSignaturesOptions

Returns AsyncGenerator<EthereumTransactionHistoryPaginationResponse, any, unknown>

getBalance

Parameters

account: string

Returns Promise<string>

Protected getBlockHistoryChunk

Parameters

__namedParameters: EthereumBlocksChunkOptions

Returns Promise<EthereumBlocksChunkResponse>

Protected getBlockLogs

Type Parameters

S extends boolean

`Optional` accountSignatureDAL: EthereumAccountTransactionHistoryStorage

`Optional` logBloomDAL: EthereumLogBloomStorage

`Protected` `Optional` accountSignatureDAL

`Protected` blockchainId

`Protected` `Optional` logBloomDAL

`Protected` options

`Protected` sdk

`Protected` batchRequest

`Optional` options: {
swallowErrors?: S;
}

`Optional` swallowErrors?: S

`Protected` completeBlocksInfo

`Optional` swallowErrors: S

`Protected` completeLogsWithBlockInfo

`Optional` swallowErrors: S

`Protected` completeTransactionsWithBlockInfo

`Optional` swallowErrors: S

`Protected` getBlockHistoryChunk

`Protected` getBlockLogs

`Optional` swallowErrors: S

`Optional` address: string

`Protected` getBlocks

`Protected` getLogHistoryChunk

`Optional` options: {
swallowErrors: boolean;
}

`Protected` getTransactionHistoryChunk

`Optional` options: {
swallowErrors: boolean;
}

`Optional` abi: any

`Optional` abi: any

`Protected` processJsonRpcResult

T extends {
error?: Error;
id: string;
jsonrpc: string;
result: any;
}