Constructor Detail

Method Detail

• getTransaction

   abstract Request<Transaction> getTransaction(Felt transactionHash)

  Get a transaction.

  Get the details of a submitted transaction.

  Parameters:

  transactionHash - a hash of sent transaction

• invokeFunction

   abstract Request<InvokeFunctionResponse> invokeFunction(InvokeTransactionV3 payload)

  Invoke a function using version 3 transaction.

  Invoke a function in deployed contract using version 3 transaction.

  Parameters:

  payload - invoke function version 3 payload

• getClass

   abstract Request<ContractClassBase> getClass(Felt classHash)

  Get the contract class definition.

  Get the contract class definition associated with the given hash.

  Parameters:

  classHash - The hash of the requested contract class.

• getClass

   abstract Request<ContractClassBase> getClass(Felt classHash, Felt blockHash)

  Get the contract class definition.

  Get the contract class definition associated with the given hash.

  Parameters:

  classHash - The hash of the requested contract class.

  blockHash - The hash of requested block.

• getClass

   abstract Request<ContractClassBase> getClass(Felt classHash, Integer blockNumber)

  Get the contract class definition.

  Get the contract class definition associated with the given block number.

  Parameters:

  classHash - The hash of the requested contract class.

  blockNumber - The number of requested block.

• getClass

   abstract Request<ContractClassBase> getClass(Felt classHash, BlockTag blockTag)

  Get the contract class definition.

  Get the contract class definition associated with the given block tag.

  Parameters:

  classHash - The hash of the requested contract class.

  blockTag - The tag of requested block.

• declareContract

   abstract Request<DeclareResponse> declareContract(DeclareTransactionV3 payload)

  Declare contract using version 3 transaction.

  Declare a contract on Starknet using version 3 transaction.

  Parameters:

  payload - declare transaction version 3 payload

• getBlockNumber

   abstract Request<IntResponse> getBlockNumber()

  Get the block number.

  Get the most recent accepted block number.

• getBlockHashAndNumber

   abstract Request<GetBlockHashAndNumberResponse> getBlockHashAndNumber()

  Get the hash and number of the block.

  Get the most recent accepted block hash and number.

• getBlockTransactionCount

   abstract Request<IntResponse> getBlockTransactionCount(BlockTag blockTag)

  Get the block transaction count.

  Get the number of transactions in a given block.

  Parameters:

  blockTag - The tag of the block.

• getBlockTransactionCount

   abstract Request<IntResponse> getBlockTransactionCount(Felt blockHash)

  Get the block transaction count.

  Get the number of transactions in a given block.

  Parameters:

  blockHash - The hash of the block.

• getBlockTransactionCount

   abstract Request<IntResponse> getBlockTransactionCount(Integer blockNumber)

  Get the block transaction count.

  Get the number of transactions in a given block.

  Parameters:

  blockNumber - The number of the block.

• deployAccount

   abstract Request<DeployAccountResponse> deployAccount(DeployAccountTransactionV3 payload)

  Deploy an account contract using version 3 transaction.

  Deploy a new account contract on Starknet.

  Parameters:

  payload - deploy account transaction version 3 payload

• callContract

   abstract Request<FeltArray> callContract(Call call, BlockTag blockTag)

  Calls a contract deployed on Starknet.

  Parameters:

  call - a call to be made

• callContract

   abstract Request<FeltArray> callContract(Call call, Felt blockHash)

  Calls a contract deployed on Starknet.

  Parameters:

  call - a call to be made

  blockHash - a hash of the block in respect to what the call will be made

• callContract

   abstract Request<FeltArray> callContract(Call call, Integer blockNumber)

  Calls a contract deployed on Starknet.

  Parameters:

  call - a call to be made

  blockNumber - a number of the block in respect to what the call will be made

• callContract

   abstract Request<FeltArray> callContract(Call call)

  Calls a contract deployed on Starknet.

  Calls a contract deployed on Starknet in the latest block.

  Parameters:

  call - a call to be made

• getSpecVersion

   abstract Request<StringResponse> getSpecVersion()

  Get the version of the spec.

  Get the version of the Starknet JSON-RPC specification being used by the node.

