Full conversion to typescript (#5)

* Full conversion to typescript

* Fix export logic

* README fixes

* Version bump to 1.1.0

While this looks like a significant change, the code is semantically the same as before

getAddress is a typo and has been renamed to the correct getPublicKey. I'm the only user of this repo at this time and I'll be changing all references to the correct one when updating to this version so I consider this all a minor change.

Breaking change:
- getAddress is now getPublicKey (which is what it should've been in the first place)

Author: coderofstuff

.gitignore

@@ -1 +1,2 @@
-node_modules/
+node_modules/
+coverage

README.md

@@ -14,7 +14,7 @@ Ledger Hardware Wallet Kaspa JavaScript bindings.
 *   [Kaspa](#kaspa)
     *   [Parameters](#parameters)
     *   [Examples](#examples)
-    *   [getAddress](#getaddress)
+    *   [getPublicKey](#getaddress)
         *   [Parameters](#parameters-1)
         *   [Examples](#examples-1)
     *   [signTransaction](#signtransaction)
@@ -32,13 +32,13 @@ Kaspa API
 #### Examples
 
 ```javascript
-import Kaspa from "@ledgerhq/hw-app-kaspa";
+import Kaspa from "hw-app-kaspa";
 const kaspa = new Kaspa(transport);
 ```
 
-#### getAddress
+#### getPublicKey
 
-Get Kaspa address (public key) for a BIP32 path.
+Get Kaspa Public Key for a BIP32 path.
 
 ##### Parameters
 
@@ -48,10 +48,10 @@ Get Kaspa address (public key) for a BIP32 path.
 ##### Examples
 
 ```javascript
-kaspa.getAddress("44'/111111'/0'").then(r => r.address)
+kaspa.getPublicKey("44'/111111'/0'")
 ```
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{address: [Buffer](https://nodejs.org/api/buffer.html)}>** an object with the address field
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Buffer](https://nodejs.org/api/buffer.html)>** the public key buffer with chain code
 
 #### signTransaction
 
@@ -63,9 +63,9 @@ Sign a Kaspa transaction.
 
 ##### Examples
 
-```javascript
-const Kaspa = require("../src/kaspa");
-const { TransactionInput, TransactionOutput, Transaction } = require("../src/transaction");
+```typescript
+import Kaspa from 'hw-app-kaspa';
+import { TransactionInput, TransactionOutput, Transaction } from 'hw-app-kaspa';
 
 ...
 

index.js

@@ -0,0 +1,10 @@
+export default {
+    preset: "ts-jest",
+    testEnvironment: "node",
+    testRegex: ".test.ts$",
+    collectCoverage: true,
+    testPathIgnorePatterns: ["packages/*/lib-es", "packages/*/lib"],
+    coveragePathIgnorePatterns: ["packages/create-dapp"],
+    passWithNoTests: true,
+    rootDir: __dirname,
+};

jest.config.ts

@@ -0,0 +1,4 @@
+import Kaspa from './kaspa';
+export { TransactionInput, TransactionOutput, Transaction } from './transaction';
+export default Kaspa;
+//# sourceMappingURL=index.d.ts.map

lib-es/index.d.ts

@@ -0,0 +1,60 @@
+/// <reference types="node" />
+import Transport from "@ledgerhq/hw-transport";
+import { Transaction } from "./transaction";
+declare class Kaspa {
+    /**
+     * @type {Transport}
+     */
+    transport: Transport;
+    constructor(transport: Transport);
+    /**
+     * Get Kaspa address (public key) for a BIP32 path.
+     *
+     * @param {string} path a BIP32 path
+     * @param {boolean} display flag to show display
+     * @returns {Buffer} an object with the address field
+     *
+     * @example
+     * kaspa.getPublicKey("44'/111111'/0'").then(r => r.address)
+     */
+    getPublicKey(path: any, display?: boolean): Promise<Buffer>;
+    /**
+     * Sign a Kaspa transaction. Applies the signatures into the input objects
+     *
+     * @param {Transaction} transaction - the Transaction object
+     *
+     *
+     * @example
+     * kaspa.signTransaction(transaction)
+     */
+    signTransaction(transaction: Transaction): Promise<void>;
+    /**
+     * Sign personal message on the device
+     * @param {String} message - the personal message string to sign. Max 120 len for Nano S, 200 len for others
+     * @param {0|1} addressType
+     * @param {number} addressIndex
+     *
+     * @returns {Buffer} application config object
+     *
+     * @example
+     * kaspa.signMessage(message).then(r => r.version)
+     */
+    signMessage(message: string, addressType: 0 | 1, addressIndex: number): Promise<{
+        signature: string;
+        messageHash: string;
+    }>;
+    /**
+     * Get application configuration.
+     *
+     * @returns {Buffer} application config object
+     *
+     * @example
+     * kaspa.getVersion().then(r => r.version)
+     */
+    getVersion(): Promise<{
+        version: string;
+    }>;
+    sendToDevice(instruction: any, p1: any, payload?: Buffer, p2?: number): Promise<Buffer>;
+}
+export default Kaspa;
+//# sourceMappingURL=kaspa.d.ts.map