tokenbridge/deployment-bridge/README.md
Przemyslaw Rzad 0447dd1a78
Add deployment bridge sub-repository (#25)
* Added deployment-bridge from tags/1.0.0

* Removed Contributing, Licence, Code of Conduct, updated links in readme.
2019-05-08 13:51:56 +02:00

2.6 KiB

Ansible playbooks for deploying cross-chain bridges

Bridge Overview

The POA Bridge allows users to transfer assets between two chains in the Ethereum ecosystem. It is composed of several elements which are located in different POA Network repositories:

Bridge Elements

  1. Deployment Playbooks. Configuration management instructions for validator nodes contained in this repository.
  2. Bridge Smart Contracts. Solidity contracts used to manage bridge validators, collect signatures, and confirm asset relay and disposal.
  3. Token Bridge. The token bridge oracle written in NodeJS.
  4. Bridge UI Application. A DApp interface to transfer tokens and coins between chains.
  5. Bridge Monitor. A tool for checking balances and unprocessed events in bridged networks.

Playbooks Overview

These playbooks are designed to automate the deployment process for cross-chain bridges on bridge validator nodes. This process installs the bridge as a service and sets .env configurations on a remote server. Playbooks for the current token-bridge deployment are located in the bridge-nodejs folder.

Rust Bridge Playbooks

The Rust bridge is not currently in production, but an Ansible playbook is developed for this implementation. It is available in the upgradable-wo-parityfolder.

Dependencies

The playbooks automatically install Docker, docker-compose, Python, Gitand it dependencies (such as curl, ca-certificates, apt-transport-https, etc.). Install Ansible to launch playbooks.

Configuration

Please see the bridge-nodejs README for configuration and execution details.

Bridge service commands

The Bridge service is named poabridge. Use the default SysVinit commands to start, stop, restart, and rebuild the service and to check the status of the service.

Commands format:

sudo service poabridge [start|stop|restart|status|rebuild]

Contributing

See the CONTRIBUTING document for contribution, testing and pull request protocol.

License

License: LGPL v3.0

This project is licensed under the GNU Lesser General Public License v3.0. See the LICENSE file for details.