dApps staking indexer

Prerequisites

• npm, node ≥ v16
• git
• docker
• docker-compose with docker user & group

This is the list of install commands of the prerequisites for Ubuntu 22.04 for the program list above.

# For node and npm
curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg
NODE_MAJOR=18
echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_$NODE_MAJOR.x nodistro main" | sudo tee /etc/apt/sources.list.d/nodesource.list
sudo apt update
sudo apt install nodejs

# For docker
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc
echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
  $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin docker-compose
sudo gpasswd -a $USER docker
newgrp docker

sqd CLI installation

sudo npm i -g @subsquid/cli

Run

npm ci
sqd up
sqd process

to beging the ingestion, then start the GraphQL server in a separate terminal. Also note that the endpoint & block range are stored in the .env file.

sqd serve

Serve starts a local API and webserver for you to look at and play with. Open your browser here: http://localhost:4350/graphql

Develop

Types

When changes are made to the rpc types, use the following commands:

npm generate-metadata # for local node development
sqd typegen # operates on metadata or rpc and modifies types

Schema

When you make changes to the schema, use the following commands:

sqd codegen
sqd build # modify your squid to use the new schema until it builds
sqd down; sqd up
sqd migration:generate # rerun everytime there is a change to the schema

This drops then re-creates the database and regenerates any migrations.

Deploy to the aquarium

There are 3 manifests, one for each network: astar, shiden and shibuya.

sqd deploy . -r --org astar-network -m manifests/astar.yaml

The -r is optional if no re-indexing is needed

Data being indexed

Table	Fields
dapps	beneficiary, dappId, id, owner, registeredAt, registrationBlockNumber, stakersCount, state, unregisteredAt, unregistrationBlockNumber
dappAggregatedDailies	timestamp, stakersCount, id, dappAddress
rewardEvents	amount, blockNumber, contractAddress, era, id, period, tierId, timestamp, transaction, userAddress
rewardAggregatedDailies	amount, beneficiary, id, timestamp
stakes	amount, dappAddress, stakerAddress, blockNumber, expiredAt, expiredBlockNumber, id, timestamp
stakers	amount, dappAddress, stakerAddress, id
stakersCount	total
stakersCountAggregatedDailies	blockNumber, id, stakersCount, stakersAmount, usdPrice
subperiods	id, type, blockNumber, timestamp
tvlAggregatedDailies	blockNumber, id, tvl, lockersCount, usdPrice
uniqueStakerAddresses	id
uniqueLockerAddresses	id, amount