@com-chain/jsc3l 2.0.1-rc.2 → 2.0.1-rc.20

package/src/utils.ts

@@ -0,0 +1,300 @@
+export class SplitError extends Error {
+  constructor (message) {
+    super(message)
+    this.name = 'SplitError'
+  }
+}
+
+
+export class InsufficientBalanceError extends SplitError {
+  missingAmount: number
+  constructor (message, missingAmount) {
+    super(message)
+    this.name = 'InsufficientBalanceError'
+    this.missingAmount = missingAmount
+  }
+}
+
+export class CmSpendLimitError extends SplitError {
+  missingAmount: number
+  constructor (message, missingAmount) {
+    super(message)
+    this.name = 'CmSpendLimitError'
+    this.missingAmount = missingAmount
+  }
+}
+
+
+function min(a, b) {
+  return a < b ? a : b
+}
+
+
+export let getSplitting = function (amount, bals, cmSrcMin, cmSpendMax = null) {
+
+  const zero = amount - amount  // Required for agnosticity
+
+  const split = { nant: zero, cm: zero }
+  const cmPosSpendMax = cmSpendMax !== null ? min(bals.cm, cmSpendMax) : bals.cm
+
+  if (cmPosSpendMax >= 0) {
+    if (cmPosSpendMax >= amount) {
+      split.cm += amount
+      return split
+    }
+    split.cm += cmPosSpendMax
+    amount -= cmPosSpendMax
+    bals.cm -= cmPosSpendMax
+    if (cmSpendMax !== null) {
+      cmSpendMax -= cmPosSpendMax
+    }
+  }
+
+  if (bals.nant >= amount) {
+    split.nant += amount
+    return split
+  }
+
+  split.nant = bals.nant
+  amount -= bals.nant
+
+  let cmNegAvailable = bals.cm - cmSrcMin
+  const cmNegSpendMax = cmSpendMax !== null ? min(cmNegAvailable, cmSpendMax) : cmNegAvailable
+  if (cmNegSpendMax >= amount) {
+    split.cm += amount
+    return split
+  }
+
+  amount -= cmNegSpendMax
+  bals.cm -= cmNegSpendMax
+  if (cmSpendMax !== null) {
+    cmSpendMax -= cmNegSpendMax
+  }
+
+  cmNegAvailable = (bals.cm - cmSrcMin)
+  if (cmNegAvailable >= amount && cmSpendMax == 0) {
+    throw new CmSpendLimitError(
+      `Cm spend limit preventing to complete amount (remaining: ${amount}).`,
+      amount
+    )
+  }
+
+  throw new InsufficientBalanceError(
+    `Missing ${amount - cmNegAvailable} to complete amount`,
+    amount - cmNegAvailable
+  )
+}
+
+
+/* @skip-prod-transpilation */
+if (import.meta.vitest) {
+  const { it, expect, describe, beforeAll, afterAll } = import.meta.vitest
+
+  function testSuite (numberFactory: any = null, label: any = null) {
+    let msg
+    if (numberFactory) {
+      msg = `check with ${label}`
+    } else {
+      msg = "check with standard number"
+    }
+    describe(msg, () => {
+
+      let getSplittingOrig = getSplitting
+      let toStrictEqual
+
+      beforeAll(() => {
+
+        if (numberFactory) {
+          getSplitting = function (amount, bals, cmSrcMin, cmSpendMax = null) {
+            amount = numberFactory(amount)
+            bals.cm = numberFactory(bals.cm)
+            bals.nant = numberFactory(bals.nant)
+            cmSrcMin = numberFactory(cmSrcMin)
+            if (cmSpendMax !== null) {
+              cmSpendMax = numberFactory(cmSpendMax)
+            }
+            return getSplittingOrig(amount, bals, cmSrcMin, cmSpendMax)
+          }
+          toStrictEqual = function (actual, expected) {
+            let { cm, nant } = expected
+            expect(actual).toStrictEqual({ cm: numberFactory(cm), nant: numberFactory(nant) })
+          }
+        } else {
+          toStrictEqual = function (actual, expected) {
+            expect(actual).toStrictEqual(expected)
+          }
+        }
+      })
+
+      afterAll(() => {
+        getSplitting = getSplittingOrig
+      })
+
+
+      describe('split without cmSpendMax', () => {
+        it('should split 0 to cm: 0, nant: 0', () => {
+          toStrictEqual(getSplitting(0, { cm: 0, nant: 0 }, 0), { nant: 0, cm: 0 })
+        });
+        it('should NOT split 1 with no funds', () => {
+          expect(() => getSplitting(1, { cm: 0, nant: 0 }, 0))
+            .toThrow("Missing 1 to complete amount")
+        });
+        // Only Cm
+        it('should split 1 to cm: 1, nant: 0 with bal cm: 2, nant: 0', () => {
+          toStrictEqual(getSplitting(1, {cm: 2, nant: 0}, 0), { nant: 0, cm: 1 })
+        });
+        it('should split 2 to cm: 2, nant: 0 with bal cm: 2, nant: 0', () => {
+          toStrictEqual(getSplitting(2, { cm: 2, nant: 0 }, 0), { nant: 0, cm: 2 })
+        });
+        it('should NOT split 3 with bal cm: 2, nant: 0', () => {
+          expect(() => getSplitting(3, { cm: 2, nant: 0 }, 0))
+            .toThrow("Missing 1 to complete amount")
+        });
+        // Only Nant
+        it('should split 1 to cm: 0, nant: 1 with bal cm: 0, nant: 2', () => {
+          toStrictEqual(getSplitting(1, { cm: 0, nant: 2 }, 0), { nant: 1, cm: 0 })
+        });
+        it('should split 2 to cm: 0, nant: 2 with bal cm: 0, nant: 2', () => {
+          toStrictEqual(getSplitting(2, { cm: 0, nant: 2 }, 0), { nant: 2, cm: 0 })
+        });
+        it('should NOT split 3 with bal cm: 0, nant: 2', () => {
+          expect(() => getSplitting(3, { cm: 0, nant: 2 }, 0))
+            .toThrow("Missing 1 to complete amount")
+        });
+        // Both Nant and Cm
+        it('should split 2 to cm: 1, nant: 1 with bal cm: 1, nant: 1', () => {
+          toStrictEqual(getSplitting(2, { cm: 1, nant: 1 }, 0), { nant: 1, cm: 1 })
+        });
+        it('should split 2 to cm: 0, nant: 2 with bal cm: 0, nant: 2 (limSrcCm: -2)', () => {
+          toStrictEqual(getSplitting(2, { cm: 0, nant: 2 }, -2), { nant: 2, cm: 0 })
+        });
+        it('should split 2 to cm: 1, nant: 1 with bal cm: 0, nant: 1 (limSrcCm: -1)', () => {
+          toStrictEqual(getSplitting(2, { cm: 0, nant: 1 }, -1), { nant: 1, cm: 1 })
+        });
+        it('should NOT split 3 with bal cm: 0, nant: 1 (limSrcCm: -1)', () => {
+          expect(() => getSplitting(3, { cm: 0, nant: 1 }, -1))
+            .toThrow("Missing 1 to complete amount")
+        });
+        it('should split 3 to cm: 2, nant: 1 with bal cm: 1, nant: 1 (limSrcCm: -1)', () => {
+          toStrictEqual(getSplitting(3, { cm: 1, nant: 1 }, -1), { nant: 1, cm: 2 })
+        });
+        // Negative cm bal and limSrcCm
+        it('should split 1 to cm: -1, nant: 0 with bal cm: -1, nant: 0 (limSrcCm: -2)', () => {
+          toStrictEqual(getSplitting(1, { cm: -1, nant: 0 }, -2), { nant: 0, cm: 1 })
+        });
+        it('should NOT split 2 with bal cm: -1, nant: 0 (limSrcCm: -2)', () => {
+          expect(() => getSplitting(2, { cm: -1, nant: 0 }, -2))
+            .toThrow("Missing 1 to complete amount")
+        });
+      });
+      describe('split with cmSpendMax', () => {
+        it('should split 0 to cm: 0, nant: 0 (cmSpendMax: 0)', () => {
+          toStrictEqual(getSplitting(0, { cm: 0, nant: 0 }, 0, 0), { nant: 0, cm: 0})
+        });
+        it('should split 0 to cm: 0, nant: 0 (cmSpendMax: 1)', () => {
+          toStrictEqual(getSplitting(0, { cm: 0, nant: 0 }, 0, 0), { nant: 0, cm: 0})
+        });
+        it('should NOT split 1 with no funds (cmSpendMax: 1)', () => {
+          expect(() => getSplitting(1, { cm: 0, nant: 0 }, 0, 1))
+            .toThrow("Missing 1 to complete amount")
+        });
+        it('should NOT split 1 with no funds (cmSpendMax: 0)', () => {
+          expect(() => getSplitting(1, { cm: 0, nant: 0 }, 0, 0))
+            .toThrow("Missing 1 to complete amount")
+        });
+        // Only Cm
+        it('should split 1 to cm: 1, nant: 0 with bal cm: 2, nant: 0 (cmSpendMax: 1)', () => {
+          toStrictEqual(getSplitting(1, {cm: 2, nant: 0}, 0, 1), { nant: 0, cm: 1 })
+        });
+        it('should split 2 to cm: 2, nant: 0 with bal cm: 2, nant: 0 (cmSpendMax: 2)', () => {
+          toStrictEqual(getSplitting(2, { cm: 2, nant: 0 }, 0, 2), { nant: 0, cm: 2 })
+        });
+        it('should NOT split 2 to cm: 2, nant: 0 with bal cm: 2, nant: 0 (cmSpendMax: 1)', () => {
+          expect(() => getSplitting(2, { cm: 2, nant: 0 }, 0, 1))
+            .toThrow("Cm spend limit preventing to complete amount (remaining: 1)")
+        });
+        it('should NOT split 3 with bal cm: 2, nant: 0 (cmSpendMax: 5)', () => {
+          expect(() => getSplitting(3, { cm: 2, nant: 0 }, 0, 5))
+            .toThrow("Missing 1 to complete amount")
+        });
+        it('should NOT split 3 with bal cm: 2, nant: 0 (cmSpendMax: 2)', () => {
+          expect(() => getSplitting(3, { cm: 2, nant: 0 }, 0, 2))
+            .toThrow("Missing 1 to complete amount")
+        });
+        it('should NOT split 3 with bal cm: 2, nant: 0 (cmSpendMax: 1)', () => {
+          expect(() => getSplitting(3, { cm: 2, nant: 0 }, 0, 1))
+            .toThrow("Missing 1 to complete amount")
+        });
+        // Only Nant
+        it('should split 1 to cm: 0, nant: 1 with bal cm: 0, nant: 2 (cmSpendMax: 0)', () => {
+          toStrictEqual(getSplitting(1, { cm: 0, nant: 2 }, 0, 0), { nant: 1, cm: 0 })
+        });
+        it('should split 2 to cm: 0, nant: 2 with bal cm: 0, nant: 2 (cmSpendMax: 1)', () => {
+          toStrictEqual(getSplitting(2, { cm: 0, nant: 2 }, 0, 1), { nant: 2, cm: 0 })
+        });
+        it('should NOT split 3 with bal cm: 0, nant: 2 (cmSpendMax: 0)', () => {
+          expect(() => getSplitting(3, { cm: 0, nant: 2 }, 0, 0))
+            .toThrow("Missing 1 to complete amount")
+        });
+        // Both Nant and Cm
+        it('should split 2 to cm: 1, nant: 1 with bal cm: 1, nant: 1 (cmSpendMax: 1)', () => {
+          toStrictEqual(getSplitting(2, { cm: 1, nant: 1 }, 0, 1), { nant: 1, cm: 1})
+        });
+        it('should NOT split 2 to cm: 1, nant: 1 with bal cm: 1, nant: 1 (cmSpendMax: 0)', () => {
+          expect(() => getSplitting(2, { cm: 1, nant: 1 }, 0, 0))
+            .toThrow("Cm spend limit preventing to complete amount (remaining: 1)")
+        });
+        it('should split 2 to cm: 1, nant: 1 with bal cm: 0, nant: 1 (limSrcCm: -1, cmSpendMax: 1)', () => {
+          toStrictEqual(getSplitting(2, { cm: 0, nant: 1 }, -1, 1), { nant: 1, cm: 1})
+        });
+        it('should NOT split 2 to cm: 1, nant: 1 with bal cm: 0, nant: 1 (limSrcCm: -1, cmSpendMax: 0)', () => {
+          expect(() => getSplitting(2, { cm: 0, nant: 1 }, -1, 0))
+            .toThrow("Cm spend limit preventing to complete amount (remaining: 1)")
+        });
+        it('should NOT split 3 with bal cm: 0, nant: 1 (limSrcCm: -1, cmSpendMax: 5)', () => {
+          expect(() => getSplitting(3, { cm: 0, nant: 1 }, -1, 5))
+            .toThrow("Missing 1 to complete amount")
+        });
+        it('should NOT split 3 with bal cm: 0, nant: 1 (limSrcCm: -1, cmSpendMax: 0)', () => {
+          expect(() => getSplitting(3, { cm: 0, nant: 1 }, -1, 0))
+            .toThrow("Missing 1 to complete amount")
+        });
+        it('should split 3 to cm: 2, nant: 1 with bal cm: 1, nant: 1 (limSrcCm: -1, cmSpendMax: 2)', () => {
+          toStrictEqual(getSplitting(3, { cm: 1, nant: 1 }, -1, 2), { nant: 1, cm: 2 })
+        });
+        it('should NOT split 3 to cm: 2, nant: 1 with bal cm: 1, nant: 1 (limSrcCm: -1, cmSpendMax: 1)', () => {
+          expect(() => getSplitting(3, { cm: 1, nant: 1 }, -1, 1))
+            .toThrow("Cm spend limit preventing to complete amount (remaining: 1)")
+        });
+        // If the recipient can't receive cm, then pay with nant if possible.
+        it('should split 2 to cm: 0, nant: 2 with bal cm: 2, nant: 2 (limSrcCm: 0, cmSpendMax: 0)', () => {
+          toStrictEqual(getSplitting(2, { cm: 2, nant: 2 }, 0, 0), { nant: 2, cm: 0 })
+        });
+        it('should split 3 to cm: 1, nant: 2 with bal cm: 2, nant: 2 (limSrcCm: 0, cmSpendMax: 1)', () => {
+          toStrictEqual(getSplitting(3, { cm: 2, nant: 2 }, 0, 1), { nant: 2, cm: 1 })
+        });
+        it('should split 3 to cm: 2, nant: 2 with bal cm: 2, nant: 2 (limSrcCm: 0, cmSpendMax: 2)', () => {
+          toStrictEqual(getSplitting(3, { cm: 2, nant: 2 }, 0, 2), { nant: 1, cm: 2 })
+        });
+        // Negative cm bal and limSrcCm
+        it('should split 1 to cm: -1, nant: 0 with bal cm: -1, nant: 0 (limSrcCm: -2, cmSpendMax: 1)', () => {
+          toStrictEqual(getSplitting(1, { cm: -1, nant: 0 }, -2, 1), { nant: 0, cm: 1 })
+        });
+        it('should NOT split 2 with bal cm: -1, nant: 0 (limSrcCm: -2, cmSpendMax: 2)', () => {
+          expect(() => getSplitting(2, { cm: -1, nant: 0 }, -2, 2))
+            .toThrow("Missing 1 to complete amount")
+        });
+        it('should NOT split 2 with bal cm: -1, nant: 0 (limSrcCm: -2, cmSpendMax: 0)', () => {
+          expect(() => getSplitting(2, { cm: -1, nant: 0 }, -2, 2))
+            .toThrow("Missing 1 to complete amount")
+        });
+        it('should NOT split 2 with bal cm: -1, nant: 0 (limSrcCm: -3, cmSpendMax: 1)', () => {
+          expect(() => getSplitting(2, { cm: -1, nant: 0 }, -3, 1))
+            .toThrow("Cm spend limit preventing to complete amount (remaining: 1)")
+        });
+      })
+    })
+  }
+  testSuite()
+  testSuite(BigInt, "BigInt")
+}

