Merge branch 'v3' into trevor/deploy-kathy-nov-13

.eslintrc

@@ -31,7 +31,7 @@
     "@typescript-eslint/no-require-imports": ["warn"],
     "@typescript-eslint/no-unused-vars": [
       "error",
-      { 
+      {
         "argsIgnorePattern": "^_",
         "varsIgnorePattern": "^_",
         "caughtErrorsIgnorePattern": "^_"
@@ -48,4 +48,4 @@
       }
     ]
   }
-}
+}

.github/CODEOWNERS

@@ -22,5 +22,8 @@ typescript/token @yorhodes @jmrossy @tkporter @aroralanuk
 ## Hello World
 typescript/helloworld @yorhodes @nambrot
 
+## CLI
+typescript/cli @jmrossy @yorhodes @aroralanuk
+
 ## Infra
 typescript/infra @tkporter @nambrot

.github/workflows/node.yml

@@ -112,6 +112,25 @@ jobs:
       - name: infra
         run: yarn workspace @hyperlane-xyz/infra run test
 
+  test-cli:
+    runs-on: ubuntu-latest
+    needs: [yarn-build]
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: onbjerg/foundry-toolchain@v1
+
+      - uses: actions/cache@v3
+        with:
+          path: ./*
+          key: ${{ github.sha }}
+
+      - name: test
+        run: ./typescript/cli/ci-test.sh
+
   test-env:
     runs-on: ubuntu-latest
     needs: [yarn-build]

Dockerfile

@@ -13,6 +13,7 @@ COPY .yarn/releases ./.yarn/releases
 COPY typescript/utils/package.json ./typescript/utils/
 COPY typescript/sdk/package.json ./typescript/sdk/
 COPY typescript/helloworld/package.json ./typescript/helloworld/
+COPY typescript/cli/package.json ./typescript/cli/
 COPY typescript/infra/package.json ./typescript/infra/
 COPY solidity/package.json ./solidity/
 

README.md

@@ -7,16 +7,16 @@
 [codecov-badge]: https://img.shields.io/codecov/c/github/hyperlane-xyz/hyperlane-monorepo
 [foundry]: https://getfoundry.sh/
 [foundry-badge]: https://img.shields.io/badge/Built%20with-Foundry-FFDB1C.svg
-[license]: https://opensource.org/licenses/MIT
-[license-badge]: https://img.shields.io/badge/License-MIT-blue.svg
+[license]: https://www.apache.org/licenses/LICENSE-2.0
+[license-badge]: https://img.shields.io/badge/License-Apache-blue.svg
 
 ## Versioning
 
 Note this is the branch for Hyperlane v3.
 
-V2 is on the main branch but is eventually being phased out.
+V2 is still in operation but is not being actively developed. The code for V2 can be found in the [v2](https://github.com/hyperlane-xyz/hyperlane-monorepo/tree/v2) branch.
 
-V1 has since been deprecated in favor of V2, but if you are looking for code relating to the existing V1 deployments of the `testnet2` or `mainnet` environments, refer to the [v1](https://github.com/hyperlane-xyz/hyperlane-monorepo/tree/v1) branch.
+V1 has since been deprecated in favor of V2, but if you are looking for code relating to the existing V1 deployments, refer to the [v1](https://github.com/hyperlane-xyz/hyperlane-monorepo/tree/v1) branch.
 
 ## Overview
 

package.json

@@ -6,8 +6,8 @@
     "@trivago/prettier-plugin-sort-imports": "^4.2.1",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
-    "eslint": "^8.16.0",
-    "eslint-config-prettier": "^8.5.0",
+    "eslint": "^8.43.0",
+    "eslint-config-prettier": "^8.8.0",
     "husky": "^8.0.0",
     "lint-staged": "^12.4.3",
     "prettier": "^2.8.8"
@@ -37,6 +37,7 @@
     "lodash": "^4.17.21",
     "recursive-readdir": "^2.2.3",
     "underscore": "^1.13",
-    "undici": "^5.11"
+    "undici": "^5.11",
+    "@trivago/prettier-plugin-sort-imports/@babel/parser": "^7.22.7"
   }
 }

rust/build.sh

@@ -13,7 +13,7 @@ if [[ -z $TAG ]]; then
   # compatible with our K8s infrastructure.
   # More info: https://stackoverflow.com/a/71102144
   if [[ $USE_DEFAULT_PLATFORM != "true" ]]; then
-    PLATFORM="--platform=linux/amd64"
+    PLATFORM="--platform=linux/amd64/v8"
   fi
 fi
 

solidity/contracts/token/FastHypERC20.sol

@@ -0,0 +1,62 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity >=0.8.0;
+
+import {HypERC20} from "./HypERC20.sol";
+
+import {TokenRouter} from "./libs/TokenRouter.sol";
+import {FastTokenRouter} from "./libs/FastTokenRouter.sol";
+import {TokenMessage} from "./libs/TokenMessage.sol";
+
+import {ERC20Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
+
+/**
+ * @title Hyperlane ERC20 Token Router that extends ERC20 with remote transfer functionality.
+ * @author Abacus Works
+ * @dev Supply on each chain is not constant but the aggregate supply across all chains is.
+ */
+contract FastHypERC20 is FastTokenRouter, HypERC20 {
+    constructor(
+        uint8 __decimals,
+        address _mailbox
+    ) HypERC20(__decimals, _mailbox) {}
+
+    /**
+     * @dev delegates transfer logic to `_transferTo`.
+     * @inheritdoc TokenRouter
+     */
+    function _handle(
+        uint32 _origin,
+        bytes32 _sender,
+        bytes calldata _message
+    ) internal virtual override(FastTokenRouter, TokenRouter) {
+        FastTokenRouter._handle(_origin, _sender, _message);
+    }
+
+    /**
+     * @dev Mints `_amount` of tokens to `_recipient`.
+     * @inheritdoc FastTokenRouter
+     */
+    function _fastTransferTo(
+        address _recipient,
+        uint256 _amount
+    ) internal override {
+        _mint(_recipient, _amount);
+    }
+
+    /**
+     * @dev Burns `_amount` of tokens from `_recipient`.
+     * @inheritdoc FastTokenRouter
+     */
+    function _fastRecieveFrom(
+        address _sender,
+        uint256 _amount
+    ) internal override {
+        _burn(_sender, _amount);
+    }
+
+    function balanceOf(
+        address _account
+    ) public view virtual override(TokenRouter, HypERC20) returns (uint256) {
+        return HypERC20.balanceOf(_account);
+    }
+}

