tokenbridge/oracle/README.md

POA TokenBridge / Oracle

Oracle responsible for listening to bridge related events and authorizing asset transfers.

Overview

Please refer to the POA TokenBridge 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:

• listening to events related to bridge contracts
• sending transactions to authorize asset transfers

Architecture

Native-to-ERC20

ERC20-to-ERC20 and ERC20-to-Native

Watcher

A watcher listens for a certain event and creates proper jobs in the queue. These jobs contain the transaction data (without the nonce) and the transaction hash for the related event. The watcher runs on a given frequency, keeping track of the last processed block.

If the watcher observes that the transaction data cannot be prepared, which generally means that the corresponding method of the bridge contract cannot be invoked, it inspects the contract state to identify the potential reason for failure and records this in the logs.

There are three Watchers:

• Signature Request Watcher: Listens to UserRequestForSignature events on the Home network.
• Collected Signatures Watcher: Listens to CollectedSignatures events on the Home network.
• Affirmation Request Watcher: Depends on the bridge mode.
  • Native-to-ERC20: Listens to UserRequestForAffirmation raised by the bridge contract.
  • ERC20-to-ERC20 and ERC20-to-Native: Listens to Transfer events raised by the token contract.

Sender

A sender subscribes to the queue and keeps track of the nonce. It takes jobs from the queue, extracts transaction data, adds the proper nonce, and sends it to the network.

There are two Senders:

• Home Sender: Sends a transaction to the Home network.
• Foreign Sender: Sends a transaction to the Foreign network.

RabbitMQ

RabbitMQ is used to transmit jobs from watchers to senders.

Redis DB

Redis is used to store the number of blocks that were already inspected by watchers, and the NOnce (Number of Operation) which was used previously by the sender to send a transaction.

For more information on the Redis/RabbitMQ requirements, see #90. We also provide useful commands for development.

How to Use

Deploy the Bridge Contracts

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.

1. Deploy the bridge contracts

2. Open bridgeDeploymentResults.json or copy the JSON output generated by the bridge contract deployment process.

Output examples

Native-to-ERC20 mode example:

{
    "homeBridge": {
        "address": "0xc60daff55ec5b5ce5c3d2105a77e287ff638c35e",
        "deployedBlockNumber": 123321
    },
    "foreignBridge": {
        "address": "0x3f5ce5fbfe3e9af3971dd833d26ba9b5c936f0be",
        "deployedBlockNumber": 456654,
        "erc677": {
            "address": "0x41a29780309dc2582f080f6af89953be3435679a"
        }
    }
}

ERC20-to-ERC20 mode example:

{
    "homeBridge": {
        "address": "0x765a0d90e5a5773deacbd94b2dc941cbb163bdab",
        "deployedBlockNumber": 789987,
        "erc677": {
            "address": "0x269f57f5ae5421d084686f9e353f5b7ee6af54c2"
        }
    },
    "foreignBridge": {
        "address": "0x7ae703ea88b0545eef1f0bf8f91d5276e39be2f7",
        "deployedBlockNumber": 567765
    }
}

Install and configure the Oracle

1. Initialize the monorepository.

2. Go to the oracle sub-repository:

cd oracle

3. Create a .env file:

cp .env.example .env

2. Fill in the required information using the JSON output data. Check the tables with the set of parameters below to see their explanation.

Run the Processes

There are two options to run the TokenBridge processes:

1. Docker containers. This requires Docker and Docker Compose. If you are on Linux, it's also recommended that you create a docker group and add your user to it, so that you can use the CLI without sudo.
2. Yarn Package Manager.

Docker

• While running the bridge containers for the first time use VALIDATOR_ADDRESS=<validator address> VALIDATOR_ADDRESS_PRIVATE_KEY=<validator address private key> docker-compose up -d --build
• For further launches use VALIDATOR_ADDRESS=<validator address> VALIDATOR_ADDRESS_PRIVATE_KEY=<validator address private key> docker-compose up --detach

All watcher & sender services launch when docker-compose is called.

Redis and RabbitMQ data are placed in ~/bridge_data directory. In case you need to reset your bridge or setup a new one (with different configuration) you must delete this directory to prevent old data from being read.

Note: To view the Docker logs:

• chdir to the directory containing the docker-compose.yml file used to run the bridge instance
• View the logs : docker-compose logs

Yarn

• redis-server starts Redis. redis-cli ping will return a pong if Redis is running.
• rabbitmq-server starts RabbitMQ. Use rabbitmqctl status to check if RabbitMQ is running.
• yarn watcher:signature-request
• yarn watcher:collected-signatures
• yarn watcher:affirmation-request
• yarn sender:home
• yarn sender:foreign

Bridge UI

See the UI instructions to configure and use the optional Bridge UI.

Rollback the Last Processed Block in Redis

