Webb-Solidity package structure (#65)

This PR changes the project structure to separate packages:

- contracts: types of the latest solidity contracts
- fixed-bridge: Wrapper-classes for anchors, bridges, etc. related to fixed-bridge.
- tokens: Wrapper-classes for token functionality
- utils: Common utilities e.g. toFixedHex and others.
- vbridge: UNIMPLEMENTED, wrapper-classes for anchors, bridges, etc. related to variable bridges.

This PR brings in a dependency on lerna for building and publishing the packages.

This PR updates the root-directory package.json to include:

- yarn build:packages - needs to be run before tests.
- yarn compile - should be run instead of npx hardhat compile as it will run a script to update the src files in the contracts directory of the latest typechain output.

Author: nepoche

.github/workflows/node.js.yml

@@ -29,4 +29,5 @@ jobs:
       - run: git submodule update --init --recursive
       - run: yarn install --production=false
       - run: yarn compile
+      - run: yarn build:packages
       - run: yarn test

.gitignore

@@ -4,10 +4,16 @@ node_modules
 build/
 .env
 
+#Packages
+packages/*/node_modules
+packages/*/lib
+packages/*/tsconfig.tsbuildinfo
+
 #Hardhat files
 cache
 artifacts
 /typechain
+/typechain-types
 /src
 
 dist

lerna.json

@@ -0,0 +1,9 @@
+{
+  "packages": [
+    "packages/*",
+    "examples/*"
+  ],
+  "version": "independent",
+  "useWorkspaces": true,
+  "npmClient": "yarn"
+}

lib/fixed-bridge/index.ts

@@ -1,19 +1,21 @@
 {
-  "name": "webb-solidity",
-  "version": "0.1.7",
-  "main": "index.js",
-  "repository": "https://github.com/webb-tools/protocol-solidity.git",
-  "author": "Webb Technologies",
+  "name": "protocol-solidity",
+  "repository": "git://github.com/webb-tools/protocol-solidity.git",
+  "author": "Webb Developers <[email protected]>",
   "license": "GPL-3.0-or-later",
+  "private": true,
+  "workspaces": [
+    "packages/*"
+  ],
   "scripts": {
-    "compile": "npx hardhat compile",
+    "compile": "npx hardhat compile && sh ./scripts/bash/copyTypechain.sh && yarn build:packages",
     "build": "yarn compile && yarn build:circuits && yarn build:ptau",
     "build:circuits": "./scripts/bash/build_circuits.sh",
+    "build:packages": "lerna run build",
     "build:ptau": "./scripts/bash/generate_phase1_ptau.sh",
-    "prepublishOnly": "tsc && ./scripts/bash/npm/prepublish.sh",
-    "run:deploy-webb": "ts-node ./scripts/evm/webbSystemDeployment.ts",
-    "run:inspect-webb": "ts-node ./scripts/evm/inspectWebbInstance.ts",
-    "run:link-webbs": "ts-node ./scripts/evm/linkAnchors.ts",
+    "clean": "rm -rf artifacts typechain && yarn clean:packages",
+    "clean:packages": "lerna run clean",
+    "publish:packages": "lerna run build && lerna publish",
     "setup:bridge2": "./scripts/bash/groth16/bridge/phase2_poseidon_bridge2.sh",
     "setup:bridge3": "./scripts/bash/groth16/bridge/phase2_poseidon_bridge3.sh",
     "setup:bridge4": "./scripts/bash/groth16/bridge/phase2_poseidon_bridge4.sh",
@@ -34,12 +36,12 @@
     "@types/mocha": "^9.0.0",
     "chai": "^4.3.4",
     "ethereum-waffle": "^3.4.0",
-    "ethers": "^5.3.1",
+    "ethers": "5.5.1",
     "ffiasm": "^0.1.1",
     "ffjavascript": "^0.2.38",
     "ganache-cli": "^6.12.2",
-    "hardhat": "^2.4.1",
-    "snarkjs": "^0.4.10",
+    "hardhat": "^2.6.8",
+    "lerna": "~4.0.0",
     "solparse": "^2.2.8",
     "truffle-assertions": "^0.9.2",
     "web3": "^1.3.6",
@@ -66,8 +68,8 @@
     "maci-domainobjs": "^0.9.1",
     "prettier": "^2.3.2",
     "prettier-plugin-solidity": "^1.0.0-beta.18",
+    "snarkjs": "^0.4.10",
     "ts-node": "^10.1.0",
     "typechain": "^5.1.2"
-  },
-  "files": ["src/**/*"]
+  }
 }