Skip to main content
Version: Next

Class: RpcChannel

RPC06.RpcChannel

Constructors​

constructor​

• new RpcChannel(optionsOrProvider?): RpcChannel

Parameters​

NameType
optionsOrProvider?RpcProviderOptions

Returns​

RpcChannel

Defined in​

src/channel/rpc_0_6.ts:60

Properties​

nodeUrl​

• nodeUrl: string

Defined in​

src/channel/rpc_0_6.ts:40

headers​

• headers: object

Defined in​

src/channel/rpc_0_6.ts:42

retries​

• Readonly retries: number

Defined in​

src/channel/rpc_0_6.ts:44

requestId​

• requestId: number

Defined in​

src/channel/rpc_0_6.ts:46

blockIdentifier​

• Readonly blockIdentifier: BlockIdentifier

Defined in​

src/channel/rpc_0_6.ts:48

chainId​

• Private Optional chainId: StarknetChainId

Defined in​

src/channel/rpc_0_6.ts:50

specVersion​

• Private Optional specVersion: string

Defined in​

src/channel/rpc_0_6.ts:52

transactionRetryIntervalFallback​

• Private Optional transactionRetryIntervalFallback: number

Defined in​

src/channel/rpc_0_6.ts:54

waitMode​

• Readonly waitMode: Boolean

Defined in​

src/channel/rpc_0_6.ts:56

batchClient​

• Private Optional batchClient: BatchClient

Defined in​

src/channel/rpc_0_6.ts:58

Accessors​

transactionRetryIntervalDefault​

• get transactionRetryIntervalDefault(): number

Returns​

number

Defined in​

src/channel/rpc_0_6.ts:97

Methods​

setChainId​

▸ setChainId(chainId): void

Parameters​

NameType
chainIdStarknetChainId

Returns​

void

Defined in​

src/channel/rpc_0_6.ts:101

fetch​

▸ fetch(method, params?, id?): Promise<Response>

Parameters​

NameTypeDefault value
methodstringundefined
params?objectundefined
idstring | number0

Returns​

Promise<Response>

Defined in​

src/channel/rpc_0_6.ts:105

errorHandler​

▸ errorHandler(method, params, rpcError?, otherError?): void

Parameters​

NameType
methodstring
paramsany
rpcError?Error
otherError?any

Returns​

void

Defined in​

src/channel/rpc_0_6.ts:119

fetchEndpoint​

▸ fetchEndpoint<T>(method, params?): Promise<Methods[T][``"result"``]>

Type parameters​

NameType
Textends keyof ReadMethods | keyof WriteMethods | keyof TraceMethods

Parameters​

NameType
methodT
params?Methods[T][``"params"``]

Returns​

Promise<Methods[T][``"result"``]>

Defined in​

src/channel/rpc_0_6.ts:135

getChainId​

▸ getChainId(): Promise<StarknetChainId>

Returns​

Promise<StarknetChainId>

Defined in​

src/channel/rpc_0_6.ts:160

getSpecVersion​

▸ getSpecVersion(): Promise<string>

Returns​

Promise<string>

Defined in​

src/channel/rpc_0_6.ts:165

getNonceForAddress​

▸ getNonceForAddress(contractAddress, blockIdentifier?): Promise<string>

Parameters​

NameType
contractAddressBigNumberish
blockIdentifierBlockIdentifier

Returns​

Promise<string>

Defined in​

src/channel/rpc_0_6.ts:170

getBlockLatestAccepted​

▸ getBlockLatestAccepted(): Promise<BlockHashAndNumber>

Get the most recent accepted block hash and number

Returns​

Promise<BlockHashAndNumber>

Defined in​

src/channel/rpc_0_6.ts:185

getBlockNumber​

▸ getBlockNumber(): Promise<number>

Get the most recent accepted block number redundant use getBlockLatestAccepted();

Returns​

Promise<number>

Number of the latest block

Defined in​

src/channel/rpc_0_6.ts:194

