@ledgerhq/zcash-shielded 0.1.1-nightly.20251217131814

package/.turbo/turbo-build.log

@@ -0,0 +1,4 @@
+
+> @ledgerhq/zcash-shielded@0.1.0 build /home/runner/work/ledger-live/ledger-live/libs/coin-modules/zcash-shielded
+> tsc && tsc -m esnext --moduleResolution bundler --outDir lib-es
+

package/.unimportedrc.json

@@ -0,0 +1,16 @@
+{
+  "entry": [
+    "src/ZCash.ts"
+  ],
+  "ignorePatterns": [
+    "**/node_modules/**",
+    "**/*.fixture.ts",
+    "**/*.mock.ts",
+    "**/*.test.{js,jsx,ts,tsx}"
+  ],
+  "ignoreUnresolved": [],
+  "ignoreUnused": [],
+  "ignoreUnimported": [
+    "src/ZCash.ts"
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @ledgerhq/zcash-shielded
+
+## 0.1.1-nightly.20251217131814
+
+### Patch Changes
+
+- [#13166](https://github.com/LedgerHQ/ledger-live/pull/13166) [`9a97195`](https://github.com/LedgerHQ/ledger-live/commit/9a9719585de98dee726345643549676712848972) Thanks [@alevito](https://github.com/alevito)! - Create the basic structure of a ZCash library for shielded transactions.

package/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2017-present Ledger https://www.ledger.com/
+
+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,11 @@
+<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />
+
+[GitHub](https://github.com/LedgerHQ/ledger-live/),
+[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
+[Developer Portal](https://developers.ledger.com/)
+
+## @ledgerhq/zcash-shielded
+
+ZCash shielded account library
+
+***

package/jest.config.js

@@ -0,0 +1,9 @@
+/** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
+module.exports = {
+  collectCoverageFrom: ["src/**/*.ts"],
+  coveragePathIgnorePatterns: ["test/cli.ts", ".*\\.integration\\.test\\.[tj]s"],
+  coverageDirectory: "coverage",
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testPathIgnorePatterns: ["lib/", "lib-es/", ".*\\.integration\\.test\\.[tj]s"],
+};

package/jest.integ.config.js

@@ -0,0 +1,8 @@
+/** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testRegex: ".integration.test.ts$",
+  testPathIgnorePatterns: ["lib/", "lib-es/", "bridge.integration.test.ts"],
+  testTimeout: 60_000,
+};

package/lib/ZCash.d.ts

@@ -0,0 +1,29 @@
+/**
+ * ZCash API
+ */
+export default class ZCash {
+    static readonly AVERAGE_BLOCK_SYNC_TIME_MS = 5;
+    /**
+     * Estimates sync time given a start and an end block.
+     *
+     * @param startBlock starting block
+     * @param endBlock end block, usually the latest confirmed block
+     * @return the estimated sync time
+     */
+    estimateSyncTime(startBlock: number, endBlock: number): Promise<number>;
+    /**
+     * Decrypts a ZCash shielded - i.e., encrypted - transaction.
+     *
+     * @param encryptedTransaction string raw string representing an encrypted transaction.
+     * @return a decrypted transaction
+     */
+    decryptTransaction(encryptedTransaction: string): Promise<string>;
+    /**
+     * Finds the lowest block height correspondent to a given timestamp
+     *
+     * @param timestamp
+     * @return a block height
+     */
+    findBlockHeight(timestamp: number): Promise<number>;
+}
+//# sourceMappingURL=ZCash.d.ts.map

package/lib/ZCash.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ZCash.d.ts","sourceRoot":"","sources":["../src/ZCash.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,CAAC,OAAO,OAAO,KAAK;IACxB,MAAM,CAAC,QAAQ,CAAC,0BAA0B,KAAK;IAE/C;;;;;;OAMG;IACG,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAI3D;;;;;OAKG;IACG,kBAAkB,CAAC,oBAAoB,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvE;;;;;OAKG;IACG,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAG1D"}

package/lib/ZCash.js

@@ -0,0 +1,38 @@
+"use strict";
+/**
+ * ZCash API
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+class ZCash {
+    static AVERAGE_BLOCK_SYNC_TIME_MS = 5;
+    /**
+     * Estimates sync time given a start and an end block.
+     *
+     * @param startBlock starting block
+     * @param endBlock end block, usually the latest confirmed block
+     * @return the estimated sync time
+     */
+    async estimateSyncTime(startBlock, endBlock) {
+        return (endBlock - startBlock) * ZCash.AVERAGE_BLOCK_SYNC_TIME_MS;
+    }
+    /**
+     * Decrypts a ZCash shielded - i.e., encrypted - transaction.
+     *
+     * @param encryptedTransaction string raw string representing an encrypted transaction.
+     * @return a decrypted transaction
+     */
+    async decryptTransaction(encryptedTransaction) {
+        return `decrypted_${encryptedTransaction}`;
+    }
+    /**
+     * Finds the lowest block height correspondent to a given timestamp
+     *
+     * @param timestamp
+     * @return a block height
+     */
+    async findBlockHeight(timestamp) {
+        return timestamp + 42;
+    }
+}
+exports.default = ZCash;
+//# sourceMappingURL=ZCash.js.map

package/lib/ZCash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ZCash.js","sourceRoot":"","sources":["../src/ZCash.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAEH,MAAqB,KAAK;IACxB,MAAM,CAAU,0BAA0B,GAAG,CAAC,CAAC;IAE/C;;;;;;OAMG;IACH,KAAK,CAAC,gBAAgB,CAAC,UAAkB,EAAE,QAAgB;QACzD,OAAO,CAAC,QAAQ,GAAG,UAAU,CAAC,GAAG,KAAK,CAAC,0BAA0B,CAAC;IACpE,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB,CAAC,oBAA4B;QACnD,OAAO,aAAa,oBAAoB,EAAE,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CAAC,SAAiB;QACrC,OAAO,SAAS,GAAG,EAAE,CAAC;IACxB,CAAC;;AAhCH,wBAiCC"}

package/lib-es/ZCash.d.ts

@@ -0,0 +1,29 @@
+/**
+ * ZCash API
+ */
+export default class ZCash {
+    static readonly AVERAGE_BLOCK_SYNC_TIME_MS = 5;
+    /**
+     * Estimates sync time given a start and an end block.
+     *
+     * @param startBlock starting block
+     * @param endBlock end block, usually the latest confirmed block
+     * @return the estimated sync time
+     */
+    estimateSyncTime(startBlock: number, endBlock: number): Promise<number>;
+    /**
+     * Decrypts a ZCash shielded - i.e., encrypted - transaction.
+     *
+     * @param encryptedTransaction string raw string representing an encrypted transaction.
+     * @return a decrypted transaction
+     */
+    decryptTransaction(encryptedTransaction: string): Promise<string>;
+    /**
+     * Finds the lowest block height correspondent to a given timestamp
+     *
+     * @param timestamp
+     * @return a block height
+     */
+    findBlockHeight(timestamp: number): Promise<number>;
+}
+//# sourceMappingURL=ZCash.d.ts.map

package/lib-es/ZCash.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ZCash.d.ts","sourceRoot":"","sources":["../src/ZCash.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,CAAC,OAAO,OAAO,KAAK;IACxB,MAAM,CAAC,QAAQ,CAAC,0BAA0B,KAAK;IAE/C;;;;;;OAMG;IACG,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAI3D;;;;;OAKG;IACG,kBAAkB,CAAC,oBAAoB,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvE;;;;;OAKG;IACG,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAG1D"}

package/lib-es/ZCash.js

@@ -0,0 +1,35 @@
+/**
+ * ZCash API
+ */
+export default class ZCash {
+    static AVERAGE_BLOCK_SYNC_TIME_MS = 5;
+    /**
+     * Estimates sync time given a start and an end block.
+     *
+     * @param startBlock starting block
+     * @param endBlock end block, usually the latest confirmed block
+     * @return the estimated sync time
+     */
+    async estimateSyncTime(startBlock, endBlock) {
+        return (endBlock - startBlock) * ZCash.AVERAGE_BLOCK_SYNC_TIME_MS;
+    }
+    /**
+     * Decrypts a ZCash shielded - i.e., encrypted - transaction.
+     *
+     * @param encryptedTransaction string raw string representing an encrypted transaction.
+     * @return a decrypted transaction
+     */
+    async decryptTransaction(encryptedTransaction) {
+        return `decrypted_${encryptedTransaction}`;
+    }
+    /**
+     * Finds the lowest block height correspondent to a given timestamp
+     *
+     * @param timestamp
+     * @return a block height
+     */
+    async findBlockHeight(timestamp) {
+        return timestamp + 42;
+    }
+}
+//# sourceMappingURL=ZCash.js.map

package/lib-es/ZCash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ZCash.js","sourceRoot":"","sources":["../src/ZCash.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,CAAC,OAAO,OAAO,KAAK;IACxB,MAAM,CAAU,0BAA0B,GAAG,CAAC,CAAC;IAE/C;;;;;;OAMG;IACH,KAAK,CAAC,gBAAgB,CAAC,UAAkB,EAAE,QAAgB;QACzD,OAAO,CAAC,QAAQ,GAAG,UAAU,CAAC,GAAG,KAAK,CAAC,0BAA0B,CAAC;IACpE,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB,CAAC,oBAA4B;QACnD,OAAO,aAAa,oBAAoB,EAAE,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CAAC,SAAiB;QACrC,OAAO,SAAS,GAAG,EAAE,CAAC;IACxB,CAAC"}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@ledgerhq/zcash-shielded",
+  "version": "0.1.1-nightly.20251217131814",
+  "description": "ZCash library shielded accounts",
+  "keywords": [
+    "ZCash"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/LedgerHQ/ledger-live.git"
+  },
+  "bugs": {
+    "url": "https://github.com/LedgerHQ/ledger-live/issues"
+  },
+  "homepage": "https://github.com/LedgerHQ/ledger-live/tree/develop/libs/coin-modules/zcash-shielded",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "lib/ZCash.js",
+  "module": "lib-es/ZCash.js",
+  "types": "lib/ZCash.d.ts",
+  "typesVersions": {
+    "*": {
+      "lib/*": [
+        "lib/*"
+      ],
+      "lib-es/*": [
+        "lib-es/*"
+      ],
+      "*": [
+        "lib/*"
+      ]
+    }
+  },
+  "exports": {
+    "./lib/*": "./lib/ZCash.js",
+    "./lib-es/*": "./lib-es/ZCash.js",
+    "./*": {
+      "require": "./lib/ZCash.js",
+      "default": "./lib-es/ZCash.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "@types/jest": "^29.5.10",
+    "jest": "^29.7.0",
+    "jest-util": "30.2.0",
+    "ts-jest": "^29.1.1"
+  },
+  "scripts": {
+    "clean": "rimraf lib lib-es",
+    "build": "tsc && tsc -m esnext --moduleResolution bundler --outDir lib-es",
+    "coverage": "jest --coverage --passWithNoTests",
+    "prewatch": "pnpm build",
+    "watch": "tsc --watch",
+    "watch:es": "tsc --watch -m esnext --moduleResolution bundler --outDir lib-es",
+    "doc": "documentation readme src/** --section=API --pe ts --re ts --re d.ts",
+    "lint": "eslint ./src --no-error-on-unmatched-pattern --ext .ts,.tsx --cache",
+    "lint:fix": "pnpm lint --fix",
+    "test": "jest",
+    "test-integ": "jest --config=jest.integ.config.js",
+    "typecheck": "tsc --noEmit",
+    "unimported": "unimported"
+  }
+}

package/src/ZCash.ts

@@ -0,0 +1,38 @@
+/**
+ * ZCash API
+ */
+
+export default class ZCash {
+  static readonly AVERAGE_BLOCK_SYNC_TIME_MS = 5;
+
+  /**
+   * Estimates sync time given a start and an end block.
+   *
+   * @param startBlock starting block
+   * @param endBlock end block, usually the latest confirmed block
+   * @return the estimated sync time
+   */
+  async estimateSyncTime(startBlock: number, endBlock: number) {
+    return (endBlock - startBlock) * ZCash.AVERAGE_BLOCK_SYNC_TIME_MS;
+  }
+
+  /**
+   * Decrypts a ZCash shielded - i.e., encrypted - transaction.
+   *
+   * @param encryptedTransaction string raw string representing an encrypted transaction.
+   * @return a decrypted transaction
+   */
+  async decryptTransaction(encryptedTransaction: string): Promise<string> {
+    return `decrypted_${encryptedTransaction}`;
+  }
+
+  /**
+   * Finds the lowest block height correspondent to a given timestamp
+   *
+   * @param timestamp
+   * @return a block height
+   */
+  async findBlockHeight(timestamp: number): Promise<number> {
+    return timestamp + 42;
+  }
+}

package/tests/ZCash.test.ts

@@ -0,0 +1,25 @@
+import ZCash from "../src/ZCash";
+
+describe("estimateSyncTime", () => {
+  test("estimates the sync time", async () => {
+    const zcash = new ZCash();
+    const estimatedSyncTime = await zcash.estimateSyncTime(5, 10);
+    expect(estimatedSyncTime).toEqual(25);
+  });
+});
+
+describe("findBlockHeight", () => {
+  test("finds the lowest block height", async () => {
+    const zcash = new ZCash();
+    const height = await zcash.findBlockHeight(1234);
+    expect(height).toEqual(1276);
+  });
+});
+
+describe("decryptTransaction", () => {
+  test("decrypts an encrypted transaction", async () => {
+    const zcash = new ZCash();
+    const height = await zcash.decryptTransaction("transaction");
+    expect(height).toEqual("decrypted_transaction");
+  });
+});

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "extends": "../../../tsconfig.base",
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "downlevelIteration": true,
+    "lib": ["es2020", "dom"],
+    "outDir": "lib",
+    "exactOptionalPropertyTypes": true
+  },
+  "include": ["src/**/*"]
+}