FIO.Relic is the state history solution for the FIO Blockchain incorporating the ingest of state history data, as well as the parsing and storage of that data into a relational database for asynchronous consumption by 3rd party applications.
The FIO.Relic ecosystem is comprised of;
- FIO Nodeos node providing state history via the state-history plugin
- The FIO.Chronicle state history processor which ingests and processes state historical data from FIO.Nodeos
- The FIO.Relic PostgreSQL database as the state history data store
The FIO.Chronicle state history processor utilizes the FIO.Relic database server and schema as the peristence layer for historical data ingested from the FIO Nodeos blockchain. See FIO.Chronicle to stand up FIO.Chronicle.
FIO.Chronicle is based on the opensource project EOS-Chronicle.
The Foundation for Interwallet Operability (FIO) or, in short, the FIO Protocol, is an open-source project based on EOSIO 1.8+.
- For information on FIO Protocol, visit FIO.
- For information on the FIO Chain, API, and SDKs, including detailed clone, build and deploy instructions, visit FIO Protocol Developer Hub.
See the FIO.Relic Tech Stack document for the requisite hardware and software needed to install and run the FIO.Relic ecosystem
See the FIO.Relic Deployment Guide document for the deployment outline of a FIO History Node, FIO.Relic including a RDMS as well as the state history processor.
To clone the FIO.Relic repository, execute the command;
git clone https://github.com/fioprotocol/fio.relic.gitsee Cloning a repository for more information.
The installation and configuration of the FIO.Relic PostgreSQL database will occur in two parts;
- Installation and configuration of the database server as a system application
- Creation and configuration of the database schema including tables, and functions, as well as connectivity and user access
PostgreSQL provides packages for Ubuntu and may be installed manually, however, for an automated install, the PostgreSQL install script will be used. To install PostgreSQL, execute the following command;
sudo ./scripts/install_pgsql.shThe PostgreSQL install script will update the OS, install PostgreSQL and any required PostgreSQL package dependencies. Note that the PostgreSQL installation includes configuration and startup of the PostgreSQL database.
For further support refer to the PostgreSQL Ubuntu documentation located here.
To create the FIO.Relic database, including tables, functions as well as configure the necessary user access and connectivity, execute the following command;
sudo ./scripts/create_schema.shVerification of the relicdb may be done by executing the following commands;
psql -d relicdb -U chronicle_user
Password for user chronicle_user:Note that the default password is password123!
To get a listing of all tables, execute the command;
relicdb=> \dt
List of relations
Schema | Name | Type | Owner
--------+--------------------+-------+----------------
public | accountactivities | table | chronicle_user
public | accounts | table | chronicle_user
public | accountsaudit | table | chronicle_user
public | blocks | table | chronicle_user
public | domainactivities | table | chronicle_user
public | domains | table | chronicle_user
...
public | transactions | table | chronicle_user
(22 rows)The configuration of PostgresSQL including connection handling, authentication, database administration is outlined in the PostgresQL configuration document here.
For further insight into the PostgreSQL database see Getting Started.
The PostgreSQL service is started automatically on installation and will stop and start automatically on shutdown or boot up, respectively. While unnecessary under normal circumstances, the following commands are used to start and stop the PostgreSQL service.
systemctl start postgresqlsystemctl stop postgresqlThere are two components which represent state;
- FIO.Relic PostgreSQL database
- FIO.Chronicle shared-memory database
To capture consistent state the FIO.Chronicle state history processor must be shutdown. This is also required when importing state.
Exporting data:
To export the FIO.Relic database schema including tables, functions, users and data execute the following command;
sudo ./scripts/export_db.sh relicdb_snapshot.tar.gzTo export FIO.Chronicle shared-memory data see the export documentation at FIO.Chronicle Data Capture
Importing data:
To import the FIO.Relic database execute the following command;
sudo ./scripts/import_db.sh relicdb_snapshot.tar.gzWARNING: The import script will clear any and all data as well as tables, functions and users!
To import FIO.Chronicle shared-memory data see the import documention at FIO.Chronicle Data Capture