Merge pull request #5 from hyperlane-xyz/sdk-migration

- Finish migration of SDK consts started in #3 
- Convert json chain files to yaml
- Create build script to transform data
- Set up CI job and mocha tests
- Productize package.json file
- Update Readme
- Lock yarn version like in monorepo

.github/workflows/ci.yml

@@ -0,0 +1,81 @@
+name: ci
+
+on:
+  # Triggers the workflow on push or pull request events
+  push:
+    branches: [main]
+  pull_request:
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  install:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/cache@v3
+        with:
+          path: |
+            **/node_modules
+            .yarn/cache
+          key: ${{ runner.os }}-yarn-cache-${{ hashFiles('./yarn.lock') }}
+      - name: yarn-install
+        # Check out the lockfile from main, reinstall, and then
+        # verify the lockfile matches what was committed.
+        run: |
+            yarn install
+            CHANGES=$(git status -s)
+            if [[ ! -z $CHANGES ]]; then
+              echo "Changes found: $CHANGES"
+              git diff
+              exit 1
+            fi
+
+  build:
+    runs-on: ubuntu-latest
+    needs: [install]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/cache@v3
+        with:
+          path: |
+            **/node_modules
+            .yarn/cache
+          key: ${{ runner.os }}-yarn-cache-${{ hashFiles('./yarn.lock') }}
+      - name: build
+        run: yarn run build
+
+  prettier:
+    runs-on: ubuntu-latest
+    needs: [install]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/cache@v3
+        with:
+          path: |
+            **/node_modules
+            .yarn/cache
+          key: ${{ runner.os }}-yarn-cache-${{ hashFiles('./yarn.lock') }}
+      - name: prettier
+        run: |
+          yarn run prettier
+          CHANGES=$(git status -s)
+          if [[ ! -z $CHANGES ]]; then
+            echo "Changes found: $CHANGES"
+            exit 1
+          fi
+
+  test:
+    runs-on: ubuntu-latest
+    needs: [build]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/cache@v3
+        with:
+          path: |
+            **/node_modules
+            .yarn/cache
+          key: ${{ runner.os }}-yarn-cache-${{ hashFiles('./yarn.lock') }}
+      - name: test
+        run: yarn run test

.gitignore

@@ -19,4 +19,8 @@ yarn-error.log*
 .env*.local
 
 # typescript
-*.tsbuildinfo
+*.tsbuildinfo
+
+# build artifacts
+dist
+tmp

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn lint-staged

.lintstagedrc

@@ -0,0 +1,7 @@
+{
+  "*.js": "prettier --write",
+  "*.ts": "prettier --write", 
+  "*.md": "prettier --write",
+  "*.json": "prettier --write",
+  "*.yaml": "prettier --write"
+}

.mocharc.json

@@ -0,0 +1,3 @@
+{
+  "import": ["tsx"]
+}

.prettierrc

@@ -0,0 +1,14 @@
+{
+  "tabWidth": 2,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "printWidth": 100,
+  "overrides": [
+    {
+      "files": "*.yaml",
+      "options": {
+        "singleQuote": false
+      }
+    }
+  ]
+}

.yarnrc.yml

@@ -0,0 +1,9 @@
+compressionLevel: mixed
+
+enableGlobalCache: false
+
+enableScripts: false
+
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-4.0.2.cjs

README.md

@@ -1,21 +1,22 @@
 # Hyperlane Registry
 
-**WORK IN PROGRESS, SUBJECT TO MAJOR CHANGES**
-
 A collection of configs, artifacts, and schemas for Hyperlane.
 
 ## Contents
 
 ### Chains
 
-A map of chain names to chain metadata. Includes the information Hyperlane utilities and apps will require to interact with chains.
+A list of chains and the relevant information that Hyperlane utilities and apps will require to interact with chains.
+Structured as a folder for each chain. Each folder should contain a `metadata.yaml`, `addresses.yaml`, and a `logo.svg` file.
 
 ### Deployments
 
