@node-lightning/wire

<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/messages/ChannelUpdateMessage.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> ChannelUpdateMessage.ts</h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 74.65% Statements 53/71 </div> <div class='fl pad1y space-right2'> 61.11% Branches 11/18 </div> <div class='fl pad1y space-right2'> 81.82% Functions 9/11 </div> <div class='fl pad1y space-right2'> 74.65% Lines 53/71 </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 medium'></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> <a name='L193'></a><a href='#L193'>193</a> <a name='L194'></a><a href='#L194'>194</a> <a name='L195'></a><a href='#L195'>195</a> <a name='L196'></a><a href='#L196'>196</a> <a name='L197'></a><a href='#L197'>197</a> <a name='L198'></a><a href='#L198'>198</a> <a name='L199'></a><a href='#L199'>199</a> <a name='L200'></a><a href='#L200'>200</a> <a name='L201'></a><a href='#L201'>201</a> <a name='L202'></a><a href='#L202'>202</a> <a name='L203'></a><a href='#L203'>203</a> <a name='L204'></a><a href='#L204'>204</a> <a name='L205'></a><a href='#L205'>205</a> <a name='L206'></a><a href='#L206'>206</a> <a name='L207'></a><a href='#L207'>207</a> <a name='L208'></a><a href='#L208'>208</a> <a name='L209'></a><a href='#L209'>209</a> <a name='L210'></a><a href='#L210'>210</a> <a name='L211'></a><a href='#L211'>211</a> <a name='L212'></a><a href='#L212'>212</a> <a name='L213'></a><a href='#L213'>213</a> <a name='L214'></a><a href='#L214'>214</a> <a name='L215'></a><a href='#L215'>215</a> <a name='L216'></a><a href='#L216'>216</a> <a name='L217'></a><a href='#L217'>217</a> <a name='L218'></a><a href='#L218'>218</a> <a name='L219'></a><a href='#L219'>219</a> <a name='L220'></a><a href='#L220'>220</a> <a name='L221'></a><a href='#L221'>221</a> <a name='L222'></a><a href='#L222'>222</a> <a name='L223'></a><a href='#L223'>223</a> <a name='L224'></a><a href='#L224'>224</a> <a name='L225'></a><a href='#L225'>225</a> <a name='L226'></a><a href='#L226'>226</a> <a name='L227'></a><a href='#L227'>227</a> <a name='L228'></a><a href='#L228'>228</a> <a name='L229'></a><a href='#L229'>229</a> <a name='L230'></a><a href='#L230'>230</a> <a name='L231'></a><a href='#L231'>231</a> <a name='L232'></a><a href='#L232'>232</a> <a name='L233'></a><a href='#L233'>233</a> <a name='L234'></a><a href='#L234'>234</a> <a name='L235'></a><a href='#L235'>235</a> <a name='L236'></a><a href='#L236'>236</a> <a name='L237'></a><a href='#L237'>237</a> <a name='L238'></a><a href='#L238'>238</a> <a name='L239'></a><a href='#L239'>239</a> <a name='L240'></a><a href='#L240'>240</a> <a name='L241'></a><a href='#L241'>241</a> <a name='L242'></a><a href='#L242'>242</a> <a name='L243'></a><a href='#L243'>243</a> <a name='L244'></a><a href='#L244'>244</a> <a name='L245'></a><a href='#L245'>245</a> <a name='L246'></a><a href='#L246'>246</a> <a name='L247'></a><a href='#L247'>247</a> <a name='L248'></a><a href='#L248'>248</a> <a name='L249'></a><a href='#L249'>249</a> <a name='L250'></a><a href='#L250'>250</a> <a name='L251'></a><a href='#L251'>251</a> <a name='L252'></a><a href='#L252'>252</a> <a name='L253'></a><a href='#L253'>253</a> <a name='L254'></a><a href='#L254'>254</a> <a name='L255'></a><a href='#L255'>255</a> <a name='L256'></a><a href='#L256'>256</a> <a name='L257'></a><a href='#L257'>257</a> <a name='L258'></a><a href='#L258'>258</a> <a name='L259'></a><a href='#L259'>259</a> <a name='L260'></a><a href='#L260'>260</a> <a name='L261'></a><a href='#L261'>261</a> <a name='L262'></a><a href='#L262'>262</a> <a name='L263'></a><a href='#L263'>263</a> <a name='L264'></a><a href='#L264'>264</a> <a name='L265'></a><a href='#L265'>265</a> <a name='L266'></a><a href='#L266'>266</a></td><td class="line-coverage quiet">1x 1x 1x 1x 1x     1x               1x           496x 496x 496x   496x 496x 496x 496x 496x 496x 496x 496x 496x 496x     496x 1x     496x               254x 254x                           254x 254x           509x                                                             509x                   509x                                                                             1006x                 1490x       2x 1x 1x 1x                       2x                                 255x                         255x 255x 255x 255x 255x 255x 255x 255x 255x 255x 255x 255x 255x 1x   255x                                                                                  </td><td class="text"><pre class="prettyprint lang-js">import { BufferReader, BufferWriter } from "@node-lightning/bufio"; import { BitField, ShortChannelId, Value } from "@node-lightning/core"; import { shortChannelIdFromBuffer } from "@node-lightning/core"; import * as crypto from "@node-lightning/crypto"; import { Checksum } from "../domain/Checksum"; import { ChannelUpdateMessageFlags } from "../flags/ChannelUpdateMessageFlags"; import { ChannelUpdateChannelFlags } from "../flags/ChanneUpdateChannelFlags"; import { MessageType } from "../MessageType"; import { IWireMessage } from "./IWireMessage";   /** * After a channel has been announced, each side independently announces the fees * and minimum expiry delta it requires to relay HTLCs through this channel. A * node can broadcast this message multiple times in order to change fees. */ export class ChannelUpdateMessage implements IWireMessage { /** * Deserializes the message from a Buffer. The message * is not validated in this function. */ public static deserialize(payload: Buffer): ChannelUpdateMessage { const instance = new ChannelUpdateMessage(); const reader = new BufferReader(payload); reader.readUInt16BE(); // read off type   instance.signature = reader.readBytes(64); instance.chainHash = reader.readBytes(32); instance.shortChannelId = shortChannelIdFromBuffer(reader.readBytes(8)); instance.timestamp = reader.readUInt32BE(); instance.messageFlags = BitField.fromNumber(reader.readUInt8()); instance.channelFlags = BitField.fromNumber(reader.readUInt8()); instance.cltvExpiryDelta = reader.readUInt16BE(); instance.htlcMinimumMsat = Value.fromMilliSats(reader.readUInt64BE()); instance.feeBaseMsat = Value.fromMilliSats(reader.readUInt32BE()); instance.feeProportionalMillionths = Value.fromMicroSats(reader.readUInt32BE());   // has optional_channel_htlc_max if (instance.hasHtlcMaximumMsatFlag) { instance.htlcMaximumMsat = Value.fromMilliSats(reader.readUInt64BE()); }   return instance; }   /** * Performs a double SHA-256 hash of the message with all * data excluding the signature data */ public static hashForSignature(message: ChannelUpdateMessage): Buffer { const raw = message.serialize().slice(66); return crypto.hash256(raw); }   /** * Performs signature validation for the message by * hashing the data post signature. A passing signature * indicates that the message was submitted by the node * that owns the channel. Becuase the nodeId is not included * in the message, we need to obtain the nodeId by accessing * the ChannelAnnouncementMessage and determining the public key * @param message * @param pubkey 33-byte ECDSA public key */ public static validateSignature(message: ChannelUpdateMessage, pubkey: Buffer) { const sigmsg = ChannelUpdateMessage.hashForSignature(message); return crypto.verifySig(sigmsg, message.signature, pubkey); }   /** * Message type is 258 */ public type: MessageType = MessageType.ChannelUpdate;   /** * 64-byte buffer containing the ECDSA secp256k1 signature of the double * SHA256 hash of the message as signed by the originating node. */ public signature: Buffer;   /** * 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;   /** * Timestamp of the update message and is used to indicate ordering of * messages if multiple messages are sent by the same node. */ public timestamp: number;   /** * Indicate the presence of optional fields in the channel_update message. * bit, field * 0, htlc_maximum_msat */ public messageFlags: BitField<ChannelUpdateMessageFlags> = new BitField();   /** * Indicates the direction of the channel: it identifies the node that this * update originated from and signals various options concerning the channel * such as whether it is disabled. * bit, name * 0, direction * 1, disabled */ public channelFlags: BitField<ChannelUpdateChannelFlags> = new BitField();   /** * The number of blocks the channel will subtract from an incoming * HTLC's cltv_expiry. */ public cltvExpiryDelta: number;   /** * The minimum HTLC value (in millisatoshi) that the channel peer * will accept. */ public htlcMinimumMsat: Value;   /** * The maximum value (in millisatoshi) it will send through this * channel for a single HTLC. This value must be less than the * channel capacity. This value will only be available when the * message flag option_channel_htlc_max is set. */ public htlcMaximumMsat: Value;   /** * The base fee (in millisatoshi) the channel will charge for * any HTLC. */ public feeBaseMsat: Value;   /** * The amount (in millionths of a satoshi) it will charge per * transferred satoshi. */ public feeProportionalMillionths: Value;   /** * Returns true when message flags have the optional * maximum HTLC msat value available */ public get hasHtlcMaximumMsatFlag(): boolean { return this.messageFlags.isSet(0); }   /** * Direction is determined by channel_flags bit 0. * When set to 0, node_1 is the sender. When set to 1 * node_2 is the sender */ public get direction(): number { return this.channelFlags.isSet(0) ? 1 : 0; }   public set direction(val: number) { if (val === 0) { this.channelFlags.unset(0); } else Eif (val === 1) { this.channelFlags.set(0); } else { throw new Error("Invlid direction"); } }   /** * Disabled flag is determined by channel_flags bit 1. * When set to 0, the channel is active. When set to 1 * the channel is disabled. */ public get disabled(): boolean { return this.channelFlags.isSet(1); }   public set disabled(val: boolean) { if (val) { this.channelFlags.set(1); } else { this.channelFlags.unset(1); } }   /** * Serializes the instance into a Buffer that can be * transmitted over the wire */ public serialize() { const len = 2 + // type 64 + // signature 32 + // chain_hash 8 + // short_channel_id 4 + // timestamp 1 + // message_flags 1 + // channel_flags 2 + // cltv_expiry_delta 8 + // htlc_minimum_msat 4 + // fee_base_msat 4 + // fee_proportional_millionths (this.hasHtlcMaximumMsatFlag ? 8 : 0);   const writer = new BufferWriter(Buffer.alloc(len)); writer.writeUInt16BE(this.type); writer.writeBytes(this.signature); writer.writeBytes(this.chainHash); writer.writeBytes(this.shortChannelId.toBuffer()); writer.writeUInt32BE(this.timestamp); writer.writeUInt8(this.messageFlags.toNumber()); writer.writeUInt8(this.channelFlags.toNumber()); writer.writeUInt16BE(this.cltvExpiryDelta); writer.writeUInt64BE(this.htlcMinimumMsat.msats); writer.writeUInt32BE(Number(this.feeBaseMsat.msats)); writer.writeUInt32BE(Number(this.feeProportionalMillionths.microsats)); if (this.hasHtlcMaximumMsatFlag) { writer.writeUInt64BE(this.htlcMaximumMsat.msats); } return writer.toBuffer(); }   /** * CRC32C checksum is calculated from the raw channel_update * message and excludes the signature and timestamp. * * @remarks * Defined in BOLT 07 gossip queries section: * https://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md#query-messages * */ public checksum(): Checksum { const len = 2 + // type 32 + // chain_hash 8 + // short_channel_id 1 + // message_flags 1 + // channel_flags 2 + // cltv_expiry_delta 8 + // htlc_minimum_msat 4 + // fee_base_msat 4 + // fee_proportional_millionths (this.hasHtlcMaximumMsatFlag ? 8 : 0);   const writer = new BufferWriter(Buffer.alloc(len)); writer.writeUInt16BE(this.type); writer.writeBytes(this.chainHash); writer.writeBytes(this.shortChannelId.toBuffer()); writer.writeUInt8(Number(this.messageFlags)); writer.writeUInt8(Number(this.channelFlags)); writer.writeUInt16BE(this.cltvExpiryDelta); writer.writeUInt64BE(this.htlcMinimumMsat.msats); writer.writeUInt32BE(Number(this.feeBaseMsat.msats)); writer.writeUInt32BE(Number(this.feeProportionalMillionths.microsats)); if (this.hasHtlcMaximumMsatFlag) { writer.writeUInt64BE(this.htlcMaximumMsat.msats); } return Checksum.fromBuffer(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>