| | | 1 | | using System.Diagnostics; |
| | | 2 | | using System.Diagnostics.CodeAnalysis; |
| | | 3 | | |
| | | 4 | | namespace NLightning.Bolt11.Models; |
| | | 5 | | |
| | | 6 | | using Domain.Protocol.ValueObjects; |
| | | 7 | | using Domain.Utils; |
| | | 8 | | using Enums; |
| | | 9 | | using Factories; |
| | | 10 | | using Interfaces; |
| | | 11 | | |
| | | 12 | | /// <summary> |
| | | 13 | | /// A list of tagged fields |
| | | 14 | | /// </summary> |
| | | 15 | | internal class TaggedFieldList : List<ITaggedField> |
| | | 16 | | { |
| | 0 | 17 | | private bool _shouldInvokeChangedEvent = true; |
| | | 18 | | public event EventHandler? Changed; |
| | | 19 | | |
| | | 20 | | /// <summary> |
| | | 21 | | /// Add a tagged field to the list |
| | | 22 | | /// </summary> |
| | | 23 | | /// <param name="taggedField">The tagged field to add</param> |
| | | 24 | | /// <exception cref="ArgumentException">If the tagged field is not unique</exception> |
| | | 25 | | internal new void Add(ITaggedField taggedField) |
| | | 26 | | { |
| | | 27 | | // Individual field validation |
| | 0 | 28 | | if (!taggedField.IsValid()) |
| | 0 | 29 | | throw new ArgumentException($"Invalid {taggedField.Type} field: field validation failed"); |
| | | 30 | | |
| | | 31 | | // Check for uniqueness |
| | 0 | 32 | | if (this.Any(x => x.Type.Equals(taggedField.Type)) && taggedField.Type != TaggedFieldTypes.FallbackAddress) |
| | 0 | 33 | | throw new ArgumentException( |
| | 0 | 34 | | $"TaggedFieldDictionary already contains a tagged field of type {taggedField.Type}"); |
| | | 35 | | |
| | | 36 | | // Mutual exclusivity validation |
| | 0 | 37 | | if (taggedField.Type == TaggedFieldTypes.Description |
| | 0 | 38 | | && this.Any(x => x.Type.Equals(TaggedFieldTypes.DescriptionHash))) |
| | 0 | 39 | | throw new ArgumentException( |
| | 0 | 40 | | $"TaggedFieldDictionary already contains a tagged field of type {taggedField.Type}"); |
| | | 41 | | |
| | 0 | 42 | | if (taggedField.Type == TaggedFieldTypes.DescriptionHash |
| | 0 | 43 | | && this.Any(x => x.Type.Equals(TaggedFieldTypes.Description))) |
| | 0 | 44 | | throw new ArgumentException( |
| | 0 | 45 | | $"TaggedFieldDictionary already contains a tagged field of type {taggedField.Type}"); |
| | | 46 | | |
| | | 47 | | // Add the tagged field |
| | 0 | 48 | | base.Add(taggedField); |
| | 0 | 49 | | if (_shouldInvokeChangedEvent) |
| | 0 | 50 | | OnChanged(); |
| | 0 | 51 | | } |
| | | 52 | | |
| | | 53 | | /// <summary> |
| | | 54 | | /// Add a range of tagged fields to the list |
| | | 55 | | /// </summary> |
| | | 56 | | /// <param name="taggedFields">The tagged fields to add</param> |
| | | 57 | | internal new void AddRange(IEnumerable<ITaggedField> taggedFields) |
| | | 58 | | { |
| | 0 | 59 | | _shouldInvokeChangedEvent = false; |
| | | 60 | | |
| | 0 | 61 | | foreach (var taggedField in taggedFields) |
| | 0 | 62 | | Add(taggedField); |
| | | 63 | | |
| | 0 | 64 | | _shouldInvokeChangedEvent = true; |
| | 0 | 65 | | OnChanged(); |
| | 0 | 66 | | } |
| | | 67 | | |
| | | 68 | | internal new bool Remove(ITaggedField item) |
| | | 69 | | { |
| | 0 | 70 | | if (!base.Remove(item)) |
| | 0 | 71 | | return false; |
| | | 72 | | |
| | 0 | 73 | | OnChanged(); |
| | 0 | 74 | | return true; |
| | | 75 | | } |
| | | 76 | | |
| | | 77 | | internal new void RemoveAt(int index) |
| | | 78 | | { |
| | 0 | 79 | | base.RemoveAt(index); |
| | 0 | 80 | | OnChanged(); |
| | 0 | 81 | | } |
| | | 82 | | |
| | | 83 | | internal new int RemoveAll(Predicate<ITaggedField> match) |
| | | 84 | | { |
| | 0 | 85 | | var removed = base.RemoveAll(match); |
| | 0 | 86 | | if (removed > 0) |
| | 0 | 87 | | OnChanged(); |
| | | 88 | | |
| | 0 | 89 | | return removed; |
| | | 90 | | } |
| | | 91 | | |
| | | 92 | | internal new void RemoveRange(int index, int count) |
| | | 93 | | { |
| | 0 | 94 | | base.RemoveRange(index, count); |
| | 0 | 95 | | OnChanged(); |
| | 0 | 96 | | } |
| | | 97 | | |
| | | 98 | | /// <summary> |
| | | 99 | | /// Attempts to retrieve a tagged field of the specified type from the list. |
| | | 100 | | /// </summary> |
| | | 101 | | /// <typeparam name="T">The type of the tagged field to retrieve.</typeparam> |
| | | 102 | | /// <param name="taggedFieldType">The type of the tagged field being searched for.</param> |
| | | 103 | | /// <param name="taggedField">The output parameter to hold the retrieved tagged field if found; otherwise, the defau |
| | | 104 | | /// <returns>True if the tagged field of the specified type is found; otherwise, false.</returns> |
| | | 105 | | internal bool TryGet<T>(TaggedFieldTypes taggedFieldType, [MaybeNullWhen(false)] out T taggedField) |
| | | 106 | | where T : ITaggedField |
| | | 107 | | { |
| | 0 | 108 | | var value = Get<T>(taggedFieldType); |
| | 0 | 109 | | if (value != null) |
| | | 110 | | { |
| | 0 | 111 | | taggedField = value; |
| | 0 | 112 | | return true; |
| | | 113 | | } |
| | | 114 | | |
| | 0 | 115 | | taggedField = default; |
| | 0 | 116 | | return false; |
| | | 117 | | } |
| | | 118 | | |
| | | 119 | | /// <summary> |
| | | 120 | | /// Try to get all tagged fields of a specific type |
| | | 121 | | /// </summary> |
| | | 122 | | /// <param name="taggedFieldType">The type of the tagged field</param> |
| | | 123 | | /// <param name="taggedFieldList">A list containing the tagged fields</param> |
| | | 124 | | /// <typeparam name="T">The type of the tagged field</typeparam> |
| | | 125 | | /// <returns>True if the tagged fields were found, false otherwise</returns> |
| | | 126 | | internal bool TryGetAll<T>(TaggedFieldTypes taggedFieldType, [MaybeNullWhen(false)] out List<T> taggedFieldList) |
| | | 127 | | where T : ITaggedField |
| | | 128 | | { |
| | 0 | 129 | | var value = GetAll<T>(taggedFieldType); |
| | 0 | 130 | | if (value != null) |
| | | 131 | | { |
| | 0 | 132 | | taggedFieldList = value; |
| | 0 | 133 | | return true; |
| | | 134 | | } |
| | | 135 | | |
| | 0 | 136 | | taggedFieldList = null; |
| | 0 | 137 | | return false; |
| | | 138 | | } |
| | | 139 | | |
| | | 140 | | /// <summary> |
| | | 141 | | /// Get a new TaggedFieldList from a BitReader |
| | | 142 | | /// </summary> |
| | | 143 | | /// <param name="bitReader">The BitReader to read from</param> |
| | | 144 | | /// <param name="bitcoinNetwork">The network type</param> |
| | | 145 | | /// <returns>A new TaggedFieldList</returns> |
| | | 146 | | internal static TaggedFieldList FromBitReader(BitReader bitReader, BitcoinNetwork bitcoinNetwork) |
| | | 147 | | { |
| | 0 | 148 | | var taggedFields = new TaggedFieldList(); |
| | 0 | 149 | | while (bitReader.HasMoreBits(15)) |
| | | 150 | | { |
| | 0 | 151 | | var type = (TaggedFieldTypes)bitReader.ReadByteFromBits(5); |
| | 0 | 152 | | var length = bitReader.ReadInt16FromBits(10); |
| | 0 | 153 | | if (length != 0 && !bitReader.HasMoreBits(length * 5)) |
| | | 154 | | continue; |
| | | 155 | | |
| | 0 | 156 | | if (!Enum.IsDefined(type)) |
| | | 157 | | { |
| | 0 | 158 | | bitReader.SkipBits(length * 5); |
| | | 159 | | } |
| | | 160 | | else |
| | | 161 | | { |
| | | 162 | | try |
| | | 163 | | { |
| | 0 | 164 | | var taggedField = |
| | 0 | 165 | | TaggedFieldFactory.CreateTaggedFieldFromBitReader(type, bitReader, length, bitcoinNetwork); |
| | 0 | 166 | | if (taggedField is null) |
| | 0 | 167 | | continue; |
| | | 168 | | |
| | | 169 | | try |
| | | 170 | | { |
| | 0 | 171 | | taggedFields.Add(taggedField); |
| | 0 | 172 | | } |
| | 0 | 173 | | catch (Exception e) |
| | | 174 | | { |
| | | 175 | | Debug.WriteLine(e.Message); |
| | | 176 | | // Skip for now, log latter |
| | 0 | 177 | | } |
| | 0 | 178 | | } |
| | 0 | 179 | | catch (Exception e) |
| | | 180 | | { |
| | | 181 | | Debug.WriteLine(e.Message); |
| | | 182 | | // Skip for now, log latter |
| | 0 | 183 | | } |
| | | 184 | | } |
| | | 185 | | } |
| | | 186 | | |
| | 0 | 187 | | return taggedFields; |
| | | 188 | | } |
| | | 189 | | |
| | | 190 | | /// <summary> |
| | | 191 | | /// Write the TaggedFieldList to a BitWriter |
| | | 192 | | /// </summary> |
| | | 193 | | /// <param name="bitWriter">The BitWriter to write to</param> |
| | | 194 | | internal void WriteToBitWriter(BitWriter bitWriter) |
| | | 195 | | { |
| | 0 | 196 | | foreach (var taggedField in this) |
| | | 197 | | { |
| | | 198 | | // Write type |
| | 0 | 199 | | bitWriter.WriteByteAsBits((byte)taggedField.Type, 5); |
| | | 200 | | |
| | | 201 | | // Write length |
| | 0 | 202 | | bitWriter.WriteInt16AsBits(taggedField.Length, 10); |
| | | 203 | | |
| | 0 | 204 | | taggedField.WriteToBitWriter(bitWriter); |
| | | 205 | | } |
| | 0 | 206 | | } |
| | | 207 | | |
| | | 208 | | /// <summary> |
| | | 209 | | /// Calculate the size of the TaggedFieldList in bits |
| | | 210 | | /// </summary> |
| | | 211 | | /// <returns>The size of the TaggedFieldList in bits</returns> |
| | | 212 | | internal int CalculateSizeInBits() |
| | | 213 | | { |
| | 0 | 214 | | return this.Sum(x => x.Length); |
| | | 215 | | } |
| | | 216 | | |
| | | 217 | | /// <summary> |
| | | 218 | | /// Get a tagged field of a specific type |
| | | 219 | | /// </summary> |
| | | 220 | | /// <param name="taggedFieldType">The type of the tagged field</param> |
| | | 221 | | /// <typeparam name="T">The type of the tagged field</typeparam> |
| | | 222 | | /// <returns>The tagged field</returns> |
| | | 223 | | private T? Get<T>(TaggedFieldTypes taggedFieldType) where T : ITaggedField |
| | | 224 | | { |
| | 0 | 225 | | return (T?)this.FirstOrDefault(x => x.Type.Equals(taggedFieldType)); |
| | | 226 | | } |
| | | 227 | | |
| | | 228 | | /// <summary> |
| | | 229 | | /// Get all tagged fields of a specific type |
| | | 230 | | /// </summary> |
| | | 231 | | /// <param name="taggedFieldType">The type of the tagged field</param> |
| | | 232 | | /// <typeparam name="T">The type of the tagged field</typeparam> |
| | | 233 | | /// <returns>A list containing the tagged fields</returns> |
| | | 234 | | private List<T>? GetAll<T>(TaggedFieldTypes taggedFieldType) where T : ITaggedField |
| | | 235 | | { |
| | 0 | 236 | | var taggedFields = this.Where(x => x.Type.Equals(taggedFieldType)).ToList(); |
| | 0 | 237 | | return taggedFields.Count == 0 |
| | 0 | 238 | | ? null |
| | 0 | 239 | | : taggedFields.Cast<T>().ToList(); |
| | | 240 | | } |
| | | 241 | | |
| | | 242 | | private void OnChanged() |
| | | 243 | | { |
| | 0 | 244 | | Changed?.Invoke(this, EventArgs.Empty); |
| | 0 | 245 | | } |
| | | 246 | | } |