injectivejs 1.11.13 → 1.11.15

package/cosmos/group/v1/types.js

@@ -204,6 +204,13 @@ function createBaseMember() {
         addedAt: new Date()
     };
 }
+/**
+ * Member represents a group member with an account address,
+ * non-zero weight, metadata and added_at timestamp.
+ * @name Member
+ * @package cosmos.group.v1
+ * @see proto type: cosmos.group.v1.Member
+ */
 exports.Member = {
     typeUrl: "/cosmos.group.v1.Member",
     aminoType: "cosmos-sdk/Member",
@@ -316,6 +323,14 @@ function createBaseMemberRequest() {
         metadata: ""
     };
 }
+/**
+ * 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.
+ * @name MemberRequest
+ * @package cosmos.group.v1
+ * @see proto type: cosmos.group.v1.MemberRequest
+ */
 exports.MemberRequest = {
     typeUrl: "/cosmos.group.v1.MemberRequest",
     aminoType: "cosmos-sdk/MemberRequest",
@@ -416,6 +431,17 @@ function createBaseThresholdDecisionPolicy() {
         windows: undefined
     };
 }
+/**
+ * ThresholdDecisionPolicy is a decision policy where a proposal passes when it
+ * satisfies the two following conditions:
+ * 1. The sum of all `YES` voter's weights is greater or equal than the defined
+ *    `threshold`.
+ * 2. The voting and execution periods of the proposal respect the parameters
+ *    given by `windows`.
+ * @name ThresholdDecisionPolicy
+ * @package cosmos.group.v1
+ * @see proto type: cosmos.group.v1.ThresholdDecisionPolicy
+ */
 exports.ThresholdDecisionPolicy = {
     typeUrl: "/cosmos.group.v1.ThresholdDecisionPolicy",
     aminoType: "cosmos-sdk/ThresholdDecisionPolicy",
@@ -512,6 +538,17 @@ function createBasePercentageDecisionPolicy() {
         windows: undefined
     };
 }
+/**
+ * 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`.
+ * @name PercentageDecisionPolicy
+ * @package cosmos.group.v1
+ * @see proto type: cosmos.group.v1.PercentageDecisionPolicy
+ */
 exports.PercentageDecisionPolicy = {
     typeUrl: "/cosmos.group.v1.PercentageDecisionPolicy",
     aminoType: "cosmos-sdk/PercentageDecisionPolicy",
@@ -608,6 +645,12 @@ function createBaseDecisionPolicyWindows() {
         minExecutionPeriod: duration_1.Duration.fromPartial({})
     };
 }
+/**
+ * DecisionPolicyWindows defines the different windows for voting and execution.
+ * @name DecisionPolicyWindows
+ * @package cosmos.group.v1
+ * @see proto type: cosmos.group.v1.DecisionPolicyWindows
+ */
 exports.DecisionPolicyWindows = {
     typeUrl: "/cosmos.group.v1.DecisionPolicyWindows",
     aminoType: "cosmos-sdk/DecisionPolicyWindows",
@@ -701,6 +744,12 @@ function createBaseGroupInfo() {
         createdAt: new Date()
     };
 }
+/**
+ * GroupInfo represents the high-level on-chain information for a group.
+ * @name GroupInfo
+ * @package cosmos.group.v1
+ * @see proto type: cosmos.group.v1.GroupInfo
+ */
 exports.GroupInfo = {
     typeUrl: "/cosmos.group.v1.GroupInfo",
     aminoType: "cosmos-sdk/GroupInfo",
@@ -834,6 +883,12 @@ function createBaseGroupMember() {
         member: undefined
     };
 }
+/**
+ * GroupMember represents the relationship between a group and a member.
+ * @name GroupMember
+ * @package cosmos.group.v1
+ * @see proto type: cosmos.group.v1.GroupMember
+ */
 exports.GroupMember = {
     typeUrl: "/cosmos.group.v1.GroupMember",
     aminoType: "cosmos-sdk/GroupMember",
@@ -933,6 +988,12 @@ function createBaseGroupPolicyInfo() {
         createdAt: new Date()
     };
 }
+/**
+ * GroupPolicyInfo represents the high-level on-chain information for a group policy.
+ * @name GroupPolicyInfo
+ * @package cosmos.group.v1
+ * @see proto type: cosmos.group.v1.GroupPolicyInfo
+ */
 exports.GroupPolicyInfo = {
     typeUrl: "/cosmos.group.v1.GroupPolicyInfo",
     aminoType: "cosmos-sdk/GroupPolicyInfo",
@@ -1095,6 +1156,15 @@ function createBaseProposal() {
         summary: ""
     };
 }
+/**
+ * Proposal defines a group proposal. Any member of a group can submit a proposal
+ * for a group policy to decide upon.
+ * A proposal consists of a set of `sdk.Msg`s that will be executed if the proposal
+ * passes as well as some optional metadata associated with the proposal.
+ * @name Proposal
+ * @package cosmos.group.v1
+ * @see proto type: cosmos.group.v1.Proposal
+ */
 exports.Proposal = {
     typeUrl: "/cosmos.group.v1.Proposal",
     aminoType: "cosmos-sdk/Proposal",
@@ -1324,6 +1394,12 @@ function createBaseTallyResult() {
         noWithVetoCount: ""
     };
 }
+/**
+ * TallyResult represents the sum of weighted votes for each vote option.
+ * @name TallyResult
+ * @package cosmos.group.v1
+ * @see proto type: cosmos.group.v1.TallyResult
+ */
 exports.TallyResult = {
     typeUrl: "/cosmos.group.v1.TallyResult",
     aminoType: "cosmos-sdk/TallyResult",
@@ -1438,6 +1514,12 @@ function createBaseVote() {
         submitTime: new Date()
     };
 }
+/**
+ * Vote represents a vote for a proposal.string metadata
+ * @name Vote
+ * @package cosmos.group.v1
+ * @see proto type: cosmos.group.v1.Vote
+ */
 exports.Vote = {
     typeUrl: "/cosmos.group.v1.Vote",
     aminoType: "cosmos-sdk/Vote",