@matrix-privacy/wallet 0.0.1

package/.eslintrc.js

@@ -0,0 +1,73 @@
+module.exports = {
+  root: true,
+  env: {
+    node: true,
+    es6: true,
+    mocha: true,
+  },
+  extends: [
+    'eslint:recommended',
+    'airbnb-base',
+    'plugin:import/typescript',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+    'prettier',
+  ],
+  globals: {
+    Optional: 'readonly',
+    MapType: 'readonly',
+    BigInt: 'readonly',
+  },
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 13,
+    sourceType: 'module',
+    project: ['./tsconfig.json', './tsconfig.test.json'],
+  },
+  plugins: ['@typescript-eslint', 'no-only-tests'],
+  rules: {
+    'arrow-body-style': 0,
+    'import/extensions': 0,
+    'no-unused-vars': 0,
+    'no-use-before-define': 0,
+    'import/prefer-default-export': 0,
+    'import/no-unresolved': 0,
+    'no-restricted-syntax': 0,
+    'no-unused-expressions': 0,
+    'no-shadow': 0,
+    'no-continue': 0,
+    'no-console': 1,
+    'default-case': 0,
+    '@typescript-eslint/switch-exhaustiveness-check': 2,
+    '@typescript-eslint/no-explicit-any': 1,
+    '@typescript-eslint/ban-ts-comment': 0,
+    '@typescript-eslint/no-unused-vars': 1,
+    '@typescript-eslint/no-unsafe-call': 1,
+    '@typescript-eslint/no-unsafe-member-access': 1,
+    '@typescript-eslint/no-unsafe-assignment': 1,
+    '@typescript-eslint/no-unsafe-argument': 1,
+    '@typescript-eslint/no-unsafe-return': 1,
+    '@typescript-eslint/require-await': 0,
+    'import/order': 0,
+    'consistent-return': 0,
+    'prefer-destructuring': 0,
+    'lines-between-class-members': 0,
+    '@typescript-eslint/no-empty-function': 0,
+    'no-promise-executor-return': 0,
+    '@typescript-eslint/no-floating-promises': 2,
+    '@typescript-eslint/no-non-null-assertion': 2,
+    'no-warning-comments': 1,
+    '@typescript-eslint/no-duplicate-enum-values': 1,
+    'no-only-tests/no-only-tests': 1,
+    '@typescript-eslint/strict-boolean-expressions': 2,
+  },
+  overrides: [
+    {
+      files: ['**/__tests__/**', './src/tests/**'],
+      rules: {
+        '@typescript-eslint/no-explicit-any': 0,
+        '@typescript-eslint/no-unsafe-member-access': 0,
+      },
+    },
+  ],
+};

package/.prettierrc.js

@@ -0,0 +1,21 @@
+module.exports = {
+  default: true,
+  'editor.formatOnSave': true,
+  'eslint.autoFixOnSave': true,
+  bracketSpacing: true,
+  singleQuote: true,
+  trailingComma: 'all',
+  arrowParens: 'avoid',
+  'eslint.validate': [
+    'javascript',
+    'javascriptreact',
+    {
+      language: 'typescript',
+      autoFix: true,
+    },
+    {
+      language: 'typescriptreact',
+      autoFix: true,
+    },
+  ],
+};

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 MATRIX Project Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,7 @@
+# MATRIX Wallet SDK
+
+The MATRIX Wallet SDK is an open-source project developed by [MATRIX] contributors.
+
+The Wallet SDK enables dApp and DeFi developers to provide privacy to users safely and conveniently on Ethereum, Polygon and BNB Chain.
+
+The repo is written in TypeScript, and compatible with node.js and modern web browsers.

package/dist/__tests__/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/index.test.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const index_1 = __importDefault(require("../index"));
+describe('index', () => {
+    it('Should load main for test', async () => {
+        (0, chai_1.expect)(index_1.default).to.deep.equal({});
+    });
+});
+//# sourceMappingURL=index.test.js.map

package/dist/__tests__/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../../src/__tests__/index.test.ts"],"names":[],"mappings":";;;;;AAAA,+BAA8B;AAC9B,qDAA6B;AAE7B,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACrB,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,IAAA,aAAM,EAAC,eAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { expect } from 'chai';\nimport index from '../index';\n\ndescribe('index', () => {\n  it('Should load main for test', async () => {\n    expect(index).to.deep.equal({});\n  });\n});\n"]}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './services';
+export * from './utils';
+declare const _default: {};
+export default _default;

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./services"), exports);
+__exportStar(require("./utils"), exports);
+exports.default = {};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,0CAAwB;AAExB,kBAAe,EAAE,CAAC","sourcesContent":["export * from './services';\nexport * from './utils';\n\nexport default {};\n"]}

package/dist/services/artifacts/__tests__/artifact-downloader.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/services/artifacts/__tests__/artifact-downloader.test.js

