@aptos-labs/ts-sdk 6.3.0 → 7.0.0

package/dist/core/crypto/multiKey.js

@@ -0,0 +1,417 @@
+import { AnyPublicKeyVariant, SigningScheme as AuthenticationKeyScheme } from "../../types/index.js";
+import { AuthenticationKey } from "../authenticationKey.js";
+import { AccountPublicKey } from "./publicKey.js";
+import { Signature } from "./signature.js";
+import { AnyPublicKey, AnySignature } from "./singleKey.js";
+/**
+ * Counts the number of set bits (1s) in a byte.
+ * This function can help you determine the population count of a given byte value.
+ *
+ * @param byte - The byte value for which to count the number of set bits.
+ * @group Implementation
+ * @category Serialization
+ */
+function bitCount(byte) {
+    let n = byte;
+    n -= (n >> 1) & 0x55555555;
+    n = (n & 0x33333333) + ((n >> 2) & 0x33333333);
+    return (((n + (n >> 4)) & 0xf0f0f0f) * 0x1010101) >> 24;
+}
+const MAX_NUM_KEYLESS_PUBLIC_FOR_MULTI_KEY = 3;
+export class AbstractMultiKey extends AccountPublicKey {
+    publicKeys;
+    constructor(args) {
+        super();
+        this.publicKeys = args.publicKeys;
+    }
+    /**
+     * Create a bitmap that holds the mapping from the original public keys
+     * to the signatures passed in
+     *
+     * @param args.bits array of the index mapping to the matching public keys
+     * @returns Uint8array bit map
+     * @group Implementation
+     * @category Serialization
+     */
+    createBitmap(args) {
+        const { bits } = args;
+        // Bits are read from left to right. e.g. 0b10000000 represents the first bit is set in one byte.
+        // The decimal value of 0b10000000 is 128.
+        const firstBitInByte = 128;
+        const bitmap = new Uint8Array([0, 0, 0, 0]);
+        // Check if duplicates exist in bits
+        const dupCheckSet = new Set();
+        bits.forEach((bit, idx) => {
+            if (idx + 1 > this.publicKeys.length) {
+                throw new Error(`Signature index ${idx + 1} is out of public keys range, ${this.publicKeys.length}.`);
+            }
+            if (dupCheckSet.has(bit)) {
+                throw new Error(`Duplicate bit ${bit} detected.`);
+            }
+            dupCheckSet.add(bit);
+            const byteOffset = Math.floor(bit / 8);
+            let byte = bitmap[byteOffset];
+            byte |= firstBitInByte >> (bit % 8);
+            bitmap[byteOffset] = byte;
+        });
+        return bitmap;
+    }
+    /**
+     * Get the index of the provided public key.
+     *
+     * This function retrieves the index of a specified public key within the MultiKey.
+     * If the public key does not exist, it throws an error.
+     *
+     * @param publicKey - The public key to find the index for.
+     * @returns The corresponding index of the public key, if it exists.
+     * @throws Error - If the public key is not found in the MultiKey.
+     * @group Implementation
+     * @category Serialization
+     */
+    getIndex(publicKey) {
+        const index = this.publicKeys.findIndex((pk) => pk.toString() === publicKey.toString());
+        if (index !== -1) {
+            return index;
+        }
+        throw new Error(`Public key ${publicKey} not found in multi key set ${this.publicKeys}`);
+    }
+}
+/**
+ * Represents a multi-key authentication scheme for accounts, allowing multiple public keys
+ * to be associated with a single account. This class enforces a minimum number of valid signatures
+ * required to authorize actions, ensuring enhanced security for multi-agent accounts.
+ *
+ * The public keys of each individual agent can be any type of public key supported by Aptos.
+ * Since [AIP-55](https://github.com/aptos-foundation/AIPs/pull/263), Aptos supports
+ * `Legacy` and `Unified` authentication keys.
+ * @group Implementation
+ * @category Serialization
+ */
+export class MultiKey extends AbstractMultiKey {
+    /**
+     * List of any public keys
+     * @group Implementation
+     * @category Serialization
+     */
+    publicKeys;
+    /**
+     * The minimum number of valid signatures required, for the number of public keys specified
+     * @group Implementation
+     * @category Serialization
+     */
+    signaturesRequired;
+    /**
+     * Signature for a K-of-N multi-sig transaction.
+     * This constructor initializes a multi-signature transaction with the provided signatures and bitmap.
+     *
+     * @param args An object containing the parameters for the multi-signature transaction.
+     * @param args.signatures A list of signatures.
+     * @param args.bitmap A bitmap represented as a Uint8Array or an array of numbers, where each bit indicates whether a
+     * corresponding signature is present. A maximum of 32 signatures is supported, and the length of the bitmap must be 4 bytes.
+     *
+     * @throws Error if the number of signatures exceeds the maximum supported, if the bitmap length is incorrect, or if the number
+     * of signatures does not match the bitmap.
+     * @group Implementation
+     * @category Serialization
+     */
+    // region Constructors
+    constructor(args) {
+        const { publicKeys, signaturesRequired } = args;
+        super({ publicKeys });
+        // Validate number of public keys is greater than signature required
+        if (signaturesRequired < 1) {
+            throw new Error("The number of required signatures needs to be greater than 0");
+        }
+        // Validate number of public keys is greater than signature required
+        if (publicKeys.length < signaturesRequired) {
+            throw new Error(`Provided ${publicKeys.length} public keys is smaller than the ${signaturesRequired} required signatures`);
+        }
+        // Make sure that all keys are normalized to the SingleKey authentication scheme
+        this.publicKeys = publicKeys.map((publicKey) => publicKey instanceof AnyPublicKey ? publicKey : new AnyPublicKey(publicKey));
+        if (signaturesRequired > MAX_NUM_KEYLESS_PUBLIC_FOR_MULTI_KEY) {
+            const keylessCount = this.publicKeys.filter((pk) => pk.variant === AnyPublicKeyVariant.Keyless || pk.variant === AnyPublicKeyVariant.FederatedKeyless).length;
+            if (keylessCount > MAX_NUM_KEYLESS_PUBLIC_FOR_MULTI_KEY) {
+                throw new Error(`Construction of MultiKey with more than ${MAX_NUM_KEYLESS_PUBLIC_FOR_MULTI_KEY} keyless public keys is not allowed when signaturesRequired 
+          is greater than ${MAX_NUM_KEYLESS_PUBLIC_FOR_MULTI_KEY}. This is because a maximum of 3 keyless signatures are supported for a 
+          K-of-N MultiKey transaction.`);
+            }
+        }
+        this.signaturesRequired = signaturesRequired;
+    }
+    getSignaturesRequired() {
+        return this.signaturesRequired;
+    }
+    // endregion
+    // region AccountPublicKey
+    /**
+     * Verifies the provided signature against the given message.
+     * This function helps ensure the integrity and authenticity of the message by checking if the signature is valid.
+     *
+     * Note: This function will fail if a keyless signature is used.  Use `verifySignatureAsync` instead.
+     *
+     * @param args - The arguments for verifying the signature.
+     * @param args.message - The message that was signed.
+     * @param args.signature - The signature to verify.
+     * @group Implementation
+     * @category Serialization
+     */
+    verifySignature(args) {
+        const { message, signature } = args;
+        if (signature.signatures.length !== this.signaturesRequired) {
+            throw new Error("The number of signatures does not match the number of required signatures");
+        }
+        const signerIndices = signature.bitMapToSignerIndices();
+        for (let i = 0; i < signature.signatures.length; i += 1) {
+            const singleSignature = signature.signatures[i];
+            const publicKey = this.publicKeys[signerIndices[i]];
+            if (!publicKey.verifySignature({ message, signature: singleSignature })) {
+                return false;
+            }
+        }
+        return true;
+    }
+    /**
+     * Verifies the provided signature against the given message.
+     * This function helps ensure the integrity and authenticity of the message by checking if the signature is valid.
+     *
+     * @param args - The arguments for verifying the signature.
+     * @param args.aptosConfig - The Aptos configuration to use
+     * @param args.message - The message that was signed.
+     * @param args.signature - The signature to verify.
+     * @group Implementation
+     * @category Serialization
+     */
+    async verifySignatureAsync(args) {
+        const { signature } = args;
+        try {
+            if (!(signature instanceof MultiKeySignature)) {
+                throw new Error("Signature is not a MultiKeySignature");
+            }
+            if (signature.signatures.length !== this.signaturesRequired) {
+                throw new Error("The number of signatures does not match the number of required signatures");
+            }
+            const signerIndices = signature.bitMapToSignerIndices();
+            for (let i = 0; i < signature.signatures.length; i += 1) {
+                const singleSignature = signature.signatures[i];
+                const publicKey = this.publicKeys[signerIndices[i]];
+                if (!(await publicKey.verifySignatureAsync({ ...args, signature: singleSignature }))) {
+                    return false;
+                }
+            }
+            return true;
+        }
+        catch (error) {
+            if (args.options?.throwErrorWithReason) {
+                throw error;
+            }
+            return false;
+        }
+    }
+    /**
+     * Generates an authentication key based on the current instance's byte representation.
+     * This key can be used for secure authentication processes within the system.
+     *
+     * @returns {AuthenticationKey} The generated authentication key.
+     * @group Implementation
+     * @category Serialization
+     */
+    authKey() {
+        return AuthenticationKey.fromSchemeAndBytes({
+            scheme: AuthenticationKeyScheme.MultiKey,
+            input: this.toUint8Array(),
+        });
+    }
+    // endregion
+    // region Serializable
+    /**
+     * Serializes the object by writing its signatures and bitmap to the provided serializer.
+     * This allows the object to be converted into a format suitable for transmission or storage.
+     *
+     * @param serializer - The serializer instance used to perform the serialization.
+     * @group Implementation
+     * @category Serialization
+     */
+    serialize(serializer) {
+        serializer.serializeVector(this.publicKeys);
+        serializer.serializeU8(this.signaturesRequired);
+    }
+    /**
+     * Deserializes a MultiKeySignature from the provided deserializer.
+     * This function retrieves the signatures and bitmap necessary for creating a MultiKeySignature object.
+     *
+     * @param deserializer - The deserializer instance used to read the serialized data.
+     * @group Implementation
+     * @category Serialization
+     */
+    static deserialize(deserializer) {
+        const keys = deserializer.deserializeVector(AnyPublicKey);
+        const signaturesRequired = deserializer.deserializeU8();
+        return new MultiKey({ publicKeys: keys, signaturesRequired });
+    }
+    // endregion
+    /**
+     * Get the index of the provided public key.
+     *
+     * This function retrieves the index of a specified public key within the MultiKey.
+     * If the public key does not exist, it throws an error.
+     *
+     * @param publicKey - The public key to find the index for.
+     * @returns The corresponding index of the public key, if it exists.
+     * @throws Error - If the public key is not found in the MultiKey.
+     * @group Implementation
+     */
+    getIndex(publicKey) {
+        const anyPublicKey = publicKey instanceof AnyPublicKey ? publicKey : new AnyPublicKey(publicKey);
+        return super.getIndex(anyPublicKey);
+    }
+    static isInstance(value) {
+        return "publicKeys" in value && "signaturesRequired" in value;
+    }
+}
+/**
+ * Represents a multi-signature transaction using Ed25519 signatures.
+ * This class allows for the creation and management of a K-of-N multi-signature scheme,
+ * where a specified number of signatures are required to authorize a transaction.
+ *
+ * It includes functionality to validate the number of signatures against a bitmap,
+ * which indicates which public keys have signed the transaction.
+ * @group Implementation
+ * @category Serialization
+ */
+export class MultiKeySignature extends Signature {
+    /**
+     * Number of bytes in the bitmap representing who signed the transaction (32-bits)
+     * @group Implementation
+     * @category Serialization
+     */
+    static BITMAP_LEN = 4;
+    /**
+     * Maximum number of Ed25519 signatures supported
+     * @group Implementation
+     * @category Serialization
+     */
+    static MAX_SIGNATURES_SUPPORTED = MultiKeySignature.BITMAP_LEN * 8;
+    /**
+     * The list of underlying Ed25519 signatures
+     * @group Implementation
+     * @category Serialization
+     */
+    signatures;
+    /**
+     * 32-bit Bitmap representing who signed the transaction
+     *
+     * This is represented where each public key can be masked to determine whether the message was signed by that key.
+     * @group Implementation
+     * @category Serialization
+     */
+    bitmap;
+    /**
+     * Signature for a K-of-N multi-sig transaction.
+     *
+     * @see {@link
+     * https://aptos.dev/integration/creating-a-signed-transaction/#multisignature-transactions | Creating a Signed Transaction}
+     *
+     * @param args.signatures A list of signatures
+     * @param args.bitmap 4 bytes, at most 32 signatures are supported. If Nth bit value is `1`, the Nth
+     * signature should be provided in `signatures`. Bits are read from left to right
+     * @group Implementation
+     * @category Serialization
+     */
+    constructor(args) {
+        super();
+        const { signatures, bitmap } = args;
+        if (signatures.length > MultiKeySignature.MAX_SIGNATURES_SUPPORTED) {
+            throw new Error(`The number of signatures cannot be greater than ${MultiKeySignature.MAX_SIGNATURES_SUPPORTED}`);
+        }
+        // Make sure that all signatures are normalized to the SingleKey authentication scheme
+        this.signatures = signatures.map((signature) => signature instanceof AnySignature ? signature : new AnySignature(signature));
+        if (!(bitmap instanceof Uint8Array)) {
+            this.bitmap = MultiKeySignature.createBitmap({ bits: bitmap });
+        }
+        else if (bitmap.length !== MultiKeySignature.BITMAP_LEN) {
+            throw new Error(`"bitmap" length should be ${MultiKeySignature.BITMAP_LEN}`);
+        }
+        else {
+            this.bitmap = bitmap;
+        }
+        const nSignatures = this.bitmap.reduce((acc, byte) => acc + bitCount(byte), 0);
+        if (nSignatures !== this.signatures.length) {
+            throw new Error(`Expecting ${nSignatures} signatures from the bitmap, but got ${this.signatures.length}`);
+        }
+    }
+    /**
+     * Helper method to create a bitmap out of the specified bit positions
+     * @param args.bits The bitmap positions that should be set. A position starts at index 0.
+     * Valid position should range between 0 and 31.
+     * @example
+     * Here's an example of valid `bits`
+     * ```
+     * [0, 2, 31]
+     * ```
+     * `[0, 2, 31]` means the 1st, 3rd and 32nd bits should be set in the bitmap.
+     * The result bitmap should be 0b1010000000000000000000000000001
+     *
+     * @returns bitmap that is 32bit long
+     * @group Implementation
+     * @category Serialization
+     */
+    static createBitmap(args) {
+        const { bits } = args;
+        // Bits are read from left to right. e.g. 0b10000000 represents the first bit is set in one byte.
+        // The decimal value of 0b10000000 is 128.
+        const firstBitInByte = 128;
+        const bitmap = new Uint8Array([0, 0, 0, 0]);
+        // Check if duplicates exist in bits
+        const dupCheckSet = new Set();
+        bits.forEach((bit) => {
+            if (bit >= MultiKeySignature.MAX_SIGNATURES_SUPPORTED) {
+                throw new Error(`Cannot have a signature larger than ${MultiKeySignature.MAX_SIGNATURES_SUPPORTED - 1}.`);
+            }
+            if (dupCheckSet.has(bit)) {
+                throw new Error("Duplicate bits detected.");
+            }
+            dupCheckSet.add(bit);
+            const byteOffset = Math.floor(bit / 8);
+            let byte = bitmap[byteOffset];
+            byte |= firstBitInByte >> (bit % 8);
+            bitmap[byteOffset] = byte;
+        });
+        return bitmap;
+    }
+    /**
+     * Converts the bitmap to an array of signer indices.
+     *
+     * Example:
+     *
+     * bitmap: [0b10001000, 0b01000000, 0b00000000, 0b00000000]
+     * signerIndices: [0, 4, 9]
+     *
+     * @returns An array of signer indices.
+     * @group Implementation
+     * @category Serialization
+     */
+    bitMapToSignerIndices() {
+        const signerIndices = [];
+        for (let i = 0; i < this.bitmap.length; i += 1) {
+            const byte = this.bitmap[i];
+            for (let bit = 0; bit < 8; bit += 1) {
+                if ((byte & (128 >> bit)) !== 0) {
+                    signerIndices.push(i * 8 + bit);
+                }
+            }
+        }
+        return signerIndices;
+    }
+    // region Serializable
+    serialize(serializer) {
+        // Note: we should not need to serialize the vector length, as it can be derived from the bitmap
+        serializer.serializeVector(this.signatures);
+        serializer.serializeBytes(this.bitmap);
+    }
+    static deserialize(deserializer) {
+        const signatures = deserializer.deserializeVector(AnySignature);
+        const bitmap = deserializer.deserializeBytes();
+        return new MultiKeySignature({ signatures, bitmap });
+    }
+}
+//# sourceMappingURL=multiKey.js.map

