ecash-lib 3.0.0 → 3.1.0

package/README.md

@@ -92,3 +92,4 @@ console.log(toHex(rawTx));
 -   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)
 -   2.1.0 - Add `signRecoverable` and `recoverSig` to `Ecc` [D17667](https://reviews.bitcoinabc.org/D17667)
 -   3.0.0 - Improve types and shapes in line with chronik proto updates [D17650](https://reviews.bitcoinabc.org/D17650)
+-   3.1.0 - Add methods for signing and verifying messages [D17778](https://reviews.bitcoinabc.org/D17778)

package/dist/ecc.d.ts

@@ -4,8 +4,18 @@ export interface Ecc {
     derivePubkey(seckey: Uint8Array): Uint8Array;
     /** Sign an ECDSA signature. msg needs to be a 32-byte hash */
     ecdsaSign(seckey: Uint8Array, msg: Uint8Array): Uint8Array;
+    /**
+     * Verify an ECDSA signature. msg needs to be a 32-byte hash.
+     * Throws an exception if the signature is invalid.
+     **/
+    ecdsaVerify(sig: Uint8Array, msg: Uint8Array, pk: Uint8Array): void;
     /** Sign a Schnorr signature. msg needs to be a 32-byte hash */
     schnorrSign(seckey: Uint8Array, msg: Uint8Array): Uint8Array;
+    /**
+     * Verify a Schnorr signature. msg needs to be a 32-byte hash.
+     * Throws an exception if the signature is invalid.
+     **/
+    schnorrVerify(sig: Uint8Array, msg: Uint8Array, pk: Uint8Array): void;
     /**
      * Return whether the given secret key is valid, i.e. whether is of correct
      * length (32 bytes) and is on the curve.
@@ -19,19 +29,26 @@ export interface Ecc {
     signRecoverable(seckey: Uint8Array, msg: Uint8Array): Uint8Array;
     /** Recover the public key of an ECDSA signed signature (with recovery ID) */
     recoverSig(sig: Uint8Array, msg: Uint8Array): Uint8Array;
+    /** Compress an uncompressed public key (must start with 0x04) */
+    compressPk(pk: Uint8Array): Uint8Array;
 }
 /** Dummy Ecc impl that always returns 0, useful for measuring tx size */
 export declare class EccDummy implements Ecc {
     derivePubkey(_seckey: Uint8Array): Uint8Array;
     ecdsaSign(_seckey: Uint8Array, _msg: Uint8Array): Uint8Array;
+    ecdsaVerify(_sig: Uint8Array, _msg: Uint8Array, _pk: Uint8Array): void;
     schnorrSign(_seckey: Uint8Array, _msg: Uint8Array): Uint8Array;
+    schnorrVerify(_sig: Uint8Array, _msg: Uint8Array, _pk: Uint8Array): void;
     isValidSeckey(_seckey: Uint8Array): boolean;
     seckeyAdd(_a: Uint8Array, _b: Uint8Array): Uint8Array;
     pubkeyAdd(_a: Uint8Array, _b: Uint8Array): Uint8Array;
     signRecoverable(_seckey: Uint8Array, _msg: Uint8Array): Uint8Array;
     recoverSig(_sig: Uint8Array, _msg: Uint8Array): Uint8Array;
+    compressPk(_pk: Uint8Array): Uint8Array;
 }
-export declare function __setEcc(ecc: Ecc): void;
+type FfiEcc = Omit<Ecc, 'compressPk'>;
+export declare function __setEcc(ecc: FfiEcc): void;
 export declare class Ecc implements Ecc {
 }
+export {};
 //# 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;IAEpD,mEAAmE;IACnE,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,GAAG,UAAU,CAAC;IAEjE,6EAA6E;IAC7E,UAAU,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,GAAG,UAAU,CAAC;CAC5D;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;IAIrD,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,GAAG,UAAU;IAIlE,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,GAAG,UAAU;CAG7D;AAID,wBAAgB,QAAQ,CAAC,GAAG,EAAE,GAAG,QAEhC;AAED,qBAAa,GAAI,YAAW,GAAG;CAyC9B"}
+{"version":3,"file":"ecc.d.ts","sourceRoot":"","sources":["../src/ecc.ts"],"names":[],"mappings":"AAIA,6DAA6D;AAE7D,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;;;QAGI;IACJ,WAAW,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU,GAAG,IAAI,CAAC;IAEpE,+DAA+D;IAC/D,WAAW,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,GAAG,UAAU,CAAC;IAE7D;;;QAGI;IACJ,aAAa,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU,GAAG,IAAI,CAAC;IAEtE;;;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;IAEpD,mEAAmE;IACnE,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,GAAG,UAAU,CAAC;IAEjE,6EAA6E;IAC7E,UAAU,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,GAAG,UAAU,CAAC;IAEzD,iEAAiE;IACjE,UAAU,CAAC,EAAE,EAAE,UAAU,GAAG,UAAU,CAAC;CAC1C;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,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,GAAG,IAAI;IAEtE,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,GAAG,UAAU;IAI9D,aAAa,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,GAAG,IAAI;IAExE,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;IAIrD,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,GAAG,UAAU;IAIlE,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,GAAG,UAAU;IAI1D,UAAU,CAAC,GAAG,EAAE,UAAU,GAAG,UAAU;CAG1C;AAED,KAAK,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;AAGtC,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,QAEnC;AAGD,qBAAa,GAAI,YAAW,GAAG;CAmE9B"}

package/dist/ecc.js

@@ -12,9 +12,11 @@ class EccDummy {
     ecdsaSign(_seckey, _msg) {
         return new Uint8Array(73);
     }
+    ecdsaVerify(_sig, _msg, _pk) { }
     schnorrSign(_seckey, _msg) {
         return new Uint8Array(64);
     }
+    schnorrVerify(_sig, _msg, _pk) { }
     isValidSeckey(_seckey) {
         return false;
     }
@@ -30,6 +32,9 @@ class EccDummy {
     recoverSig(_sig, _msg) {
         return new Uint8Array(33);
     }
+    compressPk(_pk) {
+        return new Uint8Array(33);
+    }
 }
 exports.EccDummy = EccDummy;
 const ECC = {};
@@ -37,6 +42,7 @@ function __setEcc(ecc) {
     ECC.ecc = ecc;
 }
 exports.__setEcc = __setEcc;
+// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
 class Ecc {
     /** Derive a public key from secret key. */
     derivePubkey(seckey) {
@@ -46,10 +52,24 @@ class Ecc {
     ecdsaSign(seckey, msg) {
         return ECC.ecc.ecdsaSign(seckey, msg);
     }
+    /**
+     * Verify an ECDSA signature. msg needs to be a 32-byte hash.
+     * Throws an exception if the signature is invalid.
+     **/
+    ecdsaVerify(sig, msg, pk) {
+        ECC.ecc?.ecdsaVerify(sig, msg, pk);
+    }
     /** Sign a Schnorr signature. msg needs to be a 32-byte hash */
     schnorrSign(seckey, msg) {
         return ECC.ecc.schnorrSign(seckey, msg);
     }
+    /**
+     * Verify a Schnorr signature. msg needs to be a 32-byte hash.
+     * Throws an exception if the signature is invalid.
+     **/
+    schnorrVerify(sig, msg, pk) {
+        ECC.ecc?.schnorrVerify(sig, msg, pk);
+    }
     /**
      * Return whether the given secret key is valid, i.e. whether is of correct
      * length (32 bytes) and is on the curve.
@@ -71,6 +91,15 @@ class Ecc {
     recoverSig(sig, msg) {
         return ECC.ecc.recoverSig(sig, msg);
     }
+    compressPk(pk) {
+        if (pk[0] != 0x04) {
+            throw new Error('Uncompressed pubkey must start with 0x04');
+        }
+        const compressedPk = new Uint8Array(33);
+        compressedPk[0] = 0x02 | (pk[64] & 0x01);
+        compressedPk.set(pk.slice(1, 33), 1);
+        return compressedPk;
+    }
 }
 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;;;AAgCtE,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;IAED,eAAe,CAAC,OAAmB,EAAE,IAAgB;QACjD,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,UAAU,CAAC,IAAgB,EAAE,IAAgB;QACzC,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;CACJ;AAhCD,4BAgCC;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;IAED,eAAe,CAAC,MAAkB,EAAE,GAAe;QAC/C,OAAO,GAAG,CAAC,GAAI,CAAC,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjD,CAAC;IAED,UAAU,CAAC,GAAe,EAAE,GAAe;QACvC,OAAO,GAAG,CAAC,GAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACzC,CAAC;CACJ;AAzCD,kBAyCC"}
+{"version":3,"file":"ecc.js","sourceRoot":"","sources":["../src/ecc.ts"],"names":[],"mappings":";AAAA,4CAA4C;AAC5C,mEAAmE;AACnE,sEAAsE;;;AAgDtE,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,IAAgB,EAAE,IAAgB,EAAE,GAAe,IAAS,CAAC;IAEzE,WAAW,CAAC,OAAmB,EAAE,IAAgB;QAC7C,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,aAAa,CAAC,IAAgB,EAAE,IAAgB,EAAE,GAAe,IAAS,CAAC;IAE3E,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;IAED,eAAe,CAAC,OAAmB,EAAE,IAAgB;QACjD,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,UAAU,CAAC,IAAgB,EAAE,IAAgB;QACzC,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,UAAU,CAAC,GAAe;QACtB,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;CACJ;AAxCD,4BAwCC;AAGD,MAAM,GAAG,GAAqB,EAAE,CAAC;AAEjC,SAAgB,QAAQ,CAAC,GAAW;IAChC,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC;AAClB,CAAC;AAFD,4BAEC;AAED,4EAA4E;AAC5E,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;;;QAGI;IACJ,WAAW,CAAC,GAAe,EAAE,GAAe,EAAE,EAAc;QACxD,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IACvC,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;;;QAGI;IACJ,aAAa,CAAC,GAAe,EAAE,GAAe,EAAE,EAAc;QAC1D,GAAG,CAAC,GAAG,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IACzC,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;IAED,eAAe,CAAC,MAAkB,EAAE,GAAe;QAC/C,OAAO,GAAG,CAAC,GAAI,CAAC,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjD,CAAC;IAED,UAAU,CAAC,GAAe,EAAE,GAAe;QACvC,OAAO,GAAG,CAAC,GAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACzC,CAAC;IAED,UAAU,CAAC,EAAc;QACrB,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAChE,CAAC;QACD,MAAM,YAAY,GAAG,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;QACxC,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QACzC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACrC,OAAO,YAAY,CAAC;IACxB,CAAC;CACJ;AAnED,kBAmEC"}