@sparkdreamnft/sparkdreamjs 0.0.6 → 0.0.7

package/cosmos/distribution/v1beta1/distribution.js

@@ -13,6 +13,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
+ */
 exports.Params = {
     typeUrl: "/cosmos.distribution.v1beta1.Params",
     aminoType: "cosmos-sdk/x/distribution/Params",
@@ -117,6 +123,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
+ */
 exports.ValidatorHistoricalRewards = {
     typeUrl: "/cosmos.distribution.v1beta1.ValidatorHistoricalRewards",
     aminoType: "cosmos-sdk/ValidatorHistoricalRewards",
@@ -202,6 +225,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
+ */
 exports.ValidatorCurrentRewards = {
     typeUrl: "/cosmos.distribution.v1beta1.ValidatorCurrentRewards",
     aminoType: "cosmos-sdk/ValidatorCurrentRewards",
@@ -286,6 +317,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
+ */
 exports.ValidatorAccumulatedCommission = {
     typeUrl: "/cosmos.distribution.v1beta1.ValidatorAccumulatedCommission",
     aminoType: "cosmos-sdk/ValidatorAccumulatedCommission",
@@ -359,6 +397,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
+ */
 exports.ValidatorOutstandingRewards = {
     typeUrl: "/cosmos.distribution.v1beta1.ValidatorOutstandingRewards",
     aminoType: "cosmos-sdk/ValidatorOutstandingRewards",
@@ -433,6 +478,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
+ */
 exports.ValidatorSlashEvent = {
     typeUrl: "/cosmos.distribution.v1beta1.ValidatorSlashEvent",
     aminoType: "cosmos-sdk/ValidatorSlashEvent",
@@ -514,6 +568,12 @@ function createBaseValidatorSlashEvents() {
         validatorSlashEvents: []
     };
 }
+/**
+ * ValidatorSlashEvents is a collection of ValidatorSlashEvent messages.
+ * @name ValidatorSlashEvents
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorSlashEvents
+ */
 exports.ValidatorSlashEvents = {
     typeUrl: "/cosmos.distribution.v1beta1.ValidatorSlashEvents",
     aminoType: "cosmos-sdk/ValidatorSlashEvents",
@@ -587,6 +647,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
+ */
 exports.FeePool = {
     typeUrl: "/cosmos.distribution.v1beta1.FeePool",
     aminoType: "cosmos-sdk/FeePool",
@@ -663,6 +729,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
+ */
 exports.CommunityPoolSpendProposal = {
     typeUrl: "/cosmos.distribution.v1beta1.CommunityPoolSpendProposal",
     aminoType: "cosmos-sdk/CommunityPoolSpendProposal",
@@ -771,6 +851,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
+ */
 exports.DelegatorStartingInfo = {
     typeUrl: "/cosmos.distribution.v1beta1.DelegatorStartingInfo",
     aminoType: "cosmos-sdk/DelegatorStartingInfo",
@@ -864,6 +955,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
+ */
 exports.DelegationDelegatorReward = {
     typeUrl: "/cosmos.distribution.v1beta1.DelegationDelegatorReward",
     aminoType: "cosmos-sdk/DelegationDelegatorReward",
@@ -952,6 +1050,13 @@ function createBaseCommunityPoolSpendProposalWithDeposit() {
         deposit: ""
     };
 }
+/**
+ * CommunityPoolSpendProposalWithDeposit defines a CommunityPoolSpendProposal
+ * with a deposit
+ * @name CommunityPoolSpendProposalWithDeposit
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.CommunityPoolSpendProposalWithDeposit
+ */
 exports.CommunityPoolSpendProposalWithDeposit = {
     typeUrl: "/cosmos.distribution.v1beta1.CommunityPoolSpendProposalWithDeposit",
     aminoType: "cosmos-sdk/CommunityPoolSpendProposalWithDeposit",