feat: add vesting account handling

database/auth.go

@@ -2,13 +2,18 @@ package database
 
 import (
 	"fmt"
+	"time"
 
+	"github.com/cosmos/cosmos-sdk/x/auth/vesting/exported"
+	vestingtypes "github.com/cosmos/cosmos-sdk/x/auth/vesting/types"
+	dbtypes "github.com/forbole/bdjuno/v2/database/types"
 	dbutils "github.com/forbole/bdjuno/v2/database/utils"
+	"github.com/lib/pq"
 
 	"github.com/forbole/bdjuno/v2/types"
 )
 
-// SaveAccounts saves the given accounts inside the database
+// SaveAccounts saves the given account addresses inside the database
 func (db *Db) SaveAccounts(accounts []types.Account) error {
 	paramsNumber := 1
 	slices := dbutils.SplitAccounts(accounts, paramsNumber)
@@ -52,6 +57,146 @@ func (db *Db) saveAccounts(paramsNumber int, accounts []types.Account) error {
 	return nil
 }
 
+// SaveVestingAccounts saves the given vesting account details inside the database, including:
+// type, address, original vesting, endTime, startTime, and vesting periods
+func (db *Db) SaveVestingAccounts(vestingAccounts []exported.VestingAccount) error {
+	if len(vestingAccounts) == 0 {
+		return nil
+	}
+
+	for _, account := range vestingAccounts {
+		switch vestingAccount := account.(type) {
+		case *vestingtypes.ContinuousVestingAccount:
+			ContinuousVestingAccount := types.NewContinuousVestingAccount(*vestingAccount)
+			err := db.storeContinuousVestingAccount(ContinuousVestingAccount)
+			if err != nil {
+				return fmt.Errorf("error while storing Continuous Vesting Account: %s", err)
+			}
+
+		case *vestingtypes.DelayedVestingAccount:
+			DelayedVestingAccount := types.NewDelayedVestingAccount(*vestingAccount)
+			err := db.storeDelayedVestingAccount(DelayedVestingAccount)
+			if err != nil {
+				return fmt.Errorf("error while storing Delayed Vesting Account: %s", err)
+			}
+
+		case *vestingtypes.PeriodicVestingAccount:
+			PeriodicVestingAccount := types.NewPeriodicVestingAccount(*vestingAccount)
+			err := db.storePeriodicVestingAccount(PeriodicVestingAccount)
+			if err != nil {
+				return fmt.Errorf("error while storing Periodic Vesting Account: %s", err)
+			}
+		}
+	}
+
+	return nil
+}
+
+//storeContinuousVestingAccount stores the vesting account details of type ContinuousVestingAccount into the database
+func (db *Db) storeContinuousVestingAccount(account types.ContinuousVestingAccount) error {
+	stmt := `
+INSERT INTO vesting_account (type, address, original_vesting, end_time, start_time) 
+VALUES ($1, $2, $3, $4, $5)
+ON CONFLICT (address) DO UPDATE 
+    SET original_vesting = excluded.original_vesting, 
+		end_time = excluded.end_time, 
+		start_time = excluded.start_time`
+
+	_, err := db.Sql.Exec(stmt,
+		account.Type,
+		account.Address,
+		pq.Array(dbtypes.NewDbCoins(account.OriginalVesting)),
+		time.Unix(account.EndTime, 0).Format(time.RFC3339),
+		time.Unix(account.StartTime, 0).Format(time.RFC3339),
+	)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+//storeDelayedVestingAccount stores the vesting account details of type DelayedVestingAccount into the database
+func (db *Db) storeDelayedVestingAccount(account types.DelayedVestingAccount) error {
+	stmt := `
+INSERT INTO vesting_account (type, address, original_vesting, end_time) 
+VALUES ($1, $2, $3, $4)
+ON CONFLICT (address) DO UPDATE 
+    SET original_vesting = excluded.original_vesting, 
+		end_time = excluded.end_time`
+
+	_, err := db.Sql.Exec(
+		stmt,
+		account.Type,
+		account.Address,
+		pq.Array(dbtypes.NewDbCoins(account.OriginalVesting)),
+		time.Unix(account.EndTime, 0).Format(time.RFC3339),
+	)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+//storePeriodicVestingAccount stores the vesting account details of type PeriodicVestingAccount into the database
+func (db *Db) storePeriodicVestingAccount(account types.PeriodicVestingAccount) error {
+	stmt := `
+INSERT INTO vesting_account (type, address, original_vesting, end_time, start_time) 
+VALUES ($1, $2, $3, $4, $5) 
+ON CONFLICT (address) DO UPDATE 
+	SET type = excluded.type,
+		original_vesting = excluded.original_vesting,
+		end_time = excluded.end_time,
+		start_time = excluded.start_time
+		RETURNING id `
+
+	var vestingAccountID int
+	err := db.Sql.QueryRow(
+		stmt,
+		account.Type,
+		account.Address,
+		pq.Array(dbtypes.NewDbCoins(account.OriginalVesting)),
+		time.Unix(account.EndTime, 0).Format(time.RFC3339),
+		time.Unix(account.StartTime, 0).Format(time.RFC3339),
+	).Scan(&vestingAccountID)
+
+	if err != nil {
+		return fmt.Errorf("error while saving Periodic Vesting Account: %s", err)
+	}
+
+	err = db.storeVestingPeriods(vestingAccountID, account.VestingPeriods)
+	if err != nil {
+		return fmt.Errorf("error while storing vesting periods: %s", err)
+	}
+
+	return nil
+}
+
+//storePeriodicVestingAccount stores the vesting periods of type PeriodicVestingAccount into the database
+func (db *Db) storeVestingPeriods(vestingAccountID int, vestingPeriods []vestingtypes.Period) error {
+	stmt := `
+INSERT INTO vesting_period (vesting_account_id, period_order, length, amount) 
+VALUES `
+
+	var params []interface{}
+	for i, period := range vestingPeriods {
+		ai := i * 4
+		stmt += fmt.Sprintf("($%d,$%d,$%d,$%d),", ai+1, ai+2, ai+3, ai+4)
+
+		order := i
+		amount := pq.Array(dbtypes.NewDbCoins(period.Amount))
+		params = append(params, vestingAccountID, order, period.Length, amount)
+	}
+	stmt = stmt[:len(stmt)-1]
+
+	_, err := db.Sql.Exec(stmt, params...)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
 // GetAccounts returns all the accounts that are currently stored inside the database.
 func (db *Db) GetAccounts() ([]string, error) {
 	var rows []string

database/auth_test.go

@@ -1,8 +1,12 @@
 package database_test
 
 import (
+	"time"
+
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	authttypes "github.com/cosmos/cosmos-sdk/x/auth/types"
+	"github.com/cosmos/cosmos-sdk/x/auth/vesting/exported"
+	vestingtypes "github.com/cosmos/cosmos-sdk/x/auth/vesting/types"
 
 	"github.com/forbole/bdjuno/v2/types"
 
@@ -71,3 +75,130 @@ func (suite *DbTestSuite) TestBigDipperDb_GetAccounts() {
 		suite.Require().Equal(acc, accounts[index])
 	}
 }
+
+func (suite *DbTestSuite) Test_SaveVestingAccounts() {
+	// --- Save account addresses for foreign key contraint ---
+	queries := []string{
+		`INSERT INTO account (address) VALUES ('cosmos1ltzt0z992ke6qgmtjxtygwzn36km4cy6cqdknt')`,
+		`INSERT INTO account (address) VALUES ('cosmos1re6zjpyczs0w7flrl6uacl0r4teqtyg62crjsn')`,
+		`INSERT INTO account (address) VALUES ('cosmos1eg47ue0l85lzkfgc4leske6hcah8cz3qajpjy2')`,
+	}
+	for _, query := range queries {
+		_, err := suite.database.Sql.Exec(query)
+		suite.Require().NoError(err)
+	}
+	var accountRows []dbtypes.AccountRow
+	suite.database.Sqlx.Select(&accountRows, `SELECT * FROM account`)
+
+	// --- Prepare VestingAccounts for saving into DB ---
+	sdkCoins := sdk.NewCoins(sdk.NewCoin("desmos", sdk.NewInt(10)))
+	// ContinuousVestingAccount
+	address1, err := sdk.AccAddressFromBech32("cosmos1ltzt0z992ke6qgmtjxtygwzn36km4cy6cqdknt")
+	suite.Require().NoError(err)
+	ContinuousVestingAccount := vestingtypes.NewContinuousVestingAccount(
+		authttypes.NewBaseAccountWithAddress(address1),
+		sdkCoins,
+		time.Date(1990, 9, 9, 00, 00, 00, 000, time.UTC).Unix(), // Start Time
+		time.Date(2020, 9, 9, 00, 00, 00, 000, time.UTC).Unix(), // End Time
+	)
+
+	// DelayedVestingAccount
+	address2, _ := sdk.AccAddressFromBech32("cosmos1re6zjpyczs0w7flrl6uacl0r4teqtyg62crjsn")
+	DelayedVestingAccount := vestingtypes.NewDelayedVestingAccount(
+		authttypes.NewBaseAccountWithAddress(address2),
+		sdkCoins,
+		time.Date(2020, 9, 9, 00, 00, 00, 000, time.UTC).Unix(), // End Time
+	)
+
+	// PeriodicVestingAccount
+	address3, _ := sdk.AccAddressFromBech32("cosmos1eg47ue0l85lzkfgc4leske6hcah8cz3qajpjy2")
+	periods := []vestingtypes.Period{
+		{
+			Length: 2629743,
+			Amount: sdkCoins,
+		},
+		{
+			Length: 7889229,
+			Amount: sdkCoins,
+		},
+	}
+	PeriodicVestingAccount := vestingtypes.NewPeriodicVestingAccount(
+		authttypes.NewBaseAccountWithAddress(address3),
+		sdkCoins,
+		time.Date(1990, 9, 9, 00, 00, 00, 000, time.UTC).Unix(), // Start Time
+		periods,
+	)
+
+	// VestingAccounts
+	vestingAccounts := []exported.VestingAccount{
+		ContinuousVestingAccount,
+		DelayedVestingAccount,
+		PeriodicVestingAccount,
+	}
+
+	// --- Save the data into DB ---
+	err = suite.database.SaveVestingAccounts(vestingAccounts)
+	suite.Require().NoError(err)
+
+	// --- Verify Continuous Vesting Account ---
+	var continuousVestingAccountRow []dbtypes.ContinuousVestingAccountRow
+	err = suite.database.Sqlx.Select(&continuousVestingAccountRow, `SELECT * FROM vesting_account WHERE type = 'ContinuousVestingAccount'`)
+	suite.Require().NoError(err)
+	suite.Require().Len(continuousVestingAccountRow, 1, "ContinuousVestingAccount type should contain only one row")
+
+	expectedContinuousVestingAccountRow := dbtypes.NewContinuousVestingAccountRow(
+		1,
+		"ContinuousVestingAccount",
+		"cosmos1ltzt0z992ke6qgmtjxtygwzn36km4cy6cqdknt",
+		dbtypes.NewDbCoins(sdkCoins),
+		time.Date(2020, 9, 9, 00, 00, 00, 000, time.UTC), // EndTime
+		time.Date(1990, 9, 9, 00, 00, 00, 000, time.UTC), // StartTime
+	)
+	suite.Require().True(expectedContinuousVestingAccountRow.Equal(continuousVestingAccountRow[0]))
+
+	// --- Verify Delayed Vesting Account ---
+	var delayedVestingAccountRow []dbtypes.DelayedVestingAccountRow
+	err = suite.database.Sqlx.Select(&delayedVestingAccountRow, `SELECT id, type, address, original_vesting, end_time FROM vesting_account WHERE type = 'DelayedVestingAccount'`)
+	suite.Require().NoError(err)
+	suite.Require().Len(delayedVestingAccountRow, 1, "DelayedVestingAccountRow type should contain only one row")
+
+	expectedDelayedVestingAccountRow := dbtypes.NewDelayedVestingAccountRow(
+		2,
+		"DelayedVestingAccount",
+		"cosmos1re6zjpyczs0w7flrl6uacl0r4teqtyg62crjsn",
+		dbtypes.NewDbCoins(sdkCoins),
+		time.Date(2020, 9, 9, 00, 00, 00, 000, time.UTC), // EndTime
+	)
+	suite.Require().True(expectedDelayedVestingAccountRow.Equal(delayedVestingAccountRow[0]))
+
+	// --- Verify Periodic Vesting Account ---
+	var periodicVestingAccountRow []dbtypes.PeriodicVestingAccountRow
+	err = suite.database.Sqlx.Select(&periodicVestingAccountRow, `SELECT * FROM vesting_account WHERE type = 'PeriodicVestingAccount'`)
+	suite.Require().NoError(err)
+	suite.Require().Len(delayedVestingAccountRow, 1, "DelayedVestingAccountRow type should contain only one row")
+
+	expectedPeriodicVestingAccountRow := dbtypes.NewPeriodicVestingAccountRow(
+		3,
+		"PeriodicVestingAccount",
+		"cosmos1eg47ue0l85lzkfgc4leske6hcah8cz3qajpjy2",
+		dbtypes.NewDbCoins(sdkCoins),
+		time.Date(2020, 9, 9, 00, 00, 00, 000, time.UTC), // EndTime
+		time.Date(1990, 9, 9, 00, 00, 00, 000, time.UTC), // StartTime
+	)
+	suite.Require().True(expectedPeriodicVestingAccountRow.Equal(periodicVestingAccountRow[0]))
+
+	// --- Verify vesting periods ---
+	var vestingPeriodRows []dbtypes.VestingPeriodRow
+	err = suite.database.Sqlx.Select(&vestingPeriodRows, `SELECT * FROM vesting_period`)
+	suite.Require().NoError(err)
+	suite.Require().Len(vestingPeriodRows, 2, "vestingPeriodRows should contain only 2 rows")
+
+	expectedVestingPeriods := []dbtypes.VestingPeriodRow{
+		dbtypes.NewVestingPeriodRow(3, 0, "2629743", dbtypes.NewDbCoins(sdkCoins)),
+		dbtypes.NewVestingPeriodRow(3, 1, "7889229", dbtypes.NewDbCoins(sdkCoins)),
+	}
+	for index, vestingPeriod := range expectedVestingPeriods {
+		suite.Require().True(vestingPeriod.Equal(vestingPeriodRows[index]))
+	}
+
+}

database/schema/01-auth.sql

@@ -1,4 +1,34 @@
 CREATE TABLE account
 (
     address TEXT NOT NULL PRIMARY KEY
+);
+
+/* ---- Moved from bank.sql for vesting account usage ---- */
+CREATE TYPE COIN AS
+(
+    denom  TEXT,
+    amount TEXT
+);
+
+/* ---- AUTH/ VESTING ACCOUNT ---- */
+CREATE TABLE vesting_account
+(
+    id                  SERIAL                          PRIMARY KEY NOT NULL,
+    type                TEXT                            NOT NULL,
+    address             TEXT                            NOT NULL REFERENCES account (address),
+    original_vesting    COIN[]                          NOT NULL DEFAULT '{}',
+    end_time            TIMESTAMP WITHOUT TIME ZONE     NOT NULL,
+    start_time          TIMESTAMP WITHOUT TIME ZONE
+);
+/* ---- start_time can be empty on DelayedVestingAccount ---- */
+
+CREATE UNIQUE INDEX vesting_account_address_idx ON vesting_account (address);
+
+
+CREATE TABLE vesting_period
+(
+    vesting_account_id  INT     NOT NULL REFERENCES vesting_account (id),
+    period_order        INT     NOT NULL,
+    length              TEXT    NOT NULL,
+    amount              COIN[]  NOT NULL DEFAULT '{}'
 );

database/schema/02-bank.sql

@@ -1,9 +1,3 @@
-CREATE TYPE COIN AS
-(
-    denom  TEXT,
-    amount TEXT
-);
-
 /* ---- SUPPLY ---- */
 
 CREATE TABLE supply