tornadocontrib/tokenbridge

Fork 0

rzadp 7607a7fdb1 Readme

2019-06-04 10:28:12 +02:00

5.0 KiB

Raw Blame History

Tokenbridge

Welcome to the POA Token Bridge monorepository!

Please note that this repository as a work in progress.

Overview

The POA Token Bridge 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 Token Bridge functionality, it is useful to explore each subrepository.

Structure

Sub-repositories maintained within this monorepo are listed below.

Sub-repository	Description
Oracle	Oracle responsible for listening to bridge related events and authorizing asset transfers.
UI	DApp interface to transfer tokens and coins between chains.
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
UI-E2E	End to end tests for the UI
E2E-Commons	Common utilities and configuration used in end to end tests

Additionally there are Smart Contracts used to manage bridge validators, collect signatures, and confirm asset relay and disposal.

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 three operational modes:

Native-to-ERC20 Coins on a Home network can be converted to ERC20-compatible tokens on a Foreign network. Coins are locked on the Home side and the corresponding amount of ERC20 tokens are minted on the Foreign side. When the operation is reversed, tokens are burnt on the Foreign side and unlocked in the Home network. More Information: POA-to-POA20 Bridge
ERC20-to-ERC20 ERC20-compatible tokens on the Foreign network are locked and minted as ERC20-compatible tokens (ERC677 tokens) on the Home network. When transferred from Home to Foreign, they are burnt on the Home side and unlocked in the Foreign network. This can be considered a form of atomic swap when a user swaps the token "X" in network "A" to the token "Y" in network "B". More Information: ERC20-to-ERC20
ERC20-to-Native: Pre-existing tokens in the Foreign network are locked and coins are minted in the Home network. 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

Initializing the monorepository

Clone the repository with submodules:

git clone --recursive https://github.com/poanetwork/tokenbridge

# or initialize submodules if already cloned without --recursive option:
git submodule update --init

Install dependencies:

yarn install && yarn install:deploy

Note: The installation should be performed with an unprivileged Linux account or with the following flag: yarn install --unsafe-perm. More information

Compile the Smart Contracts

yarn compile:contracts

Linting

Running linter for all JS projects:

yarn lint

Running linter for all Ansible playbooks:

ansible-lint is required

yarn ansible-lint

Tests

Running tests for all projects:

yarn test

Additionaly there are end-to-end tests for Oracle and UI.

For details on building, running and developing please refer to respective READMEs in sub-repositories.

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.

5.0 KiB Raw Blame History