• getStorageAt

   abstract Request<Felt> getStorageAt(Felt contractAddress, Felt key, BlockTag blockTag)

  Get a value of storage var.

  Get a value of a storage variable of contract at the provided address.

  Parameters:

  contractAddress - an address of the contract

  key - an address of the storage variable inside contract

  blockTag - The tag of the requested block.

• getStorageAt

   abstract Request<Felt> getStorageAt(Felt contractAddress, Felt key, Felt blockHash)

  Get a value of storage var.

  Get a value of a storage variable of contract at the provided address.

  Parameters:

  contractAddress - an address of the contract

  key - an address of the storage variable inside contract

  blockHash - a hash of the block in respect to what the query will be made

• getStorageAt

   abstract Request<Felt> getStorageAt(Felt contractAddress, Felt key, Integer blockNumber)

  Get a value of storage var.

  Get a value of a storage variable of contract at the provided address.

  Parameters:

  contractAddress - an address of the contract

  key - an address of the storage variable inside contract

  blockNumber - a number of the block in respect to what the query will be made

• getStorageAt

   abstract Request<Felt> getStorageAt(Felt contractAddress, Felt key)

  Get a value of storage var.

  Get a value of a storage variable of contract at the provided address and in the latest block.

  Parameters:

  contractAddress - an address of the contract

  key - an address of the storage variable inside contract

• getStorageAt

   abstract Request<Felt> getStorageAt(Felt contractAddress, String key, BlockTag blockTag)

  Get a value of storage var.

  Get a value of a storage variable of contract at the provided address.

  Parameters:

  contractAddress - an address of the contract

  key - an address of the storage variable inside contract

  blockTag - The tag of the requested block.

• getStorageAt

   abstract Request<Felt> getStorageAt(Felt contractAddress, String key, Felt blockHash)

  Get a value of storage var.

  Get a value of a storage variable of contract at the provided address.

  Parameters:

  contractAddress - an address of the contract

  key - an address of the storage variable inside contract

  blockHash - a hash of the block in respect to what the query will be made

• getStorageAt

   abstract Request<Felt> getStorageAt(Felt contractAddress, String key, Integer blockNumber)

  Get a value of storage var.

  Get a value of a storage variable of contract at the provided address.

  Parameters:

  contractAddress - an address of the contract

  key - an address of the storage variable inside contract

  blockNumber - a number of the block in respect to what the query will be made

• getStorageAt

   abstract Request<Felt> getStorageAt(Felt contractAddress, String key)

  Get a value of storage var.

  Get a value of a storage variable of contract at the provided address and in the latest block.

  Parameters:

  contractAddress - an address of the contract

  key - an address of the storage variable inside contract

• getTransactionReceipt

   abstract Request<out TransactionReceipt> getTransactionReceipt(Felt transactionHash)

  Get transaction receipt

  Get a receipt of the transactions.

  Parameters:

  transactionHash - a hash of sent transaction

• getTransactionStatus

   abstract Request<GetTransactionStatusResponse> getTransactionStatus(Felt transactionHash)

  Get transaction status

  Get a status of the transaction.

  Parameters:

  transactionHash - a hash of sent transaction

• getMessagesStatus

   abstract Request<MessageStatusList> getMessagesStatus(NumAsHex l1TransactionHash)

  Get L1 handler transaction data.

  Get L1 handler transaction data for all L1 → L2 messages sent by the given L1 transaction.

  Parameters:

  l1TransactionHash - the hash of the L1 transaction.

• getClassAt

   abstract Request<ContractClassBase> getClassAt(Felt contractAddress, Felt blockHash)

  Get the contract class definition.

  Get the contract class definition at the given address in the given block.

  Parameters:

  contractAddress - The address of the contract whose class definition will be returned.

  blockHash - The hash of the requested block.

• getClassAt

   abstract Request<ContractClassBase> getClassAt(Felt contractAddress, Integer blockNumber)

  Get the contract class definition.

  Get the contract class definition at the given address in the given block.

  Parameters:

  contractAddress - The address of the contract whose class definition will be returned.

  blockNumber - The number of the requested block.

• getClassAt

   abstract Request<ContractClassBase> getClassAt(Felt contractAddress, BlockTag blockTag)

  Get the contract class definition.

  Get the contract class definition at the given address in the given block.

  Parameters:

  contractAddress - The address of the contract whose class definition will be returned.

  blockTag - The tag of the requested block.

