From 12ef6b9c99786c85785a8fa9ab6cb6a75a2162fc Mon Sep 17 00:00:00 2001 From: coderofstuff <114628839+coderofstuff@users.noreply.github.com> Date: Sun, 3 Dec 2023 19:30:25 -0700 Subject: [PATCH 1/2] Convert nodejs samples to typescript --- wasm/nodejs/.gitignore | 3 +- wasm/nodejs/README.md | 19 ++++ wasm/nodejs/{addresses.js => addresses.ts} | 12 +- wasm/nodejs/{derivation.js => derivation.ts} | 15 +-- wasm/nodejs/package.json | 12 +- wasm/nodejs/tsconfig.json | 109 +++++++++++++++++++ 6 files changed, 153 insertions(+), 17 deletions(-) create mode 100644 wasm/nodejs/README.md rename wasm/nodejs/{addresses.js => addresses.ts} (90%) rename wasm/nodejs/{derivation.js => derivation.ts} (66%) create mode 100644 wasm/nodejs/tsconfig.json diff --git a/wasm/nodejs/.gitignore b/wasm/nodejs/.gitignore index 25c8fdbab..87807d97c 100644 --- a/wasm/nodejs/.gitignore +++ b/wasm/nodejs/.gitignore @@ -1,2 +1,3 @@ node_modules -package-lock.json \ No newline at end of file +package-lock.json +dist diff --git a/wasm/nodejs/README.md b/wasm/nodejs/README.md new file mode 100644 index 000000000..1bf847c84 --- /dev/null +++ b/wasm/nodejs/README.md @@ -0,0 +1,19 @@ +# Testing Typescript Files + +Run this command + +``` +npx ts-node .ts +``` + +## Example + +npx ts-node addresses.ts + +## Transpile to Javascript + +``` +npm run build +// to test +node dist/index.js +``` \ No newline at end of file diff --git a/wasm/nodejs/addresses.js b/wasm/nodejs/addresses.ts similarity index 90% rename from wasm/nodejs/addresses.js rename to wasm/nodejs/addresses.ts index 1735ca639..2dbd6e31b 100644 --- a/wasm/nodejs/addresses.js +++ b/wasm/nodejs/addresses.ts @@ -1,11 +1,11 @@ -let kaspa = require('./kaspa/kaspa_wasm'); -let { +import * as kaspa from "./kaspa/kaspa_wasm"; +import { PrivateKey, PublicKey, XPublicKey, createAddress, NetworkType, -} = kaspa; +} from "./kaspa/kaspa_wasm"; kaspa.initConsolePanicHook(); @@ -16,7 +16,7 @@ kaspa.initConsolePanicHook(); /*** Advanced ***/ // HD Wallet-style public key generation - let xpub = await XPublicKey.fromMasterXPrv( + let xpub: XPublicKey = await XPublicKey.fromMasterXPrv( "kprv5y2qurMHCsXYrNfU3GCihuwG3vMqFji7PZXajMEqyBkNh9UZUJgoHYBLTKu1eM4MvUtomcXPQ3Sw9HZ5ebbM4byoUciHo1zrPJBQfqpLorQ", false, 0n @@ -27,13 +27,13 @@ kaspa.initConsolePanicHook(); // Generates the first 10 Receive Public keys and their addresses let compressedPublicKeys = await xpub.receivePubkeys(0, 10); console.log("receive address compressedPublicKeys", compressedPublicKeys); - let addresses = compressedPublicKeys.map(key => createAddress(key, NetworkType.Mainnet).toString()); + let addresses = compressedPublicKeys.map((key: string) => createAddress(key, NetworkType.Mainnet).toString()); console.log("receive addresses", addresses); // Generates the first 10 Change Public keys and their addresses compressedPublicKeys = await xpub.changePubkeys(0, 10); console.log("change address compressedPublicKeys", compressedPublicKeys) - addresses = compressedPublicKeys.map(key => createAddress(key, NetworkType.Mainnet).toString()); + addresses = compressedPublicKeys.map((key: string) => createAddress(key, NetworkType.Mainnet).toString()); console.log("change addresses", addresses); })(); diff --git a/wasm/nodejs/derivation.js b/wasm/nodejs/derivation.ts similarity index 66% rename from wasm/nodejs/derivation.js rename to wasm/nodejs/derivation.ts index 46aed07ee..dd478b623 100644 --- a/wasm/nodejs/derivation.js +++ b/wasm/nodejs/derivation.ts @@ -1,33 +1,34 @@ -const kaspa = require('./kaspa/kaspa_wasm'); -const { +import * as kaspa from './kaspa/kaspa_wasm'; +import { Mnemonic, XPrv, + XPub, DerivationPath -} = kaspa; +} from './kaspa/kaspa_wasm'; kaspa.initConsolePanicHook(); (async () => { - const mnemonic = Mnemonic.random(); + const mnemonic: Mnemonic = Mnemonic.random(); console.log("mnemonic:", mnemonic); const seed = mnemonic.toSeed("my_password"); console.log("seed:", seed); // --- - const xPrv = new XPrv(seed); + const xPrv: XPrv = new XPrv(seed); console.log("xPrv", xPrv.intoString("xprv")) console.log("xPrv", xPrv.derivePath("m/1'/2'/3").intoString("xprv")) - const path = new DerivationPath("m/1'"); + const path: DerivationPath = new DerivationPath("m/1'"); path.push(2, true); path.push(3, false); console.log(`path: ${path}`); console.log("xPrv", xPrv.derivePath(path).intoString("xprv")) - const xPub = xPrv.publicKey(); + const xPub: XPub = xPrv.publicKey(); console.log("xPub", xPub.derivePath("m/1").intoString("xpub")); })(); diff --git a/wasm/nodejs/package.json b/wasm/nodejs/package.json index c0ab8f8bb..7fc32ae26 100644 --- a/wasm/nodejs/package.json +++ b/wasm/nodejs/package.json @@ -1,7 +1,13 @@ { - "name" : "kaspa-wasm-nodejs", - "version" : "1.0.0", + "name": "kaspa-wasm-nodejs", + "version": "1.0.0", + "scripts": { + "build": "tsc && cp ./kaspa/kaspa_wasm_bg.wasm ./dist/kaspa/kaspa_wasm_bg.wasm", + "ts-node": "ts-node" + }, "dependencies": { - "websocket" : "1.0.34" + "@types/node": "^20.10.3", + "ts-node": "^10.9.1", + "websocket": "1.0.34" } } diff --git a/wasm/nodejs/tsconfig.json b/wasm/nodejs/tsconfig.json new file mode 100644 index 000000000..f8cd75150 --- /dev/null +++ b/wasm/nodejs/tsconfig.json @@ -0,0 +1,109 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "es2022", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + + /* Modules */ + "module": "commonjs", /* Specify what module code is generated. */ + // "rootDir": "./", /* Specify the root folder within your source files. */ + "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ + // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ + // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ + // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + + /* Emit */ + // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + "outDir": "dist", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ + + /* Type Checking */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +} From 0970fcb01f56d1b5b97f947a32b3c663eccae4a1 Mon Sep 17 00:00:00 2001 From: coderofstuff <114628839+coderofstuff@users.noreply.github.com> Date: Sun, 3 Dec 2023 22:29:32 -0700 Subject: [PATCH 2/2] Add tsc to node deps --- wasm/nodejs/package.json | 1 + 1 file changed, 1 insertion(+) diff --git a/wasm/nodejs/package.json b/wasm/nodejs/package.json index 7fc32ae26..8824eadd0 100644 --- a/wasm/nodejs/package.json +++ b/wasm/nodejs/package.json @@ -8,6 +8,7 @@ "dependencies": { "@types/node": "^20.10.3", "ts-node": "^10.9.1", + "tsc": "^2.0.4", "websocket": "1.0.34" } }