feat: inheritance support (#134)

Co-authored-by: Vaibhav Sethia <vrockz747@gmail.com>
Co-authored-by: Parnika Gupta <39666569+VeronicaGupta@users.noreply.github.com>
Co-authored-by: Md Irshad Ansari <irshadjsr21@gmail.com>
Co-authored-by: TejasvOnly <tejasvonly@gmail.com>
Co-authored-by: Tejasv Sharma <tejasvonly@gmail.com>
Co-authored-by: Tejasv Sharma <37572049+TejasvOnly@users.noreply.github.com>
Co-authored-by: Irshad Ansari <40335357+irshadjsr21@users.noreply.github.com>

.changeset/serious-walls-rest.md

@@ -0,0 +1,9 @@
+---
+"@cypherock/sdk-app-inheritance": major
+"@cypherock/sdk-core": minor
+"@cypherock/prettier-config": patch
+"@cypherock/sdk-interfaces": patch
+"nodejs-test": patch
+---
+
+Added Inheritance Support

.changeset/short-ghosts-fetch.md

@@ -0,0 +1,5 @@
+---
+'@cypherock/sdk-core': patch
+---
+
+added inheritance session management

apps/node/package.json

@@ -33,6 +33,7 @@
     "@cypherock/sdk-hw-serialport": "workspace:^",
     "@cypherock/sdk-interfaces": "workspace:^",
     "@cypherock/sdk-utils": "workspace:^",
+    "@cypherock/sdk-app-inheritance": "workspace:^",
     "@solana/web3.js": "^1.87.6",
     "bitcoinjs-lib": "^6.1.3",
     "ethers": "^6.7.0",

package.json

@@ -1,45 +1,45 @@
 {
-    "name": "sdk",
-    "version": "0.0.0",
-    "private": true,
-    "workspaces": [
-        "apps/*",
-        "packages/*"
-    ],
-    "scripts": {
-        "build": "turbo run build --no-daemon",
-        "prebuild": "turbo run prebuild --no-daemon",
-        "dev": "turbo run dev --parallel --no-daemon",
-        "lint": "turbo run lint --no-daemon",
-        "pretty": "turbo run pretty --no-daemon",
-        "lint:check": "turbo run lint:check --no-daemon",
-        "pretty:check": "turbo run pretty:check --no-daemon",
-        "test": "turbo run test --no-daemon",
-        "start:node": "turbo run start:node --no-daemon",
-        "start:browser": "turbo run start:browser --no-daemon",
-        "dev:browser": "turbo run dev:browser --no-daemon",
-        "pre-commit": "turbo run pre-commit --concurrency=1",
-        "prepare": "husky install",
-        "clean": "node scripts/clean.js && bash ./scripts/clean.sh",
-        "clean:force": "node scripts/clean.js -f && bash ./scripts/clean.sh",
-        "ci:publish": "pnpm publish -r --access public --no-git-checks --filter \"@cypherock/sdk-*\"",
-        "ci:version": "pnpm changeset version && pnpm i --no-frozen-lockfile",
-        "doc:serve": "mkdocs serve",
-        "doc:build": "mkdocs build"
-    },
-    "devDependencies": {
-        "@changesets/changelog-github": "^0.4.8",
-        "@changesets/cli": "^2.26.1",
-        "@commitlint/cli": "^17.4.4",
-        "@commitlint/config-conventional": "^17.4.4",
-        "@cypherock/eslint-config": "workspace:*",
-        "@cypherock/prettier-config": "workspace:*",
-        "husky": "^8.0.0",
-        "prettier": "^3.2.4",
-        "turbo": "^1.13.4"
-    },
-    "engines": {
-        "node": ">=18.0.0"
-    },
-    "packageManager": "pnpm@8.6.0"
+  "name": "sdk",
+  "version": "0.0.0",
+  "private": true,
+  "workspaces": [
+    "apps/*",
+    "packages/*"
+  ],
+  "scripts": {
+    "build": "turbo run build --no-daemon",
+    "prebuild": "turbo run prebuild --no-daemon",
+    "dev": "turbo run dev --parallel --no-daemon",
+    "lint": "turbo run lint --no-daemon",
+    "pretty": "turbo run pretty --no-daemon",
+    "lint:check": "turbo run lint:check --no-daemon",
+    "pretty:check": "turbo run pretty:check --no-daemon",
+    "test": "turbo run test --no-daemon",
+    "start:node": "turbo run start:node --no-daemon",
+    "start:browser": "turbo run start:browser --no-daemon",
+    "dev:browser": "turbo run dev:browser --no-daemon",
+    "pre-commit": "turbo run pre-commit --concurrency=1",
+    "prepare": "husky install",
+    "clean": "node scripts/clean.js && bash ./scripts/clean.sh",
+    "clean:force": "node scripts/clean.js -f && bash ./scripts/clean.sh",
+    "ci:publish": "pnpm publish -r --access public --no-git-checks --filter \"@cypherock/sdk-*\"",
+    "ci:version": "pnpm changeset version && pnpm i --no-frozen-lockfile",
+    "doc:serve": "mkdocs serve",
+    "doc:build": "mkdocs build"
+  },
+  "devDependencies": {
+    "@changesets/changelog-github": "^0.4.8",
+    "@changesets/cli": "^2.26.1",
+    "@commitlint/cli": "^17.4.4",
+    "@commitlint/config-conventional": "^17.4.4",
+    "@cypherock/eslint-config": "workspace:*",
+    "@cypherock/prettier-config": "workspace:*",
+    "husky": "^8.0.0",
+    "prettier": "^3.2.4",
+    "turbo": "^1.13.4"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "packageManager": "pnpm@8.6.0"
 }

packages/app-inheritance/.eslintrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  root: true,
+  extends: ['@cypherock/eslint-config'],
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ['./tsconfig.eslint.json'],
+  },
+};

