@iconlake/client 0.0.2 → 0.1.0

package/cosmos.gov.v1/rest.ts

@@ -135,9 +135,16 @@ export interface RpcStatus {
 proposal.
 */
 export interface V1Deposit {
-  /** @format uint64 */
+  /**
+   * proposal_id defines the unique id of the proposal.
+   * @format uint64
+   */
   proposal_id?: string;
+
+  /** depositor defines the deposit addresses from the proposals. */
   depositor?: string;
+
+  /** amount to be deposited by depositor. */
   amount?: V1Beta1Coin[];
 }
 
@@ -150,7 +157,7 @@ export interface V1DepositParams {
 
   /**
    * Maximum period for Atom holders to deposit on a proposal. Initial value: 2
-   *  months.
+   * months.
    */
   max_deposit_period?: string;
 }
@@ -169,10 +176,21 @@ export type V1MsgExecLegacyContentResponse = object;
  * MsgSubmitProposalResponse defines the Msg/SubmitProposal response type.
  */
 export interface V1MsgSubmitProposalResponse {
-  /** @format uint64 */
+  /**
+   * proposal_id defines the unique id of the proposal.
+   * @format uint64
+   */
   proposal_id?: string;
 }
 
+/**
+* MsgUpdateParamsResponse defines the response structure for executing a
+MsgUpdateParams message.
+
+Since: cosmos-sdk 0.47
+*/
+export type V1MsgUpdateParamsResponse = object;
+
 /**
  * MsgVoteResponse defines the Msg/Vote response type.
  */
@@ -183,28 +201,66 @@ export type V1MsgVoteResponse = object;
  */
 export type V1MsgVoteWeightedResponse = object;
 
+/**
+* Params defines the parameters for the x/gov module.
+
+Since: cosmos-sdk 0.47
+*/
+export interface V1Params {
+  /** Minimum deposit for a proposal to enter voting period. */
+  min_deposit?: V1Beta1Coin[];
+
+  /**
+   * Maximum period for Atom holders to deposit on a proposal. Initial value: 2
+   * months.
+   */
+  max_deposit_period?: string;
+
+  /** Duration of the voting period. */
+  voting_period?: string;
+
+  /**
+   * 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. */
+  threshold?: string;
+
+  /**
+   * Minimum value of Veto votes to Total votes ratio for proposal to be
+   *  vetoed. Default value: 1/3.
+   */
+  veto_threshold?: string;
+
+  /** The ratio representing the proportion of the deposit value that must be paid at proposal submission. */
+  min_initial_deposit_ratio?: string;
+
+  /** burn deposits if a proposal does not meet quorum */
+  burn_vote_quorum?: boolean;
+
+  /** burn deposits if the proposal does not enter voting period */
+  burn_proposal_deposit_prevote?: boolean;
+
+  /** burn deposits if quorum with vote type no_veto is met */
+  burn_vote_veto?: boolean;
+}
+
 /**
  * Proposal defines the core field members of a governance proposal.
  */
 export interface V1Proposal {
-  /** @format uint64 */
+  /**
+   * id defines the unique id of the proposal.
+   * @format uint64
+   */
   id?: string;
+
+  /** messages are the arbitrary messages to be executed if the proposal passes. */
   messages?: ProtobufAny[];
 
-  /**
-   * ProposalStatus enumerates the valid statuses of a proposal.
-   *
-   *  - PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default proposal status.
-   *  - PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit
-   * period.
-   *  - PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting
-   *  - PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has
-   * passed.
-   *  - PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has
-   * been rejected.
-   *  - PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has
-   * failed.
-   */
+  /** status defines the proposal status. */
   status?: V1ProposalStatus;
 
   /**
@@ -214,21 +270,53 @@ export interface V1Proposal {
    */
   final_tally_result?: V1TallyResult;
 
-  /** @format date-time */
+  /**
+   * submit_time is the time of proposal submission.
+   * @format date-time
+   */
   submit_time?: string;
 
-  /** @format date-time */
+  /**
+   * deposit_end_time is the end time for deposition.
+   * @format date-time
+   */
   deposit_end_time?: string;
+
+  /** total_deposit is the total deposit on the proposal. */
   total_deposit?: V1Beta1Coin[];
 
-  /** @format date-time */
+  /**
+   * voting_start_time is the starting time to vote on a proposal.
+   * @format date-time
+   */
   voting_start_time?: string;
 
-  /** @format date-time */
+  /**
+   * voting_end_time is the end time of voting on a proposal.
+   * @format date-time
+   */
   voting_end_time?: string;
 
   /** metadata is any arbitrary metadata attached to the proposal. */
   metadata?: string;
+
+  /**
+   * title is the title of the proposal
+   * Since: cosmos-sdk 0.47
+   */
+  title?: string;
+
+  /**
+   * summary is a short summary of the proposal
+   * Since: cosmos-sdk 0.47
+   */
+  summary?: string;
+
+  /**
+   * Proposer is the address of the proposal sumbitter
+   * Since: cosmos-sdk 0.47
+   */
+  proposer?: string;
 }
 
 /**
@@ -267,6 +355,7 @@ export interface V1QueryDepositResponse {
  * QueryDepositsResponse is the response type for the Query/Deposits RPC method.
  */
 export interface V1QueryDepositsResponse {
+  /** deposits defines the requested deposits. */
   deposits?: V1Deposit[];
 
   /** pagination defines the pagination in the response. */
@@ -277,21 +366,37 @@ export interface V1QueryDepositsResponse {
  * QueryParamsResponse is the response type for the Query/Params RPC method.
  */
 export interface V1QueryParamsResponse {
-  /** voting_params defines the parameters related to voting. */
+  /**
+   * Deprecated: Prefer to use `params` instead.
+   * voting_params defines the parameters related to voting.
+   */
   voting_params?: V1VotingParams;
 
-  /** deposit_params defines the parameters related to deposit. */
+  /**
+   * Deprecated: Prefer to use `params` instead.
+   * deposit_params defines the parameters related to deposit.
+   */
   deposit_params?: V1DepositParams;
 
-  /** tally_params defines the parameters related to tally. */
+  /**
+   * Deprecated: Prefer to use `params` instead.
+   * tally_params defines the parameters related to tally.
+   */
   tally_params?: V1TallyParams;
+
+  /**
+   * params defines all the paramaters of x/gov module.
+   *
+   * Since: cosmos-sdk 0.47
+   */
+  params?: V1Params;
 }
 
 /**
  * QueryProposalResponse is the response type for the Query/Proposal RPC method.
  */
 export interface V1QueryProposalResponse {
-  /** Proposal defines the core field members of a governance proposal. */
+  /** proposal is the requested governance proposal. */
   proposal?: V1Proposal;
 }
 
@@ -300,6 +405,7 @@ export interface V1QueryProposalResponse {
 method.
 */
 export interface V1QueryProposalsResponse {
+  /** proposals defines all the requested governance proposals. */
   proposals?: V1Proposal[];
 
   /** pagination defines the pagination in the response. */
@@ -318,7 +424,7 @@ export interface V1QueryTallyResultResponse {
  * QueryVoteResponse is the response type for the Query/Vote RPC method.
  */
 export interface V1QueryVoteResponse {
-  /** vote defined the queried vote. */
+  /** vote defines the queried vote. */
   vote?: V1Vote;
 }
 
@@ -326,7 +432,7 @@ export interface V1QueryVoteResponse {
  * QueryVotesResponse is the response type for the Query/Votes RPC method.
  */
 export interface V1QueryVotesResponse {
-  /** votes defined the queried votes. */
+  /** votes defines the queried votes. */
   votes?: V1Vote[];
 
   /** pagination defines the pagination in the response. */
@@ -339,7 +445,7 @@ export interface V1QueryVotesResponse {
 export interface V1TallyParams {
   /**
    * Minimum percentage of total stake needed to vote for a result to be
-   *  considered valid.
+   * considered valid.
    */
   quorum?: string;
 
@@ -348,7 +454,7 @@ export interface V1TallyParams {
 
   /**
    * Minimum value of Veto votes to Total votes ratio for proposal to be
-   *  vetoed. Default value: 1/3.
+   * vetoed. Default value: 1/3.
    */
   veto_threshold?: string;
 }
@@ -357,9 +463,16 @@ export interface V1TallyParams {
  * TallyResult defines a standard tally for a governance proposal.
  */
 export interface V1TallyResult {
+  /** yes_count is the number of yes votes on a proposal. */
   yes_count?: string;
+
+  /** abstain_count is the number of abstain votes on a proposal. */
   abstain_count?: string;
+
+  /** no_count is the number of no votes on a proposal. */
   no_count?: string;
+
+  /** no_with_veto_count is the number of no with veto votes on a proposal. */
   no_with_veto_count?: string;
 }
 
@@ -368,9 +481,16 @@ export interface V1TallyResult {
 A Vote consists of a proposal ID, the voter, and the vote option.
 */
 export interface V1Vote {
-  /** @format uint64 */
+  /**
+   * proposal_id defines the unique id of the proposal.
+   * @format uint64
+   */
   proposal_id?: string;
+
+  /** voter is the voter address of the proposal. */
   voter?: string;
+
+  /** options is the weighted vote options. */
   options?: V1WeightedVoteOption[];
 
   /** metadata is any  arbitrary metadata to attached to the vote. */
@@ -398,7 +518,7 @@ export enum V1VoteOption {
  * VotingParams defines the params for voting on governance proposals.
  */
 export interface V1VotingParams {
-  /** Length of the voting period. */
+  /** Duration of the voting period. */
   voting_period?: string;
 }
 
@@ -406,16 +526,10 @@ export interface V1VotingParams {
  * WeightedVoteOption defines a unit of vote for vote split.
  */
 export interface V1WeightedVoteOption {
-  /**
-   * VoteOption enumerates the valid vote options for a given governance proposal.
-   *
-   *  - VOTE_OPTION_UNSPECIFIED: VOTE_OPTION_UNSPECIFIED defines a no-op vote option.
-   *  - VOTE_OPTION_YES: VOTE_OPTION_YES defines a yes vote option.
-   *  - VOTE_OPTION_ABSTAIN: VOTE_OPTION_ABSTAIN defines an abstain vote option.
-   *  - VOTE_OPTION_NO: VOTE_OPTION_NO defines a no vote option.
-   *  - VOTE_OPTION_NO_WITH_VETO: VOTE_OPTION_NO_WITH_VETO defines a no with veto vote option.
-   */
+  /** option defines the valid vote options, it must not contain duplicate vote options. */
   option?: V1VoteOption;
+
+  /** weight is the vote weight associated with the vote option. */
   weight?: string;
 }
 

package/cosmos.gov.v1/types/amino/amino.ts

@@ -0,0 +1,2 @@
+/* eslint-disable */
+export const protobufPackage = "amino";

package/cosmos.gov.v1/types/cosmos/gov/v1/genesis.ts

@@ -1,7 +1,7 @@
 /* eslint-disable */
 import Long from "long";
 import _m0 from "protobufjs/minimal";
-import { Deposit, DepositParams, Proposal, TallyParams, Vote, VotingParams } from "./gov";
+import { Deposit, DepositParams, Params, Proposal, TallyParams, Vote, VotingParams } from "./gov";
 
 export const protobufPackage = "cosmos.gov.v1";
 
@@ -17,16 +17,39 @@ export interface GenesisState {
   votes: Vote[];
   /** proposals defines all the proposals present at genesis. */
   proposals: Proposal[];
-  /** params defines all the paramaters of related to deposit. */
+  /**
+   * Deprecated: Prefer to use `params` instead.
+   * deposit_params defines all the paramaters of related to deposit.
+   *
+   * @deprecated
+   */
   depositParams:
     | DepositParams
     | undefined;
-  /** params defines all the paramaters of related to voting. */
+  /**
+   * Deprecated: Prefer to use `params` instead.
+   * voting_params defines all the paramaters of related to voting.
+   *
+   * @deprecated
+   */
   votingParams:
     | VotingParams
     | undefined;
-  /** params defines all the paramaters of related to tally. */
-  tallyParams: TallyParams | undefined;
+  /**
+   * Deprecated: Prefer to use `params` instead.
+   * tally_params defines all the paramaters of related to tally.
+   *
+   * @deprecated
+   */
+  tallyParams:
+    | TallyParams
+    | undefined;
+  /**
+   * params defines all the paramaters of x/gov module.
+   *
+   * Since: cosmos-sdk 0.47
+   */
+  params: Params | undefined;
 }
 
 function createBaseGenesisState(): GenesisState {
@@ -38,6 +61,7 @@ function createBaseGenesisState(): GenesisState {
     depositParams: undefined,
     votingParams: undefined,
     tallyParams: undefined,
+    params: undefined,
   };
 }
 
@@ -64,6 +88,9 @@ export const GenesisState = {
     if (message.tallyParams !== undefined) {
       TallyParams.encode(message.tallyParams, writer.uint32(58).fork()).ldelim();
     }
+    if (message.params !== undefined) {
+      Params.encode(message.params, writer.uint32(66).fork()).ldelim();
+    }
     return writer;
   },
 
@@ -95,6 +122,9 @@ export const GenesisState = {
         case 7:
           message.tallyParams = TallyParams.decode(reader, reader.uint32());
           break;
+        case 8:
+          message.params = Params.decode(reader, reader.uint32());
+          break;
         default:
           reader.skipType(tag & 7);
           break;
@@ -112,6 +142,7 @@ export const GenesisState = {
       depositParams: isSet(object.depositParams) ? DepositParams.fromJSON(object.depositParams) : undefined,
       votingParams: isSet(object.votingParams) ? VotingParams.fromJSON(object.votingParams) : undefined,
       tallyParams: isSet(object.tallyParams) ? TallyParams.fromJSON(object.tallyParams) : undefined,
+      params: isSet(object.params) ? Params.fromJSON(object.params) : undefined,
     };
   },
 
@@ -139,6 +170,7 @@ export const GenesisState = {
       && (obj.votingParams = message.votingParams ? VotingParams.toJSON(message.votingParams) : undefined);
     message.tallyParams !== undefined
       && (obj.tallyParams = message.tallyParams ? TallyParams.toJSON(message.tallyParams) : undefined);
+    message.params !== undefined && (obj.params = message.params ? Params.toJSON(message.params) : undefined);
     return obj;
   },
 
@@ -157,6 +189,9 @@ export const GenesisState = {
     message.tallyParams = (object.tallyParams !== undefined && object.tallyParams !== null)
       ? TallyParams.fromPartial(object.tallyParams)
       : undefined;
+    message.params = (object.params !== undefined && object.params !== null)
+      ? Params.fromPartial(object.params)
+      : undefined;
     return message;
   },
 };