cross chain contracts and scripts with LayerZero

.env.example

@@ -0,0 +1,39 @@
+# for verifying contracts
+ETHERSCAN_API_KEY=
+OPTIMISTIC_ETHERSCAN_API_KEY=
+ARBISCAN_API_KEY=
+BASESCAN_API_KEY=
+FRAXSCAN_API_KEY=
+MORPHSCAN_API_KEY=
+
+MANTASCAN_API_KEY=
+TAIKOSCAN_API_KEY=
+SCROLLSCAN_API_KEY=
+FANTOMSCAN_API_KEY=
+MANTLESCAN_API_KEY=
+BLASTSCAN_API_KEY=
+LINEASCAN_API_KEY=
+
+
+# for testing and deploying the contracts please use full arhcival nodes
+BASE_RPC_URL=
+ARBITRUM_RPC_URL=
+FRAX_RPC_URL=
+OPTIMISM_RPC_URL=
+HOLESKY_RPC_URL=
+SEPOLIA_RPC_URL=
+MAINNET_RPC_URL=
+FRAX_TESTNET_RPC_URL=
+MORPH_TESTNET_RPC_URL=
+MANTA_RPC_URL=
+TAIKO_RPC_URL=
+SCROLL_RPC_URL=
+FANTOM_RPC_URL=
+MANTLE_RPC_URL=
+BLAST_RPC_URL=
+LINEA_RPC_URL=
+
+
+# for use with cast wallet.  store the deployer private key in the keystore and put the public address here.
+DEPLOYER_ACCOUNT_NAME=
+DEPLOYER_ADDRESS=

.github/workflows/test.yml

