Params class
Params defines the parameters for the x/gov module.
Since: cosmos-sdk 0.47
- Inheritance
-
- Object
- GeneratedMessage
- Params
Constructors
-
Params.new({Iterable<
Coin> ? minDeposit, Duration? maxDepositPeriod, Duration? votingPeriod, String? quorum, String? threshold, String? vetoThreshold, String? minInitialDepositRatio, String? proposalCancelRatio, String? proposalCancelDest, Duration? expeditedVotingPeriod, String? expeditedThreshold, Iterable<Coin> ? expeditedMinDeposit, bool? burnVoteQuorum, bool? burnProposalDepositPrevote, bool? burnVoteVeto, String? minDepositRatio}) -
factory
-
Params.fromBuffer(List<
int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]) -
factory
- Params.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- burnProposalDepositPrevote ↔ bool
-
burn deposits if the proposal does not enter voting period
getter/setter pair
- burnVoteQuorum ↔ bool
-
burn deposits if a proposal does not meet quorum
getter/setter pair
- burnVoteVeto ↔ bool
-
burn deposits if quorum with vote type no_veto is met
getter/setter pair
- eventPlugin → EventPlugin?
-
Subclasses can override this getter to be notified of changes
to protobuf fields.
no setterinherited
-
expeditedMinDeposit
→ List<
Coin> -
Minimum expedited deposit for a proposal to enter voting period.
no setter
- expeditedThreshold ↔ String
-
Minimum proportion of Yes votes for proposal to pass. Default value: 0.67.
getter/setter pair
- expeditedVotingPeriod ↔ Duration
-
Duration of the voting period of an expedited proposal.
getter/setter pair
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- info_ → BuilderInfo
-
no setteroverride
- isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited - maxDepositPeriod ↔ Duration
-
Maximum period for Atom holders to deposit on a proposal. Initial value: 2
months.
getter/setter pair
-
minDeposit
→ List<
Coin> -
Minimum deposit for a proposal to enter voting period.
no setter
- minDepositRatio ↔ String
-
The ratio representing the proportion of the deposit value minimum that must be met when making a deposit.
Default value: 0.01. Meaning that for a chain with a min_deposit of 100stake, a deposit of 1stake would be
required.
getter/setter pair
- minInitialDepositRatio ↔ String
-
The ratio representing the proportion of the deposit value that must be paid at proposal submission.
getter/setter pair
- proposalCancelDest ↔ String
-
The address which will receive (proposal_cancel_ratio * deposit) proposal deposits.
If empty, the (proposal_cancel_ratio * deposit) proposal deposits will be burned.
getter/setter pair
- proposalCancelRatio ↔ String
-
The cancel ratio which will not be returned back to the depositors when a proposal is cancelled.
getter/setter pair
- quorum ↔ String
-
Minimum percentage of total stake needed to vote for a result to be
considered valid.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- threshold ↔ String
-
Minimum proportion of Yes votes for proposal to pass. Default value: 0.5.
getter/setter pair
- unknownFields → UnknownFieldSet
-
no setterinherited
- vetoThreshold ↔ String
-
Minimum value of Veto votes to Total votes ratio for proposal to be
vetoed. Default value: 1/3.
getter/setter pair
- votingPeriod ↔ Duration
-
Duration of the voting period.
getter/setter pair
Methods
-
addExtension(
Extension extension, Object? value) → void -
Adds an extension field value to a repeated field.
inherited
-
check(
) → void -
inherited
-
clear(
) → void -
Clears all data that was set in this message.
inherited
-
clearBurnProposalDepositPrevote(
) → void -
clearBurnVoteQuorum(
) → void -
clearBurnVoteVeto(
) → void -
clearExpeditedThreshold(
) → void -
clearExpeditedVotingPeriod(
) → void -
clearExtension(
Extension extension) → void -
Clears an extension field and also removes the extension.
inherited
-
clearField(
int tagNumber) → void -
Clears the contents of a given field.
inherited
-
clearMaxDepositPeriod(
) → void -
clearMinDepositRatio(
) → void -
clearMinInitialDepositRatio(
) → void -
clearProposalCancelDest(
) → void -
clearProposalCancelRatio(
) → void -
clearQuorum(
) → void -
clearThreshold(
) → void -
clearVetoThreshold(
) → void -
clearVotingPeriod(
) → void -
clone(
) → Params -
Creates a deep copy of the fields in this message.
(The generated code uses mergeFromMessage.)
override
-
copyWith(
void updates(Params)) → Params -
Apply
updatesto a copy of this message.override -
createEmptyInstance(
) → Params -
Creates an empty instance of the same message type as this.
override
-
createMapField<
K, V> (int tagNumber, MapFieldInfo< K, V> fi) → Map<K, V> -
Creates a Map representing a map field.
inherited
-
createRepeatedField<
T> (int tagNumber, FieldInfo< T> fi) → List<T> -
Creates List implementing a mutable repeated field.
inherited
-
ensureExpeditedVotingPeriod(
) → Duration -
ensureMaxDepositPeriod(
) → Duration -
ensureVotingPeriod(
) → Duration -
extensionsAreInitialized(
) → bool -
inherited
-
freeze(
) → GeneratedMessage -
Make this message read-only.
inherited
-
getDefaultForField(
int tagNumber) → dynamic -
Returns the default value for the given field.
inherited
-
getExtension(
Extension extension) → dynamic -
Returns the value of
extension.inherited -
getField(
int tagNumber) → dynamic -
Returns the value of the field associated with
tagNumber, or the default value if it is not set.inherited -
getFieldOrNull(
int tagNumber) → dynamic -
Returns the value of a field, ignoring any defaults.
inherited
-
getTagNumber(
String fieldName) → int? -
inherited
-
hasBurnProposalDepositPrevote(
) → bool -
hasBurnVoteQuorum(
) → bool -
hasBurnVoteVeto(
) → bool -
hasExpeditedThreshold(
) → bool -
hasExpeditedVotingPeriod(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
trueif a value ofextensionis present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber.inherited -
hasMaxDepositPeriod(
) → bool -
hasMinDepositRatio(
) → bool -
hasMinInitialDepositRatio(
) → bool -
hasProposalCancelDest(
) → bool -
hasProposalCancelRatio(
) → bool -
hasQuorum(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasThreshold(
) → bool -
hasVetoThreshold(
) → bool -
hasVotingPeriod(
) → bool -
isInitialized(
) → bool -
Whether all required fields in the message and embedded messages are set.
inherited
-
mergeFromBuffer(
List< int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges serialized protocol buffer data into this message.
inherited
-
mergeFromCodedBufferReader(
CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
inherited
-
mergeFromJson(
String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from
data, a JSON object, encoded as described byGeneratedMessage.writeToJson.inherited -
mergeFromJsonMap(
Map< String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from a JSON object represented as a Dart map.
inherited
-
mergeFromMessage(
GeneratedMessage other) → void -
Merges the contents of the
otherinto this message.inherited -
mergeFromProto3Json(
Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void -
Merges field values from
json, a JSON object using proto3 encoding.inherited -
mergeUnknownFields(
UnknownFieldSet unknownFieldSet) → void -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setExtension(
Extension extension, Object value) → void -
Sets the value of a non-repeated extension field to
value.inherited -
setField(
int tagNumber, Object value) → void -
Sets the value of a field by its
tagNumber.inherited -
toBuilder(
) → GeneratedMessage -
Creates a writable, shallow copy of this message.
inherited
-
toDebugString(
) → String -
Returns a String representation of this message.
inherited
-
toProto3Json(
{TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object? -
Returns an Object representing Proto3 JSON serialization of
this.inherited -
toString(
) → String -
Returns a String representation of this message.
inherited
-
writeToBuffer(
) → Uint8List -
inherited
-
writeToCodedBufferWriter(
CodedBufferWriter output) → void -
inherited
-
writeToJson(
) → String -
Returns a JSON string that encodes this message.
inherited
-
writeToJsonMap(
) → Map< String, dynamic> -
Returns the JSON encoding of this message as a Dart Map.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
create(
) → Params -
createRepeated(
) → PbList< Params> -
getDefault(
) → Params