Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview

FIO Relic is a fork of Antelope Memento and is intended to receive FIO Chain data stream from the FIO Chain Node via EOS Chronicle. FIO specific data is extracted from the stream and stored in a Relational Database (RDB) for future query via API. The following document is intended to be functional specification for the FIO Relic System.

Components

Data Transformation

This component is responsible for reading the data in the data stream and looking for FIO-specific data, parsing it, and inserting into RDB.

Example:

  • When an action registering FIO Domain is observed, insert it into domains table.

Query API

This component is responsible for receiving an API request, fetching relevant data from the RDB and returning to the API user.

Example:

  • Fetch all FIO Domains registered in specific time-frame.

Push Notification System

This component will be developed in Phase 2.

This component allows an API user to subscribe to specific events and then receive notification if such event has occurred during data transformation.

Examples

  • “Notify supplied webhook on every new FIO Domain registration”

  • “Notify when a FIO Request for specific FIO Handle is observed”

Specification

Data Model

Tables

Blocks

Field

Description

Data stream field name

Relationship

block_num

Block number as generated by FIO Node

block_num

References transactions in this block

id

Block ID as generated by FIO Node

id

timestamp

Timestamp as generated by FIO Node

timestamp

producer

Account name of producer which produced the block

producer

schedule_version

Version of BP schedule

schedule_version

Transactions

Field

Description

Data stream field name

Relationship

block_num

Block which contained this transaction

block_num

References block which contains this transaction

id

Transaction id

id

References traces in this transaction

account

Account name for action

account

action

Action name

name

actor

Actor which executed the transaction

actor

tpid

TPID which was recorded in tranaction

tpid

fee

FIO Chain fee paid for this transaction

fee_collected

request_data

Raw request data for primary trace

data

response_data

Raw response data for primary trace

response

Traces

Field

Description

Data stream field name

Relationship

id

Trace id

References transaction which contained this trace

action_ordinal

Sequential order of trace in transaction

action_ordinal

account

Account name for trace

account

action

Action name fro trace

name

request_data

Raw request data for trace

data

  • No labels