Struct JsonRpcHandler 

pub struct JsonRpcHandler {
    pub api: Api,
    pub origin_caller: Option<OriginForwarder>,
}

This object will be used as a shared state between HTTP calls. Is similar to the HttpApiHandler but is with extended functionality and is used for JSON-RPC methods

Fields

api: Api

origin_caller: Option<OriginForwarder>

Implementations

impl JsonRpcHandler

The definitions of JSON-RPC read endpoints defined in starknet_api_openrpc.json

pub fn spec_version(&self) -> StrictRpcResult

starknet_specVersion

pub async fn get_block_with_tx_hashes( &self, block_id: BlockId, ) -> StrictRpcResult

starknet_getBlockWithTxHashes

pub async fn get_block_with_txs(&self, block_id: BlockId) -> StrictRpcResult

starknet_getBlockWithTxs

pub async fn get_block_with_receipts( &self, block_id: BlockId, ) -> StrictRpcResult

starknet_getBlockWithReceipts

pub async fn get_state_update(&self, block_id: BlockId) -> StrictRpcResult

starknet_getStateUpdate

pub async fn get_storage_at( &self, contract_address: ContractAddress, key: PatriciaKey, block_id: BlockId, ) -> StrictRpcResult

starknet_getStorageAt

pub async fn get_storage_proof( &self, data: GetStorageProofInput, ) -> StrictRpcResult

starknet_getStorageProof

pub async fn get_transaction_by_hash( &self, transaction_hash: TransactionHash, ) -> StrictRpcResult

starknet_getTransactionByHash

pub async fn get_transaction_status_by_hash( &self, transaction_hash: TransactionHash, ) -> StrictRpcResult

starknet_getTransactionStatus

pub async fn get_transaction_by_block_id_and_index( &self, block_id: BlockId, index: u64, ) -> StrictRpcResult

starknet_getTransactionByBlockIdAndIndex

pub async fn get_transaction_receipt_by_hash( &self, transaction_hash: TransactionHash, ) -> StrictRpcResult

starknet_getTransactionReceipt

pub async fn get_class( &self, block_id: BlockId, class_hash: ClassHash, ) -> StrictRpcResult

starknet_getClass

pub async fn get_compiled_casm(&self, class_hash: ClassHash) -> StrictRpcResult

starknet_getCompiledCasm

pub async fn get_class_at( &self, block_id: BlockId, contract_address: ContractAddress, ) -> StrictRpcResult

starknet_getClassAt

pub async fn get_class_hash_at( &self, block_id: BlockId, contract_address: ContractAddress, ) -> StrictRpcResult

starknet_getClassHashAt

pub async fn get_block_txs_count(&self, block_id: BlockId) -> StrictRpcResult

starknet_getBlockTransactionCount

pub async fn call( &self, block_id: BlockId, request: FunctionCall, ) -> StrictRpcResult

starknet_call

pub async fn estimate_fee( &self, block_id: BlockId, request: Vec<BroadcastedTransaction>, simulation_flags: Vec<SimulationFlag>, ) -> StrictRpcResult

starknet_estimateFee

pub async fn estimate_message_fee( &self, block_id: &BlockId, message: MsgFromL1, ) -> StrictRpcResult

pub async fn block_number(&self) -> StrictRpcResult

starknet_blockNumber

pub async fn block_hash_and_number(&self) -> StrictRpcResult

starknet_blockHashAndNumber

pub async fn chain_id(&self) -> StrictRpcResult

starknet_chainId

pub async fn syncing(&self) -> StrictRpcResult

starknet_syncing

pub async fn get_events(&self, filter: EventFilter) -> StrictRpcResult

starknet_getEvents

pub async fn get_nonce( &self, block_id: BlockId, contract_address: ContractAddress, ) -> StrictRpcResult

starknet_getNonce

pub async fn simulate_transactions( &self, block_id: BlockId, transactions: Vec<BroadcastedTransaction>, simulation_flags: Vec<SimulationFlag>, ) -> StrictRpcResult

starknet_simulateTransactions

pub async fn get_trace_transaction( &self, transaction_hash: TransactionHash, ) -> StrictRpcResult

starknet_traceTransaction

pub async fn get_trace_block_transactions( &self, block_id: BlockId, ) -> StrictRpcResult

starknet_traceBlockTransactions

pub async fn get_messages_status( &self, __arg1: L1TransactionHashInput, ) -> StrictRpcResult

starknet_getMessagesStatus

pub async fn get_predeployed_accounts( &self, params: Option<PredeployedAccountsQuery>, ) -> StrictRpcResult

