Merge pull request #326 from KiraCore/v0.1.25-rc.10

v0.1.25-rc.10 -> master

Author: asmodat

RELEASE.md

@@ -2,7 +2,6 @@
 
 **Features:**
 
-- Removed setup step from main workflow
-- Added new transfer test to local tests
-- Fixed utils script missing home flags for some of the transaction queries
-- Added faucet account to local network setup
+- Snapshot period to 1000
+- Add example scripts
+- Add query for validator performance during snapshot period

app/app.go

@@ -8,6 +8,9 @@ import (
 
 	customante "github.com/KiraCore/sekai/app/ante"
 	"github.com/KiraCore/sekai/middleware"
+	"github.com/KiraCore/sekai/x/distributor"
+	distributorkeeper "github.com/KiraCore/sekai/x/distributor/keeper"
+	distributortypes "github.com/KiraCore/sekai/x/distributor/types"
 	"github.com/KiraCore/sekai/x/evidence"
 	evidencekeeper "github.com/KiraCore/sekai/x/evidence/keeper"
 	evidencetypes "github.com/KiraCore/sekai/x/evidence/types"
@@ -92,6 +95,7 @@ var (
 		customstaking.AppModuleBasic{},
 		customgov.AppModuleBasic{},
 		spending.AppModuleBasic{},
+		distributor.AppModuleBasic{},
 		ubi.AppModuleBasic{},
 		evidence.AppModuleBasic{},
 		tokens.AppModuleBasic{},
@@ -100,10 +104,11 @@ var (
 
 	// module account permissions
 	maccPerms = map[string][]string{
-		authtypes.FeeCollectorName: nil,
-		govtypes.ModuleName:        nil,
-		minttypes.ModuleName:       {authtypes.Minter},
-		spendingtypes.ModuleName:   nil,
+		authtypes.FeeCollectorName:  nil,
+		govtypes.ModuleName:         nil,
+		minttypes.ModuleName:        {authtypes.Minter},
+		spendingtypes.ModuleName:    nil,
+		distributortypes.ModuleName: nil,
 	}
 
 	// module accounts that are allowed to receive tokens
@@ -138,6 +143,7 @@ type SekaiApp struct {
 	EvidenceKeeper       evidencekeeper.Keeper
 	SpendingKeeper       spendingkeeper.Keeper
 	UbiKeeper            ubikeeper.Keeper
+	DistrKeeper          distributorkeeper.Keeper
 
 	// Module Manager
 	mm *module.Manager
@@ -180,6 +186,7 @@ func NewInitApp(
 		stakingtypes.ModuleName,
 		govtypes.ModuleName,
 		spendingtypes.ModuleName,
+		distributortypes.ModuleName,
 		ubitypes.ModuleName,
 		tokenstypes.ModuleName,
 		feeprocessingtypes.ModuleName,
@@ -223,6 +230,7 @@ func NewInitApp(
 	app.CustomStakingKeeper = *customStakingKeeper.SetHooks(
 		stakingtypes.NewMultiStakingHooks(app.CustomSlashingKeeper.Hooks()),
 	)
+	app.DistrKeeper = distributorkeeper.NewKeeper(keys[distributortypes.ModuleName], appCodec, app.AccountKeeper, app.BankKeeper, app.CustomStakingKeeper, app.CustomGovKeeper)
 
 	app.UpgradeKeeper = upgradekeeper.NewKeeper(keys[upgradetypes.StoreKey], appCodec, app.CustomStakingKeeper)
 
@@ -291,6 +299,7 @@ func NewInitApp(
 		customgov.NewAppModule(app.CustomGovKeeper),
 		tokens.NewAppModule(app.TokensKeeper, app.CustomGovKeeper),
 		spending.NewAppModule(app.SpendingKeeper, app.CustomGovKeeper, app.BankKeeper),
+		distributor.NewAppModule(app.DistrKeeper, app.CustomGovKeeper),
 		ubi.NewAppModule(app.UbiKeeper, app.CustomGovKeeper),
 		feeprocessing.NewAppModule(app.FeeProcessingKeeper),
 		evidence.NewAppModule(app.EvidenceKeeper),
@@ -305,6 +314,7 @@ func NewInitApp(
 		upgradetypes.ModuleName, slashingtypes.ModuleName,
 		evidencetypes.ModuleName, stakingtypes.ModuleName,
 		spendingtypes.ModuleName, ubitypes.ModuleName,
+		distributortypes.ModuleName,
 	)
 	app.mm.SetOrderEndBlockers(
 		banktypes.ModuleName, upgradetypes.ModuleName, tokenstypes.ModuleName,
@@ -314,6 +324,7 @@ func NewInitApp(
 		stakingtypes.ModuleName,
 		feeprocessingtypes.ModuleName,
 		spendingtypes.ModuleName, ubitypes.ModuleName,
+		distributortypes.ModuleName,
 	)
 
 	// NOTE: The genutils moodule must occur after staking so that pools are
@@ -335,6 +346,7 @@ func NewInitApp(
 		spendingtypes.ModuleName,
 		ubitypes.ModuleName,
 		paramstypes.ModuleName,
+		distributortypes.ModuleName,
 	)
 
 	app.mm.RegisterRoutes(app.Router(), app.QueryRouter(), encodingConfig.Amino)

proto/kira/distributor/genesis.proto

@@ -0,0 +1,46 @@
+syntax = "proto3";
+package kira.distributor;
+
+option go_package = "github.com/KiraCore/sekai/x/distributor/types";
+
+import "gogoproto/gogo.proto";
+
+message ValidatorVote {
+  string cons_addr = 1;
+  int64 height = 2;
+}
+
+// GenesisState defines the distributor module's genesis state.
+message GenesisState {
+  // fees that are kept in treasury that is not distributed yet - community pool
+  repeated string fees_treasury = 1 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Coin",
+    (gogoproto.nullable) = false
+  ];
+  // fees collected from genesis
+  repeated string fees_collected = 2 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Coin",
+    (gogoproto.nullable) = false
+  ];
+  // number of blocks considered for reward calculation
+  int64 snap_period = 3;
+  // validator historical votes
+  repeated ValidatorVote validator_votes = 4 [(gogoproto.nullable) = false];
+}
+
+// https://www.notion.so/kira-network/KIP-73-Fee-Reward-Distributor-v1-32b3d1dc90024befa7bb9680c6a425cd
+
+// {
+//  snap_period: <integer>,
+//  snap_block: <integer>,
+// 	snap_balances: [ { 
+// 		denom: <string>, 
+// 		amount: <integer> }, 
+// 	{ ... }, ... ]
+// }
+
+// How to distribute multiple currency fees?
+// How to manage distributed and not distributed rewards, current fee balance?
+// Distribute the rewards every block - keep remainings
+// Check how SDK distribution module detect who produce the block
+// How to get accumulated history of participation of previous blocks? (Slashing module still keeps the history or it should be added again?)

proto/kira/distributor/query.proto

@@ -0,0 +1,64 @@
+syntax = "proto3";
+package kira.distributor;
+
+import "cosmos/base/query/v1beta1/pagination.proto";
+import "gogoproto/gogo.proto";
+import "google/protobuf/any.proto";
+import "google/api/annotations.proto";
+
+option go_package = "github.com/KiraCore/sekai/x/distributor/types";
+
+// Query defines the gRPC querier service.
+service Query {
+  // FeesTreasury queries fee treasury
+  rpc FeesTreasury(QueryFeesTreasuryRequest) returns (QueryFeesTreasuryResponse) {
+    option (google.api.http).get =
+        "/kira/distributor/v1beta1/fees_treasury";
+  }
+  // FeesCollected queries fees collected from genesis
+  rpc FeesCollected(QueryFeesCollectedRequest) returns (QueryFeesCollectedResponse) {
+    option (google.api.http).get = "/kira/distributor/v1beta1/fees_collected";
+  }
+  // SnapshotPeriod queries number of blocks considered for reward calculation
+  rpc SnapshotPeriod(QuerySnapshotPeriodRequest) returns (QuerySnapshotPeriodResponse) {
+    option (google.api.http).get = "/kira/distributor/v1beta1/snapshot_period";
+  }
+  // SnapPeriodPerformance queries number of blocks signed during the snap period
+  rpc SnapshotPeriodPerformance(QuerySnapshotPeriodPerformanceRequest) returns (QuerySnapshotPeriodPerformanceResponse) {
+    option (google.api.http).get = "/kira/distributor/v1beta1/snapshot_period_performance/{validator_address}";
+  }
+}
+
+message QueryFeesTreasuryRequest {
+}
+
+message QueryFeesTreasuryResponse {
+  repeated string coins = 1 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Coin",
+    (gogoproto.nullable) = false
+  ];
+}
+
+message QueryFeesCollectedRequest {}
+
+message QueryFeesCollectedResponse {
+  repeated string coins = 1 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Coin",
+    (gogoproto.nullable) = false
+  ];
+}
+
+message QuerySnapshotPeriodRequest {}
+
+message QuerySnapshotPeriodResponse {
+  int64 snapshot_period = 1;
+}
+
+message QuerySnapshotPeriodPerformanceRequest {
+  string validator_address = 1;
+}
+
+message QuerySnapshotPeriodPerformanceResponse {
+  int64 performance = 1;
+  int64 snapshot_period = 2;
+}

proto/kira/distributor/tx.proto

@@ -0,0 +1,13 @@
+syntax = "proto3";
+package kira.distributor;
+
+option go_package = "github.com/KiraCore/sekai/x/distributor/types";
+option (gogoproto.equal_all) = true;
+
+import "gogoproto/gogo.proto";
+import "google/protobuf/any.proto";
+import "cosmos_proto/cosmos.proto";
+
+// Msg defines the distributor Msg service.
+service Msg {
+}

proto/kira/gov/network_properties.proto

@@ -35,6 +35,7 @@ enum NetworkProperty {
     MIN_IDENTITY_APPROVAL_TIP = 17 [(gogoproto.enumvalue_customname) = "MinIdentityApprovalTip"]; // minimum amount of tip to be paid to the approver per request
     UNIQUE_IDENTITY_KEYS = 18 [(gogoproto.enumvalue_customname) = "UniqueIdentityKeys"]; // manages unique identity keys to be used as an address identifier
     UBI_HARDCAP = 19 [(gogoproto.enumvalue_customname) = "UbiHardcap"]; // a maximum amount of additional KEX that can be created per year
+    VALIDATORS_FEE_SHARE = 20 [(gogoproto.enumvalue_customname) = "ValidatorsFeeShare"]; // the percentage that validators get from collected fees
 }
 
 message NetworkPropertyValue {
@@ -65,4 +66,5 @@ message NetworkProperties {
     uint64 min_identity_approval_tip = 18; // minimum amount of tip to be paid to the approver per request
     string unique_identity_keys = 19; // manages unique identity keys to be used as an address identifier
     uint64 ubi_hardcap = 20; // a maximum amount of additional KEX that can be created per year
+    uint64 validators_fee_share = 21; // the percentage that validators get from collected fees
 }

scripts/commands/query-distributor.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+# query collected fees so far
+sekaid query distributor fees-collected
+
+# query fees treasury 
+sekaid query distributor fees-treasury
+
+# query snapshot period
+sekaid query distributor snapshot-period
+
+# query validator performance
+sekaid query distributor snapshot-period-performance kiravaloper177endc8f4tnl44q0x2qct6g9l5af6nm2vlzxd6

types/constants.go

@@ -3,6 +3,6 @@ package types
 const (
 	// we set page iteration limit for safety
 	PageIterationLimit = 512
-	SekaiVersion       = "v0.1.24-rc.8"
+	SekaiVersion       = "v0.1.25-rc.10"
 	CosmosVersion      = "v0.45.1"
 )

x/distributor/abci.go

@@ -0,0 +1,55 @@
+package distributor
+
+import (
+	"time"
+
+	abci "github.com/tendermint/tendermint/abci/types"
+
+	"github.com/KiraCore/sekai/x/distributor/keeper"
+	"github.com/KiraCore/sekai/x/distributor/types"
+	"github.com/cosmos/cosmos-sdk/telemetry"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+)
+
+// BeginBlocker sets the proposer for determining distributor 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())
+	}
+
+	for _, bondedVote := range req.LastCommitInfo.GetVotes() {
+		k.SetValidatorVote(ctx, bondedVote.Validator.Address, ctx.BlockHeight())
+	}
+
+	// remove votes older than snap period
+	snapPeriod := k.GetSnapPeriod(ctx)
+	allVotes := k.GetAllValidatorVotes(ctx)
+	for _, vote := range allVotes {
+		if vote.Height+snapPeriod <= ctx.BlockHeight() {
+			consAddr, err := sdk.ConsAddressFromBech32(vote.ConsAddr)
+			if err != nil {
+				panic(err)
+			}
+			k.DeleteValidatorVote(ctx, consAddr, vote.Height)
+		}
+	}
+
+	// record the proposer for when we payout on the next block
+	consAddr := sdk.ConsAddress(req.Header.ProposerAddress)
+	k.SetPreviousProposerConsAddr(ctx, consAddr)
+}