@wishknish/knishio-client-js 0.5.2 → 0.6.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wishknish/knishio-client-js",
-  "version": "0.5.2",
+  "version": "0.6.1",
   "productName": "Knish.IO Javascript SDK Client",
   "description": "JavaScript implementation of the Knish.IO SDK to consume Knish.IO GraphQL APIs.",
   "license": "GPL-3.0-or-later",
@@ -17,17 +17,19 @@
     },
     {
       "name": "Vladimir Makarov",
-      "email": "vladimir.php@gmail.com",
+      "email": "vladimir@wishknish.com",
+      "homepage": "https://wishknish.com",
       "role": "developer"
     },
     {
       "name": "Yuri Kizilov",
-      "email": "y.kizilov.sev@yandex.ru",
+      "email": "yuriy@wishknish.com",
+      "homepage": "https://wishknish.com",
       "role": "developer"
     }
   ],
-  "main": "dist/client.umd.js",
-  "module": "dist/client.esm.js",
+  "main": "dist/client.iife.js",
+  "module": "dist/client.es.js",
   "commonjs": "dist/client.cjs.js",
   "keywords": [
     "wishknish",
@@ -38,71 +40,32 @@
     "graphql"
   ],
   "dependencies": {
-    "@apollo/client": "^3.5.10",
-    "@stablelib/base64": "^1.0.1",
-    "@stablelib/utf8": "^1.0.1",
-    "base-x": "^4.0.0",
-    "big-integer": "^1.6.51",
-    "buffer": "^6.0.3",
-    "core-js": "3.21.1",
-    "get-random-values": "^1.2.2",
-    "graphql": "^16.3.0",
+    "@noble/post-quantum": "^0.4.0",
+    "@thumbmarkjs/thumbmarkjs": "^0.19.1",
+    "@urql/core": "^5.1.0",
+    "graphql": "^16.10.0",
+    "graphql-ws": "^5.16.2",
     "isomorphic-fetch": "^3.0.0",
-    "js-sha3": "^0.8.0",
-    "pusher-js": "^7.0.6",
-    "tweetnacl": "^1.0.3",
-    "tweetnacl-sealedbox-js": "^1.2.0",
-    "uri-js": "^4.4.1"
+    "jssha": "^3.3.1",
+    "wonka": "^6.3.4"
   },
