ecash-lib 1.5.1 → 2.0.0

package/README.md

@@ -18,27 +18,9 @@ This library works for both browser and NodeJS.
 
 `npm install --save ecash-lib`
 
-### Setup
-
-To use this library, you first have to initialize the WebAssembly module:
-
-```ts
-import { initWasm } from 'ecash-lib';
-await initWasm();
-```
-
-After that, to sign signatures, you need an "Ecc" instance:
-
-```ts
-import { Ecc } from 'ecash-lib';
-const ecc = new Ecc();
-```
-
-**Note: You should only call this function once, as it's fairly expensive to setup, it internally precomputes some elliptic curve field elements, which takes some time**
-
 ### Usage
 
-Now you're ready to sign your first transactions:
+Here's how to sign your first transaction:
 
 ```ts
 import {
@@ -47,20 +29,15 @@ import {
     Script,
     TxBuilder,
     fromHex,
-    initWasm,
     shaRmd160,
     toHex,
     ALL_BIP143,
 } from 'ecash-lib';
 
-// Download and compile WebAssembly
-await initWasm();
-// Build a signature context for elliptic curve cryptography (ECC)
-const ecc = new Ecc();
 const walletSk = fromHex(
     'e6ae1669c47d092eff3eb652bea535331c338e29f34be709bc4055655cd0e950',
 );
-const walletPk = ecc.derivePubkey(walletSk);
+const walletPk = new Ecc().derivePubkey(walletSk);
 const walletPkh = shaRmd160(walletPk);
 const walletP2pkh = Script.p2pkh(walletPkh);
 // TxId with unspent funds for the above wallet
@@ -90,24 +67,11 @@ const txBuild = new TxBuilder({
         walletP2pkh,
     ],
 });
-const tx = txBuild.sign(ecc, 1000, 546);
+const tx = txBuild.sign({ feePerKb: 1000, dustLimit: 546 });
 const rawTx = tx.ser();
 console.log(toHex(rawTx));
 ```
 
-### Troubleshooting
-
-#### Can't load WebAssembly
-
-Some bundlers can't handle WebAssembly yet (at the time of writing, vite).
-If you run into "CompileError: expected magic word 00 61 73 6d", you can
-provide a custom WASM URL or module:
-
-```ts
-import ecashLibWasmUrl from 'ecash-lib/dist/ffi/ecash_lib_wasm_bg_browser.wasm?url';
-await initWasm(ecashLibWasmUrl);
-```
-
 ## Changelog
 
 -   0.1.1 - Validation that feePerKb is an integer