• getClassAt

   abstract Request<ContractClassBase> getClassAt(Felt contractAddress)

  Get the contract class definition.

  Get the contract class definition in the at the given address in the latest block.

  Parameters:

  contractAddress - The address of the contract whose class definition will be returned.

• getClassHashAt

   abstract Request<Felt> getClassHashAt(Felt contractAddress, Felt blockHash)

  Get the contract class hash.

  Get the contract class hash in the given block for the contract deployed at the given address.

  Parameters:

  contractAddress - The address of the contract whose class definition will be returned.

  blockHash - The hash of the requested block.

• getClassHashAt

   abstract Request<Felt> getClassHashAt(Felt contractAddress, Integer blockNumber)

  Get the contract class hash.

  Get the contract class hash in the given block for the contract deployed at the given address.

  Parameters:

  contractAddress - The address of the contract whose class definition will be returned.

  blockNumber - The number of the requested block.

• getClassHashAt

   abstract Request<Felt> getClassHashAt(Felt contractAddress, BlockTag blockTag)

  Get the contract class hash.

  Get the contract class hash in the given block for the contract deployed at the given address.

  Parameters:

  contractAddress - The address of the contract whose class definition will be returned.

  blockTag - The tag of the requested block.

• getClassHashAt

   abstract Request<Felt> getClassHashAt(Felt contractAddress)

  Get the contract class hash.

  Get the contract class hash in the given block for the contract deployed at the given address and in the latest block.

  Parameters:

  contractAddress - The address of the contract whose class definition will be returned.

• getEvents

   abstract Request<GetEventsResult> getEvents(GetEventsPayload payload)

  Get events

  Returns all events matching the given filter

  Parameters:

  payload - get events payload

• getEstimateFee

   abstract Request<EstimateFeeResponseList> getEstimateFee(List<ExecutableTransaction> payload, Felt blockHash, Set<SimulationFlagForEstimateFee> simulationFlags)

  Estimate a fee.

  Estimate a fee for a provided transaction list.

  Parameters:

  payload - transactions, for which the fee is to be estimated.

  blockHash - a hash of the block in respect to what the query will be made

  simulationFlags - set of flags to be used for simulation.

• getEstimateFee

   abstract Request<EstimateFeeResponseList> getEstimateFee(List<ExecutableTransaction> payload, Felt blockHash)

  Estimate a fee.

  Estimate a fee for a provided transaction list.

  Parameters:

  payload - transactions, for which the fee is to be estimated.

  blockHash - a hash of the block in respect to what the query will be made

• getEstimateFee

   abstract Request<EstimateFeeResponseList> getEstimateFee(List<ExecutableTransaction> payload, Integer blockNumber, Set<SimulationFlagForEstimateFee> simulationFlags)

  Estimate a fee.

  Estimate a fee for a provided transaction list.

  Parameters:

  payload - transactions, for which the fee is to be estimated.

  blockNumber - a number of the block in respect to what the query will be made

  simulationFlags - set of flags to be used for simulation.

• getEstimateFee

   abstract Request<EstimateFeeResponseList> getEstimateFee(List<ExecutableTransaction> payload, Integer blockNumber)

  Estimate a fee.

  Estimate a fee for a provided transaction list.

  Parameters:

  payload - transactions, for which the fee is to be estimated.

  blockNumber - a number of the block in respect to what the query will be made

• getEstimateFee

   abstract Request<EstimateFeeResponseList> getEstimateFee(List<ExecutableTransaction> payload, BlockTag blockTag, Set<SimulationFlagForEstimateFee> simulationFlags)

  Estimate a fee.

  Estimate a fee for a provided transaction list.

  Parameters:

  payload - transactions, for which the fee is to be estimated.

  blockTag - a tag of the block in respect to what the query will be made

  simulationFlags - set of flags to be used for simulation.

• getEstimateFee

   abstract Request<EstimateFeeResponseList> getEstimateFee(List<ExecutableTransaction> payload, BlockTag blockTag)

  Estimate a fee.

  Estimate a fee for a provided transaction list.

  Parameters:

  payload - transactions, for which the fee is to be estimated.

  blockTag - a tag of the block in respect to what the query will be made