-  "files": [
-    "/src"
-  ],
   "devDependencies": {
-    "@babel/core": "^7.17.8",
-    "@babel/eslint-parser": "^7.17.0",
-    "@babel/eslint-plugin": "^7.17.7",
-    "@babel/plugin-external-helpers": "^7.16.7",
-    "@babel/plugin-proposal-class-properties": "^7.16.7",
-    "@babel/plugin-proposal-decorators": "^7.17.8",
-    "@babel/plugin-proposal-do-expressions": "^7.16.7",
-    "@babel/plugin-proposal-export-default-from": "^7.16.7",
-    "@babel/plugin-proposal-export-namespace-from": "^7.16.7",
-    "@babel/plugin-proposal-function-bind": "^7.16.7",
-    "@babel/plugin-proposal-function-sent": "^7.16.7",
-    "@babel/plugin-proposal-json-strings": "^7.16.7",
-    "@babel/plugin-proposal-logical-assignment-operators": "^7.16.7",
-    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.16.7",
-    "@babel/plugin-proposal-numeric-separator": "^7.16.7",
-    "@babel/plugin-proposal-optional-chaining": "^7.16.7",
-    "@babel/plugin-proposal-pipeline-operator": "^7.17.6",
-    "@babel/plugin-proposal-throw-expressions": "^7.16.7",
-    "@babel/plugin-syntax-dynamic-import": "^7.8.3",
-    "@babel/plugin-syntax-import-meta": "^7.10.4",
-    "@babel/plugin-transform-arrow-functions": "^7.16.7",
-    "@babel/plugin-transform-async-to-generator": "^7.16.8",
-    "@babel/plugin-transform-classes": "^7.16.7",
-    "@babel/plugin-transform-for-of": "^7.16.7",
-    "@babel/plugin-transform-property-mutators": "^7.16.7",
-    "@babel/plugin-transform-runtime": "^7.12.15",
-    "@babel/plugin-transform-shorthand-properties": "^7.12.13",
-    "@babel/preset-env": "^7.12.13",
-    "@babel/runtime": "^7.12.13",
-    "@rollup/plugin-babel": "^5.2.3",
-    "@rollup/plugin-commonjs": "^21.0.3",
-    "@rollup/plugin-inject": "^4.0.4",
-    "@rollup/plugin-node-resolve": "^13.0.0",
-    "@rollup/plugin-replace": "^4.0.0",
-    "babel-loader": "^8.2.4",
-    "eslint": "^8.12.0",
-    "eslint-plugin-vue": "^8.6.0",
-    "nodemon": "^2.0.15",
-    "rollup": "^2.70.1",
-    "rollup-plugin-peer-deps-external": "^2.2.4",
-    "rollup-plugin-terser": "^7.0.2",
-    "uglify-js": "^3.15.3",
-    "webpack": "^5.71.0",
-    "webpack-cli": "^4.9.2",
-    "webpack-merge": "^5.8.0"
+    "@jest/globals": "^29.7.0",
+    "@rollup/plugin-babel": "^6.0.4",
+    "@rollup/plugin-commonjs": "^25.0.8",
+    "@rollup/plugin-node-resolve": "^15.3.1",
+    "esbuild-jest": "^0.5.0",
+    "eslint": "^8.57.1",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-promise": "^6.6.0",
+    "eslint-plugin-vue": "^9.32.0",
+    "esmock": "^2.7.0",
+    "jest": "^29.7.0",
+    "rollup": "^4.34.6",
+    "vite": "^5.4.14",
+    "vite-plugin-node-polyfills": "^0.23.0"
   },
   "browserslist": [
     "> 1%",
@@ -110,17 +73,12 @@
     "not ie <= 8"
   ],
   "scripts": {
-    "build": "yarn build:es && yarn build:umd && yarn build:cjs",
-    "build:es": "rollup --config build/rollup.config.es.js",
-    "build:umd": "rollup --config build/rollup.config.umd.js",
-    "build:cjs": "rollup --config build/rollup.config.cjs.js",
-    "dev": "nodemon --exec \"yarn build:es && yarn build:umd && yarn build:cjs\" --watch",
-    "build:webpack:dev": "webpack --mode development --watch --stats-colors --profile --stats-error-details",
-    "build:webpack:dev:sub": "webpack --mode development --watch --stats-colors --profile --config ./webpack.config.sub.js",
-    "build:webpack": "webpack --mode production --progress --stats-colors --profile",
-    "lint": "eslint --ext .js src"
+    "build": "vite build --config build/vite.config.mjs",
+    "lint": "eslint --ext .js src",
+    "test": "jest",
+    "test:coverage": "jest --coverage"
   },
-  "nodemonConfig": {
-    "delay": 5500
-  }
+  "files": [
+    "/src"
+  ]
 }

package/src/.babelrc

@@ -10,25 +10,12 @@
   "plugins" : [
     "@babel/plugin-proposal-function-bind",
     "@babel/plugin-proposal-export-default-from",
-    "@babel/plugin-proposal-logical-assignment-operators",
-    [
-      "@babel/plugin-proposal-optional-chaining",
-      {
-        "loose" : false
-      }
-    ],
     [
       "@babel/plugin-proposal-pipeline-operator",
       {
         "proposal" : "minimal"
       }
     ],
-    [
-      "@babel/plugin-proposal-nullish-coalescing-operator",
-      {
-        "loose" : false
-      }
-    ],
     "@babel/plugin-proposal-do-expressions",
     [
       "@babel/plugin-proposal-decorators",
@@ -37,18 +24,9 @@
       }
     ],
     "@babel/plugin-proposal-function-sent",
