Cross chain arbitrum module

.github/workflows/cross-chain-arbitrum.yml

@@ -0,0 +1,181 @@
+name: Cross-chain Arbitrum module
+
+on:
+  schedule:
+    - cron: "0 0 * * *"
+  push:
+    branches:
+      - main
+    paths:
+      - "cross-chain/arbitrum/**"
+      - ".github/workflows/cross-chain-arbitrum.yml"
+  pull_request:
+  workflow_dispatch:
+    inputs:
+      environment:
+        description: "Environment (network) for workflow execution, e.g. `goerli`"
+        required: false
+      upstream_builds:
+        description: "Upstream builds"
+        required: false
+      upstream_ref:
+        description: "Git reference to checkout (e.g. branch name)"
+        required: false
+        default: "main"
+
+jobs:
+  contracts-detect-changes:
+    runs-on: ubuntu-latest
+    outputs:
+      path-filter: ${{ steps.filter.outputs.path-filter }}
+    steps:
+      - uses: actions/checkout@v3
+        if: github.event_name == 'pull_request'
+
+      - uses: dorny/paths-filter@v2
+        if: github.event_name == 'pull_request'
+        id: filter
+        with:
+          filters: |
+            path-filter:
+              - './cross-chain/arbitrum/**'
+              - './.github/workflows/cross-chain-arbitrum.yml'
+
+  contracts-build-and-test:
+    needs: contracts-detect-changes
+    if: |
+      github.event_name != 'pull_request'
+        || needs.contracts-detect-changes.outputs.path-filter == 'true'
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./cross-chain/arbitrum
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "14.x"
+          cache: "yarn"
+          cache-dependency-path: cross-chain/arbitrum/yarn.lock
+
+      # A workaround for transitive dependencies that use the obsolete git://
+      # prefix instead of the recommended https://
+      - name: Configure git to not use unauthenticated protocol
+        run: git config --global url."https://".insteadOf git://
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Build contracts
+        run: yarn build
+
+      - name: Run tests
+        run: yarn test
+
+  contracts-deployment-dry-run:
+    needs: contracts-detect-changes
+    if: |
+      github.event_name != 'pull_request'
+        || needs.contracts-detect-changes.outputs.path-filter == 'true'
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./cross-chain/arbitrum
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "14.x"
+          cache: "yarn"
+          cache-dependency-path: cross-chain/arbitrum/yarn.lock
+
+      # A workaround for transitive dependencies that use the obsolete git://
+      # prefix instead of the recommended https://
+      - name: Configure git to not use unauthenticated protocol
+        run: git config --global url."https://".insteadOf git://
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Deploy contracts
+        run: yarn deploy
+
+  contracts-format:
+    needs: contracts-detect-changes
+    if: |
+      github.event_name == 'push'
+        || needs.contracts-detect-changes.outputs.path-filter == 'true'
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./cross-chain/arbitrum
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "14.x"
+          cache: "yarn"
+          cache-dependency-path: cross-chain/arbitrum/yarn.lock
+
+      # A workaround for transitive dependencies that use the obsolete git://
+      # prefix instead of the recommended https://
+      - name: Configure git to not use unauthenticated protocol
+        run: git config --global url."https://".insteadOf git://
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Build
+        run: yarn build
+
+      - name: Check formatting
+        run: yarn format
+
+  contracts-slither:
+    needs: contracts-detect-changes
+    if: |
+      github.event_name == 'push'
+        || needs.contracts-detect-changes.outputs.path-filter == 'true'
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./cross-chain/arbitrum
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "14.x"
+          cache: "yarn"
+          cache-dependency-path: cross-chain/arbitrum/yarn.lock
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.10.8
+
+      - name: Install Solidity
+        env:
+          SOLC_VERSION: 0.8.17 # according to solidity.version in hardhat.config.ts
+        run: |
+          pip3 install solc-select
+          solc-select install $SOLC_VERSION
+          solc-select use $SOLC_VERSION
+
+      - name: Install Slither
+        env:
+          SLITHER_VERSION: 0.8.3
+        run: pip3 install slither-analyzer==$SLITHER_VERSION
+
+      # A workaround for transitive dependencies that use the obsolete git://
+      # prefix instead of the recommended https://
+      - name: Configure git to not use unauthenticated protocol
+        run: git config --global url."https://".insteadOf git://
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Run Slither
+        run: slither --hardhat-artifacts-directory build .

