Class: RpcChannel

RPC06.RpcChannel

Constructors

constructor

• new RpcChannel(optionsOrProvider?): RpcChannel

Parameters

Name	Type
optionsOrProvider?	RpcProviderOptions

Returns

RpcChannel

Defined in

src/channel/rpc_0_6.ts:55

Properties

nodeUrl

• nodeUrl: string

Defined in

src/channel/rpc_0_6.ts:39

---

headers

• headers: object

Defined in

src/channel/rpc_0_6.ts:41

---

retries

• Readonly retries: number

Defined in

src/channel/rpc_0_6.ts:43

---

requestId

• requestId: number

Defined in

src/channel/rpc_0_6.ts:45

---

blockIdentifier

• Readonly blockIdentifier: BlockIdentifier

Defined in

src/channel/rpc_0_6.ts:47

---

chainId

• Private Optional chainId: StarknetChainId

Defined in

src/channel/rpc_0_6.ts:49

---

specVersion

• Private Optional specVersion: string

Defined in

src/channel/rpc_0_6.ts:51

---

waitMode

• Readonly waitMode: Boolean

Defined in

src/channel/rpc_0_6.ts:53

Methods

setChainId

▸ setChainId(chainId): void

Parameters

Name	Type
chainId	StarknetChainId

Returns

void

Defined in

src/channel/rpc_0_6.ts:74

---

fetch

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

Parameters

Name	Type	Default value
method	string	undefined
params?	object	undefined
id	string | number	0

Returns

Promise<Response>

Defined in

src/channel/rpc_0_6.ts:78

---

errorHandler

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

Parameters

Name	Type
method	string
params	any
rpcError?	Error
otherError?	any

Returns

void

Defined in

src/channel/rpc_0_6.ts:92

---

fetchEndpoint

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

Type parameters

Name	Type
T	extends keyof ReadMethods | keyof WriteMethods | keyof TraceMethods

Parameters

Name	Type
method	T
params?	Methods[T][``"params"``]

Returns

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

Defined in

src/channel/rpc_0_6.ts:108

---

getChainId

▸ getChainId(): Promise<StarknetChainId>

Returns

Promise<StarknetChainId>

Defined in

src/channel/rpc_0_6.ts:123

---

getSpecVersion

▸ getSpecVersion(): Promise<string>

Returns

Promise<string>

Defined in

src/channel/rpc_0_6.ts:128

---

getNonceForAddress

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

Parameters

Name	Type
contractAddress	BigNumberish
blockIdentifier	BlockIdentifier

Returns

Promise<string>

Defined in

src/channel/rpc_0_6.ts:133

---

getBlockLatestAccepted

▸ getBlockLatestAccepted(): Promise<BlockHashAndNumber>

Get the most recent accepted block hash and number

Returns

Promise<BlockHashAndNumber>

Defined in

src/channel/rpc_0_6.ts:148

---

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:157

---

getBlockWithTxHashes

▸ getBlockWithTxHashes(blockIdentifier?): Promise<BlockWithTxHashes>

Parameters

Name	Type
blockIdentifier	BlockIdentifier

Returns

Promise<BlockWithTxHashes>

Defined in

src/channel/rpc_0_6.ts:161

---

getBlockWithTxs

▸ getBlockWithTxs(blockIdentifier?): Promise<BlockWithTxs>

Parameters

Name	Type
blockIdentifier	BlockIdentifier

Returns

Promise<BlockWithTxs>

Defined in

src/channel/rpc_0_6.ts:166

---

getBlockStateUpdate

▸ getBlockStateUpdate(blockIdentifier?): Promise<StateUpdate>

Parameters

Name	Type
blockIdentifier	BlockIdentifier

Returns

Promise<StateUpdate>

Defined in

src/channel/rpc_0_6.ts:171

---

getBlockTransactionsTraces

▸ getBlockTransactionsTraces(blockIdentifier?): Promise<BlockTransactionsTraces>

Parameters

Name	Type
blockIdentifier	BlockIdentifier

Returns

Promise<BlockTransactionsTraces>

Defined in

src/channel/rpc_0_6.ts:176

---

getBlockTransactionCount

▸ getBlockTransactionCount(blockIdentifier?): Promise<number>

Parameters

Name	Type
blockIdentifier	BlockIdentifier

Returns

Promise<number>

Defined in

src/channel/rpc_0_6.ts:181

---

getTransactionByHash

▸ getTransactionByHash(txHash): Promise<TransactionWithHash>

Parameters

Name	Type
txHash	BigNumberish

Returns

Promise<TransactionWithHash>

Defined in

