ox/dist/core/PublicKey.d.ts

Ethereum Standard Library

import * as Bytes from './Bytes.js';
import * as Errors from './Errors.js';
import * as Hex from './Hex.js';
import type { Compute, ExactPartial } from './internal/types.js';
/** Root type for an ECDSA Public Key. */
export type PublicKey<compressed extends boolean = false, numberType = number> = Compute<compressed extends true ? {
    prefix: numberType;
    x: Hex.Hex;
    y?: undefined;
} : {
    prefix: numberType;
    x: Hex.Hex;
    y: Hex.Hex;
}>;
/**
 * Asserts that a {@link ox#PublicKey.PublicKey} is valid.
 *
 * @example
 * ```ts twoslash
 * import { PublicKey } from 'ox'
 *
 * PublicKey.assert({
 *   prefix: 4,
 *   y: '0x6e1c1f59ee1cf25b75a8d57b3c89e7e6b3b1da823df8b3b89497f30c1f000000'
 * })
 * // @error: PublicKey.InvalidError: Value \`{"y":"0x..."}\` is not a valid public key.
 * // @error: Public key must contain:
 * // @error: - an `x` and `prefix` value (compressed)
 * // @error: - an `x`, `y`, and `prefix` value (uncompressed)
 * ```
 *
 * @param publicKey - The public key object to assert.
 */
export declare function assert(publicKey: ExactPartial<PublicKey>, options?: assert.Options): asserts publicKey is PublicKey;
export declare namespace assert {
    type Options = {
        /** Whether or not the public key should be compressed. */
        compressed?: boolean;
    };
    type ErrorType = InvalidError | InvalidPrefixError | Errors.GlobalErrorType;
}
/**
 * Compresses a {@link ox#PublicKey.PublicKey}.
 *
 * @example
 * ```ts twoslash
 * import { PublicKey } from 'ox'
 *
 * const publicKey = PublicKey.from({
 *   prefix: 4,
 *   x: '0x83185...',
 *   y: '0x35477...'
 * })
 *
 * const compressed = PublicKey.compress(publicKey) // [!code focus]
 * // @log: {
 * // @log:   prefix: 3,
 * // @log:   x: '0x83185...',
 * // @log: }
 * ```
 *
 * @param publicKey - The public key to compress.
 * @returns The compressed public key.
 */
export declare function compress(publicKey: PublicKey<false>): PublicKey<true>;
export declare namespace compress {
    type ErrorType = Errors.GlobalErrorType;
}
/**
 * Instantiates a typed {@link ox#PublicKey.PublicKey} object from a
 * {@link ox#PublicKey.PublicKey}, {@link ox#Bytes.Bytes}, or {@link ox#Hex.Hex}.
 *
 * @example
 * ```ts twoslash
 * import { PublicKey } from 'ox'
 *
 * const publicKey = PublicKey.from({
 *   prefix: 4,
 *   x: '0x8318535b54105d4a7aae60c08fc45f9687181b4fdfc625bd1a753fa7397fed75',
 *   y: '0x3547f11ca8696646f2f3acb08e31016afac23e630c5d11f59f61fef57b0d2aa5'
 * })
 * // @log: {
 * // @log:   prefix: 4,
 * // @log:   x: '0x8318535b54105d4a7aae60c08fc45f9687181b4fdfc625bd1a753fa7397fed75',
 * // @log:   y: '0x3547f11ca8696646f2f3acb08e31016afac23e630c5d11f59f61fef57b0d2aa5',
 * // @log: }
 * ```
 *
 * @example
 * ### From Serialized
 *
 * ```ts twoslash
 * import { PublicKey } from 'ox'
 *
 * const publicKey = PublicKey.from(
 *   '0x048318535b54105d4a7aae60c08fc45f9687181b4fdfc625bd1a753fa7397fed753547f11ca8696646f2f3acb08e31016afac23e630c5d11f59f61fef57b0d2aa5'
 * )
 * // @log: {
 * // @log:   prefix: 4,
 * // @log:   x: '0x8318535b54105d4a7aae60c08fc45f9687181b4fdfc625bd1a753fa7397fed75',
 * // @log:   y: '0x3547f11ca8696646f2f3acb08e31016afac23e630c5d11f59f61fef57b0d2aa5',
 * // @log: }
 * ```
 *
 * @param value - The public key value to instantiate.
 * @returns The instantiated {@link ox#PublicKey.PublicKey}.
 */
