Merge pull request #77 from virtualeconomy/develop

release: v0.2.2

Author: josephzxy

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@virtualeconomy/js-vsys",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "The official JavaScript SDK for VSYS APIs",
   "keywords": [
     "vsys",

spec/model_spec.js

@@ -0,0 +1,38 @@
+/**
+ * modelSpec tests module model.
+ * @module modelSpec
+ */
+
+'use strict';
+
+import * as jv from '../src/index.js';
+
+describe('Test class Seed', function () {
+    describe('Test method encrypt', function () {
+        it('should properly encrypt', function () {
+            const key = 'abc';
+            const rounds = 5000;
+
+            const seed = new jv.Seed(this.SEED);  
+            const enc = seed.encrypt(key, rounds);
+
+            const dec = enc.decrypt(key, rounds);
+            expect(dec.data).toEqual(seed.data);
+        });
+    });
+});
+
+describe('Test class EncryptedSeed', function () {
+    describe('Test method decrypt', function () {
+        it('should properly decrypt', function () {
+            const key = 'abc';
+            const rounds = 5000;
+
+            const seed = new jv.Seed(this.SEED);  
+            const enc = seed.encrypt(key, rounds);
+
+            const dec = enc.decrypt(key, rounds);
+            expect(dec.data).toEqual(seed.data);
+        });
+    });
+});

src/account.js

@@ -206,8 +206,8 @@ export class Account {
   /**
    * lease leases the VSYS coins from the action taker to the recipient(a supernode).
    * @param {string} supernodeAddr - The supernode address.
-   * @param {md.VSYS} amount - The lease amount.
-   * @param {md.Fee} fee - The lease fee. DEFAULT to be md.Fee.DEFAULT.
+   * @param {number} amount - The lease amount.
+   * @param {number} fee - The lease fee. DEFAULT to be md.Fee.DEFAULT.
    * @returns {object} The response returned by the NodeAPI.
    */
   async lease(supernodeAddr, amount, fee = md.LeasingFee.DEFAULT) {
@@ -237,7 +237,8 @@ export class Account {
 
   /**
    * leaseCancel sends a leasing cancel transaction request on behalf of the account.
-   * @param {md.Addr} leasingTxId - The leasing Transaction id.
+   * @param {string} leasingTxId - The leasing Transaction id.
+   * @param {number} fee - The leasing cancel fee. DEFAULT to be md.Fee.DEFAULT.
    * @returns {object} The response returned by the NodeAPI.
    */
   async leaseCancel(leasingTxId, fee = md.Fee.DEFAULT) {

src/contract/pay_chan_ctrt.js

@@ -566,7 +566,7 @@ export class PayChanCtrt extends ctrt.Ctrt {
     const msg = Buffer.concat([
       bp.packUInt16(chanIdBytes.length),
       chanIdBytes,
-      bp.packUInt64(bn.toBigInt(rawAmount)),
+      bp.packUInt64(rawAmount),
     ]);
 
     return msg;

src/data_entry.js

@@ -164,7 +164,7 @@ class Long extends DataEntry {
    * @returns {Buffer} The bytes representation of this data entry.
    */
   get bytes() {
-    return bp.packUInt64(this.data.bigInt);
+    return bp.packUInt64(this.data.data);
   }
 
   /**

src/model.js

@@ -12,6 +12,7 @@ import * as bn from './utils/big_number.js';
 import * as bp from './utils/bytes_packer.js';
 import * as hs from './utils/hashes.js';
 import * as curve from './utils/curve_25519.js';
+import * as crypto from './utils/crypto.js';
 import { WORDS_SET } from './words.js';
 
 /** Model is the base class for data models */
@@ -239,7 +240,7 @@ export class Seed extends Str {
       throw new Error('Password is required');
     }
     password = this.constructor.strengthenPassword(password, encryptionRounds);
-    return new EncryptedSeed(hs.aesEncrypt(this.data, password));
+    return new EncryptedSeed(crypto.aesEncrypt(this.data, password));
   }
 
   /**
@@ -276,7 +277,7 @@ export class EncryptedSeed extends Str {
       throw new Error('Password is required');
     }
     password = Seed.strengthenPassword(password, encryptionRounds);
-    return new Seed(hs.aesDecrypt(this.data, password));
+    return new Seed(crypto.aesDecrypt(this.data, password));
   }
 }
 
@@ -826,14 +827,6 @@ export class Long extends Model {
     super(data);
   }
 
-  /**
-   * bigInt returns the containing data in JavaScript built-in BigInt.
-   * @returns {BigInt}
-   */
-  get bigInt() {
-    return bn.toBigInt(this.data);
-  }
-
   /**
    * validate validates the instance.
    */

src/tx_req.js

@@ -95,9 +95,9 @@ export class PaymentTxReq extends TxReq {
     const cls = this.constructor;
     return Buffer.concat([
       cls.TX_TYPE.serialize(),
-      bp.packUInt64(this.timestamp.bigInt),
-      bp.packUInt64(this.amount.bigInt),
-      bp.packUInt64(this.fee.bigInt),
+      bp.packUInt64(this.timestamp.data),
+      bp.packUInt64(this.amount.data),
+      bp.packUInt64(this.fee.data),
       bp.packUInt16(cls.FEE_SCALE),
       this.recipient.bytes,
       bp.packUInt16(this.attachment.data.length),
@@ -162,9 +162,9 @@ export class RegCtrtTxReq extends TxReq {
       dataStack,
       bp.packUInt16(this.description.data.length),
       this.description.bytes,
-      bp.packUInt64(this.fee.bigInt),
+      bp.packUInt64(this.fee.data),
       bp.packUInt16(cls.FEE_SCALE),
-      bp.packUInt64(this.timestamp.bigInt),
+      bp.packUInt64(this.timestamp.data),
     ]);
   }
 
@@ -226,9 +226,9 @@ export class ExecCtrtFuncTxReq extends TxReq {
       dataStack,
       bp.packUInt16(this.attachment.data.length),
       this.attachment.bytes,
-      bp.packUInt64(this.fee.bigInt),
+      bp.packUInt64(this.fee.data),
       bp.packUInt16(cls.FEE_SCALE),
-      bp.packUInt64(this.timestamp.bigInt),
+      bp.packUInt64(this.timestamp.data),
     ]);
   }
 
@@ -281,10 +281,10 @@ export class LeaseTxReq extends TxReq {
     return Buffer.concat([
       cls.TX_TYPE.serialize(),
       this.supernodeAddr.bytes,
-      bp.packUInt64(this.amount.bigInt),
-      bp.packUInt64(this.fee.bigInt),
+      bp.packUInt64(this.amount.data),
+      bp.packUInt64(this.fee.data),
       bp.packUInt16(cls.FEE_SCALE),
-      bp.packUInt64(this.timestamp.bigInt),
+      bp.packUInt64(this.timestamp.data),
     ]);
   }
 
@@ -332,9 +332,9 @@ export class LeaseCancelReq extends TxReq {
 
     return Buffer.concat([
       cls.TX_TYPE.serialize(),
-      bp.packUInt64(this.fee.bigInt),
+      bp.packUInt64(this.fee.data),
       bp.packUInt16(cls.FEE_SCALE),
-      bp.packUInt64(this.timestamp.bigInt),
+      bp.packUInt64(this.timestamp.data),
       this.leasingTxId.bytes,
     ]);
   }

src/utils/big_number.js

@@ -7,12 +7,3 @@
 
 import jsBNPkg from 'bignumber.js';
 export const { BigNumber } = jsBNPkg;
-
-/**
- * toBigInt converts BigNumber to JS built-in BigInt
- * @param {BigNumber} bn - The BigNumber instance.
- * @returns {BigInt} The BigInt instance.
- */
-export function toBigInt(bn) {
-  return BigInt('0x' + bn.toString(16));
-}

src/utils/bytes_packer.js

@@ -7,6 +7,9 @@
 
 import { Buffer } from 'buffer';
 
+import jsBNPkg from 'bignumber.js';
+export const { BigNumber } = jsBNPkg;
+
 /**
  * packUInt8 packs the given integer into 1 byte
  * @param {number} val - The value to pack.
@@ -53,13 +56,21 @@ export function packUInt32(val) {
 
 /**
  * packUInt64 packs the given integer into 8 bytes in Big Endian order.
- * @param {BigInt} val - The value to pack.
+ * @param {BigNumber} val - The value to pack.
  * @returns {Buffer} The packing result.
  */
 export function packUInt64(val) {
-  const buf = Buffer.alloc(8);
-  buf.writeBigUInt64BE(val);
-  return buf;
+  let s = val.toString(16);
+  if (s.length < 16) {
+    let diff = 16 - s.length;
+    let prefix = '';
+    while (diff--) {
+      prefix = prefix + '0';
+    }
+    s = prefix + s;
+  }
+
+  return Buffer.from(s, 'hex');
 }
 
 /**
@@ -101,10 +112,11 @@ export function unpackUInt32(buf) {
 /**
  * unpackUInt64 unpacks the given 8-byte Buffer to an integer in Big Endian order.
  * @param {Buffer} buf - The 8-byte buffer to unpack.
- * @returns {BigInt} The unpacking result.
+ * @returns {BigNumber} The unpacking result.
  */
 export function unpackUInt64(buf) {
-  return buf.readUInt64BE(0);
+  const s = buf.toString('hex');
+  return new BigNumber(s, 16);
 }
 
 /**

src/utils/crypto.js

@@ -0,0 +1,29 @@
+/**
+ * module utils/crypto provides functionalities for cryptograhphy.
+ * @module utils/crypto
+ */
+
+'use strict';
+
+import encUtf8 from "crypto-js/enc-utf8.js"
+import AES from "crypto-js/aes.js";
+
+/**
+ * aesEncrypt encrypts the given data in AES.
+ * @param {string} data - The data to encrypt.
+ * @param {string} key - The key used to encrypt data.
+ * @returns {string} The encryption result
+*/
+export function aesEncrypt(data, key) {
+  return AES.encrypt(data, key).toString();
+}
+  
+/**
+ * aesDecrypt decrypts the given data encrypted by AES.
+ * @param {string} data - The data to decrypt.
+ * @param {string} key - The key used to decrypt data.
+ * @returns {string} The decryption result.
+ */
+export function aesDecrypt(data, key) {
+  return AES.decrypt(data, key).toString(encUtf8);
+}