@sparkdreamnft/sparkdreamjs 0.0.5 → 0.0.7

package/cosmos/gov/v1beta1/gov.d.ts

@@ -59,13 +59,18 @@ export declare function proposalStatusFromJSON(object: any): ProposalStatus;
 export declare function proposalStatusToJSON(object: ProposalStatus): string;
 /**
  * WeightedVoteOption defines a unit of vote for vote split.
- *
- * Since: cosmos-sdk 0.43
+ * @name WeightedVoteOption
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.WeightedVoteOption
  */
 export interface WeightedVoteOption {
-    /** option defines the valid vote options, it must not contain duplicate vote options. */
+    /**
+     * option defines the valid vote options, it must not contain duplicate vote options.
+     */
     option: VoteOption;
-    /** weight is the vote weight associated with the vote option. */
+    /**
+     * weight is the vote weight associated with the vote option.
+     */
     weight: string;
 }
 export interface WeightedVoteOptionProtoMsg {
@@ -74,13 +79,18 @@ export interface WeightedVoteOptionProtoMsg {
 }
 /**
  * WeightedVoteOption defines a unit of vote for vote split.
- *
- * Since: cosmos-sdk 0.43
+ * @name WeightedVoteOptionAmino
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.WeightedVoteOption
  */
 export interface WeightedVoteOptionAmino {
-    /** option defines the valid vote options, it must not contain duplicate vote options. */
+    /**
+     * option defines the valid vote options, it must not contain duplicate vote options.
+     */
     option?: VoteOption;
-    /** weight is the vote weight associated with the vote option. */
+    /**
+     * weight is the vote weight associated with the vote option.
+     */
     weight: string;
 }
 export interface WeightedVoteOptionAminoMsg {
@@ -90,11 +100,18 @@ export interface WeightedVoteOptionAminoMsg {
 /**
  * TextProposal defines a standard text proposal whose changes need to be
  * manually updated in case of approval.
+ * @name TextProposal
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.TextProposal
  */
 export interface TextProposal {
-    /** title of the proposal. */
+    /**
+     * title of the proposal.
+     */
     title: string;
-    /** description associated with the proposal. */
+    /**
+     * description associated with the proposal.
+     */
     description: string;
 }
 export interface TextProposalProtoMsg {
@@ -104,11 +121,18 @@ export interface TextProposalProtoMsg {
 /**
  * TextProposal defines a standard text proposal whose changes need to be
  * manually updated in case of approval.
+ * @name TextProposalAmino
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.TextProposal
  */
 export interface TextProposalAmino {
-    /** title of the proposal. */
+    /**
+     * title of the proposal.
+     */
     title?: string;
-    /** description associated with the proposal. */
+    /**
+     * description associated with the proposal.
+     */
     description?: string;
 }
 export interface TextProposalAminoMsg {
@@ -118,13 +142,22 @@ export interface TextProposalAminoMsg {
 /**
  * Deposit defines an amount deposited by an account address to an active
  * proposal.
+ * @name Deposit
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.Deposit
  */
 export interface Deposit {
-    /** proposal_id defines the unique id of the proposal. */
+    /**
+     * proposal_id defines the unique id of the proposal.
+     */
     proposalId: bigint;
-    /** depositor defines the deposit addresses from the proposals. */
+    /**
+     * depositor defines the deposit addresses from the proposals.
+     */
     depositor: string;
-    /** amount to be deposited by depositor. */
+    /**
+     * amount to be deposited by depositor.
+     */
     amount: Coin[];
 }
 export interface DepositProtoMsg {
@@ -134,26 +167,46 @@ export interface DepositProtoMsg {
 /**
  * Deposit defines an amount deposited by an account address to an active
  * proposal.
+ * @name DepositAmino
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.Deposit
  */
 export interface DepositAmino {
-    /** proposal_id defines the unique id of the proposal. */
+    /**
+     * proposal_id defines the unique id of the proposal.
+     */
     proposal_id?: string;
-    /** depositor defines the deposit addresses from the proposals. */
+    /**
+     * depositor defines the deposit addresses from the proposals.
+     */
     depositor?: string;
-    /** amount to be deposited by depositor. */
+    /**
+     * amount to be deposited by depositor.
+     */
     amount: CoinAmino[];
 }
 export interface DepositAminoMsg {
     type: "cosmos-sdk/Deposit";
     value: DepositAmino;
 }
-/** Proposal defines the core field members of a governance proposal. */
+/**
+ * Proposal defines the core field members of a governance proposal.
+ * @name Proposal
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.Proposal
+ */
 export interface Proposal {
-    /** proposal_id defines the unique id of the proposal. */
+    /**
+     * proposal_id defines the unique id of the proposal.
+     */
     proposalId: bigint;
-    /** content is the proposal's content. */
+    /**
+     * content is the proposal's content.
+     */
     content?: TextProposal | CommunityPoolSpendProposal | CommunityPoolSpendProposalWithDeposit | ParameterChangeProposal | SoftwareUpgradeProposal | CancelSoftwareUpgradeProposal | Any | undefined;
-    /** status defines the proposal status. */
+    /**
+     * status defines the proposal status.
+     */
     status: ProposalStatus;
     /**
      * final_tally_result is the final tally result of the proposal. When
@@ -161,15 +214,25 @@ export interface Proposal {
      * proposal's voting period has ended.
      */
     finalTallyResult: TallyResult;
-    /** submit_time is the time of proposal submission. */
+    /**
+     * submit_time is the time of proposal submission.
+     */
     submitTime: Date;
-    /** deposit_end_time is the end time for deposition. */
+    /**
+     * deposit_end_time is the end time for deposition.
+     */
     depositEndTime: Date;
-    /** total_deposit is the total deposit on the proposal. */
+    /**
+     * total_deposit is the total deposit on the proposal.
+     */
     totalDeposit: Coin[];
-    /** voting_start_time is the starting time to vote on a proposal. */
+    /**
+     * voting_start_time is the starting time to vote on a proposal.
+     */
     votingStartTime: Date;
-    /** voting_end_time is the end time of voting on a proposal. */
+    /**
+     * voting_end_time is the end time of voting on a proposal.
+     */
     votingEndTime: Date;
 }
 export interface ProposalProtoMsg {
@@ -177,15 +240,29 @@ export interface ProposalProtoMsg {
     value: Uint8Array;
 }
 export type ProposalEncoded = Omit<Proposal, "content"> & {
-    /** content is the proposal's content. */ content?: TextProposalProtoMsg | CommunityPoolSpendProposalProtoMsg | CommunityPoolSpendProposalWithDepositProtoMsg | ParameterChangeProposalProtoMsg | SoftwareUpgradeProposalProtoMsg | CancelSoftwareUpgradeProposalProtoMsg | AnyProtoMsg | undefined;
+    /**
+     * content is the proposal's content.
+     */
+    content?: TextProposalProtoMsg | CommunityPoolSpendProposalProtoMsg | CommunityPoolSpendProposalWithDepositProtoMsg | ParameterChangeProposalProtoMsg | SoftwareUpgradeProposalProtoMsg | CancelSoftwareUpgradeProposalProtoMsg | AnyProtoMsg | undefined;
 };
-/** Proposal defines the core field members of a governance proposal. */
+/**
+ * Proposal defines the core field members of a governance proposal.
+ * @name ProposalAmino
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.Proposal
+ */
 export interface ProposalAmino {
-    /** proposal_id defines the unique id of the proposal. */
+    /**
+     * proposal_id defines the unique id of the proposal.
+     */
     proposal_id?: string;
-    /** content is the proposal's content. */
+    /**
+     * content is the proposal's content.
+     */
     content?: AnyAmino;
-    /** status defines the proposal status. */
+    /**
+     * status defines the proposal status.
+     */
     status?: ProposalStatus;
     /**
      * final_tally_result is the final tally result of the proposal. When
@@ -193,45 +270,81 @@ export interface ProposalAmino {
      * proposal's voting period has ended.
      */
     final_tally_result: TallyResultAmino;
-    /** submit_time is the time of proposal submission. */
+    /**
+     * submit_time is the time of proposal submission.
+     */
     submit_time: string;
-    /** deposit_end_time is the end time for deposition. */
+    /**
+     * deposit_end_time is the end time for deposition.
+     */
     deposit_end_time: string;
-    /** total_deposit is the total deposit on the proposal. */
+    /**
+     * total_deposit is the total deposit on the proposal.
+     */
     total_deposit: CoinAmino[];
-    /** voting_start_time is the starting time to vote on a proposal. */
+    /**
+     * voting_start_time is the starting time to vote on a proposal.
+     */
     voting_start_time: string;
-    /** voting_end_time is the end time of voting on a proposal. */
+    /**
+     * voting_end_time is the end time of voting on a proposal.
+     */
     voting_end_time: string;
 }
 export interface ProposalAminoMsg {
     type: "cosmos-sdk/Proposal";
     value: ProposalAmino;
 }
-/** TallyResult defines a standard tally for a governance proposal. */
+/**
+ * TallyResult defines a standard tally for a governance proposal.
+ * @name TallyResult
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.TallyResult
+ */
 export interface TallyResult {
-    /** yes is the number of yes votes on a proposal. */
+    /**
+     * yes is the number of yes votes on a proposal.
+     */
     yes: string;
-    /** abstain is the number of abstain votes on a proposal. */
+    /**
+     * abstain is the number of abstain votes on a proposal.
+     */
     abstain: string;
-    /** no is the number of no votes on a proposal. */
+    /**
+     * no is the number of no votes on a proposal.
+     */
     no: string;
-    /** no_with_veto is the number of no with veto votes on a proposal. */
+    /**
+     * no_with_veto is the number of no with veto votes on a proposal.
+     */
     noWithVeto: string;
 }
 export interface TallyResultProtoMsg {
     typeUrl: "/cosmos.gov.v1beta1.TallyResult";
     value: Uint8Array;
 }
-/** TallyResult defines a standard tally for a governance proposal. */
+/**
+ * TallyResult defines a standard tally for a governance proposal.
+ * @name TallyResultAmino
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.TallyResult
+ */
 export interface TallyResultAmino {
-    /** yes is the number of yes votes on a proposal. */
+    /**
+     * yes is the number of yes votes on a proposal.
+     */
     yes?: string;
-    /** abstain is the number of abstain votes on a proposal. */
+    /**
+     * abstain is the number of abstain votes on a proposal.
+     */
     abstain?: string;
-    /** no is the number of no votes on a proposal. */
+    /**
+     * no is the number of no votes on a proposal.
+     */
     no?: string;
-    /** no_with_veto is the number of no with veto votes on a proposal. */
+    /**
+     * no_with_veto is the number of no with veto votes on a proposal.
+     */
     no_with_veto?: string;
 }
 export interface TallyResultAminoMsg {
@@ -241,23 +354,28 @@ export interface TallyResultAminoMsg {
 /**
  * Vote defines a vote on a governance proposal.
  * A Vote consists of a proposal ID, the voter, and the vote option.
+ * @name Vote
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.Vote
  */
 export interface Vote {
-    /** proposal_id defines the unique id of the proposal. */
+    /**
+     * proposal_id defines the unique id of the proposal.
+     */
     proposalId: bigint;
-    /** voter is the voter address of the proposal. */
+    /**
+     * voter is the voter address of the proposal.
+     */
     voter: string;
     /**
      * Deprecated: Prefer to use `options` instead. This field is set in queries
      * if and only if `len(options) == 1` and that option has weight 1. In all
      * other cases, this field will default to VOTE_OPTION_UNSPECIFIED.
+     * @deprecated
      */
-    /** @deprecated */
     option: VoteOption;
     /**
      * options is the weighted vote options.
-     *
-     * Since: cosmos-sdk 0.43
      */
     options: WeightedVoteOption[];
 }
@@ -268,23 +386,28 @@ export interface VoteProtoMsg {
 /**
  * Vote defines a vote on a governance proposal.
  * A Vote consists of a proposal ID, the voter, and the vote option.
+ * @name VoteAmino
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.Vote
  */
 export interface VoteAmino {
-    /** proposal_id defines the unique id of the proposal. */
+    /**
+     * proposal_id defines the unique id of the proposal.
+     */
     proposal_id: string;
-    /** voter is the voter address of the proposal. */
+    /**
+     * voter is the voter address of the proposal.
+     */
     voter?: string;
     /**
      * Deprecated: Prefer to use `options` instead. This field is set in queries
      * if and only if `len(options) == 1` and that option has weight 1. In all
      * other cases, this field will default to VOTE_OPTION_UNSPECIFIED.
+     * @deprecated
      */
-    /** @deprecated */
     option?: VoteOption;
     /**
      * options is the weighted vote options.
-     *
-     * Since: cosmos-sdk 0.43
      */
     options: WeightedVoteOptionAmino[];
 }
@@ -292,9 +415,16 @@ export interface VoteAminoMsg {
     type: "cosmos-sdk/Vote";
     value: VoteAmino;
 }
-/** DepositParams defines the params for deposits on governance proposals. */
+/**
+ * DepositParams defines the params for deposits on governance proposals.
+ * @name DepositParams
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.DepositParams
+ */
 export interface DepositParams {
-    /** Minimum deposit for a proposal to enter voting period. */
+    /**
+     * Minimum deposit for a proposal to enter voting period.
+     */
     minDeposit: Coin[];
     /**
      * Maximum period for Atom holders to deposit on a proposal. Initial value: 2
@@ -306,9 +436,16 @@ export interface DepositParamsProtoMsg {
     typeUrl: "/cosmos.gov.v1beta1.DepositParams";
     value: Uint8Array;
 }
-/** DepositParams defines the params for deposits on governance proposals. */
+/**
+ * DepositParams defines the params for deposits on governance proposals.
+ * @name DepositParamsAmino
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.DepositParams
+ */
 export interface DepositParamsAmino {
-    /** Minimum deposit for a proposal to enter voting period. */
+    /**
+     * Minimum deposit for a proposal to enter voting period.
+     */
     min_deposit?: CoinAmino[];
     /**
      * Maximum period for Atom holders to deposit on a proposal. Initial value: 2
@@ -320,32 +457,53 @@ export interface DepositParamsAminoMsg {
     type: "cosmos-sdk/DepositParams";
     value: DepositParamsAmino;
 }
-/** VotingParams defines the params for voting on governance proposals. */
+/**
+ * VotingParams defines the params for voting on governance proposals.
+ * @name VotingParams
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.VotingParams
+ */
 export interface VotingParams {
-    /** Duration of the voting period. */
+    /**
+     * Duration of the voting period.
+     */
     votingPeriod: Duration;
 }
 export interface VotingParamsProtoMsg {
     typeUrl: "/cosmos.gov.v1beta1.VotingParams";
     value: Uint8Array;
 }
-/** VotingParams defines the params for voting on governance proposals. */
+/**
+ * VotingParams defines the params for voting on governance proposals.
+ * @name VotingParamsAmino
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.VotingParams
+ */
 export interface VotingParamsAmino {
-    /** Duration of the voting period. */
+    /**
+     * Duration of the voting period.
+     */
     voting_period?: DurationAmino;
 }
 export interface VotingParamsAminoMsg {
     type: "cosmos-sdk/VotingParams";
     value: VotingParamsAmino;
 }
-/** TallyParams defines the params for tallying votes on governance proposals. */
+/**
+ * TallyParams defines the params for tallying votes on governance proposals.
+ * @name TallyParams
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.TallyParams
+ */
 export interface TallyParams {
     /**
      * Minimum percentage of total stake needed to vote for a result to be
      * considered valid.
      */
     quorum: Uint8Array;
-    /** Minimum proportion of Yes votes for proposal to pass. Default value: 0.5. */
+    /**
+     * Minimum proportion of Yes votes for proposal to pass. Default value: 0.5.
+     */
     threshold: Uint8Array;
     /**
      * Minimum value of Veto votes to Total votes ratio for proposal to be
@@ -357,14 +515,21 @@ export interface TallyParamsProtoMsg {
     typeUrl: "/cosmos.gov.v1beta1.TallyParams";
     value: Uint8Array;
 }
-/** TallyParams defines the params for tallying votes on governance proposals. */
+/**
+ * TallyParams defines the params for tallying votes on governance proposals.
+ * @name TallyParamsAmino
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.TallyParams
+ */
 export interface TallyParamsAmino {
     /**
      * Minimum percentage of total stake needed to vote for a result to be
      * considered valid.
      */
     quorum?: string;
-    /** Minimum proportion of Yes votes for proposal to pass. Default value: 0.5. */
+    /**
+     * Minimum proportion of Yes votes for proposal to pass. Default value: 0.5.
+     */
     threshold?: string;
     /**
      * Minimum value of Veto votes to Total votes ratio for proposal to be
@@ -376,6 +541,12 @@ export interface TallyParamsAminoMsg {
     type: "cosmos-sdk/TallyParams";
     value: TallyParamsAmino;
 }
+/**
+ * WeightedVoteOption defines a unit of vote for vote split.
+ * @name WeightedVoteOption
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.WeightedVoteOption
+ */
 export declare const WeightedVoteOption: {
     typeUrl: string;
     aminoType: string;
@@ -390,6 +561,13 @@ export declare const WeightedVoteOption: {
     toProto(message: WeightedVoteOption): Uint8Array;
     toProtoMsg(message: WeightedVoteOption): WeightedVoteOptionProtoMsg;
 };
+/**
+ * TextProposal defines a standard text proposal whose changes need to be
+ * manually updated in case of approval.
+ * @name TextProposal
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.TextProposal
+ */
 export declare const TextProposal: {
     typeUrl: string;
     aminoType: string;
@@ -404,6 +582,13 @@ export declare const TextProposal: {
     toProto(message: TextProposal): Uint8Array;
     toProtoMsg(message: TextProposal): TextProposalProtoMsg;
 };
+/**
+ * Deposit defines an amount deposited by an account address to an active
+ * proposal.
+ * @name Deposit
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.Deposit
+ */
 export declare const Deposit: {
     typeUrl: string;
     aminoType: string;
@@ -418,6 +603,12 @@ export declare const Deposit: {
     toProto(message: Deposit): Uint8Array;
     toProtoMsg(message: Deposit): DepositProtoMsg;
 };
+/**
+ * Proposal defines the core field members of a governance proposal.
+ * @name Proposal
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.Proposal
+ */
 export declare const Proposal: {
     typeUrl: string;
     aminoType: string;
@@ -432,6 +623,12 @@ export declare const Proposal: {
     toProto(message: Proposal): Uint8Array;
     toProtoMsg(message: Proposal): ProposalProtoMsg;
 };
+/**
+ * TallyResult defines a standard tally for a governance proposal.
+ * @name TallyResult
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.TallyResult
+ */
 export declare const TallyResult: {
     typeUrl: string;
     aminoType: string;
@@ -446,6 +643,13 @@ export declare const TallyResult: {
     toProto(message: TallyResult): Uint8Array;
     toProtoMsg(message: TallyResult): TallyResultProtoMsg;
 };
+/**
+ * Vote defines a vote on a governance proposal.
+ * A Vote consists of a proposal ID, the voter, and the vote option.
+ * @name Vote
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.Vote
+ */
 export declare const Vote: {
     typeUrl: string;
     aminoType: string;
@@ -460,6 +664,12 @@ export declare const Vote: {
     toProto(message: Vote): Uint8Array;
     toProtoMsg(message: Vote): VoteProtoMsg;
 };
+/**
+ * DepositParams defines the params for deposits on governance proposals.
+ * @name DepositParams
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.DepositParams
+ */
 export declare const DepositParams: {
     typeUrl: string;
     aminoType: string;
@@ -474,6 +684,12 @@ export declare const DepositParams: {
     toProto(message: DepositParams): Uint8Array;
     toProtoMsg(message: DepositParams): DepositParamsProtoMsg;
 };
+/**
+ * VotingParams defines the params for voting on governance proposals.
+ * @name VotingParams
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.VotingParams
+ */
 export declare const VotingParams: {
     typeUrl: string;
     aminoType: string;
@@ -488,6 +704,12 @@ export declare const VotingParams: {
     toProto(message: VotingParams): Uint8Array;
     toProtoMsg(message: VotingParams): VotingParamsProtoMsg;
 };
+/**
+ * TallyParams defines the params for tallying votes on governance proposals.
+ * @name TallyParams
+ * @package cosmos.gov.v1beta1
+ * @see proto type: cosmos.gov.v1beta1.TallyParams
+ */
 export declare const TallyParams: {
     typeUrl: string;
     aminoType: string;