From c4a25850cbe917363ea0563f45d1f13ab710c77c Mon Sep 17 00:00:00 2001 From: emmanuelm41 Date: Wed, 16 Oct 2024 15:00:11 -0300 Subject: [PATCH] feat: commit initial codebase --- .github/workflows/main.yml | 34 ++++++ .github/workflows/publish.yml | 46 ++++++++ .gitignore | 76 +++++++++++++ .npmignore | 1 + .prettierignore | 2 + .prettierrc | 13 +++ LICENSE | 201 ++++++++++++++++++++++++++++++++++ README-npm.md | 12 ++ README.md | 13 ++- eslint.config.js | 36 ++++++ jest.config.js | 5 + package.json | 53 +++++++++ src/app.ts | 177 ++++++++++++++++++++++++++++++ src/consts.ts | 12 ++ src/helper.ts | 26 +++++ src/index.ts | 4 + src/types.ts | 23 ++++ tsconfig.json | 14 +++ 18 files changed, 747 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/main.yml create mode 100644 .github/workflows/publish.yml create mode 100644 .gitignore create mode 100644 .npmignore create mode 100644 .prettierignore create mode 100644 .prettierrc create mode 100644 LICENSE create mode 100644 README-npm.md create mode 100644 eslint.config.js create mode 100644 jest.config.js create mode 100644 package.json create mode 100644 src/app.ts create mode 100644 src/consts.ts create mode 100644 src/helper.ts create mode 100644 src/index.ts create mode 100644 src/types.ts create mode 100644 tsconfig.json diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..2cf9d80 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,34 @@ +name: "Main" +on: + - push + +jobs: + configure: + runs-on: ubuntu-latest + outputs: + uid_gid: ${{ steps.get-user.outputs.uid_gid }} + datetime: ${{ steps.get-datetime.outputs.datetime }} + steps: + - id: get-user + run: echo "uid_gid=$(id -u):$(id -g)" >> $GITHUB_OUTPUT + - id: get-datetime + run: echo "datetime=$(date +'%Y%m%d%H%M%S')" >> $GITHUB_OUTPUT + + build: + needs: [configure] + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + submodules: true + - name: Install node + uses: actions/setup-node@v4 + - name: Install dependencies + run: yarn install + - name: Run linter + run: yarn lint + - name: Run formatter + run: yarn format + - name: Build + run: yarn build diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..d90a313 --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,46 @@ +name: "Publish packages" + +on: + release: + types: + - published + - edited + tags: + - "v[0-9]+(\\.[0-9]+)*" + +jobs: + configure: + runs-on: ubuntu-latest + outputs: + datetime: ${{ steps.get-datetime.outputs.datetime }} + steps: + - id: get-datetime + run: echo "datetime=$(date +'%Y%m%d%H%M%S')" >> $GITHUB_OUTPUT + + publish_npm_package: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Install node + uses: actions/setup-node@v4 + with: + registry-url: "https://registry.npmjs.org" + scope: "@zondax" + - run: mv README-npm.md README.md + - name: Install yarn + run: npm install -g yarn + - run: yarn install + - run: yarn build + - name: Get latest release version number + id: get_version + uses: battila7/get-version-action@v2 + - name: Update tag + run: | + echo Publishing as ${{ steps.get_version.outputs.version }} + npm --allow-same-version --no-git-tag-version version ${{ steps.get_version.outputs.version }} + - name: Publish package + env: + NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN_PUBLISH_AUTO }} + run: | + npm publish diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e5b4b86 --- /dev/null +++ b/.gitignore @@ -0,0 +1,76 @@ +# 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 +node_modules + +/certs/cert.pem +/certs/server.cert +/certs/server.key diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..3c3629e --- /dev/null +++ b/.npmignore @@ -0,0 +1 @@ +node_modules diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 0000000..de4d1f0 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,2 @@ +dist +node_modules diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..53676ef --- /dev/null +++ b/.prettierrc @@ -0,0 +1,13 @@ +{ + "singleQuote": true, + "arrowParens": "avoid", + "semi": false, + "useTabs": false, + "printWidth": 140, + "tabWidth": 2, + "importOrder": ["^@(.*)/(.*)$", "^[./]"], + "trailingComma": "es5", + "plugins": ["@trivago/prettier-plugin-sort-imports"], + "importOrderSeparation": true, + "importOrderSortSpecifiers": true +} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d9005ef --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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/README-npm.md b/README-npm.md new file mode 100644 index 0000000..2402718 --- /dev/null +++ b/README-npm.md @@ -0,0 +1,12 @@ +# @zondax/ledger-penumbra + +[![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-penumbra.svg)](https://badge.fury.io/js/%40zondax%2Fledger-penumbra) + +This package provides a basic client library to communicate with the Penumbra 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/README.md b/README.md index 3066a2d..2402718 100644 --- a/README.md +++ b/README.md @@ -1 +1,12 @@ -# ledger-penumbra-js +# @zondax/ledger-penumbra + +[![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-penumbra.svg)](https://badge.fury.io/js/%40zondax%2Fledger-penumbra) + +This package provides a basic client library to communicate with the Penumbra 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/eslint.config.js b/eslint.config.js new file mode 100644 index 0000000..2756834 --- /dev/null +++ b/eslint.config.js @@ -0,0 +1,36 @@ +module.exports = { + languageOptions: { + ecmaVersion: 'latest', + sourceType: 'module', + globals: { + window: 'readonly', + document: 'readonly', + process: 'readonly', + require: 'readonly', + }, + parserOptions: { + project: 'tsconfig.json', + }, + }, + ignores: ['dist/*', 'node_modules/*'], + plugins: { + 'unused-imports': require('eslint-plugin-unused-imports'), + '@typescript-eslint': require('@typescript-eslint/eslint-plugin'), + 'eslint-plugin-tsdoc': require('eslint-plugin-tsdoc'), + }, + rules: { + curly: 'warn', + 'prefer-const': 'warn', + 'no-else-return': 'warn', + complexity: ['warn', 1000], + 'no-unneeded-ternary': 'warn', + 'no-alert': 'warn', + 'no-empty': 'warn', + 'no-useless-catch': 'error', + 'require-await': 'warn', + 'no-continue': 'warn', + 'no-console': 'warn', + 'unused-imports/no-unused-imports': 'warn', + 'no-magic-numbers': 'off', + }, +} diff --git a/jest.config.js b/jest.config.js new file mode 100644 index 0000000..ceab690 --- /dev/null +++ b/jest.config.js @@ -0,0 +1,5 @@ +module.exports = { + preset: 'ts-jest', + testEnvironment: 'node', + testPathIgnorePatterns: ['/node_modules/', '/dist/'], +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..9711eb4 --- /dev/null +++ b/package.json @@ -0,0 +1,53 @@ +{ + "name": "@zondax/ledger-penumbra", + "author": "Zondax AG", + "license": "Apache-2.0", + "version": "0.0.1", + "description": "The API for the penumbra 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-penumbra", + "repository": { + "type": "git", + "url": "git+https://github.com/zondax/ledger-penumbra.git" + }, + "keywords": [ + "Zondax", + "Ledger", + "Javascript", + "Penumbra" + ], + "scripts": { + "build": "tsc", + "lint": "eslint .", + "lint:fix": "eslint --fix .", + "format": "prettier --write ." + }, + "bugs": { + "url": "https://github.com/zondax/ledger-penumbra/issues" + }, + "dependencies": { + "@zondax/ledger-js": "^1.0.1" + }, + "devDependencies": { + "@trivago/prettier-plugin-sort-imports": "^4.3.0", + "@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", + "eslint-plugin-tsdoc": "^0.3.0", + "eslint-plugin-unused-imports": "^4.0.0", + "prettier": "^3.3.2", + "sort-package-json": "^2.10.0", + "typescript": "^5.4.5" + }, + "files": [ + "dist/**/*" + ] +} diff --git a/src/app.ts b/src/app.ts new file mode 100644 index 0000000..c1a9abc --- /dev/null +++ b/src/app.ts @@ -0,0 +1,177 @@ +/** ****************************************************************************** + * (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 { P2_VALUES, PREHASH_LEN, RANDOMIZER_LEN, SIGRSLEN } from "./consts"; +import { ResponseAddress, ResponseFvk, PenumbraIns, ResponseSign } from "./types"; + +import BaseApp, { + ConstructorParams, + LedgerError, + PAYLOAD_TYPE, + processErrorResponse, + Transport, + BIP32Path, +} from "@zondax/ledger-js"; +import { processGetAddrResponse, processGetFvkResponse } from "./helper"; + +// https://buf.build/penumbra-zone/penumbra/docs/main:penumbra.custody.v1#penumbra.custody.v1.ConfirmAddressRequest + +export * from "./types"; + +export class PenumbraApp extends BaseApp { + readonly INS!: PenumbraIns; + constructor(transport: Transport) { + if (transport == null) throw new Error("Transport has not been defined"); + + const params: ConstructorParams = { + cla: 0x80, + ins: { + GET_VERSION: 0x00, + GET_ADDR: 0x01, + SIGN: 0x02, + FVK: 0x03, + }, + p1Values: { + ONLY_RETRIEVE: 0x00, + SHOW_ADDRESS_IN_DEVICE: 0x01, + }, + acceptedPathLengths: [3], + chunkSize: 250, + }; + super(transport, params); + } + + async getAddress( + path: string, + account: number, + randomizer: string | undefined = undefined, + ): Promise { + const data = this._prepareAddressData(path, account, randomizer); + try { + const responseBuffer = await this.transport.send( + this.CLA, + this.INS.GET_ADDR, + this.P1_VALUES.ONLY_RETRIEVE, + P2_VALUES.DEFAULT, + data, + ); + + const response = processGetAddrResponse(responseBuffer); + + return { + address: response.address, + } as ResponseAddress; + } catch (e) { + throw processErrorResponse(e); + } + } + + async showAddress( + path: string, + account: number, + randomizer: string | undefined = undefined, + ): Promise { + const data = this._prepareAddressData(path, account, randomizer); + + try { + const responseBuffer = await this.transport.send( + this.CLA, + this.INS.GET_ADDR, + this.P1_VALUES.SHOW_ADDRESS_IN_DEVICE, + P2_VALUES.DEFAULT, + data, + ); + + const response = processGetAddrResponse(responseBuffer); + + return { + address: response.address, + } as ResponseAddress; + } catch (e) { + throw processErrorResponse(e); + } + } + + async getFVK(path: string, account: number): Promise { + const updatedPath = this._updatePathWithAccount(path, account); + const serializedPath = this.serializePath(updatedPath); + + // Fvk can be retrieved without user confirmation + try { + const responseBuffer = await this.transport.send( + this.CLA, + this.INS.FVK, + this.P1_VALUES.ONLY_RETRIEVE, + P2_VALUES.DEFAULT, + serializedPath, + ); + + const response = processGetFvkResponse(responseBuffer); + + return { + fvk: response.fvk, + } as ResponseFvk; + } catch (e) { + throw processErrorResponse(e); + } + } + + async sign(path: BIP32Path, account: number, blob: Buffer): Promise { + const updatedPath = this._updatePathWithAccount(path, account); + console.log("updatedPath!!!!!", blob.length, updatedPath); + const chunks = this.prepareChunks(updatedPath, blob); + console.log("chunks!!!!!", chunks.length, chunks[0]); + try { + let signatureResponse = await this.signSendChunk(this.INS.SIGN, 1, chunks.length, chunks[0]); + + for (let i = 1; i < chunks.length; i += 1) { + signatureResponse = await this.signSendChunk(this.INS.SIGN, 1 + i, chunks.length, chunks[i]); + } + return { + signature: signatureResponse.readBytes(signatureResponse.length()), + }; + } catch (e) { + throw processErrorResponse(e); + } + } + + private _prepareAddressData(path: string, account: number, randomizer: string | undefined = undefined): Buffer { + // Add /x' to the end of the path where x is the number in account + const updatedPath = this._updatePathWithAccount(path, account); + const serializedPath = this.serializePath(updatedPath); + // Serialize account + const accountBuffer = Buffer.alloc(4); + accountBuffer.writeUInt32BE(account); + const randomizerBuffer = randomizer ? Buffer.from(randomizer, "hex") : undefined; + // Ensure randomizerBuffer does not exceed 12 bytes + if (randomizerBuffer && randomizerBuffer.length > RANDOMIZER_LEN) { + throw new Error("randomizerBuffer exceeds the maximum allowed length of 12 bytes"); + } + + // concatenate data + const concatenatedBuffer: Buffer = Buffer.concat([ + serializedPath, + accountBuffer, + ...(randomizerBuffer ? [randomizerBuffer] : []), + ]); + + return concatenatedBuffer; + } + + private _updatePathWithAccount(path: string, account: number): string { + return `${path}/${account}'`; + } +} diff --git a/src/consts.ts b/src/consts.ts new file mode 100644 index 0000000..cbb8073 --- /dev/null +++ b/src/consts.ts @@ -0,0 +1,12 @@ +export const APP_KEY = "PENUMBRA"; + +export const P2_VALUES = { + DEFAULT: 0x00, +}; + +export const PKLEN = 65; +export const ADDRLEN = 80; +export const FVKLEN = 64; +export const SIGRSLEN = 64; +export const PREHASH_LEN = 32; +export const RANDOMIZER_LEN = 12; diff --git a/src/helper.ts b/src/helper.ts new file mode 100644 index 0000000..977957a --- /dev/null +++ b/src/helper.ts @@ -0,0 +1,26 @@ +import { ADDRLEN, FVKLEN } from "./consts"; +import { ResponseAddress, ResponseFvk } from "./types"; + +export function processGetAddrResponse(response: Buffer): ResponseAddress { + const errorCodeData = response.subarray(-2); + const returnCode = errorCodeData[0] * 256 + errorCodeData[1]; + + const address = Buffer.from(response.subarray(0, ADDRLEN)); + response = response.subarray(ADDRLEN); + + return { + address, + }; +} + +export function processGetFvkResponse(response: Buffer): ResponseFvk { + const errorCodeData = response.subarray(-2); + const returnCode = errorCodeData[0] * 256 + errorCodeData[1]; + + const fvk = Buffer.from(response.subarray(0, FVKLEN)); + response = response.subarray(FVKLEN); + + return { + fvk, + }; +} diff --git a/src/index.ts b/src/index.ts new file mode 100644 index 0000000..7b8424f --- /dev/null +++ b/src/index.ts @@ -0,0 +1,4 @@ +export * from "./app"; +export * from "./types"; +export * from "./consts"; +export * from "./helper"; diff --git a/src/types.ts b/src/types.ts new file mode 100644 index 0000000..21116ca --- /dev/null +++ b/src/types.ts @@ -0,0 +1,23 @@ +import { INSGeneric } from "@zondax/ledger-js"; + +export interface PenumbraIns extends INSGeneric { + GET_VERSION: 0x00; + GET_ADDR: 0x01; + SIGN: 0x02; + FVK: 0x03; +} + +export interface ResponseAddress { + // publicKey?: Buffer; + // principal?: Buffer; + address?: Buffer; + // principalText?: string; +} + +export interface ResponseFvk { + fvk?: Buffer; +} + +export interface ResponseSign { + signature: Buffer; +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..04515f3 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,14 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es2020", + "moduleResolution": "node", + "strict": true, + "esModuleInterop": true, + "declaration": true, + "forceConsistentCasingInFileNames": true, + "skipLibCheck": true, + "outDir": "./dist" + }, + "exclude": ["dist"] +}