Python bindings (astraly-labs#3)

Python bindings

* reference added.
* create env method
* create middleware method
* Implemented bindings for 3 functions:
  - create environment
  - create middleware
  - create account

* remove pyo3 ci
* Added environment operations:
  - declare contract
  - account execute call
  - top_up_balance

* cleanups

* added support for
  - call
  - set storage
  - get storage
* added support for
  - impersonate
  - stop_impersonate
* Added methods to:
  - create subscription
  - poll subscription
  - fixed id generation for middleware
* expanding examples
* adding known contracts into python bindings
* debugging bindings
* fixes
* example finalised
* lints and gas-price
* replay block transaction implementation
* mocked account method added
* some new tests
* event filter for replay block transactions speedup
* remove local devnet dep

Author: baitcode

.gitignore

@@ -1,3 +1,5 @@
+.env
+
 # Generated by Cargo
 # will have compiled files and executables
 /target/
@@ -23,4 +25,4 @@ starkbiter-core/data
 example_fork/test.json
 
 doctest_cache/
-docs/target/*
+docs/target/*

Cargo.lock

@@ -1,6 +1,6 @@
 [workspace]
 # List of crates included in this workspace
-members = ["core", "bindings", "macros", "engine"]
+members = ["core", "bindings", "macros", "engine", "python-bindings"]
 
 # List of crates excluded from this workspace
 exclude = ["benches", "docs"]
@@ -41,7 +41,8 @@ starkbiter-core = { path = "core" }
 starkbiter-engine = { path = "engine" }
 starkbiter-macros = { path = "macros" }
 
-# starknet-devnet-core = { path = "/Users/baitcode/work/starknet/starknet-devnet/crates/starknet-devnet-core" }
+uuid = { version = "=1.17.0", features = ["v4"] }
+
 starknet-devnet-core = { git = "https://github.com/baitcode/starknet-devnet.git", branch = "experiment" }
 starknet-devnet-types = { git = "https://github.com/baitcode/starknet-devnet.git", branch = "experiment" }
 starknet_api = "=0.14.0-rc.3"
@@ -106,6 +107,9 @@ config = { version = "=0.14.0" }
 toml.workspace = true
 Inflector = { version = "=0.11.4" }
 
+# Building files
+# foundry-config = { version = "=0.2.0" }
+# tempfile = { version = "3.10.1" }
 
 # Errors
 thiserror.workspace = true
@@ -138,3 +142,6 @@ lto = true
 # The Rust compiler splits your crate into multiple codegen units to parallelize (and thus speed up) compilation but at the cost of optimization.
 # This setting tells the compiler to use only one codegen unit, which will slow down compilation but improve optimization.
 codegen-units = 1
+
+[workspace.metadata.cargo-machete]
+ignored = ["proc-macro2"]

Cargo.toml

@@ -30,22 +30,27 @@ The Starkbiter workspace has five crates:
 
 ## WIP
 
+- [ ] non-blocking event polling
 - [x] bin docs
 - [x] core docs
 - [x] main readme
 - [ ] docs docs
+    - [x] getting started
+    - [ ] usage
+    - [x] index
 - [ ] benchmarks
 - [ ] python bindings
-- [ ] more test cases, more granular, coverage report
-- [ ] support for replaying mainnet transactions mixing them with simulated ones.
-- [ ] event persistence
-- [ ] github workflows revival
+- [x] more test cases
+- [ ] coverage report
+- [x] support for replaying mainnet transactions mixing them with simulated ones.
+- [x] github workflows revival
 - [ ] contribute to cainome and remove fork dep
 - [ ] contribute to starknet-rs and remove fork dep + Fix generic Runtime error with more specific errors from within Provider
 - [ ] contribute to starknet-devnet and remove fork dep
+- [x] test that toml config parameters for forking work
+- [x] contract execution logging and traces from Devnet
 - [ ] test for simultaneous connection usage by different contracts.
-- [ ] test that toml config parameters for forking work
-- [ ] contract execution logging and traces from Devnet
+
 
 ## Book
 TODO: Does not exist yet

README.md

@@ -12,7 +12,7 @@ use starkbiter_core::{
     environment::Environment,
     middleware::{traits::Middleware, StarkbiterMiddleware},
 };
-use starknet_accounts::{Account, ConnectedAccount};
+use starknet_accounts::ConnectedAccount;
 use starknet_core::{
     types::{Call, Felt},
     utils::get_selector_from_name,
@@ -113,7 +113,7 @@ async fn bencher(client: Arc<StarkbiterMiddleware>, label: &str) -> BenchDuratio
     // Track the duration for each part of the benchmark.
     let mut total_deploy_duration = 0;
     let mut total_lookup_duration = 0;
-    let mut total_stateless_call_duration = 0;
+    let total_stateless_call_duration = 0;
     let mut total_stateful_call_duration = 0;
 
     // Deploy `ArbiterMath` and `ArbiterToken` contracts and tally up how long this

core/benches/bench.rs

@@ -17,6 +17,18 @@ use starknet_devnet_types::{
 use super::*;
 use crate::tokens::TokenId;
 
+/// Filter to pass to replay block method so that only transactions containing
+/// certain events would be applied. This is merely an optimisation, as block
+/// replay with 200 tx would take 20 mins.
+#[derive(Debug, Clone)]
+pub struct EventFilter {
+    /// Matched events emitted by this address
+    pub from_address: Felt,
+    /// Matches events with those keys: [selector, key1, key2]
+    /// selector is a keccak hash from event name.
+    pub keys: Vec<Felt>,
+}
+
 /// Instructions that can be sent to the [`Environment`] via the [`Socket`].
 ///
 /// These instructions are sent to the [`Environment`] via the
@@ -313,7 +325,7 @@ pub enum Outcome {
     /// Node-related outcome.
     Node(NodeOutcome),
     /// Cheatcode-related outcome.
-    Cheat(CheatcodesReturn),
+    Cheat(CheatcodesOutcome),
     /// System-related outcome.
     System(SystemInstructionOutcome),
 }
@@ -417,18 +429,36 @@ pub enum CheatInstruction {
         /// The transaction hash of the deployment.
         tx_hash: Felt,
     },
+
+    /// Gets a block with transactions by its identifier
+    /// from the forked blockchain.
+    GetBlockWithTxs {
+        /// The identifier of the block to retrieve.
+        block_id: core_types::BlockId,
+    },
+    /// Fetches block with transactions by its identifier
+    /// and adds them on top of pending block in DevNet.
+    ReplayBlockWithTxs {
+        /// The identifier of the block to retrieve.
+        block_id: core_types::BlockId,
+        /// Checks if transaction has events matching filters and applies it if
+        /// so, otherwise ignores.
+        has_events: Option<Vec<EventFilter>>,
+        /// Set to true to recalculate the nonce for the transactions
+        override_nonce: bool,
+    },
 }
 
 /// Return values of applying cheatcodes.
 #[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
-pub enum CheatcodesReturn {
+pub enum CheatcodesOutcome {
     /// Returns the class hash of the declared contract.
     DeclareContract(Felt),
     /// Returns the contract address of the created account.
     CreateAccount(Felt),
     /// Indicates a block was created.
     CreateBlock,
-    /// Returns the result of sending an L1 message.
+    /// Returns the tx_hash of L1 message transaction.
     L1Message(Felt),
     /// Indicates a balance was added.
     TopUpBalance,
@@ -443,4 +473,9 @@ pub enum CheatcodesReturn {
     SetNextBlockGas(GasModification),
     /// Returns the address of the deployed contract.
     GetDeployedContractAddress(Felt),
+    /// Returns block with transactions.
+    GetBlockWithTxs(Box<core_types::MaybePendingBlockWithTxs>),
+    /// Returns numbers of transactions from the origin block that were (added,
+    /// ignored, failed)
+    ReplayBlockWithTxs(usize, usize, usize),
 }