packages/app-inheritance/.gitignore

@@ -0,0 +1,7 @@
+.turbo
+dist
+
+# stryker temp files
+.stryker-tmp
+reports
+src/proto

packages/app-inheritance/.prettierignore

@@ -0,0 +1 @@
+src/proto/generated

packages/app-inheritance/.prettierrc

@@ -0,0 +1 @@
+"@cypherock/prettier-config"

packages/app-inheritance/docs/index.md

@@ -0,0 +1,3 @@
+# Introduction
+
+Documentation pending

packages/app-inheritance/jest.config.js

@@ -0,0 +1,22 @@
+module.exports = {
+  collectCoverage: true,
+  collectCoverageFrom: [
+    'src/**/*.ts',
+    '!src/**/*.test.ts',
+    '!src/**/__fixtures__/*',
+    '!src/proto/generated/**/*',
+  ],
+  testTimeout: 500,
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  rootDir: '.',
+  testPathIgnorePatterns: ['/node_modules/', '/__fixtures__/', '/dist/'],
+  testMatch: [
+    '**/tests/**/*.[jt]s?(x)',
+    '**/__tests__/**/*.[jt]s?(x)',
+    '!**/__mocks__/**/*.[jt]s?(x)',
+    '!**/__helpers__/**/*.[jt]s?(x)',
+    '!**/.stryker-tmp/**/*.[jt]s?(x)',
+  ],
+  modulePathIgnorePatterns: ['<rootDir>/.stryker-tmp'],
+};

packages/app-inheritance/jest.stryker.config.js

@@ -0,0 +1,21 @@
+module.exports = {
+  collectCoverage: true,
+  collectCoverageFrom: [
+    'src/**/*.ts',
+    '!src/**/*.test.ts',
+    '!src/**/__fixtures__/*',
+    '!src/proto/generated/**/*',
+  ],
+  testTimeout: 500,
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  rootDir: '.',
+  testPathIgnorePatterns: ['/node_modules/', '/__fixtures__/', '/dist/'],
+  testMatch: [
+    '**/tests/**/*.[jt]s?(x)',
+    '**/__tests__/**/*.[jt]s?(x)',
+    '!**/__mocks__/**/*.[jt]s?(x)',
+    '!**/__helpers__/**/*.[jt]s?(x)',
+  ],
+  modulePathIgnorePatterns: ['<rootDir>/.stryker-tmp'],
+};

