@xpla/xplajs 1.7.0 → 1.8.0-rc.1

package/cosmos/distribution/v1beta1/distribution.d.ts

@@ -1,20 +1,25 @@
 import { DecCoin, DecCoinAmino, Coin, CoinAmino } from "../../base/v1beta1/coin";
 import { BinaryReader, BinaryWriter } from "../../../binary";
 import { DeepPartial } from "../../../helpers";
-/** Params defines the set of params for the distribution module. */
+/**
+ * Params defines the set of params for the distribution module.
+ * @name Params
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.Params
+ */
 export interface Params {
     communityTax: string;
     /**
      * Deprecated: The base_proposer_reward field is deprecated and is no longer used
      * in the x/distribution module's reward mechanism.
+     * @deprecated
      */
-    /** @deprecated */
     baseProposerReward: string;
     /**
      * Deprecated: The bonus_proposer_reward field is deprecated and is no longer used
      * in the x/distribution module's reward mechanism.
+     * @deprecated
      */
-    /** @deprecated */
     bonusProposerReward: string;
     withdrawAddrEnabled: boolean;
 }
@@ -22,20 +27,25 @@ export interface ParamsProtoMsg {
     typeUrl: "/cosmos.distribution.v1beta1.Params";
     value: Uint8Array;
 }
-/** Params defines the set of params for the distribution module. */
+/**
+ * Params defines the set of params for the distribution module.
+ * @name ParamsAmino
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.Params
+ */
 export interface ParamsAmino {
     community_tax: string;
     /**
      * Deprecated: The base_proposer_reward field is deprecated and is no longer used
      * in the x/distribution module's reward mechanism.
+     * @deprecated
      */
-    /** @deprecated */
     base_proposer_reward: string;
     /**
      * Deprecated: The bonus_proposer_reward field is deprecated and is no longer used
      * in the x/distribution module's reward mechanism.
+     * @deprecated
      */
-    /** @deprecated */
     bonus_proposer_reward: string;
     withdraw_addr_enabled: boolean;
 }