getBlockWithTxHashes​

▸ getBlockWithTxHashes(blockIdentifier?): Promise<BlockWithTxHashes>

Parameters​

NameType
blockIdentifierBlockIdentifier

Returns​

Promise<BlockWithTxHashes>

Defined in​

src/channel/rpc_0_6.ts:198

getBlockWithTxs​

▸ getBlockWithTxs(blockIdentifier?): Promise<BlockWithTxs>

Parameters​

NameType
blockIdentifierBlockIdentifier

Returns​

Promise<BlockWithTxs>

Defined in​

src/channel/rpc_0_6.ts:203

getBlockStateUpdate​

▸ getBlockStateUpdate(blockIdentifier?): Promise<StateUpdate>

Parameters​

NameType
blockIdentifierBlockIdentifier

Returns​

Promise<StateUpdate>

Defined in​

src/channel/rpc_0_6.ts:208

getBlockTransactionsTraces​

▸ getBlockTransactionsTraces(blockIdentifier?): Promise<BlockTransactionsTraces>

Parameters​

NameType
blockIdentifierBlockIdentifier

Returns​

Promise<BlockTransactionsTraces>

Defined in​

src/channel/rpc_0_6.ts:213

getBlockTransactionCount​

▸ getBlockTransactionCount(blockIdentifier?): Promise<number>

Parameters​

NameType
blockIdentifierBlockIdentifier

Returns​

Promise<number>

Defined in​

src/channel/rpc_0_6.ts:218

getTransactionByHash​

▸ getTransactionByHash(txHash): Promise<TransactionWithHash>

Parameters​

NameType
txHashBigNumberish

Returns​

Promise<TransactionWithHash>

Defined in​

src/channel/rpc_0_6.ts:223

getTransactionByBlockIdAndIndex​

▸ getTransactionByBlockIdAndIndex(blockIdentifier, index): Promise<TransactionWithHash>

Parameters​

NameType
blockIdentifierBlockIdentifier
indexnumber

Returns​

Promise<TransactionWithHash>

Defined in​

src/channel/rpc_0_6.ts:230

getTransactionReceipt​

▸ getTransactionReceipt(txHash): Promise<TransactionReceipt>

Parameters​

NameType
txHashBigNumberish

Returns​

Promise<TransactionReceipt>

Defined in​

src/channel/rpc_0_6.ts:235

getTransactionTrace​

▸ getTransactionTrace(txHash): Promise<TRANSACTION_TRACE>

Parameters​

NameType
txHashBigNumberish

Returns​

Promise<TRANSACTION_TRACE>

Defined in​

src/channel/rpc_0_6.ts:240

getTransactionStatus​

▸ getTransactionStatus(transactionHash): Promise<TransactionStatus>

Get the status of a transaction

Parameters​

NameType
transactionHashBigNumberish

Returns​

Promise<TransactionStatus>

Defined in​

src/channel/rpc_0_6.ts:248

simulateTransaction​

▸ simulateTransaction(invocations, simulateTransactionOptions?): Promise<SimulateTransactionResponse>

Parameters​

NameTypeDescription
invocationsAccountInvocationsAccountInvocations
simulateTransactionOptionsgetSimulateTransactionOptionsblockIdentifier and flags to skip validation and fee charge
- blockIdentifier
- skipValidate (default false)
- skipFeeCharge (default true)

Returns​

Promise<SimulateTransactionResponse>

Defined in​

src/channel/rpc_0_6.ts:260

waitForTransaction​

▸ waitForTransaction(txHash, options?): Promise<TXN_RECEIPT>

Parameters​

NameType
txHashBigNumberish
options?waitForTransactionOptions

Returns​

Promise<TXN_RECEIPT>

Defined in​

src/channel/rpc_0_6.ts:281

getStorageAt​

▸ getStorageAt(contractAddress, key, blockIdentifier?): Promise<string>

Parameters​

