@xpla/xpla-react 1.7.0 → 1.8.0-rc.1

package/esm/cosmos/distribution/v1beta1/distribution.js

@@ -10,6 +10,12 @@ function createBaseParams() {
         withdrawAddrEnabled: false
     };
 }
+/**
+ * Params defines the set of params for the distribution module.
+ * @name Params
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.Params
+ */
 export const Params = {
     typeUrl: "/cosmos.distribution.v1beta1.Params",
     aminoType: "cosmos-sdk/x/distribution/Params",
@@ -121,6 +127,23 @@ function createBaseValidatorHistoricalRewards() {
         referenceCount: 0
     };
 }
+/**
+ * ValidatorHistoricalRewards represents historical rewards for a validator.
+ * Height is implicit within the store key.
+ * Cumulative reward ratio is the sum from the zeroeth period
+ * until this period of rewards / tokens, per the spec.
+ * The reference count indicates the number of objects
+ * which might need to reference this historical entry at any point.
+ * ReferenceCount =
+ *    number of outstanding delegations which ended the associated period (and
+ *    might need to read that record)
+ *  + number of slashes which ended the associated period (and might need to
+ *  read that record)
+ *  + one per validator for the zeroeth period, set on initialization
+ * @name ValidatorHistoricalRewards
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorHistoricalRewards
+ */
 export const ValidatorHistoricalRewards = {
     typeUrl: "/cosmos.distribution.v1beta1.ValidatorHistoricalRewards",
     aminoType: "cosmos-sdk/ValidatorHistoricalRewards",
@@ -206,6 +229,9 @@ export const ValidatorHistoricalRewards = {
         };
     },
     registerTypeUrl() {
+        if (!GlobalDecoderRegistry.registerExistingTypeUrl(ValidatorHistoricalRewards.typeUrl)) {
+            return;
+        }
         DecCoin.registerTypeUrl();
     }
 };
@@ -215,6 +241,14 @@ function createBaseValidatorCurrentRewards() {
         period: BigInt(0)
     };
 }
+/**
+ * ValidatorCurrentRewards represents current rewards and current
+ * period for a validator kept as a running counter and incremented
+ * each block as long as the validator's tokens remain constant.
+ * @name ValidatorCurrentRewards
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorCurrentRewards
+ */
 export const ValidatorCurrentRewards = {
     typeUrl: "/cosmos.distribution.v1beta1.ValidatorCurrentRewards",
     aminoType: "cosmos-sdk/ValidatorCurrentRewards",
@@ -300,6 +334,9 @@ export const ValidatorCurrentRewards = {
         };
     },
     registerTypeUrl() {
+        if (!GlobalDecoderRegistry.registerExistingTypeUrl(ValidatorCurrentRewards.typeUrl)) {
+            return;
+        }
         DecCoin.registerTypeUrl();
     }
 };
@@ -308,6 +345,13 @@ function createBaseValidatorAccumulatedCommission() {
         commission: []
     };
 }
+/**
+ * ValidatorAccumulatedCommission represents accumulated commission
+ * for a validator kept as a running counter, can be withdrawn at any time.
+ * @name ValidatorAccumulatedCommission
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorAccumulatedCommission
+ */
 export const ValidatorAccumulatedCommission = {
     typeUrl: "/cosmos.distribution.v1beta1.ValidatorAccumulatedCommission",
     aminoType: "cosmos-sdk/ValidatorAccumulatedCommission",
@@ -382,6 +426,9 @@ export const ValidatorAccumulatedCommission = {
         };
     },
     registerTypeUrl() {
+        if (!GlobalDecoderRegistry.registerExistingTypeUrl(ValidatorAccumulatedCommission.typeUrl)) {
+            return;
+        }
         DecCoin.registerTypeUrl();
     }
 };
@@ -390,6 +437,13 @@ function createBaseValidatorOutstandingRewards() {
         rewards: []
     };
 }