packages/app-inheritance/mkdocs.yml

@@ -0,0 +1 @@
+site_name: '@cypherock/sdk-app-inheritance'

packages/app-inheritance/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@cypherock/sdk-app-inheritance",
+  "version": "0.0.1",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "license": "MIT",
+  "scripts": {
+    "lint": "eslint src/ tests/ --fix",
+    "lint:check": "eslint --ext .ts,tsx,js,jsx,js src/",
+    "pretty": "prettier --write 'src/**/*.ts' 'tests/**/*.ts'",
+    "pretty:check": "prettier --check 'src/**/*.ts' 'tests/**/*.ts'",
+    "prebuild": "bash ./scripts/prebuild.sh",
+    "build": "rimraf dist && tsc -p tsconfig.json",
+    "test": "cross-env LOG_LEVEL=error jest",
+    "test:mutation": "stryker run",
+    "pre-commit": "lint-staged"
+  },
+  "devDependencies": {
+    "@cypherock/eslint-config": "workspace:*",
+    "@cypherock/prettier-config": "workspace:^0.0.7",
+    "@cypherock/tsconfig": "workspace:*",
+    "@jest/globals": "^29.4.1",
+    "@stryker-mutator/core": "^6.4.1",
+    "@stryker-mutator/jest-runner": "^6.4.1",
+    "@stryker-mutator/typescript-checker": "^6.4.1",
+    "@types/jest": "^29.4.0",
+    "@types/node": "18.11.18",
+    "cross-env": "^7.0.3",
+    "eslint": "^7.32.0",
+    "jest": "^29.4.1",
+    "lint-staged": "^13.2.0",
+    "rimraf": "^4.1.2",
+    "ts-jest": "^29.0.5",
+    "ts-proto": "^1.139.0",
+    "typescript": "^4.5.2"
+  },
+  "dependencies": {
+    "@cypherock/sdk-core": "workspace:^0.0.25",
+    "@cypherock/sdk-interfaces": "workspace:^0.0.15",
+    "@cypherock/sdk-utils": "workspace:^0.0.18",
+    "long": "^5.2.1",
+    "protobufjs": "^7.2.2"
+  },
+  "lint-staged": {
+    "*.{ts,tsx}": [
+      "eslint --ext ts,tsx --quiet --fix --",
+      "prettier --write"
+    ],
+    "*.{js,jsx,md,mdx,mjs,yml,yaml,css,json}": [
+      "prettier --write"
+    ]
+  }
+}