• getEstimateFee

   abstract Request<EstimateFeeResponseList> getEstimateFee(List<ExecutableTransaction> payload, Set<SimulationFlagForEstimateFee> simulationFlags)

  Estimate a fee.

  Estimate a fee for a provided transaction list for pending block.

  Parameters:

  payload - transactions, for which the fee is to be estimated.

  simulationFlags - set of flags to be used for simulation

• getEstimateFee

   abstract Request<EstimateFeeResponseList> getEstimateFee(List<ExecutableTransaction> payload)

  Estimate a fee.

  Estimate a fee for a provided transaction list for pending block.

  Parameters:

  payload - transaction, for which the fee is to be estimated.

• getEstimateMessageFee

   abstract Request<EstimateMessageFeeResponse> getEstimateMessageFee(MessageL1ToL2 message, Felt blockHash)

  Estimate a message fee.

  Estimate the L2 fee of a provided message sent on L1.

  Parameters:

  message - message, for which the fee is to be estimated.

  blockHash - a hash of the block in respect to what the query will be made

• getEstimateMessageFee

   abstract Request<EstimateMessageFeeResponse> getEstimateMessageFee(MessageL1ToL2 message, Integer blockNumber)

  Estimate a message fee.

  Estimate the L2 fee of a provided message sent on L1.

  Parameters:

  message - message, for which the fee is to be estimated.

  blockNumber - a number of the block in respect to what the query will be made

• getEstimateMessageFee

   abstract Request<EstimateMessageFeeResponse> getEstimateMessageFee(MessageL1ToL2 message, BlockTag blockTag)

  Estimate a message fee.

  Estimate the L2 fee of a provided message sent on L1.

  Parameters:

  message - message, for which the fee is to be estimated.

  blockTag - a tag of the block in respect to what the query will be made

• getNonce

   abstract Request<Felt> getNonce(Felt contractAddress)

  Get a nonce.

  Get a nonce of an account contract of a given address for pending block.

  Parameters:

  contractAddress - address of account contract

• getNonce

   abstract Request<Felt> getNonce(Felt contractAddress, BlockTag blockTag)

  Get a nonce.

  Get a nonce of an account contract of a given address for specified block tag.

  Parameters:

  contractAddress - address of account contract

  blockTag - block tag used for returning this value

• getNonce

   abstract Request<Felt> getNonce(Felt contractAddress, Integer blockNumber)

  Get a nonce.

  Get a nonce of an account contract of a given address for specified block number.

  Parameters:

  contractAddress - address of account contract

  blockNumber - block number used for returning this value

• getNonce

   abstract Request<Felt> getNonce(Felt contractAddress, Felt blockHash)

  Get a nonce.

  Get a nonce of an account contract of a given address for specified block hash.

  Parameters:

  contractAddress - address of account contract

  blockHash - block hash used for returning this value

• getStorageProof

   abstract Request<StorageProof> getStorageProof(BlockId blockId, List<Felt> classHashes, List<Felt> contractAddresses, List<ContractsStorageKeys> contractsStorageKeys)

  Get merkle paths in one of the state tries.

  Get merkle paths in one of the state tries: global state, classes, individual contract.

  Parameters:

  blockId - the hash of the requested block

  classHashes - list of class hashes for which we want to prove membership

  contractAddresses - list of contract addresses for which we want to prove membership

  contractsStorageKeys - list of (contract address, storage keys) pairs

• getSyncing

   abstract Request<Syncing> getSyncing()

  Get the block synchronization status.

  Get the starting, current and highest block info or boolean indicating syncing is not in progress.

• getChainId

   abstract Request<StarknetChainId> getChainId()

  Get the chain id.

  Get the currently configured Starknet chain id.

• getBlockWithTxs

   abstract Request<BlockWithTransactions> getBlockWithTxs(BlockTag blockTag)

  Get a block with transactions.

  Get block information with full transactions given the block id.

  Parameters:

  blockTag - a tag of the requested block

• getBlockWithTxs

   abstract Request<BlockWithTransactions> getBlockWithTxs(Felt blockHash)

  Get a block with transactions.

  Get block information with full transactions given the block id.

  Parameters:

  blockHash - a hash of the requested block

• getBlockWithTxs

   abstract Request<BlockWithTransactions> getBlockWithTxs(Integer blockNumber)

  Get a block with transactions.

  Get block information with full transactions given the block id.

  Parameters:

  blockNumber - a number of the requested block

