Struct Starknet

pub struct Starknet {
    pub latest_state: StarknetState,
    pub pending_state: StarknetState,
    pub transactions: StarknetTransactions,
    pub config: StarknetConfig,
    pub pending_block_timestamp_shift: i64,
    pub next_block_timestamp: Option<u64>,
    pub next_block_gas: GasModification,
    /* private fields */
}

Fields

latest_state: StarknetState

pending_state: StarknetState

transactions: StarknetTransactions

config: StarknetConfig

pending_block_timestamp_shift: i64

next_block_timestamp: Option<u64>

next_block_gas: GasModification

Implementations

impl Starknet

pub async fn configure_messaging( &mut self, rpc_url: &str, contract_address: Option<&str>, ) -> DevnetResult<String>

Configures the messaging from the given L1 node parameters. Calling this function multiple time will overwrite the previous configuration, if any.

Arguments

• rpc_url - The L1 node RPC URL.
• contract_address - The messaging contract address deployed on L1 node.

pub fn get_ethereum_url(&self) -> Option<String>

Retrieves the ethereum node URL, if configured.

pub fn set_latest_local_block(&self) -> Option<String>

Sets the latest local block processed by messaging.

pub async fn collect_messages_to_l1(&mut self) -> DevnetResult<Vec<MessageToL1>>

Collects all messages found between the current messaging latest block and the Latest Starknet block, including both blocks. This function register the messages in two fashions:

1. Add each message to the l2_to_l1_messages_to_flush.
2. Increment the counter for the hash of each message into l2_to_l1_messages_hashes.

Returns all the messages currently collected and not flushed.

pub async fn send_messages_to_l1(&mut self) -> DevnetResult<Vec<MessageToL1>>

Sends (flush) all the messages in l2_to_l1_messages_to_flush to L1 node. Returns the list of sent messages.

pub async fn consume_l2_to_l1_message( &mut self, message: &MessageToL1, ) -> DevnetResult<Hash256>

Consumes a MessageToL1 that is registered in l2_to_l1_messages. If the count related to the message is hash is already 0, an error is returned, the message’s hash otherwise.

Arguments

• message - The message to consume.

pub async fn fetch_messages_to_l2(&mut self) -> DevnetResult<Vec<MessageToL2>>

Fetches all messages from L1 and converts the ethereum log into MessageToL2.

impl Starknet

pub fn new(config: &StarknetConfig) -> DevnetResult<Self>

pub fn get_state(&mut self) -> &mut StarknetState

pub fn restart(&mut self, restart_l1_to_l2_messaging: bool) -> DevnetResult<()>

pub fn get_predeployed_accounts(&self) -> Vec<Account>

pub fn commit_diff(&mut self) -> DevnetResult<StateDiff>

Commits the changes since the last commit. Use it to commit the changes generated by the last tx. Updates the pending_state_diff to accumulate the changes since the last block. Check StarknetState::commit_diff for more info.

pub fn get_class_hash_at( &mut self, block_id: &BlockId, contract_address: ContractAddress, ) -> DevnetResult<ClassHash>

pub fn get_class( &self, block_id: &BlockId, class_hash: ClassHash, ) -> DevnetResult<ContractClass>

pub fn get_class_at( &mut self, block_id: &BlockId, contract_address: ContractAddress, ) -> DevnetResult<ContractClass>

pub fn call( &mut self, block_id: &BlockId, contract_address: Felt, entrypoint_selector: Felt, calldata: Vec<Felt>, ) -> DevnetResult<Vec<Felt>>

pub fn estimate_fee( &mut self, block_id: &BlockId, transactions: &[BroadcastedTransaction], simulation_flags: &[SimulationFlag], ) -> DevnetResult<Vec<FeeEstimateWrapper>>

pub fn estimate_message_fee( &mut self, block_id: &BlockId, message: MsgFromL1, ) -> DevnetResult<FeeEstimateWrapper>

pub fn add_declare_transaction( &mut self, declare_transaction: BroadcastedDeclareTransaction, ) -> DevnetResult<(TransactionHash, ClassHash)>

pub fn chain_id(&self) -> ChainId

returning the chain id as object

pub fn add_deploy_account_transaction( &mut self, deploy_account_transaction: BroadcastedDeployAccountTransaction, ) -> DevnetResult<(TransactionHash, ContractAddress)>

pub fn add_invoke_transaction( &mut self, invoke_transaction: BroadcastedInvokeTransaction, ) -> DevnetResult<TransactionHash>

