| | | 1 | | using NLightning.Domain.Bitcoin.Transactions.Interfaces; |
| | | 2 | | using NLightning.Domain.Bitcoin.Transactions.Outputs; |
| | | 3 | | using NLightning.Domain.Bitcoin.ValueObjects; |
| | | 4 | | using NLightning.Domain.Money; |
| | | 5 | | using NLightning.Domain.Protocol.Models; |
| | | 6 | | |
| | | 7 | | namespace NLightning.Domain.Bitcoin.Transactions.Models; |
| | | 8 | | |
| | | 9 | | /// <summary> |
| | | 10 | | /// Represents a commitment transaction in the domain model. |
| | | 11 | | /// This class encapsulates the logical structure of a Lightning Network commitment transaction |
| | | 12 | | /// as defined by BOLT specifications, without dependencies on specific Bitcoin libraries. |
| | | 13 | | /// </summary> |
| | | 14 | | public class CommitmentTransactionModel |
| | | 15 | | { |
| | | 16 | | /// <summary> |
| | | 17 | | /// Gets the funding outpoint that this commitment transaction spends. |
| | | 18 | | /// </summary> |
| | 276 | 19 | | public FundingOutputInfo FundingOutput { get; } |
| | | 20 | | |
| | | 21 | | /// <summary> |
| | | 22 | | /// Gets the commitment number for this transaction. |
| | | 23 | | /// </summary> |
| | 136 | 24 | | public CommitmentNumber CommitmentNumber { get; } |
| | | 25 | | |
| | | 26 | | /// <summary> |
| | | 27 | | /// Gets or sets the transaction ID after the transaction is constructed. |
| | | 28 | | /// </summary> |
| | 0 | 29 | | public TxId? TransactionId { get; set; } |
| | | 30 | | |
| | | 31 | | /// <summary> |
| | | 32 | | /// Gets the to_local output, if present. |
| | | 33 | | /// </summary> |
| | 316 | 34 | | public ToLocalOutputInfo? ToLocalOutput { get; } |
| | | 35 | | |
| | | 36 | | /// <summary> |
| | | 37 | | /// Gets the to_remote output, if present. |
| | | 38 | | /// </summary> |
| | 212 | 39 | | public ToRemoteOutputInfo? ToRemoteOutput { get; } |
| | | 40 | | |
| | | 41 | | /// <summary> |
| | | 42 | | /// Gets the local anchor output, if present. |
| | | 43 | | /// </summary> |
| | 268 | 44 | | public AnchorOutputInfo? LocalAnchorOutput { get; } |
| | | 45 | | |
| | | 46 | | /// <summary> |
| | | 47 | | /// Gets the remote anchor output, if present. |
| | | 48 | | /// </summary> |
| | 268 | 49 | | public AnchorOutputInfo? RemoteAnchorOutput { get; } |
| | | 50 | | |
| | | 51 | | /// <summary> |
| | | 52 | | /// Gets the list of offered HTLC outputs. |
| | | 53 | | /// </summary> |
| | 68 | 54 | | public IReadOnlyList<OfferedHtlcOutputInfo> OfferedHtlcOutputs { get; } |
| | | 55 | | |
| | | 56 | | /// <summary> |
| | | 57 | | /// Gets the list of received HTLC outputs. |
| | | 58 | | /// </summary> |
| | 68 | 59 | | public IReadOnlyList<ReceivedHtlcOutputInfo> ReceivedHtlcOutputs { get; } |
| | | 60 | | |
| | | 61 | | /// <summary> |
| | | 62 | | /// Gets the total fee for this transaction. |
| | | 63 | | /// </summary> |
| | 0 | 64 | | public LightningMoney Fee { get; } |
| | | 65 | | |
| | | 66 | | /// <summary> |
| | | 67 | | /// Creates a new instance of CommitmentTransactionModel. |
| | | 68 | | /// </summary> |
| | 120 | 69 | | public CommitmentTransactionModel(CommitmentNumber commitmentNumber, LightningMoney fee, |
| | 120 | 70 | | FundingOutputInfo fundingOutput, AnchorOutputInfo? localAnchorOutput = null, |
| | 120 | 71 | | AnchorOutputInfo? remoteAnchorOutput = null, |
| | 120 | 72 | | ToLocalOutputInfo? toLocalOutput = null, |
| | 120 | 73 | | ToRemoteOutputInfo? toRemoteOutput = null, |
| | 120 | 74 | | IEnumerable<OfferedHtlcOutputInfo>? offeredHtlcOutputs = null, |
| | 120 | 75 | | IEnumerable<ReceivedHtlcOutputInfo>? receivedHtlcOutputs = null) |
| | | 76 | | { |
| | 120 | 77 | | if (fundingOutput.TransactionId is null || fundingOutput.TransactionId.Value == TxId.Zero) |
| | 0 | 78 | | throw new ArgumentException("Funding output must have a valid transaction ID.", nameof(fundingOutput)); |
| | | 79 | | |
| | 120 | 80 | | FundingOutput = fundingOutput; |
| | 120 | 81 | | CommitmentNumber = commitmentNumber; |
| | 120 | 82 | | Fee = fee; |
| | 120 | 83 | | ToLocalOutput = toLocalOutput; |
| | 120 | 84 | | ToRemoteOutput = toRemoteOutput; |
| | 120 | 85 | | LocalAnchorOutput = localAnchorOutput; |
| | 120 | 86 | | RemoteAnchorOutput = remoteAnchorOutput; |
| | 120 | 87 | | OfferedHtlcOutputs = (offeredHtlcOutputs ?? []).ToList(); |
| | 120 | 88 | | ReceivedHtlcOutputs = (receivedHtlcOutputs ?? []).ToList(); |
| | 120 | 89 | | } |
| | | 90 | | |
| | | 91 | | /// <summary> |
| | | 92 | | /// Gets the Bitcoin locktime for this commitment transaction, derived from the commitment number. |
| | | 93 | | /// </summary> |
| | 68 | 94 | | public BitcoinLockTime GetLockTime() => CommitmentNumber.CalculateLockTime(); |
| | | 95 | | |
| | | 96 | | /// <summary> |
| | | 97 | | /// Gets the Bitcoin sequence for this commitment transaction, derived from the commitment number. |
| | | 98 | | /// </summary> |
| | 68 | 99 | | public BitcoinSequence GetSequence() => CommitmentNumber.CalculateSequence(); |
| | | 100 | | |
| | | 101 | | /// <summary> |
| | | 102 | | /// Gets all outputs of this commitment transaction. |
| | | 103 | | /// </summary> |
| | | 104 | | public IEnumerable<IOutputInfo> GetAllOutputs() |
| | | 105 | | { |
| | 0 | 106 | | if (ToLocalOutput != null) yield return ToLocalOutput; |
| | 0 | 107 | | if (ToRemoteOutput != null) yield return ToRemoteOutput; |
| | 0 | 108 | | if (LocalAnchorOutput != null) yield return LocalAnchorOutput; |
| | 0 | 109 | | if (RemoteAnchorOutput != null) yield return RemoteAnchorOutput; |
| | | 110 | | |
| | 0 | 111 | | foreach (var output in OfferedHtlcOutputs) yield return output; |
| | 0 | 112 | | foreach (var output in ReceivedHtlcOutputs) yield return output; |
| | 0 | 113 | | } |
| | | 114 | | } |