Merge pull request #636 from thehubbleproject/feature/fee-receiver-script

Token & FeeRecievers Scripts

Author: jacque006

README.md

@@ -41,7 +41,11 @@ Users can onboard accounts to Hubble without going through L1. The coordinator c
 
 ## Local Development
 
-See [Setup](./SETUP.md) instructions
+[Local Development Setup](./docs/setup/LOCAL_DEVELOPMENT.md)
+
+## Node Operator
+
+[Node Operator](./docs/setup/NODE_OPERATOR.md)
 
 ## Docker
 

SETUP.md renamed to docs/setup/LOCAL_DEVELOPMENT.md

@@ -0,0 +1,50 @@
+# Setup for Node Operators
+
+## Deps
+
+- [NodeJS](https://nodejs.org/en/download/)
+- (Recommended instead of NodeJS) [nvm](https://github.com/nvm-sh/nvm#installing-and-updating)
+
+### install & generate
+
+```sh
+npm ci && npm run generate
+```
+
+## Deploy a new Hubble network
+
+Skip if you're going to join an existing network
+
+```sh
+# See ./scripts/deploy.ts for additional options
+npm run deploy -- \
+    --url https://your.eth.provider:8545 \
+    --key PRIVATE_KEY_HEX
+```
+
+## Setup fee recievers
+
+Skip if you only need a syncing node.
+
+This script will register your public key and setup the states where your proposer will recieve fees when active. 
+
+Note that a proposer will need to be active on the hubble network you are joining in order to to create (pack) the new states/deposits. You may also need to create additional deposits (using the contract `DepositManager.sol:depositFor`) so that the proposer has enough deposits to pack.
+
+```sh
+# See ./scripts/feeReceivers.ts for additional options
+npm run feeReceivers -- \
+    --url https://your.eth.provider:8545 \
+    --key PRIVATE_KEY_HEX
+    --genesisPath ./genesis.json
+    --configPath ./your-node-config.json
+```
+
+## Run node
+
+```
+npm run node -- --configPath ./your-node-config.json
+```
+
+## Docker/container
+
+TODO

docs/setup/NODE_OPERATOR.md

@@ -3,6 +3,7 @@
   "version": "0.1.0",
   "description": "",
   "scripts": {
+    "node": "ts-node --files ./ts/client",
     "dev": "ts-node --files ./ts/client --configPath config.local.json",
     "repl": "ts-node --files ./scripts/repl.ts",
     "test": "hardhat test",
@@ -12,8 +13,9 @@
     "generate": "hardhat compile && typechain --target ethers-v5 './artifacts/contracts/**/!(*.dbg).json'",
     "compile": "hardhat compile",
     "tsc": "tsc",
-    "node": "hardhat node",
+    "hardhat:node": "hardhat node",
     "deploy": "ts-node --files ./scripts/deploy.ts",
+    "feeReceivers": "ts-node --files ./scripts/feeReceivers.ts",
     "keyless:check": "ts-node --files ./scripts/keyless.ts --check",
     "keyless:deploy": "ts-node --files ./scripts/keyless.ts --deploy",
     "deposit": "ts-node --files ./scripts/deposit.ts",
@@ -57,7 +59,7 @@
   "dependencies": {
     "@godaddy/terminus": "^4.9.0",
     "bn.js": "^5.2.0",
-    "ethers": "5.4.0",
+    "ethers": "5.4.3",
     "fastify": "^3.18.0",
     "level": "^7.0.0",
     "lodash": "^4.17.21",

package-lock.json

@@ -2,10 +2,11 @@ import { ethers } from "ethers";
 import minimist from "minimist";
 import { deployAndWriteGenesis } from "../ts/deploy";
 import { DeploymentParameters } from "../ts/interfaces";
-import fs from "fs";
 import { PRODUCTION_PARAMS } from "../ts/constants";
 import { StateTree } from "../ts/stateTree";
 import { Group } from "../ts/factory";
+import * as mcl from "../ts/mcl";
+import { readJSON } from "../ts/file";
 
 const { url, root, key, input, output, numPubkeys, pubkeyMnemonic } = minimist(
     process.argv.slice(2),
@@ -54,6 +55,7 @@ function getDefaultGenesisRoot(parameters: DeploymentParameters) {
 
 async function main() {
     validateArgv();
+    await mcl.init();
 
     const provider = new ethers.providers.JsonRpcProvider(
         url ?? "http://localhost:8545"
@@ -62,9 +64,7 @@ async function main() {
         ? new ethers.Wallet(key).connect(provider)
         : provider.getSigner();
 
-    const parameters = input
-        ? JSON.parse(fs.readFileSync(input).toString())
-        : PRODUCTION_PARAMS;
+    const parameters = input ? await readJSON(input) : PRODUCTION_PARAMS;
 
     parameters.GENESIS_STATE_ROOT = root || getDefaultGenesisRoot(parameters);
     console.log("Deploy with parameters", parameters);