Add interface for CrosschainDeployAdapter

.env.example

@@ -0,0 +1,3 @@
+# copy this to a `.env` file and set these values.
+INTEGRATION_FORK_URL=
+INTEGRATION_PRIVATE_KEY=

.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: test
+
+on: workflow_dispatch
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  check:
+    strategy:
+      fail-fast: true
+
+    name: Foundry project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Run Forge build
+        run: |
+          forge --version
+          forge build --sizes
+        id: build
+
+      - name: Run Forge tests
+        run: |
+          forge test -vvv
+        id: test

.gitignore

@@ -12,3 +12,12 @@ Cargo.lock
 
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
+
+# editor specifics
+.vscode/
+
+# foundry-specific
+out/
+cache/
+
+.env

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std

README.md

@@ -1 +1,83 @@
-# foundry-multichain-deploy
+# foundry-multichain-deploy
+
+> **Warning**
+>
+> Only testnet multichain deployment is available. Mainnet deployment will be enabled soon!
+
+Provides `foundry` tooling for the multichain deployment contract built atop Sygma. See
+[ChainSafe/hardhat-plugin-multichain-deploy]("https://github.com/ChainSafe/hardhat-plugin-multichain-deploy")
+for the Hardhat plugin version.
+
+## Installation
+
+Run `forge install chainsafe/foundry-multichain-deploy` to install this plugin to your own foundry project. You might need to use `--no-commit` so as to properly configure your git working directory and commit the dependency yourself. For further instructions, check [the official documentation.](https://book.getfoundry.sh/projects/dependencies)
+
+## Usage
+
+The `CrosschainDeployScript` contract is a foundry "script", which means that it
+is not really deployed onto the blockchain. It provides a few helper methods
+that make it easier to deal with the `CrosschainDeployAdapter` from the hardhat
+repository.
+
+To use it, first import the `CrosschainDeployScript` and inherit from it.
+
+```solidity
+// SPDX-License-Identifier: LGPL-3.0-only
+pragma solidity 0.8.20
+import {CrosschainDeployScript} from "foundry-multichain-deploy/src/CrosschainDeployScript.sol";
+
+contract SampleDeployScript is CrosschainDeployScript {
+
+    function run {
+        // Remember that forge "builds" the contracts and stores them and their
+        // ABI in the root level of the `out` folder so you'd just need to use the contract
+        // file name and the contract name and forge gets it from the ABI.
+        bytes memory constructorArgs = abi.encode(uint256("10"));
+        bytes memory initData = abi.encode("add(uint256)", uint256(10));
+        addDeploymentTarget("sepolia", constructorArgs, initData);
+        addDeploymentTarget("holesky", constructorArgs, initData);
+        deploy{value: msg.value}("SimpleContract.sol:SimpleContract", 50000, false);
+    }
+}
+```
+
+Now, you can run this with `forge script script/SampleDeployScript.sol:SampleDeployScript --rpc-url $CHAIN_RPC_URL --broadcast -vvv --verify`.
+
+This script is not deployed, but it instead constructs the calls to the upstream
+contract and broadcasts them (thanks to the `--broadcast` flag).
+
+A good example of how to use this project is demonstrated in the
+[`test/unit/CrosschainDeployScript.t.sol`](test/unit/CrosschainDeployScriptTest.t.sol)
+file.
+
+### Encoding Arguments
+
+The `constructorArgs` and `initData` arguments use the encoded format for the
+values that get passed to the adapter for deployment. Notice how in the example
+above, these are encoded using `encode` and `encodePacked`.
+
+The `SimpleContract` example has a constructor that takes a `uint256` value. So
+it requires a value to be passed as `constructorArgs`.  We use `bytes memory
+constructorArgs = abi.encode(uint256(10));` to do so.
+
+If a contract constructor doesn't have any input arguments, you can just use
+`bytes memory constructorArgs = '';` for that particular constructor.
+
+Now, the `add` function of the `SimpleContract` takes a `uint256` argument as
+well, but to pass this to `initDatas`, you need to pass the function signature
+as well. So you'd have to use `bytes memory initData =
+abi.encodeWithSignature("add(uint256)", uint256(10));`. If you're calling a
+function like `inc()` which takes no arguments, just say `bytes memory initData
+= abi.encodeWithSignature("inc()");` instead.
+
+To learn more, check out the ways you can use `abi.encode` and
+`abi.encodeWithSignature` in the foundry book.
+
+
+## Development
+
+[Install foundry](https://book.getfoundry.sh/getting-started/installation) and [`just`](https://github.com/casey/just).
+
+Check the `justfile` for more instructions on how to run this project. Run `just --list` to see all the options.
+
+Note that all integration tests *should* have `Integration` in the test function name for them to work, unless you'd like to use `--match-test` specifically for those tests. However, to keep things simple, it's best to follow this practice.

foundry.toml

@@ -0,0 +1,6 @@
+[profile.default]
+src = "src"
+out = "out"
+libs = ["lib"]
+
+# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options

justfile

@@ -0,0 +1,40 @@
+set shell:=["bash", "-uc"]
+set dotenv-load
+
+# build the contracts
+build:
+    forge build
+
+# format source
+fmt:
+    forge fmt
+
+# run unit tests
+test:
+    forge test --no-match-test Integration
+
+# run integration tests, needs --fork-url
+integration-test:
+    set -x
+    forge test --mt Integration --fork-url $INTEGRATION_FORK_URL -vvv
+
+# watches the directory for changes and rebuilds.
+watch-build:
+    forge build --watch
+
+deploy-anvil: build
+    echo "Unimplemented" >&2
+    exit 1
+
+deploy-sepolia: build
+    echo "Unimplemented" >&2
+    exit 1
+
+# Builds locally using docker (useful for debugging dependency issues)
+docker-build:
+    echo "Unimplemented" >&2
+    exit 1
+
+docker-test: docker-build
+    echo "Unimplemented" >&2
+    exit 1