@prosopo/datasets 0.2.0 → 0.2.2

package/dist/captcha/util.js

@@ -15,7 +15,7 @@ import { ProsopoEnvError } from '@prosopo/common';
 import client from 'axios';
 export async function downloadImage(url) {
     try {
-        return new Uint8Array((await client.default.get(url, { url, method: 'GET', responseType: 'arraybuffer' })).data);
+        return new Uint8Array((await client.get(url, { url, method: 'GET', responseType: 'arraybuffer' })).data);
     }
     catch (error) {
         // TODO fix/improve error handling

package/dist/captcha/util.js.map

@@ -1 +1 @@
-{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/captcha/util.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,MAAM,MAAM,OAAO,CAAA;AAE1B,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,GAAW;IAC3C,IAAI;QACA,OAAO,IAAI,UAAU,CACjB,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CAAc,GAAG,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,IAAI,CACzG,CAAA;KACJ;IAAC,OAAO,KAAK,EAAE;QACZ,kCAAkC;QAClC,MAAM,IAAI,eAAe,CAAC,KAAc,CAAC,CAAA;KAC5C;AACL,CAAC"}
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/captcha/util.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,MAAM,MAAM,OAAO,CAAA;AAE1B,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,GAAW;IAC3C,IAAI;QACA,OAAO,IAAI,UAAU,CACjB,CAAC,MAAM,MAAM,CAAC,GAAG,CAAc,GAAG,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,IAAI,CACjG,CAAA;KACJ;IAAC,OAAO,KAAK,EAAE;QACZ,kCAAkC;QAClC,MAAM,IAAI,eAAe,CAAC,KAAc,CAAC,CAAA;KAC5C;AACL,CAAC"}

package/dist/cjs/captcha/captcha.cjs

@@ -0,0 +1,147 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const types = require("@prosopo/types");
+const common = require("@prosopo/common");
+const util = require("@prosopo/util");
+const util$1 = require("./util.cjs");
+const util$2 = require("@polkadot/util");
+const NO_SOLUTION_VALUE = "NO_SOLUTION";
+function parseCaptchaDataset(datasetJSON) {
+  try {
+    const result = types.DatasetSchema.parse(datasetJSON);
+    const result2 = {
+      format: result.format,
+      captchas: result.captchas.map((captcha) => {
+        return {
+          ...captcha,
+          solution: captcha.solution || [],
+          unlabelled: captcha.unlabelled || []
+        };
+      })
+    };
+    if (result.datasetId !== void 0)
+      result2.datasetId = result.datasetId;
+    if (result.contentTree !== void 0)
+      result2.contentTree = result.contentTree;
+    if (result.datasetContentId !== void 0)
+      result2.datasetContentId = result.datasetContentId;
+    if (result.solutionTree !== void 0)
+      result2.solutionTree = result.solutionTree;
+    return result2;
+  } catch (err) {
+    throw new common.ProsopoEnvError(err);
+  }
+}
+function parseAndSortCaptchaSolutions(captchaJSON) {
+  try {
+    return types.CaptchaSolutionArraySchema.parse(captchaJSON).map((captcha) => ({
+      ...captcha,
+      solution: captcha.solution.sort()
+    }));
+  } catch (err) {
+    throw new common.ProsopoEnvError(err);
+  }
+}
+function captchaSort(a, b) {
+  return a.captchaId.localeCompare(b.captchaId);
+}
+function sortAndComputeHashes(received, stored) {
+  received.sort(captchaSort);
+  stored.sort(captchaSort);
+  return stored.map(({ salt, items = [], target = "", captchaId, solved }, index) => {
+    const item = util.at(received, index);
+    if (captchaId != item.captchaId) {
+      throw new common.ProsopoEnvError("CAPTCHA.ID_MISMATCH");
+    }
+    return {
+      hash: computeCaptchaHash(
+        {
+          solution: solved ? item.solution : [],
+          salt,
+          items,
+          target
+        },
+        true,
+        true,
+        false
+      ),
+      captchaId
+    };
+  });
+}
+function compareCaptchaSolutions(received, stored) {
+  if (received.length && stored.length && received.length === stored.length) {
+    const hashes = sortAndComputeHashes(received, stored);
+    return hashes.every(({ hash, captchaId }) => hash === captchaId);
+  }
+  return false;
+}
+function computeCaptchaHash(captcha, includeSolution = false, includeSalt = false, sortItemHashes) {
+  try {
+    const itemHashes = captcha.items.map((item, index) => {
+      if (item.hash) {
+        return item.hash;
+      } else {
+        throw new common.ProsopoEnvError("CAPTCHA.MISSING_ITEM_HASH", computeCaptchaHash.name, void 0, index);
+      }
+    });
+    return common.hexHashArray([
+      captcha.target,
+      // empty array hashes as empty string, undefined solution results in the array [`NO_SOLUTION`]
+      // [undefined] also hashes as empty string, which is why we don't use it
+      ...includeSolution ? getSolutionValueToHash(captcha.solution) : [],
+      includeSalt ? captcha.salt : "",
+      sortItemHashes ? itemHashes.sort() : itemHashes
+    ]);
+  } catch (err) {
+    throw new common.ProsopoEnvError(err);
+  }
+}
+function getSolutionValueToHash(solution) {
+  return solution !== void 0 ? solution.sort() : [NO_SOLUTION_VALUE];
+}
+async function computeItemHash(item) {
+  if (item.type === "text") {
+    return { ...item, hash: common.hexHash(item.data) };
+  } else if (item.type === "image") {
+    return { ...item, hash: common.hexHash(await util$1.downloadImage(item.data)) };
+  } else {
+    throw new common.ProsopoEnvError("CAPTCHA.INVALID_ITEM_FORMAT");
+  }
+}
+function matchItemsToSolutions(solutions, items) {
+  return (solutions == null ? void 0 : solutions.map((solution) => {
+    var _a;
+    const index = parseInt(solution.toString());
+    const hash = items && items[index] && (((_a = items[index]) == null ? void 0 : _a.hash) || solution);
+    if (!hash) {
+      throw new common.ProsopoEnvError("CAPTCHA.MISSING_ITEM_HASH");
+    }
+    if (!util$2.isHex(hash)) {
+      throw new common.ProsopoEnvError("CAPTCHA.INVALID_ITEM_HASH");
+    }
+    return hash;
+  })) || [];
+}
+function computeCaptchaSolutionHash(captcha) {
+  return common.hexHashArray([captcha.captchaId, captcha.captchaContentId, [...captcha.solution].sort(), captcha.salt]);
+}
+function computePendingRequestHash(captchaIds, userAccount, salt) {
+  return common.hexHashArray([...captchaIds.sort(), userAccount, salt]);
+}
+function parseCaptchaAssets(item, assetsResolver) {
+  return { ...item, path: (assetsResolver == null ? void 0 : assetsResolver.resolveAsset(item.data).getURL()) || item.data };
+}
+exports.NO_SOLUTION_VALUE = NO_SOLUTION_VALUE;
+exports.captchaSort = captchaSort;
+exports.compareCaptchaSolutions = compareCaptchaSolutions;
+exports.computeCaptchaHash = computeCaptchaHash;
+exports.computeCaptchaSolutionHash = computeCaptchaSolutionHash;
+exports.computeItemHash = computeItemHash;
+exports.computePendingRequestHash = computePendingRequestHash;
+exports.getSolutionValueToHash = getSolutionValueToHash;
+exports.matchItemsToSolutions = matchItemsToSolutions;
+exports.parseAndSortCaptchaSolutions = parseAndSortCaptchaSolutions;
+exports.parseCaptchaAssets = parseCaptchaAssets;
+exports.parseCaptchaDataset = parseCaptchaDataset;
+exports.sortAndComputeHashes = sortAndComputeHashes;

package/dist/cjs/captcha/dataset.cjs

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const merkle = require("./merkle.cjs");
+const common = require("@prosopo/common");
+const util = require("@prosopo/util");
+const captcha = require("./captcha.cjs");
+const logger = common.getLogger(`Info`, `dataset.ts`);
+async function hashDatasetItems(datasetRaw) {
+  return datasetRaw.captchas.map(async (captcha$1) => {
+    const items = await Promise.all(captcha$1.items.map(async (item) => captcha.computeItemHash(item)));
+    return {
+      ...captcha$1,
+      items
+    };
+  });
+}
+async function validateDatasetContent(datasetOriginal) {
+  const captchaPromises = await hashDatasetItems(datasetOriginal);
+  const captchas = await Promise.all(captchaPromises);
+  const dataset = {
+    ...datasetOriginal,
+    captchas
+  };
+  const hashes = dataset.captchas.map((captcha2) => {
+    const captchaRaw = datasetOriginal.captchas.find(
+      (captchaRaw2) => "captchaId" in captchaRaw2 ? captchaRaw2.captchaId === captcha2.captchaId : false
+    );
+    if (captchaRaw) {
+      return captcha2.items.every((item, index) => item.hash === util.at(captchaRaw.items, index).hash);
+    } else {
+      return false;
+    }
+  });
+  return hashes.every((hash) => hash);
+}
+async function buildDataset(datasetRaw) {
+  var _a, _b;
+  logger.info(`Adding solution hashes to dataset`);
+  const dataset = await addSolutionHashesToDataset(datasetRaw);
+  logger.info(`Building dataset merkle trees`);
+  const contentTree = await buildCaptchaTree(dataset, false, false, true);
+  const solutionTree = await buildCaptchaTree(dataset, true, true, false);
+  dataset.captchas = dataset.captchas.map(
+    (captcha2, index) => {
+      var _a2, _b2;
+      return {
+        ...captcha2,
+        captchaId: util.at(solutionTree.leaves, index).hash,
+        captchaContentId: util.at(contentTree.leaves, index).hash,
+        datasetId: (_a2 = solutionTree.root) == null ? void 0 : _a2.hash,
+        datasetContentId: (_b2 = contentTree.root) == null ? void 0 : _b2.hash
+      };
+    }
+  );
+  dataset.solutionTree = solutionTree.layers;
+  dataset.contentTree = contentTree.layers;
+  dataset.datasetId = (_a = solutionTree.root) == null ? void 0 : _a.hash;
+  dataset.datasetContentId = (_b = contentTree.root) == null ? void 0 : _b.hash;
+  return dataset;
+}
+async function buildCaptchaTree(dataset, includeSolution, includeSalt, sortItemHashes) {
+  try {
+    const tree = new merkle.CaptchaMerkleTree();
+    const datasetWithItemHashes = { ...dataset };
+    const captchaHashes = datasetWithItemHashes.captchas.map(
+      (captcha$1) => captcha.computeCaptchaHash(captcha$1, includeSolution, includeSalt, sortItemHashes)
+    );
+    tree.build(captchaHashes);
+    return tree;
+  } catch (err) {
+    throw new common.ProsopoEnvError("DATASET.HASH_ERROR");
+  }
+}
+async function addSolutionHashesToDataset(datasetRaw) {
+  const captchaPromises = datasetRaw.captchas.map(async (captcha$1) => {
+    return {
+      ...captcha$1,
+      items: captcha$1.items,
+      // some captcha challenges will not have a solution
+      ...captcha$1.solution !== void 0 && { solution: captcha.matchItemsToSolutions(captcha$1.solution, captcha$1.items) }
+    };
+  });
+  const captchas = await Promise.all(captchaPromises);
+  return {
+    ...datasetRaw,
+    captchas
+  };
+}
+exports.addSolutionHashesToDataset = addSolutionHashesToDataset;
+exports.buildCaptchaTree = buildCaptchaTree;
+exports.buildDataset = buildDataset;
+exports.hashDatasetItems = hashDatasetItems;
+exports.validateDatasetContent = validateDatasetContent;

package/dist/cjs/captcha/index.cjs

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const captcha = require("./captcha.cjs");
+const merkle = require("./merkle.cjs");
+const util = require("./util.cjs");
+const dataset = require("./dataset.cjs");
+exports.NO_SOLUTION_VALUE = captcha.NO_SOLUTION_VALUE;
+exports.captchaSort = captcha.captchaSort;
+exports.compareCaptchaSolutions = captcha.compareCaptchaSolutions;
+exports.computeCaptchaHash = captcha.computeCaptchaHash;
+exports.computeCaptchaSolutionHash = captcha.computeCaptchaSolutionHash;
+exports.computeItemHash = captcha.computeItemHash;
+exports.computePendingRequestHash = captcha.computePendingRequestHash;
+exports.getSolutionValueToHash = captcha.getSolutionValueToHash;
+exports.matchItemsToSolutions = captcha.matchItemsToSolutions;
+exports.parseAndSortCaptchaSolutions = captcha.parseAndSortCaptchaSolutions;
+exports.parseCaptchaAssets = captcha.parseCaptchaAssets;
+exports.parseCaptchaDataset = captcha.parseCaptchaDataset;
+exports.sortAndComputeHashes = captcha.sortAndComputeHashes;
+exports.CaptchaMerkleTree = merkle.CaptchaMerkleTree;
+exports.verifyProof = merkle.verifyProof;
+exports.downloadImage = util.downloadImage;
+exports.addSolutionHashesToDataset = dataset.addSolutionHashesToDataset;
+exports.buildCaptchaTree = dataset.buildCaptchaTree;
+exports.buildDataset = dataset.buildDataset;
+exports.hashDatasetItems = dataset.hashDatasetItems;
+exports.validateDatasetContent = dataset.validateDatasetContent;

package/dist/cjs/captcha/merkle.cjs

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const util = require("@prosopo/util");
+const common = require("@prosopo/common");
+class MerkleNode {
+  constructor(hash) {
+    this.hash = hash;
+    this.parent = null;
+  }
+}
+class CaptchaMerkleTree {
+  constructor() {
+    this.leaves = [];
+    this.layers = [];
+  }
+  build(leaves) {
+    if (this.layers.length) {
+      this.layers = [];
+    }
+    const layerZero = [];
+    for (const leaf of leaves) {
+      const node = new MerkleNode(leaf);
+      this.leaves.push(node);
+      layerZero.push(node.hash);
+    }
+    this.layers.push(layerZero);
+    this.root = this.buildMerkleTree(this.leaves)[0];
+  }
+  buildMerkleTree(leaves) {
+    const numLeaves = leaves.length;
+    if (numLeaves === 1) {
+      return leaves;
+    }
+    const parents = [];
+    let leafIndex = 0;
+    const newLayer = [];
+    while (leafIndex < numLeaves) {
+      const leftChild = leaves[leafIndex];
+      if (leftChild === void 0) {
+        throw new Error("leftChild undefined");
+      }
+      const rightChild = leafIndex + 1 < numLeaves ? util.at(leaves, leafIndex + 1) : leftChild;
+      const parentNode = this.createParent(leftChild, rightChild);
+      newLayer.push(parentNode.hash);
+      parents.push(parentNode);
+      leafIndex += 2;
+    }
+    this.layers.push(newLayer);
+    return this.buildMerkleTree(parents);
+  }
+  createParent(leftChild, rightChild) {
+    const parent = new MerkleNode(common.hexHashArray([leftChild.hash, rightChild.hash]));
+    leftChild.parent = parent.hash;
+    rightChild.parent = parent.hash;
+    return parent;
+  }
+  proof(leafHash) {
+    const proofTree = [];
+    let layerNum = 0;
+    while (layerNum < this.layers.length - 1) {
+      const layer = this.layers[layerNum];
+      if (layer === void 0) {
+        throw new Error("layer undefined");
+      }
+      const leafIndex = layer.indexOf(leafHash);
+      let partnerIndex = leafIndex % 2 && leafIndex > 0 ? leafIndex - 1 : leafIndex + 1;
+      if (partnerIndex > layer.length - 1) {
+        partnerIndex = leafIndex;
+      }
+      const pair = [leafHash];
+      const partner = util.at(layer, partnerIndex);
+      if (partnerIndex > leafIndex) {
+        pair.push(partner);
+      } else {
+        pair.unshift(partner);
+      }
+      proofTree.push([util.at(pair, 0), util.at(pair, 1)]);
+      layerNum += 1;
+      leafHash = common.hexHashArray(pair);
+    }
+    const last = util.at(this.layers, this.layers.length - 1);
+    return [...proofTree, [util.at(last, 0)]];
+  }
+}
+function verifyProof(leaf, proof) {
+  try {
+    if (util.at(proof, 0).indexOf(leaf) === -1) {
+      return false;
+    }
+    for (const [layerIndex, layer] of proof.entries()) {
+      leaf = common.hexHashArray(layer);
+      if (util.at(proof, layerIndex + 1).indexOf(leaf) === -1) {
+        return false;
+      }
+      const last = util.at(proof, proof.length - 1);
+      if (leaf === util.at(last, 0)) {
+        return true;
+      }
+    }
+    return false;
+  } catch (err) {
+    return false;
+  }
+}
+exports.CaptchaMerkleTree = CaptchaMerkleTree;
+exports.verifyProof = verifyProof;

package/dist/cjs/captcha/util.cjs

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const common = require("@prosopo/common");
+const client = require("axios");
+async function downloadImage(url) {
+  try {
+    return new Uint8Array(
+      (await client.get(url, { url, method: "GET", responseType: "arraybuffer" })).data
+    );
+  } catch (error) {
+    throw new common.ProsopoEnvError(error);
+  }
+}
+exports.downloadImage = downloadImage;

package/dist/cjs/index.cjs

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+require("./captcha/index.cjs");
+const captcha = require("./captcha/captcha.cjs");
+const merkle = require("./captcha/merkle.cjs");
+const util = require("./captcha/util.cjs");
+const dataset = require("./captcha/dataset.cjs");
+exports.NO_SOLUTION_VALUE = captcha.NO_SOLUTION_VALUE;
+exports.captchaSort = captcha.captchaSort;
+exports.compareCaptchaSolutions = captcha.compareCaptchaSolutions;
+exports.computeCaptchaHash = captcha.computeCaptchaHash;
+exports.computeCaptchaSolutionHash = captcha.computeCaptchaSolutionHash;
+exports.computeItemHash = captcha.computeItemHash;
+exports.computePendingRequestHash = captcha.computePendingRequestHash;
+exports.getSolutionValueToHash = captcha.getSolutionValueToHash;
+exports.matchItemsToSolutions = captcha.matchItemsToSolutions;
+exports.parseAndSortCaptchaSolutions = captcha.parseAndSortCaptchaSolutions;
+exports.parseCaptchaAssets = captcha.parseCaptchaAssets;
+exports.parseCaptchaDataset = captcha.parseCaptchaDataset;
+exports.sortAndComputeHashes = captcha.sortAndComputeHashes;
+exports.CaptchaMerkleTree = merkle.CaptchaMerkleTree;
+exports.verifyProof = merkle.verifyProof;
+exports.downloadImage = util.downloadImage;
+exports.addSolutionHashesToDataset = dataset.addSolutionHashesToDataset;
+exports.buildCaptchaTree = dataset.buildCaptchaTree;
+exports.buildDataset = dataset.buildDataset;
+exports.hashDatasetItems = dataset.hashDatasetItems;
+exports.validateDatasetContent = dataset.validateDatasetContent;

package/package.json

@@ -1,12 +1,13 @@
 {
     "name": "@prosopo/datasets",
-    "version": "0.2.0",
+    "version": "0.2.2",
     "author": "PROSOPO LIMITED <info@prosopo.io>",
     "license": "Apache-2.0",
     "private": false,
     "scripts": {
         "clean": "tsc --build --clean",
-        "build": "tsc --build --verbose",
+        "build": "tsc --build --verbose tsconfig.json",
+        "build:cjs": "npx vite --config vite.cjs.config.ts build",
         "lint": "npx eslint .",
         "lint:fix": "npx eslint . --fix --config ../../.eslintrc.js",
         "cli": "node ./dist/cli.js",
@@ -16,8 +17,10 @@
     "type": "module",
     "types": "./dist/index.d.ts",
     "exports": {
-        ".": "./dist/index.js",
-        "./types": "./dist/types/index.js",
+        ".": {
+            "import": "./dist/index.js",
+            "require": "./dist/cjs/index.cjs"
+        },
         "./captcha": "./dist/captcha/index.js"
     },
     "typesVersions": {
@@ -32,11 +35,11 @@
     },
     "dependencies": {
         "@polkadot/util": "^12.3.2",
-        "@prosopo/common": "0.2.0",
-        "@prosopo/contract": "0.2.0",
-        "@prosopo/types": "0.2.0",
-        "@prosopo/util": "0.2.0",
-        "axios": "^0.27.2"
+        "@prosopo/common": "0.2.2",
+        "@prosopo/contract": "0.2.2",
+        "@prosopo/types": "0.2.2",
+        "@prosopo/util": "0.2.2",
+        "axios": "^1.5.0"
     },
     "devDependencies": {
         "@types/mocha": "^10.0.0",

package/vite.cjs.config.ts

@@ -0,0 +1,6 @@
+import { ViteCommonJSConfig } from '@prosopo/config'
+import path from 'path'
+
+export default function () {
+    return ViteCommonJSConfig('datasets', path.resolve('./tsconfig.cjs.json'))
+}