Class: RpcProvider
Implements
Constructors
constructor
• new RpcProvider(optionsOrProvider?)
Parameters
| Name | Type |
|---|---|
optionsOrProvider? | RpcProviderOptions |
Defined in
Properties
nodeUrl
• nodeUrl: string
Defined in
headers
• headers: object
Defined in
responseParser
• Private responseParser: RPCResponseParser
Defined in
retries
• Private retries: number
Defined in
blockIdentifier
• Private blockIdentifier: BlockIdentifier
Defined in
chainId
• Private Optional chainId: StarknetChainId
Defined in
getBlockHashAndNumber
• getBlockHashAndNumber: () => Promise<BlockHashAndNumber>
Type declaration
▸ (): Promise<BlockHashAndNumber>
Deprecated
renamed to getBlockLatestAccepted(); (will be removed in next minor version)
Returns
Promise<BlockHashAndNumber>
Defined in
getStateUpdate
• getStateUpdate: (blockIdentifier: BlockIdentifier) => Promise<PENDING_STATE_UPDATE | STATE_UPDATE>
Type declaration
▸ (blockIdentifier?): Promise<PENDING_STATE_UPDATE | STATE_UPDATE>
Deprecated
renamed to getBlockStateUpdate();
Parameters
| Name | Type |
|---|---|
blockIdentifier | BlockIdentifier |
Returns
Promise<PENDING_STATE_UPDATE | STATE_UPDATE>
Implementation of
ProviderInterface.getStateUpdate
Defined in
traceBlockTransactions
• traceBlockTransactions: (blockIdentifier: BlockIdentifier) => Promise<BlockTransactionsTraces>
Type declaration
▸ (blockIdentifier?): Promise<BlockTransactionsTraces>
Returns the execution traces of all transactions included in the given block
Deprecated
renamed to getBlockTransactionsTraces()
Parameters
| Name | Type |
|---|---|
blockIdentifier | BlockIdentifier |
Returns
Promise<BlockTransactionsTraces>
Defined in
getTransactionCount
• getTransactionCount: (blockIdentifier: BlockIdentifier) => Promise<number>
Type declaration
▸ (blockIdentifier?): Promise<number>
Get the number of transactions in a block given a block id
Deprecated
renamed to getBlockTransactionCount()
Parameters
| Name | Type |
|---|---|
blockIdentifier | BlockIdentifier |
Returns
Promise<number>
Number of transactions
Defined in
traceTransaction
• traceTransaction: (txHash: BigNumberish) => Promise<TRANSACTION_TRACE>
Type declaration
▸ (txHash): Promise<TRANSACTION_TRACE>
Deprecated
renamed to getTransactionTrace(); For a given executed transaction, return the trace of its execution, including internal calls
Parameters
| Name | Type |
|---|---|
txHash | BigNumberish |
Returns
Promise<TRANSACTION_TRACE>
Defined in
getSimulateTransaction
• getSimulateTransaction: (invocations: AccountInvocations, __namedParameters: getSimulateTransactionOptions) => Promise<SimulateTransactionResponse>
Type declaration
▸ (invocations, «destructured»): Promise<SimulateTransactionResponse>
Deprecated
renamed to simulateTransaction();
Parameters
| Name | Type |
|---|---|
invocations | AccountInvocations |
«destructured» | getSimulateTransactionOptions |
Returns
Promise<SimulateTransactionResponse>
Implementation of
ProviderInterface.getSimulateTransaction
Defined in
Methods
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
errorHandler
▸ Protected errorHandler(method, params, rpcError?, otherError?): void
Parameters
| Name | Type |
|---|---|
method | string |
params | any |
rpcError? | Error |
otherError? | any |
Returns
void
Defined in
fetchEndpoint
▸ Protected 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
getChainId
▸ getChainId(): Promise<StarknetChainId>
Gets the Starknet chain Id
Returns
Promise<StarknetChainId>
the chain Id
Implementation of
Defined in
getSpecVersion
▸ getSpecVersion(): Promise<string>
NEW: Returns the version of the Starknet JSON-RPC specification being used
Returns
Promise<string>
Defined in
getNonceForAddress
▸ getNonceForAddress(contractAddress, blockIdentifier?): Promise<string>
Returns the nonce associated with the given address in the given block
Parameters
| Name | Type | Description |
|---|---|---|
contractAddress | BigNumberish | contract address |
blockIdentifier | BlockIdentifier | - |
Returns
Promise<string>
the hex nonce
Implementation of
ProviderInterface.getNonceForAddress
Defined in
getBlock
▸ getBlock(blockIdentifier?): Promise<GetBlockResponse>
Deprecated
use getBlockWithTxHashes or getBlockWithTxs (will be removed on sequencer deprecation)
Parameters
| Name | Type |
|---|---|
blockIdentifier | BlockIdentifier |
Returns
Promise<GetBlockResponse>
Implementation of
Defined in
getBlockLatestAccepted
▸ getBlockLatestAccepted(): Promise<BlockHashAndNumber>
Get the most recent accepted block hash and number
Returns
Promise<BlockHashAndNumber>
Defined in
getBlockNumber
▸ getBlockNumber(): Promise<number>
Deprecated
redundant use getBlockLatestAccepted(); Get the most recent accepted block number
Returns
Promise<number>
Number of the latest block
Defined in
getBlockWithTxHashes
▸ getBlockWithTxHashes(blockIdentifier?): Promise<BlockWithTxHashes>
Parameters
| Name | Type |
|---|---|
blockIdentifier | BlockIdentifier |
Returns
Promise<BlockWithTxHashes>
Defined in
getBlockWithTxs
▸ getBlockWithTxs(blockIdentifier?): Promise<BlockWithTxs>
Parameters
| Name | Type |
|---|---|
blockIdentifier | BlockIdentifier |
Returns
Promise<BlockWithTxs>
Defined in
getBlockStateUpdate
▸ getBlockStateUpdate(blockIdentifier?): Promise<PENDING_STATE_UPDATE | STATE_UPDATE>
Parameters
| Name | Type |
|---|---|
blockIdentifier | BlockIdentifier |
Returns
Promise<PENDING_STATE_UPDATE | STATE_UPDATE>
Defined in
getBlockTransactionsTraces
▸ getBlockTransactionsTraces(blockIdentifier?): Promise<BlockTransactionsTraces>
Parameters
| Name | Type |
|---|---|
blockIdentifier | BlockIdentifier |
Returns
Promise<BlockTransactionsTraces>
Defined in
getBlockTransactionCount
▸ getBlockTransactionCount(blockIdentifier?): Promise<number>
Parameters
| Name | Type |
|---|---|
blockIdentifier | BlockIdentifier |
Returns
Promise<number>
Defined in
getPendingTransactions
▸ getPendingTransactions(): Promise<TransactionWithHash[]>
Return transactions from pending block
Deprecated
Instead use getBlock(BlockTag.pending); (will be removed in next minor version)
Returns
Promise<TransactionWithHash[]>
Defined in
getTransaction
▸ getTransaction(txHash): Promise<InvokeTransactionResponse | DeclareTransactionResponse | RejectedTransactionResponse>
Deprecated
use getTransactionByHash or getTransactionByBlockIdAndIndex (will be removed on sequencer deprecation)
Parameters
| Name | Type |
|---|---|
txHash | BigNumberish |
Returns
Promise<InvokeTransactionResponse | DeclareTransactionResponse | RejectedTransactionResponse>
Implementation of
ProviderInterface.getTransaction
Defined in
getTransactionByHash
▸ getTransactionByHash(txHash): Promise<TransactionWithHash>
Parameters
| Name | Type |
|---|---|
txHash | BigNumberish |
Returns
Promise<TransactionWithHash>
Defined in
getTransactionByBlockIdAndIndex
▸ getTransactionByBlockIdAndIndex(blockIdentifier, index): Promise<TransactionWithHash>
Parameters
| Name | Type |
|---|---|
blockIdentifier | BlockIdentifier |
index | number |
Returns
Promise<TransactionWithHash>
Defined in
getTransactionReceipt
▸ getTransactionReceipt(txHash): Promise<TransactionReceipt>
Gets the transaction receipt from a tx hash.
Parameters
| Name | Type |
|---|---|
txHash | BigNumberish |
Returns
Promise<TransactionReceipt>
the transaction receipt object
Implementation of
ProviderInterface.getTransactionReceipt
Defined in
getTransactionTrace
▸ getTransactionTrace(txHash): Promise<TRANSACTION_TRACE>
Parameters
| Name | Type |
|---|---|
txHash | BigNumberish |
Returns
Promise<TRANSACTION_TRACE>
Defined in
getTransactionStatus
▸ getTransactionStatus(transactionHash): Promise<TransactionStatus>
NEW: Get the status of a transaction
Parameters
| Name | Type |
|---|---|
transactionHash | BigNumberish |
Returns
Promise<TransactionStatus>
Defined in
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
waitForTransaction
▸ waitForTransaction(txHash, options?): Promise<TransactionReceipt>
Wait for the transaction to be accepted
Parameters
| Name | Type | Description |
|---|---|---|
txHash | BigNumberish | transaction hash |
options? | waitForTransactionOptions | waitForTransactionOptions - (optional) retryInterval: number | undefined; - (optional) successStates: TransactionStatus[] | undefined; |
Returns
Promise<TransactionReceipt>
GetTransactionReceiptResponse
Implementation of
ProviderInterface.waitForTransaction
Defined in
getStorageAt
▸ getStorageAt(contractAddress, key, blockIdentifier?): Promise<string>
Get the value of the storage (contract's variable) at the given address and key
Parameters
| Name | Type | Description |
|---|---|---|
contractAddress | BigNumberish | |
key | BigNumberish | from getStorageVarAddress('<STORAGE_VARIABLE_NAME>') (WIP) |
blockIdentifier | BlockIdentifier | block identifier |
Returns
Promise<string>
the value of the storage variable
Implementation of
ProviderInterface.getStorageAt
Defined in
getClassHashAt
▸ getClassHashAt(contractAddress, blockIdentifier?): Promise<string>
Returns the contract class hash in the given block for the contract deployed at the given address
Parameters
| Name | Type | Description |
|---|---|---|
contractAddress | BigNumberish | contract address |
blockIdentifier | BlockIdentifier | block identifier |
Returns
Promise<string>
Class hash
Implementation of
ProviderInterface.getClassHashAt
Defined in
getClassByHash
▸ getClassByHash(classHash): Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>
Returns the contract class deployed under the given class hash.
Parameters
| Name | Type | Description |
|---|---|---|
classHash | BigNumberish | class hash |
Returns
Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>
Contract class of compiled contract
Implementation of
ProviderInterface.getClassByHash
Defined in
getClass
▸ getClass(classHash, blockIdentifier?): Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>
Parameters
| Name | Type |
|---|---|
classHash | BigNumberish |
blockIdentifier | BlockIdentifier |
Returns
Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>
Defined in
getClassAt
▸ getClassAt(contractAddress, blockIdentifier?): Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>
Gets the contract class of the deployed contract.
Parameters
| Name | Type | Description |
|---|---|---|
contractAddress | BigNumberish | contract address |
blockIdentifier | BlockIdentifier | block identifier |
Returns
Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>
Contract class of compiled contract
Implementation of
Defined in
getCode
▸ getCode(_contractAddress, _blockIdentifier?): Promise<GetCodeResponse>
Deprecated
The method should not be used
Parameters
| Name | Type |
|---|---|
_contractAddress | string |
_blockIdentifier? | BlockIdentifier |
Returns
Promise<GetCodeResponse>
Implementation of
Defined in
getContractVersion
▸ getContractVersion(contractAddress, classHash?, options?): Promise<ContractVersion>
Gets the contract version from the provided address
Parameters
| Name | Type | Description |
|---|---|---|
contractAddress | BigNumberish | string |
classHash? | undefined | undefined |
options? | getContractVersionOptions | getContractVersionOptions - (optional) compiler - (default true) extract compiler version using type tactic from abi - (optional) blockIdentifier - block identifier |
Returns
Promise<ContractVersion>
Implementation of
ProviderInterface.getContractVersion
Defined in
▸ getContractVersion(contractAddress, classHash, options?): Promise<ContractVersion>
Gets the contract version from the provided address
Parameters
| Name | Type | Description |
|---|---|---|
contractAddress | undefined | undefined |
classHash | BigNumberish | |
options? | getContractVersionOptions | getContractVersionOptions - (optional) compiler - (default true) extract compiler version using type tactic from abi - (optional) blockIdentifier - block identifier |
Returns
Promise<ContractVersion>
Implementation of
ProviderInterface.getContractVersion
Defined in
getEstimateFee
▸ getEstimateFee(invocation, invocationDetails, blockIdentifier?): Promise<EstimateFeeResponse>
Deprecated
use gettypeEstimateFee (will be refactored based on type after sequencer deprecation)
Parameters
| Name | Type |
|---|---|
invocation | Invocation |
invocationDetails | InvocationsDetailsWithNonce |
blockIdentifier | BlockIdentifier |
Returns
Promise<EstimateFeeResponse>
Implementation of
ProviderInterface.getEstimateFee
Defined in
getInvokeEstimateFee
▸ getInvokeEstimateFee(invocation, invocationDetails, blockIdentifier?): Promise<EstimateFeeResponse>
Estimates the fee for a given INVOKE transaction
Parameters
| Name | Type | Description |
|---|---|---|
invocation | Invocation | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature |
invocationDetails | InvocationsDetailsWithNonce | optional details containing: - nonce - optional nonce - version - optional version |
blockIdentifier | BlockIdentifier | (optional) block identifier |
Returns
Promise<EstimateFeeResponse>
the estimated fee
Implementation of
ProviderInterface.getInvokeEstimateFee
Defined in
getDeclareEstimateFee
▸ getDeclareEstimateFee(invocation, details, blockIdentifier?): Promise<EstimateFeeResponse>
Estimates the fee for a given DECLARE transaction
Parameters
| Name | Type | Description |
|---|---|---|
invocation | DeclareContractTransaction | transaction payload to be declared containing: - compiled contract code - sender address - signature - (defaults to []) the signature |
details | InvocationsDetailsWithNonce | optional details containing: - nonce - version - optional version - optional maxFee |
blockIdentifier | BlockIdentifier | (optional) block identifier |
Returns
Promise<EstimateFeeResponse>
the estimated fee
Implementation of
ProviderInterface.getDeclareEstimateFee
Defined in
getDeployAccountEstimateFee
▸ getDeployAccountEstimateFee(invocation, details, blockIdentifier?): Promise<EstimateFeeResponse>
Estimates the fee for a given DEPLOY_ACCOUNT transaction
Parameters
| Name | Type | Description |
|---|---|---|
invocation | DeployAccountContractTransaction | transaction payload to be deployed containing: - classHash - constructorCalldata - addressSalt - signature - (defaults to []) the signature |
details | InvocationsDetailsWithNonce | optional details containing: - nonce - version - optional version - optional maxFee |
blockIdentifier | BlockIdentifier | (optional) block identifier |
Returns
Promise<EstimateFeeResponse>
the estimated fee
Implementation of
ProviderInterface.getDeployAccountEstimateFee
Defined in
getEstimateFeeBulk
▸ getEstimateFeeBulk(invocations, «destructured»): Promise<EstimateFeeResponseBulk>
Estimates the fee for a list of INVOKE transaction
Parameters
| Name | Type | Description |
|---|---|---|
invocations | AccountInvocations | AccountInvocations - Complete invocations array with account details |
«destructured» | getEstimateFeeBulkOptions | getEstimateFeeBulkOptions - (optional) blockIdentifier - BlockIdentifier - (optional) skipValidate - boolean (default false) |
Returns
Promise<EstimateFeeResponseBulk>
the estimated fee
Implementation of
ProviderInterface.getEstimateFeeBulk
Defined in
invokeFunction
▸ invokeFunction(functionInvocation, details): Promise<InvokedTransaction>
Invokes a function on starknet
Deprecated
This method won't be supported as soon as fees are mandatory. Should not be used outside of Account class
Parameters
| Name | Type | Description |
|---|---|---|
functionInvocation | Invocation | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature |
details | InvocationsDetailsWithNonce | optional details containing: - nonce - optional nonce - version - optional version - maxFee - optional maxFee |
Returns
Promise<InvokedTransaction>
response from addTransaction
Implementation of
ProviderInterface.invokeFunction
Defined in
declareContract
▸ declareContract(«destructured», details): Promise<DeclaredTransaction>
Declares a given compiled contract (json) to starknet
Parameters
| Name | Type | Description |
|---|---|---|
«destructured» | DeclareContractTransaction | transaction payload to be deployed containing: - compiled contract code - sender address - signature |
details | InvocationsDetailsWithNonce | Invocation Details containing: - nonce - optional version - optional maxFee |
Returns
Promise<DeclaredTransaction>
a confirmation of sending a transaction on the starknet contract
Implementation of
ProviderInterface.declareContract
Defined in
deployAccountContract
▸ deployAccountContract(«destructured», details): Promise<DeployedAccountTransaction>
Deploys a given compiled Account contract (json) to starknet
Parameters
| Name | Type | Description |
|---|---|---|
«destructured» | DeployAccountContractTransaction | payload to be deployed containing: - compiled contract code - constructor calldata - address salt |
details | InvocationsDetailsWithNonce | - |
Returns
Promise<DeployedAccountTransaction>
a confirmation of sending a transaction on the starknet contract
Implementation of
ProviderInterface.deployAccountContract
Defined in
callContract
▸ callContract(call, blockIdentifier?): Promise<CallContractResponse>
Calls a function on the Starknet contract.
Parameters
| Name | Type | Description |
|---|---|---|
call | Call | transaction to be called |
blockIdentifier | BlockIdentifier | block identifier |
Returns
Promise<CallContractResponse>
the result of the function on the smart contract.
Implementation of
ProviderInterface.callContract
Defined in
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
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
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
getStarkName
▸ getStarkName(address, StarknetIdContract?): Promise<string>
StarknetId Endpoint (get name from address)
Parameters
| Name | Type |
|---|---|
address | BigNumberish |
StarknetIdContract? | string |
Returns
Promise<string>
Defined in
getAddressFromStarkName
▸ getAddressFromStarkName(name, StarknetIdContract?): Promise<string>
StarknetId Endpoint (get address from name)
Parameters
| Name | Type |
|---|---|
name | string |
StarknetIdContract? | string |
Returns
Promise<string>
Defined in
buildTransaction
▸ buildTransaction(invocation, versionType?): BROADCASTED_TXN
Parameters
| Name | Type |
|---|---|
invocation | AccountInvocationItem |
versionType? | "fee" | "transaction" |