Skip to content
This repository has been archived by the owner on Nov 5, 2023. It is now read-only.

Latest commit

 

History

History
140 lines (90 loc) · 4.88 KB

remote_development.md

File metadata and controls

140 lines (90 loc) · 4.88 KB
Raw

Remote Development

These steps will setup this repo on your machine for targeting a remote chain, such as an EVM compatible L2. If you would like to target a local network instead, follow the steps outlined in Local Development.

If you're running a Windows machine, we recommend using WSL2.

Dependencies

Required

Optional (Recommended)

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

Deploy Contracts

Deployer account

BLS Wallet contract deploys use CREATE2 to maintain consistent addresses across networks. As such, a create2 deployer contract is used and listed in ./contracts/.env under the environment variables DEPLOYER_MNEMONIC & DEPLOYER_SET_INDEX. The hierarchical deterministic (HD) wallet address will need to be funded in order to deploy the contracts.

If you do not need consistent addresses, for example on a local or testnet network, you can replace the DEPLOYER_MNEMONIC with another seed phrase which already has a funded account.

Update hardhat.config.ts

If your network is not listed in hardhat.config.ts, you will need to add it.

Precompile Cost Estimator

If your network does not already have an instance of the BNPairingPrecompileCostEstimator contract, you will need to deploy that.

cd ./contracts
yarn hardhat run scripts/0_deploy_precompile_cost_estimator.ts --network YOUR_NETWORK

Copy the address that is output.

Update ./contracts/contracts/lib/hubble-contracts/contracts/libs/BLS.sol's COST_ESTIMATOR_ADDRESS to the value of that address if it is different:

...
address private constant COST_ESTIMATOR_ADDRESS = YOUR_NETWORKS_PRECOMPILE_COST_ESTIMATOR_ADDRESS;
...

Remaining Contracts

Deploy all remaining bls-wallet contracts.

cd ./contracts # if not already there
yarn hardhat run scripts/deploy_all.ts --network YOUR_NETWORK

A network config file will be generated at ./contracts/networks/local.json. You should rename it to match your network.

mv ./networks/local.json ./networks/your-network.json

This file can be committed so others can use your deployed contracts.

Aggregator

The aggregator is a service that accepts transaction bundles (including those that contain a single transaction) and submits aggregations of these bundles to L2.

cd ./aggregator
cp .env.example .env

if you are using different network, update the following values in ./aggregator/.env.

RPC_URL=https://your.network.rpc
...
NETWORK_CONFIG_PATH=../contracts/networks/your-network.json
PRIVATE_KEY_AGG=PK0
PRIVATE_KEY_ADMIN=PK1
...

Note: The .env file in the aggregator needs to be updated everytime the network changes from local to remote and vice-versa.

PRIVATE_KEY_AGG & PRIVATE_KEY_ADMIN are private keys for funded accounts on your network/chain. See the aggregator environment variables table for a detailed breakdown of each env property.

Extension

The extension (otherwise referred to as Quill) is a prototype extension wallet used to showcase and test BLS Wallet features. Note it is not a production wallet.

Check the config.json file to see if your network is already added. If not, you will need to add the relevant properties for your network/chain. These changes can be committed.

You now have all the main components setup to begin remote development.

Example: Arbitrum Goerli Testnet

You will need two ETH addresses with Abitrum Goerli ETH and their private keys (PRIVATE_KEY_AGG & PRIVATE_KEY_ADMIN) for running the aggregator. It is NOT recommended that you use any primary wallets with ETH Mainnet assets.

You can get Goerli ETH at https://goerlifaucet.com/ or https://app.mycrypto.com/faucet, and transfer it into the Arbitrum testnet via https://bridge.arbitrum.io/. Make sure when doing so that your network is set to Goerli in your web3 wallet extension, such as MetaMask.

Update these values in ./aggregator/.env.

RPC_URL=https://goerli-rollup.arbitrum.io/rpc
...
NETWORK_CONFIG_PATH=../contracts/networks/arbitrum-goerli.json
PRIVATE_KEY_AGG=PK0
PRIVATE_KEY_ADMIN=PK1
...

And then ensure the defaultNetwork value in ./extension/config.json is set to arbitrum-goerli.

...
"defaultNetwork": "arbitrum-goerli",
...