pub fn add_l1_handler_transaction( &mut self, l1_handler_transaction: L1HandlerTransaction, ) -> DevnetResult<TransactionHash>

pub async fn mint( &mut self, address: ContractAddress, amount: BigUint, erc20_address: ContractAddress, ) -> DevnetResult<Felt>

Creates an invoke tx for minting, using the chargeable account. Uses transfer function of the ERC20 contract

pub fn block_state_update( &self, block_id: &BlockId, ) -> DevnetResult<StateUpdateResult>

pub fn set_next_block_gas( &mut self, gas_prices: GasModificationRequest, ) -> DevnetResult<GasModification>

pub fn abort_blocks( &mut self, starting_block_id: BlockId, ) -> DevnetResult<Vec<Felt>>

pub fn get_block_txs_count(&self, block_id: &BlockId) -> DevnetResult<u64>

pub fn contract_nonce_at_block( &mut self, block_id: &BlockId, contract_address: ContractAddress, ) -> DevnetResult<Felt>

pub fn contract_storage_at_block( &mut self, block_id: &BlockId, contract_address: ContractAddress, storage_key: PatriciaKey, ) -> DevnetResult<Felt>

pub fn get_block(&self, block_id: &BlockId) -> DevnetResult<&StarknetBlock>

pub fn get_block_with_transactions( &self, block_id: &BlockId, ) -> DevnetResult<BlockResult>

pub fn get_block_with_receipts( &self, block_id: &BlockId, ) -> DevnetResult<BlockResult>

pub fn get_transaction_by_block_id_and_index( &self, block_id: &BlockId, index: u64, ) -> DevnetResult<&TransactionWithHash>

pub fn get_latest_block(&self) -> DevnetResult<StarknetBlock>

pub fn get_transaction_by_hash( &self, transaction_hash: Felt, ) -> DevnetResult<&TransactionWithHash>

pub fn get_events( &self, from_block: Option<BlockId>, to_block: Option<BlockId>, address: Option<ContractAddress>, keys: Option<Vec<Vec<Felt>>>, skip: usize, limit: Option<usize>, ) -> DevnetResult<(Vec<EmittedEvent>, bool)>

pub fn get_transaction_receipt_by_hash( &self, transaction_hash: &TransactionHash, ) -> DevnetResult<TransactionReceipt>

pub fn get_transaction_trace_by_hash( &self, transaction_hash: TransactionHash, ) -> DevnetResult<TransactionTrace>

pub fn get_transaction_traces_from_block( &self, block_id: &BlockId, ) -> DevnetResult<Vec<BlockTransactionTrace>>

pub fn get_transaction_execution_and_finality_status( &self, transaction_hash: TransactionHash, ) -> DevnetResult<(TransactionExecutionStatus, TransactionFinalityStatus)>

pub fn simulate_transactions( &mut self, block_id: &BlockId, transactions: &[BroadcastedTransaction], simulation_flags: Vec<SimulationFlag>, ) -> DevnetResult<Vec<SimulatedTransaction>>

pub fn create_block(&mut self) -> DevnetResult<(), Error>

create new block from pending one

pub fn set_time( &mut self, timestamp: u64, create_block: bool, ) -> DevnetResult<(), Error>

pub fn increase_time(&mut self, time_shift: u64) -> DevnetResult<(), Error>

pub fn set_block_timestamp_shift(&mut self, timestamp: i64)

pub fn set_next_block_timestamp(&mut self, timestamp: u64)

pub fn get_unix_timestamp_as_seconds() -> u64

pub fn impersonate_account( &mut self, account: ContractAddress, ) -> DevnetResult<(), Error>

Impersonates account, allowing to send transactions on behalf of the account, without its private key

Arguments

• account - Account to impersonate

pub fn stop_impersonating_account(&mut self, account: &ContractAddress)

Stops impersonating account. After this call, the account, previously impersonated can’t be used to send transactions without its private key

Arguments

• account - Account to stop impersonating

pub fn set_auto_impersonate_account( &mut self, auto_impersonation: bool, ) -> DevnetResult<(), Error>

Turn on/off auto impersonation of accounts that are not part of the state

Arguments

• auto_impersonation - If true, auto impersonate every account that is not part of the state, otherwise dont auto impersonate

Trait Implementations

impl Default for Starknet

fn default() -> Self

Returns the “default value” for a type.