Updated links to new repo with tokenbridge contracts (#226)
This commit is contained in:
parent
1564ccc580
commit
f6fa83d7ea
2
.gitmodules
vendored
2
.gitmodules
vendored
@ -1,3 +1,3 @@
|
|||||||
[submodule "contracts"]
|
[submodule "contracts"]
|
||||||
path = contracts
|
path = contracts
|
||||||
url = https://github.com/poanetwork/poa-bridge-contracts.git
|
url = https://github.com/poanetwork/tokenbridge-contracts.git
|
||||||
|
@ -30,7 +30,7 @@ Sub-repositories maintained within this monorepo are listed below.
|
|||||||
| [Commons](commons/README.md) | Interfaces, constants and utilities shared between the sub-repositories |
|
| [Commons](commons/README.md) | Interfaces, constants and utilities shared between the sub-repositories |
|
||||||
| [E2E-Commons](e2e-commons/README.md) | Common utilities and configuration used in end to end tests |
|
| [E2E-Commons](e2e-commons/README.md) | Common utilities and configuration used in end to end tests |
|
||||||
|
|
||||||
Additionally there are [Smart Contracts](https://github.com/poanetwork/poa-bridge-contracts) used to manage bridge validators, collect signatures, and confirm asset relay and disposal.
|
Additionally there are [Smart Contracts](https://github.com/poanetwork/tokenbridge-contracts) used to manage bridge validators, collect signatures, and confirm asset relay and disposal.
|
||||||
|
|
||||||
## Available deployments
|
## Available deployments
|
||||||
|
|
||||||
|
@ -53,7 +53,7 @@ For more information on the Redis/RabbitMQ requirements, see [#90](/../../issues
|
|||||||
|
|
||||||
**Note:** The following steps detail the bridge deployment process for development and testing. For deployment in a production environment we recommend using the [Bridge Deployment Playbooks](../deployment/README.md).
|
**Note:** The following steps detail the bridge deployment process for development and testing. For deployment in a production environment we recommend using the [Bridge Deployment Playbooks](../deployment/README.md).
|
||||||
|
|
||||||
1. [Deploy the bridge contracts](https://github.com/poanetwork/poa-bridge-contracts/blob/master/deploy/README.md)
|
1. [Deploy the bridge contracts](https://github.com/poanetwork/tokenbridge-contracts/blob/master/deploy/README.md)
|
||||||
|
|
||||||
2. Open `bridgeDeploymentResults.json` or copy the JSON output generated by the bridge contract deployment process.
|
2. Open `bridgeDeploymentResults.json` or copy the JSON output generated by the bridge contract deployment process.
|
||||||
|
|
||||||
@ -232,10 +232,10 @@ When running the processes, the following commands can be used to test functiona
|
|||||||
| `USER_ADDRESS` | An account - the current owner of coins/tokens. |
|
| `USER_ADDRESS` | An account - the current owner of coins/tokens. |
|
||||||
| `USER_ADDRESS_PRIVATE_KEY` | A private key belonging to the account. |
|
| `USER_ADDRESS_PRIVATE_KEY` | A private key belonging to the account. |
|
||||||
| `COMMON_HOME_BRIDGE_ADDRESS` | Address of the bridge in the Home network to send transactions. |
|
| `COMMON_HOME_BRIDGE_ADDRESS` | Address of the bridge in the Home network to send transactions. |
|
||||||
| `HOME_MIN_AMOUNT_PER_TX` | Value (in _eth_ or tokens) to be sent in one transaction for the Home network. This should be greater than or equal to the value specified in the `poa-bridge-contracts/deploy/.env` file. The default value in that file is 500000000000000000, which is equivalent to 0.5. |
|
| `HOME_MIN_AMOUNT_PER_TX` | Value (in _eth_ or tokens) to be sent in one transaction for the Home network. This should be greater than or equal to the value specified in the `tokenbridge-contracts/deploy/.env` file. The default value in that file is 500000000000000000, which is equivalent to 0.5. |
|
||||||
| `HOME_TEST_TX_GAS_PRICE` | The gas price (in Wei) that is used to send transactions in the Home network . |
|
| `HOME_TEST_TX_GAS_PRICE` | The gas price (in Wei) that is used to send transactions in the Home network . |
|
||||||
| `COMMON_FOREIGN_BRIDGE_ADDRESS` | Address of the bridge in the Foreign network to send transactions. |
|
| `COMMON_FOREIGN_BRIDGE_ADDRESS` | Address of the bridge in the Foreign network to send transactions. |
|
||||||
| `FOREIGN_MIN_AMOUNT_PER_TX` | Value (in _eth_ or tokens) to be sent in one transaction for the Foreign network. This should be greater than or equal to the value specified in the `poa-bridge-contracts/deploy/.env` file. The default value in that file is 500000000000000000, which is equivalent to 0.5. |
|
| `FOREIGN_MIN_AMOUNT_PER_TX` | Value (in _eth_ or tokens) to be sent in one transaction for the Foreign network. This should be greater than or equal to the value specified in the `tokenbridge-contracts/deploy/.env` file. The default value in that file is 500000000000000000, which is equivalent to 0.5. |
|
||||||
| `FOREIGN_TEST_TX_GAS_PRICE` | The gas price (in Wei) that is used to send transactions in the Foreign network . |
|
| `FOREIGN_TEST_TX_GAS_PRICE` | The gas price (in Wei) that is used to send transactions in the Foreign network . |
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
10
ui/README.md
10
ui/README.md
@ -52,7 +52,7 @@ The following is an example setup using the POA Sokol testnet as the Home networ
|
|||||||
|
|
||||||
### Dependencies
|
### Dependencies
|
||||||
|
|
||||||
- [Smart Contracts](https://github.com/poanetwork/poa-bridge-contracts)
|
- [Smart Contracts](https://github.com/poanetwork/tokenbridge-contracts)
|
||||||
- [Oracle](../oracle/README.md)
|
- [Oracle](../oracle/README.md)
|
||||||
- [Node.js](https://nodejs.org/en/download/)
|
- [Node.js](https://nodejs.org/en/download/)
|
||||||
- [AlphaWallet](https://alphawallet.com/) or [Nifty Wallet](https://github.com/poanetwork/nifty-wallet) or [MetaMask](https://metamask.io/)
|
- [AlphaWallet](https://alphawallet.com/) or [Nifty Wallet](https://github.com/poanetwork/nifty-wallet) or [MetaMask](https://metamask.io/)
|
||||||
@ -72,8 +72,8 @@ The following is an example setup using the POA Sokol testnet as the Home networ
|
|||||||
* Get free Kovan Coins from the [gitter channel](https://gitter.im/kovan-testnet/faucet) or [Iracus faucet](https://github.com/kovan-testnet/faucet) for Foreign account(s). Get 5 Keth to 1 acc, and transfer from there to all other wallets if more than one account is used.
|
* Get free Kovan Coins from the [gitter channel](https://gitter.im/kovan-testnet/faucet) or [Iracus faucet](https://github.com/kovan-testnet/faucet) for Foreign account(s). Get 5 Keth to 1 acc, and transfer from there to all other wallets if more than one account is used.
|
||||||
|
|
||||||
4. Deploy the Sokol <-> Kovan Bridge contracts.
|
4. Deploy the Sokol <-> Kovan Bridge contracts.
|
||||||
* Go to the the `sokol-kovan-bridge` folder created in step 1 and `git clone https://github.com/poanetwork/poa-bridge-contracts`
|
* Go to the the `sokol-kovan-bridge` folder created in step 1 and `git clone https://github.com/poanetwork/tokenbridge-contracts`
|
||||||
* Follow instructions in the [POA Bridge contracts repo](https://github.com/poanetwork/poa-bridge-contracts).
|
* Follow instructions in the [POA Bridge contracts repo](https://github.com/poanetwork/tokenbridge-contracts).
|
||||||
* Set the parameters in the .env file.
|
* Set the parameters in the .env file.
|
||||||
* `DEPLOYMENT_ACCOUNT_PRIVATE_KEY`: Export the private key from step 2
|
* `DEPLOYMENT_ACCOUNT_PRIVATE_KEY`: Export the private key from step 2
|
||||||
* `HOME_RPC_URL`=https://sokol.poa.network
|
* `HOME_RPC_URL`=https://sokol.poa.network
|
||||||
@ -86,7 +86,7 @@ The following is an example setup using the POA Sokol testnet as the Home networ
|
|||||||
* `FOREIGN_UPGRADEABLE_ADMIN_BRIDGE`
|
* `FOREIGN_UPGRADEABLE_ADMIN_BRIDGE`
|
||||||
* `VALIDATORS` _Note: Wallet address(es) for validator(s) are separated by a space. For testing, you can use the same address that was used as the bridge contracts management account._
|
* `VALIDATORS` _Note: Wallet address(es) for validator(s) are separated by a space. For testing, you can use the same address that was used as the bridge contracts management account._
|
||||||
* `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 `tokenbridge-contracts/deploy` directory and includes the bridge contract addresses.
|
||||||
|
|
||||||
5. Install and run the TokenBridge Oracle.
|
5. Install and run the TokenBridge Oracle.
|
||||||
* Go to the `sokol-kovan-bridge` folder
|
* Go to the `sokol-kovan-bridge` folder
|
||||||
@ -125,7 +125,7 @@ cp .env.example .env
|
|||||||
````
|
````
|
||||||
* Insert the addresses from the bridgeDeploymentResults.json file (from step 4) into the .env file. No other changes are needed, see [Env Parameter Details](#env-parameter-details) for information about each parameter.
|
* Insert the addresses from the bridgeDeploymentResults.json file (from step 4) into the .env file. No other changes are needed, see [Env Parameter Details](#env-parameter-details) for information about each parameter.
|
||||||
```
|
```
|
||||||
cat ../poa-bridge-contracts/deploy/bridgeDeploymentResults.json
|
cat ../tokenbridge-contracts/deploy/bridgeDeploymentResults.json
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
Loading…
Reference in New Issue
Block a user