@bsv/sdk 1.0.29 → 1.0.31

package/dist/types/src/compat/Mnemonic.d.ts

@@ -0,0 +1,132 @@
+/**
+ * @class Mnemonic
+ *
+ * @description
+ * Class representing Mnemonic functionality.
+ * This class provides methods for generating, converting, and validating mnemonic phrases
+ * according to the BIP39 standard. It supports creating mnemonics from random entropy,
+ * converting mnemonics to seeds, and validating mnemonic phrases.
+ */
+export default class Mnemonic {
+    mnemonic: string;
+    seed: number[];
+    Wordlist: {
+        value: string[];
+        space: string;
+    };
+    /**
+       * Constructs a Mnemonic object.
+       * @param {string} [mnemonic] - An optional mnemonic phrase.
+       * @param {number[]} [seed] - An optional seed derived from the mnemonic.
+       * @param {object} [wordlist=wordList] - An object containing a list of words and space character used in the mnemonic.
+       */
+    constructor(mnemonic?: string, seed?: number[], wordlist?: {
+        value: string[];
+        space: string;
+    });
+    /**
+       * Converts the mnemonic and seed into a binary representation.
+       * @returns {number[]} The binary representation of the mnemonic and seed.
+       */
+    toBinary(): number[];
+    /**
+       * Loads a mnemonic and seed from a binary representation.
+       * @param {number[]} bin - The binary representation of a mnemonic and seed.
+       * @returns {this} The Mnemonic instance with loaded mnemonic and seed.
+       */
+    fromBinary(bin: number[]): this;
+    /**
+       * Generates a random mnemonic from a given bit length.
+       * @param {number} [bits=128] - The bit length for the random mnemonic (must be a multiple of 32 and at least 128).
+       * @returns {this} The Mnemonic instance with the new random mnemonic.
+       * @throws {Error} If the bit length is not a multiple of 32 or is less than 128.
+       */
+    fromRandom(bits?: number): this;
+    /**
+       * Static method to generate a Mnemonic instance with a random mnemonic.
+       * @param {number} [bits=128] - The bit length for the random mnemonic.
+       * @returns {Mnemonic} A new Mnemonic instance.
+       */
+    static fromRandom(bits?: number): Mnemonic;
+    /**
+       * Converts given entropy into a mnemonic phrase.
+       * This method is used to generate a mnemonic from a specific entropy source.
+       * @param {number[]} buf - The entropy buffer, must be at least 128 bits.
+       * @returns {this} The Mnemonic instance with the mnemonic set from the given entropy.
+       * @throws {Error} If the entropy is less than 128 bits.
+       */
+    fromEntropy(buf: number[]): this;
+    /**
+       * Static method to create a Mnemonic instance from a given entropy.
+       * @param {number[]} buf - The entropy buffer.
+       * @returns {Mnemonic} A new Mnemonic instance.
+       */
+    static fromEntropy(buf: number[]): Mnemonic;
+    /**
+       * Sets the mnemonic for the instance from a string.
+       * @param {string} mnemonic - The mnemonic phrase as a string.
+       * @returns {this} The Mnemonic instance with the set mnemonic.
+       */
+    fromString(mnemonic: string): this;
+    /**
+       * Static method to create a Mnemonic instance from a mnemonic string.
+       * @param {string} str - The mnemonic phrase.
+       * @returns {Mnemonic} A new Mnemonic instance.
+       */
+    static fromString(str: string): Mnemonic;
+    /**
+       * Converts the instance's mnemonic to a string representation.
+       * @returns {string} The mnemonic phrase as a string.
+       */
+    toString(): string;
+    /**
+       * Converts the mnemonic to a seed.
+       * The mnemonic must pass the validity check before conversion.
+       * @param {string} [passphrase=''] - An optional passphrase for additional security.
+       * @returns {number[]} The generated seed.
+       * @throws {Error} If the mnemonic is invalid.
+       */
+    toSeed(passphrase?: string): number[];
+    /**
+       * Converts entropy to a mnemonic phrase.
+       * This method takes a buffer of entropy and converts it into a corresponding
+       * mnemonic phrase based on the Mnemonic wordlist. The entropy should be at least 128 bits.
+       * The method applies a checksum and maps the entropy to words in the wordlist.
+       * @param {number[]} buf - The entropy buffer to convert. Must be at least 128 bits.
+       * @returns {this} The Mnemonic instance with the mnemonic set from the entropy.
+       * @throws {Error} If the entropy is less than 128 bits or if it's not an even multiple of 11 bits.
+       */
+    entropy2Mnemonic(buf: number[]): this;
+    /**
+       * Validates the mnemonic phrase.
+       * Checks for correct length, absence of invalid words, and proper checksum.
+       * @returns {boolean} True if the mnemonic is valid, false otherwise.
+       * @throws {Error} If the mnemonic is not an even multiple of 11 bits.
+       */
+    check(): boolean;
+    /**
+       * Converts a mnemonic to a seed.
+       * This method takes the instance's mnemonic phrase, combines it with a passphrase (if provided),
+       * and uses PBKDF2 to generate a seed. It also validates the mnemonic before conversion.
+       * This seed can then be used for generating deterministic keys.
+       * @param {string} [passphrase=''] - An optional passphrase for added security.
+       * @returns {this} The Mnemonic instance with the seed generated from the mnemonic.
+       * @throws {Error} If the mnemonic does not pass validation or if the passphrase is not a string.
+       */
+    mnemonic2Seed(passphrase?: string): this;
+    /**
+       * Determines the validity of a given passphrase with the mnemonic.
+       * This method is useful for checking if a passphrase matches with the mnemonic.
+       * @param {string} [passphrase=''] - The passphrase to validate.
+       * @returns {boolean} True if the mnemonic and passphrase combination is valid, false otherwise.
+       */
+    isValid(passphrase?: string): boolean;
+    /**
+       * Static method to check the validity of a given mnemonic and passphrase combination.
+       * @param {string} mnemonic - The mnemonic phrase.
+       * @param {string} [passphrase=''] - The passphrase to validate.
+       * @returns {boolean} True if the combination is valid, false otherwise.
+       */
+    static isValid(mnemonic: string, passphrase?: string): boolean;
+}
+//# sourceMappingURL=Mnemonic.d.ts.map