If the bridge does not handle an event properly (i.e. a transaction stalls due to a low gas price), the Redis DB can be rolled back. You must identify which watcher needs to re-run. For example, if the validator signatures were collected but the transaction with signatures was not sent to the Foreign network, the collected-signatures watcher must look at the block where the corresponding CollectedSignatures event was raised.

Execute this command in the bridge root directory:

for local installation:

bash ./reset-lastBlock.sh <watcher> <block num>

for Docker installation:

docker-compose exec bridge_affirmation bash ./reset-lastBlock.sh <watcher> <block num>

where the watcher could be one of:

• signature-request
• collected-signatures
• affirmation-request

Configuration parameters

Variable	Description	Values
BRIDGE_MODE	The bridge mode. The bridge starts listening to a different set of events based on this parameter.	NATIVE_TO_ERC / ERC_TO_ERC / ERC_TO_NATIVE
HOME_RPC_URL	The HTTPS URL(s) used to communicate to the RPC nodes in the Home network. Several URLs can be specified, delimited by spaces. If the connection to one of these nodes is lost the next URL is used for connection.	URL(s)
HOME_BRIDGE_ADDRESS	The address of the bridge contract address in the Home network. It is used to listen to events from and send validators' transactions to the Home network.	hexidecimal beginning with "0x"
HOME_POLLING_INTERVAL	The interval in milliseconds used to request the RPC node in the Home network for new blocks. The interval should match the average production time for a new block.	integer
FOREIGN_RPC_URL	The HTTPS URL(s) used to communicate to the RPC nodes in the Foreign network. Several URLs can be specified, delimited by spaces. If the connection to one of these nodes is lost the next URL is used for connection.	URL(s)
FOREIGN_BRIDGE_ADDRESS	The address of the bridge contract address in the Foreign network. It is used to listen to events from and send validators' transactions to the Foreign network.	hexidecimal beginning with "0x"
ERC20_TOKEN_ADDRESS	Used with the ERC_TO_ERC bridge mode, this parameter specifies the ERC20-compatible token contract address. The token contract address is used to identify transactions that transfer tokens to the Foreign Bridge account address. Omit this parameter with other bridge modes.	hexidecimal beginning with "0x"
FOREIGN_POLLING_INTERVAL	The interval in milliseconds used to request the RPC node in the Foreign network for new blocks. The interval should match the average production time for a new block.	integer
HOME_GAS_PRICE_ORACLE_URL	The URL used to get a JSON response from the gas price prediction oracle for the Home network. The gas price provided by the oracle is used to send the validator's transactions to the RPC node. Since it is assumed that the Home network has a predefined gas price (e.g. the gas price in the Core of POA.Network is 1 GWei), the gas price oracle parameter can be omitted for such networks.	URL
HOME_GAS_PRICE_SPEED_TYPE	Assuming the gas price oracle responds with the following JSON structure: {"fast": 20.0, "block_time": 12.834, "health": true, "standard": 6.0, "block_number": 6470469, "instant": 71.0, "slow": 1.889}, this parameter specifies the desirable transaction speed. The speed type can be omitted when HOME_GAS_PRICE_ORACLE_URL is not used.	instant / fast / standard / slow
HOME_GAS_PRICE_FALLBACK	The gas price (in Wei) that is used if both the oracle and the fall back gas price specified in the Home Bridge contract are not available.	integer
HOME_GAS_PRICE_UPDATE_INTERVAL	An interval in milliseconds used to get the updated gas price value either from the oracle or from the Home Bridge contract.	integer
HOME_GAS_PRICE_FACTOR	A value that will multiply the gas price of the oracle to convert it to gwei. If the oracle API returns gas prices in gwei then this can be set to 1. Also, it could be used to intentionally pay more gas than suggested by the oracle to guarantee the transaction verification. E.g. 1.25 or 1.5.	integer
FOREIGN_GAS_PRICE_ORACLE_URL	The URL used to get a JSON response from the gas price prediction oracle for the Foreign network. The provided gas price is used to send the validator's transactions to the RPC node. If the Foreign network is Ethereum Foundation mainnet, the oracle URL can be: https://gasprice.poa.network. Otherwise this parameter can be omitted.	URL
FOREIGN_GAS_PRICE_SPEED_TYPE	Assuming the gas price oracle responds with the following JSON structure: {"fast": 20.0, "block_time": 12.834, "health": true, "standard": 6.0, "block_number": 6470469, "instant": 71.0, "slow": 1.889}, this parameter specifies the desirable transaction speed. The speed type can be omitted when FOREIGN_GAS_PRICE_ORACLE_URLis not used.	instant / fast / standard / slow
FOREIGN_GAS_PRICE_FALLBACK	The gas price (in Wei) used if both the oracle and fall back gas price specified in the Foreign Bridge contract are not available.	integer
FOREIGN_GAS_PRICE_UPDATE_INTERVAL	The interval in milliseconds used to get the updated gas price value either from the oracle or from the Foreign Bridge contract.	integer
FOREIGN_GAS_PRICE_FACTOR	A value that will multiply the gas price of the oracle to convert it to gwei. If the oracle API returns gas prices in gwei then this can be set to 1. Also, it could be used to intentionally pay more gas than suggested by the oracle to guarantee the transaction verification. E.g. 1.25 or 1.5.	integer
VALIDATOR_ADDRESS_PRIVATE_KEY	The private key of the bridge validator used to sign confirmations before sending transactions to the bridge contracts. The validator account is calculated automatically from the private key. Every bridge instance (set of watchers and senders) must have its own unique private key. The specified private key is used to sign transactions on both sides of the bridge.	hexidecimal without "0x"
HOME_START_BLOCK	The block number in the Home network used to start watching for events when the bridge instance is run for the first time. Usually this is the same block where the Home Bridge contract is deployed. If a new validator instance is being deployed for an existing set of validators, the block number could be the latest block in the chain.	integer
FOREIGN_START_BLOCK	The block number in the Foreign network used to start watching for events when the bridge instance runs for the first time. Usually this is the same block where the Foreign Bridge contract was deployed to. If a new validator instance is being deployed for an existing set of validators, the block number could be the latest block in the chain.	integer
QUEUE_URL	RabbitMQ URL used by watchers and senders to communicate to the message queue. Typically set to: amqp://127.0.0.1.	local URL
REDIS_URL	Redis DB URL used by watchers and senders to communicate to the database. Typically set to: redis://127.0.0.1:6379.	local URL
ALLOW_HTTP	Only use in test environments - must be omitted in production environments.. If this parameter is specified and set to yes, RPC URLs can be specified in form of HTTP links. A warning that the connection is insecure will be written to the logs.	yes / no
LOG_LEVEL	Set the level of details in the logs.	trace / debug / info / warn / error / fatal
MAX_PROCESSING_TIME	The workers processes will be killed if this amount of time (in milliseconds) is ellapsed before they finish processing. It is recommended to set this value to 4 times the value of the longest polling time (set with the HOME_POLLING_INTERVAL and FOREIGN_POLLING_INTERVAL variables). To disable this, set the time to 0.	integer