package/dist/core/crypto/multiKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"multiKey.js","sourceRoot":"","sources":["../../../src/core/crypto/multiKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,aAAa,IAAI,uBAAuB,EAAY,MAAM,sBAAsB,CAAC;AAG/G,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAa,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG5D;;;;;;;GAOG;AAEH,SAAS,QAAQ,CAAC,IAAY;IAC5B,IAAI,CAAC,GAAG,IAAI,CAAC;IACb,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,UAAU,CAAC;IAC3B,CAAC,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC;IAC/C,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;AAC1D,CAAC;AAED,MAAM,oCAAoC,GAAG,CAAC,CAAC;AAC/C,MAAM,OAAgB,gBAAiB,SAAQ,gBAAgB;IAC7D,UAAU,CAAc;IAExB,YAAY,IAAiC;QAC3C,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;IACpC,CAAC;IAED;;;;;;;;OAQG;IACH,YAAY,CAAC,IAAwB;QACnC,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QACtB,iGAAiG;QACjG,0CAA0C;QAC1C,MAAM,cAAc,GAAG,GAAG,CAAC;QAC3B,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAE5C,oCAAoC;QACpC,MAAM,WAAW,GAAG,IAAI,GAAG,EAAE,CAAC;QAE9B,IAAI,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,GAAW,EAAE,EAAE;YACxC,IAAI,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;gBACrC,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,GAAG,CAAC,iCAAiC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;YACxG,CAAC;YAED,IAAI,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CAAC,iBAAiB,GAAG,YAAY,CAAC,CAAC;YACpD,CAAC;YAED,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAErB,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;YAEvC,IAAI,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;YAE9B,IAAI,IAAI,cAAc,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;YAEpC,MAAM,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,SAAoB;QAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QAExF,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,cAAc,SAAS,+BAA+B,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IAC3F,CAAC;CAGF;AAED;;;;;;;;;;GAUG;AACH,MAAM,OAAO,QAAS,SAAQ,gBAAgB;IAC5C;;;;OAIG;IACa,UAAU,CAAiB;IAE3C;;;;OAIG;IACa,kBAAkB,CAAS;IAE3C;;;;;;;;;;;;;OAaG;IACH,sBAAsB;IACtB,YAAY,IAAkE;QAC5E,MAAM,EAAE,UAAU,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC;QAChD,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;QAEtB,oEAAoE;QACpE,IAAI,kBAAkB,GAAG,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;QAClF,CAAC;QAED,oEAAoE;QACpE,IAAI,UAAU,CAAC,MAAM,GAAG,kBAAkB,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CACb,YAAY,UAAU,CAAC,MAAM,oCAAoC,kBAAkB,sBAAsB,CAC1G,CAAC;QACJ,CAAC;QAED,gFAAgF;QAChF,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAC7C,SAAS,YAAY,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,SAAS,CAAC,CAC5E,CAAC;QACF,IAAI,kBAAkB,GAAG,oCAAoC,EAAE,CAAC;YAC9D,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CACzC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,OAAO,KAAK,mBAAmB,CAAC,OAAO,IAAI,EAAE,CAAC,OAAO,KAAK,mBAAmB,CAAC,gBAAgB,CAC1G,CAAC,MAAM,CAAC;YACT,IAAI,YAAY,GAAG,oCAAoC,EAAE,CAAC;gBACxD,MAAM,IAAI,KAAK,CACb,2CAA2C,oCAAoC;4BAC7D,oCAAoC;uCACzB,CAC9B,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;IAC/C,CAAC;IAED,qBAAqB;QACnB,OAAO,IAAI,CAAC,kBAAkB,CAAC;IACjC,CAAC;IAED,YAAY;IAEZ,0BAA0B;IAE1B;;;;;;;;;;;OAWG;IACH,eAAe,CAAC,IAAyD;QACvE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;QACpC,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,KAAK,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAC;QAC/F,CAAC;QACD,MAAM,aAAa,GAAG,SAAS,CAAC,qBAAqB,EAAE,CAAC;QACxD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YACxD,MAAM,eAAe,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YAChD,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;YACpD,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,CAAC,EAAE,CAAC;gBACxE,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,oBAAoB,CAAC,IAK1B;QACC,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;QAC3B,IAAI,CAAC;YACH,IAAI,CAAC,CAAC,SAAS,YAAY,iBAAiB,CAAC,EAAE,CAAC;gBAC9C,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;YAC1D,CAAC;YACD,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,KAAK,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBAC5D,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAC;YAC/F,CAAC;YACD,MAAM,aAAa,GAAG,SAAS,CAAC,qBAAqB,EAAE,CAAC;YACxD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxD,MAAM,eAAe,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;gBAChD,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;gBACpD,IAAI,CAAC,CAAC,MAAM,SAAS,CAAC,oBAAoB,CAAC,EAAE,GAAG,IAAI,EAAE,SAAS,EAAE,eAAe,EAAE,CAAC,CAAC,EAAE,CAAC;oBACrF,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,IAAI,CAAC,OAAO,EAAE,oBAAoB,EAAE,CAAC;gBACvC,MAAM,KAAK,CAAC;YACd,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,OAAO,iBAAiB,CAAC,kBAAkB,CAAC;YAC1C,MAAM,EAAE,uBAAuB,CAAC,QAAQ;YACxC,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE;SAC3B,CAAC,CAAC;IACL,CAAC;IAED,YAAY;IAEZ,sBAAsB;IAEtB;;;;;;;OAOG;IACH,SAAS,CAAC,UAAsB;QAC9B,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5C,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,WAAW,CAAC,YAA0B;QAC3C,MAAM,IAAI,GAAG,YAAY,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;QAC1D,MAAM,kBAAkB,GAAG,YAAY,CAAC,aAAa,EAAE,CAAC;QAExD,OAAO,IAAI,QAAQ,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,YAAY;IAEZ;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,SAAoB;QAC3B,MAAM,YAAY,GAAG,SAAS,YAAY,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,SAAS,CAAC,CAAC;QACjG,OAAO,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IACtC,CAAC;IAEM,MAAM,CAAC,UAAU,CAAC,KAAgB;QACvC,OAAO,YAAY,IAAI,KAAK,IAAI,oBAAoB,IAAI,KAAK,CAAC;IAChE,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,iBAAkB,SAAQ,SAAS;IAC9C;;;;OAIG;IACH,MAAM,CAAC,UAAU,GAAW,CAAC,CAAC;IAE9B;;;;OAIG;IACH,MAAM,CAAC,wBAAwB,GAAG,iBAAiB,CAAC,UAAU,GAAG,CAAC,CAAC;IAEnE;;;;OAIG;IACa,UAAU,CAAiB;IAE3C;;;;;;OAMG;IACa,MAAM,CAAa;IAEnC;;;;;;;;;;;OAWG;IACH,YAAY,IAAoF;QAC9F,KAAK,EAAE,CAAC;QACR,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAEpC,IAAI,UAAU,CAAC,MAAM,GAAG,iBAAiB,CAAC,wBAAwB,EAAE,CAAC;YACnE,MAAM,IAAI,KAAK,CAAC,mDAAmD,iBAAiB,CAAC,wBAAwB,EAAE,CAAC,CAAC;QACnH,CAAC;QAED,sFAAsF;QACtF,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAC7C,SAAS,YAAY,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,SAAS,CAAC,CAC5E,CAAC;QAEF,IAAI,CAAC,CAAC,MAAM,YAAY,UAAU,CAAC,EAAE,CAAC;YACpC,IAAI,CAAC,MAAM,GAAG,iBAAiB,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QACjE,CAAC;aAAM,IAAI,MAAM,CAAC,MAAM,KAAK,iBAAiB,CAAC,UAAU,EAAE,CAAC;YAC1D,MAAM,IAAI,KAAK,CAAC,6BAA6B,iBAAiB,CAAC,UAAU,EAAE,CAAC,CAAC;QAC/E,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACvB,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QAC/E,IAAI,WAAW,KAAK,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,aAAa,WAAW,wCAAwC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;QAC5G,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,YAAY,CAAC,IAAwB;QAC1C,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QACtB,iGAAiG;QACjG,0CAA0C;QAC1C,MAAM,cAAc,GAAG,GAAG,CAAC;QAC3B,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAE5C,oCAAoC;QACpC,MAAM,WAAW,GAAG,IAAI,GAAG,EAAE,CAAC;QAE9B,IAAI,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE;YAC3B,IAAI,GAAG,IAAI,iBAAiB,CAAC,wBAAwB,EAAE,CAAC;gBACtD,MAAM,IAAI,KAAK,CAAC,uCAAuC,iBAAiB,CAAC,wBAAwB,GAAG,CAAC,GAAG,CAAC,CAAC;YAC5G,CAAC;YAED,IAAI,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;YAC9C,CAAC;YAED,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAErB,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;YAEvC,IAAI,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;YAE9B,IAAI,IAAI,cAAc,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;YAEpC,MAAM,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,qBAAqB;QACnB,MAAM,aAAa,GAAa,EAAE,CAAC;QACnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC5B,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;gBACpC,IAAI,CAAC,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;oBAChC,aAAa,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;gBAClC,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,sBAAsB;IAEtB,SAAS,CAAC,UAAsB;QAC9B,gGAAgG;QAChG,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5C,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,YAA0B;QAC3C,MAAM,UAAU,GAAG,YAAY,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;QAChE,MAAM,MAAM,GAAG,YAAY,CAAC,gBAAgB,EAAE,CAAC;QAC/C,OAAO,IAAI,iBAAiB,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC;IACvD,CAAC"}