export declare function from<const publicKey extends CompressedPublicKey | UncompressedPublicKey | Hex.Hex | Bytes.Bytes>(value: from.Value<publicKey>): from.ReturnType<publicKey>;
/** @internal */
type CompressedPublicKey = PublicKey<true>;
/** @internal */
type UncompressedPublicKey = Omit<PublicKey<false>, 'prefix'> & {
    prefix?: PublicKey['prefix'] | undefined;
};
export declare namespace from {
    type Value<publicKey extends CompressedPublicKey | UncompressedPublicKey | Hex.Hex | Bytes.Bytes = PublicKey> = publicKey | CompressedPublicKey | UncompressedPublicKey;
    type ReturnType<publicKey extends CompressedPublicKey | UncompressedPublicKey | Hex.Hex | Bytes.Bytes = PublicKey> = publicKey extends CompressedPublicKey | UncompressedPublicKey ? publicKey extends UncompressedPublicKey ? Compute<publicKey & {
        readonly prefix: 0x04;
    }> : publicKey : PublicKey;
    type ErrorType = assert.ErrorType | Errors.GlobalErrorType;
}
/**
 * Deserializes a {@link ox#PublicKey.PublicKey} from a {@link ox#Bytes.Bytes}
 * value.
 *
 * @example
 * ```ts twoslash
 * // @noErrors
 * import { PublicKey } from 'ox'
 *
 * const publicKey = PublicKey.fromBytes(new Uint8Array([128, 3, 131, ...]))
 * // @log: {
 * // @log:   prefix: 4,
 * // @log:   x: '0x8318535b54105d4a7aae60c08fc45f9687181b4fdfc625bd1a753fa7397fed75',
 * // @log:   y: '0x3547f11ca8696646f2f3acb08e31016afac23e630c5d11f59f61fef57b0d2aa5',
 * // @log: }
 * ```
 *
 * @param publicKey - The serialized public key.
 * @returns The deserialized public key.
 */
export declare function fromBytes(publicKey: Bytes.Bytes): PublicKey;
export declare namespace fromBytes {
    type ErrorType = fromHex.ErrorType | Hex.fromBytes.ErrorType | Errors.GlobalErrorType;
}
/**
 * Deserializes a {@link ox#PublicKey.PublicKey} from a {@link ox#Hex.Hex} value.
 *
 * @example
 * ```ts twoslash
 * import { PublicKey } from 'ox'
 *
 * const publicKey = PublicKey.fromHex(
 *   '0x8318535b54105d4a7aae60c08fc45f9687181b4fdfc625bd1a753fa7397fed753547f11ca8696646f2f3acb08e31016afac23e630c5d11f59f61fef57b0d2aa5'
 * )
 * // @log: {
 * // @log:   prefix: 4,
 * // @log:   x: '0x8318535b54105d4a7aae60c08fc45f9687181b4fdfc625bd1a753fa7397fed75',
 * // @log:   y: '0x3547f11ca8696646f2f3acb08e31016afac23e630c5d11f59f61fef57b0d2aa5',
 * // @log: }
 * ```
 *
 * @example
 * ### Deserializing a Compressed Public Key
 *
 * ```ts twoslash
 * import { PublicKey } from 'ox'
 *
 * const publicKey = PublicKey.fromHex(
 *   '0x038318535b54105d4a7aae60c08fc45f9687181b4fdfc625bd1a753fa7397fed75'
 * )
 * // @log: {
 * // @log:   prefix: 3,
 * // @log:   x: '0x8318535b54105d4a7aae60c08fc45f9687181b4fdfc625bd1a753fa7397fed75',
 * // @log: }
 * ```
 *
 * @param publicKey - The serialized public key.
 * @returns The deserialized public key.
 */
export declare function fromHex(publicKey: Hex.Hex): PublicKey;
export declare namespace fromHex {
    type ErrorType = assert.ErrorType | Hex.slice.ErrorType | InvalidSerializedSizeError | Errors.GlobalErrorType;
}
/**
 * Serializes a {@link ox#PublicKey.PublicKey} to {@link ox#Bytes.Bytes}.
 *
 * @example
 * ```ts twoslash
 * import { PublicKey } from 'ox'
 *
 * const publicKey = PublicKey.from({
 *   prefix: 4,
 *   x: '0x8318535b54105d4a7aae60c08fc45f9687181b4fdfc625bd1a753fa7397fed75',
 *   y: '0x3547f11ca8696646f2f3acb08e31016afac23e630c5d11f59f61fef57b0d2aa5'
 * })
 *
 * const bytes = PublicKey.toBytes(publicKey) // [!code focus]
 * // @log: Uint8Array [128, 3, 131, ...]
 * ```
 *
 * @param publicKey - The public key to serialize.
 * @returns The serialized public key.
 */
