Class CommitmentNumber

Namespace

NLightning.Domain.Protocol.Models

Assembly

NLightning.Domain.dll

Manages Lightning Network commitment numbers and their obscuring as defined in BOLT3.

public class CommitmentNumber

Inheritance

object

CommitmentNumber

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CommitmentNumber(CompactPubKey, CompactPubKey, ISha256, ulong)

Represents a commitment number in the Lightning Network.

public CommitmentNumber(CompactPubKey localPaymentBasepoint, CompactPubKey remotePaymentBasepoint, ISha256 sha256, ulong initialValue = 0)

Parameters

localPaymentBasepoint CompactPubKey

remotePaymentBasepoint CompactPubKey

sha256 ISha256

initialValue ulong

Properties

ObscuredValue

Gets the obscured commitment number (value XOR obscuring factor).

public ulong ObscuredValue { get; }

Property Value

ulong

ObscuringFactor

Gets the obscuring factor derived from payment basepoints.

public ulong ObscuringFactor { get; }

Property Value

ulong

Value

Gets the commitment number value.

public ulong Value { get; }

Property Value

ulong

Methods

CalculateLockTime()

Calculates the transaction locktime value using the obscured commitment number.

public BitcoinLockTime CalculateLockTime()

Returns

BitcoinLockTime

The transaction locktime.

CalculateSequence()

Calculates the transaction sequence value using the obscured commitment number.

public BitcoinSequence CalculateSequence()

Returns

BitcoinSequence

The transaction sequence.

Increment()

Increments the commitment number.

public CommitmentNumber Increment()

Returns

CommitmentNumber

This instance for chaining.