ox 0.0.1 → 0.1.0

package/_types/Value.d.ts

@@ -0,0 +1,159 @@
+import * as Errors from './Errors.js';
+/** @see https://ethereum.github.io/yellowpaper/paper.pdf */
+export declare const exponents: {
+    readonly wei: 0;
+    readonly gwei: 9;
+    readonly szabo: 12;
+    readonly finney: 15;
+    readonly ether: 18;
+};
+/**
+ * Formats a `bigint` Value to its string representation (divided by the given exponent).
+ *
+ * @example
+ * ```ts twoslash
+ * import { Value } from 'ox'
+ *
+ * Value.format(420_000_000_000n, 9)
+ * // @log: '420'
+ * ```
+ *
+ * @param value - The `bigint` Value to format.
+ * @param decimals - The exponent to divide the `bigint` Value by.
+ * @returns The string representation of the Value.
+ */
+export declare function format(value: bigint, decimals?: number): string;
+export declare namespace format {
+    var parseError: (error: unknown) => format.ErrorType;
+}
+export declare namespace format {
+    type ErrorType = Errors.GlobalErrorType;
+}
+/**
+ * Formats a `bigint` Value (default: wei) to a string representation of Ether.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Value } from 'ox'
+ *
+ * Value.formatEther(1_000_000_000_000_000_000n)
+ * // @log: '1'
+ * ```
+ *
+ * @param wei - The Value to format.
+ * @param unit - The unit to format the Value in. @default 'wei'.
+ * @returns The Ether string representation of the Value.
+ */
+export declare function formatEther(wei: bigint, unit?: 'wei' | 'gwei' | 'szabo' | 'finney'): string;
+export declare namespace formatEther {
+    var parseError: (error: unknown) => formatEther.ErrorType;
+}
+export declare namespace formatEther {
+    type ErrorType = format.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Formats a `bigint` Value (default: wei) to a string representation of Gwei.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Value } from 'ox'
+ *
+ * Value.formatGwei(1_000_000_000n)
+ * // @log: '1'
+ * ```
+ *
+ * @param wei - The Value to format.
+ * @param unit - The unit to format the Value in. @default 'wei'.
+ * @returns The Gwei string representation of the Value.
+ */
+export declare function formatGwei(wei: bigint, unit?: 'wei'): string;
+export declare namespace formatGwei {
+    var parseError: (error: unknown) => formatGwei.ErrorType;
+}
+export declare namespace formatGwei {
+    type ErrorType = format.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Parses a `string` representation of a Value to `bigint` (multiplied by the given exponent).
+ *
+ * @example
+ * ```ts twoslash
+ * import { Value } from 'ox'
+ *
+ * Value.from('420', 9)
+ * // @log: 420000000000n
+ * ```
+ *
+ * @param value - The string representation of the Value.
+ * @param decimals - The exponent to multiply the Value by.
+ * @returns The `bigint` representation of the Value.
+ */
+export declare function from(value: string, decimals?: number): bigint;
+export declare namespace from {
+    var parseError: (error: unknown) => from.ErrorType;
+}
+export declare namespace from {
+    type ErrorType = Errors.GlobalErrorType;
+}
+/**
+ * Parses a string representation of Ether to a `bigint` Value (default: wei).
+ *
+ * @example
+ * ```ts twoslash
+ * import { Value } from 'ox'
+ *
+ * Value.fromEther('420')
+ * // @log: 420000000000000000000n
+ * ```
+ *
+ * @param ether - String representation of Ether.
+ * @param unit - The unit to parse to. @default 'wei'.
+ * @returns A `bigint` Value.
+ */
+export declare function fromEther(ether: string, unit?: 'wei' | 'gwei' | 'szabo' | 'finney'): bigint;
+export declare namespace fromEther {
+    var parseError: (error: unknown) => fromEther.ErrorType;
+}
+export declare namespace fromEther {
+    type ErrorType = from.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Parses a string representation of Gwei to a `bigint` Value (default: wei).
+ *
+ * @example
+ * ```ts twoslash
+ * import { Value } from 'ox'
+ *
+ * Value.fromGwei('420')
+ * // @log: 420000000000n
+ * ```
+ *
+ * @param gwei - String representation of Gwei.
+ * @param unit - The unit to parse to. @default 'wei'.
+ * @returns A `bigint` Value.
+ */
+export declare function fromGwei(gwei: string, unit?: 'wei'): bigint;
+export declare namespace fromGwei {
+    var parseError: (error: unknown) => fromGwei.ErrorType;
+}
+export declare namespace fromGwei {
+    type ErrorType = from.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Thrown when a value is not a valid decimal number.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Value } from 'ox'
+ *
+ * Value.fromEther('123.456.789')
+ * // @error: Value.InvalidDecimalNumberError: Value `123.456.789` is not a valid decimal number.
+ * ```
+ */
+export declare class InvalidDecimalNumberError extends Errors.BaseError {
+    readonly name = "Value.InvalidDecimalNumberError";
+    constructor({ value }: {
+        value: string;
+    });
+}
+//# sourceMappingURL=Value.d.ts.map

package/_types/Value.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Value.d.ts","sourceRoot":"","sources":["../Value.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC,4DAA4D;AAC5D,eAAO,MAAM,SAAS;;;;;;CAMZ,CAAA;AAEV;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,SAAI,UAgBjD;yBAhBe,MAAM;4BAuBM,OAAO,KAAc,MAAM,CAAC,SAAS;;AALjE,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAKD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,CACzB,GAAG,EAAE,MAAM,EACX,IAAI,GAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,QAAgB,UAGlD;yBALe,WAAW;4BAYM,OAAO,KAAc,WAAW,CAAC,SAAS;;AAL3E,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,KAAK,SAAS,GAAG,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CAC3D;AAKD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,KAAa,UAE1D;yBAFe,UAAU;4BASM,OAAO,KAAc,UAAU,CAAC,SAAS;;AALzE,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,KAAK,SAAS,GAAG,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CAC3D;AAKD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,SAAI,UAwC/C;yBAxCe,IAAI;4BA+CM,OAAO,KAAc,IAAI,CAAC,SAAS;;AAL7D,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAKD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,CACvB,KAAK,EAAE,MAAM,EACb,IAAI,GAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,QAAgB,UAGlD;yBALe,SAAS;4BAYM,OAAO,KAAc,SAAS,CAAC,SAAS;;AALvE,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,KAAK,SAAS,GAAG,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACzD;AAKD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,KAAa,UAEzD;yBAFe,QAAQ;4BASM,OAAO,KAAc,QAAQ,CAAC,SAAS;;AALrE,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,KAAK,SAAS,GAAG,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACzD;AAKD;;;;;;;;;;GAUG;AACH,qBAAa,yBAA0B,SAAQ,MAAM,CAAC,SAAS;IAC7D,SAAkB,IAAI,qCAAoC;gBAC9C,EAAE,KAAK,EAAE,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE;CAGzC"}

package/_types/WebAuthnP256.d.ts