+/**
+ * ValidatorOutstandingRewards represents outstanding (un-withdrawn) rewards
+ * for a validator inexpensive to track, allows simple sanity checks.
+ * @name ValidatorOutstandingRewards
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorOutstandingRewards
+ */
 export const ValidatorOutstandingRewards = {
     typeUrl: "/cosmos.distribution.v1beta1.ValidatorOutstandingRewards",
     aminoType: "cosmos-sdk/ValidatorOutstandingRewards",
@@ -464,6 +518,9 @@ export const ValidatorOutstandingRewards = {
         };
     },
     registerTypeUrl() {
+        if (!GlobalDecoderRegistry.registerExistingTypeUrl(ValidatorOutstandingRewards.typeUrl)) {
+            return;
+        }
         DecCoin.registerTypeUrl();
     }
 };
@@ -473,6 +530,15 @@ function createBaseValidatorSlashEvent() {
         fraction: ""
     };
 }
+/**
+ * ValidatorSlashEvent represents a validator slash event.
+ * Height is implicit within the store key.
+ * This is needed to calculate appropriate amount of staking tokens
+ * for delegations which are withdrawn after a slash has occurred.
+ * @name ValidatorSlashEvent
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorSlashEvent
+ */
 export const ValidatorSlashEvent = {
     typeUrl: "/cosmos.distribution.v1beta1.ValidatorSlashEvent",
     aminoType: "cosmos-sdk/ValidatorSlashEvent",
@@ -561,6 +627,12 @@ function createBaseValidatorSlashEvents() {
         validatorSlashEvents: []
     };
 }
+/**
+ * ValidatorSlashEvents is a collection of ValidatorSlashEvent messages.
+ * @name ValidatorSlashEvents
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorSlashEvents
+ */
 export const ValidatorSlashEvents = {
     typeUrl: "/cosmos.distribution.v1beta1.ValidatorSlashEvents",
     aminoType: "cosmos-sdk/ValidatorSlashEvents",
@@ -635,6 +707,9 @@ export const ValidatorSlashEvents = {
         };
     },
     registerTypeUrl() {
+        if (!GlobalDecoderRegistry.registerExistingTypeUrl(ValidatorSlashEvents.typeUrl)) {
+            return;
+        }
         ValidatorSlashEvent.registerTypeUrl();
     }
 };
@@ -643,6 +718,12 @@ function createBaseFeePool() {
         communityPool: []
     };
 }
+/**
+ * FeePool is the global fee pool for distribution.
+ * @name FeePool
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.FeePool
+ */
 export const FeePool = {
     typeUrl: "/cosmos.distribution.v1beta1.FeePool",
     aminoType: "cosmos-sdk/FeePool",
@@ -717,6 +798,9 @@ export const FeePool = {
         };
     },
     registerTypeUrl() {
+        if (!GlobalDecoderRegistry.registerExistingTypeUrl(FeePool.typeUrl)) {
+            return;
+        }
         DecCoin.registerTypeUrl();
     }
 };
@@ -728,6 +812,20 @@ function createBaseCommunityPoolSpendProposal() {
         amount: []
     };
 }
