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

JsonRpcProvider

constructor(url: String, ignoreUnknownJsonKeys: Boolean)

constructor(url: String, httpService: HttpService)

constructor(url: String)

constructor(url: String, httpService: HttpService, ignoreUnknownJsonKeys: Boolean)

Types

Companion

object Companion

Properties

url

val url: String

Functions

callContract

open override fun callContract(call: Call): Request<List<Felt>>

open override fun callContract(call: Call, blockTag: BlockTag): Request<List<Felt>>

open override fun callContract(call: Call, blockHash: Felt): Request<List<Felt>>

open override fun callContract(call: Call, blockNumber: Int): Request<List<Felt>>

Calls a contract deployed on Starknet.

declareContract

open override fun declareContract(payload: DeclareTransactionV1Payload): Request<DeclareResponse>

Declare contract using version 1 transaction.

open override fun declareContract(payload: DeclareTransactionV2Payload): Request<DeclareResponse>

Declare contract using version 2 transaction.

open override fun declareContract(payload: DeclareTransactionV3Payload): Request<DeclareResponse>

Declare contract using version 3 transaction.

deployAccount

open override fun deployAccount(payload: DeployAccountTransactionV1Payload): Request<DeployAccountResponse>

Deploy an account contract using version 1 transaction.

open override fun deployAccount(payload: DeployAccountTransactionV3Payload): Request<DeployAccountResponse>

Deploy an account contract using version 3 transaction.

getBlockHashAndNumber

open override fun getBlockHashAndNumber(): Request<GetBlockHashAndNumberResponse>

Get the hash and number of the block.

getBlockNumber

open override fun getBlockNumber(): Request<Int>

Get the block number.

getBlockTransactionCount

open override fun getBlockTransactionCount(blockTag: BlockTag): Request<Int>

open override fun getBlockTransactionCount(blockHash: Felt): Request<Int>

open override fun getBlockTransactionCount(blockNumber: Int): Request<Int>

Get the block transaction count.

getBlockWithReceipts

open override fun getBlockWithReceipts(blockTag: BlockTag): Request<BlockWithReceipts>

open override fun getBlockWithReceipts(blockHash: Felt): Request<BlockWithReceipts>

open override fun getBlockWithReceipts(blockNumber: Int): Request<BlockWithReceipts>

Get a block with transaction receipts.

getBlockWithTxHashes

open override fun getBlockWithTxHashes(blockTag: BlockTag): Request<BlockWithTransactionHashes>

open override fun getBlockWithTxHashes(blockHash: Felt): Request<BlockWithTransactionHashes>

open override fun getBlockWithTxHashes(blockNumber: Int): Request<BlockWithTransactionHashes>

Get a block with transaction hashes.

getBlockWithTxs

open override fun getBlockWithTxs(blockTag: BlockTag): Request<BlockWithTransactions>

open override fun getBlockWithTxs(blockHash: Felt): Request<BlockWithTransactions>

open override fun getBlockWithTxs(blockNumber: Int): Request<BlockWithTransactions>

Get a block with transactions.

getChainId

open override fun getChainId(): Request<StarknetChainId>

Get the chain id.

getClass

open override fun getClass(classHash: Felt): Request<ContractClassBase>

open override fun getClass(classHash: Felt, blockTag: BlockTag): Request<ContractClassBase>

open override fun getClass(classHash: Felt, blockHash: Felt): Request<ContractClassBase>

open override fun getClass(classHash: Felt, blockNumber: Int): Request<ContractClassBase>

Get the contract class definition.

getClassAt

open override fun getClassAt(contractAddress: Felt): Request<ContractClassBase>

open override fun getClassAt(contractAddress: Felt, blockTag: BlockTag): Request<ContractClassBase>

open override fun getClassAt(contractAddress: Felt, blockHash: Felt): Request<ContractClassBase>

open override fun getClassAt(contractAddress: Felt, blockNumber: Int): Request<ContractClassBase>

Get the contract class definition.

getClassHashAt

open override fun getClassHashAt(contractAddress: Felt): Request<Felt>

open override fun getClassHashAt(contractAddress: Felt, blockTag: BlockTag): Request<Felt>

open override fun getClassHashAt(contractAddress: Felt, blockHash: Felt): Request<Felt>

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

Get the contract class hash.

getEstimateFee

open override fun getEstimateFee(payload: List<TransactionPayload>): Request<List<EstimateFeeResponse>>

open override fun getEstimateFee(payload: List<TransactionPayload>, blockTag: BlockTag): Request<List<EstimateFeeResponse>>