Useful Commands for Development

RabbitMQ

Command	Description
rabbitmqctl list_queues	List all queues
rabbitmqctl purge_queue home	Remove all messages from home queue
rabbitmqctl status	check if rabbitmq server is currently running
rabbitmq-server	start rabbitMQ server

Redis

Use redis-cli

Command	Description
KEYS *	Returns all keys
SET signature-request:lastProcessedBlock 1234	Set key to hold the string value.
GET signature-request:lastProcessedBlock	Get the key value.
DEL signature-request:lastProcessedBlock	Removes the specified key.
FLUSHALL	Delete all the keys in all existing databases.
redis-cli ping	check if redis is running.
redis-server	start redis server.

Testing

yarn test

E2E tests

See the E2E README for instructions.

Notice: for docker-based installations do not forget to add docker-compose exec bridge_affirmation before the test commands listed below.

Native-to-ERC20 Mode Testing

When running the processes, the following commands can be used to test functionality.

• To send deposits to a home contract run node scripts/native_to_erc20/sendHome.js <tx num>, where <tx num> is how many tx will be sent out to deposit.

• To send withdrawals to a foreign contract run node scripts/native_to_erc20/sendForeign.js <tx num>, where <tx num> is how many tx will be sent out to withdraw.

ERC20-to-ERC20 Mode Testing

• To deposit from a Foreign to a Home contract run node scripts/erc20_to_erc20/sendForeign.js <tx num>.

• To make withdrawal to Home from a Foreign contract run node scripts/erc20_to_erc20/sendHome.js <tx num>.

ERC20-to-Native Mode Testing

• To deposit from a Foreign to a Home contract run node scripts/erc20_to_native/sendForeign.js <tx num>.

• To make withdrawal to Home from a Foreign contract run node scripts/erc20_to_native/sendHome.js <tx num>.

Configuration parameters for testing

Variable	Description
HOME_RPC_URL	The HTTPS URL(s) used to communicate to the RPC nodes in the Home network.
FOREIGN_RPC_URL	The HTTPS URL(s) used to communicate to the RPC nodes in the Foreign network.
USER_ADDRESS	An account - the current owner of coins/tokens.
USER_ADDRESS_PRIVATE_KEY	A private key belonging to the account.
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_TEST_TX_GAS_PRICE	The gas price (in Wei) that is used to send transactions in the Home network .
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_TEST_TX_GAS_PRICE	The gas price (in Wei) that is used to send transactions in the Foreign network .

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.