+/**
+ * CommunityPoolSpendProposal details a proposal for use of community funds,
+ * together with how many coins are proposed to be spent, and to which
+ * recipient account.
+ *
+ * Deprecated: Do not use. As of the Cosmos SDK release v0.47.x, there is no
+ * longer a need for an explicit CommunityPoolSpendProposal. To spend community
+ * pool funds, a simple MsgCommunityPoolSpend can be invoked from the x/gov
+ * module via a v1 governance proposal.
+ * @name CommunityPoolSpendProposal
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.CommunityPoolSpendProposal
+ * @deprecated
+ */
 export const CommunityPoolSpendProposal = {
     typeUrl: "/cosmos.distribution.v1beta1.CommunityPoolSpendProposal",
     aminoType: "cosmos-sdk/CommunityPoolSpendProposal",
@@ -835,6 +933,9 @@ export const CommunityPoolSpendProposal = {
         };
     },
     registerTypeUrl() {
+        if (!GlobalDecoderRegistry.registerExistingTypeUrl(CommunityPoolSpendProposal.typeUrl)) {
+            return;
+        }
         GlobalDecoderRegistry.register(CommunityPoolSpendProposal.typeUrl, CommunityPoolSpendProposal);
         GlobalDecoderRegistry.registerAminoProtoMapping(CommunityPoolSpendProposal.aminoType, CommunityPoolSpendProposal.typeUrl);
         Coin.registerTypeUrl();
@@ -847,6 +948,17 @@ function createBaseDelegatorStartingInfo() {
         height: BigInt(0)
     };
 }
+/**
+ * DelegatorStartingInfo represents the starting info for a delegator reward
+ * period. It tracks the previous validator period, the delegation's amount of
+ * staking token, and the creation height (to check later on if any slashes have
+ * occurred). NOTE: Even though validators are slashed to whole staking tokens,
+ * the delegators within the validator may be left with less than a full token,
+ * thus sdk.Dec is used.
+ * @name DelegatorStartingInfo
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.DelegatorStartingInfo
+ */
 export const DelegatorStartingInfo = {
     typeUrl: "/cosmos.distribution.v1beta1.DelegatorStartingInfo",
     aminoType: "cosmos-sdk/DelegatorStartingInfo",
@@ -947,6 +1059,13 @@ function createBaseDelegationDelegatorReward() {
         reward: []
     };
 }
+/**
+ * DelegationDelegatorReward represents the properties
+ * of a delegator's delegation reward.
+ * @name DelegationDelegatorReward
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.DelegationDelegatorReward
+ */
 export const DelegationDelegatorReward = {
     typeUrl: "/cosmos.distribution.v1beta1.DelegationDelegatorReward",
     aminoType: "cosmos-sdk/DelegationDelegatorReward",
@@ -1032,6 +1151,9 @@ export const DelegationDelegatorReward = {
         };
     },
     registerTypeUrl() {
+        if (!GlobalDecoderRegistry.registerExistingTypeUrl(DelegationDelegatorReward.typeUrl)) {
+            return;
+        }
         DecCoin.registerTypeUrl();
     }
 };
@@ -1044,6 +1166,13 @@ function createBaseCommunityPoolSpendProposalWithDeposit() {
         deposit: ""
     };
 }
+/**
+ * CommunityPoolSpendProposalWithDeposit defines a CommunityPoolSpendProposal
+ * with a deposit
+ * @name CommunityPoolSpendProposalWithDeposit
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.CommunityPoolSpendProposalWithDeposit
+ */
 export const CommunityPoolSpendProposalWithDeposit = {
     typeUrl: "/cosmos.distribution.v1beta1.CommunityPoolSpendProposalWithDeposit",
     aminoType: "cosmos-sdk/CommunityPoolSpendProposalWithDeposit",
@@ -1159,6 +1288,9 @@ export const CommunityPoolSpendProposalWithDeposit = {
         };
     },
     registerTypeUrl() {
+        if (!GlobalDecoderRegistry.registerExistingTypeUrl(CommunityPoolSpendProposalWithDeposit.typeUrl)) {
+            return;
+        }
         GlobalDecoderRegistry.register(CommunityPoolSpendProposalWithDeposit.typeUrl, CommunityPoolSpendProposalWithDeposit);
         GlobalDecoderRegistry.registerAminoProtoMapping(CommunityPoolSpendProposalWithDeposit.aminoType, CommunityPoolSpendProposalWithDeposit.typeUrl);
     }

package/esm/cosmos/distribution/v1beta1/genesis.js

