bindings -> contract-bindings

drahnr · drahnr · commit 860bf6f94e84 · 2025-02-10T08:49:55.000+01:00
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -52,11 +52,11 @@ jobs:
           path: |
             ./contracts/out
             ./contracts/cache
-            ./crates/bindings
+            ./crates/contract-bindings
           ## TODO maybe add the rust version and solc version to the key
           key: v2-contracts-abi-${{ hashFiles('./contracts/**/*.sol') }}
 
-      - name: Generate ABI and bindings
+      - name: Generate ABI and contract-bindings
         run: cd contracts && make gen
 
       - name: Install Rust nightly
diff --git a/.github/workflows/contracts-test.yaml b/.github/workflows/contracts-test.yaml
@@ -26,7 +26,7 @@ jobs:
           path: |
             ./contracts/out
             ./contracts/cache
-            ./crates/bindings
+            ./crates/contract-bindings
           key: v2-contracts-abi-${{ hashFiles('./contracts/**/*.sol') }}
 
       - name: Run tests
diff --git a/.github/workflows/tests-e2e.yaml b/.github/workflows/tests-e2e.yaml
@@ -41,7 +41,7 @@ jobs:
           path: |
             ./contracts/out
             ./contracts/cache
-            ./crates/bindings
+            ./crates/contract-bindings
           key: v2-contracts-abi-${{ hashFiles('./contracts/**/*.sol') }}
 
       - uses: Swatinem/rust-cache@v2
diff --git a/.github/workflows/tests-unit.yaml b/.github/workflows/tests-unit.yaml
@@ -30,7 +30,7 @@ jobs:
           path: | 
             ./contracts/out
             ./contracts/cache
-            ./crates/bindings
+            ./crates/contract-bindings
           key: v2-contracts-abi-${{ hashFiles('./contracts/**/*.sol') }}
 
       - uses: Swatinem/rust-cache@v2