+**WORK IN PROGRESS: Note, the shape and contents of the deployments folders are subject to change**
+
 #### Core
 
 Configs and artifacts for [Hyperlane Core Contract](https://docs.hyperlane.xyz/docs/deploy/deploy-hyperlane) deployments.
 
 #### Warp
 
-Configs and artifacts for [Warp Route](https://docs.hyperlane.xyz/docs/deploy/deploy-warp-route) token deployments.
+Address artifacts for [Warp Route](https://docs.hyperlane.xyz/docs/deploy/deploy-warp-route) token deployments.

chains/alfajores/addresses.yaml

@@ -0,0 +1,19 @@
+aggregationHook: "0xdBabD76358897E68E4964647C1fb8Bf524f5EFdB"
+domainRoutingIsmFactory: "0x30d9A03762431F8A917a0C469E7A62Bf55092Ca6"
+fallbackRoutingHook: "0x3528B1aeF3a3d29E0eae90ad777A2b4A6a48aC3F"
+interchainAccountIsm: "0x6895d3916B94b386fAA6ec9276756e16dAe7480E"
+interchainAccountRouter: "0xEbA64c8a9b4a61a9210d5fe7E4375380999C821b"
+interchainGasPaymaster: "0x44769b0f4a6f01339e131a691cc2eebbb519d297"
+mailbox: "0xEf9F292fcEBC3848bF4bB92a96a04F9ECBb78E59"
+merkleTreeHook: "0x221FA9CBaFcd6c1C3d206571Cf4427703e023FFa"
+protocolFee: "0xC9D50584F08Bf6cCD1004d14c7062044b45E3b48"
+proxyAdmin: "0x4eDBf5846D973c53AF478cf62aB5bC92807521e3"
+staticAggregationHookFactory: "0x71bB34Ee833467443628CEdFAA188B2387827Cee"
+staticAggregationIsmFactory: "0x4bE8AC22f506B1504C93C3A5b1579C5e7c550D9C"
+staticMerkleRootMultisigIsmFactory: "0xa9C7e306C0941896CA1fd528aA59089571D8D67E"
+staticMessageIdMultisigIsmFactory: "0xC1b8c0e56D6a34940Ee2B86172450B54AFd633A7"
+storageGasOracle: "0x8356113754C7aCa297Db3089b89F87CC125499fb"
+testRecipient: "0x6489d13AcAd3B8dce4c5B31f375DE4f9451E7b38"
+testTokenRecipient: "0x92dC0a76452a9D9358D2d2dEd8CddA209DF67c45"
+timelockController: "0x0000000000000000000000000000000000000000"
+validatorAnnounce: "0x3726EE36a2A9e11a40d1ffD7D9A1A16e0154cDA0"

chains/alfajores/metadata.yaml

@@ -0,0 +1,26 @@
+# yaml-language-server: $schema=../schema
+blockExplorers:
+  - apiUrl: https://api-alfajores.celoscan.io/api
+    family: etherscan
+    name: CeloScan
+    url: https://alfajores.celoscan.io
+  - apiUrl: https://explorer.celo.org/alfajores/api
+    family: blockscout
+    name: Blockscout
+    url: https://explorer.celo.org/alfajores
+blocks:
+  confirmations: 1
+  estimateBlockTime: 5
+  reorgPeriod: 0
+chainId: 44787
+displayName: Alfajores
+domainId: 44787
+isTestnet: true
+name: alfajores
+nativeToken:
+  decimals: 18
+  name: CELO
+  symbol: CELO
+protocol: ethereum
+rpcUrls:
+  - http: https://alfajores-forno.celo-testnet.org

chains/arbitrum/addresses.yaml

@@ -0,0 +1,21 @@
+aggregationHook: "0xe0cb37cFc47296f1c4eD77EFf92Aed478644d10c"
+domainRoutingIsmFactory: "0xa2931C37957f3079d3B21b877d56E1db930e02a5"
+fallbackRoutingHook: "0x9e8fFb1c26099e75Dd5D794030e2E9AA51471c25"
+interchainAccountIsm: "0xfa8bfcE55B3A0631dF38257615cEF7FCD3523A48"
+interchainAccountRouter: "0xCD0CFFf6eFD943b4b81f2c15847730dbcD30e3aE"
+interchainGasPaymaster: "0x3b6044acd6767f017e99318AA6Ef93b7B06A5a22"
+interchainSecurityModule: "0xD0DBBF922076352cC50B285A0023536561F00EEa"
+mailbox: "0x979Ca5202784112f4738403dBec5D0F3B9daabB9"
+merkleTreeHook: "0x748040afB89B8FdBb992799808215419d36A0930"
+pausableHook: "0xEf30f29Dcd3FCB1DCcDA9C7Cbf2A5957E8Ee9Cc3"
+protocolFee: "0xD0199067DACb8526e7dc524a9a7DCBb57Cd25421"
+proxyAdmin: "0x80Cebd56A65e46c474a1A101e89E76C4c51D179c"
+staticAggregationHookFactory: "0x9B5f440bBb64Fee337F37e03362b628711Ea09C7"
+staticAggregationIsmFactory: "0xD4883084389fC1Eeb4dAfB2ADcFc36B711c310EB"
+staticMerkleRootMultisigIsmFactory: "0x3C330D4A2e2b8443AFaB8E326E64ab4251B7Eae0"
+staticMessageIdMultisigIsmFactory: "0x12Df53079d399a47e9E730df095b712B0FDFA791"
+storageGasOracle: "0xD3805207b65d99C075ceA938Fa7c0587026a5DF5"
+testRecipient: "0x36FdA966CfffF8a9Cdc814f546db0e6378bFef35"
+testTokenRecipient: "0x85ac1164878e017b67660a74ff1f41f3D05C02Bb"
+timelockController: "0x0000000000000000000000000000000000000000"
+validatorAnnounce: "0x1df063280C4166AF9a725e3828b4dAC6c7113B08"

chains/arbitrum/metadata.yaml

@@ -0,0 +1,24 @@
+# yaml-language-server: $schema=../schema
+blockExplorers:
+  - apiUrl: https://api.arbiscan.io/api
+    family: etherscan
+    name: Arbiscan
+    url: https://arbiscan.io
+blocks:
+  confirmations: 1
+  estimateBlockTime: 3
+  reorgPeriod: 0
+chainId: 42161
+displayName: Arbitrum
+domainId: 42161
+gasCurrencyCoinGeckoId: ethereum
+gnosisSafeTransactionServiceUrl: https://safe-transaction-arbitrum.safe.global/
+name: arbitrum
+nativeToken:
+  decimals: 18
+  name: Ether
+  symbol: ETH
+protocol: ethereum
+rpcUrls:
+  - http: https://arb1.arbitrum.io/rpc
+technicalStack: arbitrumnitro