@node-lightning/wire

<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/messages/ExtendedChannelAnnouncementMessage.ts</title> <meta charset="utf-8" /> <link rel="stylesheet" href="../../prettify.css" /> <link rel="stylesheet" href="../../base.css" /> <link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <style type='text/css'> .coverage-summary .sorter { background-image: url(../../sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1><a href="../../index.html">All files</a> / <a href="index.html">lib/messages</a> ExtendedChannelAnnouncementMessage.ts</h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 98.33% Statements 59/60 </div> <div class='fl pad1y space-right2'> 66.67% Branches 2/3 </div> <div class='fl pad1y space-right2'> 100% Functions 4/4 </div> <div class='fl pad1y space-right2'> 98.33% Lines 59/60 </div> </div> Press n or j to go to the next uncovered block, b, p or k for the previous block. </div> <div class='status-line high'></div> <pre><table class="coverage"> <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a> <a name='L2'></a><a href='#L2'>2</a> <a name='L3'></a><a href='#L3'>3</a> <a name='L4'></a><a href='#L4'>4</a> <a name='L5'></a><a href='#L5'>5</a> <a name='L6'></a><a href='#L6'>6</a> <a name='L7'></a><a href='#L7'>7</a> <a name='L8'></a><a href='#L8'>8</a> <a name='L9'></a><a href='#L9'>9</a> <a name='L10'></a><a href='#L10'>10</a> <a name='L11'></a><a href='#L11'>11</a> <a name='L12'></a><a href='#L12'>12</a> <a name='L13'></a><a href='#L13'>13</a> <a name='L14'></a><a href='#L14'>14</a> <a name='L15'></a><a href='#L15'>15</a> <a name='L16'></a><a href='#L16'>16</a> <a name='L17'></a><a href='#L17'>17</a> <a name='L18'></a><a href='#L18'>18</a> <a name='L19'></a><a href='#L19'>19</a> <a name='L20'></a><a href='#L20'>20</a> <a name='L21'></a><a href='#L21'>21</a> <a name='L22'></a><a href='#L22'>22</a> <a name='L23'></a><a href='#L23'>23</a> <a name='L24'></a><a href='#L24'>24</a> <a name='L25'></a><a href='#L25'>25</a> <a name='L26'></a><a href='#L26'>26</a> <a name='L27'></a><a href='#L27'>27</a> <a name='L28'></a><a href='#L28'>28</a> <a name='L29'></a><a href='#L29'>29</a> <a name='L30'></a><a href='#L30'>30</a> <a name='L31'></a><a href='#L31'>31</a> <a name='L32'></a><a href='#L32'>32</a> <a name='L33'></a><a href='#L33'>33</a> <a name='L34'></a><a href='#L34'>34</a> <a name='L35'></a><a href='#L35'>35</a> <a name='L36'></a><a href='#L36'>36</a> <a name='L37'></a><a href='#L37'>37</a> <a name='L38'></a><a href='#L38'>38</a> <a name='L39'></a><a href='#L39'>39</a> <a name='L40'></a><a href='#L40'>40</a> <a name='L41'></a><a href='#L41'>41</a> <a name='L42'></a><a href='#L42'>42</a> <a name='L43'></a><a href='#L43'>43</a> <a name='L44'></a><a href='#L44'>44</a> <a name='L45'></a><a href='#L45'>45</a> <a name='L46'></a><a href='#L46'>46</a> <a name='L47'></a><a href='#L47'>47</a> <a name='L48'></a><a href='#L48'>48</a> <a name='L49'></a><a href='#L49'>49</a> <a name='L50'></a><a href='#L50'>50</a> <a name='L51'></a><a href='#L51'>51</a> <a name='L52'></a><a href='#L52'>52</a> <a name='L53'></a><a href='#L53'>53</a> <a name='L54'></a><a href='#L54'>54</a> <a name='L55'></a><a href='#L55'>55</a> <a name='L56'></a><a href='#L56'>56</a> <a name='L57'></a><a href='#L57'>57</a> <a name='L58'></a><a href='#L58'>58</a> <a name='L59'></a><a href='#L59'>59</a> <a name='L60'></a><a href='#L60'>60</a> <a name='L61'></a><a href='#L61'>61</a> <a name='L62'></a><a href='#L62'>62</a> <a name='L63'></a><a href='#L63'>63</a> <a name='L64'></a><a href='#L64'>64</a> <a name='L65'></a><a href='#L65'>65</a> <a name='L66'></a><a href='#L66'>66</a> <a name='L67'></a><a href='#L67'>67</a> <a name='L68'></a><a href='#L68'>68</a> <a name='L69'></a><a href='#L69'>69</a> <a name='L70'></a><a href='#L70'>70</a> <a name='L71'></a><a href='#L71'>71</a> <a name='L72'></a><a href='#L72'>72</a> <a name='L73'></a><a href='#L73'>73</a> <a name='L74'></a><a href='#L74'>74</a> <a name='L75'></a><a href='#L75'>75</a> <a name='L76'></a><a href='#L76'>76</a> <a name='L77'></a><a href='#L77'>77</a> <a name='L78'></a><a href='#L78'>78</a> <a name='L79'></a><a href='#L79'>79</a> <a name='L80'></a><a href='#L80'>80</a> <a name='L81'></a><a href='#L81'>81</a> <a name='L82'></a><a href='#L82'>82</a> <a name='L83'></a><a href='#L83'>83</a> <a name='L84'></a><a href='#L84'>84</a> <a name='L85'></a><a href='#L85'>85</a> <a name='L86'></a><a href='#L86'>86</a> <a name='L87'></a><a href='#L87'>87</a> <a name='L88'></a><a href='#L88'>88</a> <a name='L89'></a><a href='#L89'>89</a> <a name='L90'></a><a href='#L90'>90</a> <a name='L91'></a><a href='#L91'>91</a> <a name='L92'></a><a href='#L92'>92</a> <a name='L93'></a><a href='#L93'>93</a> <a name='L94'></a><a href='#L94'>94</a> <a name='L95'></a><a href='#L95'>95</a> <a name='L96'></a><a href='#L96'>96</a> <a name='L97'></a><a href='#L97'>97</a> <a name='L98'></a><a href='#L98'>98</a> <a name='L99'></a><a href='#L99'>99</a> <a name='L100'></a><a href='#L100'>100</a> <a name='L101'></a><a href='#L101'>101</a> <a name='L102'></a><a href='#L102'>102</a> <a name='L103'></a><a href='#L103'>103</a> <a name='L104'></a><a href='#L104'>104</a> <a name='L105'></a><a href='#L105'>105</a> <a name='L106'></a><a href='#L106'>106</a> <a name='L107'></a><a href='#L107'>107</a> <a name='L108'></a><a href='#L108'>108</a> <a name='L109'></a><a href='#L109'>109</a> <a name='L110'></a><a href='#L110'>110</a> <a name='L111'></a><a href='#L111'>111</a> <a name='L112'></a><a href='#L112'>112</a> <a name='L113'></a><a href='#L113'>113</a> <a name='L114'></a><a href='#L114'>114</a> <a name='L115'></a><a href='#L115'>115</a> <a name='L116'></a><a href='#L116'>116</a> <a name='L117'></a><a href='#L117'>117</a> <a name='L118'></a><a href='#L118'>118</a> <a name='L119'></a><a href='#L119'>119</a> <a name='L120'></a><a href='#L120'>120</a> <a name='L121'></a><a href='#L121'>121</a> <a name='L122'></a><a href='#L122'>122</a> <a name='L123'></a><a href='#L123'>123</a> <a name='L124'></a><a href='#L124'>124</a> <a name='L125'></a><a href='#L125'>125</a> <a name='L126'></a><a href='#L126'>126</a> <a name='L127'></a><a href='#L127'>127</a> <a name='L128'></a><a href='#L128'>128</a> <a name='L129'></a><a href='#L129'>129</a> <a name='L130'></a><a href='#L130'>130</a></td><td class="line-coverage quiet">1x 1x 1x 1x 1x 1x                           1x           135x 135x 135x 135x 135x 135x 135x 135x 135x 135x 135x 135x 135x 135x       12x 12x 12x   12x 12x 12x 12x   12x 12x 12x 12x 12x 12x 12x 12x     12x 13x         12x       12x           1x 1x             12x                                 1x 1x     1x 1x 1x 1x     1x 1x 1x     1x 1x 1x     1x 1x 1x   1x      </td><td class="text"><pre class="prettyprint lang-js">import { BufferReader, BufferWriter } from "@node-lightning/bufio"; import { BitField, HashByteOrder, HashValue } from "@node-lightning/core"; import { shortChannelIdFromBuffer } from "@node-lightning/core"; import { OutPoint } from "@node-lightning/core"; import { readTlvs } from "../serialize/readTlvs"; import { ChannelAnnouncementMessage } from "./ChannelAnnouncementMessage";   /** * Decorator for the channel_announcement that includes the additional * information provided by the on-chain validation. Specifically, the * channel_announcement message only has a short_channel_id with block, tx num, * and vout num. We need to obtain the txid as well as the outpoint value to * determine the value of the channel. * * This information is stored in this decorator class which can be broadcast * and used downstream by clients that need both sets of information. Additionally * the use of this decorator allows us to store the on-chain data along side the * channel_announcement data if so desired. */ export class ExtendedChannelAnnouncementMessage extends ChannelAnnouncementMessage { /** * Constructs a new ExtendedChannelAnnouncementMessage from the plain-jane * ChannelAnnouncementMessage */ public static fromMessage(msg: ChannelAnnouncementMessage) { const instance = new ExtendedChannelAnnouncementMessage(); instance.bitcoinKey1 = msg.bitcoinKey1; instance.bitcoinKey2 = msg.bitcoinKey2; instance.bitcoinSignature1 = msg.bitcoinSignature1; instance.bitcoinSignature2 = msg.bitcoinSignature2; instance.chainHash = msg.chainHash; instance.features = msg.features; instance.nodeId1 = msg.nodeId1; instance.nodeId2 = msg.nodeId2; instance.nodeSignature1 = msg.nodeSignature1; instance.nodeSignature2 = msg.nodeSignature2; instance.shortChannelId = msg.shortChannelId; instance.type = msg.type; return instance; }   public static deserialize(payload: Buffer): ExtendedChannelAnnouncementMessage { const instance = new ExtendedChannelAnnouncementMessage(); const reader = new BufferReader(payload); reader.readUInt16BE(); // read off type   instance.nodeSignature1 = reader.readBytes(64); instance.nodeSignature2 = reader.readBytes(64); instance.bitcoinSignature1 = reader.readBytes(64); instance.bitcoinSignature2 = reader.readBytes(64);   const len = reader.readUInt16BE(); instance.features = BitField.fromBuffer(reader.readBytes(len)); instance.chainHash = reader.readBytes(32); instance.shortChannelId = shortChannelIdFromBuffer(reader.readBytes(8)); instance.nodeId1 = reader.readBytes(33); instance.nodeId2 = reader.readBytes(33); instance.bitcoinKey1 = reader.readBytes(33); instance.bitcoinKey2 = reader.readBytes(33);   // read the TLVs for the extended data readTlvs(reader, (type: bigint, valueReader: BufferReader) => { switch (type) { // process the outpoint which is obtained after looking onchain // at the funding transaction. This is encoded as a 32-byte txid // and a 2 byte uint output index case BigInt(16777271): { instance.outpoint = new OutPoint( HashValue.fromRpc(valueReader.readBytes(32).toString("hex")), valueReader.readTUInt16(), ); return true; } // process the channel capacity which is obtained after looking // onchain at the funding transaction outpoint. This is encoded // as a single tuint64 value. case BigInt(16777273): { instance.capacity = valueReader.readTUInt64(); return true; } default: return false; } });   return instance; }   /** * OutPoint for the channel that includes the transaction identifier as well * as the vout index. This information is obtained by finding the transaction * in a block based on the short_channel_id. */ public outpoint: OutPoint;   /** * Capacity of the funding transaction. This information is obtained from on-chain * validation of the transaction. */ public capacity: bigint;   public serialize() { const chanAnnBuffer = super.serialize(); const writer = new BufferWriter();   // outpoint value let valueWriter = new BufferWriter(); valueWriter.writeBytes(this.outpoint.txid.serialize(HashByteOrder.RPC)); valueWriter.writeTUInt16(this.outpoint.outputIndex); let value = valueWriter.toBuffer();   // outpoint tlv writer.writeBigSize(16777271); writer.writeBigSize(value.length); writer.writeBytes(value);   // capacity value valueWriter = new BufferWriter(); valueWriter.writeTUInt64(this.capacity); value = valueWriter.toBuffer();   // capacity tlv writer.writeBigSize(16777273); writer.writeBigSize(value.length); writer.writeBytes(value);   return Buffer.concat([chanAnnBuffer, writer.toBuffer()]); } }  </pre></td></tr></table></pre> <div class='push'></div> </div> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Mon Nov 07 2022 14:49:44 GMT-0500 (Eastern Standard Time) </div> </div> <script src="../../prettify.js"></script> <script> window.onload = function () { prettyPrint(); }; </script> <script src="../../sorter.js"></script> <script src="../../block-navigation.js"></script> </body> </html>