@@ -0,0 +1,55 @@
+name: test
+
+on: 
+  pull_request:
+    branches:
+      - main
+  push:
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  check:
+    strategy:
+      fail-fast: true
+
+    name: Foundry project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+
+      - uses: actions/cache@v4
+        with:
+          path: '**/node_modules'
+          key: cached-node-modules-${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Install Dependencies
+        run: |
+          yarn install --frozen-lockfile
+
+      - name: Run Forge build
+        run: |
+          forge --version
+          forge build --sizes
+        id: build
+
+      - name: Run Forge tests
+        env:
+          CI: true
+          MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
+          ARBITRUM_RPC_URL: ${{ secrets.ARBITRUM_RPC_URL }}
+          OPTIMISM_RPC_URL: ${{ secrets.OPTIMISM_RPC_URL }}
+
+        run: |
+          forge test -vvv
+        id: test

.gitignore

@@ -0,0 +1,17 @@
+# Compiler files
+cache/
+out/
+
+# Ignores development broadcast logs
+!/broadcast
+/broadcast/*/31337/
+/broadcast/**/dry-run/
+
+# Docs
+docs/
+
+# Dotenv file
+.env
+
+# Node Modules
+node_modules/

.gitmodules

@@ -0,0 +1,13 @@
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+[submodule "lib/LayerZero-v2"]
+	path = lib/LayerZero-v2
+	url = https://github.com/JorgeAtPaladin/LayerZero-v2
+	branch = lz-upgrade
+[submodule "lib/solmate"]
+	path = lib/solmate
+	url = https://github.com/transmissions11/solmate
+[submodule "lib/surl"]
+	path = lib/surl
+	url = https://github.com/memester-xyz/surl

.husky/pre-commit

@@ -0,0 +1 @@
+yarn lint-staged

.solhint.json

@@ -0,0 +1,3 @@
+{
+  "extends": "solhint:default"
+}

README.md

@@ -1,3 +1,239 @@
-# Yieldnest Cross Chain
+# Yieldnest Cross-Chain Contracts
 
-Contracts and scripts for deploying cross chain yieldnest tokens using LayerZero.
+This project contains the smart contracts and scripts for deploying cross-chain Yieldnest tokens using LayerZero technology. It leverages the Foundry development toolkit for testing, building, and deploying contracts, and uses Yarn to manage dependencies.
+
+## Project Overview
+
+This repository includes:
+
+- **Smart Contracts**: Contracts for Yieldnest's cross-chain tokens.
+- **Deployment Scripts**: Scripts for deploying and configuring the contracts across multiple chains.
+- **Testing Framework**: Tests using Foundry's Forge tool.
+
+### Key Contracts and Scripts
+
+- **Main Contracts**:
+  - `L2YnERC20Upgradeable.sol`: Layer 2 upgradeable ERC20 token contract.
+  - `ImmutableMultiChainDeployer.sol`: Handles multi-chain deployment of contracts.
+  - `L1YnOFTAdapterUpgradeable.sol`: Adapter for Layer 1 OFT (Omnichain Fungible Token).
+  - `L2YnOFTAdapterUpgradeable.sol`: Adapter for Layer 2 OFT.
+
+- **Deployment Scripts**:
+  - `deploy.sh`: The main deployment script that handles deployments across multiple chains.
+  - `DeployL2OFTAdapter.s.sol`: Deploys the Layer 2 ERC20 token and OFT Adapter.
+  - `DeployL1OFTAdapter.s.sol`: Deploys the Layer 1 OFT Adapter.
+  - `VerifyL2OFTAdapter.s.sol`: Verifys the Layer 2 ERC20 token and OFT Adapter.
+  - `VerifyL1OFTAdapter.s.sol`: Verifys the Layer 1 OFT Adapter.
+
+## Prerequisites
+
+- **Foundry**: A fast, portable, and modular toolkit for Ethereum development.
+- **Yarn**: Dependency management tool used in this project.
+- **Solidity**: For developing smart contracts.
+
+## Installation
+
+### 1. Clone the Repository
+
+```bash
+git clone https://github.com/yieldnest/yieldnest-cross-chain.git
+cd yieldnest-cross-chain
+```
+
+### 2. Install Dependencies
+
+This project uses `yarn` to manage dependencies
+
+```bash
+yarn install
+```
+
+## Usage
+
+### Build
+
+To build the project, use the following command. This will compile all Solidity contracts:
+
+```bash
+yarn build
+```
+
+### Compile
+
+You can compile contracts using Foundry's `forge`:
+
+```bash
+forge compile
+```
+
+### Test
+
+Run the tests with the following command:
+
+```bash
+yarn test
+```
+
+### Lint
+
+To lint Solidity files using `solhint`, run:
+
+```bash
+yarn lint
+```
+
+This will check all Solidity files in the `src/`, `test/`, and `scripts/` directories for issues, adhering to the project's `solhint` configuration.
+
+### Format
+
+You can format your Solidity code using:
+
+```bash
+yarn format
+```
+
+### Scripts
+
+For most users, it is recommended to use the `yarn deploy` command (outlined in the following section), as it simplifies the deployment process and ensures all necessary configurations are handled across multiple chains. Running the Forge scripts manually should only be done if you have a deep understanding of the deployment steps.
+
+However, if you need to run a script manually (e.g., `DeployL1OFTAdapter`), you can use the following command pattern:
+
+```bash
+forge script script/DeployL1OFTAdapter.s.sol:DeployL1OFTAdapter \
+  --rpc-url ${rpc} --sig "run(string calldata)" ${path} \
+  --account ${deployerAccountName} --sender ${deployer} \
+  --broadcast --etherscan-api-key ${api} --verify
+```
+
+Replace `DeployL1OFTAdapter` with the relevant contract name for other scripts if needed. But again, for ease and accuracy, the `yarn deploy` command is recommended.
+
+### Deployment
+
+To deploy Yieldnest tokens to new chains, you can use the `yarn deploy` command, which runs the `script/deploy.sh` script. This script accepts an input JSON file that specifies the token and chain configurations for deployment.
+
+For example, to deploy the `ynETH` token to the specified networks, use the following command:
+
+```bash
+yarn deploy script/inputs/mainnet-ynETH.json
+```
+
+You can find template JSON files for reference in the `script/inputs/` directory. Below is an example of a typical input file:
+
+```json
+{
+  "erc20Name": "ynETH",
+  "erc20Symbol": "ynETH",
+  "l1ChainId": 1,
+  "l2ChainIds": [
+    10,
+    8453
+  ],
+  "l1ERC20Address": "0x09db87A538BD693E9d08544577d5cCfAA6373A48",
+  "rateLimitConfig": {
+    "limit": "100000000000000000000",
+    "window": "86400"
+  }
+}
+```
+
+This script will deploy all the necessary contracts across the chains specified in the JSON file, including both the Layer 1 and all Layer 2 chains.
+
+### Adding a New L2 Chain
+
+To add a new L2 chain to an existing deployment, follow these steps using Morph Testnet as an example:
+
+1. Update the `BaseData.s.sol` file:
+   - Add the new testnet chain's ID to the `ChainIds` struct:
+     ```solidity
+     struct ChainIds {
+         // ... existing chain IDs
+         uint256 morphTestnet;
+     }
+     ```
+   - Initialize the new testnet chain ID in the `__chainIds` variable:
+     ```solidity
+     __chainIds = ChainIds({
+         // ... existing chain IDs
+         morphTestnet: 2810
+     });
+     ```
+   - Add the testnet chain-specific data to the `setUp()` function:
+     ```solidity
+     __chainIdToData[__chainIds.morphTestnet] = Data({
+         OFT_OWNER: TEMP_GNOSIS_SAFE,
+         TOKEN_ADMIN: TEMP_GNOSIS_SAFE,
+         PROXY_ADMIN: TEMP_PROXY_CONTROLLER,
+         LZ_ENDPOINT: 0x1a44076050125825900e736c501f859c50fE728c,
+         LZ_EID: 30210 // LayerZero Endpoint ID for Morph Testnet
+     });
+     ```
+
+2. Update the deployment input JSON file for testnets (e.g., `script/inputs/holesky-ynETH.json`):
+   - Add the new testnet chain ID to the `l2ChainIds` array:
+     ```json
+     {
+       "l2ChainIds": [
+         2522,
+         2810
+       ],
+       // ... other existing configuration
+     }
+     ```
+
+3. Add the new testnet chain's RPC URL to the `.env` file:
+   ```
+   MORPH_TESTNET_RPC_URL=https://rpc-testnet.morphl2.io
+   ```
+
+4. Update the `foundry.toml` file to include the new testnet RPC endpoint:
+   ```toml
+   [rpc_endpoints]
+   morph_testnet = "${MORPH_TESTNET_RPC_URL}"
+   ```
+
+5. Run the deployment script for the testnet environment:
+   ```bash
+   yarn deploy script/inputs/holesky-ynETH.json
+   ```
+
+   This will deploy the necessary contracts on the new Morph Testnet chain and update the existing contracts on other testnet chains to recognize the new L2 testnet.
+
+6. After deployment, verify that the new testnet chain has been properly added:
+   - Check that the L2YnOFTAdapter on Morph Testnet has the correct peers set for all other testnet chains.
+   - Verify that all other L2YnOFTAdapters and the L1YnOFTAdapter on testnets have been updated to include Morph Testnet as a peer.
+
+7. Update any front-end applications or scripts to include support for the new Morph Testnet chain, such as adding it to the list of supported testnet networks and including its contract addresses.
+
+By following these steps, you can successfully add Morph Testnet (or any other new L2 testnet chain) to your existing multi-chain testnet deployment.
+
+### Gas Snapshots
+
+To generate gas usage reports for the contracts, run:
+
+```bash
+forge snapshot
+```
+
+## Project Structure
+
+- `src/`: Contains the core smart contracts for the project.
+- `script/`: Contains deployment scripts for the contracts.
+- `test/`: Contains tests for the contracts, utilizing Forge.
+- `deployments/`: Contains deployment artifacts and configuration files for different environments.
+- `foundry.toml`: Foundry configuration file.
+- `package.json`: Yarn configuration file for managing dependencies.
+- `remappings.txt`: Foundry remappings for import resolution.
+
+## Linting
+
+This project uses `husky` for Git hooks and `forge fmt` for Solidity file formatting. Pre-commit hooks are set up using `lint-staged` to automatically format `.sol` files on commit.
+
+In addition, `solhint` is used to lint Solidity files. You can run `yarn lint` to manually check the code for common issues and enforce style guidelines.
+
+## Documentation
+
+For more information on Foundry and how to use it, please refer to the [Foundry Book](https://book.getfoundry.sh/).
+
+## License
+
+This project is licensed under the MIT License.