package/src/wallet.ts

@@ -1,6 +1,7 @@
-import ethUtil from 'ethereumjs-util'
-
 import AjaxReq from './rest/ajaxReq'
+import {
+  checkSignedQR, SignedQR, makeSignedQRContent, makeSignedQRFragments
+} from './qr'
 import { shortenAddress, cipherMsg, decipherMsg } from './ethereum/cipher'
 import Wallet from './ethereum/myetherwallet'
 
@@ -95,7 +96,7 @@ export default abstract class MessagingWalletAbstract extends Wallet {
     const newKey = Wallet.generate(false)
     const mPub = newKey.getPublicKeyString()
     const mPriv = newKey.getPrivateKeyString()
-    return { pub: mPub, priv: cipherMsg(mPub, mPriv) }
+    return { pub: mPub, priv: cipherMsg(this.getPublicKeyString(), mPriv) }
   }
 
   public messageKeysFromCrypted (cipheredKey) {
@@ -121,10 +122,14 @@ export default abstract class MessagingWalletAbstract extends Wallet {
     })
   }
 
-  public enrollAddress (codeId, token) {
-    return this.ajaxReq.enrollAddress(
-      codeId, this.getAddressString(),
-      this.currencyName, token)
+  public enrollAddress (id, token) {
+    return this.ajaxReq.enrollPost({
+      id,
+      token,
+      currency: this.currencyName,
+      // XXXvlab: Yes, typo is intentional here (in PHP API):
+      adresse: this.getAddressString(),
+    })
   }
 
   public requestUnlock () {
@@ -148,54 +153,38 @@ export default abstract class MessagingWalletAbstract extends Wallet {
     }
   }
 
-
   //
-  // QR Codes requires EthUtils
+  // QR Code helpers
   //
 
-  public makeSignedQRWithPubKey (objContent, pubKey) {
-    objContent.message_key = cipherMsg(
-      pubKey, this.messageKeysFromWallet()
-    )
-    objContent.address = this.getAddressString()
-    return this.makeSignedQR(objContent)
+  public makeSignedQRContent (obj, pubKey: string | null) {
+    return makeSignedQRContent({
+      server: this.currencyName,
+      address: this.getAddressString(),
+      ...obj,
+      ...pubKey && {
+        message_key: cipherMsg(pubKey, this.messageKeysFromWallet())
+      },
+    }, this.privKey)
   }
 
-  public makeSignedQR (obj) {
-
-    // Values expected:
-    const {
-      server, destinary, begin, end,
-      viewbalance, viewoldtran, pub_key
-    } = obj
-    const formatDate = (date) =>
-      `${begin.getFullYear()}/${begin.getMonth()}/${begin.getDate()}`
-    const objContent = Object.assign(obj, {
-      address: this.getAddressString(),
-      begin: formatDate(begin),
-      end: formatDate(end)
-    })
+  public makeSignedQRFragments (
+    obj, fragmentCount: number, pubKey: string | null
+  ) {
+    return makeSignedQRFragments(
+      this.makeSignedQRContent(obj, pubKey),
+      fragmentCount,
+    )
+  }
 
-    const hash = ethUtil.sha3(JSON.stringify(objContent))
-    const signature = ethUtil.ecsign(hash, this.privKey)
-    return {
-      signature,
-      qrContent: JSON.stringify({
-        data: objContent,
-        signature: {
-          v: signature.v,
-          r: '0x' + signature.r.toString('hex'),
-          s: '0x' + signature.s.toString('hex')
-        }
-      })
+  public checkSignedQRFromString (qrString: string) {
+    let qrContent: SignedQR
+    try {
+      qrContent = JSON.parse(qrString)
+    } catch (e) {
+      return 'InvalidFormat'
     }
+    return checkSignedQR(qrContent, this.getAddressString())
   }
 
 }
-
-// // TODO: What to do with this validateEnrollment
-// public static validateEnrollment (codeId, signature) {
-//     return this.ajaxReq.validateEnrollmentLetter(
-//       codeId, this.currencyName, signature)
-//   }
-

package/tests/environment.ts

@@ -0,0 +1,27 @@
+import type { Environment } from 'vitest'
+
+export default <Environment>{
+  name: 'custom',
+  transformMode: 'ssr',
+  // optional - only if you support "experimental-vm" pool
+  async setupVM() {
+    const vm = await import('node:vm')
+    const context = vm.createContext()
+    return {
+      getVmContext() {
+        return context
+      },
+      teardown() {
+        // called after all tests with this env have been run
+      }
+    }
+  },
+  setup() {
+    // custom setup
+    return {
+      teardown() {
+        // called after all tests with this env have been run
+      }
+    }
+  }
+}

package/tests/setup.ts

@@ -0,0 +1,12 @@
+import { Buffer } from 'buffer'
+import { afterAll, beforeAll } from 'vitest';
+
+beforeAll(() => {
+  global.Buffer = Buffer
+});
+
+afterAll(() => {
+  delete global.Buffer
+});
+
+

package/tsconfig.json

@@ -1,6 +1,6 @@
 {
     "compilerOptions": {
-        "target": "es2017",
+        "target": "es2020",
         "module": "esnext",
         "moduleResolution": "node",
         "declaration": true,
@@ -24,7 +24,13 @@
         "outDir": "build",
         "paths": {
             "*": ["src/types/*"]
-        }
+        },
+        "types": [
+            "vitest/importMeta"
+        ],
+        "plugins": [
+          { "transform": "./skip-prod-transpilation.ts" }
+        ]
     },
     "include": ["src/**/*", "references.d.ts"],
     "exclude": ["node_modules", "platforms", "**/angular"]

package/vitest.config.ts

@@ -0,0 +1,14 @@
+/// <reference types="vitest" />
+import { defineConfig } from 'vite'
+
+const cfg =  defineConfig({
+  test: {
+    include: ['src/**/*.{js,ts}'],
+    setupFiles: ['./tests/setup.ts'],
+    environment: 'jsdom',
+    passWithNoTests: true,
+    bail: 1,
+  },
+})
+
+export default cfg