ox 0.0.1 → 0.1.0

package/_types/Secp256k1.d.ts

@@ -0,0 +1,277 @@
+import * as Address from './Address.js';
+import * as Bytes from './Bytes.js';
+import type * as Errors from './Errors.js';
+import * as Hex from './Hex.js';
+import * as PublicKey from './PublicKey.js';
+import type * as Signature from './Signature.js';
+import type { OneOf } from './internal/types.js';
+/** Re-export of noble/curves secp256k1 utilities. */
+export declare const noble: Readonly<{
+    create: (hash: import("@noble/curves/abstract/utils.js").CHash) => import(
+    /**
+     * 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.
+     */
+    "@noble/curves/abstract/weierstrass.js").CurveFn;
+    CURVE: ReturnType<(curve: import("@noble/curves/abstract/weierstrass.js").CurveType) => Readonly<{
+        readonly nBitLength: number;
+        readonly nByteLength: number;
+        readonly Fp: import("@noble/curves/abstract/modular.js").IField<bigint>;
+        readonly n: bigint;
+        readonly h: bigint;
+        readonly hEff?: bigint;
+        readonly Gx: bigint;
+        readonly Gy: bigint;
+        readonly allowInfinityPoint?: boolean;
+        readonly a: bigint;
+        readonly b: bigint;
+        readonly allowedPrivateKeyLengths?: readonly number[];
+        readonly wrapPrivateKey?: boolean;
+        readonly endo?: {
+            beta: bigint;
+            splitScalar: (k: bigint) => {
+                k1neg: boolean;
+                k1: bigint;
+                k2neg: boolean;
+                k2: bigint;
+            };
+        };
+        readonly isTorsionFree?: ((c: import("@noble/curves/abstract/weierstrass.js").ProjConstructor<bigint>, point: import("@noble/curves/abstract/weierstrass.js").ProjPointType<bigint>) => boolean) | undefined;
+        readonly clearCofactor?: ((c: import("@noble/curves/abstract/weierstrass.js").ProjConstructor<bigint>, point: import("@noble/curves/abstract/weierstrass.js").ProjPointType<bigint>) => import("@noble/curves/abstract/weierstrass.js").ProjPointType<bigint>) | undefined;
+        readonly hash: import("@noble/curves/abstract/utils.js").CHash;
+        readonly hmac: (key: Uint8Array, ...messages: Uint8Array[]) => Uint8Array;
+        readonly randomBytes: (bytesLength?: number) => Uint8Array;
+        lowS: boolean;
+        readonly bits2int?: (bytes: Uint8Array) => bigint;
+        readonly bits2int_modN?: (bytes: Uint8Array) => bigint;
+        readonly p: bigint;
+    }>>;
+    getPublicKey: (privateKey: import("@noble/curves/abstract/utils.js").PrivKey, isCompressed?: boolean) => Uint8Array;
+    getSharedSecret: (privateA: import("@noble/curves/abstract/utils.js").PrivKey, publicB: import("@noble/curves/abstract/utils.js").Hex, isCompressed?: boolean) => Uint8Array;
+    sign: (msgHash: import("@noble/curves/abstract/utils.js").Hex, privKey: import("@noble/curves/abstract/utils.js").PrivKey, opts?: import("@noble/curves/abstract/weierstrass.js").SignOpts) => import("@noble/curves/abstract/weierstrass.js").RecoveredSignatureType;
+    verify: (signature: import("@noble/curves/abstract/utils.js").Hex | {
+        r: bigint;
+        s: bigint;
+    }, msgHash: import("@noble/curves/abstract/utils.js").Hex, publicKey: import("@noble/curves/abstract/utils.js").Hex, opts?: import("@noble/curves/abstract/weierstrass.js").VerOpts) => boolean;
+    ProjectivePoint: import("@noble/curves/abstract/weierstrass.js").ProjConstructor<bigint>;
+    Signature: import("@noble/curves/abstract/weierstrass.js").SignatureConstructor;
+    utils: {
+        normPrivateKeyToScalar: (key: import("@noble/curves/abstract/utils.js").PrivKey) => bigint;
+        isValidPrivateKey(privateKey: import("@noble/curves/abstract/utils.js").PrivKey): boolean;
+        randomPrivateKey: () => Uint8Array;
+        precompute: (windowSize?: number, point?: import("@noble/curves/abstract/weierstrass.js").ProjPointType<bigint>) => import("@noble/curves/abstract/weierstrass.js").ProjPointType<bigint>;
+    };
+}>;
+/**
+ * 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): PublicKey.PublicKey;
+export declare namespace getPublicKey {
+    type Options = {
+        /**
+         * Private key to compute the public key from.
+         */
+        privateKey: Hex.Hex | Bytes.Bytes;
+    };
+    type ErrorType = Hex.from.ErrorType | PublicKey.from.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<as extends 'Hex' | 'Bytes' = 'Hex'>(options?: randomPrivateKey.Options<as>): randomPrivateKey.ReturnType<as>;
+export declare namespace randomPrivateKey {
+    type Options<as extends 'Hex' | 'Bytes' = 'Hex'> = {
+        /**
+         * Format of the returned private key.
+         * @default 'Hex'
+         */
+        as?: as | 'Hex' | 'Bytes' | undefined;
+    };
+    type ReturnType<as extends 'Hex' | 'Bytes'> = (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 {
+    var parseError: (error: unknown) => recoverAddress.ErrorType;
+}
+export declare namespace recoverAddress {
+    type Options = {
+        /** Payload that was signed. */
+        payload: Hex.Hex | Bytes.Bytes;
+        /** Signature of the payload. */
+        signature: 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): PublicKey.PublicKey;
+export declare namespace recoverPublicKey {
+    var parseError: (error: unknown) => recoverPublicKey.ErrorType;
+}
+export declare namespace recoverPublicKey {
+    type Options = {
+        /** Payload that was signed. */
+        payload: Hex.Hex | Bytes.Bytes;
+        /** Signature of the payload. */
+        signature: Signature.Signature;
+    };
+    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): Signature.Signature;
+export declare namespace sign {
+    var parseError: (error: unknown) => sign.ErrorType;
+}
+export declare namespace sign {
+    type Options = {
+        /** 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 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 {
+    var parseError: (error: unknown) => verify.ErrorType;
+}
+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. */
+        signature: Signature.Signature;
+    } | {
+        /** Public key that signed the payload. */
+        publicKey: PublicKey.PublicKey<boolean>;
+        /** Signature of the payload. */
+        signature: Signature.Signature<false>;
+    }>;
+    type ErrorType = Errors.GlobalErrorType;
+}
+//# sourceMappingURL=Secp256k1.d.ts.map

package/_types/Secp256k1.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Secp256k1.d.ts","sourceRoot":"","sources":["../Secp256k1.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,KAAK,MAAM,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAC3C,OAAO,KAAK,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAEhD,qDAAqD;AACrD,eAAO,MAAM,KAAK;0BAD0B,iCACjC;IAEX;;;;;;;;;;;;OAYG;IACH,uCAZqB;qCAAgD,uCAG5D;;;4BAMJ,mCAAuB;;;qBAGL,CAAC;;;mCAIlB,CAAC;;;yCAGW,CAAC;+BAGmB,CAAA;qBAGjC,CAAD;;;;;;;;;8BAYoC,CAAA,cAAc,uCAGpD;8BAIE,CAAC,cAEK,uCAA0B;8BAGc,iCACjD;yCACG,GAAI;0CAEW,CAAC;;yBACsB,CAAC;8BAIrB,CAAC;;;8FAGe,CAAC;uJAM3B,CAAC;mIACyB,CAAC,SACnC,uCAAsB,sBAEtB,uCAA2B;;;;6HAOxB,CAAC,SACP,uCAAyB;4BAEc,uCAA2B;sBAEtC,uCAA2B;;;;;+BAS5B,CAAC,eACjB,CAAC;;EAhGiB,CAAA;AAE9B;;;;;;;;;;;;GAYG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,YAAY,CAAC,OAAO,GAC5B,SAAS,CAAC,SAAS,CAMrB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,KAAK,OAAO,GAAG;QACb;;WAEG;QACH,UAAU,EAAE,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,CAAA;KAClC,CAAA;IAED,KAAK,SAAS,GACV,GAAG,CAAC,IAAI,CAAC,SAAS,GAClB,SAAS,CAAC,IAAI,CAAC,SAAS,GACxB,MAAM,CAAC,eAAe,CAAA;CAC3B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,EAAE,SAAS,KAAK,GAAG,OAAO,GAAG,KAAK,EACjE,OAAO,GAAE,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAM,GACzC,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC,CAKjC;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,KAAK,OAAO,CAAC,EAAE,SAAS,KAAK,GAAG,OAAO,GAAG,KAAK,IAAI;QACjD;;;WAGG;QACH,EAAE,CAAC,EAAE,EAAE,GAAG,KAAK,GAAG,OAAO,GAAG,SAAS,CAAA;KACtC,CAAA;IAED,KAAK,UAAU,CAAC,EAAE,SAAS,KAAK,GAAG,OAAO,IACtC,CAAC,EAAE,SAAS,OAAO,GAAG,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,GAC1C,CAAC,EAAE,SAAS,KAAK,GAAG,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,CAAA;IAExC,KAAK,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CAClE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,cAAc,CAC5B,OAAO,EAAE,cAAc,CAAC,OAAO,GAC9B,cAAc,CAAC,UAAU,CAE3B;yBAJe,cAAc;4BAsBM,OAAO,KAEhC,cAAc,CAAC,SAAS;;AAlBnC,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,KAAK,OAAO,GAAG;QACb,+BAA+B;QAC/B,OAAO,EAAE,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,CAAA;QAC9B,gCAAgC;QAChC,SAAS,EAAE,SAAS,CAAC,SAAS,CAAA;KAC/B,CAAA;IAED,KAAK,UAAU,GAAG,OAAO,CAAC,OAAO,CAAA;IAEjC,KAAK,SAAS,GACV,OAAO,CAAC,aAAa,CAAC,SAAS,GAC/B,gBAAgB,CAAC,SAAS,GAC1B,MAAM,CAAC,eAAe,CAAA;CAC3B;AAMD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,gBAAgB,CAAC,OAAO,GAChC,SAAS,CAAC,SAAS,CASrB;yBAXe,gBAAgB;4BA2BM,OAAO,KAElC,gBAAgB,CAAC,SAAS;;AAhBrC,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,KAAK,OAAO,GAAG;QACb,+BAA+B;QAC/B,OAAO,EAAE,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,CAAA;QAC9B,gCAAgC;QAChC,SAAS,EAAE,SAAS,CAAC,SAAS,CAAA;KAC/B,CAAA;IAED,KAAK,SAAS,GACV,SAAS,CAAC,IAAI,CAAC,SAAS,GACxB,GAAG,CAAC,IAAI,CAAC,SAAS,GAClB,MAAM,CAAC,eAAe,CAAA;CAC3B;AAMD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,SAAS,CAY/D;yBAZe,IAAI;4BA2BM,OAAO,KAEtB,IAAI,CAAC,SAAS;;AAfzB,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,KAAK,OAAO,GAAG;QACb,iFAAiF;QACjF,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAC1B,uBAAuB;QACvB,OAAO,EAAE,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,CAAA;QAC9B,yBAAyB;QACzB,UAAU,EAAE,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,CAAA;KAClC,CAAA;IAED,KAAK,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CAC/D;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,GAAG,OAAO,CAUvD;yBAVe,MAAM;4BAoCM,OAAO,KAExB,MAAM,CAAC,SAAS;;AA1B3B,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,KAAK,OAAO,GAAG;QACb,mFAAmF;QACnF,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAC1B,+BAA+B;QAC/B,OAAO,EAAE,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,CAAA;KAC/B,GAAG,KAAK,CACL;QACE,uCAAuC;QACvC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAA;QACxB,gCAAgC;QAChC,SAAS,EAAE,SAAS,CAAC,SAAS,CAAA;KAC/B,GACD;QACE,0CAA0C;QAC1C,SAAS,EAAE,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;QACvC,gCAAgC;QAChC,SAAS,EAAE,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;KACtC,CACJ,CAAA;IAED,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC"}