Skip to content

Commit

Permalink
fix: remove version from miden-mock dependency in miden-tx
Browse files Browse the repository at this point in the history
  • Loading branch information
bobbinth committed Mar 5, 2024
1 parent 09b63f8 commit 3cbe8d5
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
2 changes: 1 addition & 1 deletion miden-tx/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ miden-verifier = { workspace = true }
vm-processor = { workspace = true }

[dev-dependencies]
mock = { package = "miden-mock", path = "../mock", version = "0.1", default-features = false }
mock = { package = "miden-mock", path = "../mock", default-features = false }
10 changes: 3 additions & 7 deletions miden-tx/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,18 @@
# Miden Transaction

This crate contains tools to create, execute, and prove transactions.
This crate contains tools to create, execute, and prove Miden transactions.

## Usage

This crate exposes a few components to compile, run, and prove transactions.

The first requirement is to have a `DataStore` implementation. `DataStore`
objects are responsible to load the data needed by the transactions executor,
specially the account's code, the reference block data, and the note's inputs.
The first requirement is to have a `DataStore` implementation. `DataStore` objects are responsible to load the data needed by the transactions executor, specially the account's code, the reference block data, and the note's inputs.

```rust
let store = DataStore:new();
```

Once a store is available, a `TransactionExecutor` object can be used to
execute a transaction. Consuming a zero or more notes, and possibly calling
some of the account's code.
Once a store is available, a `TransactionExecutor` object can be used to execute a transaction. Consuming a zero or more notes, and possibly calling some of the account's code.

```rust
let executor = TransactionExecutor::new(store);
Expand Down

0 comments on commit 3cbe8d5

Please sign in to comment.