Merge pull request #792 from PayButton/refactor/rename-nonce-paymentId

refactor: rename nonce -> paymentId

Author: Klakurka

services/chronikService.ts

@@ -74,25 +74,25 @@ export function getNullDataScriptData (outputScript: string): OpReturnData | nul
     paymentId: ''
   }
 
-  const noncePushDataIndex = dataStartIndex + dataPushData * 2
-  const nonceStartIndex = noncePushDataIndex + 2
-  const hasNonce = outputScript.length >= nonceStartIndex
-  if (!hasNonce) {
+  const paymentIdPushDataIndex = dataStartIndex + dataPushData * 2
+  const paymentIdStartIndex = paymentIdPushDataIndex + 2
+  const hasPaymentId = outputScript.length >= paymentIdStartIndex
+  if (!hasPaymentId) {
     return ret
   }
 
-  const noncePushDataHex = outputScript.slice(noncePushDataIndex, nonceStartIndex)
-  const noncePushData = parseInt(noncePushDataHex, 16)
-  let nonceString = ''
-  if (outputScript.length < nonceStartIndex + noncePushData * 2) {
+  const paymentIdPushDataHex = outputScript.slice(paymentIdPushDataIndex, paymentIdStartIndex)
+  const paymentIdPushData = parseInt(paymentIdPushDataHex, 16)
+  let paymentIdString = ''
+  if (outputScript.length < paymentIdStartIndex + paymentIdPushData * 2) {
     return ret
   }
-  for (let i = 0; i < noncePushData; i++) {
-    const hexByte = outputScript.slice(nonceStartIndex + (i * 2), nonceStartIndex + (i * 2) + 2)
-    // we don't decode the hex for the nonce, since those are just random bytes.
-    nonceString += hexByte
+  for (let i = 0; i < paymentIdPushData; i++) {
+    const hexByte = outputScript.slice(paymentIdStartIndex + (i * 2), paymentIdStartIndex + (i * 2) + 2)
+    // we don't decode the hex for the paymentId, since those are just random bytes.
+    paymentIdString += hexByte
   }
-  ret.paymentId = nonceString
+  ret.paymentId = paymentIdString
 
   return ret
 }

tests/unittests/chronikService.test.ts

@@ -32,7 +32,7 @@ describe('getNullDataScriptData tests', () => {
     const data = getNullDataScriptData(script)
     expect(data).toStrictEqual(EMPTY_OP_RETURN)
   })
-  it('Empty if data explicitly empty and nonce too', async () => {
+  it('Empty if data explicitly empty and paymentId too', async () => {
     const script = '6a' + '04' + '50415900' + '00' + '00' + '00'
     const data = getNullDataScriptData(script)
     expect(data).toStrictEqual(EMPTY_OP_RETURN)
@@ -102,23 +102,23 @@ describe('getNullDataScriptData tests', () => {
       data: '😂👍©ĸðМжЪы% ŋæPßđĸł„»“æ}¹↓£³→²'
     })
   })
-  it('String data with nonce', async () => {
+  it('String data with paymentId', async () => {
     const script = '6a' + '04' + '50415900' + '00' + '08' + '5051525354555657' + '03' + '010203'
     const data = getNullDataScriptData(script)
     expect(data).toStrictEqual({
       paymentId: '010203',
       data: 'PQRSTUVW'
     })
   })
-  it('String data with explicitly empty nonce', async () => {
+  it('String data with explicitly empty paymentId', async () => {
     const script = '6a' + '04' + '50415900' + '00' + '08' + '5051525354555657' + '00'
     const data = getNullDataScriptData(script)
     expect(data).toStrictEqual({
       paymentId: '',
       data: 'PQRSTUVW'
     })
   })
-  it('Ignore incomplete nonce', async () => {
+  it('Ignore incomplete paymentId', async () => {
     const script = '6a' + '04' + '50415900' + '00' + '08' + '5051525354555657' + '03' + 'aabb'
     const data = getNullDataScriptData(script)
     expect(data).toStrictEqual({