starknet-jvm/com.swmansion.starknet.provider.rpc/JsonRpcProvider

JsonRpcProvider

class JsonRpcProvider(val url: String, httpService: HttpService, ignoreUnknownJsonKeys: Boolean) : Provider

A provider for interacting with Starknet using JSON-RPC. You should reuse it in your application to share the httpService or provide it with your own httpService.

Parameters

url

url of the service providing a rpc interface

httpService

service used for making http requests

Constructors

Link copied to clipboard
constructor(url: String, ignoreUnknownJsonKeys: Boolean)
constructor(url: String, httpService: HttpService)
constructor(url: String)
constructor(url: String, httpService: HttpService, ignoreUnknownJsonKeys: Boolean)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val url: String

Functions

Link copied to clipboard
fun <T : StarknetResponse> batchRequests(vararg requests: HttpRequest<T>): HttpBatchRequest<T>
fun <T : StarknetResponse> batchRequests(requests: List<HttpRequest<T>>): HttpBatchRequest<T>

Batch multiple calls into a single RPC request

Link copied to clipboard
fun batchRequestsAny(vararg requests: HttpRequest<out StarknetResponse>): HttpBatchRequest<StarknetResponse>
fun batchRequestsAny(requests: List<HttpRequest<out StarknetResponse>>): HttpBatchRequest<StarknetResponse>

Batch multiple various calls into a single RPC request

Link copied to clipboard
open override fun callContract(call: Call): HttpRequest<FeltArray>

Calls a contract deployed on Starknet.

open override fun callContract(call: Call, blockTag: BlockTag): HttpRequest<FeltArray>
open override fun callContract(call: Call, blockHash: Felt): HttpRequest<FeltArray>
open override fun callContract(call: Call, blockNumber: Int): HttpRequest<FeltArray>
Link copied to clipboard
open override fun declareContract(payload: DeclareTransactionV3): HttpRequest<DeclareResponse>

Declare contract using version 3 transaction.

Link copied to clipboard
open override fun deployAccount(payload: DeployAccountTransactionV3): HttpRequest<DeployAccountResponse>

Deploy an account contract using version 3 transaction.

Link copied to clipboard
Link copied to clipboard
open override fun getBlockNumber(): HttpRequest<IntResponse>
Link copied to clipboard
open override fun getBlockTransactionCount(blockTag: BlockTag): HttpRequest<IntResponse>
open override fun getBlockTransactionCount(blockHash: Felt): HttpRequest<IntResponse>
open override fun getBlockTransactionCount(blockNumber: Int): HttpRequest<IntResponse>
Link copied to clipboard
open override fun getBlockWithReceipts(blockTag: BlockTag): HttpRequest<BlockWithReceipts>
open override fun getBlockWithReceipts(blockHash: Felt): HttpRequest<BlockWithReceipts>
open override fun getBlockWithReceipts(blockNumber: Int): HttpRequest<BlockWithReceipts>

open override fun getBlockWithReceipts(blockTag: BlockTag, responseFlags: Set<TxnResponseFlag>): HttpRequest<BlockWithReceipts>
open override fun getBlockWithReceipts(blockHash: Felt, responseFlags: Set<TxnResponseFlag>): HttpRequest<BlockWithReceipts>
open override fun getBlockWithReceipts(blockNumber: Int, responseFlags: Set<TxnResponseFlag>): HttpRequest<BlockWithReceipts>

Get a block with transaction receipts including optional response flags.

Link copied to clipboard
Link copied to clipboard
open override fun getBlockWithTxs(blockTag: BlockTag): HttpRequest<BlockWithTransactions>
open override fun getBlockWithTxs(blockHash: Felt): HttpRequest<BlockWithTransactions>
open override fun getBlockWithTxs(blockNumber: Int): HttpRequest<BlockWithTransactions>

open override fun getBlockWithTxs(blockTag: BlockTag, responseFlags: Set<TxnResponseFlag>): HttpRequest<BlockWithTransactions>
open override fun getBlockWithTxs(blockHash: Felt, responseFlags: Set<TxnResponseFlag>): HttpRequest<BlockWithTransactions>
open override fun getBlockWithTxs(blockNumber: Int, responseFlags: Set<TxnResponseFlag>): HttpRequest<BlockWithTransactions>

Get a block with transactions including optional response flags.

Link copied to clipboard
open override fun getChainId(): HttpRequest<StarknetChainId>
Link copied to clipboard
open override fun getClass(classHash: Felt): HttpRequest<ContractClassBase>
open override fun getClass(classHash: Felt, blockTag: BlockTag): HttpRequest<ContractClassBase>
open override fun getClass(classHash: Felt, blockHash: Felt): HttpRequest<ContractClassBase>
open override fun getClass(classHash: Felt, blockNumber: Int): HttpRequest<ContractClassBase>
Link copied to clipboard
open override fun getClassAt(contractAddress: Felt): HttpRequest<ContractClassBase>
open override fun getClassAt(contractAddress: Felt, blockTag: BlockTag): HttpRequest<ContractClassBase>
open override fun getClassAt(contractAddress: Felt, blockHash: Felt): HttpRequest<ContractClassBase>
open override fun getClassAt(contractAddress: Felt, blockNumber: Int): HttpRequest<ContractClassBase>
Link copied to clipboard
open override fun getClassHashAt(contractAddress: Felt): HttpRequest<Felt>
open override fun getClassHashAt(contractAddress: Felt, blockTag: BlockTag): HttpRequest<Felt>

