Skip to content
Mono repository of Token Bridge (Oracle, UI, Deployment, Monitor). TokenBridge is an interoperability solution between Ethereum networks for native to ERC20 and ERC20 to ERC20 cross chain transfers
Branch: master
Clone or download
Latest commit 26ff22a Jun 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Monorepo initialization (#101) Jun 13, 2019
audit/peppersec Update the token-bridge sub-repo (#19) May 7, 2019
contracts @ bbb97a6 Update Contracts to 2.3.2 (#74) May 27, 2019
deployment Updates after deployment test (#75) May 31, 2019
e2e-commons UI in docker (#102) Jun 14, 2019
monitor Expose stuckTransfer endpoint only if v1 bridge Jun 3, 2019
oracle-e2e Removed obsole e2e deploy scripts (#104) Jun 14, 2019
oracle Merge branch 'master' into fix-coef-for-gaslimit-in-oracle Jun 14, 2019
parity Single parity dockerfile May 21, 2019
ui-e2e Removed obsole e2e deploy scripts (#104) Jun 14, 2019
ui UI in docker (#102) Jun 14, 2019
.coveralls.yml Added Coveralls for UI (#59) May 22, 2019
.dockerignore Ignoring images only in the oracle May 23, 2019
.editorconfig Move .editorconfig to root dir. May 22, 2019
.eslintignore Configured Prettier (#60) May 22, 2019
.eslintrc Configured Prettier (#60) May 22, 2019
.gitignore Updates after deployment test (#75) May 31, 2019
.gitmodules Removed contracts-2.2.0 module May 24, 2019
.nvmrc Consolidated .nvmrc May 22, 2019
.prettierrc Configured Prettier (#60) May 22, 2019
CODE_OF_CONDUCT.md Update the token-bridge sub-repo (#19) May 7, 2019
CONTRIBUTING.md Update the token-bridge sub-repo (#19) May 7, 2019
Dockerfile.e2e UI in docker (#102) Jun 14, 2019
LICENSE Update the token-bridge sub-repo (#19) May 7, 2019
README.md Monorepo initialization (#101) Jun 13, 2019
package.json Monorepo initialization (#101) Jun 13, 2019
yarn.lock Update dependencies (#72) May 25, 2019

README.md

CircleCI Gitter License: LGPL v3.0

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:

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

Initialize submodules, install dependencies, compile the Smart Contracts:

yarn initialize

Linting

Running linter for all JS projects:

yarn lint

Running linter for all Ansible playbooks:

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.

Building, running and deploying

Please refer to the instructions in sub-directories.

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.

References

You can’t perform that action at this time.