Incremental polling for voters, rex balances & delegations

.env.sample

@@ -0,0 +1,3 @@
+INDEXER_LOG_LEVEL=debug
+API_LOG_LEVEL=info
+MODE=dev

README.md

@@ -1,8 +1,39 @@
-# YAAI - Yet Another Antelope Indexer
+# OBE Indexer - Antelope Indexer for Open Block Explorer
+
+This is an Antelope indexer developed for our [Open Block Explorer](https://github.com/telosnetwork/open-block-explorer)
+
+## Requirement
+
+This repository's instructions requires Docker to be installed but alternatively you can install Postgres without it.
 
 ## Developer Setup
 
-### Docker
+**Install node v.16**
+
+```curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash -```
+```sudo apt-get install -y nodejs```
+
+**Clone the OBE Indexer**
+
+```git clone https://github.com/telosnetwork/obe-indexer```
+
+**Copy example.config.json to config.json and edit it for your DB, Hyperion and Nodeos connection.**
+
+Make sure to note the default port for psql is 5432. The config in git is set differently for the docker dev version. Also be sure the `nodeosUrl` is pointed to your node running in irreversible mode.
+
+```read-mode = irreversible```
+
+**Install Yarn** 
+
+```sudo npm install --global yarn```
+
+**Install Dependencies** 
+
+```yarn ```
+
+**Setup postgres** 
+
+Using `bash runDockerPostgres.sh` or
 
 ```bash
 docker run \
@@ -14,69 +45,41 @@ docker run \
     postgres
 ```
 
-Then connect `psql -U postgres -h localhost -p 5455` and create the db
+Then connect `psql -U postgres -h localhost -p 5455` and create the database and privileged user by pasting the following snippet:
 
 ```postgresql
 CREATE DATABASE obeindex;
 CREATE USER obe WITH ENCRYPTED PASSWORD 'obe';
 GRANT ALL PRIVILEGES ON DATABASE obeindex to obe;
 ```
 
-Now paste all the tables in there and create those too, or write a script and put it
+Now paste all the tables defined in `src/tables` and create those too, or write a script to do it
 
 ```bash
 HERE
 ```
 
-## Operator Setup
+## Nodeos Setup
 
-Nodeos Setup:  
-The OBE Indexer does not have functionality for handeling forks so it must be pointed at a nodeos instance running in irreversible mode. More on that can be read here: https://developers.eos.io/manuals/eos/v2.2/nodeos/features/storage-and-read-modes
+The OBE Indexer does not have functionality for handling forks so it must be pointed at a nodeos instance running in irreversible mode. More on that can be read here: https://developers.eos.io/manuals/eos/v2.2/nodeos/features/storage-and-read-modes
 
 Within your nodeos config.ini file you will use with the indexer, be sure to include the option:  
-```read-mode = irreversible```
-
-Install node v.16  
-```curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash -```
-```sudo apt-get install -y nodejs```
-
-Install jq  
-```sudo apt install jq```
-
-Install Postgresql  
-```sudo apt install postgresql postgresql-contrib```
-
-Edit pg_hba.conf to allow password access locally  
-```sudo vi /etc/postgresql/14/main/pg_hba.conf```
-
-Change the below line under "local" to password from peer.  
-```# "local" is for Unix domain socket connections only
-local   all             all                                     password
-```
 
-Elevate to psql console  
-```sudo -u postgres psql```
+```read-mode = irreversible```
 
-Create user and database:  
-```create user USER with encrypted password 'PASSWORD';```  
-```create database DBNAME;```  
-```grant all privileges on database yaai to yaai;```  
+## Build
+Build the Indexer with
 
-Clone the OBE Indexer  
-```git clone https://github.com/telosnetwork/obe-indexer```
-
-Import tables as the DB user you just created using https://github.com/telosnetwork/obe-indexer/blob/master/src/tables/tokens.sql
+```yarn run build```
 
-Copy example.config.json to config.json and edit it for your DB, Hyp and Nodeos connection. Make sure to note the default port for psql is 5432. The config in git is set differently for the docker dev version. Also be sure the `nodeosUrl` is pointed to your node running in irreversible mode.
+## Run
+Run the Indexer with 
 
-Install Yarn  
-```sudo npm install --global yarn```
+```nohup node dist/indexer.js > obeIndexer.log 2>&1 &```
 
-Buld the Indexer  
-```yarn run build```
+Run the API with
 
-Run the Indexer  
-```nohup node dist/indexer.js > obeIndexer.log 2>&1 &```
+```nohup node dist/api.js > obeApi.log 2>&1 &```
 
 
 

example.config.json

@@ -1,16 +1,36 @@
-{
-    "networkName": "telos-mainnet",
-    "apiPort": 5000,
-    "apiAddress": "0.0.0.0",
-    "apiHost": "localhost:5000",
-    "apiProtocols": ["https", "http"],
-    "apiInstances": 4,
-    "tokenListUrl": "https://raw.githubusercontent.com/telosnetwork/token-list/main/telosmain.json",
-    "nodeosUrl": "https://mainnet.telos.net",
-    "hyperionUrl": "https://mainnet.telos.net",
-    "dbHost": "localhost",
-    "dbPort": 5455,
-    "dbName": "obeindex",
-    "dbUser": "obe",
-    "dbPass": "obe"
-}
+{
+  "indexerLogLevel": "debug",
+  "apiLogLevel": "debug",
+  "mode": "dev",
+  "apiVersion": "1.0.0",
+  "networkName": "telos-mainnet",
+  "displayNetworkName": "Telos",
+  "documentationUrl": "https://docs.telos.net",
+  "baseCurrencyContract": "eosio.token",
+  "baseCurrencySymbol": "TLOS",
+  "baseCurrencyDecimals": 4,
+  "apiPort": 5555,
+  "apiAddress": "0.0.0.0",
+  "apiHost": "localhost:5555",
+  "apiProtocols": ["http"],
+  "apiInstances": 4,
+  "tokenListUrl": "https://raw.githubusercontent.com/telosnetwork/token-list/main/telosmain.json",
+  "nodeosUrl": "https://telos.caleos.io",
+  "hyperionUrl": "https://telos.caleos.io",
+  "dbHost": "localhost",
+  "dbPort": 5432,
+  "dbName": "obeindex",
+  "dbUser": "obe",
+  "dbPass": "obe",
+  "dbMaximumPoolSize": 50,
+  "dbConnectionRetries": 5,
+  "dbConnectionTimeout": 30000,
+  "hyperionIncrementLimit": 1000,
+  "fetchRetryCount": 100,
+  "fetchRetryDelay": 1000,
+  "tokenListInterval": 120,
+  "tokenPollInterval": 2,
+  "rexPollInterval": 2,
+  "voterPollInterval": 2,
+  "bpPollInterval": 720
+}