chore(workspace): reorganize binary example programs (#294)

op-rs · Jun 21, 2024 · 5655e48 · 5655e48
1 parent 5acf0fe
commit 5655e48
Show file tree

Hide file tree

Showing 32 changed files with 33 additions and 36 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [workspace]
-members = ["crates/*", "bin/host", "bin/programs/*", "examples/*"]
-default-members = ["bin/host", "bin/programs/*"]
+members = ["crates/*", "bin/host", "bin/client", "examples/*"]
+default-members = ["bin/host", "bin/client"]
 exclude = ["fpvm-tests/cannon-rs-tests"]
 resolver = "2"
 

diff --git a/README.md b/README.md
@@ -37,7 +37,7 @@ rollup state transition in order to verify an [L2 output root][g-output-root] fr
 
 **`kona`**
 
-- [`client`](./bin/programs/client): The bare-metal program that runs on top of a [fault proof VM][g-fault-proof-vm].
+- [`client`](./bin/client): The bare-metal program that runs on top of a [fault proof VM][g-fault-proof-vm].
 - [`host`](./bin/host): The host program that runs natively alongside the FPVM, serving as the [Preimage Oracle][g-preimage-oracle] server.
 
 **Build Pipelines**

diff --git a/bin/programs/client/Cargo.toml → bin/client/Cargo.toml b/bin/programs/client/Cargo.toml → bin/client/Cargo.toml
@@ -22,13 +22,13 @@ async-trait.workspace = true
 tracing.workspace = true
 
 # local
-kona-common = { path = "../../../crates/common", version = "0.0.1" }
-kona-common-proc = { path = "../../../crates/common-proc", version = "0.0.1" }
-kona-preimage = { path = "../../../crates/preimage", version = "0.0.1" }
-kona-primitives = { path = "../../../crates/primitives", version = "0.0.1" }
-kona-mpt = { path = "../../../crates/mpt", version = "0.0.1" }
-kona-derive = { path = "../../../crates/derive", default-features = false, version = "0.0.1" }
-kona-executor = { path = "../../../crates/executor", version = "0.0.1" }
+kona-common = { path = "../../crates/common", version = "0.0.1" }
+kona-common-proc = { path = "../../crates/common-proc", version = "0.0.1" }
+kona-preimage = { path = "../../crates/preimage", version = "0.0.1" }
+kona-primitives = { path = "../../crates/primitives", version = "0.0.1" }
+kona-mpt = { path = "../../crates/mpt", version = "0.0.1" }
+kona-derive = { path = "../../crates/derive", default-features = false, version = "0.0.1" }
+kona-executor = { path = "../../crates/executor", version = "0.0.1" }
 
 tracing-subscriber = { version = "0.3.18", optional = true }
 

diff --git a/bin/programs/client/README.md → bin/client/README.md b/bin/programs/client/README.md → bin/client/README.md
diff --git a/bin/programs/client/justfile → bin/client/justfile b/bin/programs/client/justfile → bin/client/justfile
diff --git a/bin/programs/client/src/boot.rs → bin/client/src/boot.rs b/bin/programs/client/src/boot.rs → bin/client/src/boot.rs
diff --git a/...ograms/client/src/comms/caching_oracle.rs → bin/client/src/comms/caching_oracle.rs b/...ograms/client/src/comms/caching_oracle.rs → bin/client/src/comms/caching_oracle.rs
diff --git a/bin/programs/client/src/comms/mod.rs → bin/client/src/comms/mod.rs b/bin/programs/client/src/comms/mod.rs → bin/client/src/comms/mod.rs
diff --git a/bin/programs/client/src/hint.rs → bin/client/src/hint.rs b/bin/programs/client/src/hint.rs → bin/client/src/hint.rs
diff --git a/bin/programs/client/src/kona.rs → bin/client/src/kona.rs b/bin/programs/client/src/kona.rs → bin/client/src/kona.rs
diff --git a/bin/programs/client/src/l1/blob_provider.rs → bin/client/src/l1/blob_provider.rs b/bin/programs/client/src/l1/blob_provider.rs → bin/client/src/l1/blob_provider.rs
diff --git a/bin/programs/client/src/l1/chain_provider.rs → bin/client/src/l1/chain_provider.rs b/bin/programs/client/src/l1/chain_provider.rs → bin/client/src/l1/chain_provider.rs
diff --git a/bin/programs/client/src/l1/driver.rs → bin/client/src/l1/driver.rs b/bin/programs/client/src/l1/driver.rs → bin/client/src/l1/driver.rs
diff --git a/bin/programs/client/src/l1/mod.rs → bin/client/src/l1/mod.rs b/bin/programs/client/src/l1/mod.rs → bin/client/src/l1/mod.rs
diff --git a/bin/programs/client/src/l2/chain_provider.rs → bin/client/src/l2/chain_provider.rs b/bin/programs/client/src/l2/chain_provider.rs → bin/client/src/l2/chain_provider.rs
diff --git a/bin/programs/client/src/l2/mod.rs → bin/client/src/l2/mod.rs b/bin/programs/client/src/l2/mod.rs → bin/client/src/l2/mod.rs
diff --git a/bin/programs/client/src/l2/trie_hinter.rs → bin/client/src/l2/trie_hinter.rs b/bin/programs/client/src/l2/trie_hinter.rs → bin/client/src/l2/trie_hinter.rs
diff --git a/bin/programs/client/src/lib.rs → bin/client/src/lib.rs b/bin/programs/client/src/lib.rs → bin/client/src/lib.rs
diff --git a/bin/host/Cargo.toml b/bin/host/Cargo.toml
@@ -18,7 +18,7 @@ alloy-consensus.workspace = true
 alloy-rlp.workspace = true
 
 # local
-kona-client = { path = "../programs/client", version = "0.1.0" }
+kona-client = { path = "../client", version = "0.1.0" }
 kona-common = { path = "../../crates/common", version = "0.0.1" }
 kona-preimage = { path = "../../crates/preimage", version = "0.0.1" }
 kona-mpt = { path = "../../crates/mpt", version = "0.0.1" }

diff --git a/bin/programs/README.md b/bin/programs/README.md
diff --git a/bin/programs/minimal/Cargo.lock → examples/minimal/Cargo.lock b/bin/programs/minimal/Cargo.lock → examples/minimal/Cargo.lock
diff --git a/bin/programs/minimal/Cargo.toml → examples/minimal/Cargo.toml b/bin/programs/minimal/Cargo.toml → examples/minimal/Cargo.toml
@@ -11,8 +11,8 @@ homepage.workspace = true
 [dependencies]
 cfg-if.workspace = true
 anyhow.workspace = true
-kona-common = { path = "../../../crates/common" }
-kona-common-proc = { path = "../../../crates/common-proc" }
+kona-common = { path = "../../crates/common" }
+kona-common-proc = { path = "../../crates/common-proc" }
 
 [[bin]]
 name = "minimal"

diff --git a/bin/programs/minimal/README.md → examples/minimal/README.md b/bin/programs/minimal/README.md → examples/minimal/README.md
diff --git a/bin/programs/minimal/justfile → examples/minimal/justfile b/bin/programs/minimal/justfile → examples/minimal/justfile
@@ -5,15 +5,15 @@ build-cannon *args='':
   docker run \
     --rm \
     --platform linux/amd64 \
-    -v `pwd`/../../../:/workdir \
-    -w="/workdir/bin/programs/minimal" \
+    -v `pwd`/../../:/workdir \
+    -w="/workdir/examples/minimal" \
     ghcr.io/ethereum-optimism/kona/cannon-builder:main cargo build -Zbuild-std --bin minimal $@
 
 # Build for the `asterisc` target
 build-asterisc *args='':
   docker run \
     --rm \
     --platform linux/amd64 \
-    -v `pwd`/../../../:/workdir \
-    -w="/workdir/bin/programs/minimal" \
+    -v `pwd`/../../:/workdir \
+    -w="/workdir/examples/minimal" \
     ghcr.io/ethereum-optimism/kona/asterisc-builder:main cargo build -Zbuild-std --bin minimal $@
diff --git a/bin/programs/minimal/src/main.rs → examples/minimal/src/main.rs b/bin/programs/minimal/src/main.rs → examples/minimal/src/main.rs
diff --git a/bin/programs/simple-revm/Cargo.lock → examples/simple-revm/Cargo.lock b/bin/programs/simple-revm/Cargo.lock → examples/simple-revm/Cargo.lock
diff --git a/bin/programs/simple-revm/Cargo.toml → examples/simple-revm/Cargo.toml b/bin/programs/simple-revm/Cargo.toml → examples/simple-revm/Cargo.toml
@@ -13,9 +13,9 @@ anyhow.workspace = true
 revm.workspace = true
 cfg-if.workspace = true
 
-kona-common = { path = "../../../crates/common" }
-kona-common-proc = { path = "../../../crates/common-proc" }
-kona-preimage = { path = "../../../crates/preimage" }
+kona-common = { path = "../../crates/common" }
+kona-common-proc = { path = "../../crates/common-proc" }
+kona-preimage = { path = "../../crates/preimage" }
 
 [[bin]]
 name = "simple-revm"

diff --git a/bin/programs/simple-revm/README.md → examples/simple-revm/README.md b/bin/programs/simple-revm/README.md → examples/simple-revm/README.md
diff --git a/bin/programs/simple-revm/justfile → examples/simple-revm/justfile b/bin/programs/simple-revm/justfile → examples/simple-revm/justfile
@@ -5,15 +5,15 @@ build-cannon *args='':
   docker run \
     --rm \
     --platform linux/amd64 \
-    -v `pwd`/../../../:/workdir \
-    -w="/workdir/bin/programs/simple-revm" \
+    -v `pwd`/../../:/workdir \
+    -w="/workdir/examples/simple-revm" \
     ghcr.io/ethereum-optimism/kona/cannon-builder:main cargo build -Zbuild-std --bin simple-revm $@
 
 # Build for the `asterisc` target
 build-asterisc *args='':
   docker run \
     --rm \
     --platform linux/amd64 \
-    -v `pwd`/../../../:/workdir \
-    -w="/workdir/bin/programs/simple-revm" \
+    -v `pwd`/../../:/workdir \
+    -w="/workdir/examples/simple-revm" \
     ghcr.io/ethereum-optimism/kona/asterisc-builder:main cargo build -Zbuild-std --bin simple-revm $@
diff --git a/bin/programs/simple-revm/src/main.rs → examples/simple-revm/src/main.rs b/bin/programs/simple-revm/src/main.rs → examples/simple-revm/src/main.rs
diff --git a/fpvm-tests/justfile b/fpvm-tests/justfile
@@ -9,13 +9,13 @@ test: build-cannon-examples build-asterisc-examples test-cannon test-asterisc
 
 # Build cannon programs
 build-cannon-examples:
-  @cd ../bin/programs/minimal && just build-cannon --profile release-client-lto
-  @cd ../bin/programs/simple-revm && just build-cannon --profile release-client-lto
+  @cd ../examples/minimal && just build-cannon --profile release-client-lto
+  @cd ../examples/simple-revm && just build-cannon --profile release-client-lto
 
 # Build asterisc programs
 build-asterisc-examples:
-  @cd ../bin/programs/minimal && just build-asterisc --profile release-client-lto
-  @cd ../bin/programs/simple-revm && just build-asterisc --profile release-client-lto
+  @cd ../examples/minimal && just build-asterisc --profile release-client-lto
+  @cd ../examples/simple-revm && just build-asterisc --profile release-client-lto
 
 # Test programs on `cannon`
 test-cannon: test-cannon-go test-cannon-rs