Audit/omnistaking

.gitignore

@@ -8,3 +8,9 @@ typechain-types
 # Hardhat files
 cache
 artifacts
+*.bin
+*.abi
+
+# Inception LRT custom ignore
+*.tgz
+/projects/tests/omnivault-rebalancer/contracts/

.prettierrc

@@ -0,0 +1,36 @@
+{
+  "arrowParens": "avoid",
+  "bracketSameLine": true,
+  "bracketSpacing": true,
+  "endOfLine": "crlf",
+  "semi": true,
+  "experimentalTernaries": false,
+  "singleQuote": false,
+  "jsxSingleQuote": false,
+  "quoteProps": "as-needed",
+  "trailingComma": "all",
+  "singleAttributePerLine": false,
+  "htmlWhitespaceSensitivity": "css",
+  "vueIndentScriptAndStyle": false,
+  "proseWrap": "preserve",
+  "insertPragma": false,
+  "printWidth": 120,
+  "requirePragma": false,
+  "tabWidth": 2,
+  "useTabs": false,
+  "embeddedLanguageFormatting": "auto",
+  "plugins": ["prettier-plugin-solidity"],
+  "overrides": [
+    {
+      "files": "*.sol",
+      "options": {
+        "parser": "solidity-parse",
+        "printWidth": 80,
+        "tabWidth": 4,
+        "useTabs": false,
+        "singleQuote": false,
+        "bracketSpacing": false
+      }
+    }
+  ]
+}

README.md

@@ -0,0 +1,64 @@
+![OmniStaking Architecture](./OmniStaking_Architecture.jpg)
+
+# OmniStaking
+
+OmniStaking is a cross-chain staking system designed to maintain the balance of Inception Tokens across Layer 1 (L1) and multiple Layer 2 (L2) networks. By managing both data and ETH transfers between chains, OmniStaking ensures that the protocol maintains a consistent supply of Inception Tokens across all deployed chains, creating a unified and decentralized staking ecosystem.
+
+## Overview
+
+OmniStaking operates through a sequence of cross-chain communications involving several key contracts and components:
+
+1. **InceptionOmniVault**: This contract initiates the transfer process. Operators (backend) interact with it to send either:
+   - **Data Messages**: For reporting asset balances, using `sendAssetsInfoToL1()`.
+   - **ETH Transfers**: For transferring ETH across chains, using `sendEthCrossChain()`.
+
+2. **LZCrossChainAdapterL2**: This contract, specific to L2 chains, is responsible for processing and transmitting cross-chain messages. It receives calls from `InceptionOmniVault` and initiates cross-chain transfers using the LayerZero protocol.
+
+3. **LZCrossChainAdapterL1**: After a specified delay (e.g., 7 days for mainnets or 20 minutes for testnets), messages or ETH transfers from L2 arrive at this L1 contract. Here, the contract:
+   - Decodes data messages.
+   - Relays the decoded information or ETH to the **NativeRebalancer**.
+
+4. **NativeRebalancer**: This L1 contract aggregates data from all L2 chains. When data from each L2 is received, users can call `updateTreasuryData` on **NativeRebalancer**. This function recalculates the token supply, minting or burning tokens to maintain the invariant:
+
+$$
+\text{sum(Inception Tokens on L2s)} = \text{Inception Tokens on L1}
+$$
+
+## Message Flow
+
+### L2 to L1 (Data and ETH Transfer)
+
+1. **Data Transfer**: 
+   - The operator calls `sendAssetsInfoToL1()` on **InceptionOmniVault**.
+   - This data message is forwarded to **LZCrossChainAdapterL2**, which encodes and sends the data across chains.
+
+2. **ETH Transfer**: 
+   - The operator initiates `sendEthCrossChain()` on **InceptionOmniVault**.
+   - **LZCrossChainAdapterL2** processes and sends the ETH transfer request to **LZCrossChainAdapterL1**.
+
+### L1 Reception and Balancing
+
+After the specified waiting period, **LZCrossChainAdapterL1** receives the cross-chain message or ETH transfer:
+
+1. **Data Message**: **LZCrossChainAdapterL1** decodes the data and relays it to **NativeRebalancer**.
+2. **ETH Transfer**: The ETH is directly forwarded as specified in the initial transfer request.
+
+Once all L2 data has been received, users call `updateTreasuryData()` on **NativeRebalancer**, which mints or burns Inception Tokens on L1 as needed to ensure cross-chain token balance.
+
+## Components
+
+- **InceptionOmniVault**: Initiates L2 to L1 cross-chain transfers.
+- **LZCrossChainAdapterL2**: Manages cross-chain messaging from L2 to L1.
+- **LZCrossChainAdapterL1**: Receives and processes messages or ETH on L1.
+- **NativeRebalancer**: Maintains the Inception Token invariant across chains by adjusting L1 supply.
+
+## Invariant Guarantee
+
+OmniStaking maintains the invariant:
+
+$$
+\text{sum(Inception Tokens on L2s)} = \text{Inception Tokens on L1}
+$$
+
+
+This ensures that the total supply of Inception Tokens is balanced across all chains in the OmniStaking ecosystem.

hh.config.ts

@@ -13,20 +13,74 @@ export const CONFIG = {
       gas: 8000000,
       gasPrice,
       accounts,
+      eid: 30101
     },
     holesky: {
       url: process.env.HOLESKY_RPC || "https://rpc.ankr.com/eth_holesky",
       chainId: 17000,
-      gasPrice,
       gas: 8000000,
+      gasPrice,
       accounts,
+      eid: 40217,
       verify: {
         etherscan: {
           apiKey: process.env.ETHERSCAN_API_KEY,
           apiUrl: "https://api-holesky.etherscan.io",
         },
       },
     },
