@taquito/signer 23.0.3 → 24.0.0-beta.0

package/dist/types/derivation-tools/ed25519.d.ts

@@ -1,4 +1,4 @@
-import { ExtendedPrivateKey } from './index';
+import { ExtendedPrivateKey } from './types';
 export declare class PrivateKey implements ExtendedPrivateKey {
     readonly priv: Uint8Array;
     readonly chainCode: Uint8Array;

package/dist/types/derivation-tools/index.d.ts

@@ -1,15 +1,6 @@
 export * as ECDSA from './ecdsa';
 export * as Ed25519 from './ed25519';
-export declare const Hard = 2147483648;
-export interface ExtendedKey {
-    readonly chainCode: Uint8Array;
-    derive(index: number): ExtendedKey;
-    derivePath(path: Iterable<number>): ExtendedKey;
-}
-export interface ExtendedPrivateKey extends ExtendedKey {
-    derive(index: number): ExtendedPrivateKey;
-    derivePath(path: number[]): ExtendedPrivateKey;
-}
+export * from './types';
 export declare class Path extends Array<number> {
     static from(iterable: Iterable<number> | ArrayLike<number>): Path;
     /**

package/dist/types/derivation-tools/types.d.ts

@@ -0,0 +1,10 @@
+export declare const Hard = 2147483648;
+export interface ExtendedKey {
+    readonly chainCode: Uint8Array;
+    derive(index: number): ExtendedKey;
+    derivePath(path: Iterable<number>): ExtendedKey;
+}
+export interface ExtendedPrivateKey extends ExtendedKey {
+    derive(index: number): ExtendedPrivateKey;
+    derivePath(path: number[]): ExtendedPrivateKey;
+}

package/dist/types/ec-key.d.ts

@@ -1,16 +1,11 @@
-import elliptic from 'elliptic';
 import { SigningKey, PublicKey } from './key-interface';
 import { RawSignResult } from '@taquito/core';
 type Curve = 'p256' | 'secp256k1';
-declare class ECKeyBase {
-    readonly keyPair: elliptic.ec.KeyPair;
-    constructor(keyPair: elliptic.ec.KeyPair);
-    curve(): Curve;
-}
 /**
  * @description Provide signing logic for elliptic curve based key (tz2, tz3)
  */
-export declare class ECKey extends ECKeyBase implements SigningKey {
+export declare class ECKey implements SigningKey {
+    #private;
     /**
      *
      * @param key Encoded private key
@@ -33,9 +28,10 @@ export declare class ECKey extends ECKeyBase implements SigningKey {
      */
     secretKey(): string;
 }
-export declare class ECPublicKey extends ECKeyBase implements PublicKey {
+export declare class ECPublicKey implements PublicKey {
+    #private;
+    readonly curve: Curve;
     constructor(src: string);
-    constructor(src: elliptic.ec.KeyPair);
     constructor(src: Uint8Array, curve: Curve);
     compare(other: PublicKey): number;
     hash(): string;

package/dist/types/in-memory-signer.d.ts

@@ -0,0 +1,60 @@
+import { Curves } from './helpers';
+import { SignResult, RawSignResult, Signer } from '@taquito/core';
+import { PublicKey } from './key-interface';
+export interface FromMnemonicParams {
+    mnemonic: string;
+    password?: string;
+    derivationPath?: string;
+    curve?: Curves;
+}
+/**
+ * @description A local implementation of the signer. Will represent a Tezos account and be able to produce signature in its behalf
+ *
+ * @warn If running in production and dealing with tokens that have real value, it is strongly recommended to use a HSM backed signer so that private key material is not stored in memory or on disk
+ * @throws {@link InvalidMnemonicError}
+ */
+export declare class InMemorySigner implements Signer {
+    #private;
+    static fromFundraiser(email: string, password: string, mnemonic: string): InMemorySigner;
+    static fromSecretKey(key: string, passphrase?: string): Promise<InMemorySigner>;
+    /**
+     *
+     * @description Instantiation of an InMemorySigner instance from a mnemonic
+     * @param mnemonic 12-24 word mnemonic
+     * @param password password used to encrypt the mnemonic to seed value
+     * @param derivationPath default 44'/1729'/0'/0' (44'/1729' mandatory)
+     * @param curve currently only supported for tz1, tz2, tz3 addresses. soon bip25519
+     * @returns InMemorySigner
+     * @throws {@link InvalidMnemonicError}
+     */
+    static fromMnemonic({ mnemonic, password, derivationPath, curve, }: FromMnemonicParams): InMemorySigner;
+    /**
+     *
+     * @param key Encoded private key
+     * @param passphrase Passphrase to decrypt the private key if it is encrypted
+     * @throws {@link InvalidKeyError}
+     *
+     */
+    constructor(key: string, passphrase?: string);
+    /**
+     *
+     * @param bytes Bytes to sign
+     * @param watermark Watermark to append to the bytes
+     */
+    sign(message: string | Uint8Array, watermark?: Uint8Array): Promise<SignResult>;
+    provePossession(): Promise<RawSignResult>;
+    get canProvePossession(): boolean;
+    /**
+     * @returns Encoded public key
+     */
+    publicKey(): Promise<string>;
+    /**
+     * @returns Encoded public key hash
+     */
+    publicKeyHash(): Promise<string>;
+    /**
+     * @returns Encoded private key
+     */
+    secretKey(): Promise<string>;
+}
+export declare function publicKeyFromString(src: string): PublicKey;

package/dist/types/key-interface.d.ts

@@ -10,8 +10,28 @@ export interface SigningKeyWithProofOfPossession extends SigningKey {
 }
 export declare function isPOP(k: SigningKey): k is SigningKeyWithProofOfPossession;
 export interface PublicKey {
+    /**
+     * @description Compare two public keys of the same elliptic curve
+     * @param PublicKey the other PublicKey class to compare to
+     * @returns -1 if this public key is less than the other, 0 if they are equal, 1 if this public key is greater than the other
+     * @throws {@link InvalidPublicKeyError}
+     */
     compare(other: PublicKey): number;
+    /**
+     * @description Hash of the public key (tz1, tz2, tz3, tz4 addresses)
+     * @returns the hash of the public key
+     */
     hash(): string;
+    /**
+     * @description Get the bytes of the public key without prefix
+     * @param compress: Whether to get the compressed format of the public key
+     * @default true
+     * @returns the bytes of the public key
+     */
     bytes(compress?: boolean): Uint8Array;
+    /**
+     * @description Get the bytes of the public key with prefix
+     * @returns the bytes of the public key
+     */
     toProtocol(): Uint8Array;
 }

package/dist/types/taquito-signer.d.ts

@@ -1,66 +1,10 @@
-import { Curves } from './helpers';
-import { SignResult, RawSignResult, Signer } from '@taquito/core';
-import { PublicKey } from './key-interface';
-export * from './import-key';
+/**
+ * @packageDocumentation
+ * @module @taquito/signer
+ */
+export * from './in-memory-signer';
 export { VERSION } from './version';
 export * from './derivation-tools';
 export * from './helpers';
 export { InvalidPassphraseError } from './errors';
 export { PublicKey } from './key-interface';
-export interface FromMnemonicParams {
-    mnemonic: string;
-    password?: string;
-    derivationPath?: string;
-    curve?: Curves;
-}
-/**
- * @description A local implementation of the signer. Will represent a Tezos account and be able to produce signature in its behalf
- *
- * @warn If running in production and dealing with tokens that have real value, it is strongly recommended to use a HSM backed signer so that private key material is not stored in memory or on disk
- * @throws {@link InvalidMnemonicError}
- */
-export declare class InMemorySigner implements Signer {
-    #private;
-    static fromFundraiser(email: string, password: string, mnemonic: string): InMemorySigner;
-    static fromSecretKey(key: string, passphrase?: string): Promise<InMemorySigner>;
-    /**
-     *
-     * @description Instantiation of an InMemorySigner instance from a mnemonic
-     * @param mnemonic 12-24 word mnemonic
-     * @param password password used to encrypt the mnemonic to seed value
-     * @param derivationPath default 44'/1729'/0'/0' (44'/1729' mandatory)
-     * @param curve currently only supported for tz1, tz2, tz3 addresses. soon bip25519
-     * @returns InMemorySigner
-     * @throws {@link InvalidMnemonicError}
-     */
-    static fromMnemonic({ mnemonic, password, derivationPath, curve, }: FromMnemonicParams): InMemorySigner;
-    /**
-     *
-     * @param key Encoded private key
-     * @param passphrase Passphrase to decrypt the private key if it is encrypted
-     * @throws {@link InvalidKeyError}
-     *
-     */
-    constructor(key: string, passphrase?: string);
-    /**
-     *
-     * @param bytes Bytes to sign
-     * @param watermark Watermark to append to the bytes
-     */
-    sign(message: string | Uint8Array, watermark?: Uint8Array): Promise<SignResult>;
-    provePossession(): Promise<RawSignResult>;
-    get canProvePossession(): boolean;
-    /**
-     * @returns Encoded public key
-     */
-    publicKey(): Promise<string>;
-    /**
-     * @returns Encoded public key hash
-     */
-    publicKeyHash(): Promise<string>;
-    /**
-     * @returns Encoded private key
-     */
-    secretKey(): Promise<string>;
-}
-export declare function publicKeyFromString(src: string): PublicKey;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taquito/signer",
-  "version": "23.0.3",
+  "version": "24.0.0-beta.0",
   "description": "Provide signing functionality to be with taquito",
   "keywords": [
     "tezos",
@@ -24,7 +24,7 @@
   },
   "license": "Apache-2.0",
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "scripts": {
     "test": "jest --coverage",
@@ -66,27 +66,24 @@
     ]
   },
   "dependencies": {
-    "@noble/curves": "^1.9.6",
+    "@noble/curves": "^1.9.7",
     "@stablelib/blake2b": "^1.0.1",
     "@stablelib/ed25519": "^1.0.3",
     "@stablelib/hmac": "^1.0.1",
     "@stablelib/nacl": "^1.0.4",
     "@stablelib/pbkdf2": "^1.0.1",
     "@stablelib/sha512": "^1.0.1",
-    "@taquito/core": "^23.0.3",
-    "@taquito/taquito": "^23.0.3",
-    "@taquito/utils": "^23.0.3",
+    "@taquito/core": "^24.0.0-beta.0",
+    "@taquito/utils": "^24.0.0-beta.0",
     "@types/bn.js": "^5.1.5",
     "bip39": "3.1.0",
-    "elliptic": "^6.6.1",
     "pbkdf2": "^3.1.2",
     "typedarray-to-buffer": "^4.0.0"
   },
   "devDependencies": {
     "@types/bluebird": "^3.5.42",
-    "@types/elliptic": "^6.4.18",
     "@types/jest": "^29.5.12",
-    "@types/node": "^18",
+    "@types/node": "^20",
     "@types/pbkdf2": "^3.1.2",
     "@typescript-eslint/eslint-plugin": "^6.21.0",
     "@typescript-eslint/parser": "^6.21.0",
@@ -104,6 +101,7 @@
     "rimraf": "^6.0.1",
     "rollup": "^4.22.4",
     "rollup-plugin-json": "^4.0.0",
+    "rollup-plugin-polyfill-node": "^0.13.0",
     "rollup-plugin-typescript2": "^0.36.0",
     "shelljs": "^0.8.5",
     "ts-jest": "^29.2.3",
@@ -112,5 +110,5 @@
     "typedoc": "^0.26.5",
     "typescript": "~5.5.4"
   },
-  "gitHead": "2abf349e97af45f11210b3121078b9d96699d5da"
+  "gitHead": "f212ea3edaf1fac34d738b5d00a9892ab7a3b721"
 }

package/dist/lib/import-key.js

@@ -1,51 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.importKey = importKey;
-const taquito_signer_1 = require("./taquito-signer");
-/**
- *
- * @description Import a key to sign operation with the side-effect of setting the Tezos instance to use the InMemorySigner provider
- *
- * @warn The JSON faucets are no longer available on https://teztnets.com/
- * @param toolkit The toolkit instance to attach a signer
- * @param privateKeyOrEmail Key to load in memory
- * @param passphrase If the key is encrypted passphrase to decrypt it
- * @param mnemonic Faucet mnemonic
- * @param secret Faucet secret
- */
-function importKey(toolkit, privateKeyOrEmail, passphrase, mnemonic, secret) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (privateKeyOrEmail && passphrase && mnemonic && secret) {
-            const signer = taquito_signer_1.InMemorySigner.fromFundraiser(privateKeyOrEmail, passphrase, mnemonic);
-            toolkit.setProvider({ signer });
-            const pkh = yield signer.publicKeyHash();
-            let op;
-            try {
-                op = yield toolkit.tz.activate(pkh, secret);
-            }
-            catch (ex) {
-                const isInvalidActivationError = ex && ex.body && /Invalid activation/.test(ex.body);
-                if (!isInvalidActivationError) {
-                    throw ex;
-                }
-            }
-            if (op) {
-                yield op.confirmation();
-            }
-        }
-        else {
-            // Fallback to regular import
-            const signer = yield taquito_signer_1.InMemorySigner.fromSecretKey(privateKeyOrEmail, passphrase);
-            toolkit.setProvider({ signer });
-        }
-    });
-}

package/dist/types/import-key.d.ts

@@ -1,13 +0,0 @@
-import { TezosToolkit } from '@taquito/taquito';
-/**
- *
- * @description Import a key to sign operation with the side-effect of setting the Tezos instance to use the InMemorySigner provider
- *
- * @warn The JSON faucets are no longer available on https://teztnets.com/
- * @param toolkit The toolkit instance to attach a signer
- * @param privateKeyOrEmail Key to load in memory
- * @param passphrase If the key is encrypted passphrase to decrypt it
- * @param mnemonic Faucet mnemonic
- * @param secret Faucet secret
- */
-export declare function importKey(toolkit: TezosToolkit, privateKeyOrEmail: string, passphrase?: string, mnemonic?: string, secret?: string): Promise<void>;