package/dist/types/src/compat/Mnemonic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Mnemonic.d.ts","sourceRoot":"","sources":["../../../../src/compat/Mnemonic.ts"],"names":[],"mappings":"AAKA;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,QAAQ,EAAE;QAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IAEnD;;;;;SAKK;gBACQ,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,QAAQ;;;KAAW;IAMpE;;;SAGK;IACE,QAAQ,IAAK,MAAM,EAAE;IAkB5B;;;;SAIK;IACE,UAAU,CAAE,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI;IAavC;;;;;SAKK;IACE,UAAU,CAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IAgBvC;;;;SAIK;WACS,UAAU,CAAE,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ;IAIlD;;;;;;SAMK;IACE,WAAW,CAAE,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI;IAKxC;;;;SAIK;WACS,WAAW,CAAE,GAAG,EAAE,MAAM,EAAE,GAAG,QAAQ;IAInD;;;;SAIK;IACE,UAAU,CAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAK1C;;;;SAIK;WACS,UAAU,CAAE,GAAG,EAAE,MAAM,GAAG,QAAQ;IAIhD;;;SAGK;IACE,QAAQ,IAAK,MAAM;IAI1B;;;;;;SAMK;IACE,MAAM,CAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE;IAK7C;;;;;;;;SAQK;IACE,gBAAgB,CAAE,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI;IAgC7C;;;;;SAKK;IACE,KAAK,IAAK,OAAO;IAiCxB;;;;;;;;SAQK;IACE,aAAa,CAAE,UAAU,SAAK,GAAG,IAAI;IAkB5C;;;;;SAKK;IACE,OAAO,CAAE,UAAU,SAAK,GAAG,OAAO;IAUzC;;;;;SAKK;WACS,OAAO,CAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,SAAK,GAAG,OAAO;CAGnE"}

package/dist/types/src/compat/bip-39-wordlist-en.d.ts

@@ -0,0 +1,5 @@
+export declare const wordList: {
+    value: string[];
+    space: string;
+};
+//# sourceMappingURL=bip-39-wordlist-en.d.ts.map

package/dist/types/src/compat/bip-39-wordlist-en.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bip-39-wordlist-en.d.ts","sourceRoot":"","sources":["../../../../src/compat/bip-39-wordlist-en.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ;;;CAogEpB,CAAA"}

package/dist/types/src/compat/index.d.ts

@@ -0,0 +1,5 @@
+export * as BSM from './BSM.js';
+export { default as HD } from './HD.js';
+export { default as Mnemonic } from './Mnemonic.js';
+export { default as ECIES } from './ECIES.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/src/compat/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/compat/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,EAAE,OAAO,IAAI,EAAE,EAAE,MAAM,SAAS,CAAA;AACvC,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAA;AACnD,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,YAAY,CAAA"}

