[Morse->Shannon Migration] scaffold: MsgClaimMorseSupplier

app/upgrades/historical.go

@@ -18,6 +18,7 @@ import (
 	consensusparamtypes "github.com/cosmos/cosmos-sdk/x/consensus/types"
 
 	cosmostypes "github.com/cosmos/cosmos-sdk/types"
+
 	"github.com/pokt-network/poktroll/app/keepers"
 )
 

app/upgrades/v0.0.10.go

@@ -11,6 +11,7 @@ import (
 	cosmosTypes "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
 	"github.com/cosmos/cosmos-sdk/x/authz"
+
 	"github.com/pokt-network/poktroll/app/keepers"
 	prooftypes "github.com/pokt-network/poktroll/x/proof/types"
 )

app/upgrades/v0.0.11.go

@@ -7,6 +7,7 @@ import (
 	upgradetypes "cosmossdk.io/x/upgrade/types"
 	cosmosTypes "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
+
 	"github.com/pokt-network/poktroll/app/keepers"
 	sessiontypes "github.com/pokt-network/poktroll/x/session/types"
 	tokenomicstypes "github.com/pokt-network/poktroll/x/tokenomics/types"

app/upgrades/v0.0.12.go

@@ -9,6 +9,7 @@ import (
 	upgradetypes "cosmossdk.io/x/upgrade/types"
 	cosmosTypes "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
+
 	"github.com/pokt-network/poktroll/app/keepers"
 	sharedtypes "github.com/pokt-network/poktroll/x/shared/types"
 )

proto/poktroll/migration/tx.proto

@@ -10,6 +10,7 @@ import "poktroll/shared/service.proto";
 import "poktroll/migration/morse_onchain.proto";
 import "poktroll/migration/params.proto";
 import "poktroll/application/types.proto";
+import "poktroll/shared/supplier.proto";
 import "cosmos/base/v1beta1/coin.proto";
 
 option go_package = "github.com/pokt-network/poktroll/x/migration/types";
@@ -21,14 +22,15 @@ service Msg {
 
   // UpdateParams defines a (governance) operation for updating the module
   // parameters. The authority defaults to the x/gov module account.
-  rpc UpdateParams                 (MsgUpdateParams) returns (MsgUpdateParamsResponse);
+  rpc UpdateParams                 (MsgUpdateParams                ) returns (MsgUpdateParamsResponse                );
   rpc ImportMorseClaimableAccounts (MsgImportMorseClaimableAccounts) returns (MsgImportMorseClaimableAccountsResponse);
-  rpc ClaimMorseAccount            (MsgClaimMorseAccount) returns (MsgClaimMorseAccountResponse);
-  rpc ClaimMorseApplication        (MsgClaimMorseApplication) returns (MsgClaimMorseApplicationResponse);
+  rpc ClaimMorseAccount            (MsgClaimMorseAccount           ) returns (MsgClaimMorseAccountResponse           );
+  rpc ClaimMorseApplication        (MsgClaimMorseApplication       ) returns (MsgClaimMorseApplicationResponse       );
+  rpc ClaimMorseSupplier           (MsgClaimMorseSupplier          ) returns (MsgClaimMorseSupplierResponse          );
 }
 // MsgUpdateParams is the Msg/UpdateParams request type.
 message MsgUpdateParams {
-  option (cosmos.msg.v1.signer) = "authority";
+  option (cosmos.msg.v1.signer) =                            "authority";
   option           (amino.name) = "poktroll/x/migration/MsgUpdateParams";
 
   // authority is the address that controls the module (defaults to x/gov unless overwritten).
@@ -57,10 +59,10 @@ message MsgImportMorseClaimableAccounts {
   // Validates the morse_account_state sha256 hash:
   // - Transaction fails if hash doesn't match on-chain computation
   // - Off-chain social consensus should be reached off-chain before verification
-  //
+
   // Verification can be done by comparing with locally derived Morse state like so:
   //   $ poktrolld migrate collect-morse-accounts $<(pocket util export-genesis-for-reset)
-  //
+
   // Additional documentation:
   // - pocket util export-genesis-for-migration --help
   // - poktrolld migrate collect-morse-accounts --help
@@ -70,6 +72,7 @@ message MsgImportMorseClaimableAccounts {
 // MsgImportMorseClaimableAccountsResponse is returned from MsgImportMorseClaimableAccounts.
 // It indicates the canonical hash of the imported MorseAccountState, and the number of claimable accounts which were imported.
 message MsgImportMorseClaimableAccountsResponse {
+
   // On-chain computed sha256 hash of the morse_account_state provided in the corresponding MsgCreateMorseAccountState.
   bytes state_hash = 1 [(gogoproto.jsontag) = "state_hash"];
 
@@ -103,6 +106,7 @@ message MsgClaimMorseAccount {
 // It indicates the morse_src_address of the account which was claimed, the total
 // balance claimed, and the height at which the claim was committed.
 message MsgClaimMorseAccountResponse {
+
   // The hex-encoded address of the Morse account whose balance will be claimed.
   // E.g.: 00f9900606fa3d5c9179fc0c8513078a53a2073e
   string morse_src_address = 1 [(gogoproto.jsontag) = "morse_src_address"];
@@ -143,6 +147,7 @@ message MsgClaimMorseApplication {
 // It indicates the morse_src_address of the account which was claimed, the unstaked
 // balance claimed, the application stake, and the height at which the claim was committed.
 message MsgClaimMorseApplicationResponse {
+
   // The hex-encoded address of the Morse account whose balance will be claimed.
   string morse_src_address = 1 [(gogoproto.jsontag) = "morse_src_address"];
 
@@ -160,3 +165,61 @@ message MsgClaimMorseApplicationResponse {
   application.Application application = 5 [(gogoproto.jsontag) = "application"];
 }
 
+// TODO_UPNEXT(@bryanchriswhite, #1034): for messages below:
+// - Update field types where necessary.
+// - Rename fields to conform to best practices.
+// - Add applicable field options.
+
+// MsgClaimMorseSupplier is used to:
+// - Execute a one-time minting of tokens on Shannon based on tokens owned by the given Morse account
+// - Use the on-chain MorseClaimableAccounts for verification
+// - Credit the minted tokens to the balance of the given Shannon account
+// - Automatically stake that Shannon account as a supplier
+//
+// NOTE: The supplier module's staking fee parameter (at the time of claiming) is deducted from the
+// claimed balance.
+message MsgClaimMorseSupplier {
+  option (cosmos.msg.v1.signer) = "shannonDestAddress";
+
+  // The bech32-encoded address of the Shannon account to which the claimed tokens
+  // will be minted and from which the supplier will be staked.
+  //
+  // TODO_MAINNET(@bryanchriswhite, #1095): split into owner and operator addresses...
+  string shannonDestAddress = 1;
+
+  // The hex-encoded address of the Morse account whose balance will be claimed.
+  // E.g.: 00f9900606fa3d5c9179fc0c8513078a53a2073e
+  string morseSrcAddress = 2;
+
+  // The hex-encoded signature, by the Morse account, of this message (where this field is nil).
+  // I.e.: morse_signature = private_key.sign(marshal(MsgClaimMorseAccount{morse_signature: nil, ...}))
+  string morseSignature = 3;
+
+  // The services this supplier is staked to provide service for.
+  // TODO_MAINNET(@bryanchriswhite, #1095): ensure this field is repeated (to match MsgStakeSupplier).
+  string services = 5;
+}
+
+// MsgClaimMorseSupplierResponse is returned from MsgClaimMorseSupplier.
+// It indicates:
+// - The morse_src_address of the claimed account
+// - The unstaked balance claimed
+// - The session end height in which the claim was committed
+// - The staked supplier
+message MsgClaimMorseSupplierResponse {
+  // The hex-encoded address of the Morse account whose balance was claimed.
+  // E.g.: 00f9900606fa3d5c9179fc0c8513078a53a2073e
+  string morseSrcAddress = 1;
+
+  // The unstaked balance which was claimed.
+  cosmos.base.v1beta1.Coin claimedBalance = 2 [(gogoproto.nullable) = false];
+
+  cosmos.base.v1beta1.Coin claimedSupplierStake = 4 [(gogoproto.nullable) = false];
+
+  // The session end height (on Shannon) in which the claim was committed (i.e. claimed).
+  int32 sessionEndHeight = 5;
+
+  // The supplier which was staked as a result of the claim.
+  shared.Supplier supplier = 6;
+}
+

tests/integration/migration/morse_claim_supplier_test.go

@@ -0,0 +1,3 @@
+package migration
+
+// TODO_UPNEXT(@bryanchriswhite, #1034): Add app-integration coverage over claiming Morse accounts as suppliers...

testutil/events/filter.go

@@ -9,9 +9,10 @@ import (
 	abci "github.com/cometbft/cometbft/abci/types"
 	cosmostypes "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/gogoproto/proto"
+	"github.com/stretchr/testify/require"
+
 	"github.com/pokt-network/poktroll/pkg/observable"
 	"github.com/pokt-network/poktroll/pkg/observable/channel"
-	"github.com/stretchr/testify/require"
 )
 
 // FilterEvents filters allEvents, returning list of T type events whose protobuf  message type string matches protoType.

x/migration/keeper/msg_server_claim_morse_supplier.go

@@ -0,0 +1,18 @@
+package keeper
+
+import (
+	"context"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	"github.com/pokt-network/poktroll/x/migration/types"
+)
+
+func (k msgServer) ClaimMorseSupplier(goCtx context.Context, msg *types.MsgClaimMorseSupplier) (*types.MsgClaimMorseSupplierResponse, error) {
+	ctx := sdk.UnwrapSDKContext(goCtx)
+
+	// TODO_UPNEXT(@bryanchriswhite, #1034): Handling the message
+	_ = ctx
+
+	return &types.MsgClaimMorseSupplierResponse{}, nil
+}

x/migration/keeper/msg_server_claim_morse_supplier_test.go

@@ -0,0 +1,3 @@
+package keeper
+
+// TODO_UPNEXT(@bryanchriswhite, #1034): Add msgServer/Keeper unit tests...

x/migration/module/autocli.go

@@ -68,6 +68,14 @@ func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions {
 					Skip:           true, // skipped because autoCLI cannot handle loading & signing using the Morse key.
 					// TODO_MAINNET(@bryanchriswhite, #1034): Add morse application claiming CLI, incl. examples (see x/supplier/module/autocli.go).
 				},
+				{
+					RpcMethod:      "ClaimMorseSupplier",
+					Use:            "claim-morse-supplier [morse-src-address] [morse-signature] [stake] [service-config]",
+					Short:          "Send a claim_morse_supplier tx",
+					PositionalArgs: []*autocliv1.PositionalArgDescriptor{{ProtoField: "morseSrcAddress"}, {ProtoField: "morseSignature"}, {ProtoField: "stake"}, {ProtoField: "serviceConfig"}},
+					Skip:           true, // skipped because autoCLI cannot handle signing
+					// TODO_UPNEXT(@bryanchriswhite, #1034): Add morse supplier claiming CLI, incl. examples (see x/supplier/module/autocli.go).
+				},
 				// this line is used by ignite scaffolding # autocli/tx
 			},
 		},

x/migration/module/simulation.go

@@ -35,6 +35,10 @@ const (
 	// TODO: Determine the simulation weight value
 	defaultWeightMsgClaimMorseApplication int = 100
 
+	opWeightMsgClaimMorseSupplier = "op_weight_msg_claim_morse_supplier"
+	// TODO: Determine the simulation weight value
+	defaultWeightMsgClaimMorseSupplier int = 100
+
 	// this line is used by starport scaffolding # simapp/module/const
 )
 
@@ -91,6 +95,17 @@ func (am AppModule) WeightedOperations(simState module.SimulationState) []simtyp
 		migrationsimulation.SimulateMsgClaimMorseApplication(am.accountKeeper, am.bankKeeper, am.keeper),
 	))
 
+	var weightMsgClaimMorseSupplier int
+	simState.AppParams.GetOrGenerate(opWeightMsgClaimMorseSupplier, &weightMsgClaimMorseSupplier, nil,
+		func(_ *rand.Rand) {
+			weightMsgClaimMorseSupplier = defaultWeightMsgClaimMorseSupplier
+		},
+	)
+	operations = append(operations, simulation.NewWeightedOperation(
+		weightMsgClaimMorseSupplier,
+		migrationsimulation.SimulateMsgClaimMorseSupplier(am.accountKeeper, am.bankKeeper, am.keeper),
+	))
+
 	// this line is used by starport scaffolding # simapp/module/operation
 
 	return operations
@@ -123,6 +138,14 @@ func (am AppModule) ProposalMsgs(simState module.SimulationState) []simtypes.Wei
 				return nil
 			},
 		),
+		simulation.NewWeightedProposalMsg(
+			opWeightMsgClaimMorseSupplier,
+			defaultWeightMsgClaimMorseSupplier,
+			func(r *rand.Rand, ctx sdk.Context, accs []simtypes.Account) sdk.Msg {
+				migrationsimulation.SimulateMsgClaimMorseSupplier(am.accountKeeper, am.bankKeeper, am.keeper)
+				return nil
+			},
+		),
 		// this line is used by starport scaffolding # simapp/module/OpMsg
 	}
 }

x/migration/simulation/claim_morse_supplier.go

@@ -0,0 +1,30 @@
+package simulation
+
+import (
+	"math/rand"
+
+	"github.com/cosmos/cosmos-sdk/baseapp"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	simtypes "github.com/cosmos/cosmos-sdk/types/simulation"
+
+	"github.com/pokt-network/poktroll/x/migration/keeper"
+	"github.com/pokt-network/poktroll/x/migration/types"
+)
+
+func SimulateMsgClaimMorseSupplier(
+	ak types.AccountKeeper,
+	bk types.BankKeeper,
+	k keeper.Keeper,
+) simtypes.Operation {
+	return func(r *rand.Rand, app *baseapp.BaseApp, ctx sdk.Context, accs []simtypes.Account, chainID string,
+	) (simtypes.OperationMsg, []simtypes.FutureOperation, error) {
+		simAccount, _ := simtypes.RandomAcc(r, accs)
+		msg := &types.MsgClaimMorseSupplier{
+			ShannonDestAddress: simAccount.Address.String(),
+		}
+
+		// TODO: Handling the ClaimMorseSupplier simulation
+
+		return simtypes.NoOpMsg(types.ModuleName, sdk.MsgTypeURL(msg), "ClaimMorseSupplier simulation not implemented"), nil, nil
+	}
+}

x/migration/types/codec.go

@@ -17,6 +17,9 @@ func RegisterInterfaces(registry cdctypes.InterfaceRegistry) {
 	registry.RegisterImplementations((*sdk.Msg)(nil),
 		&MsgClaimMorseApplication{},
 	)
+	registry.RegisterImplementations((*sdk.Msg)(nil),
+		&MsgClaimMorseSupplier{},
+	)
 	// this line is used by starport scaffolding # 3
 
 	registry.RegisterImplementations((*sdk.Msg)(nil),