@@ -0,0 +1,172 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/// <reference types="../../../types/global" />
+const chai_1 = __importDefault(require("chai"));
+const chai_as_promised_1 = __importDefault(require("chai-as-promised"));
+const shared_models_1 = require("@matrix-privacy/shared-models");
+const setup_test_1 = require("../../../tests/setup.test");
+const artifacts_1 = require("../../matrix/core/artifacts");
+const artifact_util_1 = require("../artifact-util");
+chai_1.default.use(chai_as_promised_1.default);
+const { expect } = chai_1.default;
+describe('artifact-downloader', () => {
+    before(async () => {
+        const useNativeArtifacts = false;
+        await (0, setup_test_1.initTestEngine)(useNativeArtifacts);
+    });
+    it('Should set and get artifacts', async () => {
+        (0, artifacts_1.setUseNativeArtifacts)(false);
+        (0, artifacts_1.clearArtifactCache)();
+        const inputs11By2 = {
+            nullifiers: [
+                BigInt(1),
+                BigInt(1),
+                BigInt(1),
+                BigInt(1),
+                BigInt(1),
+                BigInt(1),
+                BigInt(1),
+                BigInt(1),
+                BigInt(1),
+                BigInt(1),
+                BigInt(1),
+            ],
+            merkleRoot: BigInt(0),
+            boundParamsHash: BigInt(0),
+            commitmentsOut: [BigInt(0), BigInt(1)],
+        };
+        await expect(artifacts_1.artifactGetterDownloadJustInTime.getArtifacts(inputs11By2)).to.be.rejectedWith('No artifacts for inputs: 11-2');
+        const mockArtifact = {
+            [shared_models_1.ArtifactName.ZKEY]: Buffer.from('123'),
+            [shared_models_1.ArtifactName.WASM]: Buffer.from('456'),
+            [shared_models_1.ArtifactName.DAT]: undefined,
+            [shared_models_1.ArtifactName.VKEY]: { data: '789' },
+        };
+        const artifactVariantString2by2 = (0, artifact_util_1.getArtifactVariantString)(2, 2);
+        (0, artifacts_1.overrideArtifact)(artifactVariantString2by2, mockArtifact);
+        // Pre-set in test.
+        const inputs2By2 = {
+            nullifiers: [BigInt(1), BigInt(2)],
+            merkleRoot: BigInt(0),
+            boundParamsHash: BigInt(0),
+            commitmentsOut: [BigInt(0), BigInt(1)],
+        };
+        await expect(artifacts_1.artifactGetterDownloadJustInTime.getArtifacts(inputs2By2)).to
+            .be.fulfilled;
+    });
+    it('Should download artifacts - snarkjs', async () => {
+        (0, artifacts_1.setUseNativeArtifacts)(false);
+        (0, artifacts_1.clearArtifactCache)();
+        // Requires download.
+        const inputs = {
+            nullifiers: [
+                BigInt(1),
+                BigInt(1),
+                BigInt(1),
+                BigInt(1),
+                BigInt(1),
+                BigInt(1),
+                BigInt(1),
+                BigInt(1),
+            ],
+            merkleRoot: BigInt(0),
+            boundParamsHash: BigInt(0),
+            commitmentsOut: [BigInt(0), BigInt(1)],
+        };
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        const artifacts = await artifacts_1.artifactGetterDownloadJustInTime.getArtifacts(inputs);
+        expect(artifacts.vkey).to.not.be.undefined;
+        expect(artifacts.zkey).to.not.be.undefined;
+        expect(artifacts.wasm).to.not.be.undefined;
+        expect(artifacts.dat).to.be.undefined;
+        const cached = artifacts_1.artifactCache['08x02'];
+        expect(cached?.vkey).to.not.be.undefined;
+        expect(cached?.zkey).to.not.be.undefined;
+        expect(cached?.wasm).to.not.be.undefined;
+        expect(cached?.dat).to.be.undefined;
+    }).timeout(30000);
+    it('Should download artifacts - native', async () => {
+        (0, artifacts_1.setUseNativeArtifacts)(true);
+        (0, artifacts_1.clearArtifactCache)();
+        // Requires download.
+        const inputs = {
+            nullifiers: [
+                BigInt(1),
+                BigInt(1),
+                BigInt(1),
+                BigInt(1),
+                BigInt(1),
+                BigInt(1),
+            ],
+            merkleRoot: BigInt(0),
+            boundParamsHash: BigInt(0),
+            commitmentsOut: [BigInt(0), BigInt(1), BigInt(1)],
+        };
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        const artifacts = await artifacts_1.artifactGetterDownloadJustInTime.getArtifacts(inputs);
+        expect(artifacts.vkey).to.not.be.undefined;
+        expect(artifacts.zkey).to.not.be.undefined;
+        expect(artifacts.wasm).to.be.undefined;
+        expect(artifacts.dat).to.not.be.undefined;
+        const cached = artifacts_1.artifactCache['06x03'];
+        expect(cached?.vkey).to.not.be.undefined;
+        expect(cached?.zkey).to.not.be.undefined;
+        expect(cached?.wasm).to.be.undefined;
+        expect(cached?.dat).to.not.be.undefined;
+    }).timeout(30000);
+    // Skipped because we don't want to run this on every build.
+    it.skip('Should download ALL artifacts - native and nodejs', async () => {
+        (0, artifacts_1.setUseNativeArtifacts)(true);
+        (0, artifacts_1.clearArtifactCache)();
+        for (let i = 1; i <= 10; i += 1) {
+            for (let j = 1; j <= 3; j += 1) {
+                if (i === 10 && j === 5) {
+                    continue;
+                }
+                // console.log(`NATIVE: ${i}x${j}...`);
+                const inputs = {
+                    nullifiers: new Array(i),
+                    merkleRoot: BigInt(0),
+                    boundParamsHash: BigInt(0),
+                    commitmentsOut: new Array(j),
+                };
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                const artifacts = 
+                // eslint-disable-next-line no-await-in-loop
+                await artifacts_1.artifactGetterDownloadJustInTime.getArtifacts(inputs);
+                expect(artifacts.vkey).to.not.be.undefined;
+                expect(artifacts.zkey).to.not.be.undefined;
+                expect(artifacts.wasm).to.be.undefined;
+                expect(artifacts.dat).to.not.be.undefined;
+            }
+        }
+        (0, artifacts_1.clearArtifactCache)();
+        (0, artifacts_1.setUseNativeArtifacts)(false);
+        for (let i = 1; i <= 10; i += 1) {
+            for (let j = 1; j <= 5; j += 1) {
+                if (i === 10 && j === 5) {
+                    continue;
+                }
+                // console.log(`NODEJS: ${i}x${j}...`);
+                const inputs = {
+                    nullifiers: new Array(i),
+                    merkleRoot: BigInt(0),
+                    boundParamsHash: BigInt(0),
+                    commitmentsOut: new Array(j),
+                };
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                const artifacts = 
+                // eslint-disable-next-line no-await-in-loop
+                await artifacts_1.artifactGetterDownloadJustInTime.getArtifacts(inputs);
+                expect(artifacts.vkey).to.not.be.undefined;
+                expect(artifacts.zkey).to.not.be.undefined;
+                expect(artifacts.wasm).to.not.be.undefined;
+                expect(artifacts.dat).to.be.undefined;
+            }
+        }
+    }).timeout(30000);
+});
+//# sourceMappingURL=artifact-downloader.test.js.map