package/dist/types/src/messages/EncryptedMessage.d.ts

@@ -0,0 +1,20 @@
+import PublicKey from '../primitives/PublicKey.js';
+import PrivateKey from '../primitives/PrivateKey.js';
+/**
+ * Encrypts a message from one party to another using the BRC-78 message encryption protocol.
+ * @param message The message to encrypt
+ * @param sender The private key of the sender
+ * @param recipient The public key of the recipient
+ *
+ * @returns The encrypted message
+ */
+export declare const encrypt: (message: number[], sender: PrivateKey, recipient: PublicKey) => number[];
+/**
+ * Decrypts a message from one party to another using the BRC-78 message encryption protocol.
+ * @param message The message to decrypt
+ * @param sender The private key of the recipient
+ *
+ * @returns The decrypted message
+ */
+export declare const decrypt: (message: number[], recipient: PrivateKey) => number[];
+//# sourceMappingURL=EncryptedMessage.d.ts.map

package/dist/types/src/messages/EncryptedMessage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EncryptedMessage.d.ts","sourceRoot":"","sources":["../../../../src/messages/EncryptedMessage.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,4BAA4B,CAAA;AAClD,OAAO,UAAU,MAAM,6BAA6B,CAAA;AAOpD;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO,YACT,MAAM,EAAE,UACT,UAAU,aACP,SAAS,KACnB,MAAM,EAkBR,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,YAAa,MAAM,EAAE,aAAa,UAAU,KAAG,MAAM,EAsBxE,CAAA"}

package/dist/types/src/messages/SignedMessage.d.ts

@@ -0,0 +1,21 @@
+import PublicKey from '../primitives/PublicKey.js';
+import PrivateKey from '../primitives/PrivateKey.js';
+/**
+ * Signs a message from one party to be verified by another, or for verification by anyone, using the BRC-77 message signing protocol.
+ * @param message The message to sign
+ * @param signer The private key of the message signer
+ * @param [verifier] The public key of the person who can verify the message. If not provided, anyone will be able to verify the message signature.
+ *
+ * @returns The message signature.
+ */
+export declare const sign: (message: number[], signer: PrivateKey, verifier?: PublicKey) => number[];
+/**
+ * Verifies a message using the BRC-77 message signing protocol.
+ * @param message The message to verify.
+ * @param sig The message signature to be verified.
+ * @param [recipient] The private key of the message verifier. This can be omitted if the message is verifiable by anyone.
+ *
+ * @returns True if the message is verified.
+ */
+export declare const verify: (message: number[], sig: number[], recipient?: PrivateKey) => boolean;
+//# sourceMappingURL=SignedMessage.d.ts.map

package/dist/types/src/messages/SignedMessage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SignedMessage.d.ts","sourceRoot":"","sources":["../../../../src/messages/SignedMessage.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,4BAA4B,CAAA;AAClD,OAAO,UAAU,MAAM,6BAA6B,CAAA;AAQpD;;;;;;;GAOG;AACH,eAAO,MAAM,IAAI,YACN,MAAM,EAAE,UACT,UAAU,aACP,SAAS,KACnB,MAAM,EAyBR,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,MAAM,YAAa,MAAM,EAAE,OAAO,MAAM,EAAE,cAAc,UAAU,KAAG,OA8BjF,CAAA"}

package/dist/types/src/messages/index.d.ts

@@ -0,0 +1,3 @@
+export * as SignedMessage from './SignedMessage.js';
+export * as EncryptedMessage from './EncryptedMessage.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/src/messages/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/messages/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AACnD,OAAO,KAAK,gBAAgB,MAAM,uBAAuB,CAAA"}

package/dist/types/src/primitives/AESGCM.d.ts

@@ -0,0 +1,14 @@
+export declare function AES(input: number[], key: number[]): number[];
+export declare const checkBit: (byteArray: number[], byteIndex: number, bitIndex: number) => 1 | 0;
+export declare const getBytes: (numericValue: number) => number[];
+export declare const exclusiveOR: (block0: number[], block1: number[]) => number[];
+export declare const rightShift: (block: number[]) => number[];
+export declare const multiply: (block0: number[], block1: number[]) => number[];
+export declare const incrementLeastSignificantThirtyTwoBits: (block: number[]) => number[];
+export declare function ghash(input: number[], hashSubKey: number[]): number[];
+export declare function AESGCM(plainText: number[], additionalAuthenticatedData: number[], initializationVector: number[], key: number[]): {
+    result: number[];
+    authenticationTag: number[];
+};
+export declare function AESGCMDecrypt(cipherText: number[], additionalAuthenticatedData: number[], initializationVector: number[], authenticationTag: number[], key: number[]): number[] | null;
+//# sourceMappingURL=AESGCM.d.ts.map