NameType
contractAddressBigNumberish
keyBigNumberish
blockIdentifierBlockIdentifier

Returns​

Promise<string>

Defined in​

src/channel/rpc_0_6.ts:363

getClassHashAt​

▸ getClassHashAt(contractAddress, blockIdentifier?): Promise<string>

Parameters​

NameType
contractAddressBigNumberish
blockIdentifierBlockIdentifier

Returns​

Promise<string>

Defined in​

src/channel/rpc_0_6.ts:378

getClass​

▸ getClass(classHash, blockIdentifier?): Promise<ContractClass>

Parameters​

NameType
classHashBigNumberish
blockIdentifierBlockIdentifier

Returns​

Promise<ContractClass>

Defined in​

src/channel/rpc_0_6.ts:390

getClassAt​

▸ getClassAt(contractAddress, blockIdentifier?): Promise<ContractClass>

Parameters​

NameType
contractAddressBigNumberish
blockIdentifierBlockIdentifier

Returns​

Promise<ContractClass>

Defined in​

src/channel/rpc_0_6.ts:402

getEstimateFee​

▸ getEstimateFee(invocations, «destructured»): Promise<FEE_ESTIMATE[]>

Parameters​

NameType
invocationsAccountInvocations
«destructured»getEstimateFeeBulkOptions

Returns​

Promise<FEE_ESTIMATE[]>

Defined in​

src/channel/rpc_0_6.ts:414

invoke​

▸ invoke(functionInvocation, details): Promise<InvokedTransaction>

Parameters​

NameType
functionInvocationInvocation
detailsInvocationsDetailsWithNonce

Returns​

Promise<InvokedTransaction>

Defined in​

src/channel/rpc_0_6.ts:433

declare​

▸ declare(«destructured», details): Promise<TXN_RECEIPT | DeclaredTransaction>

Parameters​

NameType
«destructured»DeclareContractTransaction
detailsInvocationsDetailsWithNonce

Returns​

Promise<TXN_RECEIPT | DeclaredTransaction>

Defined in​

src/channel/rpc_0_6.ts:471

deployAccount​

▸ deployAccount(«destructured», details): Promise<TXN_RECEIPT | DeployedAccountTransaction>

Parameters​

NameType
«destructured»DeployAccountContractTransaction
detailsInvocationsDetailsWithNonce

Returns​

Promise<TXN_RECEIPT | DeployedAccountTransaction>

Defined in​

src/channel/rpc_0_6.ts:543

callContract​

▸ callContract(call, blockIdentifier?): Promise<string[]>

Parameters​

NameType
callCall
blockIdentifierBlockIdentifier

Returns​

Promise<string[]>

Defined in​

src/channel/rpc_0_6.ts:585

estimateMessageFee​

▸ estimateMessageFee(message, blockIdentifier?): Promise<FEE_ESTIMATE>

NEW: Estimate the fee for a message from L1

Parameters​

NameTypeDescription
messageMSG_FROM_L1Message From L1
blockIdentifierBlockIdentifier-

Returns​

Promise<FEE_ESTIMATE>

Defined in​

src/channel/rpc_0_6.ts:601

getSyncingStats​

▸ getSyncingStats(): Promise<Syncing>

Returns an object about the sync status, or false if the node is not synching

Returns​

Promise<Syncing>

Object with the stats data

Defined in​

src/channel/rpc_0_6.ts:624

getEvents​

▸ getEvents(eventFilter): Promise<EVENTS_CHUNK>

Returns all events matching the given filter

Parameters​

NameType
eventFilterEventFilter

Returns​

Promise<EVENTS_CHUNK>

events and the pagination of the events

Defined in​

src/channel/rpc_0_6.ts:632

buildTransaction​

▸ buildTransaction(invocation, versionType?): BROADCASTED_TXN

Parameters​

NameType
invocationAccountInvocationItem
versionType?"fee" | "transaction"

Returns​

BROADCASTED_TXN

Defined in​

src/channel/rpc_0_6.ts:636