Orakl Network

This repository is split to on-chain and off-chain oracle implementation.

You can learn more about the Orakl Network from documentation.

Test Data Feed Locally Using Docker

Run local data feed connected to testnet.

Steps run through docker compose

• Deploy contracts in testnet(baobab)
• Run postgres & redis
• Run orakl-api & orakl-delegator
• Insert deployed data feed & set delegator fee payer
• Run listener, worker, reporter, and fetcher
• Activate inserted data feed

Prerequisites

1. Docker

brew install docker
brew install docker-compose

2. Env setup

Nearly everything is already setup, but there are two variables that should be set manually in following env files:

• dockerfiles/local-data-feed/envs/.contracts.env

MNEMONIC="{MNEMONIC for contract deployer wallet}"

• dockerfiles/local-data-feed/envs/.cli.env

DELEGATOR_REPORTER_PK={private key for delegator fee payer}

Run docker

Data feed

1. Docker Compose Build Builds all required images for docker-compose.

docker-compose -f docker-compose.local-data-feed.yaml build

2. Docker Compose Up Runs all required images to run datafeed locally.

docker-compose -f docker-compose.local-data-feed.yaml up

3. Docker Compose Down Close all related containers.

docker-compose -f docker-compose.local-data-feed.yaml down -v

VRF / Request-Response

Run the following command to build all images

docker-compose -f docker-compose.local-core.yaml build

Set wallet credentials, ADDRESS and PRIVATE_KEY values, in the .core-cli-contracts.env file. Keep in mind that the default chain is localhost. If changes are required, update CHAIN (other options being baobab and cypress) and PROVIDER_URL values. Note that if the chain is not localhost, Coordinator and Prepayment contracts won't be deployed. Instead, Bisonai's already deployed contract addresses (VRF, RR) will be used. After setting the appropriate .env values, run the following command to start the VRF service:

SERVICE=vrf docker-compose -f docker-compose.local-core.yaml up --force-recreate

SERVICE is an env variable that will be used to spin up the specified service. The options are rr and vrf stands for Request-Response and VRF, respectively.

Note that the current docker implementation is designed to run a single service, either rr or vrf, at a time. Therefore, it's highly recommended to add --force-recreate when running docker-compose up command. That will restart all containers thus removing all the modified data in those containers.

Here is what happens after the above command is run:

• api, postgres, redis, and json-rpc services will start as separate docker containers
• postgres will get populated with necessary data:
  • chains
  • services
  • vrf keys in case if the service is vrf
  • listener (after contracts are deployed)
  • reporter (after contracts are deployed)
• migration files in contracts/v0.1/migration/ get updated with provided keys and other values
• if the chain is localhost:
  • contracts/v0.1/hardhat.config.cjs file gets updated with PROVIDER_URL
  • relevant coordinator and prepayment contracts get deployed

To start core microservices (listener, worker, reporter) as a singleton service run:

• production mode

  yarn start:core:vrf
  # or
  yarn start:core:request_response
  

• development mode

  yarn dev:core:vrf
  # or
  yarn dev:core:request_response
  

The microservices can also be started separately in any arbitrary order by replacing core in the above commands with either listener, worker, or reporter