Skip to content

Latest commit

 

History

History
201 lines (132 loc) · 6.58 KB

README.md

File metadata and controls

201 lines (132 loc) · 6.58 KB
Raw

Webb Hubble Bridge

Private cross-chain bridge for digital assets

Run Hubble Bridge

Once the development environment is set up, you may proceed to install the required dependencies and run the dapp locally.

  1. Clone this repo

    git clone git@github.com:webb-tools/webb-dapp.git

  2. Install dependencies by yarn

    yarn install

  3. Start the bridge-dapp:

    yarn start:bridge

Visit http://localhost:3000/ to see the Webb Bridge Dapp UI!

Run local Webb relayer and local network alongside Hubble bridge

To make local development and testing easier we can run a local EVM network and a local Webb relayer. In doing so, we will have access to a large supply of test tokens, access to both relayer and network logs to observe any unexpected issues during development. To accomplish this follow the below instructions.

Setting up local testnet

Before setting up a local testnet, we first need to clear our local storage in the browser for dApp to work correctly with our local evm testnet.

1. Clear local storage in the browser

Next, we will open a separate terminal window and execute the following instructions. For more in-depth the Orbit setup please refer to the README.md

2. Clone the orbit repo

git clone https://github.com/webb-tools/orbit
cd orbit

3. Start the network using Docker

You can follow the instructions here to install Docker on your machine. Then run the following command to start the network:

docker compose up

to stop the network run:

docker compose down

⚠️ NOTE: If you already ran the network before, you may need to remove the old data and logs before starting the network again. To do so, run the following commands:

rm -rf data logs

4. Open a new window and navigate to the deploy directory

cd deploy

5. Populate fixtures

⚠️ NOTE: Prerequisites for fetching fixtures is to have dvc installed locally. You can view installation instructions here. For macos it is recommended to install using pip install dvc.

yarn dvc:pull

6. Install the npm dependencies for running deploy scripts

yarn install

7. Run the deploy script and faucet script

Run the deploy script to deploy the contracts to the local running network.

yarn deploy --deployWeth --allowWrappingNativeToken --allowWrappingNativeToken

Run the faucet script to send test tokens to your account (replace the recipient address with your own address and the erc20Address with the address of the ERC20 token you want to send)

yarn faucet --recipients="YOUR_WALLET_ADDRESS" --nativeTokenAmount=1000 --erc20Address="DEPLOYED_ERC20_ADDRESS" --erc20Amount=1000

Great! Now you have a running local EVM test network.

⚠️️ Note: After deploying the contracts, maybe you need to restart the bridge-dapp and update the environment variables in the .env file with the deployed contract addresses and deploy block number.

Setting up local relayer

To make use of a local relayer we will open a separate terminal window and execute the following instructions. For more in-depth relayer setup please refer to the relayer README.md

1. Clone the relayer repo

git clone https://github.com/webb-tools/relayer
cd relayer

2. Compile the relayer

cargo build --release --features cli

3. Setup .env file

You will need to add .env file to run the Webb relayer.

touch .env

Then update with the following values:

# EVM LOCAL NET
GOVERNOR_PRIVATE_KEY=0x0000000000000000000000000000000000000000000000000000000000000001

WEBB_EVM_ATHENA_ENABLED=true
WEBB_EVM_DEMETER_ENABLED=true
WEBB_EVM_HERMES_ENABLED=true

ATHENA_PRIVATE_KEY=0x0000000000000000000000000000000000000000000000000000000000000001
HERMES_PRIVATE_KEY=0x0000000000000000000000000000000000000000000000000000000000000001
DEMETER_PRIVATE_KEY=0x0000000000000000000000000000000000000000000000000000000000000001

ATHENA_HTTP_URL=http://127.0.0.1:5005
DEMETER_HTTP_URL=http://127.0.0.1:5006
HERMES_HTTP_URL=http://127.0.0.1:5004
ATHENA_WS_URL=wss://127.0.0.1:5005
DEMETER_WS_URL=wss://127.0.0.1:5006
HERMES_WS_URL=wss://127.0.0.1:5004

4. Run a local relayer

./target/release/webb-relayer -c config/development/evm-localnet/ -vv

Great! Now you have a running local relayer.

We now have our local environment running, next we will want to setup our MetaMask wallet to add test tokens and reset the account on Metamask to reset the account’s nonce and tx history. Please refer to the support article here for instructions on how to reset a MetaMask account.

Lastly, we will want to one of the following accounts to obtain test tokens.

// Any of these keys has 1000 ETH on each testnet
0x0000000000000000000000000000000000000000000000000000000000000001
0x0000000000000000000000000000000000000000000000000000000000000002
0xc0d375903fd6f6ad3edafc2c5428900c0757ce1da10e5dd864fe387b32b91d7e

If you are unfamiliar with how to import an account with MetaMask, please refer to the support article here.

You have now successfully setup:

  • local evm test network
  • local Webb relayer
  • local Hubble bridge
  • configured your MetaMask wallet for testing / development

Happy hacking!

Need help?

If you need help or you want to additional information please: