import * as Address from './Address.js'; import * as Bytes from './Bytes.js'; import * as Errors from './Errors.js'; import * as Hash from './Hash.js'; import * as Hex from './Hex.js'; import * as keyDerivation from './internal/keyDerivation.js'; import type { OneOf } from './internal/types.js'; import * as Mnemonic from './Mnemonic.js'; import * as PublicKey from './PublicKey.js'; import type * as Signature from './Signature.js'; /** Re-export of noble/curves secp256k1 utilities. */ export declare const noble: import("@noble/curves/abstract/weierstrass.js").ECDSA; /** * Creates a new secp256k1 ECDSA key pair consisting of a private key and its corresponding public key. * * @example * ```ts twoslash * import { Secp256k1 } from 'ox' * * const { privateKey, publicKey } = Secp256k1.createKeyPair() * ``` * * @param options - The options to generate the key pair. * @returns The generated key pair containing both private and public keys. */ export declare function createKeyPair(options?: createKeyPair.Options): createKeyPair.ReturnType; export declare namespace createKeyPair { type Options = { /** * Format of the returned private key. * @default 'Hex' */ as?: as | 'Hex' | 'Bytes' | undefined; }; type ReturnType = { privateKey: (as extends 'Bytes' ? Bytes.Bytes : never) | (as extends 'Hex' ? Hex.Hex : never); publicKey: PublicKey.PublicKey; }; type ErrorType = Hex.fromBytes.ErrorType | PublicKey.from.ErrorType | Errors.GlobalErrorType; } /** * Derives a valid secp256k1 private key from a 32-byte WebAuthn PRF output. * * The permanent derivation contract uses the PRF output as the HMAC-SHA256 * key. The HMAC message uses the `ox.secp256k1.fromPrf.v1` domain followed by * a 32-bit big-endian counter starting at zero. Invalid scalars are skipped. * * @example * ```ts twoslash * import { Secp256k1 } from 'ox' * * const privateKey = Secp256k1.fromPrf( * '0x000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f' * ) * ``` * * @param value - A 32-byte WebAuthn PRF output. * @param options - Options. * @returns A valid secp256k1 private key. */ export declare function fromPrf(value: Hex.Hex | Bytes.Bytes, options?: fromPrf.Options): fromPrf.ReturnType; export declare namespace fromPrf { type Options = { /** * Format of the returned private key. * @default 'Hex' */ as?: as | 'Hex' | 'Bytes' | undefined; }; type ReturnType = (as extends 'Bytes' ? Bytes.Bytes : never) | (as extends 'Hex' ? Hex.Hex : never); type ErrorType = Bytes.concat.ErrorType | Bytes.from.ErrorType | Bytes.fromNumber.ErrorType | Hash.hmac256.ErrorType | Hex.fromBytes.ErrorType | InvalidPrfSizeError | Errors.GlobalErrorType; } /** * Derives a valid secp256k1 private key from a BIP-39 mnemonic. * * This is equivalent to {@link ox#Mnemonic.toPrivateKey}, and derives the * private key at `m/44'/60'/0'/0/0` by default. * * @example * ```ts twoslash * import { Secp256k1 } from 'ox' * * const privateKey = Secp256k1.fromMnemonic( * 'test test test test test test test test test test test junk' * ) * ``` * * @param mnemonic - BIP-39 mnemonic phrase. * @param options - Options. * @returns A valid secp256k1 private key. */ export declare function fromMnemonic(mnemonic: string, options?: fromMnemonic.Options): fromMnemonic.ReturnType; export declare namespace fromMnemonic { type Options = { /** * Format of the returned private key. * @default 'Hex' */ as?: as | 'Hex' | 'Bytes' | undefined; /** Derivation path. @default `m/44'/60'/0'/0/0` */ path?: string | undefined; /** Optional BIP-39 passphrase. */ passphrase?: string | undefined; }; type ReturnType = Mnemonic.toPrivateKey.ReturnType; type ErrorType = Mnemonic.toPrivateKey.ErrorType; } /** * Derives a valid secp256k1 private key from a seed. * * The seed must contain at least 32 bytes of cryptographically strong key * material. Do not pass a password directly; use a password KDF first. * * The permanent derivation contract uses the seed as the HMAC-SHA256 * key. The HMAC message uses the `ox.secp256k1.fromSeed.v1` domain followed by * a 32-bit big-endian counter starting at zero. Invalid scalars are skipped. * * @example * ```ts twoslash * import { Secp256k1 } from 'ox' * * const privateKey = Secp256k1.fromSeed( * '0x000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f' * ) * ``` * * @param seed - Seed containing at least 32 bytes of cryptographically strong key material. * @param options - Options. * @returns A valid secp256k1 private key. */ export declare function fromSeed(seed: Hex.Hex | Bytes.Bytes, options?: fromSeed.Options): fromSeed.ReturnType; export declare namespace fromSeed { type Options = { /** * Format of the returned private key. * @default 'Hex' */ as?: as | 'Hex' | 'Bytes' | undefined; }; type ReturnType = (as extends 'Bytes' ? Bytes.Bytes : never) | (as extends 'Hex' ? Hex.Hex : never); type ErrorType = Bytes.from.ErrorType | Hex.fromBytes.ErrorType | keyDerivation.derive.ErrorType | InvalidSeedSizeError | Errors.GlobalErrorType; } /** * Computes the secp256k1 ECDSA public key from a provided private key. * * @example * ```ts twoslash * import { Secp256k1 } from 'ox' * * const publicKey = Secp256k1.getPublicKey({ * privateKey: '0x...' * }) * ``` * * @param options - The options to compute the public key. * @returns The computed public key. */ export declare function getPublicKey(options: getPublicKey.Options): getPublicKey.ReturnType; export declare namespace getPublicKey { type Options = { /** * Format of the returned public key. * @default 'Object' */ as?: as | 'Hex' | 'Bytes' | 'Object' | undefined; /** * Private key to compute the public key from. */ privateKey: Hex.Hex | Bytes.Bytes; }; type ReturnType = (as extends 'Bytes' ? Bytes.Bytes : never) | (as extends 'Hex' ? Hex.Hex : never) | (as extends 'Object' ? PublicKey.PublicKey : never); type ErrorType = Hex.from.ErrorType | PublicKey.from.ErrorType | Errors.GlobalErrorType; } /** * Computes a shared secret using ECDH (Elliptic Curve Diffie-Hellman) between a private key and a public key. * * @example * ```ts twoslash * import { Secp256k1 } from 'ox' * * const { privateKey: privateKeyA } = * Secp256k1.createKeyPair() * const { publicKey: publicKeyB } = Secp256k1.createKeyPair() * * const sharedSecret = Secp256k1.getSharedSecret({ * privateKey: privateKeyA, * publicKey: publicKeyB * }) * ``` * * @param options - The options to compute the shared secret. * @returns The computed shared secret. */ export declare function getSharedSecret(options: getSharedSecret.Options): getSharedSecret.ReturnType; export declare namespace getSharedSecret { type Options = { /** * Format of the returned shared secret. * @default 'Hex' */ as?: as | 'Hex' | 'Bytes' | undefined; /** * Private key to use for the shared secret computation. */ privateKey: Hex.Hex | Bytes.Bytes; /** * Public key to use for the shared secret computation. * * Accepts a structured {@link ox#PublicKey.PublicKey}, a serialized hex * string, or a `Uint8Array` (SEC1 encoding). */ publicKey: Hex.Hex | Bytes.Bytes | PublicKey.PublicKey; }; type ReturnType = (as extends 'Bytes' ? Bytes.Bytes : never) | (as extends 'Hex' ? Hex.Hex : never); type ErrorType = Hex.from.ErrorType | PublicKey.toHex.ErrorType | Hex.fromBytes.ErrorType | Errors.GlobalErrorType; } /** * Generates a random ECDSA private key on the secp256k1 curve. * * @example * ```ts twoslash * import { Secp256k1 } from 'ox' * * const privateKey = Secp256k1.randomPrivateKey() * ``` * * @param options - The options to generate the private key. * @returns The generated private key. */ export declare function randomPrivateKey(options?: randomPrivateKey.Options): randomPrivateKey.ReturnType; export declare namespace randomPrivateKey { type Options = { /** * Format of the returned private key. * @default 'Hex' */ as?: as | 'Hex' | 'Bytes' | undefined; }; type ReturnType = (as extends 'Bytes' ? Bytes.Bytes : never) | (as extends 'Hex' ? Hex.Hex : never); type ErrorType = Hex.fromBytes.ErrorType | Errors.GlobalErrorType; } /** * Recovers the signing address from the signed payload and signature. * * @example * ```ts twoslash * import { Secp256k1 } from 'ox' * * const signature = Secp256k1.sign({ * payload: '0xdeadbeef', * privateKey: '0x...' * }) * * const address = Secp256k1.recoverAddress({ * // [!code focus] * payload: '0xdeadbeef', // [!code focus] * signature // [!code focus] * }) // [!code focus] * ``` * * @param options - The recovery options. * @returns The recovered address. */ export declare function recoverAddress(options: recoverAddress.Options): recoverAddress.ReturnType; export declare namespace recoverAddress { type Options = { /** Payload that was signed. */ payload: Hex.Hex | Bytes.Bytes; /** * Signature of the payload. * * Accepts a structured {@link ox#Signature.Signature}, a serialized hex * string, or a `Uint8Array` (65-byte recovered). */ signature: Hex.Hex | Bytes.Bytes | Signature.Signature; }; type ReturnType = Address.Address; type ErrorType = Address.fromPublicKey.ErrorType | recoverPublicKey.ErrorType | Errors.GlobalErrorType; } /** * Recovers the signing public key from the signed payload and signature. * * @example * ```ts twoslash * import { Secp256k1 } from 'ox' * * const signature = Secp256k1.sign({ * payload: '0xdeadbeef', * privateKey: '0x...' * }) * * const publicKey = Secp256k1.recoverPublicKey({ * // [!code focus] * payload: '0xdeadbeef', // [!code focus] * signature // [!code focus] * }) // [!code focus] * ``` * * @param options - The recovery options. * @returns The recovered public key. */ export declare function recoverPublicKey(options: recoverPublicKey.Options): recoverPublicKey.ReturnType; export declare namespace recoverPublicKey { type Options = { /** * Format of the returned public key. * @default 'Object' */ as?: as | 'Hex' | 'Bytes' | 'Object' | undefined; /** Payload that was signed. */ payload: Hex.Hex | Bytes.Bytes; /** * Signature of the payload. * * Accepts a structured {@link ox#Signature.Signature}, a serialized hex * string, or a `Uint8Array` (65-byte recovered). */ signature: Hex.Hex | Bytes.Bytes | Signature.Signature; }; type ReturnType = (as extends 'Bytes' ? Bytes.Bytes : never) | (as extends 'Hex' ? Hex.Hex : never) | (as extends 'Object' ? PublicKey.PublicKey : never); type ErrorType = PublicKey.from.ErrorType | Hex.from.ErrorType | Errors.GlobalErrorType; } /** * Signs the payload with the provided private key. * * @example * ```ts twoslash * import { Secp256k1 } from 'ox' * * const signature = Secp256k1.sign({ * // [!code focus] * payload: '0xdeadbeef', // [!code focus] * privateKey: '0x...' // [!code focus] * }) // [!code focus] * ``` * * @param options - The signing options. * @returns The ECDSA {@link ox#Signature.Signature}. */ export declare function sign(options: sign.Options): sign.ReturnType; export declare namespace sign { type Options = { /** * Format of the returned signature. * @default 'Object' */ as?: as | 'Hex' | 'Bytes' | 'Object' | undefined; /** * Extra entropy to add to the signing process. Setting to `true` enables hedged * (RFC 6979 + extra randomness) signing. * @default false */ extraEntropy?: boolean | Hex.Hex | Bytes.Bytes | undefined; /** * If set to `true`, the payload will be hashed (sha256) before being signed. */ hash?: boolean | undefined; /** * Payload to sign. */ payload: Hex.Hex | Bytes.Bytes; /** * ECDSA private key. */ privateKey: Hex.Hex | Bytes.Bytes; }; type ReturnType = (as extends 'Bytes' ? Bytes.Bytes : never) | (as extends 'Hex' ? Hex.Hex : never) | (as extends 'Object' ? Signature.Signature : never); type ErrorType = Bytes.from.ErrorType | Errors.GlobalErrorType; } /** * Verifies a payload was signed by the provided address. * * @example * ### Verify with Ethereum Address * * ```ts twoslash * import { Secp256k1 } from 'ox' * * const signature = Secp256k1.sign({ * payload: '0xdeadbeef', * privateKey: '0x...' * }) * * const verified = Secp256k1.verify({ * // [!code focus] * address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', // [!code focus] * payload: '0xdeadbeef', // [!code focus] * signature // [!code focus] * }) // [!code focus] * ``` * * @example * ### Verify with Public Key * * ```ts twoslash * import { Secp256k1 } from 'ox' * * const privateKey = '0x...' * const publicKey = Secp256k1.getPublicKey({ privateKey }) * const signature = Secp256k1.sign({ * payload: '0xdeadbeef', * privateKey * }) * * const verified = Secp256k1.verify({ * // [!code focus] * publicKey, // [!code focus] * payload: '0xdeadbeef', // [!code focus] * signature // [!code focus] * }) // [!code focus] * ``` * * @param options - The verification options. * @returns Whether the payload was signed by the provided address. */ export declare function verify(options: verify.Options): boolean; export declare namespace verify { type Options = { /** If set to `true`, the payload will be hashed (sha256) before being verified. */ hash?: boolean | undefined; /** Payload that was signed. */ payload: Hex.Hex | Bytes.Bytes; } & OneOf<{ /** Address that signed the payload. */ address: Address.Address; /** * Signature of the payload. * * Accepts a structured {@link ox#Signature.Signature}, a serialized * hex string, or a `Uint8Array`. */ signature: Hex.Hex | Bytes.Bytes | Signature.Signature; } | { /** * Public key that signed the payload. * * Accepts a structured {@link ox#PublicKey.PublicKey}, a serialized * hex string, or a `Uint8Array` (SEC1 encoding). */ publicKey: Hex.Hex | Bytes.Bytes | PublicKey.PublicKey; /** * Signature of the payload. * * Accepts a structured {@link ox#Signature.Signature}, a serialized * hex string, or a `Uint8Array`. */ signature: Hex.Hex | Bytes.Bytes | Signature.Signature; }>; type ErrorType = Errors.GlobalErrorType; } /** Thrown when a WebAuthn PRF output is not 32 bytes. */ export declare class InvalidPrfSizeError extends Errors.BaseError { readonly name = "Secp256k1.InvalidPrfSizeError"; constructor(options: InvalidPrfSizeError.Options); } export declare namespace InvalidPrfSizeError { /** Options for {@link ox#Secp256k1.InvalidPrfSizeError}. */ type Options = { /** Received PRF output size. */ size: number; }; } /** Thrown when a seed contains fewer than 32 bytes. */ export declare class InvalidSeedSizeError extends Errors.BaseError { readonly name = "Secp256k1.InvalidSeedSizeError"; constructor(options: InvalidSeedSizeError.Options); } export declare namespace InvalidSeedSizeError { /** Options for {@link ox#Secp256k1.InvalidSeedSizeError}. */ type Options = { /** Received seed size. */ size: number; }; } //# sourceMappingURL=Secp256k1.d.ts.map