package/dist/services/artifacts/__tests__/artifact-downloader.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"artifact-downloader.test.js","sourceRoot":"","sources":["../../../../src/services/artifacts/__tests__/artifact-downloader.test.ts"],"names":[],"mappings":";;;;;AAAA,+CAA+C;AAC/C,gDAAwB;AACxB,wEAA8C;AAC9C,iEAAuE;AACvE,0DAA2D;AAC3D,2DAMqC;AAErC,oDAA4D;AAE5D,cAAI,CAAC,GAAG,CAAC,0BAAc,CAAC,CAAC;AACzB,MAAM,EAAE,MAAM,EAAE,GAAG,cAAI,CAAC;AAExB,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,MAAM,CAAC,KAAK,IAAI,EAAE;QAChB,MAAM,kBAAkB,GAAG,KAAK,CAAC;QACjC,MAAM,IAAA,2BAAc,EAAC,kBAAkB,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;QAC5C,IAAA,iCAAqB,EAAC,KAAK,CAAC,CAAC;QAE7B,IAAA,8BAAkB,GAAE,CAAC;QAErB,MAAM,WAAW,GAAuB;YACtC,UAAU,EAAE;gBACV,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;aACV;YACD,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;YACrB,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC;YAC1B,cAAc,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;SACvC,CAAC;QACF,MAAM,MAAM,CACV,4CAAgC,CAAC,YAAY,CAAC,WAAW,CAAC,CAC3D,CAAC,EAAE,CAAC,EAAE,CAAC,YAAY,CAAC,+BAA+B,CAAC,CAAC;QAEtD,MAAM,YAAY,GAAa;YAC7B,CAAC,4BAAY,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;YACvC,CAAC,4BAAY,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;YACvC,CAAC,4BAAY,CAAC,GAAG,CAAC,EAAE,SAAS;YAC7B,CAAC,4BAAY,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;SACrC,CAAC;QACF,MAAM,yBAAyB,GAAG,IAAA,wCAAwB,EAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACjE,IAAA,4BAAgB,EAAC,yBAAyB,EAAE,YAAY,CAAC,CAAC;QAE1D,mBAAmB;QACnB,MAAM,UAAU,GAAuB;YACrC,UAAU,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;YAClC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;YACrB,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC;YAC1B,cAAc,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;SACvC,CAAC;QACF,MAAM,MAAM,CAAC,4CAAgC,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE;aACvE,EAAE,CAAC,SAAS,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACnD,IAAA,iCAAqB,EAAC,KAAK,CAAC,CAAC;QAE7B,IAAA,8BAAkB,GAAE,CAAC;QAErB,qBAAqB;QACrB,MAAM,MAAM,GAAuB;YACjC,UAAU,EAAE;gBACV,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;aACV;YACD,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;YACrB,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC;YAC1B,cAAc,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;SACvC,CAAC;QAEF,mEAAmE;QACnE,MAAM,SAAS,GACb,MAAM,4CAAgC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAE9D,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;QAC3C,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;QAC3C,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;QAC3C,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QAEtC,MAAM,MAAM,GAAG,yBAAa,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;QACzC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;QACzC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;QACzC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IACtC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAM,CAAC,CAAC;IAEnB,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAClD,IAAA,iCAAqB,EAAC,IAAI,CAAC,CAAC;QAE5B,IAAA,8BAAkB,GAAE,CAAC;QAErB,qBAAqB;QACrB,MAAM,MAAM,GAAuB;YACjC,UAAU,EAAE;gBACV,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;gBACT,MAAM,CAAC,CAAC,CAAC;aACV;YACD,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;YACrB,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC;YAC1B,cAAc,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;SAClD,CAAC;QAEF,mEAAmE;QACnE,MAAM,SAAS,GACb,MAAM,4CAAgC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAE9D,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;QAC3C,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;QAC3C,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QACvC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;QAE1C,MAAM,MAAM,GAAG,yBAAa,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;QACzC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;QACzC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QACrC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;IAC1C,CAAC,CAAC,CAAC,OAAO,CAAC,KAAM,CAAC,CAAC;IAEnB,4DAA4D;IAC5D,EAAE,CAAC,IAAI,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACtE,IAAA,iCAAqB,EAAC,IAAI,CAAC,CAAC;QAE5B,IAAA,8BAAkB,GAAE,CAAC;QAErB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE;YAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE;gBAC9B,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE;oBACvB,SAAS;iBACV;gBAED,uCAAuC;gBAEvC,MAAM,MAAM,GAAuB;oBACjC,UAAU,EAAE,IAAI,KAAK,CAAS,CAAC,CAAC;oBAChC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;oBACrB,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC;oBAC1B,cAAc,EAAE,IAAI,KAAK,CAAS,CAAC,CAAC;iBACrC,CAAC;gBAEF,mEAAmE;gBACnE,MAAM,SAAS;gBACb,4CAA4C;gBAC5C,MAAM,4CAAgC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;gBAE9D,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;gBAC3C,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;gBAC3C,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;gBACvC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;aAC3C;SACF;QAED,IAAA,8BAAkB,GAAE,CAAC;QACrB,IAAA,iCAAqB,EAAC,KAAK,CAAC,CAAC;QAE7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE;YAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE;gBAC9B,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE;oBACvB,SAAS;iBACV;gBAED,uCAAuC;gBAEvC,MAAM,MAAM,GAAuB;oBACjC,UAAU,EAAE,IAAI,KAAK,CAAS,CAAC,CAAC;oBAChC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;oBACrB,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC;oBAC1B,cAAc,EAAE,IAAI,KAAK,CAAS,CAAC,CAAC;iBACrC,CAAC;gBAEF,mEAAmE;gBACnE,MAAM,SAAS;gBACb,4CAA4C;gBAC5C,MAAM,4CAAgC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;gBAE9D,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;gBAC3C,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;gBAC3C,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;gBAC3C,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;aACvC;SACF;IACH,CAAC,CAAC,CAAC,OAAO,CAAC,KAAM,CAAC,CAAC;AACrB,CAAC,CAAC,CAAC","sourcesContent":["/// <reference types=\"../../../types/global\" />\nimport chai from 'chai';\nimport chaiAsPromised from 'chai-as-promised';\nimport { Artifact, ArtifactName } from '@matrix-privacy/shared-models';\nimport { initTestEngine } from '../../../tests/setup.test';\nimport {\n  clearArtifactCache,\n  overrideArtifact,\n  artifactGetterDownloadJustInTime,\n  artifactCache,\n  setUseNativeArtifacts,\n} from '../../matrix/core/artifacts';\nimport { PublicInputsMatrix } from '@matrix-privacy/engine';\nimport { getArtifactVariantString } from '../artifact-util';\n\nchai.use(chaiAsPromised);\nconst { expect } = chai;\n\ndescribe('artifact-downloader', () => {\n  before(async () => {\n    const useNativeArtifacts = false;\n    await initTestEngine(useNativeArtifacts);\n  });\n\n  it('Should set and get artifacts', async () => {\n    setUseNativeArtifacts(false);\n\n    clearArtifactCache();\n\n    const inputs11By2: PublicInputsMatrix = {\n      nullifiers: [\n        BigInt(1),\n        BigInt(1),\n        BigInt(1),\n        BigInt(1),\n        BigInt(1),\n        BigInt(1),\n        BigInt(1),\n        BigInt(1),\n        BigInt(1),\n        BigInt(1),\n        BigInt(1),\n      ],\n      merkleRoot: BigInt(0),\n      boundParamsHash: BigInt(0),\n      commitmentsOut: [BigInt(0), BigInt(1)],\n    };\n    await expect(\n      artifactGetterDownloadJustInTime.getArtifacts(inputs11By2),\n    ).to.be.rejectedWith('No artifacts for inputs: 11-2');\n\n    const mockArtifact: Artifact = {\n      [ArtifactName.ZKEY]: Buffer.from('123'),\n      [ArtifactName.WASM]: Buffer.from('456'),\n      [ArtifactName.DAT]: undefined,\n      [ArtifactName.VKEY]: { data: '789' },\n    };\n    const artifactVariantString2by2 = getArtifactVariantString(2, 2);\n    overrideArtifact(artifactVariantString2by2, mockArtifact);\n\n    // Pre-set in test.\n    const inputs2By2: PublicInputsMatrix = {\n      nullifiers: [BigInt(1), BigInt(2)],\n      merkleRoot: BigInt(0),\n      boundParamsHash: BigInt(0),\n      commitmentsOut: [BigInt(0), BigInt(1)],\n    };\n    await expect(artifactGetterDownloadJustInTime.getArtifacts(inputs2By2)).to\n      .be.fulfilled;\n  });\n\n  it('Should download artifacts - snarkjs', async () => {\n    setUseNativeArtifacts(false);\n\n    clearArtifactCache();\n\n    // Requires download.\n    const inputs: PublicInputsMatrix = {\n      nullifiers: [\n        BigInt(1),\n        BigInt(1),\n        BigInt(1),\n        BigInt(1),\n        BigInt(1),\n        BigInt(1),\n        BigInt(1),\n        BigInt(1),\n      ],\n      merkleRoot: BigInt(0),\n      boundParamsHash: BigInt(0),\n      commitmentsOut: [BigInt(0), BigInt(1)],\n    };\n\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n    const artifacts: Artifact =\n      await artifactGetterDownloadJustInTime.getArtifacts(inputs);\n\n    expect(artifacts.vkey).to.not.be.undefined;\n    expect(artifacts.zkey).to.not.be.undefined;\n    expect(artifacts.wasm).to.not.be.undefined;\n    expect(artifacts.dat).to.be.undefined;\n\n    const cached = artifactCache['08x02'];\n    expect(cached?.vkey).to.not.be.undefined;\n    expect(cached?.zkey).to.not.be.undefined;\n    expect(cached?.wasm).to.not.be.undefined;\n    expect(cached?.dat).to.be.undefined;\n  }).timeout(30_000);\n\n  it('Should download artifacts - native', async () => {\n    setUseNativeArtifacts(true);\n\n    clearArtifactCache();\n\n    // Requires download.\n    const inputs: PublicInputsMatrix = {\n      nullifiers: [\n        BigInt(1),\n        BigInt(1),\n        BigInt(1),\n        BigInt(1),\n        BigInt(1),\n        BigInt(1),\n      ],\n      merkleRoot: BigInt(0),\n      boundParamsHash: BigInt(0),\n      commitmentsOut: [BigInt(0), BigInt(1), BigInt(1)],\n    };\n\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n    const artifacts: Artifact =\n      await artifactGetterDownloadJustInTime.getArtifacts(inputs);\n\n    expect(artifacts.vkey).to.not.be.undefined;\n    expect(artifacts.zkey).to.not.be.undefined;\n    expect(artifacts.wasm).to.be.undefined;\n    expect(artifacts.dat).to.not.be.undefined;\n\n    const cached = artifactCache['06x03'];\n    expect(cached?.vkey).to.not.be.undefined;\n    expect(cached?.zkey).to.not.be.undefined;\n    expect(cached?.wasm).to.be.undefined;\n    expect(cached?.dat).to.not.be.undefined;\n  }).timeout(30_000);\n\n  // Skipped because we don't want to run this on every build.\n  it.skip('Should download ALL artifacts - native and nodejs', async () => {\n    setUseNativeArtifacts(true);\n\n    clearArtifactCache();\n\n    for (let i = 1; i <= 10; i += 1) {\n      for (let j = 1; j <= 3; j += 1) {\n        if (i === 10 && j === 5) {\n          continue;\n        }\n\n        // console.log(`NATIVE: ${i}x${j}...`);\n\n        const inputs: PublicInputsMatrix = {\n          nullifiers: new Array<bigint>(i),\n          merkleRoot: BigInt(0),\n          boundParamsHash: BigInt(0),\n          commitmentsOut: new Array<bigint>(j),\n        };\n\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n        const artifacts: Artifact =\n          // eslint-disable-next-line no-await-in-loop\n          await artifactGetterDownloadJustInTime.getArtifacts(inputs);\n\n        expect(artifacts.vkey).to.not.be.undefined;\n        expect(artifacts.zkey).to.not.be.undefined;\n        expect(artifacts.wasm).to.be.undefined;\n        expect(artifacts.dat).to.not.be.undefined;\n      }\n    }\n\n    clearArtifactCache();\n    setUseNativeArtifacts(false);\n\n    for (let i = 1; i <= 10; i += 1) {\n      for (let j = 1; j <= 5; j += 1) {\n        if (i === 10 && j === 5) {\n          continue;\n        }\n\n        // console.log(`NODEJS: ${i}x${j}...`);\n\n        const inputs: PublicInputsMatrix = {\n          nullifiers: new Array<bigint>(i),\n          merkleRoot: BigInt(0),\n          boundParamsHash: BigInt(0),\n          commitmentsOut: new Array<bigint>(j),\n        };\n\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n        const artifacts: Artifact =\n          // eslint-disable-next-line no-await-in-loop\n          await artifactGetterDownloadJustInTime.getArtifacts(inputs);\n\n        expect(artifacts.vkey).to.not.be.undefined;\n        expect(artifacts.zkey).to.not.be.undefined;\n        expect(artifacts.wasm).to.not.be.undefined;\n        expect(artifacts.dat).to.be.undefined;\n      }\n    }\n  }).timeout(30_000);\n});\n"]}

