@cfxdevkit/core

@cfxdevkit/core / ChainClient

Interface: ChainClient

Defined in: packages/core/src/types/clients.ts:35

Unified interface for both Core and EVM clients Abstracts away the differences between cive and viem

Extended by

• TestClient

Properties

address

readonly address: string

Defined in: packages/core/src/types/clients.ts:38

chainId

readonly chainId: number

Defined in: packages/core/src/types/clients.ts:37

chainType

readonly chainType: ChainType

Defined in: packages/core/src/types/clients.ts:36

Methods

callContract()

callContract<T>(address, abi, functionName, args?): Promise<T>

Defined in: packages/core/src/types/clients.ts:56

Type Parameters

T

T = unknown

Parameters

address

string

abi

unknown[]

functionName

string

args?

unknown[]

Returns

Promise<T>

estimateGas()

estimateGas(tx): Promise<bigint>

Defined in: packages/core/src/types/clients.ts:46

Parameters

tx

BaseTransaction

Returns

Promise<bigint>

formatAmount()

formatAmount(amount): string

Defined in: packages/core/src/types/clients.ts:75

Parameters

amount

bigint

Returns

string

getBalance()

getBalance(address): Promise<string>

Defined in: packages/core/src/types/clients.ts:42

Parameters

address

string

Returns

Promise<string>

getBalanceRaw()

getBalanceRaw(address): Promise<bigint>

Defined in: packages/core/src/types/clients.ts:43

Parameters

address

string

Returns

Promise<bigint>

getBlockNumber()

getBlockNumber(): Promise<bigint>

Defined in: packages/core/src/types/clients.ts:41

Returns

Promise<bigint>

getChainId()

getChainId(): Promise<number>

Defined in: packages/core/src/types/clients.ts:45

Returns

Promise<number>

getGasPrice()

getGasPrice(): Promise<bigint>

Defined in: packages/core/src/types/clients.ts:44

Returns

Promise<bigint>

getInternalClient()

getInternalClient(): unknown

Defined in: packages/core/src/types/clients.ts:79

Returns

unknown

getTokenBalance()

getTokenBalance(tokenAddress, holderAddress?): Promise<string>

Defined in: packages/core/src/types/clients.ts:64

Parameters

tokenAddress

string

holderAddress?

string

Returns

Promise<string>

isValidAddress()

isValidAddress(address): boolean

Defined in: packages/core/src/types/clients.ts:74

Parameters

address

string

Returns

boolean

parseAmount()

parseAmount(amount): bigint

Defined in: packages/core/src/types/clients.ts:76

Parameters

amount

string

Returns

bigint

sendTransaction()

sendTransaction(tx): Promise<string>

Defined in: packages/core/src/types/clients.ts:49

Parameters

tx

BaseTransaction

Returns

Promise<string>

waitForTransaction()

waitForTransaction(hash, timeout?): Promise<TransactionReceipt>

Defined in: packages/core/src/types/clients.ts:50

Parameters

hash

string

timeout?

number

Returns

Promise<TransactionReceipt>

watchBlocks()

watchBlocks(callback): UnwatchFunction

Defined in: packages/core/src/types/clients.ts:70

Parameters

callback

EventCallback<BlockEvent>

Returns

UnwatchFunction

watchTransactions()

watchTransactions(callback): UnwatchFunction

Defined in: packages/core/src/types/clients.ts:71

Parameters

callback

EventCallback<TransactionEvent>

Returns

UnwatchFunction