Adding LSM module (x/lsnative)

go.mod

@@ -4,15 +4,20 @@ go 1.19
 
 require (
 	cosmossdk.io/math v1.0.0-beta.3
+	github.com/armon/go-metrics v0.4.1
+	github.com/cosmos/cosmos-proto v1.0.0-alpha8
 	github.com/cosmos/cosmos-sdk v0.46.11
+	github.com/cosmos/go-bip39 v1.0.0
 	github.com/cosmos/ibc-go/v6 v6.1.0
 	github.com/gogo/protobuf v1.3.3
 	github.com/golang/protobuf v1.5.2
 	github.com/gorilla/mux v1.8.0
 	github.com/grpc-ecosystem/grpc-gateway v1.16.0
+	github.com/pkg/errors v0.9.1
 	github.com/rakyll/statik v0.1.7
 	github.com/spf13/cast v1.5.0
 	github.com/spf13/cobra v1.6.1
+	github.com/spf13/pflag v1.0.5
 	github.com/spf13/viper v1.14.0
 	github.com/stretchr/testify v1.8.1
 	github.com/tendermint/tendermint v0.34.27
@@ -22,6 +27,7 @@ require (
 	google.golang.org/grpc v1.52.0
 	google.golang.org/protobuf v1.28.2-0.20220831092852-f930b1dc76e8
 	gopkg.in/yaml.v2 v2.4.0
+	sigs.k8s.io/yaml v1.3.0
 )
 
 require (
@@ -36,7 +42,6 @@ require (
 	github.com/99designs/keyring v1.2.1 // indirect
 	github.com/ChainSafe/go-schnorrkel v0.0.0-20200405005733-88cbf1b4c40d // indirect
 	github.com/Workiva/go-datastructures v1.0.53 // indirect
-	github.com/armon/go-metrics v0.4.1 // indirect
 	github.com/aws/aws-sdk-go v1.40.45 // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/bgentry/go-netrc v0.0.0-20140422174119-9fd32a8b3d3d // indirect
@@ -51,8 +56,6 @@ require (
 	github.com/cometbft/cometbft-db v0.7.0 // indirect
 	github.com/confio/ics23/go v0.9.0 // indirect
 	github.com/cosmos/btcutil v1.0.5 // indirect
-	github.com/cosmos/cosmos-proto v1.0.0-alpha8 // indirect
-	github.com/cosmos/go-bip39 v1.0.0 // indirect
 	github.com/cosmos/gorocksdb v1.2.0 // indirect
 	github.com/cosmos/iavl v0.19.5 // indirect
 	github.com/cosmos/ledger-cosmos-go v0.12.2 // indirect
@@ -119,7 +122,6 @@ require (
 	github.com/pelletier/go-toml v1.9.5 // indirect
 	github.com/pelletier/go-toml/v2 v2.0.5 // indirect
 	github.com/petermattis/goid v0.0.0-20180202154549-b0b1615b78e5 // indirect
-	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/prometheus/client_golang v1.14.0 // indirect
 	github.com/prometheus/client_model v0.3.0 // indirect
@@ -132,7 +134,6 @@ require (
 	github.com/sasha-s/go-deadlock v0.3.1 // indirect
 	github.com/spf13/afero v1.9.2 // indirect
 	github.com/spf13/jwalterweatherman v1.1.0 // indirect
-	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/subosito/gotenv v1.4.1 // indirect
 	github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7 // indirect
 	github.com/tecbot/gorocksdb v0.0.0-20191217155057-f0fad39f321c // indirect
@@ -155,7 +156,6 @@ require (
 	gopkg.in/ini.v1 v1.67.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 	nhooyr.io/websocket v1.8.6 // indirect
-	sigs.k8s.io/yaml v1.3.0 // indirect
 )
 
 replace (

x/lsnative/distribution/README.md

@@ -0,0 +1,7 @@
+<!--
+order: 0
+-->
+
+# Distribution
+
+* [Distribution](spec/README.md) - Fee distribution, and staking token provision distribution.

x/lsnative/distribution/abci.go

@@ -0,0 +1,38 @@
+package distribution
+
+import (
+	"time"
+
+	abci "github.com/tendermint/tendermint/abci/types"
+
+	"github.com/cosmos/cosmos-sdk/telemetry"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/persistenceOne/persistence-sdk/v2/x/lsnative/distribution/keeper"
+	"github.com/persistenceOne/persistence-sdk/v2/x/lsnative/distribution/types"
+)
+
+// BeginBlocker sets the proposer for determining distribution during endblock
+// and distribute rewards for the previous block
+func BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock, k keeper.Keeper) {
+	defer telemetry.ModuleMeasureSince(types.ModuleName, time.Now(), telemetry.MetricKeyBeginBlocker)
+
+	// determine the total power signing the block
+	var previousTotalPower, sumPreviousPrecommitPower int64
+	for _, voteInfo := range req.LastCommitInfo.GetVotes() {
+		previousTotalPower += voteInfo.Validator.Power
+		if voteInfo.SignedLastBlock {
+			sumPreviousPrecommitPower += voteInfo.Validator.Power
+		}
+	}
+
+	// TODO this is Tendermint-dependent
+	// ref https://github.com/cosmos/cosmos-sdk/issues/3095
+	if ctx.BlockHeight() > 1 {
+		previousProposer := k.GetPreviousProposerConsAddr(ctx)
+		k.AllocateTokens(ctx, sumPreviousPrecommitPower, previousTotalPower, previousProposer, req.LastCommitInfo.GetVotes())
+	}
+
+	// record the proposer for when we payout on the next block
+	consAddr := sdk.ConsAddress(req.Header.ProposerAddress)
+	k.SetPreviousProposerConsAddr(ctx, consAddr)
+}

x/lsnative/distribution/abci_test.go

@@ -0,0 +1,107 @@
+package distribution_test
+
+import (
+	"testing"
+
+	"github.com/cosmos/cosmos-sdk/crypto/keys/ed25519"
+	cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
+	"github.com/cosmos/cosmos-sdk/simapp"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/x/staking/teststaking"
+	stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
+	"github.com/stretchr/testify/require"
+	abci "github.com/tendermint/tendermint/abci/types"
+	tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
+)
+
+const (
+	totalValidators  = 6
+	lazyValidatorIdx = 2
+	power            = 100 / totalValidators
+)
+
+var (
+	valTokens                = sdk.TokensFromConsensusPower(50, sdk.DefaultPowerReduction)
+	validatorCommissionRates = stakingtypes.NewCommissionRates(sdk.OneDec(), sdk.OneDec(), sdk.OneDec())
+)
+
+type validator struct {
+	addr   sdk.ValAddress
+	pubkey cryptotypes.PubKey
+	votes  []abci.VoteInfo
+}
+
+// Context in https://github.com/cosmos/cosmos-sdk/issues/9161
+func TestVerifyProposerRewardAssignement(t *testing.T) {
+	app := simapp.Setup(t, false)
+	ctx := app.BaseApp.NewContext(false, tmproto.Header{})
+	addrs := simapp.AddTestAddrsIncremental(app, ctx, totalValidators, valTokens)
+	tstaking := teststaking.NewHelper(t, ctx, app.StakingKeeper)
+	tstaking.Commission = validatorCommissionRates
+
+	// create validators
+	validators := make([]validator, totalValidators-1)
+	for i := range validators {
+		validators[i].addr = sdk.ValAddress(addrs[i])
+		validators[i].pubkey = ed25519.GenPrivKey().PubKey()
+		validators[i].votes = make([]abci.VoteInfo, totalValidators)
+		tstaking.CreateValidatorWithValPower(validators[i].addr, validators[i].pubkey, power, true)
+	}
+	app.EndBlock(abci.RequestEndBlock{})
+	require.NotEmpty(t, app.Commit())
+
+	// verify validators lists
+	require.Len(t, app.StakingKeeper.GetAllValidators(ctx), totalValidators)
+	for i, val := range validators {
+		// verify all validator exists
+		require.NotNil(t, app.StakingKeeper.ValidatorByConsAddr(ctx, sdk.GetConsAddress(val.pubkey)))
+
+		// populate last commit info
+		voteInfos := []abci.VoteInfo{}
+		for _, val2 := range validators {
+			voteInfos = append(voteInfos, abci.VoteInfo{
+				Validator: abci.Validator{
+					Address: sdk.GetConsAddress(val2.pubkey),
+					Power:   power,
+				},
+				SignedLastBlock: true,
+			})
+		}
+
+		// have this validator only submit the minimum amount of pre-commits
+		if i == lazyValidatorIdx {
+			for j := totalValidators * 2 / 3; j < len(voteInfos); j++ {
+				voteInfos[j].SignedLastBlock = false
+			}
+		}
+
+		validators[i].votes = voteInfos
+	}
+
+	// previous block submitted by validator n-1 (with 100% previous commits) and proposed by lazy validator
+	app.BeginBlock(abci.RequestBeginBlock{
+		Header:         tmproto.Header{Height: app.LastBlockHeight() + 1, ProposerAddress: sdk.GetConsAddress(validators[lazyValidatorIdx].pubkey)},
+		LastCommitInfo: abci.LastCommitInfo{Votes: validators[lazyValidatorIdx-1].votes},
+	})
+	require.NotEmpty(t, app.Commit())
+
+	// previous block submitted by lazy validator (with 67% previous commits) and proposed by validator n+1
+	app.BeginBlock(abci.RequestBeginBlock{
+		Header:         tmproto.Header{Height: app.LastBlockHeight() + 1, ProposerAddress: sdk.GetConsAddress(validators[lazyValidatorIdx+1].pubkey)},
+		LastCommitInfo: abci.LastCommitInfo{Votes: validators[lazyValidatorIdx].votes},
+	})
+	require.NotEmpty(t, app.Commit())
+
+	// previous block submitted by validator n+1 (with 100% previous commits) and proposed by validator n+2
+	app.BeginBlock(abci.RequestBeginBlock{
+		Header:         tmproto.Header{Height: app.LastBlockHeight() + 1, ProposerAddress: sdk.GetConsAddress(validators[lazyValidatorIdx+2].pubkey)},
+		LastCommitInfo: abci.LastCommitInfo{Votes: validators[lazyValidatorIdx+1].votes},
+	})
+	require.NotEmpty(t, app.Commit())
+
+	rewardsValidatorBeforeLazyValidator := app.DistrKeeper.GetValidatorOutstandingRewardsCoins(ctx, validators[lazyValidatorIdx+1].addr)
+	rewardsLazyValidator := app.DistrKeeper.GetValidatorOutstandingRewardsCoins(ctx, validators[lazyValidatorIdx].addr)
+	rewardsValidatorAfterLazyValidator := app.DistrKeeper.GetValidatorOutstandingRewardsCoins(ctx, validators[lazyValidatorIdx+1].addr)
+	require.True(t, rewardsLazyValidator[0].Amount.LT(rewardsValidatorAfterLazyValidator[0].Amount))
+	require.Equal(t, rewardsValidatorBeforeLazyValidator, rewardsValidatorAfterLazyValidator)
+}