export declare function toBytes(publicKey: PublicKey<boolean>, options?: toBytes.Options): Bytes.Bytes;
export declare namespace toBytes {
    type Options = {
        /**
         * Whether to include the prefix in the serialized public key.
         *
         * @default true
         */
        includePrefix?: boolean | undefined;
    };
    type ErrorType = Hex.fromNumber.ErrorType | Bytes.fromHex.ErrorType | Errors.GlobalErrorType;
}
/**
 * Serializes a {@link ox#PublicKey.PublicKey} to {@link ox#Hex.Hex}.
 *
 * @example
 * ```ts twoslash
 * import { PublicKey } from 'ox'
 *
 * const publicKey = PublicKey.from({
 *   prefix: 4,
 *   x: '0x8318535b54105d4a7aae60c08fc45f9687181b4fdfc625bd1a753fa7397fed75',
 *   y: '0x3547f11ca8696646f2f3acb08e31016afac23e630c5d11f59f61fef57b0d2aa5'
 * })
 *
 * const hex = PublicKey.toHex(publicKey) // [!code focus]
 * // @log: '0x048318535b54105d4a7aae60c08fc45f9687181b4fdfc625bd1a753fa7397fed753547f11ca8696646f2f3acb08e31016afac23e630c5d11f59f61fef57b0d2aa5'
 * ```
 *
 * @param publicKey - The public key to serialize.
 * @returns The serialized public key.
 */
export declare function toHex(publicKey: PublicKey<boolean>, options?: toHex.Options): Hex.Hex;
export declare namespace toHex {
    type Options = {
        /**
         * Whether to include the prefix in the serialized public key.
         *
         * @default true
         */
        includePrefix?: boolean | undefined;
    };
    type ErrorType = Hex.fromNumber.ErrorType | Errors.GlobalErrorType;
}
/**
 * Validates a {@link ox#PublicKey.PublicKey}. Returns `true` if valid, `false`
 * otherwise.
 *
 * @example
 * ```ts twoslash
 * import { PublicKey } from 'ox'
 *
 * const valid = PublicKey.validate({
 *   prefix: 4,
 *   y: '0x6e1c1f59ee1cf25b75a8d57b3c89e7e6b3b1da823df8b3b89497f30c1f000000'
 * })
 * // @log: false
 * ```
 *
 * @param publicKey - The public key object to assert.
 */
export declare function validate(publicKey: ExactPartial<PublicKey>, options?: validate.Options): boolean;
export declare namespace validate {
    type Options = {
        /** Whether or not the public key should be compressed. */
        compressed?: boolean;
    };
    type ErrorType = Errors.GlobalErrorType;
}
/**
 * Thrown when a public key is invalid.
 *
 * @example
 * ```ts twoslash
 * import { PublicKey } from 'ox'
 *
 * PublicKey.assert({ y: '0x01' })
 * // @error: PublicKey.InvalidError: Value `{"y":"0x01"}` is not a valid public key.
 * // @error: Public key must contain:
 * // @error: - an `x` and `prefix` value (compressed)
 * // @error: - an `x`, `y`, and `prefix` value (uncompressed)
 * ```
 */
export declare class InvalidError extends Errors.BaseError {
    readonly name = "PublicKey.InvalidError";
    constructor({ publicKey }: {
        publicKey: unknown;
    });
}
/** Thrown when a public key has an invalid prefix. */
export declare class InvalidPrefixError<cause extends InvalidCompressedPrefixError | InvalidUncompressedPrefixError = InvalidCompressedPrefixError | InvalidUncompressedPrefixError> extends Errors.BaseError<cause> {
    readonly name = "PublicKey.InvalidPrefixError";
    constructor({ prefix, cause }: {
        prefix: number | undefined;
        cause: cause;
    });
}
/** Thrown when the public key has an invalid prefix for a compressed public key. */
export declare class InvalidCompressedPrefixError extends Errors.BaseError {
    readonly name = "PublicKey.InvalidCompressedPrefixError";
    constructor();
}
/**
 * Thrown when the public key has an invalid prefix for an uncompressed public
 * key.
 */
export declare class InvalidUncompressedPrefixError extends Errors.BaseError {
    readonly name = "PublicKey.InvalidUncompressedPrefixError";
    constructor();
}
/** Thrown when the public key has an invalid serialized size. */
export declare class InvalidSerializedSizeError extends Errors.BaseError {
    readonly name = "PublicKey.InvalidSerializedSizeError";
    constructor({ publicKey }: {
        publicKey: Hex.Hex | Bytes.Bytes;
    });
}
export {};
//# sourceMappingURL=PublicKey.d.ts.map