tornadocontrib/tokenbridge
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Cosistent TokenBridge naming (#159)

Browse Source
This commit is contained in:
Przemyslaw Rzad 2019-07-19 09:18:51 +02:00 committed by GitHub
parent 82a3bdd86b
commit 110b9accc9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -3,15 +3,15 @@
[![License: LGPL v3.0](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) [![License: LGPL v3.0](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
# Tokenbridge # Tokenbridge
Welcome to the **POA Token Bridge** monorepository! Welcome to the **POA TokenBridge** monorepository!
Please note that this repository as a **work in progress**. Please note that this repository as a **work in progress**.
## Overview ## 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. 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 Token Bridge functionality, it is useful to explore each subrepository. For a complete picture of the POA TokenBridge functionality, it is useful to explore each subrepository.
## Structure ## Structure
@ -35,9 +35,9 @@ Additionally there are [Smart Contracts](https://github.com/poanetwork/poa-bridg
| **Launched by POA** | **Launched by 3rd parties** | | **Launched by POA** | **Launched by 3rd parties** |
| ---------- | ---------- | | ---------- | ---------- |
| [POA20 Bridge](https://bridge.poa.net/) | [Ocean Token Bridge](https://bridge.oceanprotocol.com/) | | [POA20 Bridge](https://bridge.poa.net/) | [Ocean TokenBridge](https://bridge.oceanprotocol.com/) |
| [xDai Bridge](https://dai-bridge.poa.network/) | [Thunder bridge](https://ui.stormdapps.com/) | | [xDai Bridge](https://dai-bridge.poa.network/) | [Thunder bridge](https://ui.stormdapps.com/) |
| [WETC Bridge](https://wetc.app/) | [Volta Token Bridge](https://vt.volta.bridge.eth.events/) & [DAI bridge to Volta Chain](https://dai.volta.bridge.eth.events/) | | [WETC Bridge](https://wetc.app/) | [Volta TokenBridge](https://vt.volta.bridge.eth.events/) & [DAI bridge to Volta Chain](https://dai.volta.bridge.eth.events/) |
| | [Artis Brige](https://bridge.artis.network/) | | | [Artis Brige](https://bridge.artis.network/) |
| | [Tenda bridge](https://bridge-mainnet.tenda.network) & [xDai-to-Tenda bridge](https://bridge-xdai.tenda.network/) | | | [Tenda bridge](https://bridge-mainnet.tenda.network) & [xDai-to-Tenda bridge](https://bridge-xdai.tenda.network/) |

2
commons/README.md
View File

@ -1,2 +1,2 @@
# POA Token Bridge / Commons # POA TokenBridge / Commons
Interfaces, constants and utilities shared between the sub-repositories Interfaces, constants and utilities shared between the sub-repositories

8
deployment/CONFIGURATION.md
View File

@ -1,4 +1,4 @@
# POA Token Bridge / Deployment Configuration # POA TokenBridge / Deployment Configuration
Please see the [Oracle](../oracle/README.md) for additional configuration and execution details. Please see the [Oracle](../oracle/README.md) for additional configuration and execution details.
@ -85,13 +85,13 @@ Example config for installing only UI:
2. You can also add the following parameters in the `group_vars` to change the default behavior of the playbooks: 2. You can also add the following parameters in the `group_vars` to change the default behavior of the playbooks:
2.1 `compose_service_user` - specifies the user created by the playbooks. This user runs the Token Bridge Oracle. 2.1 `compose_service_user` - specifies the user created by the playbooks. This user runs the TokenBridge Oracle.
2.2 `bridge_repo` contains the address of the Token Bridge Oracle repository. The default value is https://github.com/poanetwork/tokenbridge. 2.2 `bridge_repo` contains the address of the TokenBridge Oracle repository. The default value is https://github.com/poanetwork/tokenbridge.
2.3 `bridge_repo_branch` points to the specific branch or commit to use with the `bridge_repo`. If `bridge_repo_branch` is not specified, the default (`master`) branch is used. 2.3 `bridge_repo_branch` points to the specific branch or commit to use with the `bridge_repo`. If `bridge_repo_branch` is not specified, the default (`master`) branch is used.
2.4 `bridge_path` sets the path where the Token Bridge Oracle is installed. By default, it points. to the home folder of `compose_service_user` 2.4 `bridge_path` sets the path where the TokenBridge Oracle is installed. By default, it points. to the home folder of `compose_service_user`
2.5 `docker_compose_version` - specifies a version of docker-compose to be installed. 2.5 `docker_compose_version` - specifies a version of docker-compose to be installed.

2
deployment/EXECUTION.md
View File

@ -1,4 +1,4 @@
# POA Token Bridge / Deployment Execution # POA TokenBridge / Deployment Execution
Please refer to the [Configuration](./CONFIGURATION.md) first. Please refer to the [Configuration](./CONFIGURATION.md) first.

4
deployment/README.md
View File

@ -1,8 +1,8 @@
# POA Token Bridge / Deployment # POA TokenBridge / Deployment
Ansible playbooks for deploying cross-chain bridges. Ansible playbooks for deploying cross-chain bridges.
## Overview ## Overview
Please refer to the [POA Token Bridge](../README.md) overview first of all. Please refer to the [POA TokenBridge](../README.md) overview first of all.
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. 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.

2
deployment/molecule/TESTING.md
View File

@ -1,4 +1,4 @@
# POA Token Bridge / Deployment Testing # POA TokenBridge / Deployment Testing
The deployment playbooks are tested using [Molecule](https://molecule.readthedocs.io). The deployment playbooks are tested using [Molecule](https://molecule.readthedocs.io).

2
e2e-commons/README.md
View File

@ -1,4 +1,4 @@
# POA Token Bridge / E2E-Commons # POA TokenBridge / E2E-Commons
Common scripts and configuration for the end-to-end tests. Common scripts and configuration for the end-to-end tests.

4
monitor-e2e/README.md
View File

@ -1,6 +1,6 @@
# POA Token Bridge / Monitor-E2E # POA TokenBridge / Monitor-E2E
End to end tests for the POA Token Bridge [Monitor](../monitor/README.md). End to end tests for the POA TokenBridge [Monitor](../monitor/README.md).
## Running ## Running

6
monitor/README.md
View File

@ -1,12 +1,12 @@
# POA Token Bridge / Monitor # POA TokenBridge / Monitor
Tool for checking balances and unprocessed events in bridged networks. Tool for checking balances and unprocessed events in bridged networks.
## Overview ## Overview
Please refer to the [POA Token Bridge](../README.md) overview first of all. Please refer to the [POA TokenBridge](../README.md) overview first of all.
- Deployed version: https://bridge-monitoring.poa.net/ - Deployed version: https://bridge-monitoring.poa.net/
This tool allows you to spin up a NODE.JS server to monitor for health of the Token Bridge contracts: check for the balance difference, discover inconsistency in the validators list, catch unhandled transactions. This tool allows you to spin up a NODE.JS server to monitor for health of the TokenBridge contracts: check for the balance difference, discover inconsistency in the validators list, catch unhandled transactions.
## Examples ## Examples

4
oracle-e2e/README.md
View File

@ -1,6 +1,6 @@
# POA Token Bridge / Oracle-E2E # POA TokenBridge / Oracle-E2E
End to end tests for the POA Token Bridge [Oracle](../oracle/README.md). End to end tests for the POA TokenBridge [Oracle](../oracle/README.md).
## Prerequisites ## Prerequisites

4
oracle/README.md
View File

@ -1,8 +1,8 @@
# POA Token Bridge / Oracle # POA TokenBridge / Oracle
Oracle responsible for listening to bridge related events and authorizing asset transfers. Oracle responsible for listening to bridge related events and authorizing asset transfers.
## Overview ## Overview
Please refer to the [POA Token Bridge](../README.md) overview first of all. Please refer to the [POA TokenBridge](../README.md) overview first of all.
The Oracle is deployed on specified validator nodes (only nodes whose private keys correspond to addresses specified in the smart contracts) in the network. It connects to two chains via a Remote Procedure Call (RPC) and is responsible for: The Oracle is deployed on specified validator nodes (only nodes whose private keys correspond to addresses specified in the smart contracts) in the network. It connects to two chains via a Remote Procedure Call (RPC) and is responsible for:
- listening to events related to bridge contracts - listening to events related to bridge contracts

2
package.json
View File

@ -1,7 +1,7 @@
{ {
"name": "tokenbridge", "name": "tokenbridge",
"version": "0.0.1", "version": "0.0.1",
"description": "Monorepository for token bridge", "description": "Monorepository for TokenBridge",
"repository": "https://github.com/poanetwork/tokenbridge.git", "repository": "https://github.com/poanetwork/tokenbridge.git",
"author": "rzadp <przemek@ethworks.io>", "author": "rzadp <przemek@ethworks.io>",
"license": "MIT", "license": "MIT",

4
ui-e2e/README.md
View File

@ -1,6 +1,6 @@
# POA Token Bridge / UI-E2E # POA TokenBridge / UI-E2E
End to end tests for the POA Token Bridge [UI](../UI/README.md). End to end tests for the POA TokenBridge [UI](../UI/README.md).
- Configure startURL, homeAccount, foreignAccount in ```config.json``` - Configure startURL, homeAccount, foreignAccount in ```config.json```

6
ui/README.md
View File

@ -1,10 +1,10 @@
[![Coverage Status](https://coveralls.io/repos/github/poanetwork/tokenbridge/badge.svg?branch=master)](https://coveralls.io/github/poanetwork/tokenbridge?branch=master) [![Coverage Status](https://coveralls.io/repos/github/poanetwork/tokenbridge/badge.svg?branch=master)](https://coveralls.io/github/poanetwork/tokenbridge?branch=master)
# POA Token Bridge / UI # POA TokenBridge / UI
DApp interface to transfer tokens and coins between chains. DApp interface to transfer tokens and coins between chains.
## Overview ## Overview
Please refer to the [POA Token Bridge](../README.md) overview first of all. Please refer to the [POA TokenBridge](../README.md) overview first of all.
The UI provides an intuitive interface for assets transfer between networks running the Bridge smart contracts. Users can connect to a web3 wallet such as [Nifty Wallet](https://github.com/poanetwork/nifty-wallet) or [MetaMask](https://metamask.io/) and complete the transfer through a web browser. The UI provides an intuitive interface for assets transfer between networks running the Bridge smart contracts. Users can connect to a web3 wallet such as [Nifty Wallet](https://github.com/poanetwork/nifty-wallet) or [MetaMask](https://metamask.io/) and complete the transfer through a web browser.
@ -88,7 +88,7 @@ The following is an example setup using the POA Sokol testnet as the Home networ
* `FOREIGN_RPC_URL`=https://kovan.infura.io/mew * `FOREIGN_RPC_URL`=https://kovan.infura.io/mew
* When deployment is finished, check that the `bridgeDeploymentResults.json` file exists in the `poa-bridge-contracts/deploy` directory and includes the bridge contract addresses. * When deployment is finished, check that the `bridgeDeploymentResults.json` file exists in the `poa-bridge-contracts/deploy` directory and includes the bridge contract addresses.
5. Install and run the Token Bridge Oracle. 5. Install and run the TokenBridge Oracle.
* Go to the `sokol-kovan-bridge` folder * Go to the `sokol-kovan-bridge` folder
* [Initialize](../README.md#initializing-the-monorepository) the monorepository * [Initialize](../README.md#initializing-the-monorepository) the monorepository
* Go to `oracle` sub-repository * Go to `oracle` sub-repository