feat: TotalCoin and TotalCoinKeeper implementation

gno.land/cmd/gnoland/testdata/restart_missing_type.txtar

@@ -9,11 +9,11 @@ gnokey sign -tx-path $WORK/tx1.tx -chainid tendermint_test -account-sequence 0 t
 ! gnokey broadcast $WORK/tx1.tx
 stderr 'out of gas'
 
-gnokey sign -tx-path $WORK/tx2.tx -chainid tendermint_test -account-sequence 1 test1
+gnokey sign -tx-path $WORK/tx2.tx -chainid tendermint_test -account-sequence 0 test1
 gnokey broadcast $WORK/tx2.tx
 stdout 'OK!'
 
-gnokey sign -tx-path $WORK/tx3.tx -chainid tendermint_test -account-sequence 2 test1
+gnokey sign -tx-path $WORK/tx3.tx -chainid tendermint_test -account-sequence 1 test1
 gnokey broadcast $WORK/tx3.tx
 stdout 'OK!'
 

gno.land/pkg/gnoland/app.go

@@ -87,7 +87,8 @@ func NewAppWithOptions(cfg *AppOptions) (abci.Application, error) {
 
 	// Construct keepers.
 	acctKpr := auth.NewAccountKeeper(mainKey, ProtoGnoAccount)
-	bankKpr := bank.NewBankKeeper(acctKpr)
+	tckpr := bank.NewTotalCoinKeeper(mainKey)
+	bankKpr := bank.NewBankKeeper(acctKpr, tckpr)
 	vmk := vm.NewVMKeeper(baseKey, mainKey, acctKpr, bankKpr, cfg.MaxCycles)
 
 	// Set InitChainer
@@ -291,7 +292,7 @@ func (cfg InitChainerConfig) loadAppState(ctx sdk.Context, appState any) ([]abci
 	for _, bal := range state.Balances {
 		acc := cfg.acctKpr.NewAccountWithAddress(ctx, bal.Address)
 		cfg.acctKpr.SetAccount(ctx, acc)
-		err := cfg.bankKpr.SetCoins(ctx, bal.Address, bal.Amount)
+		_, err := cfg.bankKpr.AddCoins(ctx, bal.Address, bal.Amount)
 		if err != nil {
 			panic(err)
 		}

gno.land/pkg/sdk/vm/builtins.go

@@ -37,7 +37,7 @@
 }
 
 func (bnk *SDKBanker) TotalCoin(denom string) int64 {
-	panic("not yet implemented")
+	return bnk.vmk.bank.TotalCoin(bnk.ctx, denom)
 }
 
 func (bnk *SDKBanker) IssueCoin(b32addr crypto.Bech32Address, denom string, amount int64) {

gno.land/pkg/sdk/vm/common_test.go

@@ -46,7 +46,8 @@ func _setupTestEnv(cacheStdlibs bool) testEnv {
 
 	ctx := sdk.NewContext(sdk.RunTxModeDeliver, ms, &bft.Header{ChainID: "test-chain-id"}, log.NewNoopLogger())
 	acck := authm.NewAccountKeeper(iavlCapKey, std.ProtoBaseAccount)
-	bank := bankm.NewBankKeeper(acck)
+	tck := bankm.NewTotalCoinKeeper(iavlCapKey)
+	bank := bankm.NewBankKeeper(acck, tck)
 	vmk := NewVMKeeper(baseCapKey, iavlCapKey, acck, bank, 100_000_000)
 
 	mcw := ms.MultiCacheWrap()

gno.land/pkg/sdk/vm/gas_test.go

@@ -147,7 +147,7 @@ func setupAddPkg(success bool) (sdk.Context, sdk.Tx, vmHandler) {
 	addr := crypto.AddressFromPreimage([]byte("test1"))
 	acc := env.acck.NewAccountWithAddress(ctx, addr)
 	env.acck.SetAccount(ctx, acc)
-	env.bank.SetCoins(ctx, addr, std.MustParseCoins(ugnot.ValueString(10000000)))
+	env.bank.AddCoins(ctx, addr, std.MustParseCoins(ugnot.ValueString(10000000)))
 	// success message
 	var files []*std.MemFile
 	if success {

gno.land/pkg/sdk/vm/keeper_test.go

@@ -5,7 +5,6 @@ package vm
 import (
 	"errors"
 	"fmt"
-	"strings"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -31,7 +30,7 @@ func TestVMKeeperAddPackage(t *testing.T) {
 	addr := crypto.AddressFromPreimage([]byte("addr1"))
 	acc := env.acck.NewAccountWithAddress(ctx, addr)
 	env.acck.SetAccount(ctx, acc)
-	env.bank.SetCoins(ctx, addr, std.MustParseCoins(coinsString))
+	env.bank.AddCoins(ctx, addr, std.MustParseCoins(coinsString))
 	assert.True(t, env.bank.GetCoins(ctx, addr).IsEqual(std.MustParseCoins(coinsString)))
 
 	// Create test package.
@@ -76,7 +75,7 @@ func TestVMKeeperOrigSend1(t *testing.T) {
 	addr := crypto.AddressFromPreimage([]byte("addr1"))
 	acc := env.acck.NewAccountWithAddress(ctx, addr)
 	env.acck.SetAccount(ctx, acc)
-	env.bank.SetCoins(ctx, addr, std.MustParseCoins(coinsString))
+	env.bank.AddCoins(ctx, addr, std.MustParseCoins(coinsString))
 	assert.True(t, env.bank.GetCoins(ctx, addr).IsEqual(std.MustParseCoins(coinsString)))
 
 	// Create test package.
@@ -121,7 +120,7 @@ func TestVMKeeperOrigSend2(t *testing.T) {
 	addr := crypto.AddressFromPreimage([]byte("addr1"))
 	acc := env.acck.NewAccountWithAddress(ctx, addr)
 	env.acck.SetAccount(ctx, acc)
-	env.bank.SetCoins(ctx, addr, std.MustParseCoins(coinsString))
+	env.bank.AddCoins(ctx, addr, std.MustParseCoins(coinsString))
 	assert.True(t, env.bank.GetCoins(ctx, addr).IsEqual(std.MustParseCoins(coinsString)))
 
 	// Create test package.
@@ -162,8 +161,7 @@ func GetAdmin() string {
 	res, err := env.vmk.Call(ctx, msg2)
 	assert.Error(t, err)
 	assert.Equal(t, "", res)
-	fmt.Println(err.Error())
-	assert.True(t, strings.Contains(err.Error(), "insufficient coins error"))
+	assert.Equal(t, err.Error(), "invalid coins error")
 }
 
 // Sending more than tx send fails.
@@ -175,7 +173,7 @@ func TestVMKeeperOrigSend3(t *testing.T) {
 	addr := crypto.AddressFromPreimage([]byte("addr1"))
 	acc := env.acck.NewAccountWithAddress(ctx, addr)
 	env.acck.SetAccount(ctx, acc)
-	env.bank.SetCoins(ctx, addr, std.MustParseCoins(coinsString))
+	env.bank.AddCoins(ctx, addr, std.MustParseCoins(coinsString))
 	assert.True(t, env.bank.GetCoins(ctx, addr).IsEqual(std.MustParseCoins(coinsString)))
 
 	// Create test package.
@@ -219,7 +217,7 @@ func TestVMKeeperRealmSend1(t *testing.T) {
 	addr := crypto.AddressFromPreimage([]byte("addr1"))
 	acc := env.acck.NewAccountWithAddress(ctx, addr)
 	env.acck.SetAccount(ctx, acc)
-	env.bank.SetCoins(ctx, addr, std.MustParseCoins(coinsString))
+	env.bank.AddCoins(ctx, addr, std.MustParseCoins(coinsString))
 	assert.True(t, env.bank.GetCoins(ctx, addr).IsEqual(std.MustParseCoins(coinsString)))
 
 	// Create test package.
@@ -263,7 +261,7 @@ func TestVMKeeperRealmSend2(t *testing.T) {
 	addr := crypto.AddressFromPreimage([]byte("addr1"))
 	acc := env.acck.NewAccountWithAddress(ctx, addr)
 	env.acck.SetAccount(ctx, acc)
-	env.bank.SetCoins(ctx, addr, std.MustParseCoins(coinsString))
+	env.bank.AddCoins(ctx, addr, std.MustParseCoins(coinsString))
 	assert.True(t, env.bank.GetCoins(ctx, addr).IsEqual(std.MustParseCoins(coinsString)))
 
 	// Create test package.
@@ -307,7 +305,7 @@ func TestVMKeeperOrigCallerInit(t *testing.T) {
 	addr := crypto.AddressFromPreimage([]byte("addr1"))
 	acc := env.acck.NewAccountWithAddress(ctx, addr)
 	env.acck.SetAccount(ctx, acc)
-	env.bank.SetCoins(ctx, addr, std.MustParseCoins(coinsString))
+	env.bank.AddCoins(ctx, addr, std.MustParseCoins(coinsString))
 	assert.True(t, env.bank.GetCoins(ctx, addr).IsEqual(std.MustParseCoins(coinsString)))
 
 	// Create test package.
@@ -430,7 +428,7 @@ func TestNumberOfArgsError(t *testing.T) {
 	addr := crypto.AddressFromPreimage([]byte("addr1"))
 	acc := env.acck.NewAccountWithAddress(ctx, addr)
 	env.acck.SetAccount(ctx, acc)
-	env.bank.SetCoins(ctx, addr, std.MustParseCoins(coinsString))
+	env.bank.AddCoins(ctx, addr, std.MustParseCoins(coinsString))
 	assert.True(t, env.bank.GetCoins(ctx, addr).IsEqual(std.MustParseCoins(coinsString)))
 
 	// Create test package.
@@ -469,7 +467,7 @@ func TestVMKeeperReinitialize(t *testing.T) {
 	addr := crypto.AddressFromPreimage([]byte("addr1"))
 	acc := env.acck.NewAccountWithAddress(ctx, addr)
 	env.acck.SetAccount(ctx, acc)
-	env.bank.SetCoins(ctx, addr, std.MustParseCoins(coinsString))
+	env.bank.AddCoins(ctx, addr, std.MustParseCoins(coinsString))
 	assert.True(t, env.bank.GetCoins(ctx, addr).IsEqual(std.MustParseCoins(coinsString)))
 
 	// Create test package.

gnovm/tests/file.go

@@ -21,6 +21,7 @@
 	osm "github.com/gnolang/gno/tm2/pkg/os"
 	"github.com/gnolang/gno/tm2/pkg/sdk"
 	"github.com/gnolang/gno/tm2/pkg/std"
+	"github.com/gnolang/overflow"
 	"github.com/pmezard/go-difflib/difflib"
 )
 
@@ -548,20 +549,28 @@
 
 type testBanker struct {
 	coinTable map[crypto.Bech32Address]std.Coins
+	totalCoin map[string]int64
 }
 
 func newTestBanker(args ...interface{}) *testBanker {
 	coinTable := make(map[crypto.Bech32Address]std.Coins)
+	totalCoin := make(map[string]int64)
 	if len(args)%2 != 0 {
 		panic("newTestBanker requires even number of arguments; addr followed by coins")
 	}
 	for i := 0; i < len(args); i += 2 {
 		addr := args[i].(crypto.Bech32Address)
-		amount := args[i+1].(std.Coins)
-		coinTable[addr] = amount
+		coins := args[i+1].(std.Coins)
+		coinTable[addr] = coins
+		for _, coin := range coins {
+			if coin.IsValid() {
+				totalCoin[coin.Denom] += coin.Amount
+			}
+		}
 	}
 	return &testBanker{
 		coinTable: coinTable,
+		totalCoin: totalCoin,
 	}
 }
 
@@ -586,23 +595,31 @@
 	tb.coinTable[from] = frest
 	// Second, add to 'to'.
 	// NOTE: even works when from==to, due to 2-step isolation.
-	tcoins, _ := tb.coinTable[to]
+	tcoins := tb.coinTable[to]
 	tsum := tcoins.Add(amt)
 	tb.coinTable[to] = tsum
 }
 
 func (tb *testBanker) TotalCoin(denom string) int64 {
-	panic("not yet implemented")
+	return tb.totalCoin[denom]
 }
 
 func (tb *testBanker) IssueCoin(addr crypto.Bech32Address, denom string, amt int64) {
-	coins, _ := tb.coinTable[addr]
+	coins := tb.coinTable[addr]
 	sum := coins.Add(std.Coins{{denom, amt}})
 	tb.coinTable[addr] = sum
+
+	totalCoin := overflow.Add64p(tb.totalCoin[denom], amt)
+
+	tb.totalCoin[denom] = totalCoin
 }
 
 func (tb *testBanker) RemoveCoin(addr crypto.Bech32Address, denom string, amt int64) {
-	coins, _ := tb.coinTable[addr]
+	coins := tb.coinTable[addr]
 	rest := coins.Sub(std.Coins{{denom, amt}})
 	tb.coinTable[addr] = rest
+
+	totalCoin := overflow.Sub64p(tb.totalCoin[denom], amt)
+
+	tb.totalCoin[denom] = totalCoin
 }

tm2/pkg/sdk/bank/common_test.go

@@ -9,6 +9,7 @@ import (
 
 	"github.com/gnolang/gno/tm2/pkg/sdk"
 	"github.com/gnolang/gno/tm2/pkg/sdk/auth"
+
 	"github.com/gnolang/gno/tm2/pkg/std"
 	"github.com/gnolang/gno/tm2/pkg/store"
 	"github.com/gnolang/gno/tm2/pkg/store/iavl"
@@ -18,6 +19,7 @@ type testEnv struct {
 	ctx  sdk.Context
 	bank BankKeeper
 	acck auth.AccountKeeper
+	tck  TotalCoinKeeper
 }
 
 func setupTestEnv() testEnv {
@@ -34,7 +36,8 @@ func setupTestEnv() testEnv {
 		authCapKey, std.ProtoBaseAccount,
 	)
 
-	bank := NewBankKeeper(acck)
+	tck := NewTotalCoinKeeper(authCapKey)
+	bank := NewBankKeeper(acck, tck)
 
 	return testEnv{ctx: ctx, bank: bank, acck: acck}
 }

tm2/pkg/sdk/bank/consts.go

@@ -2,4 +2,12 @@ package bank
 
 const (
 	ModuleName = "bank"
+
+	// TotalCoinStoreKeyPrefix prefix for total-coin-by-denom store
+	TotalCoinStoreKeyPrefix = "/tc/"
 )
+
+// TotalCoinStoreKey turn an denom to key used to get it from the total coin store
+func TotalCoinStoreKey(denom string) []byte {
+	return []byte(TotalCoinStoreKeyPrefix + denom)
+}