@aptos-labs/ts-sdk 6.3.1 → 7.0.1

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

@@ -0,0 +1,304 @@
+import { Deserializer, Serializer } from "../../bcs/index.js";
+import { Hex } from "../hex.js";
+import { HexInput } from "../../types/index.js";
+import { PublicKey, VerifySignatureAsyncArgs } from "./publicKey.js";
+import { PrivateKey } from "./privateKey.js";
+import { Signature } from "./signature.js";
+import { AuthenticationKey } from "../authenticationKey.js";
+/**
+ * Represents a Secp256r1 ECDSA public key.
+ *
+ * @extends PublicKey
+ * @property LENGTH - The length of the Secp256r1 public key in bytes.
+ * @group Implementation
+ * @category Serialization
+ */
+export declare class Secp256r1PublicKey extends PublicKey {
+    static readonly LENGTH: number;
+    static readonly COMPRESSED_LENGTH: number;
+    private readonly key;
+    readonly keyType: string;
+    /**
+     * Create a new PublicKey instance from a HexInput, which can be a string or Uint8Array.
+     * This constructor validates the length of the provided public key data.
+     *
+     * @param hexInput - A HexInput (string or Uint8Array) representing the public key data.
+     * @throws Error if the length of the public key data is not equal to Secp256r1PublicKey.LENGTH or COMPRESSED_LENGTH.
+     * @group Implementation
+     * @category Serialization
+     */
+    constructor(hexInput: HexInput);
+    /**
+     * Get the data as a Uint8Array representation.
+     *
+     * @returns Uint8Array representation of the data.
+     * @group Implementation
+     * @category Serialization
+     */
+    toUint8Array(): Uint8Array;
+    /**
+     * Get the public key as a hex string with the 0x prefix.
+     *
+     * @returns string representation of the public key.
+     * @group Implementation
+     * @category Serialization
+     */
+    toString(): string;
+    /**
+     * Converts the public key to BCS (Binary Canonical Serialization) bytes.
+     * This function serializes the public key data into a byte array format suitable for transmission or storage.
+     *
+     * @returns Uint8Array representation of the serialized public key.
+     * @group Implementation
+     * @category Serialization
+     */
+    bcsToBytes(): Uint8Array<ArrayBufferLike>;
+    /**
+     * Verifies a Secp256r1 signature against the public key.
+     *
+     * This function checks the validity of a signature for a given message.
+     *
+     * @param args - The arguments for verifying the signature.
+     * @param args.message - The message that was signed.
+     * @param args.signature - The signature to verify against the public key.
+     * @group Implementation
+     * @category Serialization
+     */
+    verifySignature(args: {
+        message: HexInput;
+        signature: Signature;
+    }): boolean;
+    /**
+     * Note: Secp256r1Signatures can be verified synchronously.
+     *
+     * Verifies the provided signature against the given message.
+     * This function helps ensure the integrity and authenticity of the message by confirming that the signature is valid.
+     *
+     * @param args - The arguments for signature verification.
+     * @param args.message - The message that was signed.
+     * @param args.signature - The signature to verify, which must be an instance of Secp256r1Signature.
+     * @returns A boolean indicating whether the signature is valid for the given message.
+     * @group Implementation
+     * @category Serialization
+     */
+    verifySignatureAsync(args: VerifySignatureAsyncArgs): Promise<boolean>;
+    /**
+     * Serializes the data into a byte array using the provided serializer.
+     * This function is essential for converting data into a format suitable for transmission or storage.
+     *
+     * @param serializer - The serializer instance used to convert the data.
+     * @group Implementation
+     * @category Serialization
+     */
+    serialize(serializer: Serializer): void;
+    /**
+     * Deserializes a Secp256r1PublicKey from the provided deserializer.
+     * This function allows you to reconstruct a Secp256r1PublicKey object from its serialized byte representation.
+     *
+     * @param deserializer - The deserializer instance used to read the serialized data.
+     * @group Implementation
+     * @category Serialization
+     */
+    static deserialize(deserializer: Deserializer): Secp256r1PublicKey;
+    /**
+     * Loads a Secp256r1PublicKey from the provided deserializer.
+     *
+     * @param deserializer - The deserializer instance used to read the serialized data.
+     * @group Implementation
+     * @category Serialization
+     */
+    static load(deserializer: Deserializer): Secp256r1PublicKey;
+    /**
+     * Determines if the provided public key is a valid instance of a Secp256r1 public key.
+     * This function checks for the presence of a "key" property and validates the length of the key data.
+     *
+     * @param publicKey - The public key to validate.
+     * @returns A boolean indicating whether the public key is a valid Secp256r1 public key.
+     * @group Implementation
+     * @category Serialization
+     */
+    static isInstance(publicKey: PublicKey): publicKey is Secp256r1PublicKey;
+    /**
+     * Generates an authentication key from the public key using the Secp256r1 scheme.
+     * This function is essential for creating a secure authentication key that can be used for further cryptographic operations.
+     *
+     * @returns {AuthenticationKey} The generated authentication key.
+     * @group Implementation
+     * @category Serialization
+     */
+    authKey(): AuthenticationKey;
+}
+/**
+ * Represents a Secp256r1 ECDSA private key, providing functionality to create, sign messages,
+ * derive public keys, and serialize/deserialize the key.
+ * @group Implementation
+ * @category Serialization
+ */
+export declare class Secp256r1PrivateKey extends PrivateKey {
+    /**
+     * Length of Secp256r1 ecdsa private key
+     * @group Implementation
+     * @category Serialization
+     */
+    static readonly LENGTH: number;
+    /**
+     * The private key bytes
+     * @private
+     * @group Implementation
+     * @category Serialization
+     */
+    private readonly key;
+    /**
+     * Create a new PrivateKey instance from a Uint8Array or String.
+     *
+     * [Read about AIP-80](https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-80.md)
+     *
+     * @param hexInput A HexInput (string or Uint8Array)
+     * @param strict If true, private key must AIP-80 compliant.
+     * @group Implementation
+     * @category Serialization
+     */
+    constructor(hexInput: HexInput, strict?: boolean);
+    /**
+     * Get the private key in bytes (Uint8Array).
+     *
+     * @returns
+     * @group Implementation
+     * @category Serialization
+     */
+    toUint8Array(): Uint8Array;
+    /**
+     * Get the private key as a string representation.
+     *
+     * @returns string representation of the private key
+     * @group Implementation
+     * @category Serialization
+     */
+    toString(): string;
+    /**
+     * Get the private key as a hex string with the 0x prefix.
+     *
+     * @returns string representation of the private key.
+     */
+    toHexString(): string;
+    /**
+     * Sign the given message with the private key.
+     * This function generates a cryptographic signature for the provided message.
+     *
+     * @param message - A message in HexInput format to be signed.
+     * @returns Signature - The generated signature for the provided message.
+     * @group Implementation
+     * @category Serialization
+     */
+    sign(message: HexInput): Secp256r1Signature;
+    /**
+     * Serializes the data into a byte array using the provided serializer.
+     * This function is essential for converting data into a format suitable for transmission or storage.
+     *
+     * @param serializer - The serializer instance used to convert the data.
+     * @group Implementation
+     * @category Serialization
+     */
+    serialize(serializer: Serializer): void;
+    /**
+     * Deserializes a Secp256r1PrivateKey from the provided deserializer.
+     * This function allows you to reconstruct a Secp256r1PrivateKey object from its serialized byte representation.
+     *
+     * @param deserializer - The deserializer instance used to read the serialized data.
+     * @group Implementation
+     * @category Serialization
+     */
+    static deserialize(deserializer: Deserializer): Secp256r1PrivateKey;
+    /**
+     * Generate a new random private key.
+     *
+     * @returns Secp256r1PrivateKey - A newly generated Secp256r1 private key.
+     * @group Implementation
+     * @category Serialization
+     */
+    static generate(): Secp256r1PrivateKey;
+    /**
+     * Derive the Secp256r1PublicKey from this private key.
+     *
+     * @returns Secp256r1PublicKey The derived public key.
+     * @group Implementation
+     * @category Serialization
+     */
+    publicKey(): Secp256r1PublicKey;
+}
+export declare class WebAuthnSignature extends Signature {
+    signature: Hex;
+    authenticatorData: Hex;
+    clientDataJSON: Hex;
+    constructor(signature: HexInput, authenticatorData: HexInput, clientDataJSON: HexInput);
+    toUint8Array(): Uint8Array<ArrayBufferLike>;
+    serialize(serializer: Serializer): void;
+    bcsToBytes(): Uint8Array<ArrayBufferLike>;
+    bcsToHex(): Hex;
+    toStringWithoutPrefix(): string;
+    static deserialize(deserializer: Deserializer): WebAuthnSignature;
+}
+/**
+ * Represents a signature of a message signed using a Secp256r1 ECDSA private key.
+ *
+ * @group Implementation
+ * @category Serialization
+ */
+export declare class Secp256r1Signature extends Signature {
+    /**
+     * Secp256r1 ecdsa signatures are 256-bit.
+     * @group Implementation
+     * @category Serialization
+     */
+    static readonly LENGTH = 64;
+    /**
+     * The signature bytes
+     * @private
+     * @group Implementation
+     * @category Serialization
+     */
+    private readonly data;
+    /**
+     * Create a new Signature instance from a Uint8Array or String.
+     *
+     * @param hexInput A HexInput (string or Uint8Array)
+     * @group Implementation
+     * @category Serialization
+     */
+    constructor(hexInput: HexInput);
+    /**
+     * Get the signature in bytes (Uint8Array).
+     *
+     * @returns Uint8Array representation of the signature
+     * @group Implementation
+     * @category Serialization
+     */
+    toUint8Array(): Uint8Array;
+    /**
+     * Get the signature as a hex string with the 0x prefix.
+     *
+     * @returns string representation of the signature
+     * @group Implementation
+     * @category Serialization
+     */
+    toString(): string;
+    /**
+     * Serializes the data into a byte array using the provided serializer.
+     * This function is essential for converting data into a format suitable for transmission or storage.
+     *
+     * @param serializer - The serializer instance used to convert the data.
+     * @group Implementation
+     * @category Serialization
+     */
+    serialize(serializer: Serializer): void;
+    /**
+     * Deserializes a Secp256r1Signature from the provided deserializer.
+     * This function allows you to reconstruct a Secp256r1Signature object from its serialized byte representation.
+     *
+     * @param deserializer - The deserializer instance used to read the serialized data.
+     * @group Implementation
+     * @category Serialization
+     */
+    static deserialize(deserializer: Deserializer): Secp256r1Signature;
+}
+//# sourceMappingURL=secp256r1.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"secp256r1.d.ts","sourceRoot":"","sources":["../../../src/core/crypto/secp256r1.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAChC,OAAO,EACL,QAAQ,EAIT,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAE5D;;;;;;;GAOG;AACH,qBAAa,kBAAmB,SAAQ,SAAS;IAE/C,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAM;IAGpC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAM;IAG/C,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAM;IAG1B,SAAgB,OAAO,EAAE,MAAM,CAAe;IAE9C;;;;;;;;OAQG;gBACS,QAAQ,EAAE,QAAQ;IAmB9B;;;;;;OAMG;IACH,YAAY,IAAI,UAAU;IAI1B;;;;;;OAMG;IACH,QAAQ,IAAI,MAAM;IAIlB;;;;;;;OAOG;IACH,UAAU;IAMV;;;;;;;;;;OAUG;IACH,eAAe,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,QAAQ,CAAC;QAAC,SAAS,EAAE,SAAS,CAAA;KAAE,GAAG,OAAO;IAU3E;;;;;;;;;;;;OAYG;IACG,oBAAoB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5E;;;;;;;OAOG;IACH,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAIvC;;;;;;;OAOG;IACH,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,kBAAkB;IAKlE;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,kBAAkB;IAK3D;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,IAAI,kBAAkB;IAgBxE;;;;;;;OAOG;IACH,OAAO,IAAI,iBAAiB;CAS7B;AAED;;;;;GAKG;AACH,qBAAa,mBAAoB,SAAQ,UAAU;IACjD;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAM;IAEpC;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAM;IAE1B;;;;;;;;;OASG;gBACS,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,OAAO;IAYhD;;;;;;OAMG;IACH,YAAY,IAAI,UAAU;IAI1B;;;;;;OAMG;IACH,QAAQ,IAAI,MAAM;IAIlB;;;;OAIG;IACH,WAAW,IAAI,MAAM;IAIrB;;;;;;;;OAQG;IACH,IAAI,CAAC,OAAO,EAAE,QAAQ,GAAG,kBAAkB;IAO3C;;;;;;;OAOG;IACH,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAIvC;;;;;;;OAOG;IACH,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,mBAAmB;IAKnE;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,IAAI,mBAAmB;IAKtC;;;;;;OAMG;IACH,SAAS,IAAI,kBAAkB;CAIhC;AAED,qBAAa,iBAAkB,SAAQ,SAAS;IAC9C,SAAS,EAAE,GAAG,CAAC;IAEf,iBAAiB,EAAE,GAAG,CAAC;IAEvB,cAAc,EAAE,GAAG,CAAC;gBAER,SAAS,EAAE,QAAQ,EAAE,iBAAiB,EAAE,QAAQ,EAAE,cAAc,EAAE,QAAQ;IAOtF,YAAY;IAIZ,SAAS,CAAC,UAAU,EAAE,UAAU;IAOhC,UAAU;IAMV,QAAQ;IAIR,qBAAqB;IAIrB,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,YAAY;CAU9C;AAED;;;;;GAKG;AACH,qBAAa,kBAAmB,SAAQ,SAAS;IAC/C;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAM,MAAM;IAE5B;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAM;IAE3B;;;;;;OAMG;gBACS,QAAQ,EAAE,QAAQ;IAY9B;;;;;;OAMG;IACH,YAAY,IAAI,UAAU;IAI1B;;;;;;OAMG;IACH,QAAQ,IAAI,MAAM;IAIlB;;;;;;;OAOG;IACH,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAIvC;;;;;;;OAOG;IACH,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,kBAAkB;CAInE"}