feat(cmd/network): add network reward set command

go.mod

@@ -45,7 +45,7 @@ require (
 	github.com/stretchr/testify v1.7.0
 	github.com/takuoki/gocase v1.0.0
 	github.com/tendermint/flutter/v2 v2.0.3
-	github.com/tendermint/spn v0.1.1-0.20220307175754-0b579dc934ec
+	github.com/tendermint/spn v0.1.1-0.20220309210912-ae38eed8fbee
 	github.com/tendermint/tendermint v0.34.14
 	github.com/tendermint/tm-db v0.6.4
 	github.com/tendermint/vue v0.3.0

go.sum

@@ -1505,8 +1505,8 @@ github.com/tendermint/go-amino v0.16.0 h1:GyhmgQKvqF82e2oZeuMSp9JTN0N09emoSZlb2l
 github.com/tendermint/go-amino v0.16.0/go.mod h1:TQU0M1i/ImAo+tYpZi73AU3V/dKeCoMC9Sphe2ZwGME=
 github.com/tendermint/spm v0.1.8/go.mod h1:iHgfQ5YOI6ONc9E7ugGQolVdfSMHpeXfZ/OpXuN/42Q=
 github.com/tendermint/spn v0.1.1-0.20211210094128-4ca78a240c57/go.mod h1:p4BO8YC6kOKSKqMfySqaLHfwBmuPE/QcLwnnVhh7H9M=
-github.com/tendermint/spn v0.1.1-0.20220307175754-0b579dc934ec h1:D6iJ2DGu6iGTbxCp0ye5KM1OlabfoyrueH672qXtZMQ=
-github.com/tendermint/spn v0.1.1-0.20220307175754-0b579dc934ec/go.mod h1:E1/XLH8W9U3B+E/Lyytly+HXbpkIXqy5nbhdra14paU=
+github.com/tendermint/spn v0.1.1-0.20220309210912-ae38eed8fbee h1:V4aDFMIRRTEqDAOyxg9o1CweDifo8JECJTjwNdWEww4=
+github.com/tendermint/spn v0.1.1-0.20220309210912-ae38eed8fbee/go.mod h1:E1/XLH8W9U3B+E/Lyytly+HXbpkIXqy5nbhdra14paU=
 github.com/tendermint/starport v0.19.3/go.mod h1:1BlPohoDtLl8CFqTHbMSN3rhq5YLBHlTQ9mJhcRuvwI=
 github.com/tendermint/tendermint v0.34.0-rc4/go.mod h1:yotsojf2C1QBOw4dZrTcxbyxmPUrT4hNuOQWX9XUwB4=
 github.com/tendermint/tendermint v0.34.0-rc6/go.mod h1:ugzyZO5foutZImv0Iyx/gOFCX6mjJTgbLHTwi17VDVg=

starport/cmd/network.go

@@ -63,6 +63,7 @@ func NewNetwork() *cobra.Command {
 		NewNetworkChain(),
 		NewNetworkCampaign(),
 		NewNetworkRequest(),
+		NewNetworkReward(),
 	)
 
 	return c

starport/cmd/network_chain_publish.go

@@ -14,14 +14,16 @@ import (
 )
 
 const (
-	flagTag      = "tag"
-	flagBranch   = "branch"
-	flagHash     = "hash"
-	flagGenesis  = "genesis"
-	flagCampaign = "campaign"
-	flagNoCheck  = "no-check"
-	flagChainID  = "chain-id"
-	flagMainnet  = "mainnet"
+	flagTag          = "tag"
+	flagBranch       = "branch"
+	flagHash         = "hash"
+	flagGenesis      = "genesis"
+	flagCampaign     = "campaign"
+	flagNoCheck      = "no-check"
+	flagChainID      = "chain-id"
+	flagMainnet      = "mainnet"
+	flagRewardCoins  = "reward.coins"
+	flagRewardHeight = "reward.height"
 )
 
 // NewNetworkChainPublish returns a new command to publish a new chain to start a new network.
@@ -41,12 +43,14 @@ func NewNetworkChainPublish() *cobra.Command {
 	c.Flags().Uint64(flagCampaign, 0, "Campaign ID to use for this network")
 	c.Flags().Bool(flagNoCheck, false, "Skip verifying chain's integrity")
 	// FIXME: total shares cannot be set if the campaign doesn't have dynamic shares.
-	// TODO: we should update the SPN to accept dynamic shares before enabling this flag
+	// TODO: we should update the SPN to accept dynamic shares before enabling this flag.
 	// c.Flags().String(flagCampaignTotalShares, "", "Add a total shares to the campaign")
 	c.Flags().String(flagCampaignMetadata, "", "Add a campaign metadata")
 	c.Flags().String(flagCampaignTotalShares, "", "Add a shares supply for the campaign")
 	c.Flags().String(flagCampaignTotalSupply, "", "Add a total of the mainnet of a campaign")
 	c.Flags().Bool(flagMainnet, false, "Initialize a mainnet campaign")
+	c.Flags().String(flagRewardCoins, "", "Reward coins")
+	c.Flags().Int64(flagRewardHeight, 0, "Last reward height")
 	c.Flags().AddFlagSet(flagNetworkFrom())
 	c.Flags().AddFlagSet(flagSetKeyringBackend())
 	c.Flags().AddFlagSet(flagSetHome())
@@ -69,6 +73,8 @@ func networkChainPublishHandler(cmd *cobra.Command, args []string) error {
 		campaignTotalSharesStr, _ = cmd.Flags().GetString(flagCampaignTotalShares)
 		campaignTotalSupplyStr, _ = cmd.Flags().GetString(flagCampaignTotalSupply)
 		isMainnet, _              = cmd.Flags().GetBool(flagMainnet)
+		rewardCoinsStr, _         = cmd.Flags().GetString(flagRewardCoins)
+		rewardDuration, _         = cmd.Flags().GetInt64(flagRewardHeight)
 	)
 
 	if campaign != 0 && campaignTotalSupplyStr != "" {
@@ -93,6 +99,16 @@ func networkChainPublishHandler(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	rewardCoins, err := sdk.ParseCoinsNormalized(rewardCoinsStr)
+	if err != nil {
+		return err
+	}
+
+	if (!rewardCoins.Empty() && rewardDuration == 0) ||
+		(rewardCoins.Empty() && rewardDuration > 0) {
+		return fmt.Errorf("%s and %s flags must be provided together", flagRewardCoins, flagRewardHeight)
+	}
+
 	nb, err := newNetworkBuilder(cmd)
 	if err != nil {
 		return err
@@ -186,6 +202,12 @@ func networkChainPublishHandler(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	if !rewardCoins.Empty() && rewardDuration > 0 {
+		if err := n.SetReward(launchID, rewardDuration, rewardCoins); err != nil {
+			return err
+		}
+	}
+
 	nb.Spinner.Stop()
 
 	fmt.Printf("%s Network published \n", clispinner.OK)

starport/cmd/network_reward.go

@@ -0,0 +1,17 @@
+package starportcmd
+
+import (
+	"github.com/spf13/cobra"
+)
+
+// NewNetworkReward creates a new chain reward command
+func NewNetworkReward() *cobra.Command {
+	c := &cobra.Command{
+		Use:   "reward",
+		Short: "Manage network rewards",
+	}
+	c.AddCommand(
+		NewNetworkRewardSet(),
+	)
+	return c
+}

starport/cmd/network_reward_set.go

@@ -0,0 +1,58 @@
+package starportcmd
+
+import (
+	"fmt"
+	"strconv"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/spf13/cobra"
+
+	"github.com/tendermint/starport/starport/services/network"
+)
+
+// NewNetworkRewardSet creates a new chain reward set command to
+// add the chain reward to the network as a coordinator.
+func NewNetworkRewardSet() *cobra.Command {
+	c := &cobra.Command{
+		Use:   "set [launch-id] [last-reward-height] [coins]",
+		Short: "set a network chain reward",
+		Args:  cobra.ExactArgs(3),
+		RunE:  networkChainRewardSetHandler,
+	}
+	c.Flags().AddFlagSet(flagSetKeyringBackend())
+	c.Flags().AddFlagSet(flagNetworkFrom())
+	c.Flags().AddFlagSet(flagSetHome())
+	return c
+}
+
+func networkChainRewardSetHandler(cmd *cobra.Command, args []string) error {
+	nb, err := newNetworkBuilder(cmd)
+	if err != nil {
+		return err
+	}
+	defer nb.Cleanup()
+
+	// parse launch ID
+	launchID, err := network.ParseID(args[0])
+	if err != nil {
+		return err
+	}
+
+	// parse the last reward height
+	lastRewardHeight, err := strconv.ParseInt(args[1], 10, 64)
+	if err != nil {
+		return err
+	}
+
+	coins, err := sdk.ParseCoinsNormalized(args[2])
+	if err != nil {
+		return fmt.Errorf("failed to parse coins: %w", err)
+	}
+
+	n, err := nb.Network()
+	if err != nil {
+		return err
+	}
+
+	return n.SetReward(launchID, lastRewardHeight, coins)
+}

starport/pkg/events/events.go

@@ -36,6 +36,20 @@ const (
 	StatusDone
 )
 
+// TextColor sets the text color
+func TextColor(c color.Color) Option {
+	return func(e *Event) {
+		e.TextColor = c
+	}
+}
+
+// Icon sets the text icon prefix
+func Icon(icon string) Option {
+	return func(e *Event) {
+		e.Icon = icon
+	}
+}
+
 // New creates a new event with given config.
 func New(status Status, description string, options ...Option) Event {
 	ev := Event{Status: status, Description: description}

starport/services/network/reward.go

@@ -0,0 +1,69 @@
+package network
+
+import (
+	"fmt"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	rewardtypes "github.com/tendermint/spn/x/reward/types"
+
+	"github.com/tendermint/starport/starport/pkg/clispinner"
+	"github.com/tendermint/starport/starport/pkg/events"
+	"github.com/tendermint/starport/starport/services/network/networktypes"
+)
+
+// SetReward set a chain reward
+func (n Network) SetReward(launchID uint64, lastRewardHeight int64, coins sdk.Coins) error {
+	n.ev.Send(events.New(
+		events.StatusOngoing,
+		fmt.Sprintf("Setting reward %s to the chain %d at height %d",
+			coins.String(),
+			launchID,
+			lastRewardHeight,
+		),
+	))
+
+	msg := rewardtypes.NewMsgSetRewards(
+		n.account.Address(networktypes.SPN),
+		launchID,
+		lastRewardHeight,
+		coins,
+	)
+	res, err := n.cosmos.BroadcastTx(n.account.Name, msg)
+	if err != nil {
+		return err
+	}
+
+	var setRewardRes rewardtypes.MsgSetRewardsResponse
+	if err := res.Decode(&setRewardRes); err != nil {
+		return err
+	}
+
+	if setRewardRes.PreviousCoins.Empty() {
+		n.ev.Send(events.New(
+			events.StatusDone,
+			"The reward pool is empty.",
+			events.Icon(clispinner.Info),
+		))
+	} else {
+		n.ev.Send(events.New(events.StatusDone,
+			fmt.Sprintf(
+				"Previous reward pool %s at height %d was overwritten.",
+				coins.String(),
+				lastRewardHeight,
+			),
+			events.Icon(clispinner.Info),
+		))
+	}
+
+	if setRewardRes.NewCoins.Empty() {
+		n.ev.Send(events.New(events.StatusDone, "The reward pool was removed."))
+	} else {
+		n.ev.Send(events.New(events.StatusDone, fmt.Sprintf(
+			"%s will be distributed to validators at height %d. The chain %d is now an incentivized testnet",
+			coins.String(),
+			lastRewardHeight,
+			launchID,
+		)))
+	}
+	return nil
+}