@@ -125,3 +89,4 @@ await initWasm(ecashLibWasmUrl);
 -   1.4.1 - Patch import in `mnemonic.ts` [D17621](https://reviews.bitcoinabc.org/D17621)
 -   1.5.0 - Support custom WASM URL and module [D17622](https://reviews.bitcoinabc.org/D17622)
 -   1.5.1 - `Address.withPrefix()` returns same prefix if unchanged (instead of throwing an error) [D17623](https://reviews.bitcoinabc.org/D17623)
+-   2.0.0 - Remove `initWasm`, auto-load the WebAssembly instead. Remove unneeded `ecc` parameters, esp. in `TxBuilder.sign` and `HdNode.fromSeed` [D17639](https://reviews.bitcoinabc.org/D17639) [D17640](https://reviews.bitcoinabc.org/D17640)

package/dist/ecc.d.ts

@@ -16,10 +16,6 @@ export interface Ecc {
     /** Add a scalar to a public key (adding G*b) */
     pubkeyAdd(a: Uint8Array, b: Uint8Array): Uint8Array;
 }
-/** Ecc implementation using WebAssembly */
-export declare let Ecc: {
-    new (): Ecc;
-};
 /** Dummy Ecc impl that always returns 0, useful for measuring tx size */
 export declare class EccDummy implements Ecc {
     derivePubkey(_seckey: Uint8Array): Uint8Array;
@@ -29,7 +25,7 @@ export declare class EccDummy implements Ecc {
     seckeyAdd(_a: Uint8Array, _b: Uint8Array): Uint8Array;
     pubkeyAdd(_a: Uint8Array, _b: Uint8Array): Uint8Array;
 }
-export declare function __setEcc(ecc: {
-    new (): Ecc;
-}): void;
+export declare function __setEcc(ecc: Ecc): void;
+export declare class Ecc implements Ecc {
+}
 //# sourceMappingURL=ecc.d.ts.map

package/dist/ecc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ecc.d.ts","sourceRoot":"","sources":["../src/ecc.ts"],"names":[],"mappings":"AAIA,6DAA6D;AAC7D,MAAM,WAAW,GAAG;IAChB,2CAA2C;IAC3C,YAAY,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC;IAE7C,8DAA8D;IAC9D,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,GAAG,UAAU,CAAC;IAE3D,+DAA+D;IAC/D,WAAW,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,GAAG,UAAU,CAAC;IAE7D;;;OAGG;IACH,aAAa,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC;IAE3C,mCAAmC;IACnC,SAAS,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;IAEpD,gDAAgD;IAChD,SAAS,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;CACvD;AAED,2CAA2C;AAC3C,eAAO,IAAI,GAAG,EAAE;IAAE,QAAQ,GAAG,CAAA;CAAE,CAAC;AAEhC,yEAAyE;AACzE,qBAAa,QAAS,YAAW,GAAG;IAChC,YAAY,CAAC,OAAO,EAAE,UAAU,GAAG,UAAU;IAI7C,SAAS,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,GAAG,UAAU;IAI5D,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,GAAG,UAAU;IAI9D,aAAa,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO;IAI3C,SAAS,CAAC,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU,GAAG,UAAU;IAIrD,SAAS,CAAC,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU,GAAG,UAAU;CAGxD;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE;IAAE,QAAQ,GAAG,CAAA;CAAE,QAE5C"}
+{"version":3,"file":"ecc.d.ts","sourceRoot":"","sources":["../src/ecc.ts"],"names":[],"mappings":"AAIA,6DAA6D;AAC7D,MAAM,WAAW,GAAG;IAChB,2CAA2C;IAC3C,YAAY,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC;IAE7C,8DAA8D;IAC9D,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,GAAG,UAAU,CAAC;IAE3D,+DAA+D;IAC/D,WAAW,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,GAAG,UAAU,CAAC;IAE7D;;;OAGG;IACH,aAAa,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC;IAE3C,mCAAmC;IACnC,SAAS,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;IAEpD,gDAAgD;IAChD,SAAS,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;CACvD;AAED,yEAAyE;AACzE,qBAAa,QAAS,YAAW,GAAG;IAChC,YAAY,CAAC,OAAO,EAAE,UAAU,GAAG,UAAU;IAI7C,SAAS,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,GAAG,UAAU;IAI5D,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,GAAG,UAAU;IAI9D,aAAa,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO;IAI3C,SAAS,CAAC,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU,GAAG,UAAU;IAIrD,SAAS,CAAC,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU,GAAG,UAAU;CAGxD;AAID,wBAAgB,QAAQ,CAAC,GAAG,EAAE,GAAG,QAEhC;AAED,qBAAa,GAAI,YAAW,GAAG;CAiC9B"}

package/dist/ecc.js

@@ -3,7 +3,7 @@
 // Distributed under the MIT software license, see the accompanying
 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.__setEcc = exports.EccDummy = exports.Ecc = void 0;
+exports.Ecc = exports.__setEcc = exports.EccDummy = void 0;
 /** Dummy Ecc impl that always returns 0, useful for measuring tx size */
 class EccDummy {
     derivePubkey(_seckey) {
@@ -26,8 +26,39 @@ class EccDummy {
     }
 }
 exports.EccDummy = EccDummy;
+const ECC = {};
 function __setEcc(ecc) {
-    exports.Ecc = ecc;
+    ECC.ecc = ecc;
 }
 exports.__setEcc = __setEcc;
+class Ecc {
+    /** Derive a public key from secret key. */
+    derivePubkey(seckey) {
+        return ECC.ecc.derivePubkey(seckey);
+    }
+    /** Sign an ECDSA signature. msg needs to be a 32-byte hash */
+    ecdsaSign(seckey, msg) {
+        return ECC.ecc.ecdsaSign(seckey, msg);
+    }
+    /** Sign a Schnorr signature. msg needs to be a 32-byte hash */
+    schnorrSign(seckey, msg) {
+        return ECC.ecc.schnorrSign(seckey, msg);
+    }
+    /**
+     * Return whether the given secret key is valid, i.e. whether is of correct
+     * length (32 bytes) and is on the curve.
+     */
+    isValidSeckey(seckey) {
+        return ECC.ecc.isValidSeckey(seckey);
+    }
+    /** Add a scalar to a secret key */
+    seckeyAdd(a, b) {
+        return ECC.ecc.seckeyAdd(a, b);
+    }
+    /** Add a scalar to a public key (adding G*b) */
+    pubkeyAdd(a, b) {
+        return ECC.ecc.pubkeyAdd(a, b);
+    }
+}
+exports.Ecc = Ecc;
 //# sourceMappingURL=ecc.js.map

package/dist/ecc.js.map

@@ -1 +1 @@
-{"version":3,"file":"ecc.js","sourceRoot":"","sources":["../src/ecc.ts"],"names":[],"mappings":";AAAA,4CAA4C;AAC5C,mEAAmE;AACnE,sEAAsE;;;AA6BtE,yEAAyE;AACzE,MAAa,QAAQ;IACjB,YAAY,CAAC,OAAmB;QAC5B,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,SAAS,CAAC,OAAmB,EAAE,IAAgB;QAC3C,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,WAAW,CAAC,OAAmB,EAAE,IAAgB;QAC7C,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,aAAa,CAAC,OAAmB;QAC7B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,SAAS,CAAC,EAAc,EAAE,EAAc;QACpC,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,SAAS,CAAC,EAAc,EAAE,EAAc;QACpC,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;CACJ;AAxBD,4BAwBC;AAED,SAAgB,QAAQ,CAAC,GAAoB;IACzC,WAAG,GAAG,GAAG,CAAC;AACd,CAAC;AAFD,4BAEC"}
+{"version":3,"file":"ecc.js","sourceRoot":"","sources":["../src/ecc.ts"],"names":[],"mappings":";AAAA,4CAA4C;AAC5C,mEAAmE;AACnE,sEAAsE;;;AA0BtE,yEAAyE;AACzE,MAAa,QAAQ;IACjB,YAAY,CAAC,OAAmB;QAC5B,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,SAAS,CAAC,OAAmB,EAAE,IAAgB;QAC3C,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,WAAW,CAAC,OAAmB,EAAE,IAAgB;QAC7C,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,aAAa,CAAC,OAAmB;QAC7B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,SAAS,CAAC,EAAc,EAAE,EAAc;QACpC,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,SAAS,CAAC,EAAc,EAAE,EAAc;QACpC,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;CACJ;AAxBD,4BAwBC;AAED,MAAM,GAAG,GAAkB,EAAE,CAAC;AAE9B,SAAgB,QAAQ,CAAC,GAAQ;IAC7B,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC;AAClB,CAAC;AAFD,4BAEC;AAED,MAAa,GAAG;IACZ,2CAA2C;IAC3C,YAAY,CAAC,MAAkB;QAC3B,OAAO,GAAG,CAAC,GAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,8DAA8D;IAC9D,SAAS,CAAC,MAAkB,EAAE,GAAe;QACzC,OAAO,GAAG,CAAC,GAAI,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3C,CAAC;IAED,+DAA+D;IAC/D,WAAW,CAAC,MAAkB,EAAE,GAAe;QAC3C,OAAO,GAAG,CAAC,GAAI,CAAC,WAAW,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,MAAkB;QAC5B,OAAO,GAAG,CAAC,GAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IAED,mCAAmC;IACnC,SAAS,CAAC,CAAa,EAAE,CAAa;QAClC,OAAO,GAAG,CAAC,GAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACpC,CAAC;IAED,gDAAgD;IAChD,SAAS,CAAC,CAAa,EAAE,CAAa;QAClC,OAAO,GAAG,CAAC,GAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACpC,CAAC;CACJ;AAjCD,kBAiCC"}

package/dist/ffi/ecash_lib_wasm_bg_browser.d.ts

@@ -0,0 +1 @@
+export const ECASH_LIB_WASM_BASE64: string;