@@ -56,6 +66,9 @@ export interface ParamsAminoMsg {
  *  + 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 interface ValidatorHistoricalRewards {
     cumulativeRewardRatio: DecCoin[];
@@ -78,6 +91,9 @@ export interface ValidatorHistoricalRewardsProtoMsg {
  *  + 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 ValidatorHistoricalRewardsAmino
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorHistoricalRewards
  */
 export interface ValidatorHistoricalRewardsAmino {
     cumulative_reward_ratio: DecCoinAmino[];
@@ -91,6 +107,9 @@ export interface ValidatorHistoricalRewardsAminoMsg {
  * 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 interface ValidatorCurrentRewards {
     rewards: DecCoin[];
@@ -104,6 +123,9 @@ export interface ValidatorCurrentRewardsProtoMsg {
  * 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 ValidatorCurrentRewardsAmino
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorCurrentRewards
  */
 export interface ValidatorCurrentRewardsAmino {
     rewards: DecCoinAmino[];
@@ -116,6 +138,9 @@ export interface ValidatorCurrentRewardsAminoMsg {
 /**
  * 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 interface ValidatorAccumulatedCommission {
     commission: DecCoin[];
@@ -127,6 +152,9 @@ export interface ValidatorAccumulatedCommissionProtoMsg {
 /**
  * ValidatorAccumulatedCommission represents accumulated commission
  * for a validator kept as a running counter, can be withdrawn at any time.
+ * @name ValidatorAccumulatedCommissionAmino
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorAccumulatedCommission
  */
 export interface ValidatorAccumulatedCommissionAmino {
     commission: DecCoinAmino[];
@@ -138,6 +166,9 @@ export interface ValidatorAccumulatedCommissionAminoMsg {
 /**
  * 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 interface ValidatorOutstandingRewards {
     rewards: DecCoin[];
@@ -149,6 +180,9 @@ export interface ValidatorOutstandingRewardsProtoMsg {
 /**
  * ValidatorOutstandingRewards represents outstanding (un-withdrawn) rewards
  * for a validator inexpensive to track, allows simple sanity checks.
+ * @name ValidatorOutstandingRewardsAmino
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorOutstandingRewards
  */
 export interface ValidatorOutstandingRewardsAmino {
     rewards: DecCoinAmino[];
@@ -162,6 +196,9 @@ export interface ValidatorOutstandingRewardsAminoMsg {
  * 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 interface ValidatorSlashEvent {
     validatorPeriod: bigint;
@@ -176,6 +213,9 @@ export interface ValidatorSlashEventProtoMsg {
  * 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 ValidatorSlashEventAmino
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorSlashEvent
  */
 export interface ValidatorSlashEventAmino {
     validator_period: string;
@@ -185,7 +225,12 @@ export interface ValidatorSlashEventAminoMsg {
     type: "cosmos-sdk/ValidatorSlashEvent";
     value: ValidatorSlashEventAmino;
 }
-/** ValidatorSlashEvents is a collection of ValidatorSlashEvent messages. */
+/**
+ * ValidatorSlashEvents is a collection of ValidatorSlashEvent messages.
+ * @name ValidatorSlashEvents
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorSlashEvents
+ */
 export interface ValidatorSlashEvents {
     validatorSlashEvents: ValidatorSlashEvent[];
 }
@@ -193,7 +238,12 @@ export interface ValidatorSlashEventsProtoMsg {
     typeUrl: "/cosmos.distribution.v1beta1.ValidatorSlashEvents";
     value: Uint8Array;
 }
-/** ValidatorSlashEvents is a collection of ValidatorSlashEvent messages. */
+/**
+ * ValidatorSlashEvents is a collection of ValidatorSlashEvent messages.
+ * @name ValidatorSlashEventsAmino
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorSlashEvents
+ */
 export interface ValidatorSlashEventsAmino {
     validator_slash_events: ValidatorSlashEventAmino[];
 }
@@ -201,7 +251,12 @@ export interface ValidatorSlashEventsAminoMsg {
     type: "cosmos-sdk/ValidatorSlashEvents";
     value: ValidatorSlashEventsAmino;
 }
-/** FeePool is the global fee pool for distribution. */
+/**
+ * FeePool is the global fee pool for distribution.
+ * @name FeePool
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.FeePool
+ */
 export interface FeePool {
     communityPool: DecCoin[];
 }
@@ -209,7 +264,12 @@ export interface FeePoolProtoMsg {
     typeUrl: "/cosmos.distribution.v1beta1.FeePool";
     value: Uint8Array;
 }
-/** FeePool is the global fee pool for distribution. */
+/**
+ * FeePool is the global fee pool for distribution.
+ * @name FeePoolAmino
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.FeePool
+ */
 export interface FeePoolAmino {
     community_pool: DecCoinAmino[];
 }
@@ -226,8 +286,11 @@ export interface FeePoolAminoMsg {
  * 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
  */
-/** @deprecated */
 export interface CommunityPoolSpendProposal {
     title: string;
     description: string;
@@ -247,8 +310,11 @@ export interface CommunityPoolSpendProposalProtoMsg {
  * 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 CommunityPoolSpendProposalAmino
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.CommunityPoolSpendProposal
+ * @deprecated
  */
-/** @deprecated */
 export interface CommunityPoolSpendProposalAmino {
     title: string;
     description: string;
@@ -266,6 +332,9 @@ export interface CommunityPoolSpendProposalAminoMsg {
  * 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 interface DelegatorStartingInfo {
     previousPeriod: bigint;
@@ -283,6 +352,9 @@ export interface DelegatorStartingInfoProtoMsg {
  * 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 DelegatorStartingInfoAmino
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.DelegatorStartingInfo
  */
 export interface DelegatorStartingInfoAmino {
     previous_period: string;
@@ -296,6 +368,9 @@ export interface DelegatorStartingInfoAminoMsg {
 /**
  * DelegationDelegatorReward represents the properties
  * of a delegator's delegation reward.
+ * @name DelegationDelegatorReward
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.DelegationDelegatorReward
  */
 export interface DelegationDelegatorReward {
     validatorAddress: string;
@@ -308,6 +383,9 @@ export interface DelegationDelegatorRewardProtoMsg {
 /**
  * DelegationDelegatorReward represents the properties
  * of a delegator's delegation reward.
+ * @name DelegationDelegatorRewardAmino
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.DelegationDelegatorReward
  */
 export interface DelegationDelegatorRewardAmino {
     validator_address: string;
@@ -320,6 +398,9 @@ export interface DelegationDelegatorRewardAminoMsg {
 /**
  * CommunityPoolSpendProposalWithDeposit defines a CommunityPoolSpendProposal
  * with a deposit
+ * @name CommunityPoolSpendProposalWithDeposit
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.CommunityPoolSpendProposalWithDeposit
  */
 export interface CommunityPoolSpendProposalWithDeposit {
     title: string;
@@ -335,6 +416,9 @@ export interface CommunityPoolSpendProposalWithDepositProtoMsg {
 /**
  * CommunityPoolSpendProposalWithDeposit defines a CommunityPoolSpendProposal
  * with a deposit
+ * @name CommunityPoolSpendProposalWithDepositAmino
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.CommunityPoolSpendProposalWithDeposit
  */
 export interface CommunityPoolSpendProposalWithDepositAmino {
     title: string;
@@ -347,6 +431,12 @@ export interface CommunityPoolSpendProposalWithDepositAminoMsg {
     type: "cosmos-sdk/CommunityPoolSpendProposalWithDeposit";
     value: CommunityPoolSpendProposalWithDepositAmino;
 }
+/**
+ * Params defines the set of params for the distribution module.
+ * @name Params
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.Params
+ */
 export declare const Params: {
     typeUrl: string;
     aminoType: string;
@@ -364,6 +454,23 @@ export declare const Params: {
     toProtoMsg(message: Params): ParamsProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * 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 declare const ValidatorHistoricalRewards: {
     typeUrl: string;
     aminoType: string;
@@ -381,6 +488,14 @@ export declare const ValidatorHistoricalRewards: {
     toProtoMsg(message: ValidatorHistoricalRewards): ValidatorHistoricalRewardsProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * 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 declare const ValidatorCurrentRewards: {
     typeUrl: string;
     aminoType: string;
@@ -398,6 +513,13 @@ export declare const ValidatorCurrentRewards: {
     toProtoMsg(message: ValidatorCurrentRewards): ValidatorCurrentRewardsProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * 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 declare const ValidatorAccumulatedCommission: {
     typeUrl: string;
     aminoType: string;
@@ -415,6 +537,13 @@ export declare const ValidatorAccumulatedCommission: {
     toProtoMsg(message: ValidatorAccumulatedCommission): ValidatorAccumulatedCommissionProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * 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 declare const ValidatorOutstandingRewards: {
     typeUrl: string;
     aminoType: string;
@@ -432,6 +561,15 @@ export declare const ValidatorOutstandingRewards: {
     toProtoMsg(message: ValidatorOutstandingRewards): ValidatorOutstandingRewardsProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * 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 declare const ValidatorSlashEvent: {
     typeUrl: string;
     aminoType: string;
@@ -449,6 +587,12 @@ export declare const ValidatorSlashEvent: {
     toProtoMsg(message: ValidatorSlashEvent): ValidatorSlashEventProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * ValidatorSlashEvents is a collection of ValidatorSlashEvent messages.
+ * @name ValidatorSlashEvents
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.ValidatorSlashEvents
+ */
 export declare const ValidatorSlashEvents: {
     typeUrl: string;
     aminoType: string;
@@ -466,6 +610,12 @@ export declare const ValidatorSlashEvents: {
     toProtoMsg(message: ValidatorSlashEvents): ValidatorSlashEventsProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * FeePool is the global fee pool for distribution.
+ * @name FeePool
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.FeePool
+ */
 export declare const FeePool: {
     typeUrl: string;
     aminoType: string;
@@ -483,6 +633,20 @@ export declare const FeePool: {
     toProtoMsg(message: FeePool): FeePoolProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * 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 declare const CommunityPoolSpendProposal: {
     typeUrl: string;
     aminoType: string;
@@ -500,6 +664,17 @@ export declare const CommunityPoolSpendProposal: {
     toProtoMsg(message: CommunityPoolSpendProposal): CommunityPoolSpendProposalProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * 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 declare const DelegatorStartingInfo: {
     typeUrl: string;
     aminoType: string;
@@ -517,6 +692,13 @@ export declare const DelegatorStartingInfo: {
     toProtoMsg(message: DelegatorStartingInfo): DelegatorStartingInfoProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * DelegationDelegatorReward represents the properties
+ * of a delegator's delegation reward.
+ * @name DelegationDelegatorReward
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.DelegationDelegatorReward
+ */
 export declare const DelegationDelegatorReward: {
     typeUrl: string;
     aminoType: string;
@@ -534,6 +716,13 @@ export declare const DelegationDelegatorReward: {
     toProtoMsg(message: DelegationDelegatorReward): DelegationDelegatorRewardProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * CommunityPoolSpendProposalWithDeposit defines a CommunityPoolSpendProposal
+ * with a deposit
+ * @name CommunityPoolSpendProposalWithDeposit
+ * @package cosmos.distribution.v1beta1
+ * @see proto type: cosmos.distribution.v1beta1.CommunityPoolSpendProposalWithDeposit
+ */
 export declare const CommunityPoolSpendProposalWithDeposit: {
     typeUrl: string;
     aminoType: string;