Add interface for CrosschainDeployAdapter

.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,6 @@ Cargo.lock
 
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
+
+# editor specifics
+.vscode/

.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,9 @@
-# foundry-multichain-deploy
+# foundry-multichain-deploy
+
+Provides `foundry` tooling for the multichain deployment contract built atop of Sygma. See [ChainSafe/hardhat-plugin-multichain-deploy]("https://github.com/ChainSafe/hardhat-plugin-multichain-deploy") for more details.
+
+## 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.

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,33 @@
+set shell:=["bash", "-uc"]
+
+
+# build the contracts
+build:
+    forge build
+
+# format source
+fmt:
+    forge fmt
+
+
+# watches the directory for changes and rebuilds. Needs `watchexec` - https://github.com/watchexec/watchexec. This is useful when developing contracts.
+watch-build:
+    watchexec just fmt build
+
+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

src/CrosschainDeployScript.sol

@@ -0,0 +1,54 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+
+pragma solidity 0.8.20;
+
+import {Script} from "forge-std/Script.sol";
+import {ICrosschainDeployAdapter} from "./interfaces/CrosschainDeployAdapterInterface.sol";
+
+/**
+ * @title Provides a script to allow users to call the multichain deployment contract defined in `CrossChainDeployAdapter` from chainsafe/hardhat-plugin-multichain-deploy, passing it the contract bytecode and constructor arguments.
+ * @author ChainSafe Systems
+ */
+contract CrosschainDeployScript is Script {
+    // this is the address of the original contract defined in chainsafe/hardhat-plugin-multichain-deploy
+    // this address is the same across all chains
+    address private constant CROSS_CHAIN_DEPLOY_CONTRACT_ADDRESS = 0x85d62AD850B322152BF4ad9147bfBF097DA42217;
+
+    /**
+     * @notice this function takes in the contract string, in the form that
+     * @notice `forge`'s `getCode` takes it, along with some other parameters and passes
+     * @notice it along to the `deploy` function of the `CrossChainDeployAdapter`
+     * @notice contract.
+     * @param contractString Contract name in the form of `ContractFile.sol`, if the name of the contract and the file are the same, or `ContractFile.sol:ContractName` if they are different.
+     * @param gasLimit Contract deploy and init gas.
+     * @param salt Entropy for contract address generation.
+     * @param isUniquePerChain True to have unique addresses on every chain.
+     * @param constructorArgs Bytes to add to the deployBytecode, or empty, one per chain.
+     * @param initDatas Bytes to send to the contract after deployment, or empty, one per chain.
+     * @param destinationDomainIDs Sygma Domain IDs of target chains.
+     *
+     *   Users call this function and pass only the function call string as
+     *   `MyContract.sol:MyContract`. The function call string is then parsed
+     *   and the `callData` and `bytesCode` are extracted from it.
+     *   and the contract is deployed on the other chains.
+     */
+    function deployContractOnOtherChains(
+        string calldata contractString,
+        uint256 gasLimit,
+        bytes32 salt,
+        bool isUniquePerChain,
+        bytes[] memory constructorArgs,
+        bytes[] memory initDatas,
+        uint8[] memory destinationDomainIDs
+    ) public payable {
+        // We use the contractString to get the bytecode of the contract,
+        // reference: https://book.getfoundry.sh/cheatcodes/get-code
+        bytes memory deployByteCode = vm.getCode(contractString);
+        uint256[] memory fees = ICrosschainDeployAdapter(CROSS_CHAIN_DEPLOY_CONTRACT_ADDRESS).calculateDeployFee(
+            deployByteCode, gasLimit, salt, isUniquePerChain, constructorArgs, initDatas, destinationDomainIDs
+        );
+        ICrosschainDeployAdapter(CROSS_CHAIN_DEPLOY_CONTRACT_ADDRESS).deploy(
+            deployByteCode, gasLimit, salt, isUniquePerChain, constructorArgs, initDatas, destinationDomainIDs, fees
+        );
+    }
+}

src/interfaces/CrosschainDeployAdapterInterface.sol

@@ -0,0 +1,36 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+
+pragma solidity 0.8.20;
+
+/**
+ * @title Provides an interface to the CrosschainDeployAdapter from chainsafe/hardhat-plugin-multichain-deploy
+ * @author ChainSafe Systems.
+ * @notice The original contract in question is intended to be used with the Bridge contract and Permissionless Generic Handler
+ */
+interface ICrosschainDeployAdapter {
+    function deploy(
+        bytes calldata deployBytecode,
+        uint256 gasLimit,
+        bytes32 salt,
+        bool isUniquePerChain,
+        bytes[] memory constructorArgs,
+        bytes[] memory initDatas,
+        uint8[] memory destinationDomainIDs,
+        uint256[] memory fees
+    ) external payable;
+
+    function computeContractAddressForChain(address sender, bytes32 salt, bool isUniquePerChain)
+        external
+        view
+        returns (address);
+
+    function calculateDeployFee(
+        bytes calldata deployBytecode,
+        uint256 gasLimit,
+        bytes32 salt,
+        bool isUniquePerChain,
+        bytes[] memory constructorArgs,
+        bytes[] memory initDatas,
+        uint8[] memory destinationDomainIds
+    ) external view returns (uint256[] memory fees);
+}