@agoric/cosmic-proto 0.4.1-dev-76b8d53.0 → 0.4.1-dev-b78d824.0

package/dist/codegen/cosmos/group/v1/types.d.ts

@@ -3,7 +3,10 @@ import { Any, AnySDKType } from '../../../google/protobuf/any.js';
 import { BinaryReader, BinaryWriter } from '../../../binary.js';
 /** VoteOption enumerates the valid vote options for a given proposal. */
 export declare enum VoteOption {
-    /** VOTE_OPTION_UNSPECIFIED - VOTE_OPTION_UNSPECIFIED defines a no-op vote option. */
+    /**
+     * VOTE_OPTION_UNSPECIFIED - VOTE_OPTION_UNSPECIFIED defines an unspecified vote option which will
+     * return an error.
+     */
     VOTE_OPTION_UNSPECIFIED = 0,
     /** VOTE_OPTION_YES - VOTE_OPTION_YES defines a yes vote option. */
     VOTE_OPTION_YES = 1,
@@ -22,37 +25,33 @@ export declare function voteOptionToJSON(object: VoteOption): string;
 export declare enum ProposalStatus {
     /** PROPOSAL_STATUS_UNSPECIFIED - An empty value is invalid and not allowed. */
     PROPOSAL_STATUS_UNSPECIFIED = 0,
-    /** PROPOSAL_STATUS_SUBMITTED - Initial status of a proposal when persisted. */
+    /** PROPOSAL_STATUS_SUBMITTED - Initial status of a proposal when submitted. */
     PROPOSAL_STATUS_SUBMITTED = 1,
-    /** PROPOSAL_STATUS_CLOSED - Final status of a proposal when the final tally was executed. */
-    PROPOSAL_STATUS_CLOSED = 2,
-    /** PROPOSAL_STATUS_ABORTED - Final status of a proposal when the group was modified before the final tally. */
-    PROPOSAL_STATUS_ABORTED = 3,
     /**
-     * PROPOSAL_STATUS_WITHDRAWN - A proposal can be deleted before the voting start time by the owner. When this happens the final status
-     * is Withdrawn.
+     * PROPOSAL_STATUS_ACCEPTED - Final status of a proposal when the final tally is done and the outcome
+     * passes the group policy's decision policy.
+     */
+    PROPOSAL_STATUS_ACCEPTED = 2,
+    /**
+     * PROPOSAL_STATUS_REJECTED - Final status of a proposal when the final tally is done and the outcome
+     * is rejected by the group policy's decision policy.
+     */
+    PROPOSAL_STATUS_REJECTED = 3,
+    /**
+     * PROPOSAL_STATUS_ABORTED - Final status of a proposal when the group policy is modified before the
+     * final tally.
+     */
+    PROPOSAL_STATUS_ABORTED = 4,
+    /**
+     * PROPOSAL_STATUS_WITHDRAWN - A proposal can be withdrawn before the voting start time by the owner.
+     * When this happens the final status is Withdrawn.
      */
-    PROPOSAL_STATUS_WITHDRAWN = 4,
+    PROPOSAL_STATUS_WITHDRAWN = 5,
     UNRECOGNIZED = -1
 }
 export declare const ProposalStatusSDKType: typeof ProposalStatus;
 export declare function proposalStatusFromJSON(object: any): ProposalStatus;
 export declare function proposalStatusToJSON(object: ProposalStatus): string;
-/** ProposalResult defines types of proposal results. */
-export declare enum ProposalResult {
-    /** PROPOSAL_RESULT_UNSPECIFIED - An empty value is invalid and not allowed */
-    PROPOSAL_RESULT_UNSPECIFIED = 0,
-    /** PROPOSAL_RESULT_UNFINALIZED - Until a final tally has happened the status is unfinalized */
-    PROPOSAL_RESULT_UNFINALIZED = 1,
-    /** PROPOSAL_RESULT_ACCEPTED - Final result of the tally */
-    PROPOSAL_RESULT_ACCEPTED = 2,
-    /** PROPOSAL_RESULT_REJECTED - Final result of the tally */
-    PROPOSAL_RESULT_REJECTED = 3,
-    UNRECOGNIZED = -1
-}
-export declare const ProposalResultSDKType: typeof ProposalResult;
-export declare function proposalResultFromJSON(object: any): ProposalResult;
-export declare function proposalResultToJSON(object: ProposalResult): string;
 /** ProposalExecutorResult defines types of proposal executor results. */
 export declare enum ProposalExecutorResult {
     /** PROPOSAL_EXECUTOR_RESULT_UNSPECIFIED - An empty value is not allowed. */
@@ -70,14 +69,14 @@ export declare function proposalExecutorResultFromJSON(object: any): ProposalExe
 export declare function proposalExecutorResultToJSON(object: ProposalExecutorResult): string;
 /**
  * Member represents a group member with an account address,
- * non-zero weight and metadata.
+ * non-zero weight, metadata and added_at timestamp.
  */
 export interface Member {
     /** address is the member's account address. */
     address: string;
     /** weight is the member's voting weight that should be greater than 0. */
     weight: string;
-    /** metadata is any arbitrary metadata to attached to the member. */
+    /** metadata is any arbitrary metadata attached to the member. */
     metadata: string;
     /** added_at is a timestamp specifying when a member was added. */
     addedAt: Date;
@@ -88,7 +87,7 @@ export interface MemberProtoMsg {
 }
 /**
  * Member represents a group member with an account address,
- * non-zero weight and metadata.
+ * non-zero weight, metadata and added_at timestamp.
  */
 export interface MemberSDKType {
     address: string;
@@ -96,23 +95,47 @@ export interface MemberSDKType {
     metadata: string;
     added_at: Date;
 }
-/** Members defines a repeated slice of Member objects. */
-export interface Members {
-    /** members is the list of members. */
-    members: Member[];
+/**
+ * MemberRequest represents a group member to be used in Msg server requests.
+ * Contrary to `Member`, it doesn't have any `added_at` field
+ * since this field cannot be set as part of requests.
+ */
+export interface MemberRequest {
+    /** address is the member's account address. */
+    address: string;
+    /** weight is the member's voting weight that should be greater than 0. */
+    weight: string;
+    /** metadata is any arbitrary metadata attached to the member. */
+    metadata: string;
 }
-export interface MembersProtoMsg {
-    typeUrl: '/cosmos.group.v1.Members';
+export interface MemberRequestProtoMsg {
+    typeUrl: '/cosmos.group.v1.MemberRequest';
     value: Uint8Array;
 }
-/** Members defines a repeated slice of Member objects. */
-export interface MembersSDKType {
-    members: MemberSDKType[];
+/**
+ * MemberRequest represents a group member to be used in Msg server requests.
+ * Contrary to `Member`, it doesn't have any `added_at` field
+ * since this field cannot be set as part of requests.
+ */
+export interface MemberRequestSDKType {
+    address: string;
+    weight: string;
+    metadata: string;
 }
-/** ThresholdDecisionPolicy implements the DecisionPolicy interface */
+/**
+ * ThresholdDecisionPolicy is a decision policy where a proposal passes when it
+ * satisfies the two following conditions:
+ * 1. The sum of all `YES` voters' weights is greater or equal than the defined
+ *    `threshold`.
+ * 2. The voting and execution periods of the proposal respect the parameters
+ *    given by `windows`.
+ */
 export interface ThresholdDecisionPolicy {
     $typeUrl?: '/cosmos.group.v1.ThresholdDecisionPolicy';
-    /** threshold is the minimum weighted sum of yes votes that must be met or exceeded for a proposal to succeed. */
+    /**
+     * threshold is the minimum weighted sum of `YES` votes that must be met or
+     * exceeded for a proposal to succeed.
+     */
     threshold: string;
     /** windows defines the different windows for voting and execution. */
     windows?: DecisionPolicyWindows;
@@ -121,16 +144,33 @@ export interface ThresholdDecisionPolicyProtoMsg {
     typeUrl: '/cosmos.group.v1.ThresholdDecisionPolicy';
     value: Uint8Array;
 }
-/** ThresholdDecisionPolicy implements the DecisionPolicy interface */
+/**
+ * ThresholdDecisionPolicy is a decision policy where a proposal passes when it
+ * satisfies the two following conditions:
+ * 1. The sum of all `YES` voters' weights is greater or equal than the defined
+ *    `threshold`.
+ * 2. The voting and execution periods of the proposal respect the parameters
+ *    given by `windows`.
+ */
 export interface ThresholdDecisionPolicySDKType {
     $typeUrl?: '/cosmos.group.v1.ThresholdDecisionPolicy';
     threshold: string;
     windows?: DecisionPolicyWindowsSDKType;
 }
-/** PercentageDecisionPolicy implements the DecisionPolicy interface */
+/**
+ * PercentageDecisionPolicy is a decision policy where a proposal passes when
+ * it satisfies the two following conditions:
+ * 1. The percentage of all `YES` voters' weights out of the total group weight
+ *    is greater or equal than the given `percentage`.
+ * 2. The voting and execution periods of the proposal respect the parameters
+ *    given by `windows`.
+ */
 export interface PercentageDecisionPolicy {
     $typeUrl?: '/cosmos.group.v1.PercentageDecisionPolicy';
-    /** percentage is the minimum percentage the weighted sum of yes votes must meet for a proposal to succeed. */
+    /**
+     * percentage is the minimum percentage the weighted sum of `YES` votes must
+     * meet for a proposal to succeed.
+     */
     percentage: string;
     /** windows defines the different windows for voting and execution. */
     windows?: DecisionPolicyWindows;
@@ -139,7 +179,14 @@ export interface PercentageDecisionPolicyProtoMsg {
     typeUrl: '/cosmos.group.v1.PercentageDecisionPolicy';
     value: Uint8Array;
 }
-/** PercentageDecisionPolicy implements the DecisionPolicy interface */
+/**
+ * PercentageDecisionPolicy is a decision policy where a proposal passes when
+ * it satisfies the two following conditions:
+ * 1. The percentage of all `YES` voters' weights out of the total group weight
+ *    is greater or equal than the given `percentage`.
+ * 2. The voting and execution periods of the proposal respect the parameters
+ *    given by `windows`.
+ */
 export interface PercentageDecisionPolicySDKType {
     $typeUrl?: '/cosmos.group.v1.PercentageDecisionPolicy';
     percentage: string;
@@ -241,7 +288,7 @@ export interface GroupPolicyInfo {
      */
     version: bigint;
     /** decision_policy specifies the group policy's decision policy. */
-    decisionPolicy?: (ThresholdDecisionPolicy & PercentageDecisionPolicy & Any) | undefined;
+    decisionPolicy?: Any | undefined;
     /** created_at is a timestamp specifying when a group policy was created. */
     createdAt: Date;
 }
@@ -256,7 +303,7 @@ export interface GroupPolicyInfoSDKType {
     admin: string;
     metadata: string;
     version: bigint;
-    decision_policy?: ThresholdDecisionPolicySDKType | PercentageDecisionPolicySDKType | AnySDKType | undefined;
+    decision_policy?: AnySDKType | undefined;
     created_at: Date;
 }
 /**
@@ -268,8 +315,8 @@ export interface GroupPolicyInfoSDKType {
 export interface Proposal {
     /** id is the unique id of the proposal. */
     id: bigint;
-    /** address is the account address of group policy. */
-    address: string;
+    /** group_policy_address is the account address of group policy. */
+    groupPolicyAddress: string;
     /** metadata is any arbitrary metadata to attached to the proposal. */
     metadata: string;
     /** proposers are the account addresses of the proposers. */
@@ -277,40 +324,37 @@ export interface Proposal {
     /** submit_time is a timestamp specifying when a proposal was submitted. */
     submitTime: Date;
     /**
-     * group_version tracks the version of the group that this proposal corresponds to.
-     * When group membership is changed, existing proposals from previous group versions will become invalid.
+     * group_version tracks the version of the group at proposal submission.
+     * This field is here for informational purposes only.
      */
     groupVersion: bigint;
     /**
-     * group_policy_version tracks the version of the group policy that this proposal corresponds to.
-     * When a decision policy is changed, existing proposals from previous policy versions will become invalid.
+     * group_policy_version tracks the version of the group policy at proposal submission.
+     * When a decision policy is changed, existing proposals from previous policy
+     * versions will become invalid with the `ABORTED` status.
+     * This field is here for informational purposes only.
      */
     groupPolicyVersion: bigint;
     /** status represents the high level position in the life cycle of the proposal. Initial value is Submitted. */
     status: ProposalStatus;
-    /**
-     * result is the final result based on the votes and election rule. Initial value is unfinalized.
-     * The result is persisted so that clients can always rely on this state and not have to replicate the logic.
-     */
-    result: ProposalResult;
     /**
      * final_tally_result contains the sums of all weighted votes for this
-     * proposal for each vote option, after tallying. When querying a proposal
-     * via gRPC, this field is not populated until the proposal's voting period
-     * has ended.
+     * proposal for each vote option. It is empty at submission, and only
+     * populated after tallying, at voting period end or at proposal execution,
+     * whichever happens first.
      */
     finalTallyResult: TallyResult;
     /**
      * voting_period_end is the timestamp before which voting must be done.
      * Unless a successfull MsgExec is called before (to execute a proposal whose
      * tally is successful before the voting period ends), tallying will be done
-     * at this point, and the `final_tally_result`, as well
-     * as `status` and `result` fields will be accordingly updated.
+     * at this point, and the `final_tally_result`and `status` fields will be
+     * accordingly updated.
      */
     votingPeriodEnd: Date;
-    /** executor_result is the final result based on the votes and election rule. Initial value is NotRun. */
+    /** executor_result is the final result of the proposal execution. Initial value is NotRun. */
     executorResult: ProposalExecutorResult;
-    /** messages is a list of Msgs that will be executed if the proposal passes. */
+    /** messages is a list of `sdk.Msg`s that will be executed if the proposal passes. */
     messages: Any[];
 }
 export interface ProposalProtoMsg {
@@ -325,14 +369,13 @@ export interface ProposalProtoMsg {
  */
 export interface ProposalSDKType {
     id: bigint;
-    address: string;
+    group_policy_address: string;
     metadata: string;
     proposers: string[];
     submit_time: Date;
     group_version: bigint;
     group_policy_version: bigint;
     status: ProposalStatus;
-    result: ProposalResult;
     final_tally_result: TallyResultSDKType;
     voting_period_end: Date;
     executor_result: ProposalExecutorResult;
@@ -344,7 +387,7 @@ export interface TallyResult {
     yesCount: string;
     /** abstain_count is the weighted sum of abstainers. */
     abstainCount: string;
-    /** no is the weighted sum of no votes. */
+    /** no_count is the weighted sum of no votes. */
     noCount: string;
     /** no_with_veto_count is the weighted sum of veto. */
     noWithVetoCount: string;
@@ -396,16 +439,16 @@ export declare const Member: {
     toProto(message: Member): Uint8Array;
     toProtoMsg(message: Member): MemberProtoMsg;
 };
-export declare const Members: {
+export declare const MemberRequest: {
     typeUrl: string;
-    encode(message: Members, writer?: BinaryWriter): BinaryWriter;
-    decode(input: BinaryReader | Uint8Array, length?: number): Members;
-    fromJSON(object: any): Members;
-    toJSON(message: Members): unknown;
-    fromPartial(object: Partial<Members>): Members;
-    fromProtoMsg(message: MembersProtoMsg): Members;
-    toProto(message: Members): Uint8Array;
-    toProtoMsg(message: Members): MembersProtoMsg;
+    encode(message: MemberRequest, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): MemberRequest;
+    fromJSON(object: any): MemberRequest;
+    toJSON(message: MemberRequest): unknown;
+    fromPartial(object: Partial<MemberRequest>): MemberRequest;
+    fromProtoMsg(message: MemberRequestProtoMsg): MemberRequest;
+    toProto(message: MemberRequest): Uint8Array;
+    toProtoMsg(message: MemberRequest): MemberRequestProtoMsg;
 };
 export declare const ThresholdDecisionPolicy: {
     typeUrl: string;
@@ -506,4 +549,4 @@ export declare const Vote: {
     toProto(message: Vote): Uint8Array;
     toProtoMsg(message: Vote): VoteProtoMsg;
 };
-export declare const Cosmos_groupDecisionPolicy_InterfaceDecoder: (input: BinaryReader | Uint8Array) => ThresholdDecisionPolicy | PercentageDecisionPolicy | Any;
+export declare const Cosmos_groupv1DecisionPolicy_InterfaceDecoder: (input: BinaryReader | Uint8Array) => Any;