-    "@babel/plugin-proposal-export-namespace-from",
-    "@babel/plugin-proposal-numeric-separator",
     "@babel/plugin-proposal-throw-expressions",
     "@babel/plugin-syntax-dynamic-import",
     "@babel/plugin-syntax-import-meta",
-    [
-      "@babel/plugin-proposal-class-properties",
-      {
-        "loose" : false
-      }
-    ],
-    "@babel/plugin-proposal-json-strings",
     "@babel/plugin-transform-property-mutators",
     "@babel/plugin-transform-shorthand-properties",
     "@babel/plugin-transform-for-of",

package/src/Atom.js

@@ -45,35 +45,17 @@ Please visit https://github.com/WishKnish/KnishIO-Client-JS for information.
 
 License: https://github.com/WishKnish/KnishIO-Client-JS/blob/master/LICENSE
 */
-import { shake256 } from 'js-sha3';
-import { charsetBaseConvert } from './libraries/strings';
-import Meta from './Meta';
-import AtomMeta from './AtomMeta';
+import JsSHA from 'jssha'
+import { charsetBaseConvert } from './libraries/strings'
+import Meta from './Meta'
+import AtomMeta from './AtomMeta'
+import AtomsMissingException from './exception/AtomsMissingException'
+import versions from './versions/index'
 
 /**
  * Atom class used to form microtransactions within a Molecule
  */
 export default class Atom {
-
-  /**
-   *
-   * @returns {string[]}
-   */
-  static getHashableProps () {
-    return [
-      'position',
-      'walletAddress',
-      'isotope',
-      'token',
-      'value',
-      'batchId',
-      'metaType',
-      'metaId',
-      'meta',
-      'createdAt'
-    ];
-  }
-
   /**
    * Class constructor
    *
@@ -88,8 +70,9 @@ export default class Atom {
    * @param {array|object|null} meta
    * @param {string|null} otsFragment
    * @param {number|null} index
+   * @param {string|null} version
    */
-  constructor ( {
+  constructor ({
     position = null,
     walletAddress = null,
     isotope = null,
@@ -100,37 +83,69 @@ export default class Atom {
     metaId = null,
     meta = null,
     otsFragment = null,
-    index = null
-  } ) {
-    this.position = position;
-    this.walletAddress = walletAddress;
-    this.isotope = isotope;
-    this.token = token;
-    this.value = null !== value ? String( value ) : null;
-    this.batchId = batchId;
-
-    this.metaType = metaType;
-    this.metaId = metaId;
-    this.meta = meta ? Meta.normalizeMeta( meta ) : [];
-
-    this.index = index;
-    this.otsFragment = otsFragment;
-    this.createdAt = String( +new Date );
+    index = null,
+    version = null
+  }) {
+    this.position = position
+    this.walletAddress = walletAddress
+    this.isotope = isotope
+    this.token = token
+    this.value = value !== null ? String(value) : null
+    this.batchId = batchId
+
+    this.metaType = metaType
+    this.metaId = metaId
+    this.meta = meta ? Meta.normalizeMeta(meta) : []
+
+    this.index = index
+    this.otsFragment = otsFragment
+    this.createdAt = String(+new Date())
+    if (version !== null && Object.prototype.hasOwnProperty.call(versions, version)) {
+      this.version = String(version)
+    }
   }
 
+  /**
+   *
+   * @returns {string[]}
+   */
+  static getHashableProps () {
+    return [
+      'position',
+      'walletAddress',
+      'isotope',
+      'token',
+      'value',
+      'batchId',
+      'metaType',
+      'metaId',
+      'meta',
+      'createdAt'
+    ]
+  }
+
+  /**
+   *
+   * @returns {string[]}
+   */
+  static getUnclaimedProps () {
+    return [
+      'otsFragment'
+    ]
+  }
 
   /**
    *
-   * @param isotope
-   * @param wallet
-   * @param value
-   * @param metaType
-   * @param metaId
-   * @param meta
-   * @param batchId
+   * @param {string} isotope
+   * @param {Wallet|null} wallet
+   * @param {int|null} value
+   * @param {string|null} metaType
+   * @param {string|null} metaId
+   * @param {AtomMeta|array|object|null} meta
+   * @param {string|null} batchId
    * @returns {Atom}
    */
-  static create( {
+  static create ({
     isotope,
     wallet = null,
     value = null,
@@ -138,26 +153,30 @@ export default class Atom {
     metaId = null,
     meta = null,
     batchId = null
-  } ) {
+  }) {
     // If meta object is not passed - create it
-    if ( !meta ) {
-      meta = new AtomMeta;
+    if (!meta) {
+      meta = new AtomMeta()
     }
 
-    // If wallet has been passed => add related metas
-    if ( wallet ) {
+    // If meta object is not an instance of AtomMeta - create it from meta
+    if (!(meta instanceof AtomMeta)) {
+      meta = new AtomMeta(meta)
+    }
 
+    // If wallet has been passed => add related metas
+    if (wallet) {
       // Add wallet's meta
-      meta.addWallet( wallet );
+      meta.setAtomWallet(wallet)
 
       // If batch ID does not passed: set it from the wallet
-      if ( !batchId ) {
-        batchId = wallet.batchId;
+      if (!batchId) {
+        batchId = wallet.batchId
       }
     }
 
     // Create the final atom's object
-    return new Atom( {
+    return new Atom({
       position: wallet ? wallet.position : null,
       walletAddress: wallet ? wallet.address : null,
       isotope,
@@ -167,14 +186,7 @@ export default class Atom {
       metaType,
       metaId,
       meta: meta.get()
-    } );
-  }
-
-  /**
-   * Get aggregated meta from stored normalized ones
-   */
-  aggregatedMeta () {
-    return Meta.aggregateMeta( this.meta );
+    })
   }
 
   /**
@@ -183,49 +195,17 @@ export default class Atom {
    * @param {string} json
    * @return {object}
    */
-  static jsonToObject ( json ) {
-
-    const target = Object.assign( new Atom( {} ), JSON.parse( json ) ),
-      properties = Object.keys( new Atom( {} ) );
+  static jsonToObject (json) {
+    const target = Object.assign(new Atom({}), JSON.parse(json))
+    const properties = Object.keys(new Atom({}))
 
-    for ( const property in target ) {
-      if ( target.hasOwnProperty( property ) && !properties.includes( property ) ) {
-        delete target[ property ];
+    for (const property in target) {
+      if (Object.prototype.hasOwnProperty.call(target, property) && !properties.includes(property)) {
+        delete target[property]
       }
     }
 
-    return target;
-  }
-
-  /**
-   *
-   * @returns {*[]}
-   */
-  getHashableValues() {
-    const hashableValues = [];
-    for ( let property of Atom.getHashableProps() ) {
-      const value = this[ property ];
-
-      // All nullable values are not hashed (only custom keys)
-      if ( value === null && ![ 'position', 'walletAddress' ].includes( property ) ) {
-        continue;
-      }
-
-      // Hashing individual meta keys and values
-      if ( property === 'meta' ) {
-        for ( const meta of value ) {
-          if ( typeof meta.value !== 'undefined' && meta.value !== null ) {
-            hashableValues.push( String( meta.key ) );
-            hashableValues.push( String( meta.value ) );
-          }
-        }
-      }
-      // Default value
-      else {
-        hashableValues.push( value === null ? '' : String( value ) );
-      }
-    }
-    return hashableValues;
+    return target
   }
 
   /**
@@ -236,59 +216,118 @@ export default class Atom {
    * @param {string} output
    * @return {number[]|*}
    */
-  static hashAtoms ( {
+  static hashAtoms ({
     atoms,
     output = 'base17'
-  } ) {
-
-    const molecularSponge = shake256.create( 256 ),
-      numberOfAtoms = atoms.length,
-      atomList = Atom.sortAtoms( atoms );
+  }) {
+    const molecularSponge = new JsSHA('SHAKE256', 'TEXT')
+    const atomList = Atom.sortAtoms(atoms)
 
-    // Hashing each atom in the molecule to produce a molecular hash
-    let hashableValues = [];
-    for ( const atom of atomList ) {
+    if (atomList.length === 0) {
+      throw new AtomsMissingException()
+    }
 
-      // Add number of atoms (???)
-      hashableValues.push( String( numberOfAtoms ) );
+    atomList.map(atom => {
+      if (!(atom instanceof Atom)) {
+        throw new AtomsMissingException()
+      }
+      return atom
+    })
 
-      // Add atom's properties
-      hashableValues = hashableValues.concat( atom.getHashableValues() );
-    }
+    // Hashing each atom in the molecule to produce a molecular hash
+    if (atomList.every(atom => atom.version && Object.prototype.hasOwnProperty.call(versions, atom.version))) {
+      molecularSponge.update(JSON.stringify(atomList.map(atom => versions[atom.version].create(atom).view())))
+    } else {
+      const numberOfAtoms = String(atoms.length)
+      let hashableValues = []
+
+      for (const atom of atomList) {
+        // Add number of atoms (???)
+        hashableValues.push(numberOfAtoms)
+
+        // Add atom's properties
+        hashableValues = hashableValues.concat(atom.getHashableValues())
+      }
 
-    // Add hash values to the sponge
-    for ( const hashableValue of hashableValues ) {
-      molecularSponge.update( hashableValue );
+      // Add hash values to the sponge
+      for (const hashableValue of hashableValues) {
+        molecularSponge.update(hashableValue)
+      }
     }
 
     // Return the hash in the requested format
-    switch ( output ) {
+    switch (output) {
       case 'hex': {
-        return molecularSponge.hex();
+        return molecularSponge.getHash('HEX', { outputLen: 256 })
       }
       case 'array': {
-        return molecularSponge.array();
+        return molecularSponge.getHash('ARRAYBUFFER', { outputLen: 256 })
       }
       default: {
-        return charsetBaseConvert( molecularSponge.hex(), 16, 17, '0123456789abcdef', '0123456789abcdefg' ).padStart( 64, '0' );
+        return charsetBaseConvert(molecularSponge.getHash('HEX', { outputLen: 256 }), 16, 17, '0123456789abcdef', '0123456789abcdefg').padStart(64, '0')
       }
     }
   }
 
+  static jsonSerialization (key, value) {
+    if (!Atom.getUnclaimedProps().includes(key)) {
+      return value
+    }
+
+    return undefined
+  }
+
   /**
    * Sort the atoms in a Molecule
    *
    * @param {array} atoms
    * @return {array}
    */
-  static sortAtoms ( atoms ) {
-    const atomList = [ ...atoms ];
+  static sortAtoms (atoms) {
+    const atomList = [...atoms]
 
     // Sort based on atomic index
-    atomList.sort( ( first, second ) => {
-      return first.index < second.index ? -1 : 1;
-    } );
+    atomList.sort((first, second) => {
+      return first.index < second.index ? -1 : 1
+    })
+
+    return atomList
+  }
+
+  /**
+   * Get aggregated meta from stored normalized ones
+   */
+  aggregatedMeta () {
+    return Meta.aggregateMeta(this.meta)
+  }
 
-    return atomList;
+  /**
+   *
+   * @returns {*[]}
+   */
+  getHashableValues () {
+    const hashableValues = []
+    for (const property of Atom.getHashableProps()) {
+      const value = this[property]
+
+      // All nullable values are not hashed (only custom keys)
+      if (value === null && !['position', 'walletAddress'].includes(property)) {
+        continue
+      }
+
+      // Hashing individual meta keys and values
+      if (property === 'meta') {
+        for (const meta of value) {
+          if (typeof meta.value !== 'undefined' && meta.value !== null) {
+            hashableValues.push(String(meta.key))
+            hashableValues.push(String(meta.value))
+          }
+        }
+      } else {
+        // Default value
+        hashableValues.push(value === null ? '' : String(value))
+      }
+    }
+    return hashableValues
   }
 }