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,81 @@
-# 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 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));
+        setCrosschainDeployContractAddress(crosschainDeployAdapterAddress);
+        addDeploymentTarget("sepolia", constructorArgs, initData);
+        deploy{value: msg.value}(50000, false);
+    }
+}
+```
+
+Now, you can run this with `forge script script/SampleDeployScript.sol:SampleDeployScript SimpleContract.sol:SimpleContract --rpc-url $CHAIN_RPC_URL --broadcast -vvv --verify`.
+**Note** that the contract you'd like to deploy, `SimpleContract.sol` is provided as an argument to `forge script` because it is then passed to the `constructor` of `CrosschainDeployScript` this way.
+
+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 --via-ir
+
+# format source
+fmt:
+    forge fmt
+
+# run unit tests
+test:
+    forge test --via-ir --no-match-test Integration
+
+# run integration tests, needs --fork-url
+integration-test:
+    set -x
+    forge test --via-ir --mt Integration --fork-url $INTEGRATION_FORK_URL -vvv
+
+# watches the directory for changes and rebuilds.
+watch-build:
+    forge build --via-ir --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

src/CrosschainDeployScript.sol

@@ -0,0 +1,200 @@
+// 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 string for the contract name,
+    string public contractString;
+    // 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 crosschainDeployContractAddress = 0x85d62AD850B322152BF4ad9147bfBF097DA42217;
+
+    struct NetworkIds {
+        uint8 InternalDomainId;
+        uint256 ChainId;
+    }
+
+    // given a string, obtain the domain ID;
+    // https://www.notion.so/chainsafe/Testnet-deployment-0483991cf1ac481593d37baf8d48712a
+    mapping(string => NetworkIds) private _stringToNetworkIds;
+
+    // NOTE: All three of these need to be stored in the same order since they've
+    //      a shared index. Storing them in a mapping isn't gas-efficient since I'd
+    //      have to loop over these to build these arrays later, and that would not
+    //      translate to a `bytes[] memory` object, which is what the contract method needs.
+    //      Explicit conversion is a waste of gas.
+    // store the domain IDs
+    uint8[] private _domainIds;
+    // store the constructor args.
+    bytes[] private _constructorArgs;
+    // store the init datas;
+    bytes[] private _initDatas;
+    // store the chain ids
+    uint256[] private _chainIds;
+
+    uint8 private _randomCounter;
+
+    // use this to store a static value for the salt, one that the user can override using `setSalt`. If set to _anything_ other than 0x00000000000000000000, this will be used as the salt.
+    bytes32 private _staticSalt = 0x00000000000000000000;
+
+    /**
+     * @notice Constructor, takes the contract name.
+     * @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.
+     */
+    constructor(string memory _contractString) {
+        contractString = _contractString;
+        _stringToNetworkIds["goerli"] = NetworkIds(1, 5);
+        _stringToNetworkIds["sepolia"] = NetworkIds(2, 11155111);
+        _stringToNetworkIds["cronos-testnet"] = NetworkIds(5, 338);
+        _stringToNetworkIds["holesky"] = NetworkIds(6, 17000);
+        _stringToNetworkIds["mumbai"] = NetworkIds(7, 80001);
+        _stringToNetworkIds["arbitrum-sepolia"] = NetworkIds(8, 421614);
+        _stringToNetworkIds["gnosis-chiado"] = NetworkIds(9, 10200);
+    }
+
+    function _convertDeploymentTargetToNetworkIds(string memory deploymentTarget)
+        private
+        view
+        returns (NetworkIds memory)
+    {
+        NetworkIds memory deploymentTargetNetworkIds = _stringToNetworkIds[deploymentTarget];
+        uint8 deploymentTargetDomainId = deploymentTargetNetworkIds.InternalDomainId;
+        require(deploymentTargetDomainId != 0, "Invalid deployment target");
+        return deploymentTargetNetworkIds;
+    }
+
+    /**
+     * This function will take the network, constructor args and initdata and
+     * save these to a mapping.
+     */
+    function addDeploymentTarget(string memory deploymentTarget, bytes memory constructorArgs, bytes memory initData)
+        public
+    {
+        NetworkIds memory networkIds = _convertDeploymentTargetToNetworkIds(deploymentTarget);
+        _domainIds.push(networkIds.InternalDomainId);
+        _chainIds.push(networkIds.ChainId);
+        _constructorArgs.push(constructorArgs);
+        _initDatas.push(initData);
+    }
+
+    /**
+     * @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 gasLimit Contract deploy and init gas.
+     * @param isUniquePerChain True to have unique addresses on every chain.
+     *   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 deploy(uint256 gasLimit, bool isUniquePerChain)
+        public
+        payable
+        hasDeploymentNetworks
+        returns (address[] memory)
+    {
+        // 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);
+        bytes32 salt;
+        if (_staticSalt == 0x00000000000000000000) {
+            salt = generateSalt();
+        } else {
+            salt = _staticSalt;
+        }
+
+        uint256[] memory fees = ICrosschainDeployAdapter(crosschainDeployContractAddress).calculateDeployFee(
+            deployByteCode, gasLimit, salt, isUniquePerChain, _constructorArgs, _initDatas, _domainIds
+        );
+        uint256 totalFee;
+        uint256 feesArrayLength = fees.length;
+        for (uint256 j = 0; j < feesArrayLength; j++) {
+            uint256 fee = fees[j];
+            totalFee += fee;
+        }
+        ICrosschainDeployAdapter(crosschainDeployContractAddress).deploy{value: totalFee}(
+            deployByteCode, gasLimit, salt, isUniquePerChain, _constructorArgs, _initDatas, _domainIds, fees
+        );
+        address[] memory contractAddresses = new address[](_chainIds.length);
+        for (uint256 k = 0; k < _chainIds.length; k++) {
+            address contractAddress = ICrosschainDeployAdapter(crosschainDeployContractAddress)
+                .computeContractAddressForChain(msg.sender, salt, isUniquePerChain, _chainIds[k]);
+            contractAddresses[k] = contractAddress;
+        }
+        resetDeploymentNetworks();
+        return contractAddresses;
+    }
+
+    // empties the deployment networks added so far. Note that this won't change the contract string.
+    function resetDeploymentNetworks() public {
+        // purge the deployment targets now.
+        delete _chainIds;
+        delete _constructorArgs;
+        delete _domainIds;
+        delete _initDatas;
+    }
+
+    // resets the static salt
+    function resetSalt() public {
+        _staticSalt = 0x00000000000000000000;
+    }
+
+    // sets the static salt
+    function setSalt(bytes32 salt) public {
+        _staticSalt = salt;
+    }
+
+    // returns a pseudorandom bytes32 for salt *if* _staticSalt is not set.
+    function generateSalt() public returns (bytes32) {
+        require(
+            _staticSalt == 0x00000000000000000000,
+            "Static salt is set. Use `setSalt` to override it, or use resetSalt to reset it."
+        );
+        _randomCounter++;
+        return keccak256(abi.encodePacked(block.prevrandao, block.timestamp, msg.sender, _randomCounter));
+    }
+
+    // check that the user has added deployment networks by calling `addDeploymentNetwork`
+    modifier hasDeploymentNetworks() {
+        uint256 deploymentNetworksCount = _domainIds.length;
+        require(deploymentNetworksCount > 0, "Need to add deployment networks. Use `addDeploymentNetwork` first");
+        _;
+    }
+
+    /**
+     * @notice Computes the address where the contract will be deployed on this chain.
+     *     @param sender Address that requested deploy.
+     *     @param salt Entropy for contract address generation.
+     *     @param isUniquePerChain True to have unique addresses on every chain.
+     *     @param deploymentTarget the name of the network onto which to deploy the chain.
+     *     @return Address where the contract will be deployed on this chain.
+     */
+    function computeAddressForChain(address sender, bytes32 salt, bool isUniquePerChain, string memory deploymentTarget)
+        external
+        view
+        returns (address)
+    {
+        NetworkIds memory networkIds = _convertDeploymentTargetToNetworkIds(deploymentTarget);
+
+        return ICrosschainDeployAdapter(crosschainDeployContractAddress).computeContractAddressForChain(
+            sender, salt, isUniquePerChain, networkIds.InternalDomainId
+        );
+    }
+
+    /**
+     * This is a function we only need for tests.
+     * TODO: Figure out a safer way of keeping this visible.
+     */
+    function setCrosschainDeployContractAddress(address _crosschainDeployContractAddress) public {
+        crosschainDeployContractAddress = _crosschainDeployContractAddress;
+    }
+}