diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml deleted file mode 100644 index 9229e6d..0000000 --- a/.github/workflows/publish.yaml +++ /dev/null @@ -1,54 +0,0 @@ -name: "Publish js packages" - -on: - release: - types: - - created - tags: - - "npm_v[0-9]+(\\.[0-9]+)*" - -jobs: - publish_npm_package: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v3 - with: - submodules: true - - name: Install node - uses: actions/setup-node@v3 - with: - registry-url: "https://registry.npmjs.org" - scope: "@zondax" - - name: Install yarn - run: npm install -g yarn - - name: Build package - run: | - cd js - yarn install - yarn build - - name: Get latest release version number - id: get_version - run: | - GITHUB_REF=${{ github.ref }} - echo "version=${GITHUB_REF##*/}" >> $GITHUB_OUTPUT - - name: Show version - run: echo ${{ steps.get_version.outputs.version }} - - name: Clean latest release version number - id: get_version_cleaned - uses: bhowell2/github-substring-action@v1 - with: - output_name: version - value: ${{ steps.get_version.outputs.version }} - index_of_str: "npm_" - - name: Update tag - run: | - cd js - echo Publishing as ${{ steps.get_version_cleaned.outputs.version }} - npm --allow-same-version --no-git-tag-version version ${{ steps.get_version_cleaned.outputs.version }} - - name: Publish package - run: | - cd js - npm publish - env: - NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN_PUBLISH_AUTO }} diff --git a/js/.eslintignore b/js/.eslintignore deleted file mode 100644 index 1521c8b..0000000 --- a/js/.eslintignore +++ /dev/null @@ -1 +0,0 @@ -dist diff --git a/js/.eslintrc.json b/js/.eslintrc.json deleted file mode 100644 index c48f805..0000000 --- a/js/.eslintrc.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "env": { - "browser": true, - "es2021": true, - "node": true - }, - "extends": ["standard-with-typescript", "prettier"], - "parserOptions": { - "project": "tsconfig.json", - "ecmaVersion": "latest", - "sourceType": "module" - }, - "rules": {} -} diff --git a/js/.gitignore b/js/.gitignore deleted file mode 100644 index 053bb63..0000000 --- a/js/.gitignore +++ /dev/null @@ -1,74 +0,0 @@ -# Logs -logs -*.log -npm-debug.log* -yarn-debug.log* -yarn-error.log* - -yarn.lock - -# Runtime data -pids -*.pid -*.seed -*.pid.lock - -# Directory for instrumented libs generated by jscoverage/JSCover -lib-cov - -# Coverage directory used by tools like istanbul -coverage - -# nyc test coverage -.nyc_output - -# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) -.grunt - -# Bower dependency directory (https://bower.io/) -bower_components - -# node-waf configuration -.lock-wscript - -# Compiled binary addons (https://nodejs.org/api/addons.html) -build/Release - -# Dependency directories -node_modules/ -jspm_packages/ - -# TypeScript v1 declaration files -typings/ - -# Optional npm cache directory -.npm - -# Optional eslint cache -.eslintcache - -# Optional REPL history -.node_repl_history - -# Output of 'npm pack' -*.tgz - -# Yarn Integrity file -.yarn-integrity - -# dotenv environment variables file -.env - -# next.js build output -.next - -\.idea/ - -.vscode - -TODO\.md - -\dist -/certs/cert.pem -/certs/server.cert -/certs/server.key diff --git a/js/.npmignore b/js/.npmignore deleted file mode 100644 index 3c3629e..0000000 --- a/js/.npmignore +++ /dev/null @@ -1 +0,0 @@ -node_modules diff --git a/js/.prettierignore b/js/.prettierignore deleted file mode 100644 index de4d1f0..0000000 --- a/js/.prettierignore +++ /dev/null @@ -1,2 +0,0 @@ -dist -node_modules diff --git a/js/.prettierrc b/js/.prettierrc deleted file mode 100644 index 963354f..0000000 --- a/js/.prettierrc +++ /dev/null @@ -1,3 +0,0 @@ -{ - "printWidth": 120 -} diff --git a/js/LICENSE b/js/LICENSE deleted file mode 100644 index d9005ef..0000000 --- a/js/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright 2018 - 2023 Zondax AG - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/js/README.md b/js/README.md deleted file mode 100644 index d02ea92..0000000 --- a/js/README.md +++ /dev/null @@ -1,12 +0,0 @@ -# @zondax/ledger-ironfish - -[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -[![npm version](https://badge.fury.io/js/%40zondax%2Fledger-ironfish.svg)](https://badge.fury.io/js/%40zondax%2Fledger-ironfish) - -This package provides a basic client library to communicate with the Ironfish App running in a Ledger Nano S/X - -We recommend using the npmjs package in order to receive updates/fixes. - -## Notes - -Use `yarn install` to avoid issues. diff --git a/js/package.json b/js/package.json deleted file mode 100644 index d82dd29..0000000 --- a/js/package.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "name": "@zondax/ledger-ironfish", - "author": "Zondax AG", - "license": "Apache-2.0", - "version": "0.0.1", - "description": "Node API for the Ironfish App (Ledger Nano S/X/S+)", - "main": "./dist/index.js", - "typings": "./dist/index.d.ts", - "types": "./dist/index.d.ts", - "homepage": "https://github.com/zondax/ledger-ironfish", - "repository": { - "type": "git", - "url": "git+https://github.com/zondax/ledger-ironfish.git" - }, - "keywords": [ - "Zondax", - "Ledger", - "Javascript", - "Ironfish" - ], - "scripts": { - "build": "tsc" - }, - "bugs": { - "url": "https://github.com/zondax/ledger-ironfish/issues" - }, - "dependencies": { - "@zondax/ledger-js": "^0.2.1" - }, - "devDependencies": { - "@types/node": "^20.14.5", - "@typescript-eslint/eslint-plugin": "^7.13.1", - "@typescript-eslint/parser": "^7.13.1", - "eslint": "^9.5.0", - "eslint-config-prettier": "^9.1.0", - "eslint-config-standard-with-typescript": "^43.0.1", - "eslint-plugin-import": "^2.29.1", - "eslint-plugin-n": "^17.9.0", - "eslint-plugin-promise": "^6.2.0", - "prettier": "^3.3.2", - "typescript": "^5.4.5" - }, - "files": [ - "dist/**/*" - ], - "publishConfig": { - "access": "public" - } -} diff --git a/js/src/consts.ts b/js/src/consts.ts deleted file mode 100644 index c4e0833..0000000 --- a/js/src/consts.ts +++ /dev/null @@ -1,14 +0,0 @@ -export const APP_KEY = "Ironfish"; - -export const P2_VALUES = { - DEFAULT: 0x00, -}; - -export const KEY_TYPES = { - PUBLIC_ADRESS: 0x00, - VIEW_KEY: 0x01, - PROOF_GEN_KEY: 0x02, -}; - -export const KEY_LENGTH = 32; -export const REDJUBJUB_SIGNATURE_LEN = 64; diff --git a/js/src/helper.ts b/js/src/helper.ts deleted file mode 100644 index b35ff94..0000000 --- a/js/src/helper.ts +++ /dev/null @@ -1,60 +0,0 @@ -import { errorCodeToString } from "@zondax/ledger-js"; -import { KEY_LENGTH } from "./consts"; -import { IronfishKeys, KeyResponse } from "./types"; - -export function processGetKeysResponse(response: Buffer, keyType: IronfishKeys): KeyResponse { - const errorCodeData = response.subarray(-2); - const returnCode = errorCodeData[0] * 256 + errorCodeData[1]; - - let requestedKey: KeyResponse = { - returnCode: returnCode, - errorMessage: errorCodeToString(returnCode), - } - - switch(keyType) { - case IronfishKeys.PublicAddress: { - const publicAddress = Buffer.from(response.subarray(0, KEY_LENGTH)); - requestedKey = { - ...requestedKey, - publicAddress, - }; - break; - } - - case IronfishKeys.ViewKey: { - const viewKey = Buffer.from(response.subarray(0, 2 * KEY_LENGTH)); - response = response.subarray(2 * KEY_LENGTH); - - const ivk = Buffer.from(response.subarray(0, KEY_LENGTH)); - response = response.subarray(KEY_LENGTH); - - const ovk = Buffer.from(response.subarray(0, KEY_LENGTH)); - response = response.subarray(KEY_LENGTH); - - requestedKey = { - ...requestedKey, - viewKey, - ivk, - ovk, - }; - break; - } - - case IronfishKeys.ProofGenerationKey: { - const ak = Buffer.from(response.subarray(0, KEY_LENGTH)); - response = response.subarray(KEY_LENGTH); - - const nsk = Buffer.from(response.subarray(0, KEY_LENGTH)); - response = response.subarray(KEY_LENGTH); - - requestedKey = { - ...requestedKey, - ak, - nsk, - }; - break; - } - } - - return requestedKey; - } diff --git a/js/src/index.ts b/js/src/index.ts deleted file mode 100644 index 80058bc..0000000 --- a/js/src/index.ts +++ /dev/null @@ -1,136 +0,0 @@ -/** ****************************************************************************** - * (c) 2019-2020 Zondax GmbH - * (c) 2016-2017 Ledger - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - ******************************************************************************* */ -import { ResponseSign, IronfishIns, IronfishKeys, KeyResponse } from "./types"; - -import GenericApp, { - ConstructorParams, - errorCodeToString, - LedgerError, - PAYLOAD_TYPE, - processErrorResponse, - Transport, -} from "@zondax/ledger-js"; -import { processGetKeysResponse } from "./helper"; -import { REDJUBJUB_SIGNATURE_LEN, P2_VALUES } from "./consts"; - -export * from "./types"; - -export default class IronfishApp extends GenericApp { - readonly INS!: IronfishIns; - constructor(transport: Transport) { - if (transport == null) throw new Error("Transport has not been defined"); - - const params: ConstructorParams = { - cla: 0x59, - ins: { - GET_VERSION: 0x00, - GET_KEYS: 0x01, - SIGN: 0x02, - }, - p1Values: { - ONLY_RETRIEVE: 0x00, - SHOW_ADDRESS_IN_DEVICE: 0x01, - }, - acceptedPathLengths: [3], - chunkSize: 250, - }; - super(transport, params); - } - - async retrieveKeys(path: string, keyType: IronfishKeys, showInDevice: boolean): Promise { - const serializedPath = this.serializePath(path); - const p1 = showInDevice ? this.P1_VALUES.SHOW_ADDRESS_IN_DEVICE : this.P1_VALUES.ONLY_RETRIEVE; - - return await this.transport - .send(this.CLA, this.INS.GET_KEYS, p1, keyType, serializedPath, [ - LedgerError.NoErrors, - ]) - .then((response) => processGetKeysResponse(response, keyType), processErrorResponse); - } - - // #{TODO} --> Create sign methods, this are example ones! - async signSendChunk(chunkIdx: number, chunkNum: number, chunk: Buffer): Promise { - let payloadType = PAYLOAD_TYPE.ADD; - if (chunkIdx === 1) { - payloadType = PAYLOAD_TYPE.INIT; - } - if (chunkIdx === chunkNum) { - payloadType = PAYLOAD_TYPE.LAST; - } - - return await this.transport - .send(this.CLA, this.INS.SIGN, payloadType, P2_VALUES.DEFAULT, chunk, [ - LedgerError.NoErrors, - LedgerError.DataIsInvalid, - LedgerError.BadKeyHandle, - LedgerError.SignVerifyError, - ]) - .then((response: Buffer) => { - const errorCodeData = response.subarray(-2); - const returnCode = errorCodeData[0] * 256 + errorCodeData[1]; - let errorMessage = errorCodeToString(returnCode); - - let signatures: Buffer[] = []; - - if ( - returnCode === LedgerError.BadKeyHandle || - returnCode === LedgerError.DataIsInvalid || - returnCode === LedgerError.SignVerifyError - ) { - errorMessage = `${errorMessage} : ${response.subarray(0, response.length - 2).toString("ascii")}`; - } - - if (returnCode === LedgerError.NoErrors && response.length > 2) { - const signaturesLen = (response.length - 2) / REDJUBJUB_SIGNATURE_LEN - for (let i = 0; i < signaturesLen; i++) { - const tmpSignature = response.subarray(i * REDJUBJUB_SIGNATURE_LEN, i * REDJUBJUB_SIGNATURE_LEN + REDJUBJUB_SIGNATURE_LEN) - signatures.push(tmpSignature) - } - - return { - signatures, - returnCode, - errorMessage, - }; - } - - return { - returnCode, - errorMessage, - }; - }, processErrorResponse); - } - - async sign(path: string, blob: Buffer): Promise { - const chunks = this.prepareChunks(path, blob); - return await this.signSendChunk(1, chunks.length, chunks[0]).then(async (response) => { - let result: ResponseSign = { - returnCode: response.returnCode, - errorMessage: response.errorMessage, - }; - - for (let i = 1; i < chunks.length; i += 1) { - // eslint-disable-next-line no-await-in-loop - result = await this.signSendChunk(1 + i, chunks.length, chunks[i]); - if (result.returnCode !== LedgerError.NoErrors) { - break; - } - } - return result; - }, processErrorResponse); - } -} diff --git a/js/src/types.ts b/js/src/types.ts deleted file mode 100644 index 851cfb6..0000000 --- a/js/src/types.ts +++ /dev/null @@ -1,34 +0,0 @@ -import { INSGeneric, ResponseBase } from "@zondax/ledger-js"; - -export interface IronfishIns extends INSGeneric { - GET_VERSION: 0x00; - GET_KEYS: 0x01; - SIGN: 0x02; -} - -export type KeyResponse = ResponseAddress | ResponseViewKey | ResponseProofGenKey; - -export interface ResponseAddress extends ResponseBase { - publicAddress?: Buffer; -} - -export interface ResponseViewKey extends ResponseBase { - viewKey?: Buffer; - ivk?: Buffer; - ovk?: Buffer; -} - - export interface ResponseProofGenKey extends ResponseBase { - ak?: Buffer; - nsk?: Buffer; -} - -export interface ResponseSign extends ResponseBase { - signatures?: Buffer[]; -} - -export enum IronfishKeys { - PublicAddress = 0x00, - ViewKey = 0x01, - ProofGenerationKey = 0x02, -} diff --git a/js/tsconfig.json b/js/tsconfig.json deleted file mode 100644 index 04515f3..0000000 --- a/js/tsconfig.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "compilerOptions": { - "module": "commonjs", - "target": "es2020", - "moduleResolution": "node", - "strict": true, - "esModuleInterop": true, - "declaration": true, - "forceConsistentCasingInFileNames": true, - "skipLibCheck": true, - "outDir": "./dist" - }, - "exclude": ["dist"] -}