+    arbitrum: {
+      url: process.env.RPC_URL_ARBITRUM,
+      chainId: 42161,
+      gas: 8000000,
+      gasPrice,
+      accounts,
+      eid: 30110,
+    },
+    sepolia: {
+      url: process.env.RPC_URL_SEPOLIA,
+      chainId: 11155111,
+      gas: 800000,
+      gasPrice,
+      accounts,
+      eid: 40161,
+      verify: {
+        etherscan: {
+          apiKey: process.env.ETHERSCAN_API_KEY,
+          apiUrl: "https://api-sepolia.etherscan.io",
+        },
+      },
+    },
+    optimism: {
+      url: process.env.RPC_URL_OPTIMISM,
+      chainId: 10,
+      gas: 8000000,
+      gasPrice,
+      accounts,
+      eid: 30111,
+      verify: {
+        etherscan: {
+          apiKey: process.env.OPTIMISM_API_KEY,
+          apiUrl: "https://api-optimistic.etherscan.io/api",
+        },
+      },
+    },
+    arbitrumSepolia: {
+      url: process.env.RPC_URL_ARBITRUM_TESTNET,
+      chainId: 421614,
+      gas: 8000000,
+      gasPrice,
+      accounts,
+      eid: 40231,
+    },
+    optimismSepolia: {
+      url: process.env.RPC_URL_OPTIMISM_SEPOLIA,
+      chainId: 11155420,
+      gas: 8000000,
+      gasPrice,
+      accounts,
+      eid: 40232,
+    },
     local: {
       url: process.env.LOCAL_RPC || "http://127.0.0.1:8545",
       chainId: 1337,
@@ -35,8 +89,20 @@ export const CONFIG = {
     },
     hardhat: {
       forking: {
-        url: `${process.env.MAINNET_RPC}`,
-        blockNumber: 20871635,
+        url: `${process.env.RPC_URL_SEPOLIA}`,
+      },
+      accounts: process.env.DEPLOYER_PRIVATE_KEY
+        ? [{ privateKey: process.env.DEPLOYER_PRIVATE_KEY, balance: "10000000000000000000" }]
+        : []
+    },
+  },
+  solidity: {
+    version: "0.8.26",
+    settings: {
+      viaIR: true,
+      optimizer: {
+        enabled: true,
+        runs: 200,
       },
     },
   },
@@ -83,8 +149,13 @@ export const CONFIG = {
   },
   etherscan: {
     apiKey: {
-      holesky: "PP5CDPZBG6AF6FBGE9CJNYGCRYXYN549M1",
+      holesky: process.env.HOLESKY_ETHERSCAN_API_KEY,
       mainnet: process.env.ETHERSCAN_API_KEY,
+      sepolia: process.env.ETHERSCAN_API_KEY,
+      arbitrum: process.env.ARBISCAN_API_KEY,
+      arbitrumSepolia: process.env.ARBISCAN_API_KEY,
+      optimism: process.env.OPTIMISM_API_KEY,
+      optimismSepolia: process.env.OPTIMISM_API_KEY,
     },
     customChains: [
       {
@@ -95,6 +166,23 @@ export const CONFIG = {
           browserURL: "https://holesky.etherscan.io",
         },
       },
+      {
+        network: "arbitrumSepolia",
+        chainId: 421614,
+        urls: {
+          apiURL: "https://api-sepolia.arbiscan.io/api",
+          browserURL: "https://sepolia.arbiscan.io",
+        },
+      },
+
+      {
+        network: "optimismSepolia",
+        chainId: 11155420,
+        urls: {
+          apiURL: "https://api-sepolia-optimistic.etherscan.io/api",
+          browserURL: "https://sepolia-optimism.etherscan.io/",
+        },
+      },
     ],
   },
   sourcify: {

package.json

@@ -16,8 +16,8 @@
   "license": "MIT",
   "private": true,
   "scripts": {
-    "prettier:sol": "prettier --write --plugin=prettier-plugin-solidity './**/*.sol'",
+    "prettier:sol": "prettier --write --plugin=prettier-plugin-solidity ./**/*.sol",
     "prettier:ts": "prettier --write ./**/*.ts",
     "prettier:js": "prettier --write ./**/*.js"
   }
-}
+}

projects/bridge-lz/.env.example

@@ -0,0 +1,4 @@
+DEPLOYER_PRIVATE_KEY=
+RPC_URL_SEPOLIA=
+RPC_URL_ARBITRUM_SEPOLIA=
+RPC_URL_OPTIMISM_SEPOLIA=

projects/bridge-lz/.gitignore

@@ -0,0 +1,17 @@
+node_modules
+.env
+coverage
+coverage.json
+typechain
+typechain-types
+
+# Hardhat files
+cache
+artifacts
+*.bin
+*.abi
+
+# Inception LRT custom ignore
+deployment_checkpoint.json
+*.tgz
+deployments

projects/bridge-lz/.nvmrc

@@ -0,0 +1 @@
+v18.18.0

projects/bridge-lz/.prettierignore

@@ -0,0 +1,10 @@
+artifacts/
+cache/
+dist/
+node_modules/
+out/
+*.log
+*ignore
+*.yaml
+*.lock
+package-lock.json

projects/bridge-lz/.prettierrc.js

@@ -0,0 +1,3 @@
+// module.exports = {
+//     ...require('@layerzerolabs/prettier-config-next'),
+// };