@node-lightning/wire

<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/messages/ChannelAnnouncementMessage.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> ChannelAnnouncementMessage.ts</h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 100% Statements 46/46 </div> <div class='fl pad1y space-right2'> 100% Branches 6/6 </div> <div class='fl pad1y space-right2'> 100% Functions 5/5 </div> <div class='fl pad1y space-right2'> 100% Lines 45/45 </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> <a name='L131'></a><a href='#L131'>131</a> <a name='L132'></a><a href='#L132'>132</a> <a name='L133'></a><a href='#L133'>133</a> <a name='L134'></a><a href='#L134'>134</a> <a name='L135'></a><a href='#L135'>135</a> <a name='L136'></a><a href='#L136'>136</a> <a name='L137'></a><a href='#L137'>137</a> <a name='L138'></a><a href='#L138'>138</a> <a name='L139'></a><a href='#L139'>139</a> <a name='L140'></a><a href='#L140'>140</a> <a name='L141'></a><a href='#L141'>141</a> <a name='L142'></a><a href='#L142'>142</a> <a name='L143'></a><a href='#L143'>143</a> <a name='L144'></a><a href='#L144'>144</a> <a name='L145'></a><a href='#L145'>145</a> <a name='L146'></a><a href='#L146'>146</a> <a name='L147'></a><a href='#L147'>147</a> <a name='L148'></a><a href='#L148'>148</a> <a name='L149'></a><a href='#L149'>149</a> <a name='L150'></a><a href='#L150'>150</a> <a name='L151'></a><a href='#L151'>151</a> <a name='L152'></a><a href='#L152'>152</a> <a name='L153'></a><a href='#L153'>153</a> <a name='L154'></a><a href='#L154'>154</a> <a name='L155'></a><a href='#L155'>155</a> <a name='L156'></a><a href='#L156'>156</a> <a name='L157'></a><a href='#L157'>157</a> <a name='L158'></a><a href='#L158'>158</a> <a name='L159'></a><a href='#L159'>159</a> <a name='L160'></a><a href='#L160'>160</a> <a name='L161'></a><a href='#L161'>161</a> <a name='L162'></a><a href='#L162'>162</a> <a name='L163'></a><a href='#L163'>163</a> <a name='L164'></a><a href='#L164'>164</a> <a name='L165'></a><a href='#L165'>165</a> <a name='L166'></a><a href='#L166'>166</a> <a name='L167'></a><a href='#L167'>167</a> <a name='L168'></a><a href='#L168'>168</a> <a name='L169'></a><a href='#L169'>169</a> <a name='L170'></a><a href='#L170'>170</a> <a name='L171'></a><a href='#L171'>171</a> <a name='L172'></a><a href='#L172'>172</a> <a name='L173'></a><a href='#L173'>173</a> <a name='L174'></a><a href='#L174'>174</a> <a name='L175'></a><a href='#L175'>175</a> <a name='L176'></a><a href='#L176'>176</a> <a name='L177'></a><a href='#L177'>177</a> <a name='L178'></a><a href='#L178'>178</a> <a name='L179'></a><a href='#L179'>179</a> <a name='L180'></a><a href='#L180'>180</a> <a name='L181'></a><a href='#L181'>181</a> <a name='L182'></a><a href='#L182'>182</a> <a name='L183'></a><a href='#L183'>183</a> <a name='L184'></a><a href='#L184'>184</a> <a name='L185'></a><a href='#L185'>185</a> <a name='L186'></a><a href='#L186'>186</a> <a name='L187'></a><a href='#L187'>187</a> <a name='L188'></a><a href='#L188'>188</a> <a name='L189'></a><a href='#L189'>189</a> <a name='L190'></a><a href='#L190'>190</a> <a name='L191'></a><a href='#L191'>191</a> <a name='L192'></a><a href='#L192'>192</a></td><td class="line-coverage quiet">1x 1x   1x 1x   1x                               1x         275x 275x 275x   275x 275x 275x 275x   275x 275x 275x 275x 275x 275x 275x 275x 275x                 149x 149x                           149x 149x                     457x                                                                                                                                                           152x 152x   152x                         152x 152x 152x 152x 152x 152x 152x 152x 152x 152x 152x 152x 152x 152x 152x      </td><td class="text"><pre class="prettyprint lang-js">import { BufferReader, BufferWriter } from "@node-lightning/bufio"; import { BitField } from "@node-lightning/core"; import { ShortChannelId } from "@node-lightning/core"; import { shortChannelIdFromBuffer } from "@node-lightning/core"; import * as crypto from "@node-lightning/crypto"; import { ChannelFeatureFlags } from "../flags/ChannelFeatureFlags"; import { MessageType } from "../MessageType"; import { IWireMessage } from "./IWireMessage";   /** * Message contains ownership information regarding a channel. * It ties each on-chain Bitcoin key to the associated Lightning * node key, and vice-versa. Proviing the existance of a channel * between node_1 and node_2 requires: * 1. proving that the funding pays to bitcoin_key_1 and bitcoin_key_2 * 2. proving that node_1 owns bitcoin_key_1 * 3. proving that node_2 owns bitcoin_key_2 * * This also varifies that both nodes want to announce the channel. * The required data to perform all of these proofs is available * in this message. */ export class ChannelAnnouncementMessage implements IWireMessage { /** * Deserializes the Buffer into a ChannelAnnouncementMessage. */ public static deserialize(payload: Buffer): ChannelAnnouncementMessage { const instance = new ChannelAnnouncementMessage(); 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); return instance; }   /** * Message hashing is after the first 258 bytes of the message * and excludes the type and signatures. It performs a double * sha-256 hash of the remaining bytes. */ public static hash(msg: ChannelAnnouncementMessage): Buffer { const bytes = msg.serialize().slice(258); return crypto.hash256(bytes); }   /** * Performs validation the message was signed by each node and the * the corresponding bitcoin key is owned by the owner of the node. * * This is accomplished by: * 1. verifying the bitcoinSignatures1/2 are validate signatures * from bitcoinKey1/2 * 2. verifying the nodeSignature1/2 are validate signatures * from nodeId1/2 */ public static verifySignatures(msg: ChannelAnnouncementMessage): boolean { const hash = ChannelAnnouncementMessage.hash(msg); return ( crypto.verifySig(hash, msg.bitcoinSignature1, msg.bitcoinKey1) && crypto.verifySig(hash, msg.bitcoinSignature2, msg.bitcoinKey2) && crypto.verifySig(hash, msg.nodeSignature1, msg.nodeId1) && crypto.verifySig(hash, msg.nodeSignature2, msg.nodeId2) ); }   /** * The message type - 256 */ public type: MessageType = MessageType.ChannelAnnouncement;   /** * Validate signature from node_1 of the hash containing the * data: features, chainHash, shortChannelId, nodeId1, * nodeId1, bitcoinKey1, and bitcoinKey2. */ public nodeSignature1: Buffer;   /** * Validate signature from node_2 of the hash containing the * data: features, chainHash, shortChannelId, nodeId1, * nodeId1, bitcoinKey1, and bitcoinKey2. */ public nodeSignature2: Buffer;   /** * Validate signature from bitcoin_key_1 of the hash containing the * data: features, chainHash, shortChannelId, nodeId1, * nodeId1, bitcoinKey1, and bitcoinKey2. */ public bitcoinSignature1: Buffer;   /** * Validate signature from bitcoin_key_2 of the hash containing the * data: features, chainHash, shortChannelId, nodeId1, * nodeId1, bitcoinKey1, and bitcoinKey2. */ public bitcoinSignature2: Buffer;   /** * The channel features are a bitmask */ public features: BitField<ChannelFeatureFlags>;   /** * Must set chain_hash to a 32-byte hash that uniquely identifies * the chain that the channel opened within. */ public chainHash: Buffer;   /** * ShortChannelId is a unique reference to the funding output of the * channel. */ public shortChannelId: ShortChannelId;   /** * The 33-byte compressed public key identifying the * numerically greater of the two DER-encoded keys * sorted in ascending numerical order. */ public nodeId1: Buffer;   /** * The 33-byte compressed public key identifying the * numerically greater of the two DER-encoded keys * sorted in ascending numerical order. */ public nodeId2: Buffer;   /** * The 33-byte compressed Bitcoin public key used by * node_id_1 to create the funding transaction. */ public bitcoinKey1: Buffer;   /** * The 33-byte compressed Bitcoin public key used by * node_id_2 to create the funding transaction. */ public bitcoinKey2: Buffer;   /** * Serializes the intancee into a Buffer suitable * for wire transport */ public serialize(): Buffer { const featuresBuffer = this.features.toBuffer(); const featuresLen = featuresBuffer.length; const len = 2 + // type 64 + // node_signature_1 64 + // node_signature_2 64 + // bitcoin_signature_1 64 + // bitcoin_signature_2 2 + // len featuresLen + 32 + // chain_hash 8 + // short_channel_id 33 + // node_id_1 33 + // node_id_2 33 + // bitcoin_key_1 33; // bitcoin_key_2 const writer = new BufferWriter(Buffer.alloc(len)); writer.writeUInt16BE(this.type); writer.writeBytes(this.nodeSignature1); writer.writeBytes(this.nodeSignature2); writer.writeBytes(this.bitcoinSignature1); writer.writeBytes(this.bitcoinSignature2); writer.writeUInt16BE(featuresLen); if (featuresLen > 0) writer.writeBytes(featuresBuffer); writer.writeBytes(this.chainHash); writer.writeBytes(this.shortChannelId.toBuffer()); writer.writeBytes(this.nodeId1); writer.writeBytes(this.nodeId2); writer.writeBytes(this.bitcoinKey1); writer.writeBytes(this.bitcoinKey2); return 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>