package/dist/types/src/primitives/AESGCM.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AESGCM.d.ts","sourceRoot":"","sources":["../../../../src/primitives/AESGCM.ts"],"names":[],"mappings":"AA4KA,wBAAgB,GAAG,CAAE,KAAK,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CA4C7D;AAED,eAAO,MAAM,QAAQ,cACR,MAAM,EAAE,aACR,MAAM,YACP,MAAM,KACf,CAAC,GAAG,CAEN,CAAA;AAED,eAAO,MAAM,QAAQ,iBAA2B,MAAM,KAAG,MAAM,EAO9D,CAAA;AAeD,eAAO,MAAM,WAAW,WAAqB,MAAM,EAAE,UAAU,MAAM,EAAE,KAAG,MAAM,EAS/E,CAAA;AAED,eAAO,MAAM,UAAU,UAAoB,MAAM,EAAE,KAAG,MAAM,EAgB3D,CAAA;AAED,eAAO,MAAM,QAAQ,WAAqB,MAAM,EAAE,UAAU,MAAM,EAAE,KAAG,MAAM,EAqB5E,CAAA;AAED,eAAO,MAAM,sCAAsC,UAC1C,MAAM,EAAE,KACd,MAAM,EAcR,CAAA;AAED,wBAAgB,KAAK,CAAE,KAAK,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAetE;AAkCD,wBAAgB,MAAM,CACpB,SAAS,EAAE,MAAM,EAAE,EACnB,2BAA2B,EAAE,MAAM,EAAE,EACrC,oBAAoB,EAAE,MAAM,EAAE,EAC9B,GAAG,EAAE,MAAM,EAAE,GACZ;IAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAAC,iBAAiB,EAAE,MAAM,EAAE,CAAA;CAAE,CA8CnD;AAED,wBAAgB,aAAa,CAC3B,UAAU,EAAE,MAAM,EAAE,EACpB,2BAA2B,EAAE,MAAM,EAAE,EACrC,oBAAoB,EAAE,MAAM,EAAE,EAC9B,iBAAiB,EAAE,MAAM,EAAE,EAC3B,GAAG,EAAE,MAAM,EAAE,GACZ,MAAM,EAAE,GAAG,IAAI,CAoDjB"}

package/dist/types/src/primitives/BasePoint.d.ts

@@ -0,0 +1,22 @@
+import Curve from './Curve.js';
+/**
+ * Base class for Point (affine coordinates) and JacobianPoint classes,
+ * defining their curve and type.
+ */
+export default abstract class BasePoint {
+    curve: Curve;
+    type: 'affine' | 'jacobian';
+    precomputed: {
+        doubles: {
+            step: number;
+            points: any[];
+        } | undefined;
+        naf: {
+            wnd: any;
+            points: any[];
+        } | undefined;
+        beta: BasePoint | null | undefined;
+    } | null;
+    constructor(type: 'affine' | 'jacobian');
+}
+//# sourceMappingURL=BasePoint.d.ts.map

package/dist/types/src/primitives/BasePoint.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BasePoint.d.ts","sourceRoot":"","sources":["../../../../src/primitives/BasePoint.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAA;AAE9B;;;GAGG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,SAAS;IACrC,KAAK,EAAE,KAAK,CAAA;IACZ,IAAI,EAAE,QAAQ,GAAG,UAAU,CAAA;IAC3B,WAAW,EAAE;QACX,OAAO,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,GAAG,EAAE,CAAA;SAAE,GAAG,SAAS,CAAA;QACpD,GAAG,EAAE;YAAE,GAAG,EAAE,GAAG,CAAC;YAAC,MAAM,EAAE,GAAG,EAAE,CAAA;SAAE,GAAG,SAAS,CAAA;QAC5C,IAAI,EAAE,SAAS,GAAG,IAAI,GAAG,SAAS,CAAA;KACnC,GAAG,IAAI,CAAA;gBAEK,IAAI,EAAE,QAAQ,GAAG,UAAU;CAKzC"}