devnet_getPredeployedAccounts

pub async fn get_account_balance(&self, params: BalanceQuery) -> StrictRpcResult

devnet_getAccountBalance

pub async fn get_devnet_config(&self) -> StrictRpcResult

devnet_getConfig

impl JsonRpcHandler

The definitions of JSON-RPC read endpoints defined in starknet_ws_api.json

pub async fn execute_ws_subscription( &self, request: JsonRpcSubscriptionRequest, rpc_request_id: Id, socket_id: SocketId, ) -> Result<(), ApiError>

pub async fn subscribe_new_txs( &self, maybe_subscription_input: Option<TransactionSubscriptionInput>, rpc_request_id: Id, socket_id: SocketId, ) -> Result<(), ApiError>

Does not return TOO_MANY_ADDRESSES_IN_FILTER

pub async fn subscribe_new_tx_receipts( &self, maybe_subscription_input: Option<TransactionReceiptSubscriptionInput>, rpc_request_id: Id, socket_id: SocketId, ) -> Result<(), ApiError>

Does not return TOO_MANY_ADDRESSES_IN_FILTER

impl JsonRpcHandler

pub fn new(api: Api) -> JsonRpcHandler

pub async fn re_execute(&self, events: &[RpcMethodCall]) -> Result<(), RpcError>

impl JsonRpcHandler

pub async fn add_declare_transaction( &self, request: BroadcastedDeclareTransaction, ) -> StrictRpcResult

pub async fn add_deploy_account_transaction( &self, request: BroadcastedDeployAccountTransaction, ) -> StrictRpcResult

pub async fn add_invoke_transaction( &self, request: BroadcastedInvokeTransaction, ) -> StrictRpcResult

pub async fn impersonate_account( &self, address: ContractAddress, ) -> StrictRpcResult

devnet_impersonateAccount

pub async fn stop_impersonating_account( &self, address: ContractAddress, ) -> StrictRpcResult

devnet_stopImpersonateAccount

pub async fn set_auto_impersonate( &self, auto_impersonation: bool, ) -> StrictRpcResult

devnet_autoImpersonate | devnet_stopAutoImpersonate

pub async fn dump(&self, path: Option<DumpPath>) -> StrictRpcResult

devnet_dump

pub async fn load(&self, path: String) -> StrictRpcResult

devnet_load

pub async fn postman_load( &self, data: PostmanLoadL1MessagingContract, ) -> StrictRpcResult

devnet_postmanLoad

pub async fn postman_flush( &self, data: Option<FlushParameters>, ) -> StrictRpcResult

devnet_postmanFlush

pub async fn postman_send_message_to_l2( &self, message: MessageToL2, ) -> StrictRpcResult

devnet_postmanSendMessageToL2

pub async fn postman_consume_message_from_l2( &self, message: MessageToL1, ) -> StrictRpcResult

devnet_postmanConsumeMessageFromL2

pub async fn create_block(&self) -> StrictRpcResult

devnet_createBlock

pub async fn abort_blocks(&self, data: AbortingBlocks) -> StrictRpcResult

devnet_abortBlocks

pub async fn accept_on_l1(&self, data: AcceptOnL1Request) -> StrictRpcResult

devnet_acceptOnL1

pub async fn set_gas_price( &self, data: GasModificationRequest, ) -> StrictRpcResult

devnet_setGasPrice

pub async fn restart(&self, data: Option<RestartParameters>) -> StrictRpcResult

devnet_restart

pub async fn set_time(&self, data: SetTime) -> StrictRpcResult

devnet_setTime

pub async fn increase_time(&self, data: IncreaseTime) -> StrictRpcResult

devnet_increaseTime

pub async fn mint(&self, request: MintTokensRequest) -> StrictRpcResult

devnet_mint

Trait Implementations

impl Clone for JsonRpcHandler

fn clone(&self) -> JsonRpcHandler

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl RpcHandler for JsonRpcHandler

type Request = JsonRpcRequest

The request type to expect

fn on_request<'life0, 'async_trait>( &'life0 self, request: Self::Request, original_call: RpcMethodCall, ) -> Pin<Box<dyn Future<Output = ResponseResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Invoked when the request was received

fn on_call<'life0, 'async_trait>( &'life0 self, call: RpcMethodCall, ) -> Pin<Box<dyn Future<Output = RpcResponse> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Invoked for every incoming RpcMethodCall

fn on_websocket<'life0, 'async_trait>( &'life0 self, socket: WebSocket, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Handles websocket connection, from start to finish.