diff --git a/contracts/.gitattributes b/contracts/.gitattributes
@@ -1,2 +1,2 @@
 out/* linguist-generated=true
-bindings/* linguist-generated=true
+contract-bindings/* linguist-generated=true
diff --git a/contracts/.gitignore b/contracts/.gitignore
@@ -21,7 +21,7 @@ deployments.json
 scripts/*.out
 scripts/deploy-registry.ts
 scripts/deploy-gateway.ts
-bindings/target
+contract-bindings/target
 subnet.registry.json
 subnet.actor.json
 
diff --git a/contracts/Makefile b/contracts/Makefile
@@ -49,7 +49,7 @@ compile-abi: node_modules | forge
 	./ops/compile-abi.sh $(OUTPUT)
 
 rust-binding:
-	OUTPUT=$(OUTPUT) cargo build --locked --release --manifest-path ../crates/bindings/Cargo.toml -p ipc_actors_abis
+	OUTPUT=$(OUTPUT) cargo build --locked --release --manifest-path ../crates/contract-bindings/Cargo.toml -p ipc_actors_abis
 
 # ==============================================================================
 # Running security checks within the local computer
diff --git a/contracts/README.md b/contracts/README.md
@@ -168,7 +168,7 @@ Also:
 
 1. Use `make storage` to check that the storage layout has not been corrupted.
 2. Use `make coverage` to get the test coverage report.
-3. Use `make rust-binding` to generate bindings in Rust.
+3. Use `make rust-binding` to generate contract-bindings in Rust.
 
 # Vulnerability Management
 
diff --git a/crates/Cargo.toml b/crates/Cargo.toml
@@ -1,8 +1,7 @@
 [workspace]
 resolver = "2"
 members = [
-  # contracts bindings
-  "bindings",
+  "contract-bindings",
 
   # merkle
   "patched_external/merkle-tree-rs",
@@ -183,7 +182,7 @@ ipc-wallet = { path = "ipc/wallet", features = ["with-ethers"] }
 ipc_ipld_resolver = { path = "ipld/resolver" }
 ipc-types = { path = "ipc/types" }
 ipc-observability = { path = "ipc/observability" }
-ipc_actors_abis = { path = "bindings" }
+ipc_actors_abis = { path = "contract-bindings" }
 fendermint_actors_api = { path = "client/actors/api" }
 
 # Vendored for cross-compilation, see https://github.com/cross-rs/cross/wiki/Recipes#openssl
@@ -194,7 +193,7 @@ openssl = { version = "0.10", features = ["vendored"] }
 
 # NOTE: When upgrading the FVM it may cause our client/actors/build.rs to fail as it can
 # pull in crates as transitive dependencies that do not support Wasm architector. If this
-# happens, try removing "crypto" feature from fvm_shared dependency in contracts/bindings/Cargo.toml
+# happens, try removing "crypto" feature from fvm_shared dependency in contracts/contract-bindings/Cargo.toml
 # and run `cargo build`. Then add the "crypto" feature back and run `cargo build` again.
 fvm = { version = "4.4.0", features = [
   "verify-signature",
diff --git a/crates/client/README.md b/crates/client/README.md
@@ -36,15 +36,15 @@ make e2e
 
 ## IPC Solidity Actors
 
-We generate Rust bindings for the Solidity actors we need to invoke from the [contracts](../contracts/) folder, some of which are deployed during the genesis process. The bindings live in [contracts/bindings/](../contracts/binding), and are generated automatically during the build, or with the following command:
+We generate Rust contract-bindings for the Solidity actors we need to invoke from the [contracts](../contracts/) folder, some of which are deployed during the genesis process. The contract-bindings live in [contracts/contract-bindings/](../contracts/binding), and are generated automatically during the build, or with the following command:
 
 ```bash
 make gen
 ```
 
 To run it, you will have to install [forge](https://book.getfoundry.sh/getting-started/installation).
 
-The list of contracts for which we generate Rust bindings are in [build.rs](../contracts/bindings/build.rs) and needs to be maintained by hand, for example if a new "diamond facet" is added to a contract, it has to be added here. Diamond facets also have to be added manually in [ipc.rs](./vm/actor_interface/src/ipc.rs) where the contracts which need to be deployed during genesis are described. These facets cannot be divined from the ABI description, so they have to be maintained explicitly.
+The list of contracts for which we generate Rust contract-bindings are in [build.rs](../contracts/contract-bindings/build.rs) and needs to be maintained by hand, for example if a new "diamond facet" is added to a contract, it has to be added here. Diamond facets also have to be added manually in [ipc.rs](./vm/actor_interface/src/ipc.rs) where the contracts which need to be deployed during genesis are described. These facets cannot be divined from the ABI description, so they have to be maintained explicitly.
 
 To test whether the genesis process works, we can run the following unit test:
 
diff --git a/crates/client/docker/README.md b/crates/client/docker/README.md
@@ -13,7 +13,7 @@ The image contains both the `fendermint` and `ipc-cli` executables (dispatched b
 As a pre-requisite this will ensure that the following artifacts are prepared:
 * The builtin-actors bundle is downloaded from GitHub; if you upgrade the version of these, make sure you clear out any existing artifacts or you might get interface version conflicts at runtime when the bundles are loaded.
 * The custom actor bundle is built; this prepares some JSON artifacts as well, which are needed for deployment.
-* The IPC actor bindings are generated; this is refreshed every time a Solidity artifact changes.
+* The IPC actor contract-bindings are generated; this is refreshed every time a Solidity artifact changes.
 
 The actor bundles are CAR files which are copied into the `fendermint` image, so that we don't have to procure them separately when we want to create a container.
 
diff --git a/crates/client/testing/contract-test/tests/run_upgrades.rs b/crates/client/testing/contract-test/tests/run_upgrades.rs
@@ -52,7 +52,7 @@ async fn test_applying_upgrades() {
 
     // this is the contract we want to deploy
     const CONTRACT_HEX: &str = include_str!("../../contracts/SimpleCoin.bin");
-    // generate type safe bindings in rust to this contract
+    // generate type safe contract-bindings in rust to this contract
     abigen!(SimpleCoin, "../contracts/SimpleCoin.abi");
     // once we deploy this contract, this is the address we expect the contract to be deployed to
     const CONTRACT_ADDRESS: &str = "f410fnz5jdky3zzcj6pejqkomkggw72pcuvkpihz2rwa";
diff --git a/crates/client/testing/materializer/Cargo.toml b/crates/client/testing/materializer/Cargo.toml
@@ -36,7 +36,7 @@ quickcheck = { workspace = true, optional = true }
 
 ipc-api = { path = "../../../ipc/api" }
 ipc-provider = { path = "../../../ipc/provider" }
-ipc_actors_abis = { path = "../../../bindings" }
+ipc_actors_abis = { path = "../../../contract-bindings" }
 
 fendermint_crypto = { path = "../../crypto" }
 fendermint_vm_actor_interface = { path = "../../vm/actor_interface" }
diff --git a/crates/client/vm/actor_interface/src/ipc.rs b/crates/client/vm/actor_interface/src/ipc.rs
@@ -1,7 +1,7 @@
 // Copyright 2022-2024 Protocol Labs
 // SPDX-License-Identifier: Apache-2.0, MIT
 
-// The IPC actors have bindings in `ipc_actors_abis`.
+// The IPC actors have contract-bindings in `ipc_actors_abis`.
 // Here we define stable IDs for them, so we can deploy the
 // Solidity contracts during genesis.
 
diff --git a/crates/contract-bindings/.gitignore b/crates/contract-bindings/.gitignore
diff --git a/crates/contract-bindings/Cargo.toml b/crates/contract-bindings/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "ipc_actors_abis"
-description = "Rust bindings for the IPC Solidity Actors"
+description = "Rust contract-bindings for the IPC Solidity Actors"
 version = "0.1.0"
 authors = ["Protocol Labs"]
 edition = "2021"
diff --git a/crates/contract-bindings/build.rs b/crates/contract-bindings/build.rs
@@ -5,7 +5,7 @@ use std::io::Write;
 use std::path::PathBuf;
 
 const SKIP_ENV_VAR_NAME: &str = "SKIP_BINDING_GENERATION";
-/// Generate Rust bindings from the IPC Solidity Actors ABI artifacts.
+/// Generate Rust contract-bindings from the IPC Solidity Actors ABI artifacts.
 ///p
 /// These are built by `make ipc-actors-abi`, here we just add the final step
 /// so we have better code completion with Rust Analyzer.
@@ -65,9 +65,9 @@ fn main() -> color_eyre::Result<()> {
     )?;
     writeln!(mod_f)?;
 
-    // The list of actors we need bindings for, based on how the ipc-actor uses `abigen!`.
+    // The list of actors we need contract-bindings for, based on how the ipc-actor uses `abigen!`.
     // With the diamond pattern, there is a contract that holds state, and there are these facets which have the code,
-    // so we need bindings for the facets, but well (I think) use the same address with all of them.
+    // so we need contract-bindings for the facets, but well (I think) use the same address with all of them.
     for contract_name in [
         "IDiamond",
         "DiamondLoupeFacet",
diff --git a/crates/contract-bindings/src/convert.rs b/crates/contract-bindings/src/convert.rs
diff --git a/crates/contract-bindings/src/lib.rs b/crates/contract-bindings/src/lib.rs
diff --git a/rustfmt.toml b/rustfmt.toml
@@ -1,4 +1,4 @@
 edition = "2021"
 
 # Ignore auto-generated files.
-ignore = ["crates/bindings/src"]
+ignore = ["crates/contract-bindings/src"]
diff --git a/scripts/add_license.sh b/scripts/add_license.sh
@@ -13,7 +13,7 @@ LINES=4
 
 # Ignore auto-generated code.
 IGNORE=(
-	"crates/bindings" "crates/patched_external"
+	"crates/contract-bindings" "crates/patched_external"
 );
 
 ignore() {

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`out/* linguist-generated=true`
`2`		`-bindings/* linguist-generated=true`
	`2`	`+contract-bindings/* linguist-generated=true`