Tokenbridge
Welcome to the POA TokenBridge monorepository!
Please note that this repository as a work in progress.
Overview
The POA TokenBridge allows users to transfer assets between two chains in the Ethereum ecosystem. It is composed of several elements which are contained within this monorepository.
For a complete picture of the POA TokenBridge functionality, it is useful to explore each subrepository.
Structure
Sub-repositories maintained within this monorepo are listed below.
| Sub-repository | Description |
|---|---|
| Oracle | Responsible for listening to bridge related events and authorizing asset transfers. |
| Monitor | Tool for checking balances and unprocessed events in bridged networks. |
| Deployment | Ansible playbooks for deploying cross-chain bridges. |
| Oracle-E2E | End to end tests for the Oracle |
| Monitor-E2E | End to end tests for the Monitor |
| Deployment-E2E | End to end tests for the Deployment |
| Commons | Interfaces, constants and utilities shared between the sub-repositories |
| E2E-Commons | Common utilities and configuration used in end to end tests |
| ALM | DApp interface tool for AMB Live Monitoring |
| Burner-wallet-plugin | TokenBridge Burner Wallet 2 Plugin |
Additionally there are Smart Contracts used to manage bridge validators, collect signatures, and confirm asset relay and disposal.
Available deployments
| Launched by POA | Launched by 3rd parties |
|---|---|
| POA20 Bridge | Ocean TokenBridge |
| xDai Bridge | Thunder bridge |
| WETC Bridge | Volta TokenBridge & DAI bridge to Volta Chain |
| Artis Brige | |
| Tenda bridge & xDai-to-Tenda bridge |
Network Definitions
Bridging occurs between two networks.
-
Home - or Native - is a network with fast and inexpensive operations. All bridge operations to collect validator confirmations are performed on this side of the bridge.
-
Foreign can be any chain; generally it refers to the Ethereum mainnet.
Operational Modes
The POA TokenBridge provides four operational modes:
-
ERC20-to-Native: Pre-existing tokens in the Foreign network are locked and coins are minted in theHomenetwork. In this mode, the Home network consensus engine invokes Parity's Block Reward contract to mint coins per the bridge contract request. More Information: xDai Chain -
Arbitrary-Message: Transfer arbitrary data between two networks as so the data could be interpreted as an arbitrary contract method invocation.
Initializing the monorepository
Clone the repository:
git clone https://github.com/poanetwork/tokenbridgeIf there is no need to build docker images for the TokenBridge components (oracle, monitor), initialize submodules, install dependencies, compile the Smart Contracts:
yarn initialize
Then refer to the corresponding README files to get information about particular TokenBridge component.
Linting
Running linter for all JS projects:
yarn lint
Tests
Running tests for all projects:
yarn test
Additionally there are end-to-end tests for Oracle and Monitor.
For details on building, running and developing please refer to respective READMEs in sub-repositories.
Building, running and deploying
Please refer to the instructions in sub-directories. Configuration details are available here.
Contributing
See the CONTRIBUTING document for contribution, testing and pull request protocol.
License
This project is licensed under the GNU Lesser General Public License v3.0. See the LICENSE file for details.