package/dist/services/artifacts/artifact-downloader.d.ts

@@ -0,0 +1,13 @@
+import { Artifact } from '@matrix-privacy/shared-models';
+import { ArtifactStore } from './artifact-store';
+export declare class ArtifactDownloader {
+    private artifactStore;
+    private useNativeArtifacts;
+    constructor(artifactStore: ArtifactStore, useNativeArtifacts: boolean);
+    downloadArtifacts: (artifactVariantString: string) => Promise<void>;
+    private downloadArtifact;
+    private static getArtifactData;
+    private static artifactResponseType;
+    private getDownloadedArtifact;
+    getDownloadedArtifacts: (artifactVariantString: string) => Promise<Artifact>;
+}

package/dist/services/artifacts/artifact-downloader.js

@@ -0,0 +1,142 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArtifactDownloader = void 0;
+const shared_models_1 = require("@matrix-privacy/shared-models");
+const axios_1 = __importDefault(require("axios"));
+const artifact_util_1 = require("./artifact-util");
+const error_1 = require("../../utils/error");
+const logger_1 = require("../../utils/logger");
+const artifact_hash_1 = require("./artifact-hash");
+class ArtifactDownloader {
+    artifactStore;
+    useNativeArtifacts;
+    constructor(artifactStore, useNativeArtifacts) {
+        this.artifactStore = artifactStore;
+        this.useNativeArtifacts = useNativeArtifacts;
+    }
+    downloadArtifacts = async (artifactVariantString) => {
+        (0, logger_1.sendMessage)(`Downloading artifacts: ${artifactVariantString}`);
+        const [vkeyPath, zkeyPath, wasmOrDatPath] = await (0, shared_models_1.promiseTimeout)(Promise.all([
+            this.downloadArtifact(shared_models_1.ArtifactName.VKEY, artifactVariantString),
+            this.downloadArtifact(shared_models_1.ArtifactName.ZKEY, artifactVariantString),
+            this.downloadArtifact(this.useNativeArtifacts ? shared_models_1.ArtifactName.DAT : shared_models_1.ArtifactName.WASM, artifactVariantString),
+        ]), 45000, new Error(`Timed out downloading artifact files for ${artifactVariantString} circuit. Please try again.`));
+        if (!(0, shared_models_1.isDefined)(vkeyPath)) {
+            throw new Error('Could not download vkey artifact.');
+        }
+        if (!(0, shared_models_1.isDefined)(zkeyPath)) {
+            throw new Error('Could not download zkey artifact.');
+        }
+        if (!(0, shared_models_1.isDefined)(wasmOrDatPath)) {
+            throw new Error(this.useNativeArtifacts
+                ? 'Could not download dat artifact.'
+                : 'Could not download wasm artifact.');
+        }
+    };
+    downloadArtifact = async (artifactName, artifactVariantString) => {
+        const path = (0, artifact_util_1.artifactDownloadsPath)(artifactName, artifactVariantString);
+        if (await this.artifactStore.exists(path)) {
+            return path;
+        }
+        try {
+            const url = (0, artifact_util_1.getArtifactUrl)(artifactName, artifactVariantString);
+            const { data } = await axios_1.default.get(url, {
+                method: 'GET',
+                responseType: ArtifactDownloader.artifactResponseType(artifactName),
+            });
+            // NodeJS downloads as Buffer.
+            // Browser downloads as ArrayBuffer.
+            // Both will validate with the same hash.
+            let dataFormatted;
+            if (data instanceof ArrayBuffer || data instanceof Buffer) {
+                dataFormatted = data;
+            }
+            else if (typeof data === 'object') {
+                dataFormatted = JSON.stringify(data);
+            }
+            else if (typeof data === 'string') {
+                dataFormatted = JSON.stringify(JSON.parse(data));
+            }
+            else {
+                throw new Error('Unexpected response data type');
+            }
+            const decompressedData = ArtifactDownloader.getArtifactData(dataFormatted, artifactName);
+            const isValid = await (0, artifact_hash_1.validateArtifactDownload)(decompressedData, artifactName, artifactVariantString);
+            if (isValid) {
+                await this.artifactStore.store((0, artifact_util_1.artifactDownloadsDir)(artifactVariantString), path, decompressedData);
+            }
+            else {
+                throw new Error(`Invalid hash for artifact download: ${artifactName} for ${artifactVariantString}.`);
+            }
+            return path;
+        }
+        catch (err) {
+            throw (0, error_1.reportAndSanitizeError)(this.downloadArtifact.name, err);
+        }
+    };
+    static getArtifactData = (data, artifactName) => {
+        switch (artifactName) {
+            case shared_models_1.ArtifactName.VKEY:
+                return data;
+            case shared_models_1.ArtifactName.ZKEY:
+            case shared_models_1.ArtifactName.DAT:
+            case shared_models_1.ArtifactName.WASM:
+                return (0, artifact_util_1.decompressArtifact)(data);
+        }
+    };
+    static artifactResponseType = (artifactName) => {
+        switch (artifactName) {
+            case shared_models_1.ArtifactName.VKEY:
+                return 'text';
+            case shared_models_1.ArtifactName.ZKEY:
+            case shared_models_1.ArtifactName.DAT:
+            case shared_models_1.ArtifactName.WASM:
+                return 'arraybuffer';
+        }
+    };
+    getDownloadedArtifact = async (path) => {
+        try {
+            const storedItem = await this.artifactStore.get(path);
+            return storedItem;
+        }
+        catch (err) {
+            return null;
+        }
+    };
+    getDownloadedArtifacts = async (artifactVariantString) => {
+        const artifactDownloadsPaths = (0, artifact_util_1.getArtifactDownloadsPaths)(artifactVariantString);
+        const [vkeyString, zkeyBuffer, datBuffer, wasmBuffer] = await Promise.all([
+            this.getDownloadedArtifact(artifactDownloadsPaths[shared_models_1.ArtifactName.VKEY]),
+            this.getDownloadedArtifact(artifactDownloadsPaths[shared_models_1.ArtifactName.ZKEY]),
+            this.useNativeArtifacts
+                ? this.getDownloadedArtifact(artifactDownloadsPaths[shared_models_1.ArtifactName.DAT])
+                : Promise.resolve(undefined),
+            !this.useNativeArtifacts
+                ? this.getDownloadedArtifact(artifactDownloadsPaths[shared_models_1.ArtifactName.WASM])
+                : Promise.resolve(undefined),
+        ]);
+        if (vkeyString == null) {
+            throw new Error('Could not retrieve vkey artifact.');
+        }
+        if (zkeyBuffer == null) {
+            throw new Error('Could not retrieve zkey artifact.');
+        }
+        if (this.useNativeArtifacts && datBuffer == null) {
+            throw new Error('Could not retrieve dat artifact.');
+        }
+        if (!this.useNativeArtifacts && wasmBuffer == null) {
+            throw new Error('Could not retrieve wasm artifact.');
+        }
+        return {
+            vkey: JSON.parse(vkeyString),
+            zkey: zkeyBuffer,
+            wasm: wasmBuffer,
+            dat: datBuffer,
+        };
+    };
+}
+exports.ArtifactDownloader = ArtifactDownloader;
+//# sourceMappingURL=artifact-downloader.js.map