package/dist/core/crypto/poseidon.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Hashes a string to a field element via Poseidon hashing.
+ * This function is useful for converting a string into a fixed-size hash that can be used in cryptographic applications.
+ *
+ * @param str - The string to be hashed.
+ * @param maxSizeBytes - The maximum size in bytes for the resulting hash.
+ * @returns bigint - The result of the hash.
+ * @group Implementation
+ * @category Serialization
+ */
+export declare function hashStrToField(str: string, maxSizeBytes: number): bigint;
+/**
+ * Pads and packs the given byte array to a specified maximum size and appends its length.
+ * This function ensures that the byte array does not exceed the maximum size, throwing an error if it does.
+ * It is useful for preparing byte data for further processing or transmission by ensuring a consistent format.
+ *
+ * @param bytes - The byte array to be padded and packed.
+ * @param maxSizeBytes - The maximum allowed size for the byte array.
+ * @throws Error if the length of the input bytes exceeds the maximum size.
+ * @returns A new Uint8Array that contains the padded and packed bytes along with the length of the original byte array.
+ * @group Implementation
+ * @category Serialization
+ */
+export declare function padAndPackBytesWithLen(bytes: Uint8Array, maxSizeBytes: number): bigint[];
+/**
+ * Converts a little-endian byte array into a BigInt.
+ * This function is useful for interpreting byte data as a numerical value in a way that respects the little-endian format.
+ *
+ * @param bytes - The byte array to convert.
+ * @returns The resulting BigInt representation of the byte array.
+ * @group Implementation
+ * @category Serialization
+ */
+export declare function bytesToBigIntLE(bytes: Uint8Array): bigint;
+/**
+ * Converts a bigint value into a little-endian byte array of a specified length.
+ * This function is useful for representing large integers in a byte format, which is often required for cryptographic operations
+ * or binary data manipulation.
+ *
+ * @param value - The number to convert into bytes.
+ * @param length - The desired length of the resulting byte array.
+ * @returns A Uint8Array containing the little-endian representation of the bigint value.
+ * @group Implementation
+ * @category Serialization
+ */
+export declare function bigIntToBytesLE(value: bigint | number, length: number): Uint8Array;
+/**
+ * Hashes up to 16 scalar elements via the Poseidon hashing algorithm.
+ * Each element must be scalar fields of the BN254 elliptic curve group.
+ *
+ * @param inputs - An array of elements to be hashed, which can be of type number, bigint, or string.
+ * @returns bigint - The result of the hash.
+ * @throws Error - Throws an error if the input length exceeds the maximum allowed.
+ * @group Implementation
+ * @category Serialization
+ */
+export declare function poseidonHash(inputs: (number | bigint | string)[]): bigint;
+//# sourceMappingURL=poseidon.d.ts.map

package/dist/core/crypto/poseidon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"poseidon.d.ts","sourceRoot":"","sources":["../../../src/core/crypto/poseidon.ts"],"names":[],"mappings":"AA2CA;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAGxE;AAsCD;;;;;;;;;;;GAWG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,CAKxF;AAkCD;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAMzD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU,CAQlF;AA+BD;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,MAAM,CAOzE"}