@@ -0,0 +1,445 @@
+import * as Base64 from './Base64.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 P256 from './P256.js';
+import type * as PublicKey from './PublicKey.js';
+import type * as Signature from './Signature.js';
+import type { Compute, OneOf } from './internal/types.js';
+import * as internal from './internal/webauthn.js';
+/** A WebAuthn-flavored P256 credential. */
+export type P256Credential = {
+    id: string;
+    publicKey: PublicKey.PublicKey;
+    raw: internal.PublicKeyCredential;
+};
+/** Metadata for a WebAuthn P256 signature. */
+export type SignMetadata = Compute<{
+    authenticatorData: Hex.Hex;
+    challengeIndex: number;
+    clientDataJSON: string;
+    typeIndex: number;
+    userVerificationRequired: boolean;
+}>;
+export declare const createChallenge: Uint8Array;
+/**
+ * Creates a new WebAuthn P256 Credential, which can be stored and later used for signing.
+ *
+ * @example
+ * ```ts twoslash
+ * import { WebAuthnP256 } from 'ox'
+ *
+ * const credential = await WebAuthnP256.createCredential({ name: 'Example' }) // [!code focus]
+ * // @log: {
+ * // @log:   id: 'oZ48...',
+ * // @log:   publicKey: { x: 51421...5123n, y: 12345...6789n },
+ * // @log:   raw: PublicKeyCredential {},
+ * // @log: }
+ *
+ * const { metadata, signature } = await WebAuthnP256.sign({
+ *   credentialId: credential.id,
+ *   challenge: '0xdeadbeef',
+ * })
+ * ```
+ *
+ * @param options - Credential creation options.
+ * @returns A WebAuthn P256 credential.
+ */
+export declare function createCredential(options: createCredential.Options): Promise<P256Credential>;
+export declare namespace createCredential {
+    var parseError: (error: unknown) => createCredential.ErrorType;
+}
+export declare namespace createCredential {
+    type Options = getCredentialCreationOptions.Options & {
+        /**
+         * Credential creation function. Useful for environments that do not support
+         * the WebAuthn API natively (i.e. React Native or testing environments).
+         *
+         * @default window.navigator.credentials.create
+         */
+        createFn?: ((options?: internal.CredentialCreationOptions | undefined) => Promise<internal.Credential | null>) | undefined;
+    };
+    type ErrorType = getCredentialCreationOptions.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Gets the authenticator data which contains information about the
+ * processing of an authenticator request (ie. from `WebAuthnP256.sign`).
+ *
+ * :::warning
+ *
+ * This function is mainly for testing purposes or for manually constructing
+ * autenticator data. In most cases you will not need this function.
+ * `authenticatorData` is typically returned as part of the
+ * {@link ox#WebAuthnP256.(sign:function)} response (ie. an authenticator response).
+ *
+ * :::
+ *
+ * @example
+ * ```ts twoslash
+ * import { WebAuthnP256 } from 'ox'
+ *
+ * const authenticatorData = WebAuthnP256.getAuthenticatorData({
+ *   rpId: 'example.com',
+ *   signCount: 420,
+ * })
+ * // @log: "0xa379a6f6eeafb9a55e378c118034e2751e682fab9f2d30ab13d2125586ce194705000001a4"
+ * ```
+ *
+ * @param options - Options to construct the authenticator data.
+ * @returns The authenticator data.
+ */
+export declare function getAuthenticatorData(options?: getAuthenticatorData.Options): Hex.Hex;
+export declare namespace getAuthenticatorData {
+    var parseError: (error: unknown) => getAuthenticatorData.ErrorType;
+}
+export declare namespace getAuthenticatorData {
+    type Options = {
+        /** A bitfield that indicates various attributes that were asserted by the authenticator. [Read more](https://developer.mozilla.org/en-US/docs/Web/API/Web_Authentication_API/Authenticator_data#flags) */
+        flag?: number | undefined;
+        /** The [Relying Party ID](https://w3c.github.io/webauthn/#relying-party-identifier) that the credential is scoped to. */
+        rpId?: internal.PublicKeyCredentialRequestOptions['rpId'] | undefined;
+        /** A signature counter, if supported by the authenticator (set to 0 otherwise). */
+        signCount?: number | undefined;
+    };
+    type ErrorType = Errors.GlobalErrorType;
+}
+/**
+ * Constructs the Client Data in stringified JSON format which represents client data that
+ * was passed to `credentials.get()` in {@link ox#WebAuthnP256.(sign:function)}.
+ *
+ * :::warning
+ *
+ * This function is mainly for testing purposes or for manually constructing
+ * client data. In most cases you will not need this function.
+ * `clientDataJSON` is typically returned as part of the
+ * {@link ox#WebAuthnP256.(sign:function)} response (ie. an authenticator response).
+ *
+ * :::
+ *
+ * @example
+ * ```ts twoslash
+ * import { WebAuthnP256 } from 'ox'
+ *
+ * const clientDataJSON = WebAuthnP256.getClientDataJSON({
+ *   challenge: '0xdeadbeef',
+ *   origin: 'https://example.com',
+ * })
+ * // @log: "{"type":"webauthn.get","challenge":"3q2-7w","origin":"https://example.com","crossOrigin":false}"
+ * ```
+ *
+ * @param options - Options to construct the client data.
+ * @returns The client data.
+ */
+export declare function getClientDataJSON(options: getClientDataJSON.Options): string;
+export declare namespace getClientDataJSON {
+    var parseError: (error: unknown) => getClientDataJSON.ErrorType;
+}
+export declare namespace getClientDataJSON {
+    type Options = {
+        /** The challenge to sign. */
+        challenge: Hex.Hex;
+        /** If set to `true`, it means that the calling context is an `<iframe>` that is not same origin with its ancestor frames. */
+        crossOrigin?: boolean | undefined;
+        /** Additional client data to include in the client data JSON. */
+        extraClientData?: Record<string, unknown> | undefined;
+        /** The fully qualified origin of the relying party which has been given by the client/browser to the authenticator. */
+        origin?: string | undefined;
+    };
+    type ErrorType = Errors.GlobalErrorType;
+}
+/**
+ * Returns the creation options for a P256 WebAuthn Credential to be used with
+ * the Web Authentication API.
+ *
+ * @example
+ * ```ts twoslash
+ * import { WebAuthnP256 } from 'ox'
+ *
+ * const options = WebAuthnP256.getCredentialCreationOptions({ name: 'Example' })
+ *
+ * const credential = await window.navigator.credentials.create(options)
+ * ```
+ *
+ * @param options - Options.
+ * @returns The credential creation options.
+ */
+export declare function getCredentialCreationOptions(options: getCredentialCreationOptions.Options): internal.CredentialCreationOptions;
+export declare namespace getCredentialCreationOptions {
+    var parseError: (error: unknown) => getCredentialCreationOptions.ErrorType;
+}
+export declare namespace getCredentialCreationOptions {
+    type Options = {
+        /**
+         * A string specifying the relying party's preference for how the attestation statement
+         * (i.e., provision of verifiable evidence of the authenticity of the authenticator and its data)
+         * is conveyed during credential creation.
+         */
+        attestation?: internal.PublicKeyCredentialCreationOptions['attestation'] | undefined;
+        /**
+         * An object whose properties are criteria used to filter out the potential authenticators
+         * for the credential creation operation.
+         */
+        authenticatorSelection?: internal.PublicKeyCredentialCreationOptions['authenticatorSelection'] | undefined;
+        /**
+         * An `ArrayBuffer`, `TypedArray`, or `DataView` used as a cryptographic challenge.
+         */
+        challenge?: internal.PublicKeyCredentialCreationOptions['challenge'] | undefined;
+        /**
+         * List of credential IDs to exclude from the creation. This property can be used
+         * to prevent creation of a credential if it already exists.
+         */
+        excludeCredentialIds?: readonly string[] | undefined;
+        /**
+         * List of Web Authentication API credentials to use during creation or authentication.
+         */
+        extensions?: internal.PublicKeyCredentialCreationOptions['extensions'] | undefined;
+        /**
+         * An object describing the relying party that requested the credential creation
+         */
+        rp?: {
+            id: string;
+            name: string;
+        } | undefined;
+        /**
+         * A numerical hint, in milliseconds, which indicates the time the calling web app is willing to wait for the creation operation to complete.
+         */
+        timeout?: internal.PublicKeyCredentialCreationOptions['timeout'] | undefined;
+    } & OneOf<{
+        /** Name for the credential (user.name). */
+        name: string;
+    } | {
+        /**
+         * An object describing the user account for which the credential is generated.
+         */
+        user: {
+            displayName?: string;
+            id?: BufferSource;
+            name: string;
+        };
+    }>;
+    type ErrorType = Base64.toBytes.ErrorType | Hash.keccak256.ErrorType | Bytes.fromString.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Returns the request options to sign a challenge with the Web Authentication API.
+ *
+ * @example
+ * ```ts twoslash
+ * import { WebAuthnP256 } from 'ox'
+ *
+ * const options = WebAuthnP256.getCredentialRequestOptions({
+ *   challenge: '0xdeadbeef',
+ * })
+ *
+ * const credential = await window.navigator.credentials.get(options)
+ * ```
+ *
+ * @param options - Options.
+ * @returns The credential request options.
+ */
+export declare function getCredentialRequestOptions(options: getCredentialRequestOptions.Options): internal.CredentialRequestOptions;
+export declare namespace getCredentialRequestOptions {
+    var parseError: (error: unknown) => getCredentialRequestOptions.ErrorType;
+}
+export declare namespace getCredentialRequestOptions {
+    type Options = {
+        /** The credential ID to use. */
+        credentialId?: string | undefined;
+        /** The challenge to sign. */
+        challenge: Hex.Hex;
+        /** The relying party identifier to use. */
+        rpId?: internal.PublicKeyCredentialRequestOptions['rpId'] | undefined;
+        /** The user verification requirement. */
+        userVerification?: internal.PublicKeyCredentialRequestOptions['userVerification'] | undefined;
+    };
+    type ErrorType = Bytes.fromHex.ErrorType | Base64.toBytes.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Constructs the final digest that was signed and computed by the authenticator. This payload includes
+ * the cryptographic `challenge`, as well as authenticator metadata (`authenticatorData` + `clientDataJSON`).
+ * This value can be also used with raw P256 verification (such as {@link ox#P256.(verify:function)} or
+ * {@link ox#WebCryptoP256.(verify:function)}).
+ *
+ * :::warning
+ *
+ * This function is mainly for testing purposes or for manually constructing
+ * signing payloads. In most cases you will not need this function and
+ * instead use {@link ox#WebAuthnP256.(sign:function)}.
+ *
+ * :::
+ *
+ * @example
+ * ```ts twoslash
+ * import { WebAuthnP256, WebCryptoP256 } from 'ox'
+ *
+ * const { metadata, payload } = WebAuthnP256.getSignPayload({ // [!code focus]
+ *   challenge: '0xdeadbeef', // [!code focus]
+ * }) // [!code focus]
+ * // @log: {
+ * // @log:   metadata: {
+ * // @log:     authenticatorData: "0x49960de5880e8c687434170f6476605b8fe4aeb9a28632c7995cf3ba831d97630500000000",
+ * // @log:     challengeIndex: 23,
+ * // @log:     clientDataJSON: "{"type":"webauthn.get","challenge":"9jEFijuhEWrM4SOW-tChJbUEHEP44VcjcJ-Bqo1fTM8","origin":"http://localhost:5173","crossOrigin":false}",
+ * // @log:     typeIndex: 1,
+ * // @log:     userVerificationRequired: true,
+ * // @log:   },
+ * // @log:   payload: "0x49960de5880e8c687434170f6476605b8fe4aeb9a28632c7995cf3ba831d9763050000000045086dcb06a5f234db625bcdc94e657f86b76b6fd3eb9c30543eabc1e577a4b0",
+ * // @log: }
+ *
+ * const { publicKey, privateKey } = await WebCryptoP256.createKeyPair()
+ *
+ * const signature = await WebCryptoP256.sign({
+ *   payload,
+ *   privateKey,
+ * })
+ * ```
+ *
+ * @param options - Options to construct the signing payload.
+ * @returns The signing payload.
+ */
+export declare function getSignPayload(options: getSignPayload.Options): getSignPayload.ReturnType;
+export declare namespace getSignPayload {
+    var parseError: (error: unknown) => getSignPayload.ErrorType;
+}
+export declare namespace getSignPayload {
+    type Options = {
+        /** The challenge to sign. */
+        challenge: Hex.Hex;
+        /** If set to `true`, it means that the calling context is an `<iframe>` that is not same origin with its ancestor frames. */
+        crossOrigin?: boolean | undefined;
+        /** Additional client data to include in the client data JSON. */
+        extraClientData?: Record<string, unknown> | undefined;
+        /** If set to `true`, the payload will be hashed before being returned. */
+        hash?: boolean | undefined;
+        /** A bitfield that indicates various attributes that were asserted by the authenticator. [Read more](https://developer.mozilla.org/en-US/docs/Web/API/Web_Authentication_API/Authenticator_data#flags) */
+        flag?: number | undefined;
+        /** The fully qualified origin of the relying party which has been given by the client/browser to the authenticator. */
+        origin?: string | undefined;
+        /** The [Relying Party ID](https://w3c.github.io/webauthn/#relying-party-identifier) that the credential is scoped to. */
+        rpId?: internal.PublicKeyCredentialRequestOptions['rpId'] | undefined;
+        /** A signature counter, if supported by the authenticator (set to 0 otherwise). */
+        signCount?: number | undefined;
+        /** The user verification requirement that the authenticator will enforce. */
+        userVerification?: internal.PublicKeyCredentialRequestOptions['userVerification'] | undefined;
+    };
+    type ReturnType = {
+        metadata: SignMetadata;
+        payload: Hex.Hex;
+    };
+    type ErrorType = Hash.sha256.ErrorType | Hex.concat.ErrorType | Hex.fromString.ErrorType | getAuthenticatorData.ErrorType | getClientDataJSON.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Signs a challenge using a stored WebAuthn P256 Credential. If no Credential is provided,
+ * a prompt will be displayed for the user to select an existing Credential
+ * that was previously registered.
+ *
+ * @example
+ * ```ts twoslash
+ * import { WebAuthnP256 } from 'ox'
+ *
+ * const credential = await WebAuthnP256.createCredential({
+ *   name: 'Example',
+ * })
+ *
+ * const { metadata, signature } = await WebAuthnP256.sign({ // [!code focus]
+ *   credentialId: credential.id, // [!code focus]
+ *   challenge: '0xdeadbeef', // [!code focus]
+ * }) // [!code focus]
+ * // @log: {
+ * // @log:   metadata: {
+ * // @log:     authenticatorData: '0x49960de5880e8c687434170f6476605b8fe4aeb9a28632c7995cf3ba831d97630500000000',
+ * // @log:     clientDataJSON: '{"type":"webauthn.get","challenge":"9jEFijuhEWrM4SOW-tChJbUEHEP44VcjcJ-Bqo1fTM8","origin":"http://localhost:5173","crossOrigin":false}',
+ * // @log:     challengeIndex: 23,
+ * // @log:     typeIndex: 1,
+ * // @log:     userVerificationRequired: true,
+ * // @log:   },
+ * // @log:   signature: { r: 51231...4215n, s: 12345...6789n },
+ * // @log: }
+ * ```
+ *
+ * @param options - Options.
+ * @returns The signature.
+ */
+export declare function sign(options: sign.Options): Promise<sign.ReturnType>;
+export declare namespace sign {
+    var parseError: (error: unknown) => sign.ErrorType;
+}
+export declare namespace sign {
+    type Options = getCredentialRequestOptions.Options & {
+        /**
+         * Credential request function. Useful for environments that do not support
+         * the WebAuthn API natively (i.e. React Native or testing environments).
+         *
+         * @default window.navigator.credentials.get
+         */
+        getFn?: ((options?: internal.CredentialRequestOptions | undefined) => Promise<internal.Credential | null>) | undefined;
+    };
+    type ReturnType = {
+        metadata: SignMetadata;
+        raw: internal.PublicKeyCredential;
+        signature: Signature.Signature<false>;
+    };
+    type ErrorType = Hex.fromBytes.ErrorType | getCredentialRequestOptions.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Verifies a signature using the Credential's public key and the challenge which was signed.
+ *
+ * @example
+ * ```ts twoslash
+ * import { WebAuthnP256 } from 'ox'
+ *
+ * const credential = await WebAuthnP256.createCredential({
+ *   name: 'Example',
+ * })
+ *
+ * const { metadata, signature } = await WebAuthnP256.sign({
+ *   credentialId: credential.id,
+ *   challenge: '0xdeadbeef',
+ * })
+ *
+ * const result = await WebAuthnP256.verify({ // [!code focus]
+ *   metadata, // [!code focus]
+ *   challenge: '0xdeadbeef', // [!code focus]
+ *   publicKey: credential.publicKey, // [!code focus]
+ *   signature, // [!code focus]
+ * }) // [!code focus]
+ * // @log: true
+ * ```
+ *
+ * @param options - Options.
+ * @returns Whether the signature is valid.
+ */
+export declare function verify(options: verify.Options): boolean;
+export declare namespace verify {
+    var parseError: (error: unknown) => verify.ErrorType;
+}
+export declare namespace verify {
+    type Options = {
+        /** The challenge to verify. */
+        challenge: Hex.Hex;
+        /** If set to `true`, the payload will be hashed (sha256) before being verified. */
+        hash?: boolean | undefined;
+        /** The public key to verify the signature with. */
+        publicKey: PublicKey.PublicKey;
+        /** The signature to verify. */
+        signature: Signature.Signature<false>;
+        /** The metadata to verify the signature with. */
+        metadata: SignMetadata;
+    };
+    type ErrorType = Base64.toBytes.ErrorType | Bytes.concat.ErrorType | Bytes.fromHex.ErrorType | P256.verify.ErrorType | Errors.GlobalErrorType;
+}
+/** Thrown when a WebAuthn P256 credential creation fails. */
+export declare class CredentialCreationFailedError extends Errors.BaseError<Error> {
+    readonly name = "WebAuthnP256.CredentialCreationFailedError";
+    constructor({ cause }?: {
+        cause?: Error | undefined;
+    });
+}
+/** Thrown when a WebAuthn P256 credential request fails. */
+export declare class CredentialRequestFailedError extends Errors.BaseError<Error> {
+    readonly name = "WebAuthnP256.CredentialRequestFailedError";
+    constructor({ cause }?: {
+        cause?: Error | undefined;
+    });
+}
+//# sourceMappingURL=WebAuthnP256.d.ts.map

package/_types/WebAuthnP256.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebAuthnP256.d.ts","sourceRoot":"","sources":["../WebAuthnP256.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AACzD,OAAO,KAAK,QAAQ,MAAM,wBAAwB,CAAA;AAElD,2CAA2C;AAC3C,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,SAAS,CAAC,SAAS,CAAA;IAC9B,GAAG,EAAE,QAAQ,CAAC,mBAAmB,CAAA;CAClC,CAAA;AAED,8CAA8C;AAC9C,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC;IACjC,iBAAiB,EAAE,GAAG,CAAC,GAAG,CAAA;IAC1B,cAAc,EAAE,MAAM,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,EAAE,MAAM,CAAA;IACjB,wBAAwB,EAAE,OAAO,CAAA;CAClC,CAAC,CAAA;AAEF,eAAO,MAAM,eAAe,YAE1B,CAAA;AAEF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,gBAAgB,CACpC,OAAO,EAAE,gBAAgB,CAAC,OAAO,GAChC,OAAO,CAAC,cAAc,CAAC,CA0BzB;yBA5BqB,gBAAgB;4BAkDA,OAAO,KAElC,gBAAgB,CAAC,SAAS;;AAtBrC,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,KAAK,OAAO,GAAG,4BAA4B,CAAC,OAAO,GAAG;QACpD;;;;;WAKG;QACH,QAAQ,CAAC,EACL,CAAC,CACC,OAAO,CAAC,EAAE,QAAQ,CAAC,yBAAyB,GAAG,SAAS,KACrD,OAAO,CAAC,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,GACzC,SAAS,CAAA;KACd,CAAA;IAED,KAAK,SAAS,GACV,4BAA4B,CAAC,SAAS,GACtC,MAAM,CAAC,eAAe,CAAA;CAC3B;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,GAAE,oBAAoB,CAAC,OAAY,GACzC,GAAG,CAAC,GAAG,CAMT;yBARe,oBAAoB;4BAuBM,OAAO,KAEtC,oBAAoB,CAAC,SAAS;;AAfzC,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,KAAK,OAAO,GAAG;QACb,0MAA0M;QAC1M,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QACzB,yHAAyH;QACzH,IAAI,CAAC,EAAE,QAAQ,CAAC,iCAAiC,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;QACrE,mFAAmF;QACnF,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAC/B,CAAA;IAED,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,iBAAiB,CAAC,OAAO,GAAG,MAAM,CAe5E;yBAfe,iBAAiB;4BAgCM,OAAO,KAEnC,iBAAiB,CAAC,SAAS;;AAjBtC,MAAM,CAAC,OAAO,WAAW,iBAAiB,CAAC;IACzC,KAAK,OAAO,GAAG;QACb,6BAA6B;QAC7B,SAAS,EAAE,GAAG,CAAC,GAAG,CAAA;QAClB,6HAA6H;QAC7H,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACjC,iEAAiE;QACjE,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;QACrD,uHAAuH;QACvH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAC5B,CAAA;IAED,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAMD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,4BAA4B,CAC1C,OAAO,EAAE,4BAA4B,CAAC,OAAO,GAC5C,QAAQ,CAAC,yBAAyB,CA+CpC;yBAjDe,4BAA4B;4BA0HM,OAAO,KAE9C,4BAA4B,CAAC,SAAS;;AAzEjD,MAAM,CAAC,OAAO,WAAW,4BAA4B,CAAC;IACpD,KAAK,OAAO,GAAG;QACb;;;;WAIG;QACH,WAAW,CAAC,EACR,QAAQ,CAAC,kCAAkC,CAAC,aAAa,CAAC,GAC1D,SAAS,CAAA;QACb;;;WAGG;QACH,sBAAsB,CAAC,EACnB,QAAQ,CAAC,kCAAkC,CAAC,wBAAwB,CAAC,GACrE,SAAS,CAAA;QACb;;WAEG;QACH,SAAS,CAAC,EACN,QAAQ,CAAC,kCAAkC,CAAC,WAAW,CAAC,GACxD,SAAS,CAAA;QACb;;;WAGG;QACH,oBAAoB,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAA;QACpD;;WAEG;QACH,UAAU,CAAC,EACP,QAAQ,CAAC,kCAAkC,CAAC,YAAY,CAAC,GACzD,SAAS,CAAA;QACb;;WAEG;QACH,EAAE,CAAC,EACC;YACE,EAAE,EAAE,MAAM,CAAA;YACV,IAAI,EAAE,MAAM,CAAA;SACb,GACD,SAAS,CAAA;QACb;;WAEG;QACH,OAAO,CAAC,EAAE,QAAQ,CAAC,kCAAkC,CAAC,SAAS,CAAC,GAAG,SAAS,CAAA;KAC7E,GAAG,KAAK,CACL;QACE,2CAA2C;QAC3C,IAAI,EAAE,MAAM,CAAA;KACb,GACD;QACE;;WAEG;QACH,IAAI,EAAE;YACJ,WAAW,CAAC,EAAE,MAAM,CAAA;YACpB,EAAE,CAAC,EAAE,YAAY,CAAA;YACjB,IAAI,EAAE,MAAM,CAAA;SACb,CAAA;KACF,CACJ,CAAA;IAED,KAAK,SAAS,GACV,MAAM,CAAC,OAAO,CAAC,SAAS,GACxB,IAAI,CAAC,SAAS,CAAC,SAAS,GACxB,KAAK,CAAC,UAAU,CAAC,SAAS,GAC1B,MAAM,CAAC,eAAe,CAAA;CAC3B;AAMD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,2BAA2B,CACzC,OAAO,EAAE,2BAA2B,CAAC,OAAO,GAC3C,QAAQ,CAAC,wBAAwB,CAwBnC;yBA1Be,2BAA2B;4BAgDM,OAAO,KAC7C,2BAA2B,CAAC,SAAS;;AArBhD,MAAM,CAAC,OAAO,WAAW,2BAA2B,CAAC;IACnD,KAAK,OAAO,GAAG;QACb,gCAAgC;QAChC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QACjC,6BAA6B;QAC7B,SAAS,EAAE,GAAG,CAAC,GAAG,CAAA;QAClB,2CAA2C;QAC3C,IAAI,CAAC,EAAE,QAAQ,CAAC,iCAAiC,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;QACrE,yCAAyC;QACzC,gBAAgB,CAAC,EACb,QAAQ,CAAC,iCAAiC,CAAC,kBAAkB,CAAC,GAC9D,SAAS,CAAA;KACd,CAAA;IAED,KAAK,SAAS,GACV,KAAK,CAAC,OAAO,CAAC,SAAS,GACvB,MAAM,CAAC,OAAO,CAAC,SAAS,GACxB,MAAM,CAAC,eAAe,CAAA;CAC3B;AAKD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,wBAAgB,cAAc,CAC5B,OAAO,EAAE,cAAc,CAAC,OAAO,GAC9B,cAAc,CAAC,UAAU,CAuC3B;yBAzCe,cAAc;4BAiFM,OAAO,KAEhC,cAAc,CAAC,SAAS;;AAxCnC,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,KAAK,OAAO,GAAG;QACb,6BAA6B;QAC7B,SAAS,EAAE,GAAG,CAAC,GAAG,CAAA;QAClB,6HAA6H;QAC7H,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACjC,iEAAiE;QACjE,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;QACrD,0EAA0E;QAC1E,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAC1B,0MAA0M;QAC1M,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QACzB,uHAAuH;QACvH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAC3B,yHAAyH;QACzH,IAAI,CAAC,EAAE,QAAQ,CAAC,iCAAiC,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;QACrE,mFAAmF;QACnF,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAC9B,6EAA6E;QAC7E,gBAAgB,CAAC,EACb,QAAQ,CAAC,iCAAiC,CAAC,kBAAkB,CAAC,GAC9D,SAAS,CAAA;KACd,CAAA;IAED,KAAK,UAAU,GAAG;QAChB,QAAQ,EAAE,YAAY,CAAA;QACtB,OAAO,EAAE,GAAG,CAAC,GAAG,CAAA;KACjB,CAAA;IAED,KAAK,SAAS,GACV,IAAI,CAAC,MAAM,CAAC,SAAS,GACrB,GAAG,CAAC,MAAM,CAAC,SAAS,GACpB,GAAG,CAAC,UAAU,CAAC,SAAS,GACxB,oBAAoB,CAAC,SAAS,GAC9B,iBAAiB,CAAC,SAAS,GAC3B,MAAM,CAAC,eAAe,CAAA;CAC3B;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAsB,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CA0C1E;yBA1CqB,IAAI;4BAuEA,OAAO,KAEtB,IAAI,CAAC,SAAS;;AA7BzB,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,KAAK,OAAO,GAAG,2BAA2B,CAAC,OAAO,GAAG;QACnD;;;;;WAKG;QACH,KAAK,CAAC,EACF,CAAC,CACC,OAAO,CAAC,EAAE,QAAQ,CAAC,wBAAwB,GAAG,SAAS,KACpD,OAAO,CAAC,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,GACzC,SAAS,CAAA;KACd,CAAA;IAED,KAAK,UAAU,GAAG;QAChB,QAAQ,EAAE,YAAY,CAAA;QACtB,GAAG,EAAE,QAAQ,CAAC,mBAAmB,CAAA;QACjC,SAAS,EAAE,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;KACtC,CAAA;IAED,KAAK,SAAS,GACV,GAAG,CAAC,SAAS,CAAC,SAAS,GACvB,2BAA2B,CAAC,SAAS,GACrC,MAAM,CAAC,eAAe,CAAA;CAC3B;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,GAAG,OAAO,CAwDvD;yBAxDe,MAAM;4BAgFM,OAAO,KAExB,MAAM,CAAC,SAAS;;AAxB3B,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,KAAK,OAAO,GAAG;QACb,+BAA+B;QAC/B,SAAS,EAAE,GAAG,CAAC,GAAG,CAAA;QAClB,mFAAmF;QACnF,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAC1B,mDAAmD;QACnD,SAAS,EAAE,SAAS,CAAC,SAAS,CAAA;QAC9B,+BAA+B;QAC/B,SAAS,EAAE,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;QACrC,iDAAiD;QACjD,QAAQ,EAAE,YAAY,CAAA;KACvB,CAAA;IAED,KAAK,SAAS,GACV,MAAM,CAAC,OAAO,CAAC,SAAS,GACxB,KAAK,CAAC,MAAM,CAAC,SAAS,GACtB,KAAK,CAAC,OAAO,CAAC,SAAS,GACvB,IAAI,CAAC,MAAM,CAAC,SAAS,GACrB,MAAM,CAAC,eAAe,CAAA;CAC3B;AAMD,6DAA6D;AAC7D,qBAAa,6BAA8B,SAAQ,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC;IACxE,SAAkB,IAAI,gDAA+C;gBAEzD,EAAE,KAAK,EAAE,GAAE;QAAE,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;KAAO;CAK1D;AAED,4DAA4D;AAC5D,qBAAa,4BAA6B,SAAQ,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC;IACvE,SAAkB,IAAI,+CAA8C;gBAExD,EAAE,KAAK,EAAE,GAAE;QAAE,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;KAAO;CAK1D"}