.pre-commit-config.yaml

@@ -35,3 +35,9 @@ repos:
         files: "^monitoring/"
         language: script
         description: "Checks monitoring directory code according to the formatting configuration"
+      - id: cross-chain-arbitrum-format
+        name: "Check cross-chain/arbitrum directory code formatting"
+        entry: /usr/bin/env bash -c "cd cross-chain/arbitrum && yarn format"
+        files: "^cross-chain/arbitrum/"
+        language: script
+        description: "Checks cross-chain/arbitrum directory code according to the formatting configuration"

.prettierignore

@@ -4,3 +4,4 @@ yearn/
 typescript/
 system-tests/
 monitoring/
+cross-chain/

README.adoc

@@ -46,7 +46,8 @@ This repository contains:
 - TBTC v2 link:system-tests/[System tests]
 - TBTC v2 link:docs/[documentation],
 - TBTC v2 Yearn vault link:yearn/[Solidity smart contracts],
-- TBTC v2 link:monitoring/[monitoring tool].
+- TBTC v2 link:monitoring/[monitoring tool],
+- TBTC v2 Cross-chain link:cross-chain/[smart contracts].
 
 toc::[]
 

cross-chain/arbitrum/.eslintignore

@@ -0,0 +1,8 @@
+artifacts/
+build/
+cache/
+deployments/
+export/
+hardhat-dependency-compiler/
+typechain/
+export.json

cross-chain/arbitrum/.eslintrc

@@ -0,0 +1,18 @@
+{
+  "root": true,
+  "extends": ["@thesis-co"],
+  "parserOptions": {
+    "ecmaVersion": 2017,
+    "sourceType": "module"
+  },
+  "env": {
+    "es6": true,
+    "mocha": true
+  },
+  "rules": {
+    "new-cap": "off",
+    "import/no-extraneous-dependencies": "off",
+    "@typescript-eslint/no-use-before-define": "off",
+    "no-plusplus": ["error", { "allowForLoopAfterthoughts": true }]
+  }
+}

cross-chain/arbitrum/.gitignore