• getBlockWithTxHashes

   abstract Request<BlockWithTransactionHashes> getBlockWithTxHashes(BlockTag blockTag)

  Get a block with transaction hashes.

  Get block information with transaction hashes given the block id.

  Parameters:

  blockTag - a tag of the requested block

• getBlockWithTxHashes

   abstract Request<BlockWithTransactionHashes> getBlockWithTxHashes(Felt blockHash)

  Get a block with transaction hashes.

  Get block information with transaction hashes given the block id.

  Parameters:

  blockHash - a hash of the requested block

• getBlockWithTxHashes

   abstract Request<BlockWithTransactionHashes> getBlockWithTxHashes(Integer blockNumber)

  Get a block with transaction hashes.

  Get block information with transaction hashes given the block id.

  Parameters:

  blockNumber - a number of the requested block

• getBlockWithReceipts

   abstract Request<BlockWithReceipts> getBlockWithReceipts(BlockTag blockTag)

  Get a block with transaction receipts.

  Get block information with transaction receipts given the block id.

  Parameters:

  blockTag - a tag of the requested block

• getBlockWithReceipts

   abstract Request<BlockWithReceipts> getBlockWithReceipts(Felt blockHash)

  Get a block with transaction receipts.

  Get block information with transaction receipts given the block id.

  Parameters:

  blockHash - a hash of the requested block

• getBlockWithReceipts

   abstract Request<BlockWithReceipts> getBlockWithReceipts(Integer blockNumber)

  Get a block with transaction receipts.

  Get block information with transaction receipts given the block id.

  Parameters:

  blockNumber - a number of the requested block

• getStateUpdate

   abstract Request<StateUpdate> getStateUpdate(BlockTag blockTag)

  Get block state information.

  Get the information about the result of executing the requested block.

  Parameters:

  blockTag - a tag of the requested block

• getStateUpdate

   abstract Request<StateUpdate> getStateUpdate(Felt blockHash)

  Get block state information.

  Get the information about the result of executing the requested block.

  Parameters:

  blockHash - a hash of the requested block

• getStateUpdate

   abstract Request<StateUpdate> getStateUpdate(Integer blockNumber)

  Get block state information.

  Get the information about the result of executing the requested block.

  Parameters:

  blockNumber - a number of the requested block

• getTransactionByBlockIdAndIndex

   abstract Request<Transaction> getTransactionByBlockIdAndIndex(BlockTag blockTag, Integer index)

  Get transaction by block id and index.

  Get the details of a transaction by a given block id and index.

  Parameters:

  blockTag - a tag of the requested block

• getTransactionByBlockIdAndIndex

   abstract Request<Transaction> getTransactionByBlockIdAndIndex(Felt blockHash, Integer index)

  Get transaction by block id and index.

  Get the details of a transaction by a given block id and index.

  Parameters:

  blockHash - a hash of the requested block

• getTransactionByBlockIdAndIndex

   abstract Request<Transaction> getTransactionByBlockIdAndIndex(Integer blockNumber, Integer index)

  Get transaction by block id and index.

  Get the details of a transaction by a given block id and index.

  Parameters:

  blockNumber - a number of the requested block

• simulateTransactions

   abstract Request<SimulatedTransactionList> simulateTransactions(List<ExecutableTransaction> transactions, BlockTag blockTag, Set<SimulationFlag> simulationFlags)

  Simulate executing a list of transactions

  Parameters:

  transactions - list of transactions to be simulated

  blockTag - tag of the block that should be used for simulation

  simulationFlags - set of flags to be used for simulation

• simulateTransactions

   abstract Request<SimulatedTransactionList> simulateTransactions(List<ExecutableTransaction> transactions, Integer blockNumber, Set<SimulationFlag> simulationFlags)

  Simulate executing a list of transactions

  Parameters:

  transactions - list of transactions to be simulated

  blockNumber - number of the block that should be used for simulation

  simulationFlags - set of flags to be used for simulation

• simulateTransactions

   abstract Request<SimulatedTransactionList> simulateTransactions(List<ExecutableTransaction> transactions, Felt blockHash, Set<SimulationFlag> simulationFlags)

  Simulate executing a list of transactions

  Parameters:

  transactions - list of transactions to be simulated

  blockHash - hash of the block that should be used for simulation

  simulationFlags - set of flags to be used for simulation