Skip to main content

ConsensusCommitPrologueV1

ConsensusCommitPrologueV1​

class ConsensusCommitPrologueV1

V1 of the consensus commit prologue system transaction

BCS

The BCS serialized form for this type is defined by the following ABNF:

consensus-commit-prologue-v1 = u64 u64 (option u64) u64 digest
consensus-determined-version-assignments

init(epoch:round:subDagIndex:commitTimestampMs:consensusCommitDigest:consensusDeterminedVersionAssignments:)​

convenience init(epoch: UInt64, round: UInt64, subDagIndex: UInt64?, commitTimestampMs: UInt64, consensusCommitDigest: ConsensusCommitDigest, consensusDeterminedVersionAssignments: ConsensusDeterminedVersionAssignments)

debugDescription​

var debugDescription: String { get }

A textual representation of this instance, suitable for debugging.

Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the String(reflecting:) initializer. This initializer works with any type, and uses the custom debugDescription property for types that conform to CustomDebugStringConvertible:

struct Point: CustomDebugStringConvertible {
    let x: Int, y: Int

    var debugDescription: String {
        return "(\(x), \(y))"
    }
}

let p = Point(x: 21, y: 30)
let s = String(reflecting: p)
print(s)
// Prints "(21, 30)"

The conversion of p to a string in the assignment to s uses the Point type's debugDescription property.

commitTimestampMs()​

func commitTimestampMs() -> UInt64

Unix timestamp from consensus

consensusCommitDigest()​

func consensusCommitDigest() -> ConsensusCommitDigest

Digest of consensus output

consensusDeterminedVersionAssignments()​

func consensusDeterminedVersionAssignments() -> ConsensusDeterminedVersionAssignments

Stores consensus handler determined shared object version assignments.

epoch()​

func epoch() -> UInt64

Epoch of the commit prologue transaction

round()​

func round() -> UInt64

Consensus round of the commit

subDagIndex()​

func subDagIndex() -> UInt64?

The sub DAG index of the consensus commit. This field will be populated if there are multiple consensus commits per round.

!=(_:_:)​

static func != (lhs: Self, rhs: Self) -> Bool

Returns a Boolean value indicating whether two values are not equal.

Inequality is the inverse of equality. For any values a and b, a != b implies that a == b is false.

This is the default implementation of the not-equal-to operator (!=) for any type that conforms to Equatable.

  • Parameters:
    • lhs: A value to compare.
    • rhs: Another value to compare.

==(_:_:)​

static func == (self: ConsensusCommitPrologueV1, other: ConsensusCommitPrologueV1) -> Bool

Returns a Boolean value indicating whether two values are equal.

Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

  • Parameters:
    • lhs: A value to compare.
    • rhs: Another value to compare.