packages/app-inheritance/scripts/prebuild.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+set -e
+
+rm -rf ./src/proto/generated/*.ts || true
+rm -rf ./src/proto/generated/inheritance || true
+
+mkdir -p src/proto/generated
+
+if [[ "$OSTYPE" == "msys" ]] || [[ "$OSTYPE" == "win32" ]]; then
+  protoc --plugin=protoc-gen-ts_proto=$(pwd)/node_modules/.bin/protoc-gen-ts_proto.cmd --ts_proto_out=./src/proto/generated ../../submodules/common/proto/inheritance/*.proto ../../submodules/common/proto/common.proto -I../../submodules/common/proto --ts_proto_opt=forceLong=string --ts_proto_opt=esModuleInterop=true
+else
+  protoc --plugin=./node_modules/.bin/protoc-gen-ts_proto --ts_proto_out=./src/proto/generated ../../submodules/common/proto/inheritance/*.proto ../../submodules/common/proto/common.proto -I../../submodules/common/proto --ts_proto_opt=forceLong=string --ts_proto_opt=esModuleInterop=true
+fi
+
+node ../../scripts/extractTypes/index.js ./src/proto/generated ./src/proto/generated/types.ts

packages/app-inheritance/src/__mocks__/sdk.ts

@@ -0,0 +1,60 @@
+import { ISDK } from '@cypherock/sdk-core';
+import { DeviceState } from '@cypherock/sdk-interfaces';
+import { jest } from '@jest/globals';
+
+let sequenceNumber = 0;
+
+export const getStatus = jest.fn<ISDK['getStatus']>();
+export const sendAbort = jest.fn<ISDK['sendAbort']>();
+export const getResult = jest.fn<ISDK['getResult']>();
+export const sendQuery = jest.fn<ISDK['sendQuery']>();
+
+export const configureAppletId = jest.fn<ISDK['configureAppletId']>();
+export const checkAppCompatibility = jest.fn<ISDK['checkAppCompatibility']>();
+
+export const waitForResult = jest.fn<ISDK['waitForResult']>();
+export const getSequenceNumber = jest.fn<ISDK['getSequenceNumber']>(
+  async () => sequenceNumber,
+);
+export const getNewSequenceNumber = jest.fn<ISDK['getNewSequenceNumber']>(
+  async () => {
+    sequenceNumber += 1;
+    return sequenceNumber;
+  },
+);
+
+export const runOperation = jest.fn<ISDK['runOperation']>(func => func());
+
+export const destroy = jest.fn<ISDK['destroy']>();
+export const getDeviceState = jest.fn<ISDK['getDeviceState']>(
+  async () => DeviceState.MAIN,
+);
+
+export const create = jest.fn(async () =>
+  Promise.resolve({
+    configureAppletId,
+    checkAppCompatibility,
+    sendAbort,
+    getResult,
+    getStatus,
+    sendQuery,
+    waitForResult,
+    getSequenceNumber,
+    getNewSequenceNumber,
+    runOperation,
+    destroy,
+    getDeviceState,
+  }),
+);
+
+jest.mock('@cypherock/sdk-core', () => {
+  const originalModule: any = jest.requireActual('@cypherock/sdk-core');
+
+  return {
+    __esModule: true,
+    ...originalModule,
+    SDK: {
+      create,
+    },
+  };
+});

packages/app-inheritance/src/app.ts

@@ -0,0 +1,54 @@
+import { IDeviceConnection } from '@cypherock/sdk-interfaces';
+import { SDK } from '@cypherock/sdk-core';
+import * as operations from './operations';
+
+export class InheritanceApp {
+  private readonly sdk: SDK;
+
+  private static readonly APPLET_ID = 19;
+
+  private constructor(sdk: SDK) {
+    this.sdk = sdk;
+  }
+
+  public static async create(connection: IDeviceConnection) {
+    const sdk = await SDK.create(connection, InheritanceApp.APPLET_ID);
+    return new InheritanceApp(sdk);
+  }
+
+  public async encryptMessagesWithPin(
+    params: operations.IEncryptMessagesWithPinParams,
+  ) {
+    return this.sdk.runOperation(() =>
+      operations.encryptMessageWithPin(this.sdk, params),
+    );
+  }
+
+  public async decryptMessagesWithPin(
+    params: operations.IDecryptMessagesWithPinParams,
+  ) {
+    return this.sdk.runOperation(() =>
+      operations.decryptMessagesWithPin(this.sdk, params),
+    );
+  }
+
+  public async authWallet(params: operations.IAuthWalletParams) {
+    return this.sdk.runOperation(() => operations.authWallet(this.sdk, params));
+  }
+
+  public async startSession() {
+    return this.sdk.runOperation(() => this.sdk.startSession());
+  }
+
+  public async closeSession() {
+    return this.sdk.runOperation(() => this.sdk.closeSession());
+  }
+
+  public async destroy() {
+    return this.sdk.destroy();
+  }
+
+  public async abort() {
+    await this.sdk.sendAbort();
+  }
+}

packages/app-inheritance/src/constants/appId.ts

@@ -0,0 +1,4 @@
+export const APP_VERSION = {
+  from: '1.0.0',
+  to: '2.0.0',
+};

packages/app-inheritance/src/constants/index.ts

@@ -0,0 +1,2 @@
+export * from './appId';
+export * from './walletId';

packages/app-inheritance/src/constants/walletId.ts

@@ -0,0 +1 @@
+export const WALLET_ID_LENGTH = 32;

packages/app-inheritance/src/index.ts

@@ -0,0 +1,3 @@
+export * from './app';
+export * from './types';
+export { updateLogger } from './utils';