Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(workspace): Reorganize SDK #816

Merged
merged 7 commits into from
Nov 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,14 @@ categories = ["cryptography", "cryptography::cryptocurrencies"]
exclude = ["**/target"]

[workspace]
members = ["crates/*", "bin/*"]
members = [
"crates/derive",
"crates/driver",
"crates/executor",
"crates/mpt",
"crates/proof-sdk/*",
"bin/*"
]
default-members = ["bin/host", "bin/client"]

# Explicitly set the resolver to version 2, which is the default for packages with edition >= 2021
Expand Down Expand Up @@ -57,12 +64,12 @@ lto = "fat"
# Workspace
kona-mpt = { path = "crates/mpt", version = "0.0.6", default-features = false }
kona-client = { path = "bin/client", version = "0.1.0", default-features = false }
kona-common = { path = "crates/common", version = "0.0.4", default-features = false }
kona-derive = { path = "crates/derive", version = "0.0.6", default-features = false }
kona-driver = { path = "crates/driver", version = "0.0.0", default-features = false }
kona-preimage = { path = "crates/preimage", version = "0.0.4", default-features = false }
kona-executor = { path = "crates/executor", version = "0.0.5", default-features = false }
kona-common-proc = { path = "crates/common-proc", version = "0.0.5", default-features = false }
kona-common = { path = "crates/proof-sdk/common", version = "0.0.4", default-features = false }
kona-common-proc = { path = "crates/proof-sdk/common-proc", version = "0.0.5", default-features = false }
kona-preimage = { path = "crates/proof-sdk/preimage", version = "0.0.4", default-features = false }

# Alloy
alloy-rlp = { version = "0.3.9", default-features = false }
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,17 @@ see the [SDK section of the book](https://anton-rs.github.io/kona/sdk/intro.html
- [`cannon`](./build/cannon): Docker image for compiling to the bare-metal `mips-unknown-none` target.
- [`asterisc`](./build/asterisc): Docker image for compiling to the bare-metal `riscv64gc-unknown-none-elf` target.

**`client` / `host` SDK**

- [`common`](./crates/common): A suite of utilities for developing `client` programs to be run on top of Fault Proof VMs.
- [`common-proc`](./crates/common-proc): Proc macro for the `client` program entrypoint.
- [`preimage`](./crates/preimage): High level interfaces to the [`PreimageOracle`][fpp-specs] ABI

**Protocol**
- [`mpt`](./crates/mpt): Utilities for interacting with the Merkle Patricia Trie in the client program.
- [`executor`](./crates/executor): `no_std` stateless block executor for the [OP Stack][op-stack].
- [`derive`](./crates/derive): `no_std` compatible implementation of the [derivation pipeline][g-derivation-pipeline].
- [`derive-alloy`](./crates/derive-alloy/): Online, `alloy`-backed derivation pipeline.
- [`driver`](./crates/driver): Stateful derivation pipeline driver.

**Proof SDK**

- [`common`](./crates/proof-sdk/common): A suite of utilities for developing `client` programs to be run on top of Fault Proof VMs.
- [`common-proc`](./crates/proof-sdk/common-proc): Proc macro for the `client` program entrypoint.
- [`preimage`](./crates/proof-sdk/preimage): High level interfaces to the [`PreimageOracle`][fpp-specs] ABI

## Book

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading