feat: [cheqd] add top_accounts module

.github/workflows/test.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v3
         with:
-          go-version: 1.17
+          go-version: 1.18
       - name: Test & Create coverage report
         run: make install test-unit stop-docker-test
       - name: Upload cove coverage

CHANGELOG.md

@@ -1,6 +1,10 @@
 ## Unreleased
 ### Changes
 
+#### Top Accounts Module
+- ([\#510](https://github.com/forbole/bdjuno/pull/510)) Implemented top accounts module to store chain native token's balance for ranking 
+
+
 #### CI
 - ([\#508](https://github.com/forbole/bdjuno/pull/508)) Upgrade workflow golangci version to v1.50.1
 

cmd/bdjuno/cheqd.go

@@ -0,0 +1,28 @@
+package main
+
+import (
+	didMsgs "github.com/cheqd/cheqd-node/x/cheqd/types"
+	resourceMsgs "github.com/cheqd/cheqd-node/x/resource/types"
+	"github.com/cosmos/cosmos-sdk/codec"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/forbole/juno/v3/modules/messages"
+)
+
+// CheqdAddressesParser represents a MessageAddressesParser for the my custom module
+// here, we're using a DID as the address
+func CheqdAddressesParser(_ codec.Codec, cosmosMsg sdk.Msg) ([]string, error) {
+	switch msg := cosmosMsg.(type) {
+
+	case *didMsgs.MsgCreateDid:
+		return []string{msg.GetPayload().GetId()}, nil
+
+	case *didMsgs.MsgUpdateDid:
+		return []string{msg.GetPayload().GetId()}, nil
+
+	case *resourceMsgs.MsgCreateResource:
+		return []string{msg.GetPayload().GetId()}, nil
+
+	default:
+		return nil, messages.MessageNotSupported(cosmosMsg)
+	}
+}

cmd/bdjuno/main.go

@@ -1,6 +1,8 @@
 package main
 
 import (
+	"github.com/cheqd/cheqd-node/app"
+
 	"github.com/cosmos/cosmos-sdk/types/module"
 	"github.com/forbole/juno/v3/cmd"
 	initcmd "github.com/forbole/juno/v3/cmd/init"
@@ -56,6 +58,7 @@ func main() {
 func getBasicManagers() []module.BasicManager {
 	return []module.BasicManager{
 		gaiaapp.ModuleBasics,
+		app.ModuleBasics,
 	}
 }
 
@@ -65,5 +68,6 @@ func getBasicManagers() []module.BasicManager {
 func getAddressesParser() messages.MessageAddressesParser {
 	return messages.JoinMessageParsers(
 		messages.CosmosMessageAddressesParser,
+		CheqdAddressesParser,
 	)
 }

database/bank_test.go

@@ -4,8 +4,6 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 
 	dbtypes "github.com/forbole/bdjuno/v3/database/types"
-
-	bddbtypes "github.com/forbole/bdjuno/v3/database/types"
 )
 
 func (suite *DbTestSuite) TestBigDipperDb_SaveSupply() {
@@ -18,9 +16,9 @@ func (suite *DbTestSuite) TestBigDipperDb_SaveSupply() {
 	suite.Require().NoError(err)
 
 	// Verify the data
-	expected := bddbtypes.NewSupplyRow(dbtypes.NewDbCoins(original), 10)
+	expected := dbtypes.NewSupplyRow(dbtypes.NewDbCoins(original), 10)
 
-	var rows []bddbtypes.SupplyRow
+	var rows []dbtypes.SupplyRow
 	err = suite.database.Sqlx.Select(&rows, `SELECT * FROM supply`)
 	suite.Require().NoError(err)
 	suite.Require().Len(rows, 1, "supply table should contain only one row")
@@ -37,7 +35,7 @@ func (suite *DbTestSuite) TestBigDipperDb_SaveSupply() {
 	suite.Require().NoError(err)
 
 	// Verify the data
-	rows = []bddbtypes.SupplyRow{}
+	rows = []dbtypes.SupplyRow{}
 	err = suite.database.Sqlx.Select(&rows, `SELECT * FROM supply`)
 	suite.Require().NoError(err)
 	suite.Require().Len(rows, 1, "supply table should contain only one row")
@@ -51,9 +49,9 @@ func (suite *DbTestSuite) TestBigDipperDb_SaveSupply() {
 	suite.Require().NoError(err)
 
 	// Verify the data
-	expected = bddbtypes.NewSupplyRow(dbtypes.NewDbCoins(coins), 10)
+	expected = dbtypes.NewSupplyRow(dbtypes.NewDbCoins(coins), 10)
 
-	rows = []bddbtypes.SupplyRow{}
+	rows = []dbtypes.SupplyRow{}
 	err = suite.database.Sqlx.Select(&rows, `SELECT * FROM supply`)
 	suite.Require().NoError(err)
 	suite.Require().Len(rows, 1, "supply table should contain only one row")
@@ -67,9 +65,9 @@ func (suite *DbTestSuite) TestBigDipperDb_SaveSupply() {
 	suite.Require().NoError(err)
 
 	// Verify the data
-	expected = bddbtypes.NewSupplyRow(dbtypes.NewDbCoins(coins), 20)
+	expected = dbtypes.NewSupplyRow(dbtypes.NewDbCoins(coins), 20)
 
-	rows = []bddbtypes.SupplyRow{}
+	rows = []dbtypes.SupplyRow{}
 	err = suite.database.Sqlx.Select(&rows, `SELECT * FROM supply`)
 	suite.Require().NoError(err)
 	suite.Require().Len(rows, 1, "supply table should contain only one row")

database/distribution.go

@@ -52,3 +52,14 @@ WHERE distribution_params.height <= excluded.height`
 
 	return nil
 }
+
+// GetDelegators returns the current delegators set
+func (db *Db) GetDelegators() ([]string, error) {
+	var rows []string
+	err := db.Sqlx.Select(&rows, `SELECT DISTINCT (address) FROM top_accounts `)
+	if err != nil {
+		return nil, err
+	}
+
+	return rows, nil
+}

database/schema/02-bank.sql

@@ -7,4 +7,4 @@ CREATE TABLE supply
     height     BIGINT  NOT NULL,
     CHECK (one_row_id)
 );
-CREATE INDEX supply_height_index ON supply (height);
+CREATE INDEX supply_height_index ON supply (height);

database/schema/13-top_accounts.sql

@@ -0,0 +1,11 @@
+CREATE TABLE top_accounts
+(
+    address         TEXT   NOT NULL REFERENCES account (address) PRIMARY KEY,
+    available       BIGINT DEFAULT 0,
+    delegation      BIGINT DEFAULT 0,
+    redelegation    BIGINT DEFAULT 0,
+    unbonding       BIGINT DEFAULT 0,
+    reward          BIGINT DEFAULT 0,
+    sum             BIGINT NOT NULL DEFAULT 0
+);
+CREATE INDEX top_accounts_sum_index ON top_accounts (sum);

database/top_accounts.go

@@ -0,0 +1,54 @@
+package database
+
+import (
+	"fmt"
+
+	"github.com/forbole/bdjuno/v3/types"
+)
+
+func (db *Db) SaveTopAccountsBalance(column string, bals []types.NativeTokenAmount) error {
+	if len(bals) == 0 {
+		return nil
+	}
+
+	stmt := fmt.Sprintf("INSERT INTO top_accounts (address, %s) VALUES ", column) //nolint
+
+	var params []interface{}
+
+	for i, bal := range bals {
+		bi := i * 2
+		stmt += fmt.Sprintf("($%d, $%d),", bi+1, bi+2)
+
+		params = append(params, bal.Address, bal.Balance.String())
+	}
+
+	stmt = stmt[:len(stmt)-1]
+	stmt += fmt.Sprintf("ON CONFLICT (address) DO UPDATE SET %s = excluded.%s ", column, column)
+
+	_, err := db.Sql.Exec(stmt, params...)
+	return err
+
+}
+
+func (db *Db) GetAccountBalanceSum(address string) (string, error) {
+	stmt := `SELECT 
+COALESCE(available,0) + COALESCE(delegation,0) + COALESCE(redelegation,0) + COALESCE(unbonding,0) + COALESCE(reward,0) 
+as sum FROM top_accounts WHERE address = $1 
+`
+	var rows []string
+	err := db.Sqlx.Select(&rows, stmt, address)
+	if err != nil || len(rows) == 0 {
+		return "0", err
+	}
+
+	return rows[0], nil
+}
+
+func (db *Db) UpdateTopAccountsSum(address, sum string) error {
+	stmt := `INSERT INTO top_accounts (address, sum) VALUES ($1, $2) 
+ON CONFLICT (address) DO UPDATE SET sum = excluded.sum`
+
+	_, err := db.Sql.Exec(stmt, address, sum)
+	return err
+
+}

database/top_accounts_test.go

@@ -0,0 +1,143 @@
+package database_test
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	dbtypes "github.com/forbole/bdjuno/v3/database/types"
+	"github.com/forbole/bdjuno/v3/types"
+)
+
+func (suite *DbTestSuite) TestSaveTopAccountsBalance() {
+	suite.getAccount("cosmos1z4hfrxvlgl4s8u4n5ngjcw8kdqrcv43599amxs")
+
+	// Test saving balances
+	amount := types.NewNativeTokenAmount(
+		"cosmos1z4hfrxvlgl4s8u4n5ngjcw8kdqrcv43599amxs",
+		sdk.NewInt(100),
+		10,
+	)
+
+	err := suite.database.SaveTopAccountsBalance("available", []types.NativeTokenAmount{amount})
+	suite.Require().NoError(err)
+
+	err = suite.database.SaveTopAccountsBalance("delegation", []types.NativeTokenAmount{amount})
+	suite.Require().NoError(err)
+
+	err = suite.database.SaveTopAccountsBalance("redelegation", []types.NativeTokenAmount{amount})
+	suite.Require().NoError(err)
+
+	err = suite.database.SaveTopAccountsBalance("unbonding", []types.NativeTokenAmount{amount})
+	suite.Require().NoError(err)
+
+	err = suite.database.SaveTopAccountsBalance("reward", []types.NativeTokenAmount{amount})
+	suite.Require().NoError(err)
+
+	err = suite.database.UpdateTopAccountsSum("cosmos1z4hfrxvlgl4s8u4n5ngjcw8kdqrcv43599amxs", "500")
+	suite.Require().NoError(err)
+
+	// Verify data
+	expected := dbtypes.NewTopAccountsRow("cosmos1z4hfrxvlgl4s8u4n5ngjcw8kdqrcv43599amxs", 100, 100, 100, 100, 100, 500)
+
+	var rows []dbtypes.TopAccountsRow
+	err = suite.database.Sqlx.Select(&rows, `SELECT * FROM top_accounts`)
+	suite.Require().NoError(err)
+	suite.Require().Len(rows, 1)
+	suite.Require().True(expected.Equals(rows[0]))
+
+	// Test saving higher values
+	newAmount := types.NewNativeTokenAmount(
+		"cosmos1z4hfrxvlgl4s8u4n5ngjcw8kdqrcv43599amxs",
+		sdk.NewInt(200),
+		10,
+	)
+
+	err = suite.database.SaveTopAccountsBalance("available", []types.NativeTokenAmount{newAmount})
+	suite.Require().NoError(err)
+
+	err = suite.database.SaveTopAccountsBalance("delegation", []types.NativeTokenAmount{newAmount})
+	suite.Require().NoError(err)
+
+	err = suite.database.SaveTopAccountsBalance("redelegation", []types.NativeTokenAmount{newAmount})
+	suite.Require().NoError(err)
+
+	err = suite.database.SaveTopAccountsBalance("unbonding", []types.NativeTokenAmount{newAmount})
+	suite.Require().NoError(err)
+
+	err = suite.database.SaveTopAccountsBalance("reward", []types.NativeTokenAmount{newAmount})
+	suite.Require().NoError(err)
+
+	err = suite.database.UpdateTopAccountsSum("cosmos1z4hfrxvlgl4s8u4n5ngjcw8kdqrcv43599amxs", "1000")
+	suite.Require().NoError(err)
+
+	// Verify data
+	expected = dbtypes.NewTopAccountsRow("cosmos1z4hfrxvlgl4s8u4n5ngjcw8kdqrcv43599amxs", 200, 200, 200, 200, 200, 1000)
+	err = suite.database.Sqlx.Select(&rows, `SELECT * FROM top_accounts`)
+	suite.Require().NoError(err)
+	suite.Require().Len(rows, 1)
+	suite.Require().True(expected.Equals(rows[0]))
+
+}
+
+func (suite *DbTestSuite) TestGetAccountBalanceSum() {
+	suite.getAccount("cosmos1z4hfrxvlgl4s8u4n5ngjcw8kdqrcv43599amxs")
+
+	// Store balances
+	amount := types.NewNativeTokenAmount(
+		"cosmos1z4hfrxvlgl4s8u4n5ngjcw8kdqrcv43599amxs",
+		sdk.NewInt(100),
+		10,
+	)
+
+	err := suite.database.SaveTopAccountsBalance("available", []types.NativeTokenAmount{amount})
+	suite.Require().NoError(err)
+
+	err = suite.database.SaveTopAccountsBalance("delegation", []types.NativeTokenAmount{amount})
+	suite.Require().NoError(err)
+
+	err = suite.database.SaveTopAccountsBalance("redelegation", []types.NativeTokenAmount{amount})
+	suite.Require().NoError(err)
+
+	err = suite.database.SaveTopAccountsBalance("unbonding", []types.NativeTokenAmount{amount})
+	suite.Require().NoError(err)
+
+	err = suite.database.SaveTopAccountsBalance("reward", []types.NativeTokenAmount{amount})
+	suite.Require().NoError(err)
+
+	// Verify Data
+	expectedSum := "500"
+	sum, err := suite.database.GetAccountBalanceSum("cosmos1z4hfrxvlgl4s8u4n5ngjcw8kdqrcv43599amxs")
+	suite.Require().NoError(err)
+	suite.Require().Equal(expectedSum, sum)
+
+	// Verify getting 0 amount
+	expectedSum = "0"
+	sum, err = suite.database.GetAccountBalanceSum("")
+	suite.Require().NoError(err)
+	suite.Require().Equal(expectedSum, sum)
+}
+
+func (suite *DbTestSuite) TestUpdateTopAccountsSum() {
+	suite.getAccount("cosmos1z4hfrxvlgl4s8u4n5ngjcw8kdqrcv43599amxs")
+
+	// Store top accounts sum
+	amount := "100"
+	err := suite.database.UpdateTopAccountsSum("cosmos1z4hfrxvlgl4s8u4n5ngjcw8kdqrcv43599amxs", amount)
+	suite.Require().NoError(err)
+
+	// Verify data
+	var rows []string
+	err = suite.database.Sqlx.Select(&rows, `SELECT sum FROM top_accounts`)
+	suite.Require().NoError(err)
+	suite.Require().Len(rows, 1)
+	suite.Require().Equal(amount, rows[0])
+
+	// Store different amount
+	amount = "200"
+	err = suite.database.UpdateTopAccountsSum("cosmos1z4hfrxvlgl4s8u4n5ngjcw8kdqrcv43599amxs", amount)
+	suite.Require().NoError(err)
+
+	// Verify data
+	err = suite.database.Sqlx.Select(&rows, `SELECT sum FROM top_accounts`)
+	suite.Require().NoError(err)
+	suite.Require().Len(rows, 1)
+	suite.Require().Equal(amount, rows[0])
+}

database/types/top_accounts.go

@@ -0,0 +1,34 @@
+package types
+
+type TopAccountsRow struct {
+	Address      string `db:"address"`
+	Available    int64  `db:"available"`
+	Delegation   int64  `db:"delegation"`
+	Redelegation int64  `db:"redelegation"`
+	Unbonding    int64  `db:"unbonding"`
+	Reward       int64  `db:"reward"`
+	Sum          int64  `db:"sum"`
+}
+
+func NewTopAccountsRow(
+	address string, available, delegation, redelegation, unbonding, reward, sum int64,
+) TopAccountsRow {
+	return TopAccountsRow{
+		Address:      address,
+		Available:    available,
+		Delegation:   delegation,
+		Redelegation: redelegation,
+		Unbonding:    unbonding,
+		Reward:       reward,
+		Sum:          sum,
+	}
+}
+
+// Equals return true if one TopAccountsRow representing the same row as the original one
+func (a TopAccountsRow) Equals(b TopAccountsRow) bool {
+	return a.Address == b.Address &&
+		a.Available == b.Available &&
+		a.Redelegation == b.Redelegation &&
+		a.Unbonding == b.Unbonding &&
+		a.Reward == b.Reward
+}