src/channel/rpc_0_6.ts:186

---

getTransactionByBlockIdAndIndex

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

Parameters

Name	Type
blockIdentifier	BlockIdentifier
index	number

Returns

Promise<TransactionWithHash>

Defined in

src/channel/rpc_0_6.ts:193

---

getTransactionReceipt

▸ getTransactionReceipt(txHash): Promise<TransactionReceipt>

Parameters

Name	Type
txHash	BigNumberish

Returns

Promise<TransactionReceipt>

Defined in

src/channel/rpc_0_6.ts:198

---

getTransactionTrace

▸ getTransactionTrace(txHash): Promise<TRANSACTION_TRACE>

Parameters

Name	Type
txHash	BigNumberish

Returns

Promise<TRANSACTION_TRACE>

Defined in

src/channel/rpc_0_6.ts:203

---

getTransactionStatus

▸ getTransactionStatus(transactionHash): Promise<TransactionStatus>

Get the status of a transaction

Parameters

Name	Type
transactionHash	BigNumberish

Returns

Promise<TransactionStatus>

Defined in

src/channel/rpc_0_6.ts:211

---

simulateTransaction

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

Parameters

Name	Type	Description
invocations	AccountInvocations	AccountInvocations
simulateTransactionOptions	getSimulateTransactionOptions	blockIdentifier 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:223

---

waitForTransaction

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

Parameters

Name	Type
txHash	BigNumberish
options?	waitForTransactionOptions

Returns

Promise<TXN_RECEIPT>

Defined in

src/channel/rpc_0_6.ts:244

---

getStorageAt

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

Parameters

Name	Type
contractAddress	BigNumberish
key	BigNumberish
blockIdentifier	BlockIdentifier

Returns

Promise<string>

Defined in

src/channel/rpc_0_6.ts:326

---

getClassHashAt

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

Parameters

Name	Type
contractAddress	BigNumberish
blockIdentifier	BlockIdentifier

Returns

Promise<string>

Defined in

src/channel/rpc_0_6.ts:341

---

getClass

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

Parameters

Name	Type
classHash	BigNumberish
blockIdentifier	BlockIdentifier

Returns

Promise<ContractClass>

Defined in

src/channel/rpc_0_6.ts:353

---

getClassAt

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

Parameters

Name	Type
contractAddress	BigNumberish
blockIdentifier	BlockIdentifier

Returns

Promise<ContractClass>

Defined in

src/channel/rpc_0_6.ts:365

---

getEstimateFee

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

Parameters

Name	Type
invocations	AccountInvocations
«destructured»	getEstimateFeeBulkOptions

Returns

Promise<FEE_ESTIMATE[]>

Defined in

src/channel/rpc_0_6.ts:377

---

invoke

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

Parameters

Name	Type
functionInvocation	Invocation
details	InvocationsDetailsWithNonce

Returns

Promise<InvokedTransaction>

Defined in

src/channel/rpc_0_6.ts:396

---

declare

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

Parameters

Name	Type
«destructured»	DeclareContractTransaction
details	InvocationsDetailsWithNonce

Returns

Promise<TXN_RECEIPT | DeclaredTransaction>

Defined in

src/channel/rpc_0_6.ts:434

---

deployAccount

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

Parameters

Name	Type
«destructured»	DeployAccountContractTransaction
details	InvocationsDetailsWithNonce

Returns

Promise<TXN_RECEIPT | DeployedAccountTransaction>

Defined in

src/channel/rpc_0_6.ts:506

---

callContract

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

Parameters

Name	Type
call	Call
blockIdentifier	BlockIdentifier

Returns

Promise<string[]>

Defined in

src/channel/rpc_0_6.ts:548

---

estimateMessageFee

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

NEW: Estimate the fee for a message from L1

Parameters

Name	Type	Description
message	MSG_FROM_L1	Message From L1
blockIdentifier	BlockIdentifier	-

Returns

Promise<FEE_ESTIMATE>

Defined in

src/channel/rpc_0_6.ts:564

---

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:587

---

getEvents

▸ getEvents(eventFilter): Promise<EVENTS_CHUNK>

Returns all events matching the given filter

Parameters

Name	Type
eventFilter	EventFilter

Returns

Promise<EVENTS_CHUNK>

events and the pagination of the events

Defined in

src/channel/rpc_0_6.ts:595

---

buildTransaction

▸ buildTransaction(invocation, versionType?): BROADCASTED_TXN

Parameters

Name	Type
invocation	AccountInvocationItem
versionType?	"fee" | "transaction"

Returns

BROADCASTED_TXN

Defined in

src/channel/rpc_0_6.ts:599