@node-dlc/core

<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/lightning/CommitmentNumber.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/lightning</a> CommitmentNumber.ts</h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 30.77% Statements 4/13 </div> <div class='fl pad1y space-right2'> 100% Branches 0/0 </div> <div class='fl pad1y space-right2'> 0% Functions 0/5 </div> <div class='fl pad1y space-right2'> 30.77% Lines 4/13 </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 low'></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></td><td class="line-coverage quiet">1x 1x 1x   1x                                                                                                                                                                                    </td><td class="text"><pre class="prettyprint lang-js">import { LockTime, Sequence } from '@node-dlc/bitcoin'; import { bigFromBufBE } from '@node-dlc/bufio'; import { sha256 } from '@node-dlc/crypto';   export class CommitmentNumber { /** * Using the obscured commitment number, creates a Sequence with * the upper byte set to 0x80 and the lower three bytes set to the * upper 3 bytes of the 48-bit commitment number. * * The upper most byte is set to 0x80 so that the relative lock time * is disabled. * * @param commitment commitment number to obscure */ public static getSequence(obscurred: bigint): Sequence { return new Sequence( Number((BigInt(0x80) << BigInt(24)) | (obscurred >> BigInt(24))), ); }   /** * Using the obscured commitment number, creates a LockTime with * the upper byte set to 0x20 and the lower three bytes set to the * lower 3 bytes of the 48-bit commitment number. * * The uppermost byte is set to 0x20 so the LockTime uses a time * based absolute locktime that has already expired. * * @param obscurred obscurred commitment number */ public static getLockTime(obscurred: bigint): LockTime { return new LockTime( Number((BigInt(0x20) << BigInt(24)) | (obscurred & BigInt(0xffffff))), ); }   /** * Reveals the commitment number provided by the nSequence and * nLockTime values. This function reverses the obscurring using the * known payment base points. * * @param locktime * @param sequence */ public static reveal( locktime: LockTime, sequence: Sequence, openBasePoint: Buffer, acceptBasePoint: Buffer, ): number { const hash = CommitmentNumber.getHash(openBasePoint, acceptBasePoint); const upper = BigInt(sequence.value & 0xffffff) << BigInt(24); const lower = BigInt(locktime.value & 0xffffff); return Number(hash ^ (upper | lower)); }   /** * Defined in BOLT3, the obscurred commitment number is attached to the * commitment transaction. The 48-bit commitment number is broken into * two pieces, the lower 3-bytes are obscured in nLocketime and the * upper 3-bytes are obscured in the funding input's nSequence. * * The obscurred commitment number is calculated as the: * sha256(open_channel payment_basepoint || accept_channel payment_basepoint) ^ commitment_number * @param commitment * @param openBasePoint * @param acceptBasePoint */ public static obscure( commitment: number, openBasePoint: Buffer, acceptBasePoint: Buffer, ): bigint { return ( CommitmentNumber.getHash(openBasePoint, acceptBasePoint) ^ BigInt(commitment) ); }   /** * Obtains the lower 6-bytes from the sha256 of the open_channel * basepoint and the accept_channel basepoint. * @param openBasePoint * @param acceptBasePoint */ private static getHash( openBasePoint: Buffer, acceptBasePoint: Buffer, ): bigint { const hash = sha256(Buffer.concat([openBasePoint, acceptBasePoint])); return bigFromBufBE(hash.slice(hash.length - 6)); } }  </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 Sun Jul 20 2025 21:18:12 GMT-0700 (Pacific Daylight Saving 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>