@@ -0,0 +1,12 @@
+# Hardhat
+/build/
+/cache/
+/export/
+/external/npm
+/typechain/
+/export.json
+/deployments/*
+!/deployments/mainnet/
+
+# OZ
+/.openzeppelin/unknown-*.json 

cross-chain/arbitrum/.mocharc.json

@@ -0,0 +1,3 @@
+{
+  "require": "ts-node/register/files"
+}

cross-chain/arbitrum/.prettierignore

@@ -0,0 +1,9 @@
+.openzeppelin/
+artifacts/
+build/
+cache/
+deployments/
+export/
+hardhat-dependency-compiler/
+typechain/
+export.json

cross-chain/arbitrum/.prettierrc.js

@@ -0,0 +1,11 @@
+module.exports = {
+  ...require("@thesis-co/prettier-config"),
+  overrides: [
+    {
+      files: "*.sol",
+      options: {
+        tabWidth: 4,
+      },
+    },
+  ],
+}

cross-chain/arbitrum/.solhint.json

@@ -0,0 +1,7 @@
+{
+  "extends": "keep",
+  "plugins": [],
+  "rules": {
+    "func-visibility": ["error", { "ignoreConstructors": true }]
+  }
+}

cross-chain/arbitrum/.solhintignore

@@ -0,0 +1,2 @@
+hardhat-dependency-compiler/
+node_modules/

cross-chain/arbitrum/.tsconfig-eslint.json

@@ -0,0 +1 @@
+node_modules/@thesis-co/eslint-config/.tsconfig-eslint.json

cross-chain/arbitrum/README.adoc

@@ -0,0 +1,42 @@
+:toc: macro
+
+= Threshold cross-chain - Arbitrum
+
+This package brings Bitcoin to Ethereum L2 Arbitrum. For more details please
+see link:https://github.com/keep-network/tbtc-v2/blob/main/docs/rfc/rfc-8.adoc[Cross-chain Tokenized Threshold BTC]
+
+== How it works?
+
+```
++----------------------------+         +---------------------------------------------------------------------------+
+|          Ethereum          |         |                                Arbitrum                                   |
+|                            |         |                                                                           |
+|  +----------------------+  |         |  +----------------------+  +-------------------------+  +--------------+  |
+|  | Wormhole TokenBridge |--|---------|--| Wormhole TokenBridge |--| ArbitrumWormholeGateway |--| ArbitrumTBTC |  |
+|  +----------------------+  |         |  +----------------------+  +-------------------------+  +--------------+  |
+|                            |         |                                                                           |
++----------------------------+         +---------------------------------------------------------------------------+
+```
+
+- `ArbitrumTBTC` canonical tBTC token on Arbitrum with a minting authority
+delegated to `ArbitrumWormholeGateway`.
+- `ArbitrumWormholeGateway` is a smart contract wrapping and unwrapping 
+Wormhole-specific tBTC representation into the canonical `ArbitrumTBTC` token.
+
+=== Deploy contracts
+
+To deploy all contracts on the given network, please run:
+```
+yarn deploy --network <network>
+```
+
+If contracts haven't been built yet or changes occurred, this task will build
+the contracts before running the deployment script. This command produces
+an `export.json` file containing contract deployment info. Note that for the
+chains other than 'hardhat' the following env. variables are needed:
+
+- `CHAIN_L2_API_URL` - URL to access blockchain services, e.g. `\https://arb-goerli.g.alchemy.com/v2/<alchemy_api_key>`
+- `CONTRACT_L2_OWNER_ADDRESS` - Deployer / Contract Owner address
+- `THRESHOLD_L2_COUNCIL_ADDRESS` - Council / Governance address
+- `ACCOUNTS_L2_PRIVATE_KEYS` - Private keys for the deployer and council `<0xOwnerPrivKey,0xCouncilPrivKey>`
+- `ARBISCAN_API_KEY` - Arbiscan API key

cross-chain/arbitrum/contracts/test/ArbitrumTBTCUpgraded.sol

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: GPL-3.0-only
+
+pragma solidity ^0.8.17;
+
+import "@keep-network/tbtc-v2/contracts/l2/L2TBTC.sol";
+
+/// @notice Canonical tBTC Token on Arbitrum - upgraded version.
+/// @dev This contract is intended solely for testing purposes. As it currently
+///      stands in the implementation of L2TBTC.sol, there are no reserved
+///      storage gap slots available, thereby limiting the upgradability to a
+///      child contract only.
+contract ArbitrumTBTCUpgraded is L2TBTC {
+    string public newVar;
+
+    function initializeV2(string memory _newVar) public {
+        newVar = _newVar;
+    }
+}

cross-chain/arbitrum/contracts/test/ArbitrumWormholeGatewayUpgraded.sol

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: GPL-3.0-only
+
+pragma solidity ^0.8.17;
+
+import "@keep-network/tbtc-v2/contracts/l2/L2WormholeGateway.sol";
+
+/// @notice Wormhole gateway for L2 Arbitrum - upgraded version.
+/// @dev This contract is intended solely for testing purposes. As it currently
+///      stands in the implementation of L2WormholeGateway.sol, there are no
+///      reserved storage gap slots available, thereby limiting the upgradability
+///      to a child contract only.
+contract ArbitrumWormholeGatewayUpgraded is L2WormholeGateway {
+    string public newVar;
+
+    function initializeV2(string memory _newVar) public {
+        newVar = _newVar;
+    }
+}