@@ -1,12 +1,21 @@
 import { DecCoin } from "../../base/v1beta1/coin";
 import { ValidatorAccumulatedCommission, ValidatorHistoricalRewards, ValidatorCurrentRewards, DelegatorStartingInfo, ValidatorSlashEvent, Params, FeePool } from "./distribution";
 import { BinaryReader, BinaryWriter } from "../../../binary";
+import { GlobalDecoderRegistry } from "../../../registry";
 function createBaseDelegatorWithdrawInfo() {
     return {
         delegatorAddress: "",
         withdrawAddress: ""
     };
 }
+/**
+ * DelegatorWithdrawInfo is the address for where distributions rewards are
+ * withdrawn to by default this struct is only used at genesis to feed in
+ * default withdraw addresses.
+ * @name DelegatorWithdrawInfo
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.DelegatorWithdrawInfo
+ */
 export const DelegatorWithdrawInfo = {
     typeUrl: "/cosmos.distribution.v1beta1.DelegatorWithdrawInfo",
     aminoType: "cosmos-sdk/DelegatorWithdrawInfo",
@@ -96,6 +105,12 @@ function createBaseValidatorOutstandingRewardsRecord() {
         outstandingRewards: []
     };
 }
+/**
+ * ValidatorOutstandingRewardsRecord is used for import/export via genesis json.
+ * @name ValidatorOutstandingRewardsRecord
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorOutstandingRewardsRecord
+ */
 export const ValidatorOutstandingRewardsRecord = {
     typeUrl: "/cosmos.distribution.v1beta1.ValidatorOutstandingRewardsRecord",
     aminoType: "cosmos-sdk/ValidatorOutstandingRewardsRecord",
@@ -181,6 +196,9 @@ export const ValidatorOutstandingRewardsRecord = {
         };
     },
     registerTypeUrl() {
+        if (!GlobalDecoderRegistry.registerExistingTypeUrl(ValidatorOutstandingRewardsRecord.typeUrl)) {
+            return;
+        }
         DecCoin.registerTypeUrl();
     }
 };
@@ -190,6 +208,13 @@ function createBaseValidatorAccumulatedCommissionRecord() {
         accumulated: ValidatorAccumulatedCommission.fromPartial({})
     };
 }
+/**
+ * ValidatorAccumulatedCommissionRecord is used for import / export via genesis
+ * json.
+ * @name ValidatorAccumulatedCommissionRecord
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorAccumulatedCommissionRecord
+ */
 export const ValidatorAccumulatedCommissionRecord = {
     typeUrl: "/cosmos.distribution.v1beta1.ValidatorAccumulatedCommissionRecord",
     aminoType: "cosmos-sdk/ValidatorAccumulatedCommissionRecord",
@@ -272,6 +297,9 @@ export const ValidatorAccumulatedCommissionRecord = {
         };
     },
     registerTypeUrl() {
+        if (!GlobalDecoderRegistry.registerExistingTypeUrl(ValidatorAccumulatedCommissionRecord.typeUrl)) {
+            return;
+        }
         ValidatorAccumulatedCommission.registerTypeUrl();
     }
 };
@@ -282,6 +310,13 @@ function createBaseValidatorHistoricalRewardsRecord() {
         rewards: ValidatorHistoricalRewards.fromPartial({})
     };
 }
+/**
+ * ValidatorHistoricalRewardsRecord is used for import / export via genesis
+ * json.
+ * @name ValidatorHistoricalRewardsRecord
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorHistoricalRewardsRecord
+ */
 export const ValidatorHistoricalRewardsRecord = {
     typeUrl: "/cosmos.distribution.v1beta1.ValidatorHistoricalRewardsRecord",
     aminoType: "cosmos-sdk/ValidatorHistoricalRewardsRecord",
@@ -375,6 +410,9 @@ export const ValidatorHistoricalRewardsRecord = {
         };
     },
     registerTypeUrl() {
+        if (!GlobalDecoderRegistry.registerExistingTypeUrl(ValidatorHistoricalRewardsRecord.typeUrl)) {
+            return;
+        }
         ValidatorHistoricalRewards.registerTypeUrl();
     }
 };
