Proposal class

Proposal defines the core field members of a governance proposal.

Inheritance

• Object
• GeneratedMessage
• Proposal

Constructors

Proposal.new({Int64? id, Iterable<Any>? messages, ProposalStatus? status, TallyResult? finalTallyResult, Timestamp? submitTime, Timestamp? depositEndTime, Iterable<Coin>? totalDeposit, Timestamp? votingStartTime, Timestamp? votingEndTime, String? metadata, String? title, String? summary, String? proposer, bool? expedited, String? failedReason})

factory

Proposal.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

Proposal.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

Properties

depositEndTime ↔ Timestamp

deposit_end_time is the end time for deposition.

getter/setter pair

eventPlugin → EventPlugin?

Subclasses can override this getter to be notified of changes to protobuf fields.

no setter, inherited

expedited ↔ bool

expedited defines if the proposal is expedited

getter/setter pair

failedReason ↔ String

failed_reason defines the reason why the proposal failed

getter/setter pair

finalTallyResult ↔ TallyResult

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.

getter/setter pair

hashCode → int

Calculates a hash code based on the contents of the protobuf.

no setter, inherited

id ↔ Int64

id defines the unique id of the proposal.

getter/setter pair

info_ → BuilderInfo

no setter, override

isFrozen → bool

Returns true if this message is marked read-only. Otherwise false.

no setter, inherited

messages → List<Any>

messages are the arbitrary messages to be executed if the proposal passes.

no setter

metadata ↔ String

metadata is any arbitrary metadata attached to the proposal. the recommended format of the metadata is to be found here: https://docs.cosmos.network/v0.47/modules/gov#proposal-3

getter/setter pair

proposer ↔ String

proposer is the address of the proposal sumbitter

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

status ↔ ProposalStatus

status defines the proposal status.

getter/setter pair

submitTime ↔ Timestamp

submit_time is the time of proposal submission.

getter/setter pair

summary ↔ String

summary is a short summary of the proposal

getter/setter pair

title ↔ String

title is the title of the proposal

getter/setter pair

totalDeposit → List<Coin>

total_deposit is the total deposit on the proposal.

no setter

unknownFields → UnknownFieldSet

no setter, inherited

votingEndTime ↔ Timestamp

voting_end_time is the end time of voting on a proposal.

getter/setter pair

votingStartTime ↔ Timestamp

voting_start_time is the starting time to vote on a proposal.

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

clearDepositEndTime() → void

clearExpedited() → void

clearExtension(Extension extension) → void

Clears an extension field and also removes the extension.

inherited

clearFailedReason() → void

clearField(int tagNumber) → void

Clears the contents of a given field.

inherited

clearFinalTallyResult() → void

clearId() → void

clearMetadata() → void

clearProposer() → void

clearStatus() → void

clearSubmitTime() → void

clearSummary() → void

clearTitle() → void

clearVotingEndTime() → void

clearVotingStartTime() → void

clone() → Proposal

Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)

override

copyWith(void updates(Proposal)) → Proposal

Apply updates to a copy of this message.

override

createEmptyInstance() → Proposal

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

ensureDepositEndTime() → Timestamp

ensureFinalTallyResult() → TallyResult

ensureSubmitTime() → Timestamp

ensureVotingEndTime() → Timestamp

ensureVotingStartTime() → Timestamp

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

hasDepositEndTime() → bool

hasExpedited() → bool

hasExtension(Extension extension) → bool

Returns true if a value of extension is present.

inherited

hasFailedReason() → bool

hasField(int tagNumber) → bool

Whether this message has a field associated with tagNumber.

inherited

hasFinalTallyResult() → bool

hasId() → bool

hasMetadata() → bool

hasProposer() → bool

hasRequiredFields() → bool

Whether the message has required fields.

inherited

hasStatus() → bool

hasSubmitTime() → bool

hasSummary() → bool

hasTitle() → bool

hasVotingEndTime() → bool

hasVotingStartTime() → 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 by GeneratedMessage.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 other into 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() → Proposal

createRepeated() → PbList<Proposal>

getDefault() → Proposal