package/dist/services/artifacts/artifact-downloader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"artifact-downloader.js","sourceRoot":"","sources":["../../../src/services/artifacts/artifact-downloader.ts"],"names":[],"mappings":";;;;;;AAAA,iEAKuC;AACvC,kDAA4C;AAC5C,mDAMyB;AAEzB,6CAA2D;AAC3D,+CAAiD;AACjD,mDAA2D;AAE3D,MAAa,kBAAkB;IACrB,aAAa,CAAgB;IAC7B,kBAAkB,CAAU;IAEpC,YAAY,aAA4B,EAAE,kBAA2B;QACnE,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;IAC/C,CAAC;IAED,iBAAiB,GAAG,KAAK,EAAE,qBAA6B,EAAiB,EAAE;QACzE,IAAA,oBAAW,EAAC,0BAA0B,qBAAqB,EAAE,CAAC,CAAC;QAE/D,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,aAAa,CAAC,GAAG,MAAM,IAAA,8BAAc,EAC9D,OAAO,CAAC,GAAG,CAAC;YACV,IAAI,CAAC,gBAAgB,CAAC,4BAAY,CAAC,IAAI,EAAE,qBAAqB,CAAC;YAC/D,IAAI,CAAC,gBAAgB,CAAC,4BAAY,CAAC,IAAI,EAAE,qBAAqB,CAAC;YAC/D,IAAI,CAAC,gBAAgB,CACnB,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,4BAAY,CAAC,GAAG,CAAC,CAAC,CAAC,4BAAY,CAAC,IAAI,EAC9D,qBAAqB,CACtB;SACF,CAAC,EACF,KAAK,EACL,IAAI,KAAK,CACP,4CAA4C,qBAAqB,6BAA6B,CAC/F,CACF,CAAC;QAEF,IAAI,CAAC,IAAA,yBAAS,EAAC,QAAQ,CAAC,EAAE;YACxB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QACD,IAAI,CAAC,IAAA,yBAAS,EAAC,QAAQ,CAAC,EAAE;YACxB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QACD,IAAI,CAAC,IAAA,yBAAS,EAAC,aAAa,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CACb,IAAI,CAAC,kBAAkB;gBACrB,CAAC,CAAC,kCAAkC;gBACpC,CAAC,CAAC,mCAAmC,CACxC,CAAC;SACH;IACH,CAAC,CAAC;IAEM,gBAAgB,GAAG,KAAK,EAC9B,YAA0B,EAC1B,qBAA6B,EACA,EAAE;QAC/B,MAAM,IAAI,GAAG,IAAA,qCAAqB,EAAC,YAAY,EAAE,qBAAqB,CAAC,CAAC;QACxE,IAAI,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YACzC,OAAO,IAAI,CAAC;SACb;QACD,IAAI;YACF,MAAM,GAAG,GAAG,IAAA,8BAAc,EAAC,YAAY,EAAE,qBAAqB,CAAC,CAAC;YAEhE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,eAAK,CAAC,GAAG,CAAgC,GAAG,EAAE;gBACnE,MAAM,EAAE,KAAK;gBACb,YAAY,EAAE,kBAAkB,CAAC,oBAAoB,CAAC,YAAY,CAAC;aACpE,CAAC,CAAC;YAEH,8BAA8B;YAC9B,oCAAoC;YACpC,yCAAyC;YAEzC,IAAI,aAA4C,CAAC;YAEjD,IAAI,IAAI,YAAY,WAAW,IAAI,IAAI,YAAY,MAAM,EAAE;gBACzD,aAAa,GAAG,IAAI,CAAC;aACtB;iBAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;gBACnC,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;aACtC;iBAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;gBACnC,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;aAClD;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;aAClD;YAED,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,eAAe,CACzD,aAAa,EACb,YAAY,CACb,CAAC;YAEF,MAAM,OAAO,GAAG,MAAM,IAAA,wCAAwB,EAC5C,gBAAgB,EAChB,YAAY,EACZ,qBAAqB,CACtB,CAAC;YACF,IAAI,OAAO,EAAE;gBACX,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAC5B,IAAA,oCAAoB,EAAC,qBAAqB,CAAC,EAC3C,IAAI,EACJ,gBAAgB,CACjB,CAAC;aACH;iBAAM;gBACL,MAAM,IAAI,KAAK,CACb,uCAAuC,YAAY,QAAQ,qBAAqB,GAAG,CACpF,CAAC;aACH;YAED,OAAO,IAAI,CAAC;SACb;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAA,8BAAsB,EAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;SAC/D;IACH,CAAC,CAAC;IAEM,MAAM,CAAC,eAAe,GAAG,CAC/B,IAA0B,EAC1B,YAA0B,EACL,EAAE;QACvB,QAAQ,YAAY,EAAE;YACpB,KAAK,4BAAY,CAAC,IAAI;gBACpB,OAAO,IAAc,CAAC;YACxB,KAAK,4BAAY,CAAC,IAAI,CAAC;YACvB,KAAK,4BAAY,CAAC,GAAG,CAAC;YACtB,KAAK,4BAAY,CAAC,IAAI;gBACpB,OAAO,IAAA,kCAAkB,EAAC,IAAmB,CAAC,CAAC;SAClD;IACH,CAAC,CAAC;IAEM,MAAM,CAAC,oBAAoB,GAAG,CACpC,YAA0B,EACZ,EAAE;QAChB,QAAQ,YAAY,EAAE;YACpB,KAAK,4BAAY,CAAC,IAAI;gBACpB,OAAO,MAAM,CAAC;YAChB,KAAK,4BAAY,CAAC,IAAI,CAAC;YACvB,KAAK,4BAAY,CAAC,GAAG,CAAC;YACtB,KAAK,4BAAY,CAAC,IAAI;gBACpB,OAAO,aAAa,CAAC;SACxB;IACH,CAAC,CAAC;IAEM,qBAAqB,GAAG,KAAK,EACnC,IAAY,EACqB,EAAE;QACnC,IAAI;YACF,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACtD,OAAO,UAAU,CAAC;SACnB;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,IAAI,CAAC;SACb;IACH,CAAC,CAAC;IAEF,sBAAsB,GAAG,KAAK,EAC5B,qBAA6B,EACV,EAAE;QACrB,MAAM,sBAAsB,GAAG,IAAA,yCAAyB,EACtD,qBAAqB,CACtB,CAAC;QAEF,MAAM,CAAC,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACxE,IAAI,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,4BAAY,CAAC,IAAI,CAAC,CAAC;YACrE,IAAI,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,4BAAY,CAAC,IAAI,CAAC,CAAC;YACrE,IAAI,CAAC,kBAAkB;gBACrB,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,4BAAY,CAAC,GAAG,CAAC,CAAC;gBACtE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC;YAC9B,CAAC,IAAI,CAAC,kBAAkB;gBACtB,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,4BAAY,CAAC,IAAI,CAAC,CAAC;gBACvE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC;SAC/B,CAAC,CAAC;QACH,IAAI,UAAU,IAAI,IAAI,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QACD,IAAI,UAAU,IAAI,IAAI,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QACD,IAAI,IAAI,CAAC,kBAAkB,IAAI,SAAS,IAAI,IAAI,EAAE;YAChD,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;SACrD;QACD,IAAI,CAAC,IAAI,CAAC,kBAAkB,IAAI,UAAU,IAAI,IAAI,EAAE;YAClD,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QAED,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,UAAoB,CAAC;YACtC,IAAI,EAAE,UAAoB;YAC1B,IAAI,EAAE,UAAgC;YACtC,GAAG,EAAE,SAA+B;SACrC,CAAC;IACJ,CAAC,CAAC;;AAhLJ,gDAiLC","sourcesContent":["import {\n  Artifact,\n  ArtifactName,\n  isDefined,\n  promiseTimeout,\n} from '@matrix-privacy/shared-models';\nimport axios, { ResponseType } from 'axios';\nimport {\n  artifactDownloadsDir,\n  artifactDownloadsPath,\n  decompressArtifact,\n  getArtifactDownloadsPaths,\n  getArtifactUrl,\n} from './artifact-util';\nimport { ArtifactStore } from './artifact-store';\nimport { reportAndSanitizeError } from '../../utils/error';\nimport { sendMessage } from '../../utils/logger';\nimport { validateArtifactDownload } from './artifact-hash';\n\nexport class ArtifactDownloader {\n  private artifactStore: ArtifactStore;\n  private useNativeArtifacts: boolean;\n\n  constructor(artifactStore: ArtifactStore, useNativeArtifacts: boolean) {\n    this.artifactStore = artifactStore;\n    this.useNativeArtifacts = useNativeArtifacts;\n  }\n\n  downloadArtifacts = async (artifactVariantString: string): Promise<void> => {\n    sendMessage(`Downloading artifacts: ${artifactVariantString}`);\n\n    const [vkeyPath, zkeyPath, wasmOrDatPath] = await promiseTimeout(\n      Promise.all([\n        this.downloadArtifact(ArtifactName.VKEY, artifactVariantString),\n        this.downloadArtifact(ArtifactName.ZKEY, artifactVariantString),\n        this.downloadArtifact(\n          this.useNativeArtifacts ? ArtifactName.DAT : ArtifactName.WASM,\n          artifactVariantString,\n        ),\n      ]),\n      45000,\n      new Error(\n        `Timed out downloading artifact files for ${artifactVariantString} circuit. Please try again.`,\n      ),\n    );\n\n    if (!isDefined(vkeyPath)) {\n      throw new Error('Could not download vkey artifact.');\n    }\n    if (!isDefined(zkeyPath)) {\n      throw new Error('Could not download zkey artifact.');\n    }\n    if (!isDefined(wasmOrDatPath)) {\n      throw new Error(\n        this.useNativeArtifacts\n          ? 'Could not download dat artifact.'\n          : 'Could not download wasm artifact.',\n      );\n    }\n  };\n\n  private downloadArtifact = async (\n    artifactName: ArtifactName,\n    artifactVariantString: string,\n  ): Promise<string | undefined> => {\n    const path = artifactDownloadsPath(artifactName, artifactVariantString);\n    if (await this.artifactStore.exists(path)) {\n      return path;\n    }\n    try {\n      const url = getArtifactUrl(artifactName, artifactVariantString);\n\n      const { data } = await axios.get<ArrayBuffer | Buffer | object>(url, {\n        method: 'GET',\n        responseType: ArtifactDownloader.artifactResponseType(artifactName),\n      });\n\n      // NodeJS downloads as Buffer.\n      // Browser downloads as ArrayBuffer.\n      // Both will validate with the same hash.\n\n      let dataFormatted: ArrayBuffer | Buffer | string;\n\n      if (data instanceof ArrayBuffer || data instanceof Buffer) {\n        dataFormatted = data;\n      } else if (typeof data === 'object') {\n        dataFormatted = JSON.stringify(data);\n      } else if (typeof data === 'string') {\n        dataFormatted = JSON.stringify(JSON.parse(data));\n      } else {\n        throw new Error('Unexpected response data type');\n      }\n\n      const decompressedData = ArtifactDownloader.getArtifactData(\n        dataFormatted,\n        artifactName,\n      );\n\n      const isValid = await validateArtifactDownload(\n        decompressedData,\n        artifactName,\n        artifactVariantString,\n      );\n      if (isValid) {\n        await this.artifactStore.store(\n          artifactDownloadsDir(artifactVariantString),\n          path,\n          decompressedData,\n        );\n      } else {\n        throw new Error(\n          `Invalid hash for artifact download: ${artifactName} for ${artifactVariantString}.`,\n        );\n      }\n\n      return path;\n    } catch (err) {\n      throw reportAndSanitizeError(this.downloadArtifact.name, err);\n    }\n  };\n\n  private static getArtifactData = (\n    data: string | ArrayBuffer,\n    artifactName: ArtifactName,\n  ): string | Uint8Array => {\n    switch (artifactName) {\n      case ArtifactName.VKEY:\n        return data as string;\n      case ArtifactName.ZKEY:\n      case ArtifactName.DAT:\n      case ArtifactName.WASM:\n        return decompressArtifact(data as ArrayBuffer);\n    }\n  };\n\n  private static artifactResponseType = (\n    artifactName: ArtifactName,\n  ): ResponseType => {\n    switch (artifactName) {\n      case ArtifactName.VKEY:\n        return 'text';\n      case ArtifactName.ZKEY:\n      case ArtifactName.DAT:\n      case ArtifactName.WASM:\n        return 'arraybuffer';\n    }\n  };\n\n  private getDownloadedArtifact = async (\n    path: string,\n  ): Promise<string | Buffer | null> => {\n    try {\n      const storedItem = await this.artifactStore.get(path);\n      return storedItem;\n    } catch (err) {\n      return null;\n    }\n  };\n\n  getDownloadedArtifacts = async (\n    artifactVariantString: string,\n  ): Promise<Artifact> => {\n    const artifactDownloadsPaths = getArtifactDownloadsPaths(\n      artifactVariantString,\n    );\n\n    const [vkeyString, zkeyBuffer, datBuffer, wasmBuffer] = await Promise.all([\n      this.getDownloadedArtifact(artifactDownloadsPaths[ArtifactName.VKEY]),\n      this.getDownloadedArtifact(artifactDownloadsPaths[ArtifactName.ZKEY]),\n      this.useNativeArtifacts\n        ? this.getDownloadedArtifact(artifactDownloadsPaths[ArtifactName.DAT])\n        : Promise.resolve(undefined),\n      !this.useNativeArtifacts\n        ? this.getDownloadedArtifact(artifactDownloadsPaths[ArtifactName.WASM])\n        : Promise.resolve(undefined),\n    ]);\n    if (vkeyString == null) {\n      throw new Error('Could not retrieve vkey artifact.');\n    }\n    if (zkeyBuffer == null) {\n      throw new Error('Could not retrieve zkey artifact.');\n    }\n    if (this.useNativeArtifacts && datBuffer == null) {\n      throw new Error('Could not retrieve dat artifact.');\n    }\n    if (!this.useNativeArtifacts && wasmBuffer == null) {\n      throw new Error('Could not retrieve wasm artifact.');\n    }\n\n    return {\n      vkey: JSON.parse(vkeyString as string),\n      zkey: zkeyBuffer as Buffer,\n      wasm: wasmBuffer as Buffer | undefined,\n      dat: datBuffer as Buffer | undefined,\n    };\n  };\n}\n"]}

