Skip to content

Latest commit

 

History

History
109 lines (80 loc) · 2.77 KB

local_development.md

File metadata and controls

109 lines (80 loc) · 2.77 KB
Raw

Local Development

These steps will setup this repo on your machine for local development for the majority of the components in this repo. If you would like to target a remote network instead, add the addtional steps in Remote Development as well.

Dependencies

Required

Optional (Recomended)

Setup

Install the latest Node 16. If using nvm to manage node versions, run this in the root directory:

nvm install

Run the repo setup script

./setup.ts

Then choose to target either a local Hardhat node or the Arbitrum Testnet.

Chain (RPC Node)

Start a local Hardhat node for RPC use.

cd ./contracts
yarn hardhat node

Contracts

Fund the create2Deployer.

yarn hardhat fundDeployer --network gethDev

Deploy all bls-wallet contracts.

yarn hardhat run scripts/deploy_all.ts --network gethDev

Run

docker-compose up -d postgres # Or see local postgres instructions in ./aggregator/README.md#PostgreSQL
cd ./aggregator
./programs/aggregator.ts

In a seperate terminal/shell instance

cd ./extension
yarn run dev:chrome # or dev:firefox, dev:opera

Chrome

  1. Go to Chrome's extension page.
  2. Enable Developer mode.
  3. Either click Load unpacked extension... and select ./extension/extension/chrome or drag that folder into the page.

Firefox

  1. Go to Firefox's debugging page.
  2. Click Load Temporary Add-on....
  3. Select ./extension/extension/firefox/manifest.json.

Tests

See each components README.md for how to run tests.

Testing/using updates to ./clients

extension

cd ./contracts/clients
yarn build
yarn link
cd ../extension
yarn link bls-wallet-clients

aggregator

You will need to push up an @experimental version to 'bls-wallet-clients' on npm and update the version in ./aggregtor/src/deps.ts until a local linking solution for deno is found. See esm-dev/esm.sh#216 for details. You will need write access to the npmjs project to do this. You can request access or request one of the BLS Wallet project developers push up your client changes in the Discussions section of this repo.

In ./contracts/clients with your changes:

yarn publish-experimental

Note the x.y.z-abc1234 version that was output.

Then in ./aggregtor/deps.ts, change all from references for that package.

...
} from "https://esm.sh/bls-wallet-clients@x.y.z-abc1234";
...