From 9d98651a4d8890033e79550ae5de5241e791cd48 Mon Sep 17 00:00:00 2001 From: Alexander Kolotov Date: Fri, 28 Oct 2022 14:04:13 +0300 Subject: [PATCH] naming convention for oracle --- README.md | 2 +- oracle/README.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e1a226d7..e8f5fdad 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Sub-repositories maintained within this monorepo are listed below. | Sub-repository | Description | | --- | --- | -| [Oracle](oracle/README.md) | Oracle responsible for listening to bridge related events and authorizing asset transfers. | +| [Oracle](oracle/README.md) | Responsible for listening to bridge related events and authorizing asset transfers. | | [Monitor](monitor/README.md) | Tool for checking balances and unprocessed events in bridged networks. | | [Deployment](deployment/README.md) | Ansible playbooks for deploying cross-chain bridges. | | [Oracle-E2E](oracle-e2e/README.md) | End to end tests for the Oracle | diff --git a/oracle/README.md b/oracle/README.md index a5b16540..7c23e37e 100644 --- a/oracle/README.md +++ b/oracle/README.md @@ -1,10 +1,10 @@ # POA TokenBridge / Oracle -Oracle responsible for listening to bridge related events and authorizing asset transfers. +An oracle responsible for listening to bridge related events and authorizing asset transfers. ## Overview 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 - sending transactions to authorize asset transfers @@ -69,7 +69,7 @@ For more information on the Redis/RabbitMQ requirements, see [#90](/../../issues } ``` -## Install and configure the Oracle +## Install and configure the oracle 1. [Initialize](../README.md#initializing-the-monorepository) the monorepository.