open override fun getEstimateFee(payload: List<TransactionPayload>, blockHash: Felt): Request<List<EstimateFeeResponse>>

open override fun getEstimateFee(payload: List<TransactionPayload>, blockNumber: Int): Request<List<EstimateFeeResponse>>

open override fun getEstimateFee(payload: List<TransactionPayload>, simulationFlags: Set<SimulationFlagForEstimateFee>): Request<List<EstimateFeeResponse>>

open override fun getEstimateFee(payload: List<TransactionPayload>, blockTag: BlockTag, simulationFlags: Set<SimulationFlagForEstimateFee>): Request<List<EstimateFeeResponse>>

open override fun getEstimateFee(payload: List<TransactionPayload>, blockHash: Felt, simulationFlags: Set<SimulationFlagForEstimateFee>): Request<List<EstimateFeeResponse>>

open override fun getEstimateFee(payload: List<TransactionPayload>, blockNumber: Int, simulationFlags: Set<SimulationFlagForEstimateFee>): Request<List<EstimateFeeResponse>>

Estimate a fee.

getEstimateMessageFee

open override fun getEstimateMessageFee(message: MessageL1ToL2, blockTag: BlockTag): Request<EstimateFeeResponse>

open override fun getEstimateMessageFee(message: MessageL1ToL2, blockHash: Felt): Request<EstimateFeeResponse>

open override fun getEstimateMessageFee(message: MessageL1ToL2, blockNumber: Int): Request<EstimateFeeResponse>

Estimate a message fee.

getEvents

open override fun getEvents(payload: GetEventsPayload): Request<GetEventsResult>

Get events

getNonce

open override fun getNonce(contractAddress: Felt): Request<Felt>

open override fun getNonce(contractAddress: Felt, blockTag: BlockTag): Request<Felt>

open override fun getNonce(contractAddress: Felt, blockHash: Felt): Request<Felt>

open override fun getNonce(contractAddress: Felt, blockNumber: Int): Request<Felt>

Get a nonce.

getSpecVersion

open override fun getSpecVersion(): Request<String>

Get the version of the spec.

getStateUpdate

open override fun getStateUpdate(blockTag: BlockTag): Request<StateUpdate>

open override fun getStateUpdate(blockHash: Felt): Request<StateUpdate>

open override fun getStateUpdate(blockNumber: Int): Request<StateUpdate>

Get block state information.

getStorageAt

open override fun getStorageAt(contractAddress: Felt, key: Felt): Request<Felt>

open override fun getStorageAt(contractAddress: Felt, key: Felt, blockTag: BlockTag): Request<Felt>

open override fun getStorageAt(contractAddress: Felt, key: Felt, blockHash: Felt): Request<Felt>

open override fun getStorageAt(contractAddress: Felt, key: Felt, blockNumber: Int): Request<Felt>

Get a value of storage var.

getSyncing

open override fun getSyncing(): Request<Syncing>

Get the block synchronization status.

getTransaction

open override fun getTransaction(transactionHash: Felt): Request<Transaction>

Get a transaction.

getTransactionByBlockIdAndIndex

open override fun getTransactionByBlockIdAndIndex(blockTag: BlockTag, index: Int): Request<Transaction>

open override fun getTransactionByBlockIdAndIndex(blockHash: Felt, index: Int): Request<Transaction>

open override fun getTransactionByBlockIdAndIndex(blockNumber: Int, index: Int): Request<Transaction>

Get transaction by block id and index.

getTransactionReceipt

open override fun getTransactionReceipt(transactionHash: Felt): Request<out TransactionReceipt>

Get transaction receipt

getTransactionStatus

open override fun getTransactionStatus(transactionHash: Felt): Request<GetTransactionStatusResponse>

Get transaction status

invokeFunction

open override fun invokeFunction(payload: InvokeTransactionV1Payload): Request<InvokeFunctionResponse>

Invoke a function using version 1 transaction.

open override fun invokeFunction(payload: InvokeTransactionV3Payload): Request<InvokeFunctionResponse>

Invoke a function using version 3 transaction.

simulateTransactions

open override fun simulateTransactions(transactions: List<TransactionPayload>, blockTag: BlockTag, simulationFlags: Set<SimulationFlag>): Request<List<SimulatedTransaction>>

open override fun simulateTransactions(transactions: List<TransactionPayload>, blockHash: Felt, simulationFlags: Set<SimulationFlag>): Request<List<SimulatedTransaction>>

open override fun simulateTransactions(transactions: List<TransactionPayload>, blockNumber: Int, simulationFlags: Set<SimulationFlag>): Request<List<SimulatedTransaction>>

Simulate executing a list of transactions