feat: add a tool to extract bundle into a file (#223)

Co-authored-by: Raúl Kripalani <[email protected]>

Author: Stebalien

.github/workflows/ci.yml

@@ -66,10 +66,11 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
         command: version
-    - name: Making bundle
+    - name: Writing bundle
       env:
         BUILD_FIL_NETWORK: ${{ matrix.network }}
-      run: ./build-bundle.sh
+      run: |
+        cargo run -- -o output/builtin-actors.car
     - name: Uploading bundle to Estuary
       env:
         ESTUARY_TOKEN: ${{ secrets.ESTUARY_TOKEN }}

Cargo.lock

@@ -27,6 +27,9 @@ fil_actors_runtime = { version = "8.0.0-alpha.1", path = "./actors/runtime", fea
 fil_actor_bundler = "3.0.0"
 cid = { version = "0.8.3", default-features = false, features = ["serde-codec"] }
 
+[dependencies]
+clap = { version = "3.1.8", features = ["derive"] }
+
 [features]
 default = [] ## translates to mainnet
 mainnet = []

Cargo.toml

@@ -52,7 +52,7 @@ publish:
 
 # Create a bundle in a deterministic location
 bundle: deps-build
-	./build-bundle.sh
+	cargo run -- -o output/builtin-actors.car
 
 # Check if the working tree is clean.
 check-clean:

Makefile

@@ -149,13 +149,9 @@ Instructions to build from source (option 1):
 
 1. Clone the repo.
 2. Check out the relevant branch or tag (see Versioning section below).
-3. `cargo build` from the workspace root.
-4. Copy the CARv1 file generated the location printed in this log line:
-    ```
-   warning: bundle=/path/to/repo/target/debug/build/filecoin_canonical_actors_bundle-aef13b28a60e195b/out/bundle/bundle.car
-   ```
-   All output is printed as a warning only due to limitations in the Cargo build
-   script mechanisms.
+3. `make bundle` from the workspace root.
+
+The bundle be written to `output/builtin-actors.car`.
 
 Both options are compatible with automation via scripts or CI pipelines.
 

README.md

@@ -0,0 +1,22 @@
+use clap::Parser;
+use std::io::Write;
+
+use fil_builtin_actors_bundle::BUNDLE_CAR;
+
+#[derive(Parser)]
+#[clap(name = env!("CARGO_PKG_NAME"))]
+#[clap(version = env!("CARGO_PKG_VERSION"))]
+#[clap(about = "Writes a CAR file containing Wasm bytecode for Filecoin actors.", long_about = None)]
+struct Cli {
+    /// The output car path. Defaults to STDOUT.
+    #[clap(short, long, required = false)]
+    output: Option<String>,
+}
+
+fn main() -> Result<(), std::io::Error> {
+    let cli = Cli::parse();
+    match cli.output {
+        Some(path) => std::fs::write(path, BUNDLE_CAR),
+        None => std::io::stdout().write_all(BUNDLE_CAR),
+    }
+}