solidity/contracts/token/FastHypERC20Collateral.sol

@@ -0,0 +1,61 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity >=0.8.0;
+
+import {HypERC20Collateral} from "./HypERC20Collateral.sol";
+import {TokenRouter} from "./libs/TokenRouter.sol";
+import {FastTokenRouter} from "./libs/FastTokenRouter.sol";
+
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+
+/**
+ * @title Hyperlane ERC20 Token Collateral that wraps an existing ERC20 with remote transfer functionality.
+ * @author Abacus Works
+ */
+contract FastHypERC20Collateral is FastTokenRouter, HypERC20Collateral {
+    using SafeERC20 for IERC20;
+
+    /**
+     * @notice Constructor
+     * @param erc20 Address of the token to keep as collateral
+     * @param _mailbox Address of the mailbox address
+     */
+    constructor(
+        address erc20,
+        address _mailbox
+    ) HypERC20Collateral(erc20, _mailbox) {}
+
+    /**
+     * @dev delegates transfer logic to `_transferTo`.
+     * @inheritdoc FastTokenRouter
+     */
+    function _handle(
+        uint32 _origin,
+        bytes32 _sender,
+        bytes calldata _message
+    ) internal virtual override(FastTokenRouter, TokenRouter) {
+        FastTokenRouter._handle(_origin, _sender, _message);
+    }
+
+    /**
+     * @dev Transfers `_amount` of `wrappedToken` to `_recipient`.
+     * @inheritdoc FastTokenRouter
+     */
+    function _fastTransferTo(
+        address _recipient,
+        uint256 _amount
+    ) internal override {
+        wrappedToken.safeTransfer(_recipient, _amount);
+    }
+
+    /**
+     * @dev Transfers in `_amount` of `wrappedToken` from `_recipient`.
+     * @inheritdoc FastTokenRouter
+     */
+    function _fastRecieveFrom(
+        address _sender,
+        uint256 _amount
+    ) internal override {
+        wrappedToken.safeTransferFrom(_sender, address(this), _amount);
+    }
+}

solidity/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@hyperlane-xyz/core",
   "description": "Core solidity contracts for Hyperlane",
-  "version": "3.1.0-beta3",
+  "version": "3.1.3",
   "dependencies": {
     "@eth-optimism/contracts": "^0.6.0",
-    "@hyperlane-xyz/utils": "3.1.0-beta3",
+    "@hyperlane-xyz/utils": "3.1.3",
     "@openzeppelin/contracts": "^4.9.3",
     "@openzeppelin/contracts-upgradeable": "^v4.9.3"
   },
@@ -58,7 +58,6 @@
     "slither": "slither ."
   },
   "types": "dist/index.d.ts",
-  "stableVersion": "1.5.0",
   "peerDependencies": {
     "@ethersproject/abi": "*",
     "@ethersproject/providers": "*",

typescript/cli/.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+dist

typescript/cli/.eslintrc

@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "no-console": ["off"]
+  }
+}

typescript/cli/.gitignore

@@ -0,0 +1,5 @@
+.env*
+/dist
+/cache
+/configs
+/artifacts

typescript/cli/README.md

@@ -0,0 +1,57 @@
+# Hyperlane CLI
+
+The Hyperlane CLI is a command-line tool written in Typescript that facilitates common operations on Hyperlane, such as deploying the core contracts and/or warp routes to new chains.
+
+## Hyperlane overview
+
+Hyperlane is an interchain messaging protocol that allows applications to communicate between blockchains.
+
+Developers can use Hyperlane to share state between blockchains, allowing them to build interchain applications that live natively across multiple chains.
+
+To read more about interchain applications, how the protocol works, and how to integrate with Hyperlane, please see the [documentation](https://docs.hyperlane.xyz).
+
+## Setup
+
+Node 16 or newer is required.
+
+**Option 1: Global install:**
+
+```bash
+# Install with NPM
+npm install -g @hyperlane-xyz/cli
+# Or uninstall old versions
+npm uninstall -g @hyperlane-xyz/cli
+```
+
+**Option 2: Temp install:**
+
+```bash
+# Run via NPM's npx command
+npx @hyperlane-xyz/cli
+# Or via Yarn's dlx command
+yarn dlx @hyperlane-xyz/cli
+```
+
+**Option 3: Run from source:**
+
+```bash
+git clone https://github.com/hyperlane-xyz/hyperlane-monorepo.git
+cd hyperlane-monorepo
+yarn install && yarn build
+cd typescript/cli
+yarn hyperlane
+```
+
+## Common commands
+
+View help: `hyperlane --help`
+
+Create a core deployment config: `hyperlane config create`
+
+Run hyperlane core deployments: `hyperlane deploy core`
+
+Run warp route deployments: `hyperlane deploy warp`
+
+View SDK contract addresses: `hyperlane chains addresses`
+
+Send test message: `hyperlane send message`