@@ -384,6 +422,12 @@ function createBaseValidatorCurrentRewardsRecord() {
         rewards: ValidatorCurrentRewards.fromPartial({})
     };
 }
+/**
+ * ValidatorCurrentRewardsRecord is used for import / export via genesis json.
+ * @name ValidatorCurrentRewardsRecord
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorCurrentRewardsRecord
+ */
 export const ValidatorCurrentRewardsRecord = {
     typeUrl: "/cosmos.distribution.v1beta1.ValidatorCurrentRewardsRecord",
     aminoType: "cosmos-sdk/ValidatorCurrentRewardsRecord",
@@ -466,6 +510,9 @@ export const ValidatorCurrentRewardsRecord = {
         };
     },
     registerTypeUrl() {
+        if (!GlobalDecoderRegistry.registerExistingTypeUrl(ValidatorCurrentRewardsRecord.typeUrl)) {
+            return;
+        }
         ValidatorCurrentRewards.registerTypeUrl();
     }
 };
@@ -476,6 +523,12 @@ function createBaseDelegatorStartingInfoRecord() {
         startingInfo: DelegatorStartingInfo.fromPartial({})
     };
 }
+/**
+ * DelegatorStartingInfoRecord used for import / export via genesis json.
+ * @name DelegatorStartingInfoRecord
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.DelegatorStartingInfoRecord
+ */
 export const DelegatorStartingInfoRecord = {
     typeUrl: "/cosmos.distribution.v1beta1.DelegatorStartingInfoRecord",
     aminoType: "cosmos-sdk/DelegatorStartingInfoRecord",
@@ -569,6 +622,9 @@ export const DelegatorStartingInfoRecord = {
         };
     },
     registerTypeUrl() {
+        if (!GlobalDecoderRegistry.registerExistingTypeUrl(DelegatorStartingInfoRecord.typeUrl)) {
+            return;
+        }
         DelegatorStartingInfo.registerTypeUrl();
     }
 };
@@ -580,6 +636,12 @@ function createBaseValidatorSlashEventRecord() {
         validatorSlashEvent: ValidatorSlashEvent.fromPartial({})
     };
 }
+/**
+ * ValidatorSlashEventRecord is used for import / export via genesis json.
+ * @name ValidatorSlashEventRecord
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorSlashEventRecord
+ */
 export const ValidatorSlashEventRecord = {
     typeUrl: "/cosmos.distribution.v1beta1.ValidatorSlashEventRecord",
     aminoType: "cosmos-sdk/ValidatorSlashEventRecord",
@@ -684,6 +746,9 @@ export const ValidatorSlashEventRecord = {
         };
     },
     registerTypeUrl() {
+        if (!GlobalDecoderRegistry.registerExistingTypeUrl(ValidatorSlashEventRecord.typeUrl)) {
+            return;
+        }
         ValidatorSlashEvent.registerTypeUrl();
     }
 };
@@ -701,6 +766,12 @@ function createBaseGenesisState() {
         validatorSlashEvents: []
     };
 }
+/**
+ * GenesisState defines the distribution module's genesis state.
+ * @name GenesisState
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.GenesisState
+ */
 export const GenesisState = {
     typeUrl: "/cosmos.distribution.v1beta1.GenesisState",
     aminoType: "cosmos-sdk/GenesisState",
@@ -892,6 +963,9 @@ export const GenesisState = {
         };
     },
     registerTypeUrl() {
+        if (!GlobalDecoderRegistry.registerExistingTypeUrl(GenesisState.typeUrl)) {
+            return;
+        }
         Params.registerTypeUrl();
         FeePool.registerTypeUrl();
         DelegatorWithdrawInfo.registerTypeUrl();