Merge SDK + Hardhat + Deploy packages (#643)

- Merge hardhat package into SDK - Merge deploy package into SDK - Reorganize SDK consts and utils - Rename TestCoreDeploy -> TestCoreDeployer - Rename some file names to their class names - Remove runtime dependencies on Chai and Yargs - Replace Axios dep with cross-fetch - Setup type shorthand for Address type in SDK - Update infra package - Fix deploy's hardhat tests - Fix incorrect test in AbacusCoreChecker - Colocate tests into SDK src - Add instructions for publishing - Bump version to 0.3.1 and publish
hyperlane-xyz · Jul 5, 2022 · 86f280e · 86f280e
1 parent 0644e4b
commit 86f280e
Show file tree

Hide file tree

Showing 100 changed files with 802 additions and 956 deletions.
diff --git a/.github/workflows/node.yml b/.github/workflows/node.yml
@@ -90,8 +90,6 @@ jobs:
         run: yarn workspace @abacus-network/sdk run test
       - name: infra
         run: yarn workspace @abacus-network/infra run test
-      - name: hardhat
-        run: yarn workspace @abacus-network/hardhat run test
 
   test-sol:
     env:

diff --git a/Dockerfile b/Dockerfile
@@ -12,9 +12,7 @@ COPY package.json yarn.lock .yarnrc.yml ./
 COPY .yarn/plugins ./.yarn/plugins
 COPY .yarn/releases ./.yarn/releases
 COPY typescript/utils/package.json ./typescript/utils/
-COPY typescript/hardhat/package.json ./typescript/hardhat/
 COPY typescript/sdk/package.json ./typescript/sdk/
-COPY typescript/deploy/package.json ./typescript/deploy/
 COPY typescript/infra/package.json ./typescript/infra/
 COPY solidity/core/package.json ./solidity/core/
 COPY solidity/app/package.json ./solidity/app/

diff --git a/README.md b/README.md
@@ -26,12 +26,6 @@ This monorepo uses [Yarn Workspaces](https://yarnpkg.com/features/workspaces). I
   yarn build
   ```
 
-- Running prettier
-
-  ```bash
-  yarn prettier
-  ```
-
 If you are using [VSCode](https://code.visualstudio.com/), you can launch the [multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces) with `code mono.code-workspace`, install the recommended workspace extensions, and use the editor settings.
 
 ### Rust
@@ -53,7 +47,7 @@ cd rust
 ./release.sh <image_tag>
 ```
 
-## Deploy Procedure
+#### Deploy Procedure
 
 The contract addresses of each deploy can be found in `rust/config`. The latest
 deploy will be at `rust/config/[latest timestamp]` with bridge contracts within
@@ -68,3 +62,29 @@ messages will not be relayed between chains).
 
 Off-chain agents are **not** automatically re-deployed when new contract deploys
 are merged. Auto-redeploys will be implemented at some future date.
+
+### Publishing Packages
+
+Packages can be versioned and published all at once with commands from the root.
+
+First, increment the version to the desired value:
+
+```bash
+# An example of a prerelease version
+yarn version:prepare 0.5.0-beta0
+# Or for a release which increments the minor version
+yarn version:prepare minor
+```
+
+Next, ensure packages are cleaned and rebuilt:
+
+```bash
+yarn clean && yarn build
+```
+
+Finally, publish the packages to NPM
+
+```bash
+# Note: If you have not yet logged in, first run yarn npm login
+yarn publish:all --otp YOUR_OTP_HERE
+```
diff --git a/package.json b/package.json
@@ -16,11 +16,14 @@
   "private": true,
   "scripts": {
     "build": "yarn workspaces foreach --verbose --parallel --topological run build",
-    "publish": "yarn workspaces foreach --no-private --verbose --topological npm publish --access public",
+    "clean": "yarn workspaces foreach --verbose --parallel run clean",
     "postinstall": "husky install",
     "prettier": "yarn workspaces foreach --verbose --parallel run prettier",
     "lint-ts": "eslint . --ext .ts",
-    "test": "yarn workspaces foreach --verbose --parallel run test"
+    "test": "yarn workspaces foreach --verbose --parallel run test",
+    "version:check": "yarn version check --interactive",
+    "version:prepare": "yarn workspaces foreach --no-private --verbose --topological version --immediate",
+    "publish:all": "yarn workspaces foreach --no-private --verbose --topological npm publish --access public"
   },
   "workspaces": [
     "solidity/*",

diff --git a/solidity/app/package.json b/solidity/app/package.json
@@ -1,10 +1,10 @@
 {
   "name": "@abacus-network/app",
   "description": "Solidity contracts for Abacus apps",
-  "version": "0.2.3",
+  "version": "0.3.1",
   "dependencies": {
-    "@abacus-network/core": "^0.2.3",
-    "@abacus-network/utils": "^0.2.3",
+    "@abacus-network/core": "0.3.1",
+    "@abacus-network/utils": "0.3.1",
     "@openzeppelin/contracts-upgradeable": "^4.5.0"
   },
   "devDependencies": {
@@ -45,7 +45,7 @@
   "repository": "https://github.com/abacus-network/abacus-monorepo",
   "scripts": {
     "build": "hardhat compile && tsc",
-    "clean": "hardhat clean",
+    "clean": "hardhat clean && rm -rf ./dist ./cache",
     "coverage": "hardhat coverage",
     "prettier": "prettier --write ./contracts ./test",
     "test": "hardhat test"

diff --git a/solidity/core/package.json b/solidity/core/package.json
@@ -1,9 +1,9 @@
 {
   "name": "@abacus-network/core",
   "description": "Core solidity contracts for Abacus",
-  "version": "0.2.3",
+  "version": "0.3.1",
   "dependencies": {
-    "@abacus-network/utils": "^0.2.3",
+    "@abacus-network/utils": "0.3.1",
     "@openzeppelin/contracts": "^4.6.0",
     "@openzeppelin/contracts-upgradeable": "^4.6.0",
     "@summa-tx/memview-sol": "^2.0.0"
@@ -45,7 +45,7 @@
   "repository": "https://github.com/abacus-network/abacus-monorepo",
   "scripts": {
     "build": "hardhat compile && tsc",
-    "clean": "hardhat clean",
+    "clean": "hardhat clean && rm -rf ./dist ./cache",
     "coverage": "hardhat coverage",
     "prettier": "prettier --write ./contracts ./interfaces ./test",
     "test": "hardhat test"

diff --git a/typescript/deploy/.gitignore b/typescript/deploy/.gitignore
diff --git a/typescript/deploy/.prettierignore b/typescript/deploy/.prettierignore
diff --git a/typescript/deploy/package.json b/typescript/deploy/package.json
diff --git a/typescript/deploy/src/index.ts b/typescript/deploy/src/index.ts
diff --git a/typescript/deploy/src/router/index.ts b/typescript/deploy/src/router/index.ts
diff --git a/typescript/deploy/src/utils.ts b/typescript/deploy/src/utils.ts
diff --git a/typescript/deploy/src/verify/index.ts b/typescript/deploy/src/verify/index.ts
diff --git a/typescript/deploy/tsconfig.json b/typescript/deploy/tsconfig.json
diff --git a/typescript/hardhat/.gitignore b/typescript/hardhat/.gitignore
diff --git a/typescript/hardhat/.prettierrc b/typescript/hardhat/.prettierrc
diff --git a/typescript/hardhat/index.ts b/typescript/hardhat/index.ts
diff --git a/typescript/hardhat/package.json b/typescript/hardhat/package.json
diff --git a/typescript/hardhat/tsconfig.json b/typescript/hardhat/tsconfig.json
diff --git a/typescript/infra/config/environments/dev/core.ts b/typescript/infra/config/environments/dev/core.ts
@@ -1,5 +1,4 @@
-import { CoreConfig } from '@abacus-network/deploy';
-import { ChainMap } from '@abacus-network/sdk';
+import { ChainMap, CoreConfig } from '@abacus-network/sdk';
 
 import { DevChains } from './chains';
 

diff --git a/typescript/infra/config/environments/mainnet/core.ts b/typescript/infra/config/environments/mainnet/core.ts
@@ -1,5 +1,4 @@
-import { CoreConfig } from '@abacus-network/deploy';
-import { ChainMap } from '@abacus-network/sdk';
+import { ChainMap, CoreConfig } from '@abacus-network/sdk';
 
 import { MainnetChains } from './chains';
 

diff --git a/typescript/infra/config/environments/test/core.ts b/typescript/infra/config/environments/test/core.ts
@@ -1,5 +1,4 @@
-import { CoreConfig } from '@abacus-network/deploy';
-import { ChainMap } from '@abacus-network/sdk';
+import { ChainMap, CoreConfig } from '@abacus-network/sdk';
 
 import { TestChains } from './chains';