Added migration support (#48)

## Summary

* Added handlers for `MsgClaimMorseApplication`, `MsgClaimMorseAccount`,
`MsgClaimMorseSupplier` and `MsgImportMorseClaimableAccounts`
* Updated proto and client files because the migration one were outdated
* Added handlers for `/cosmos.authz.v1beta1.MsgGrant` and
`cosmos.authz.v1beta1.EventGrant` events

Author: Alann27

project.ts

@@ -386,15 +386,37 @@ const project: CosmosProject = {
           ],
         },
       ],
+      // --- MIGRATION
+      [
+        "pocket.migration_events",
+        {
+          file: "./proto/pocket/migration/event.proto",
+          messages: [
+            "EventImportMorseClaimableAccounts",
+            "EventMorseAccountClaimed",
+            "EventMorseApplicationClaimed",
+            "EventMorseSupplierClaimed",
+          ],
+        },
+      ],
+      [
+        "pocket.migration_tx",
+        {
+          file: "./proto/pocket/migration/tx.proto",
+          messages: [
+            "MsgImportMorseClaimableAccounts",
+            "MsgClaimMorseAccount",
+            "MsgClaimMorseApplication",
+            "MsgClaimMorseSupplier",
+          ],
+        },
+      ],
     ]),
   },
   dataSources: [
     {
       startBlock: 1,
-      // startBlock: 349, // first set of txs
-      // startBlock: 34123, // first set of claims
-      // startBlock: 55330, // damn big block 176k events
-      // startBlock: 58120, // more than 570 mb in response
+      // migration at 25507 on alpha
       kind: CosmosDatasourceKind.Runtime,
       mapping: {
         file: "./dist/index.js",

proto/pocket/application/tx.proto

@@ -55,7 +55,7 @@ message MsgStakeApplication {
   cosmos.base.v1beta1.Coin                 stake = 2; // The total amount of uPOKT the application has staked. Must be ≥ to the current amount that the application has staked (if any)
   repeated pocket.shared.ApplicationServiceConfig services = 3; // The list of services this application is staked to request service for
 
-  // TODO_POST_MAINNET_CONSIDERATION: Consider allowing applications to delegate
+  // TODO_POST_MAINNET: Consider allowing applications to delegate
   // to gateways at time of staking for a better developer experience.
   // repeated string gateway_address
 }

proto/pocket/application/types.proto

@@ -30,7 +30,7 @@ message Application {
   //   - https://www.notion.so/buildwithgrove/Off-chain-Application-Stake-Tracking-6a8bebb107db4f7f9dc62cbe7ba555f7
   repeated pocket.shared.ApplicationServiceConfig service_configs = 3;
 
-  // TODO_BETA(@bryanchriswhite): Rename `delegatee_gateway_addresses` to `gateway_addresses_delegated_to`.
+  // TODO_MAINNET_MIGRATION(@bryanchriswhite): Rename `delegatee_gateway_addresses` to `gateway_addresses_delegated_to`.
   // Ensure to rename all relevant configs, comments, variables, function names, etc as well.
   // Non-nullable list of Bech32 encoded delegatee Gateway addresses
   repeated string delegatee_gateway_addresses = 4 [(cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.nullable) = false];

proto/pocket/migration/morse_offchain.proto

@@ -16,7 +16,7 @@ syntax = "proto3";
 //
 // These types are used by the migration subcommand to transform
 // the Morse state export into the Shannon state import like so:
-//  $ pocketd migrate collect-morse-accounts ...
+//  $ pocketd tx migration collect-morse-accounts ...
 //
 // CRITICAL: These types are offchain and ARE NOT persisted onchain (Shannon) at any point.
 package pocket.migration;
@@ -98,11 +98,11 @@ message MorseApplication {
   bytes address = 1 [(gogoproto.casttype) = "github.com/cometbft/cometbft/crypto.Address", (gogoproto.jsontag) = "address", (gogoproto.moretags) = "yaml:\"address\""];
   // PublicKey is the binary representation of a Morse application's ed25519 public key.
   bytes public_key = 2 [(gogoproto.jsontag) = "public_key", (gogoproto.moretags) = "yaml:\"public_key\""];
-  // TODO_MAINNET(@Olshansk):  Should status and/or jailed be considered during the migration, and if so, how?
+  // TODO_MAINNET_MIGRATION(@Olshansk):  Should status and/or jailed be considered during the migration, and if so, how?
   bool   jailed = 3[(gogoproto.jsontag) = "jailed", (gogoproto.moretags) = "yaml:\"jailed\""];
   int32  status = 4 [(gogoproto.jsontag) = "status", (gogoproto.moretags) = "yaml:\"status\""];
   // The string representation of the BigInt amount of upokt.
-  string staked_tokens = 6 [(gogoproto.jsontag) = "tokens"];
+  string staked_tokens = 6 [(gogoproto.jsontag) = "staked_tokens"];
 }
 
 // MorseValidator is a subset of the Morse ProtoValidator type.
@@ -118,7 +118,7 @@ message MorseValidator {
   bytes address = 1 [(gogoproto.casttype) = "github.com/cometbft/cometbft/crypto.Address", (gogoproto.moretags) = "yaml:\"address\"", (gogoproto.jsontag) = "address"];
   // The binary representation of a Morse application's ed25519 public key.
   bytes public_key = 2 [(gogoproto.moretags) = "yaml:\"public_key\"", (gogoproto.jsontag) = "public_key"];
-  // TODO_MAINNET(@Olshansk):  Should status and/or jailed be considered during the migration, and if so, how?
+  // TODO_MAINNET_MIGRATION(@Olshansk):  Should status and/or jailed be considered during the migration, and if so, how?
   bool jailed = 3 [(gogoproto.jsontag) = "jailed"];
   int32 status = 4 [(gogoproto.jsontag) = "status"];
   // The string representation of the BigInt amount of upokt.

proto/pocket/migration/morse_onchain.proto

@@ -29,8 +29,12 @@ message MorseClaimableAccount {
   // The hex-encoded address of the Morse account whose balance will be claimed.
   string morse_src_address = 2 [(gogoproto.jsontag) = "morse_src_address"];
 
+  // DEV_NOTE: This field was momentarily used to hold the Morse public key; however, an
+  // optimization eliminates the need for this. Reserved for backwards compatibility.
+  //
   // The ed25519 public key of the account.
-  bytes public_key = 4 [(gogoproto.casttype) = "crypto/ed25519.PublicKey"];
+  // bytes public_key = 4 [(gogoproto.casttype) = "crypto/ed25519.PublicKey"];
+  reserved 4;
 
   // The unstaked upokt tokens (i.e. account balance) available for claiming.
   cosmos.base.v1beta1.Coin unstaked_balance = 5 [(gogoproto.nullable) = false, (gogoproto.jsontag) = "unstaked_balance"];

proto/pocket/migration/params.proto

@@ -11,4 +11,10 @@ option (gogoproto.stable_marshaler_all) = true;
 message Params {
   option (amino.name) = "pocket/x/migration/Params";
   option (gogoproto.equal) = true;
+
+  // waive_morse_claim_gas_fees is a feature flag used to enable/disable the waiving of gas fees for txs that:
+  // - Contain exactly one secp256k1 signer
+  // - Contain at least one Morse account/actor claim messages
+  // - Do not contain any other messages other than Morse account/actor claim messages
+  bool waive_morse_claim_gas_fees = 1 [(gogoproto.jsontag) = "waive_morse_claim_gas_fees", (gogoproto.moretags) = "yaml:\"waive_morse_claim_gas_fees\""];
 }

proto/pocket/migration/tx.proto

@@ -40,6 +40,8 @@ message MsgUpdateParams {
 
   // NOTE: All parameters must be supplied.
   Params params = 2 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];
+
+  // Next free index: 3
 }
 
 // MsgUpdateParamsResponse defines the response structure for executing a
@@ -53,20 +55,22 @@ message MsgImportMorseClaimableAccounts {
   // authority is the address that controls the module (defaults to x/gov unless overwritten).
   string authority = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
 
-  // the account state derived from the Morse state export and the `pocketd migrate collect-morse-accounts` command.
+  // the account state derived from the Morse state export and the `pocketd tx migration collect-morse-accounts` command.
   MorseAccountState morse_account_state = 2 [(gogoproto.jsontag) = "morse_account_state", (gogoproto.nullable) = false];
 
   // 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:
-  //   $ pocketd migrate collect-morse-accounts $<(pocket util export-genesis-for-reset)
+  // Verification can be done by comparing with locally derived Morse state like so (at a high-level):
+  //   $ pocketd tx migration collect-morse-accounts $<(pocket util export-genesis-for-reset)
 
   // Additional documentation:
   // - pocket util export-genesis-for-migration --help
-  // - pocketd migrate collect-morse-accounts --help
+  // - pocketd tx migration collect-morse-accounts --help
   bytes morse_account_state_hash = 3 [(gogoproto.jsontag) = "morse_account_state_hash"];
+
+  // Next free index: 4
 }
 
 // MsgImportMorseClaimableAccountsResponse is returned from MsgImportMorseClaimableAccounts.
@@ -78,6 +82,8 @@ message MsgImportMorseClaimableAccountsResponse {
 
   // Number of claimable accounts (EOAs) collected from Morse state export.
   uint64 num_accounts = 2 [(gogoproto.jsontag) = "num_accounts"];
+
+  // Next free index: 3
 }
 
 // MsgClaimMorseAccount is used to execute a claim (one-time minting of tokens on Shannon),
@@ -88,25 +94,40 @@ message MsgImportMorseClaimableAccountsResponse {
 // - The Shannon account specified must be the message signer
 // - Authz grants MAY be used to delegate claiming authority to other Shannon accounts
 message MsgClaimMorseAccount {
-  option (cosmos.msg.v1.signer) = "shannon_dest_address";
+  option (cosmos.msg.v1.signer) = "shannon_signing_address";
+
+  // The bech32-encoded address of the Shannon account which is signing for this message.
+  // This account is liable for any fees incurred by violating the constraints of Morse
+  // account/actor claim message fee waiving; the tx contains ONE OR MORE Morse account/actor
+  // claim messages AND has EXACTLY ONE signer.
+  string shannon_signing_address = 4 [(cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "shannon_signing_address"];
 
   // The bech32-encoded address of the Shannon account to which the claimed balance will be minted.
   string shannon_dest_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "shannon_dest_address"];
 
+  // DEV_NOTE: This field was momentarily used to hold the Morse source
+  // address; however, an optimization eliminates the need for this.
+  // Reserved for backwards compatibility.
+  //
   // The hex-encoded address of the Morse account whose balance will be claimed.
   // E.g.: 00f9900606fa3d5c9179fc0c8513078a53a2073e
-  string morse_src_address = 2 [(gogoproto.jsontag) = "morse_src_address"];
+  // string morse_src_address = 2 [(gogoproto.jsontag) = "morse_src_address"];
+  reserved 2;
+
+  // The ed25519 public key of the morse account with morse_src_address.
+  bytes morse_public_key = 5 [(gogoproto.casttype) = "github.com/cometbft/cometbft/crypto/ed25519.PubKey"];
 
   // 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, ...}))
   bytes morse_signature = 3 [(gogoproto.jsontag) = "morse_signature"];
+
+  // Next free index: 6
 }
 
 // MsgClaimMorseAccountResponse is returned from 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"];
@@ -116,23 +137,38 @@ message MsgClaimMorseAccountResponse {
 
   // The session end height (on Shannon) in which the claim was committed (i.e. claimed).
   int64 session_end_height = 3 [(gogoproto.jsontag) = "session_end_height"];
+
+  // Next free index: 4
 }
 
 // MsgClaimMorseApplication is used to execute a claim (one-time minting of tokens on Shannon),
 // of the total tokens owned by the given Morse account, according to the on-chain MorseClaimableAccounts,
 // to the balance of the given Shannon account, followed by staking that Shannon account as an application
 // for the given service_config and the same stake amount as on Morse.
 message MsgClaimMorseApplication {
-  option (cosmos.msg.v1.signer) = "shannon_dest_address";
+  option (cosmos.msg.v1.signer) = "shannon_signing_address";
+
+  // The bech32-encoded address of the Shannon account which is signing for this message.
+  // This account is liable for any fees incurred by violating the constraints of Morse
+  // account/actor claim message fee waiving; the tx contains ONE OR MORE Morse account/actor
+  // claim messages AND has EXACTLY ONE signer.
+  string shannon_signing_address = 5 [(cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "shannon_signing_address"];
 
   // The bech32-encoded address of the Shannon account to which the claimed tokens
   // will be minted and from which the application will be staked.
   string shannon_dest_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "shannon_dest_address"];
 
+  // DEV_NOTE: This field was momentarily used to hold the Morse source
+  // address; however, an optimization eliminates the need for this.
+  // Reserved for backwards compatibility.
+  //
   // The hex-encoded address of the Morse account whose balance will be claimed.
   // E.g.: 00f9900606fa3d5c9179fc0c8513078a53a2073e
+  // string morse_src_address = 2 [(gogoproto.jsontag) = "morse_src_address"];
+  reserved 2;
 
-  string morse_src_address = 2 [(gogoproto.jsontag) = "morse_src_address"];
+  // The ed25519 public key of the morse account with morse_src_address.
+  bytes morse_public_key = 6 [(gogoproto.casttype) = "github.com/cometbft/cometbft/crypto/ed25519.PubKey"];
 
   // 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, ...}))
@@ -142,6 +178,8 @@ message MsgClaimMorseApplication {
   // NOTE: This is not a repeated field, as in MsgStakeApplication,
   // because an application can only be staked for one service.
   shared.ApplicationServiceConfig service_config = 4 [(gogoproto.jsontag) = "service_config"];
+
+  // Next free index: 7
 }
 
 // MsgClaimMorseApplicationResponse is returned from MsgClaimMorseApplication.
@@ -164,6 +202,8 @@ message MsgClaimMorseApplicationResponse {
 
   // The application which was staked as a result of the claim.
   application.Application application = 5 [(gogoproto.jsontag) = "application"];
+
+  // Next free index: 6
 }
 
 // MsgClaimMorseSupplier is used to:
@@ -175,7 +215,13 @@ message MsgClaimMorseApplicationResponse {
 // 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) = "shannon_owner_address";
+  option (cosmos.msg.v1.signer) = "shannon_signing_address";
+
+  // The bech32-encoded address of the Shannon account which is signing for this message.
+  // This account is liable for any fees incurred by violating the constraints of Morse
+  // account/actor claim message fee waiving; the tx contains ONE OR MORE Morse account/actor
+  // claim messages AND has EXACTLY ONE signer.
+  string shannon_signing_address = 6 [(cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "shannon_signing_address"];
 
   // The bech32-encoded address of the Shannon account to which the claimed tokens
   // will be minted and which become the supplier owner.
@@ -187,11 +233,17 @@ message MsgClaimMorseSupplier {
   // See: https://dev.poktroll.com/operate/configs/supplier_staking_config#staking-types.
   string shannon_operator_address = 2 [(cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "shannon_operator_address"];
 
+  // The ed25519 public key of the morse account with morse_src_address.
+  bytes morse_public_key = 7 [(gogoproto.casttype) = "github.com/cometbft/cometbft/crypto/ed25519.PubKey"];
+
+  // DEV_NOTE: This field was momentarily used to hold the Morse source
+  // address; however, an optimization eliminates the need for this.
+  // Reserved for backwards compatibility.
+  //
   // The hex-encoded address of the Morse account whose balance will be claimed.
   // E.g.: 00f9900606fa3d5c9179fc0c8513078a53a2073e
-  //
-  // TODO_MAINNET(@bryanchriswhite, #1126): Rename to `morse_src_owner_address`.
-  string morse_src_address = 3 [(gogoproto.jsontag) = "morse_src_address"];
+  // string morse_src_address = 3 [(gogoproto.jsontag) = "morse_src_address"];
+  reserved 3;
 
   // 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, ...}))
@@ -201,6 +253,8 @@ message MsgClaimMorseSupplier {
 
   // The services this supplier is staked to provide service for.
   repeated shared.SupplierServiceConfig services = 5 [(gogoproto.jsontag) = "services"];
+
+  // Next free index: 8
 }
 
 // MsgClaimMorseSupplierResponse is returned from MsgClaimMorseSupplier.
@@ -224,5 +278,7 @@ message MsgClaimMorseSupplierResponse {
 
   // The supplier which was staked as a result of the claim.
   shared.Supplier supplier = 5 [(gogoproto.jsontag) = "supplier"];
+
+  // Next free index: 6
 }
 

proto/pocket/proof/params.proto

@@ -22,20 +22,20 @@ message Params {
   // is equal to or above the threshold. This is in contrast to the this requirement
   // being determined probabilistically via ProofRequestProbability.
   //
-  // TODO_MAINNET: Consider renaming this to `proof_requirement_threshold_upokt`.
+  // TODO_MAINNET_MIGRATION: Consider renaming this to `proof_requirement_threshold_upokt`.
   cosmos.base.v1beta1.Coin proof_requirement_threshold = 3 [(gogoproto.jsontag) = "proof_requirement_threshold"];
 
   // proof_missing_penalty is the number of tokens (uPOKT) which should be slashed from a supplier
   // when a proof is required (either via proof_requirement_threshold or proof_missing_penalty)
   // but is not provided.
-  // TODO_MAINNET: Consider renaming this to `proof_missing_penalty_upokt`.
+  // TODO_MAINNET_MIGRATION: Consider renaming this to `proof_missing_penalty_upokt`.
   cosmos.base.v1beta1.Coin proof_missing_penalty = 4 [(gogoproto.jsontag) = "proof_missing_penalty"];
 
   // proof_submission_fee is the number of tokens (uPOKT) which should be paid by
   // the supplier operator when submitting a proof.
   // This is needed to account for the cost of storing proofs onchain and prevent
   // spamming (i.e. sybil bloat attacks) the network with non-required proofs.
-  // TODO_MAINNET: Consider renaming this to `proof_submission_fee_upokt`.
+  // TODO_MAINNET_MIGRATION: Consider renaming this to `proof_submission_fee_upokt`.
   cosmos.base.v1beta1.Coin proof_submission_fee = 5 [(gogoproto.jsontag) = "proof_submission_fee"];
 
   // IMPORTANT: Make sure to update all related files if you're modifying or adding a new parameter.

proto/pocket/proof/types.proto

@@ -57,3 +57,18 @@ enum ClaimProofStatus {
   VALIDATED = 1;
   INVALID = 2;
 }
+
+// **************
+// OFFCHAIN TYPES
+// The messages defined below are used for offchain logic and should not be used for any onchain logic.
+// They are defined in the same file as the onchain types for convenience.
+// **************
+
+// SessionSMT is the serializable session's SMST used to persist the session's
+// state offchain by the RelayMiner.
+// It is not used for any onchain logic.
+message SessionSMT {
+  pocket.session.SessionHeader session_header = 1;
+  string supplier_operator_address = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+  bytes smt_root = 3;
+}

proto/pocket/session/params.proto

@@ -1,12 +1,12 @@
 syntax = "proto3";
 package pocket.session;
 
-option go_package = "github.com/pokt-network/poktroll/x/session/types";
-option (gogoproto.stable_marshaler_all) = true;
-
 import "amino/amino.proto";
 import "gogoproto/gogo.proto";
 
+option go_package = "github.com/pokt-network/poktroll/x/session/types";
+option (gogoproto.stable_marshaler_all) = true;
+
 // Params defines the parameters for the module.
 message Params {
   option (amino.name) = "pocket/x/session/Params";