open override fun getClassHashAt(contractAddress: Felt, blockHash: Felt): HttpRequest<Felt>
open override fun getClassHashAt(contractAddress: Felt, blockNumber: Int): HttpRequest<Felt>

Get the contract class hash.

Link copied to clipboard
open override fun getEstimateFee(payload: List<ExecutableTransaction>): HttpRequest<EstimateFeeResponseList>
open override fun getEstimateFee(payload: List<ExecutableTransaction>, simulationFlags: Set<SimulationFlagForEstimateFee>): HttpRequest<EstimateFeeResponseList>
open override fun getEstimateFee(payload: List<ExecutableTransaction>, blockTag: BlockTag, simulationFlags: Set<SimulationFlagForEstimateFee>): HttpRequest<EstimateFeeResponseList>

open override fun getEstimateFee(payload: List<ExecutableTransaction>, blockTag: BlockTag): HttpRequest<EstimateFeeResponseList>
open override fun getEstimateFee(payload: List<ExecutableTransaction>, blockHash: Felt): HttpRequest<EstimateFeeResponseList>
open override fun getEstimateFee(payload: List<ExecutableTransaction>, blockNumber: Int): HttpRequest<EstimateFeeResponseList>
open override fun getEstimateFee(payload: List<ExecutableTransaction>, blockHash: Felt, simulationFlags: Set<SimulationFlagForEstimateFee>): HttpRequest<EstimateFeeResponseList>
open override fun getEstimateFee(payload: List<ExecutableTransaction>, blockNumber: Int, simulationFlags: Set<SimulationFlagForEstimateFee>): HttpRequest<EstimateFeeResponseList>

Estimate a fee.

Link copied to clipboard
open override fun getEstimateMessageFee(message: MessageL1ToL2, blockTag: BlockTag): HttpRequest<EstimateMessageFeeResponse>

open override fun getEstimateMessageFee(message: MessageL1ToL2, blockHash: Felt): HttpRequest<EstimateMessageFeeResponse>
open override fun getEstimateMessageFee(message: MessageL1ToL2, blockNumber: Int): HttpRequest<EstimateMessageFeeResponse>

Estimate a message fee.

Link copied to clipboard
open override fun getEvents(payload: GetEventsPayload): HttpRequest<GetEventsResult>
Link copied to clipboard
open override fun getMessagesStatus(l1TransactionHash: NumAsHex): HttpRequest<MessageStatusList>

Get L1 handler transaction data.

Link copied to clipboard
open override fun getNonce(contractAddress: Felt): HttpRequest<Felt>

Get a nonce.

open override fun getNonce(contractAddress: Felt, blockTag: BlockTag): HttpRequest<Felt>
open override fun getNonce(contractAddress: Felt, blockHash: Felt): HttpRequest<Felt>
open override fun getNonce(contractAddress: Felt, blockNumber: Int): HttpRequest<Felt>
Link copied to clipboard
open override fun getSpecVersion(): HttpRequest<StringResponse>
Link copied to clipboard
open fun getStarknetVersion(blockTag: BlockTag): Request<String>
open fun getStarknetVersion(blockHash: Felt): Request<String>
open fun getStarknetVersion(blockNumber: Int): Request<String>

Get a Starknet version for the selected block.

Link copied to clipboard
open override fun getStateUpdate(blockTag: BlockTag): HttpRequest<StateUpdate>
open override fun getStateUpdate(blockHash: Felt): HttpRequest<StateUpdate>
open override fun getStateUpdate(blockNumber: Int): HttpRequest<StateUpdate>

open override fun getStateUpdate(blockTag: BlockTag, contractAddresses: List<Felt>): HttpRequest<StateUpdate>
open override fun getStateUpdate(blockHash: Felt, contractAddresses: List<Felt>): HttpRequest<StateUpdate>
open override fun getStateUpdate(blockNumber: Int, contractAddresses: List<Felt>): HttpRequest<StateUpdate>

Get block state information.

Link copied to clipboard
open override fun getStorageAt(contractAddress: Felt, key: Felt): HttpRequest<Felt>
open override fun getStorageAt(contractAddress: Felt, key: String): Request<Felt>
open override fun getStorageAt(contractAddress: Felt, key: Felt, blockHash: Felt): HttpRequest<Felt>
open override fun getStorageAt(contractAddress: Felt, key: Felt, blockNumber: Int): HttpRequest<Felt>
open override fun getStorageAt(contractAddress: Felt, key: String, blockHash: Felt): Request<Felt>
open override fun getStorageAt(contractAddress: Felt, key: String, blockNumber: Int): Request<Felt>

