@iconlake/client 0.0.2 → 0.1.0

package/cosmos.gov.v1beta1/rest.ts

@@ -146,9 +146,16 @@ export interface V1Beta1Coin {
 proposal.
 */
 export interface V1Beta1Deposit {
-  /** @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[];
 }
 
@@ -161,7 +168,7 @@ export interface V1Beta1DepositParams {
 
   /**
    * Maximum period for Atom holders to deposit on a proposal. Initial value: 2
-   *  months.
+   * months.
    */
   max_deposit_period?: string;
 }
@@ -175,7 +182,10 @@ export type V1Beta1MsgDepositResponse = object;
  * MsgSubmitProposalResponse defines the Msg/SubmitProposal response type.
  */
 export interface V1Beta1MsgSubmitProposalResponse {
-  /** @format uint64 */
+  /**
+   * proposal_id defines the unique id of the proposal.
+   * @format uint64
+   */
   proposal_id?: string;
 }
 
@@ -267,83 +277,16 @@ export interface V1Beta1PageResponse {
  * Proposal defines the core field members of a governance proposal.
  */
 export interface V1Beta1Proposal {
-  /** @format uint64 */
-  proposal_id?: string;
-
   /**
-   * `Any` contains an arbitrary serialized protocol buffer message along with a
-   * URL that describes the type of the serialized message.
-   *
-   * Protobuf library provides support to pack/unpack Any values in the form
-   * of utility functions or additional generated methods of the Any type.
-   * Example 1: Pack and unpack a message in C++.
-   *     Foo foo = ...;
-   *     Any any;
-   *     any.PackFrom(foo);
-   *     ...
-   *     if (any.UnpackTo(&foo)) {
-   *       ...
-   *     }
-   * Example 2: Pack and unpack a message in Java.
-   *     Any any = Any.pack(foo);
-   *     if (any.is(Foo.class)) {
-   *       foo = any.unpack(Foo.class);
-   *  Example 3: Pack and unpack a message in Python.
-   *     foo = Foo(...)
-   *     any = Any()
-   *     any.Pack(foo)
-   *     if any.Is(Foo.DESCRIPTOR):
-   *       any.Unpack(foo)
-   *  Example 4: Pack and unpack a message in Go
-   *      foo := &pb.Foo{...}
-   *      any, err := anypb.New(foo)
-   *      if err != nil {
-   *        ...
-   *      }
-   *      ...
-   *      foo := &pb.Foo{}
-   *      if err := any.UnmarshalTo(foo); err != nil {
-   * The pack methods provided by protobuf library will by default use
-   * 'type.googleapis.com/full.type.name' as the type URL and the unpack
-   * methods only use the fully qualified type name after the last '/'
-   * in the type URL, for example "foo.bar.com/x/y.z" will yield type
-   * name "y.z".
-   * JSON
-   * ====
-   * The JSON representation of an `Any` value uses the regular
-   * representation of the deserialized, embedded message, with an
-   * additional field `@type` which contains the type URL. Example:
-   *     package google.profile;
-   *     message Person {
-   *       string first_name = 1;
-   *       string last_name = 2;
-   *     {
-   *       "@type": "type.googleapis.com/google.profile.Person",
-   *       "firstName": <string>,
-   *       "lastName": <string>
-   * If the embedded message type is well-known and has a custom JSON
-   * representation, that representation will be embedded adding a field
-   * `value` which holds the custom JSON in addition to the `@type`
-   * field. Example (for message [google.protobuf.Duration][]):
-   *       "@type": "type.googleapis.com/google.protobuf.Duration",
-   *       "value": "1.212s"
+   * proposal_id defines the unique id of the proposal.
+   * @format uint64
    */
+  proposal_id?: string;
+
+  /** content is the proposal's content. */
   content?: 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?: V1Beta1ProposalStatus;
 
   /**
@@ -353,17 +296,31 @@ export interface V1Beta1Proposal {
    */
   final_tally_result?: V1Beta1TallyResult;
 
-  /** @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;
 }
 
@@ -403,6 +360,7 @@ export interface V1Beta1QueryDepositResponse {
  * QueryDepositsResponse is the response type for the Query/Deposits RPC method.
  */
 export interface V1Beta1QueryDepositsResponse {
+  /** deposits defines the requested deposits. */
   deposits?: V1Beta1Deposit[];
 
   /** pagination defines the pagination in the response. */
@@ -436,6 +394,7 @@ export interface V1Beta1QueryProposalResponse {
 method.
 */
 export interface V1Beta1QueryProposalsResponse {
+  /** proposals defines all the requested governance proposals. */
   proposals?: V1Beta1Proposal[];
 
   /** pagination defines the pagination in the response. */
@@ -454,7 +413,7 @@ export interface V1Beta1QueryTallyResultResponse {
  * QueryVoteResponse is the response type for the Query/Vote RPC method.
  */
 export interface V1Beta1QueryVoteResponse {
-  /** vote defined the queried vote. */
+  /** vote defines the queried vote. */
   vote?: V1Beta1Vote;
 }
 
@@ -462,7 +421,7 @@ export interface V1Beta1QueryVoteResponse {
  * QueryVotesResponse is the response type for the Query/Votes RPC method.
  */
 export interface V1Beta1QueryVotesResponse {
-  /** votes defined the queried votes. */
+  /** votes defines the queried votes. */
   votes?: V1Beta1Vote[];
 
   /** pagination defines the pagination in the response. */
@@ -475,7 +434,7 @@ export interface V1Beta1QueryVotesResponse {
 export interface V1Beta1TallyParams {
   /**
    * Minimum percentage of total stake needed to vote for a result to be
-   *  considered valid.
+   * considered valid.
    * @format byte
    */
   quorum?: string;
@@ -488,7 +447,7 @@ export interface V1Beta1TallyParams {
 
   /**
    * Minimum value of Veto votes to Total votes ratio for proposal to be
-   *  vetoed. Default value: 1/3.
+   * vetoed. Default value: 1/3.
    * @format byte
    */
   veto_threshold?: string;
@@ -498,9 +457,16 @@ export interface V1Beta1TallyParams {
  * TallyResult defines a standard tally for a governance proposal.
  */
 export interface V1Beta1TallyResult {
+  /** yes is the number of yes votes on a proposal. */
   yes?: string;
+
+  /** abstain is the number of abstain votes on a proposal. */
   abstain?: string;
+
+  /** 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?: string;
 }
 
@@ -509,8 +475,13 @@ export interface V1Beta1TallyResult {
 A Vote consists of a proposal ID, the voter, and the vote option.
 */
 export interface V1Beta1Vote {
-  /** @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;
 
   /**
@@ -520,7 +491,11 @@ export interface V1Beta1Vote {
    */
   option?: V1Beta1VoteOption;
 
-  /** Since: cosmos-sdk 0.43 */
+  /**
+   * options is the weighted vote options.
+   *
+   * Since: cosmos-sdk 0.43
+   */
   options?: V1Beta1WeightedVoteOption[];
 }
 
@@ -545,7 +520,7 @@ export enum V1Beta1VoteOption {
  * VotingParams defines the params for voting on governance proposals.
  */
 export interface V1Beta1VotingParams {
-  /** Length of the voting period. */
+  /** Duration of the voting period. */
   voting_period?: string;
 }
 
@@ -555,16 +530,10 @@ export interface V1Beta1VotingParams {
 Since: cosmos-sdk 0.43
 */
 export interface V1Beta1WeightedVoteOption {
-  /**
-   * 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?: V1Beta1VoteOption;
+
+  /** weight is the vote weight associated with the vote option. */
   weight?: string;
 }
 

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

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

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

@@ -15,15 +15,15 @@ export interface GenesisState {
   votes: Vote[];
   /** proposals defines all the proposals present at genesis. */
   proposals: Proposal[];
-  /** params defines all the paramaters of related to deposit. */
+  /** params defines all the parameters of related to deposit. */
   depositParams:
     | DepositParams
     | undefined;
-  /** params defines all the paramaters of related to voting. */
+  /** params defines all the parameters of related to voting. */
   votingParams:
     | VotingParams
     | undefined;
-  /** params defines all the paramaters of related to tally. */
+  /** params defines all the parameters of related to tally. */
   tallyParams: TallyParams | undefined;
 }
 

package/cosmos.gov.v1beta1/types/cosmos/gov/v1beta1/gov.ts

@@ -150,7 +150,9 @@ export function proposalStatusToJSON(object: ProposalStatus): string {
  * Since: cosmos-sdk 0.43
  */
 export interface WeightedVoteOption {
+  /** 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: string;
 }
 
@@ -159,7 +161,9 @@ export interface WeightedVoteOption {
  * manually updated in case of approval.
  */
 export interface TextProposal {
+  /** title of the proposal. */
   title: string;
+  /** description associated with the proposal. */
   description: string;
 }
 
@@ -168,34 +172,59 @@ export interface TextProposal {
  * proposal.
  */
 export interface Deposit {
+  /** proposal_id defines the unique id of the proposal. */
   proposalId: number;
+  /** depositor defines the deposit addresses from the proposals. */
   depositor: string;
+  /** amount to be deposited by depositor. */
   amount: Coin[];
 }
 
 /** Proposal defines the core field members of a governance proposal. */
 export interface Proposal {
+  /** proposal_id defines the unique id of the proposal. */
   proposalId: number;
-  content: Any | undefined;
+  /** content is the proposal's content. */
+  content:
+    | Any
+    | undefined;
+  /** status defines the proposal status. */
   status: ProposalStatus;
   /**
    * final_tally_result is the final tally result of the proposal. When
    * querying a proposal via gRPC, this field is not populated until the
    * proposal's voting period has ended.
    */
-  finalTallyResult: TallyResult | undefined;
-  submitTime: Date | undefined;
-  depositEndTime: Date | undefined;
+  finalTallyResult:
+    | TallyResult
+    | undefined;
+  /** submit_time is the time of proposal submission. */
+  submitTime:
+    | Date
+    | undefined;
+  /** deposit_end_time is the end time for deposition. */
+  depositEndTime:
+    | Date
+    | undefined;
+  /** total_deposit is the total deposit on the proposal. */
   totalDeposit: Coin[];
-  votingStartTime: Date | undefined;
+  /** voting_start_time is the starting time to vote on a proposal. */
+  votingStartTime:
+    | Date
+    | undefined;
+  /** voting_end_time is the end time of voting on a proposal. */
   votingEndTime: Date | undefined;
 }
 
 /** TallyResult defines a standard tally for a governance proposal. */
 export interface TallyResult {
+  /** yes is the number of yes votes on a proposal. */
   yes: string;
+  /** abstain is the number of abstain votes on a proposal. */
   abstain: string;
+  /** 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. */
   noWithVeto: string;
 }
 
@@ -204,7 +233,9 @@ export interface TallyResult {
  * A Vote consists of a proposal ID, the voter, and the vote option.
  */
 export interface Vote {
+  /** proposal_id defines the unique id of the proposal. */
   proposalId: number;
+  /** voter is the voter address of the proposal. */
   voter: string;
   /**
    * Deprecated: Prefer to use `options` instead. This field is set in queries
@@ -214,7 +245,11 @@ export interface Vote {
    * @deprecated
    */
   option: VoteOption;
-  /** Since: cosmos-sdk 0.43 */
+  /**
+   * options is the weighted vote options.
+   *
+   * Since: cosmos-sdk 0.43
+   */
   options: WeightedVoteOption[];
 }
 
@@ -224,14 +259,14 @@ export interface DepositParams {
   minDeposit: Coin[];
   /**
    * Maximum period for Atom holders to deposit on a proposal. Initial value: 2
-   *  months.
+   * months.
    */
   maxDepositPeriod: Duration | undefined;
 }
 
 /** VotingParams defines the params for voting on governance proposals. */
 export interface VotingParams {
-  /** Length of the voting period. */
+  /** Duration of the voting period. */
   votingPeriod: Duration | undefined;
 }
 
@@ -239,14 +274,14 @@ export interface VotingParams {
 export interface TallyParams {
   /**
    * Minimum percentage of total stake needed to vote for a result to be
-   *  considered valid.
+   * considered valid.
    */
   quorum: Uint8Array;
   /** 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
-   *  vetoed. Default value: 1/3.
+   * vetoed. Default value: 1/3.
    */
   vetoThreshold: Uint8Array;
 }

package/cosmos.gov.v1beta1/types/cosmos/gov/v1beta1/query.ts

@@ -45,6 +45,7 @@ export interface QueryProposalsRequest {
  * method.
  */
 export interface QueryProposalsResponse {
+  /** proposals defines all the requested governance proposals. */
   proposals: Proposal[];
   /** pagination defines the pagination in the response. */
   pagination: PageResponse | undefined;
@@ -60,7 +61,7 @@ export interface QueryVoteRequest {
 
 /** QueryVoteResponse is the response type for the Query/Vote RPC method. */
 export interface QueryVoteResponse {
-  /** vote defined the queried vote. */
+  /** vote defines the queried vote. */
   vote: Vote | undefined;
 }
 
@@ -74,7 +75,7 @@ export interface QueryVotesRequest {
 
 /** QueryVotesResponse is the response type for the Query/Votes RPC method. */
 export interface QueryVotesResponse {
-  /** votes defined the queried votes. */
+  /** votes defines the queried votes. */
   votes: Vote[];
   /** pagination defines the pagination in the response. */
   pagination: PageResponse | undefined;
@@ -127,6 +128,7 @@ export interface QueryDepositsRequest {
 
 /** QueryDepositsResponse is the response type for the Query/Deposits RPC method. */
 export interface QueryDepositsResponse {
+  /** deposits defines the requested deposits. */
   deposits: Deposit[];
   /** pagination defines the pagination in the response. */
   pagination: PageResponse | undefined;

package/cosmos.gov.v1beta1/types/cosmos/gov/v1beta1/tx.ts

@@ -12,20 +12,29 @@ export const protobufPackage = "cosmos.gov.v1beta1";
  * proposal Content.
  */
 export interface MsgSubmitProposal {
-  content: Any | undefined;
+  /** content is the proposal's content. */
+  content:
+    | Any
+    | undefined;
+  /** initial_deposit is the deposit value that must be paid at proposal submission. */
   initialDeposit: Coin[];
+  /** proposer is the account address of the proposer. */
   proposer: string;
 }
 
 /** MsgSubmitProposalResponse defines the Msg/SubmitProposal response type. */
 export interface MsgSubmitProposalResponse {
+  /** proposal_id defines the unique id of the proposal. */
   proposalId: number;
 }
 
 /** MsgVote defines a message to cast a vote. */
 export interface MsgVote {
+  /** proposal_id defines the unique id of the proposal. */
   proposalId: number;
+  /** voter is the voter address for the proposal. */
   voter: string;
+  /** option defines the vote option. */
   option: VoteOption;
 }
 
@@ -39,8 +48,11 @@ export interface MsgVoteResponse {
  * Since: cosmos-sdk 0.43
  */
 export interface MsgVoteWeighted {
+  /** proposal_id defines the unique id of the proposal. */
   proposalId: number;
+  /** voter is the voter address for the proposal. */
   voter: string;
+  /** options defines the weighted vote options. */
   options: WeightedVoteOption[];
 }
 
@@ -54,8 +66,11 @@ export interface MsgVoteWeightedResponse {
 
 /** MsgDeposit defines a message to submit a deposit to an existing proposal. */
 export interface MsgDeposit {
+  /** proposal_id defines the unique id of the proposal. */
   proposalId: number;
+  /** depositor defines the deposit addresses from the proposals. */
   depositor: string;
+  /** amount to be deposited by depositor. */
   amount: Coin[];
 }