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
Methods
fetch
▸ fetch(method, params): Promise<any>
Parameters
| Name | Type |
|---|---|
method | any |
params | any |
Returns
Promise<any>
Defined in
errorHandler
▸ Protected errorHandler(error): void
Parameters
| Name | Type |
|---|---|
error | any |
Returns
void
Defined in
fetchEndpoint
▸ Protected fetchEndpoint<T>(method, params?): Promise<Methods[T][``"result"``]>
Type parameters
| Name | Type |
|---|---|
T | extends keyof Methods |
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
getBlock
▸ getBlock(blockIdentifier?): Promise<GetBlockResponse>
Gets the block information
Parameters
| Name | Type | Description |
|---|---|---|
blockIdentifier | BlockIdentifier | block identifier |
Returns
Promise<GetBlockResponse>
the block object
Implementation of
Defined in
getBlockHashAndNumber
▸ getBlockHashAndNumber(): Promise<BlockHashAndNumber>
Returns
Promise<BlockHashAndNumber>
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
getClassHashAt
▸ getClassHashAt(contractAddress, blockIdentifier?): Promise<string>
Returns the class hash deployed under the given address.
Parameters
| Name | Type | Description |
|---|---|---|
contractAddress | string | contract address |
blockIdentifier | BlockIdentifier | block identifier |
Returns
Promise<string>
Class hash
Implementation of
ProviderInterface.getClassHashAt
Defined in
getNonceForAddress
▸ getNonceForAddress(contractAddress, blockIdentifier?): Promise<string>
Gets the nonce of a contract with respect to a specific block
Parameters
| Name | Type | Description |
|---|---|---|
contractAddress | string | contract address |
blockIdentifier | BlockIdentifier | - |
Returns
Promise<string>
the hex nonce
Implementation of
ProviderInterface.getNonceForAddress
Defined in
getPendingTransactions
▸ getPendingTransactions(): Promise<PendingTransactions>
Returns
Promise<PendingTransactions>
Defined in
getProtocolVersion
▸ getProtocolVersion(): Promise<Error>
Returns
Promise<Error>
Defined in
getStateUpdate
▸ getStateUpdate(blockIdentifier?): Promise<StateUpdate>
Gets the state changes in a specific block
Parameters
| Name | Type | Description |
|---|---|---|
blockIdentifier | BlockIdentifier | block identifier |
Returns
Promise<StateUpdate>
StateUpdateResponse
Implementation of
ProviderInterface.getStateUpdate
Defined in
getStorageAt
▸ getStorageAt(contractAddress, key, blockIdentifier?): Promise<string>
Gets the contract's storage variable at a specific key.
Parameters
| Name | Type | Description |
|---|---|---|
contractAddress | string | |
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
getTransaction
▸ getTransaction(txHash): Promise<GetTransactionResponse>
Gets the transaction information from a tx id.
Parameters
| Name | Type |
|---|---|
txHash | string |
Returns
Promise<GetTransactionResponse>
the transaction object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }
Implementation of
ProviderInterface.getTransaction
Defined in
getTransactionByHash
▸ getTransactionByHash(txHash): Promise<TXN>
Parameters
| Name | Type |
|---|---|
txHash | string |
Returns
Promise<TXN>
Defined in
getTransactionByBlockIdAndIndex
▸ getTransactionByBlockIdAndIndex(blockIdentifier, index): Promise<TXN>
Parameters
| Name | Type |
|---|---|
blockIdentifier | BlockIdentifier |
index | number |
Returns
Promise<TXN>
Defined in
getTransactionReceipt
▸ getTransactionReceipt(txHash): Promise<TXN_RECEIPT>
Gets the transaction receipt from a tx hash.
Parameters
| Name | Type |
|---|---|
txHash | string |
Returns
Promise<TXN_RECEIPT>
the transaction receipt object
Implementation of
ProviderInterface.getTransactionReceipt
Defined in
getClassByHash
▸ getClassByHash(classHash): Promise<ContractClassResponse>
Returns the contract class deployed under the given class hash.
Parameters
| Name | Type | Description |
|---|---|---|
classHash | string | class hash |
Returns
Promise<ContractClassResponse>
Contract class of compiled contract
Implementation of
ProviderInterface.getClassByHash
Defined in
getClass
▸ getClass(classHash, blockIdentifier?): Promise<ContractClassResponse>
Parameters
| Name | Type |
|---|---|
classHash | string |
blockIdentifier | BlockIdentifier |
Returns
Promise<ContractClassResponse>
Defined in
getClassAt
▸ getClassAt(contractAddress, blockIdentifier?): Promise<ContractClassResponse>
Gets the contract class of the deployed contract.
Parameters
| Name | Type | Description |
|---|---|---|
contractAddress | string | contract address |
blockIdentifier | BlockIdentifier | block identifier |
Returns
Promise<ContractClassResponse>
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
getEstimateFee
▸ getEstimateFee(invocation, invocationDetails, blockIdentifier?): Promise<EstimateFeeResponse>
Estimates the fee for a given INVOKE transaction
Deprecated
Please use getInvokeEstimateFee or getDeclareEstimateFee instead. Should not be used outside of Account class
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.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
declareContract
▸ declareContract(«destructured», details): Promise<DeclareContractResponse>
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<DeclareContractResponse>
a confirmation of sending a transaction on the starknet contract
Implementation of
ProviderInterface.declareContract
Defined in
deployAccountContract
▸ deployAccountContract(«destructured», details): Promise<DeployContractResponse>
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<DeployContractResponse>
a confirmation of sending a transaction on the starknet contract
Implementation of
ProviderInterface.deployAccountContract
Defined in
invokeFunction
▸ invokeFunction(functionInvocation, details): Promise<InvokeFunctionResponse>
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<InvokeFunctionResponse>
response from addTransaction
Implementation of
ProviderInterface.invokeFunction
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
traceTransaction
▸ traceTransaction(transactionHash): Promise<TRANSACTION_TRACE>
Parameters
| Name | Type |
|---|---|
transactionHash | string |
Returns
Promise<TRANSACTION_TRACE>
Defined in
traceBlockTransactions
▸ traceBlockTransactions(blockHash): Promise<Traces>
Parameters
| Name | Type |
|---|---|
blockHash | string |
Returns
Promise<Traces>
Defined in
waitForTransaction
▸ waitForTransaction(txHash, options?): Promise<any>
Wait for the transaction to be accepted
Parameters
| Name | Type | Description |
|---|---|---|
txHash | string | transaction hash |
options? | waitForTransactionOptions | waitForTransactionOptions - (optional) retryInterval: number | undefined; - (optional) successStates: TransactionStatus[] | undefined; |
Returns
Promise<any>
GetTransactionReceiptResponse
Implementation of
ProviderInterface.waitForTransaction
Defined in
getTransactionCount
▸ getTransactionCount(blockIdentifier?): Promise<number>
Gets the transaction count from a block.
Parameters
| Name | Type |
|---|---|
blockIdentifier | BlockIdentifier |
Returns
Promise<number>
Number of transactions
Defined in
getBlockNumber
▸ getBlockNumber(): Promise<number>
Gets the latest block number
Returns
Promise<number>
Number of the latest block
Defined in
getSyncingStats
▸ getSyncingStats(): Promise<SyncingStatus>
Gets syncing status of the node
Returns
Promise<SyncingStatus>
Object with the stats data
Defined in
getEvents
▸ getEvents(eventFilter): Promise<EVENTS_CHUNK>
Gets all the events filtered
Parameters
| Name | Type |
|---|---|
eventFilter | EventFilter |
Returns
Promise<EVENTS_CHUNK>
events and the pagination of the events
Defined in
getSimulateTransaction
▸ getSimulateTransaction(invocations, «destructured»): Promise<SimulateTransactionResponse>
Simulates the transaction and returns the transaction trace and estimated fee.
Parameters
| Name | Type | Description |
|---|---|---|
invocations | AccountInvocations | AccountInvocations - Complete invocations array with account details |
«destructured» | getSimulateTransactionOptions | getSimulateTransactionOptions - (optional) blockIdentifier - block identifier - (optional) skipValidate - skip cairo validate method - (optional) skipExecute - skip cairo execute method |
Returns
Promise<SimulateTransactionResponse>
an array of transaction trace and estimated fee
Implementation of
ProviderInterface.getSimulateTransaction
Defined in
getStarkName
▸ getStarkName(address, StarknetIdContract?): Promise<string>
Parameters
| Name | Type |
|---|---|
address | BigNumberish |
StarknetIdContract? | string |
Returns
Promise<string>
Defined in
getAddressFromStarkName
▸ getAddressFromStarkName(name, StarknetIdContract?): Promise<string>
Parameters
| Name | Type |
|---|---|
name | string |
StarknetIdContract? | string |
Returns
Promise<string>
Defined in
buildTransaction
▸ buildTransaction(invocation, versionType?): BaseTransaction
Parameters
| Name | Type |
|---|---|
invocation | AccountInvocationItem |
versionType? | "fee" | "transaction" |