BlockHeader class
Captures a block producer's consensus-commitment to a new block
- Inheritance
-
- Object
- GeneratedMessage
- BlockHeader
Constructors
-
BlockHeader({BlockId? parentHeaderId, Int64? parentSlot, List<
int> ? txRoot, List<int> ? bloomFilter, Int64? timestamp, Int64? height, Int64? slot, EligibilityCertificate? eligibilityCertificate, OperationalCertificate? operationalCertificate, List<int> ? metadata, StakingAddress? address, BlockId? headerId, ProtocolVersion? version}) -
factory
-
BlockHeader.fromBuffer(List<
int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]) -
factory
- BlockHeader.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- address ↔ StakingAddress
-
The operator's staking address
getter/setter pair
-
bloomFilter
↔ List<
int> -
A fuzzy search for addresses associated with this block
length = 256
getter/setter pair
- eligibilityCertificate ↔ EligibilityCertificate
-
A certificate indicating that the block producer was eligible to make this block
getter/setter pair
- eventPlugin → EventPlugin?
-
Subclasses can override this getter to be notified of changes
to protobuf fields.
no setterinherited
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- headerId ↔ BlockId
-
The ID of this block header. This value is optional and its contents are not included in the signable or identifiable data. Clients which can verify
this value should verify this value, but some clients may not be able to or need to, in which case this field acts as a convenience.
getter/setter pair
- height ↔ Int64
-
The 1-based index of this block in the blockchain
getter/setter pair
- info_ → BuilderInfo
-
no setteroverride
- isFrozen → bool
-
Returns
true
if this message is marked read-only. Otherwisefalse
.no setterinherited -
metadata
↔ List<
int> -
Optional metadata stamped by the operator. Must be latin-1 encoded, and must be at most 32 bytes in length.
optional
getter/setter pair
- operationalCertificate ↔ OperationalCertificate
-
A certificate indicating the operator's commitment to this block
getter/setter pair
- parentHeaderId ↔ BlockId
-
The parent block's ID. Each header builds from a single parent.
getter/setter pair
- parentSlot ↔ Int64
-
The slot of the parent block
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- slot ↔ Int64
-
The time-slot in which the block producer created the block
getter/setter pair
- timestamp ↔ Int64
-
The UTC UNIX timestamp (ms) when the block was created
getter/setter pair
-
txRoot
↔ List<
int> -
The commitment/accumulator of the block body
length = 32
getter/setter pair
- unknownFields → UnknownFieldSet
-
no setterinherited
- version ↔ ProtocolVersion
-
Protocol Version
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
-
clearAddress(
) → void -
clearBloomFilter(
) → void -
clearEligibilityCertificate(
) → 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
-
clearHeaderId(
) → void -
clearHeight(
) → void -
clearMetadata(
) → void -
clearOperationalCertificate(
) → void -
clearParentHeaderId(
) → void -
clearParentSlot(
) → void -
clearSlot(
) → void -
clearTimestamp(
) → void -
clearTxRoot(
) → void -
clearVersion(
) → void -
clone(
) → BlockHeader -
Creates a deep copy of the fields in this message.
(The generated code uses mergeFromMessage.)
override
-
copyWith(
void updates(BlockHeader)) → BlockHeader -
Apply
updates
to a copy of this message.override -
createEmptyInstance(
) → BlockHeader -
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
-
ensureAddress(
) → StakingAddress -
ensureEligibilityCertificate(
) → EligibilityCertificate -
ensureHeaderId(
) → BlockId -
ensureOperationalCertificate(
) → OperationalCertificate -
ensureParentHeaderId(
) → BlockId -
ensureVersion(
) → ProtocolVersion -
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
-
hasAddress(
) → bool -
hasBloomFilter(
) → bool -
hasEligibilityCertificate(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
true
if a value ofextension
is present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber
.inherited -
hasHeaderId(
) → bool -
hasHeight(
) → bool -
hasMetadata(
) → bool -
hasOperationalCertificate(
) → bool -
hasParentHeaderId(
) → bool -
hasParentSlot(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasSlot(
) → bool -
hasTimestamp(
) → bool -
hasTxRoot(
) → bool -
hasVersion(
) → 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
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(
) → BlockHeader -
createRepeated(
) → PbList< BlockHeader> -
getDefault(
) → BlockHeader