Skip to content

Latest commit

 

History

History
169 lines (137 loc) · 5.42 KB

sandbox.md

File metadata and controls

169 lines (137 loc) · 5.42 KB
Raw

Wanchain Message Bridge Sandbox Guide

1. Introduction

This guide will walk you through the process of setting up a local sandbox environment for the Wanchain Message Bridge. The sandbox environment will allow you to test the bridge without having to deploy your own Wanchain and Ethereum nodes. The sandbox environment will also allow you to test the bridge without having to wait for block confirmations. The sandbox environment is not intended for production use. The sandbox environment is intended for testing and development purposes only.

2. Prerequisites

  • Docker
  • Docker Compose
  • Git
  • Node.js
  • NPM
  • yarn

3. Installation

3.1 Docker and Docker Compose

You have to install docker and docker-compose before use this sandbox environment. You can refer to docker and docker-compose to install them.

For example, install docker and docker-compose on Ubuntu:

$ wget -qO- https://get.docker.com/ | sh
$ sudo usermod -aG docker $USER
$ sudo curl -L "https://github.com/docker/compose/releases/download/v2.20.3/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
$ sudo chmod +x /usr/local/bin/docker-compose

(You may need to re-login your computer to apply the changes.)

Check docker and docker-compose version:

$ docker -v
Docker version 24.0.6, build ed223bc
$ docker-compose -v
Docker Compose version v2.22.0-desktop.2

If you have installed docker and docker-compose, you can see the version of them.

3.2 Node.js and yarn

Install node.js and yarn:

# for Ubuntu
$ sudo apt-get install nodejs
$ sudo apt-get install npm
$ sudo npm install -g yarn

# for macOS
$ brew install node
$ sudo npm install -g yarn

Check node.js and yarn version:

$ node -v
v18.17.1
$ yarn -v
1.22.17

If you have installed node.js and yarn, you can see the version of them.

3.3 Git

Install git from website: git

Check git version:

$ git version
git version 2.37.1 (Apple Git-137.1)

3.4 Clone the repository

Clone the repository:

$ git clone https://github.com/wanchain/message-bridge-contracts.git

3.5 Install dependencies

Install dependencies:

$ cd message-bridge-contracts
$ yarn

4. Run the sandbox environment

Run the sandbox environment:

$ ./sandbox.sh

If you see the information below, it means the sandbox environment is running successfully.

$ ./sandbox.sh

Welcome to Wanchain Message Bridge Sandbox!

Please note: This script requires 'docker' and 'docker-compose' to be pre-installed.

Sandbox Environment Details:
2 Docker containers dedicated to independent EVM blockchains.
1 Docker container hosting an agent for cross-chain execution assistance.

Starting dockers please wait...
Deploying WmbGateway contracts, please wait...

**********************************************
********Sandbox environment is ready!*********
**********************************************

EVM Chain Information:
chain1:
- bip44chainId: 1
- rpc: http://127.0.0.1:18545
- chainId: 8888
- symbol: ETH

chain2:
- bip44chainId: 2
- rpc: http://127.0.0.1:28545
- chainId: 9999
- symbol: ETH

WmbGateway Contract Address: 0xa383F3CDA8E2558AD843A288f468cA5D60ab686f

Mock Cross Chain Token Address: 0xFac60b04D7Ade6de72d655413F5e029073baD621

Built-in Test Account Information:
id	Address						PrivateKey
1)	0x4E8a30f0db26251E992a8937099051F76a517117	0x00856f7a9716aff5f0e52f1832df145967537ddc75864cbdbe9f0a856def2f3f
2)	0x65D6A6b2De385Db524410BE169067A114704D868	0x5f75902136cb4d3943c14cdcf9cbb9f293fdd7e47128e77db539d83492f84eb6
3)	0x139280C8144959673AEc076842Fb1E6c560edE62	0x3e9fff4ef6a895de9c32951a75b52d49371ba050b58eff0b992acc7954428c45
4)	0x98581aEfe58265594aF5f54A5adc4Be0db2704F8	0x6e6dc8e8f58f6829392ba1e00e5fc1a9c6a48abd62d491381d3eeb996599ac02

* Each address has 1,000,000 ETH and MCToken on chain1 and chain2
* Don't use Sandbox built-in test accounts in production!

You can run node ./sandbox/test.js  in another shell window to test the MCT cross-chain in sandbox.

* Press Ctrl+C to terminate and clean up the sandbox environment.

You can use the RPC to connect to the chain1 and chain2.

such as add the sandbox test chain1 and chain2 network to your MetaMask wallet.

The chain1 and chain2 have 1,000,000 ETH in the listed accounts.

You can use the private key to import the account to your MetaMask wallet.

5. Test the Message Bridge in Sandbox

Run the test script to test Sandbox Cross Chain Token transfer powered by Wanchain Message Bridge:

$ node ./sandbox/test.js

If you see the information below, it means the test is running successfully.

$ node sandbox/test.js
Start MC Token cross chain transfer test...
wallet on chain1 MCT balance: 1000000.0
wallet on chain2 MCT balance: 1000000.0
Transfer 100 MCT from chain1 to chain2...
Wait for 5 seconds...
wallet on chain1 MCT balance: 999900.0
wallet on chain2 MCT balance: 1000100.0
Transfer 100 MCT from chain2 to chain1...
Wait for 5 seconds...
wallet on chain1 MCT balance: 1000000.0
wallet on chain2 MCT balance: 1000000.0
done!

6. Deploy your own contracts

The WmbGateway address and bip44chainId information was shown in the information above.

You can use the WmbGateway address and bip44chainId information to deploy your own contracts.

  • P.S. After resetting the sandbox environment, you may need to re-add the MetaMask network in order for block height verification to pass.