Get a value of storage var.

open override fun getStorageAt(contractAddress: Felt, key: Felt, blockTag: BlockTag): HttpRequest<Felt>
open override fun getStorageAt(contractAddress: Felt, key: String, blockTag: BlockTag): Request<Felt>
Link copied to clipboard
open override fun getStorageAtWithMetadata(contractAddress: Felt, key: Felt, blockTag: BlockTag): HttpRequest<StorageResult>
open override fun getStorageAtWithMetadata(contractAddress: Felt, key: Felt, blockHash: Felt): HttpRequest<StorageResult>
open override fun getStorageAtWithMetadata(contractAddress: Felt, key: Felt, blockNumber: Int): HttpRequest<StorageResult>

Get a value of storage var with metadata.

Link copied to clipboard
open override fun getStorageProof(blockId: BlockId, classHashes: List<Felt>?, contractAddresses: List<Felt>?, contractsStorageKeys: List<ContractsStorageKeys>?): HttpRequest<StorageProof>

Get merkle paths in one of the state tries.

Link copied to clipboard
open override fun getSyncing(): HttpRequest<Syncing>
Link copied to clipboard
open override fun getTransaction(transactionHash: Felt): HttpRequest<Transaction>

open override fun getTransaction(transactionHash: Felt, responseFlags: Set<TxnResponseFlag>): HttpRequest<Transaction>

Get a transaction with optional response flags.

Link copied to clipboard
open override fun getTransactionByBlockIdAndIndex(blockTag: BlockTag, index: Int): HttpRequest<Transaction>
open override fun getTransactionByBlockIdAndIndex(blockHash: Felt, index: Int): HttpRequest<Transaction>
open override fun getTransactionByBlockIdAndIndex(blockNumber: Int, index: Int): HttpRequest<Transaction>

open override fun getTransactionByBlockIdAndIndex(blockTag: BlockTag, index: Int, responseFlags: Set<TxnResponseFlag>): HttpRequest<Transaction>
open override fun getTransactionByBlockIdAndIndex(blockHash: Felt, index: Int, responseFlags: Set<TxnResponseFlag>): HttpRequest<Transaction>
open override fun getTransactionByBlockIdAndIndex(blockNumber: Int, index: Int, responseFlags: Set<TxnResponseFlag>): HttpRequest<Transaction>

Get transaction by block id and index with optional response flags.

Link copied to clipboard
open override fun getTransactionReceipt(transactionHash: Felt): HttpRequest<out TransactionReceipt>
Link copied to clipboard
open override fun getTransactionStatus(transactionHash: Felt): HttpRequest<GetTransactionStatusResponse>
Link copied to clipboard
Link copied to clipboard
open override fun simulateTransactions(transactions: List<ExecutableTransaction>, blockTag: BlockTag, simulationFlags: Set<SimulationFlag>): HttpRequest<SimulatedTransactionList>

open override fun simulateTransactions(transactions: List<ExecutableTransaction>, blockHash: Felt, simulationFlags: Set<SimulationFlag>): HttpRequest<SimulatedTransactionList>
open override fun simulateTransactions(transactions: List<ExecutableTransaction>, blockNumber: Int, simulationFlags: Set<SimulationFlag>): HttpRequest<SimulatedTransactionList>

Simulate executing a list of transactions

Link copied to clipboard
open override fun simulateTransactionsWithInitialReads(transactions: List<ExecutableTransaction>, blockTag: BlockTag, simulationFlags: Set<SimulationFlag>): HttpRequest<SimulatedTransactionWithInitialReads>
open override fun simulateTransactionsWithInitialReads(transactions: List<ExecutableTransaction>, blockHash: Felt, simulationFlags: Set<SimulationFlag>): HttpRequest<SimulatedTransactionWithInitialReads>
open override fun simulateTransactionsWithInitialReads(transactions: List<ExecutableTransaction>, blockNumber: Int, simulationFlags: Set<SimulationFlag>): HttpRequest<SimulatedTransactionWithInitialReads>

Simulate executing a list of transactions, returning initial reads alongside results.

Link copied to clipboard
open override fun traceBlockTransactions(blockTag: BlockTag, traceFlags: Set<TraceFlag>): HttpRequest<BlockTransactionTracesResult>
open override fun traceBlockTransactions(blockHash: Felt, traceFlags: Set<TraceFlag>): HttpRequest<BlockTransactionTracesResult>
open override fun traceBlockTransactions(blockNumber: Int, traceFlags: Set<TraceFlag>): HttpRequest<BlockTransactionTracesResult>

Get execution traces for all transactions in a block.

Link copied to clipboard
open override fun traceTransaction(transactionHash: Felt): HttpRequest<TransactionTrace>

Get the execution trace of a transaction by its hash.