BCNAracle

BCNAracle is a pseudo centralized Oracle to prevent price manipulation and to avoid spikes in the BCNA price charts. IMAGE 1: Green line is the aggregated BCNAracle price. The dots are price data provided by different sources.

• In short, it retrieves prices from three sources and combines them to an average.
• It contains several defense mechanisms and rules to ensure stable pricing feeds that avoids chartspikes and no-connection errors.
• It contains a JSON with BCNA / USD, EUR and 43 other FIAT values.
• Could be adapted to other coins

The problem

• Trusting in a single source to provide the BCNA price is an unreliable way of retrieving the price. For instance, the API could be offline, hacked, manipulated, or the source could provide prices based on low volume exchanges with big price volatibily.
• Sometimes price feeders like CoinGecko or CoinMarketCap show bad values in their API's because they get their values from low volume exchanges.

How it works

There are two scripts:

• bcnaracle_get_fiat.py -> Recollect FIAT currency values.

  • It generates a JSON file with FIAT USD.
  • Prices feeds are retrieved from APILAYER (With over 15 exchange rate data sources, the Exchangerates API is delivering exchanging rates data for more than 170 world currencies)
  • If APILAYER connection is unreachable, the script uses the last good values.
  • It retrieves the config from bcnaracle_config.json

• bcnaracle.py -> Provide an oraculised output of BCNA coin price.

  • It produces a JSON file with BCNA / USD (+44 currencies).
  • It produces a CSV file for stats analysis with input/outoput values based on time.
  • Retrieve the data from 3 sources and validate if data endpoints are:
    • Disposable (connection check and consistency check)
    • Values that differs only a % of the permitted deviation (2%)
    • Another threshold establishes if one source should be temporally disabled, and neglects to build the AVERAGE (deviation of 30% to avoid spikes)

Example:

IMAGE 2: In check 2944 Osmosis is not disposable (connection error) and it's value is replaced temporally by the LAST AVERAGE. In check 2945 connection is recovered

Install and run

Pre-requisites: python 3.10 Install dependecies: numpy termcolor requests

1. Clone or download this repo.

cd ~
git clone https://github.com/BitCannaGlobal/BCNAracle.git
cd BCNAracle
pip3 install numpy termcolor requests #install package dependencies

2. Set-up the config file.

You should edit mainly the PATH, APILAYER_APIKEY & X_CMC_PRO_API_KEY vars:

nano bcnaracle_config.py

3. Run the bcnaracle_get_fiat.py script first to generate the fiat.json file

If you have set the APILAYER_APIKEY then start the FIAT retrieving with:

python3 bcnaracle_get_fiat.py

4. Run the bcnaracle.py script then to generate the bcnaracle.json file

If you have set the X_CMC_PRO_API_KEY then start the FIAT retrieving with:

python3 bcnaracle.py

5. Create service files

Service creation With all configurations ready you can set up systemd to run the node daemon with auto-restart.

Setup bcnaracle_get_fiat systemd service (copy and paste all to create the file service changing the path of the files):

 cd $HOME
 echo "[Unit]
 Description=bcnaracle_get_fiat Script
 After=network-online.target
 [Service]
 User=${USER}
 ExecStart=$(which python3) /home/raul/BCNAracle/bcnaracle_get_fiat.py
 Restart=always
 RestartSec=3
 LimitNOFILE=4096
 [Install]
 WantedBy=multi-user.target
 " >bcnaracle_get_fiat.service

Enable and activate the bcnaracle_get_fiat service.

sudo mv bcnaracle_get_fiat.service /lib/systemd/system/
sudo systemctl enable bcnaracle_get_fiat.service && sudo systemctl start bcnaracle_get_fiat.service

Check the logs to see if everything is working correct:

sudo journalctl -fu bcnaracle_get_fiat -o cat

Setup bcnaracle systemd service (copy and paste all to create the file service changing the path of the files):

 cd $HOME
 echo "[Unit]
 Description=bcnaracle Script
 After=network-online.target
 [Service]
 User=${USER}
 ExecStart=$(which python3) /home/raul/BCNAracle/bcnaracle.py
 Restart=always
 RestartSec=3
 LimitNOFILE=4096
 [Install]
 WantedBy=multi-user.target
 " >bcnaracle.service

Enable and activate the bcnaracle service.

sudo mv bcnaracle.service /lib/systemd/system/
sudo systemctl enable bcnaracle.service && sudo systemctl start bcnaracle.service

Check the logs to see if everything is working correct:

sudo journalctl -fu bcnaracle -o cat