package/dist/services/artifacts/artifact-hash.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="node" />
+import { ArtifactName } from '@matrix-privacy/shared-models';
+export declare const validateArtifactDownload: (data: Uint8Array | Buffer | string, artifactName: ArtifactName, artifactVariantString: string) => Promise<boolean>;

package/dist/services/artifacts/artifact-hash.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateArtifactDownload = void 0;
+const crypto_1 = require("crypto");
+const shared_models_1 = require("@matrix-privacy/shared-models");
+const sha256_js_1 = require("ethereum-cryptography/sha256.js");
+const logger_1 = require("../../utils/logger");
+const engine_1 = require("@matrix-privacy/engine");
+const runtime_1 = require("../matrix/util/runtime");
+const artifact_v2_hashes_json_1 = __importDefault(require("./json/artifact-v2-hashes.json"));
+const getExpectedArtifactHash = (artifactName, artifactVariantString) => {
+    const hashes = artifact_v2_hashes_json_1.default;
+    const variantHashes = hashes[artifactVariantString];
+    if (!(0, shared_models_1.isDefined)(variantHashes)) {
+        throw new Error(`No hashes for variant ${artifactName}: ${artifactVariantString}`);
+    }
+    if (artifactName === shared_models_1.ArtifactName.VKEY) {
+        throw new Error(`No artifact hashes for vkey.`);
+    }
+    const hash = variantHashes[artifactName];
+    if (!hash) {
+        throw new Error(`No hash for artifact ${artifactName}: ${artifactVariantString}`);
+    }
+    return hash;
+};
+const getDataBytes = (data) => {
+    if (data instanceof Uint8Array) {
+        return data;
+    }
+    if (Buffer.isBuffer(data)) {
+        return data.buffer;
+    }
+    return engine_1.ByteUtils.hexStringToBytes(data);
+};
+const validateArtifactDownload = async (data, artifactName, artifactVariantString) => {
+    if (artifactName === shared_models_1.ArtifactName.VKEY) {
+        return true;
+    }
+    const dataBytes = getDataBytes(data);
+    const expectedHash = getExpectedArtifactHash(artifactName, artifactVariantString);
+    const hash = runtime_1.isReactNative
+        ? engine_1.ByteUtils.hexlify((0, sha256_js_1.sha256)(dataBytes))
+        : (0, crypto_1.createHash)('sha256').update(dataBytes).digest('hex');
+    if (hash !== expectedHash) {
+        (0, logger_1.sendErrorMessage)(`Validate artifact blob for ${artifactName}: ${artifactVariantString}. Got ${hash}, expected ${expectedHash}.`);
+    }
+    return hash === expectedHash;
+};
+exports.validateArtifactDownload = validateArtifactDownload;
+//# sourceMappingURL=artifact-hash.js.map

