https://github.com/bnb-chain/oracle-relayer
Oracle Relayer is responsible for relaying events of bsc to BNB Beacon Chain.
https://github.com/bnb-chain/oracle-relayer
bsc oracle
Last synced: about 1 year ago
JSON representation
Oracle Relayer is responsible for relaying events of bsc to BNB Beacon Chain.
- Host: GitHub
- URL: https://github.com/bnb-chain/oracle-relayer
- Owner: bnb-chain
- License: lgpl-3.0
- Archived: true
- Created: 2020-05-20T03:32:18.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-05T07:29:34.000Z (almost 3 years ago)
- Last Synced: 2025-03-13T10:16:43.910Z (about 1 year ago)
- Topics: bsc, oracle
- Language: Go
- Homepage:
- Size: 220 KB
- Stars: 28
- Watchers: 13
- Forks: 35
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Oracle Relayer
Oracle Relayer is responsible for relaying events of bsc to BNB Beacon Beacon chain.
## Build
Build binary:
```shell script
$ make build
```
Build docker image:
```shell script
$ make build_docker
```
## Config
There is a config template in config directory, you should create your own config to run your relayer correctly.
You can refer to [config doc](./docs/config.md) for more details.
### Recommendations
If you are going to deploy your oracle relayer in production, AWS Secret Manager is recommended. You can use AWS Secret
Manager to host your mnemonic.
For BBC and BSC providers, you should use trusted nodes and TLS connection is recommended.
## Run
Run locally:
```shell script
$ ./build/relayer --bbc-network [0 for testnet, 1 for mainnet] --config-type [local or aws] --config-path config_file_path --aws-region [aws region or omit] --aws-secret-key [aws secret key for config or omit]
```
Run docker:
```shell script
$ docker run -it -v /your/data/path:/relayer -e BBC_NETWORK={0 or 1} -e CONFIG_TYPE="local" -e CONFIG_FILE_PATH=/your/config/file/path/in/container -d oracle_relayer
```
## License
Distributed under the [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html). See [LICENSE](LICENSE) for more information.