< Summary - Combined Code Coverage

Information
Class: NLightning.Bolt11.Models.TaggedFields.PaymentSecretTaggedField
Assembly: NLightning.Bolt11
File(s): /home/runner/work/nlightning/nlightning/src/NLightning.Bolt11/Models/TaggedFields/PaymentSecretTaggedField.cs
Tag: 36_15743069263
Line coverage
90%
Covered lines: 19
Uncovered lines: 2
Coverable lines: 21
Total lines: 72
Line coverage: 90.4%
Branch coverage
75%
Covered branches: 6
Total branches: 8
Branch coverage: 75%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
get_Type()100%11100%
get_Value()100%11100%
get_Length()100%11100%
.ctor(...)100%11100%
WriteToBitWriter(...)100%22100%
IsValid()50%22100%
FromBitReader(...)75%4.18477.78%

File(s)

/home/runner/work/nlightning/nlightning/src/NLightning.Bolt11/Models/TaggedFields/PaymentSecretTaggedField.cs

#LineLine coverage
 1using NBitcoin;
 2
 3namespace NLightning.Bolt11.Models.TaggedFields;
 4
 5using Constants;
 6using Domain.Utils;
 7using Enums;
 8using Interfaces;
 9
 10/// <summary>
 11/// Tagged field for the payment secret
 12/// </summary>
 13/// <remarks>
 14/// The payment secret is a 32-byte secret used to identify a payment
 15/// </remarks>
 16/// <seealso cref="ITaggedField"/>
 17internal sealed class PaymentSecretTaggedField : ITaggedField
 18{
 216819    public TaggedFieldTypes Type => TaggedFieldTypes.PaymentSecret;
 61220    internal uint256 Value { get; }
 16821    public short Length => TaggedFieldConstants.HashLength;
 22
 23    /// <summary>
 24    /// Initializes a new instance of the <see cref="DescriptionHashTaggedField"/> class.
 25    /// </summary>
 26    /// <param name="value">The Description Hash</param>
 20027    internal PaymentSecretTaggedField(uint256 value)
 28    {
 20029        Value = value;
 20030    }
 31
 32    /// <inheritdoc/>
 33    public void WriteToBitWriter(BitWriter bitWriter)
 34    {
 5635        var data = Value.ToBytes();
 5636        if (BitConverter.IsLittleEndian)
 5637            Array.Reverse(data);
 38
 39        // Write data
 5640        bitWriter.WriteBits(data, Length * 5);
 5641    }
 42
 43    /// <inheritdoc/>
 44    public bool IsValid()
 45    {
 20046        return Value != uint256.Zero && Value != uint256.One;
 47    }
 48
 49    /// <summary>
 50    /// Reads a PaymentSecretTaggedField from a BitReader
 51    /// </summary>
 52    /// <param name="bitReader">The BitReader to read from</param>
 53    /// <param name="length">The length of the field</param>
 54    /// <returns>The PaymentSecretTaggedField</returns>
 55    /// <exception cref="ArgumentException">Thrown when the length is invalid</exception>
 56    internal static PaymentSecretTaggedField FromBitReader(BitReader bitReader, short length)
 57    {
 6458        if (length != TaggedFieldConstants.HashLength)
 059            throw new ArgumentException(
 060                $"Invalid length for {nameof(PaymentSecretTaggedField)}. Expected {TaggedFieldConstants.HashLength}, but
 61
 62        // Read the data from the BitReader
 6463        var data = new byte[(TaggedFieldConstants.HashLength * 5 + 7) / 8];
 6464        bitReader.ReadBits(data, length * 5);
 6465        data = data[..^1];
 66
 6467        if (BitConverter.IsLittleEndian)
 6468            Array.Reverse(data);
 69
 6470        return new PaymentSecretTaggedField(new uint256(data));
 71    }
 72}