package/dist/services/artifacts/artifact-hash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"artifact-hash.js","sourceRoot":"","sources":["../../../src/services/artifacts/artifact-hash.ts"],"names":[],"mappings":";;;;;;AAAA,mCAAoC;AACpC,iEAAwE;AACxE,+DAAyD;AACzD,+CAAsD;AACtD,mDAAmD;AACnD,oDAAuD;AACvD,6FAAgE;AAOhE,MAAM,uBAAuB,GAAG,CAC9B,YAA0B,EAC1B,qBAA6B,EACrB,EAAE;IACV,MAAM,MAAM,GAAG,iCAAwC,CAAC;IACxD,MAAM,aAAa,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;IACpD,IAAI,CAAC,IAAA,yBAAS,EAAC,aAAa,CAAC,EAAE;QAC7B,MAAM,IAAI,KAAK,CACb,yBAAyB,YAAY,KAAK,qBAAqB,EAAE,CAClE,CAAC;KACH;IACD,IAAI,YAAY,KAAK,4BAAY,CAAC,IAAI,EAAE;QACtC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;KACjD;IACD,MAAM,IAAI,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;IACzC,IAAI,CAAC,IAAI,EAAE;QACT,MAAM,IAAI,KAAK,CACb,wBAAwB,YAAY,KAAK,qBAAqB,EAAE,CACjE,CAAC;KACH;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,IAAkC,EAAc,EAAE;IACtE,IAAI,IAAI,YAAY,UAAU,EAAE;QAC9B,OAAO,IAAI,CAAC;KACb;IACD,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;QACzB,OAAO,IAAI,CAAC,MAAoB,CAAC;KAClC;IACD,OAAO,kBAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEK,MAAM,wBAAwB,GAAG,KAAK,EAC3C,IAAkC,EAClC,YAA0B,EAC1B,qBAA6B,EACX,EAAE;IACpB,IAAI,YAAY,KAAK,4BAAY,CAAC,IAAI,EAAE;QACtC,OAAO,IAAI,CAAC;KACb;IACD,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,YAAY,GAAG,uBAAuB,CAC1C,YAAY,EACZ,qBAAqB,CACtB,CAAC;IACF,MAAM,IAAI,GAAG,uBAAa;QACxB,CAAC,CAAC,kBAAS,CAAC,OAAO,CAAC,IAAA,kBAAM,EAAC,SAAS,CAAC,CAAC;QACtC,CAAC,CAAC,IAAA,mBAAU,EAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACzD,IAAI,IAAI,KAAK,YAAY,EAAE;QACzB,IAAA,yBAAgB,EACd,8BAA8B,YAAY,KAAK,qBAAqB,SAAS,IAAI,cAAc,YAAY,GAAG,CAC/G,CAAC;KACH;IACD,OAAO,IAAI,KAAK,YAAY,CAAC;AAC/B,CAAC,CAAC;AAtBW,QAAA,wBAAwB,4BAsBnC","sourcesContent":["import { createHash } from 'crypto';\nimport { ArtifactName, isDefined } from '@matrix-privacy/shared-models';\nimport { sha256 } from 'ethereum-cryptography/sha256.js';\nimport { sendErrorMessage } from '../../utils/logger';\nimport { ByteUtils } from '@matrix-privacy/engine';\nimport { isReactNative } from '../matrix/util/runtime';\nimport ARTIFACT_V2_HASHES from './json/artifact-v2-hashes.json';\n\ntype ArtifactHashesJson = Record<\n  string,\n  Record<ArtifactName.DAT | ArtifactName.WASM | ArtifactName.ZKEY, string>\n>;\n\nconst getExpectedArtifactHash = (\n  artifactName: ArtifactName,\n  artifactVariantString: string,\n): string => {\n  const hashes = ARTIFACT_V2_HASHES as ArtifactHashesJson;\n  const variantHashes = hashes[artifactVariantString];\n  if (!isDefined(variantHashes)) {\n    throw new Error(\n      `No hashes for variant ${artifactName}: ${artifactVariantString}`,\n    );\n  }\n  if (artifactName === ArtifactName.VKEY) {\n    throw new Error(`No artifact hashes for vkey.`);\n  }\n  const hash = variantHashes[artifactName];\n  if (!hash) {\n    throw new Error(\n      `No hash for artifact ${artifactName}: ${artifactVariantString}`,\n    );\n  }\n  return hash;\n};\n\nconst getDataBytes = (data: Uint8Array | Buffer | string): Uint8Array => {\n  if (data instanceof Uint8Array) {\n    return data;\n  }\n  if (Buffer.isBuffer(data)) {\n    return data.buffer as Uint8Array;\n  }\n  return ByteUtils.hexStringToBytes(data);\n};\n\nexport const validateArtifactDownload = async (\n  data: Uint8Array | Buffer | string,\n  artifactName: ArtifactName,\n  artifactVariantString: string,\n): Promise<boolean> => {\n  if (artifactName === ArtifactName.VKEY) {\n    return true;\n  }\n  const dataBytes = getDataBytes(data);\n  const expectedHash = getExpectedArtifactHash(\n    artifactName,\n    artifactVariantString,\n  );\n  const hash = isReactNative\n    ? ByteUtils.hexlify(sha256(dataBytes))\n    : createHash('sha256').update(dataBytes).digest('hex');\n  if (hash !== expectedHash) {\n    sendErrorMessage(\n      `Validate artifact blob for ${artifactName}: ${artifactVariantString}. Got ${hash}, expected ${expectedHash}.`,\n    );\n  }\n  return hash === expectedHash;\n};\n"]}

package/dist/services/artifacts/artifact-store.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="node" />
+type GetArtifact = (path: string) => Promise<string | Buffer | null>;
+type StoreArtifact = (dir: string, path: string, item: string | Uint8Array) => Promise<void>;
+type ArtifactExists = (path: string) => Promise<boolean>;
+export declare class ArtifactStore {
+    get: GetArtifact;
+    store: StoreArtifact;
+    exists: ArtifactExists;
+    constructor(get: GetArtifact, store: StoreArtifact, exists: ArtifactExists);
+}
+export {};