ox 0.0.1 → 0.1.0

package/_types/WebCryptoP256.d.ts

@@ -0,0 +1,119 @@
+import * as Bytes from './Bytes.js';
+import type * as Errors from './Errors.js';
+import type * as Hex from './Hex.js';
+import * as PublicKey from './PublicKey.js';
+import type * as Signature from './Signature.js';
+import type { Compute } from './internal/types.js';
+/**
+ * Generates an ECDSA P256 key pair that includes:
+ *
+ * - a `privateKey` of type [`CryptoKey`](https://developer.mozilla.org/en-US/docs/Web/API/CryptoKey)
+ *
+ * - a `publicKey` of type {@link ox#Hex.Hex} or {@link ox#Bytes.Bytes}
+ *
+ * @example
+ * ```ts twoslash
+ * import { WebCryptoP256 } from 'ox'
+ *
+ * const { publicKey, privateKey } = await WebCryptoP256.createKeyPair()
+ * // @log: {
+ * // @log:   privateKey: CryptoKey {},
+ * // @log:   publicKey: {
+ * // @log:     x: 59295962801117472859457908919941473389380284132224861839820747729565200149877n,
+ * // @log:     y: 24099691209996290925259367678540227198235484593389470330605641003500238088869n,
+ * // @log:     prefix: 4,
+ * // @log:   },
+ * // @log: }
+ * ```
+ *
+ * @param options - Options for creating the key pair.
+ * @returns The key pair.
+ */
+export declare function createKeyPair(options?: createKeyPair.Options): Promise<createKeyPair.ReturnType>;
+export declare namespace createKeyPair {
+    var parseError: (error: unknown) => createKeyPair.ErrorType;
+}
+export declare namespace createKeyPair {
+    type Options = {
+        /** A boolean value indicating whether it will be possible to export the private key using `globalThis.crypto.subtle.exportKey()`. */
+        extractable?: boolean | undefined;
+    };
+    type ReturnType = Compute<{
+        privateKey: CryptoKey;
+        publicKey: PublicKey.PublicKey;
+    }>;
+    type ErrorType = PublicKey.from.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Signs a payload with the provided `CryptoKey` private key and returns a P256 signature.
+ *
+ * @example
+ * ```ts twoslash
+ * import { WebCryptoP256 } from 'ox'
+ *
+ * const { privateKey } = await WebCryptoP256.createKeyPair()
+ *
+ * const signature = await WebCryptoP256.sign({ // [!code focus]
+ *   payload: '0xdeadbeef', // [!code focus]
+ *   privateKey, // [!code focus]
+ * }) // [!code focus]
+ * // @log: {
+ * // @log:   r: 151231...4423n,
+ * // @log:   s: 516123...5512n,
+ * // @log: }
+ * ```
+ *
+ * @param options - Options for signing the payload.
+ * @returns The P256 ECDSA {@link ox#Signature.Signature}.
+ */
+export declare function sign(options: sign.Options): Promise<Signature.Signature<false>>;
+export declare namespace sign {
+    var parseError: (error: unknown) => sign.ErrorType;
+}
+export declare namespace sign {
+    type Options = {
+        /** Payload to sign. */
+        payload: Hex.Hex | Bytes.Bytes;
+        /** ECDSA private key. */
+        privateKey: CryptoKey;
+    };
+    type ErrorType = Bytes.fromArray.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Verifies a payload was signed by the provided public key.
+ *
+ * @example
+ *
+ * ```ts twoslash
+ * import { WebCryptoP256 } from 'ox'
+ *
+ * const { privateKey, publicKey } = await WebCryptoP256.createKeyPair()
+ * const signature = await WebCryptoP256.sign({ payload: '0xdeadbeef', privateKey })
+ *
+ * const verified = await WebCryptoP256.verify({ // [!code focus]
+ *   payload: '0xdeadbeef', // [!code focus]
+ *   publicKey, // [!code focus]
+ *   signature, // [!code focus]
+ * }) // [!code focus]
+ * // @log: true
+ * ```
+ *
+ * @param options - The verification options.
+ * @returns Whether the payload was signed by the provided public key.
+ */
+export declare function verify(options: verify.Options): Promise<boolean>;
+export declare namespace verify {
+    var parseError: (error: unknown) => verify.ErrorType;
+}
+export declare namespace verify {
+    type Options = {
+        /** Public key that signed the payload. */
+        publicKey: PublicKey.PublicKey<boolean>;
+        /** Signature of the payload. */
+        signature: Signature.Signature<false>;
+        /** Payload that was signed. */
+        payload: Hex.Hex | Bytes.Bytes;
+    };
+    type ErrorType = Errors.GlobalErrorType;
+}
+//# sourceMappingURL=WebCryptoP256.d.ts.map

package/_types/WebCryptoP256.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebCryptoP256.d.ts","sourceRoot":"","sources":["../WebCryptoP256.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,KAAK,MAAM,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,KAAK,GAAG,MAAM,UAAU,CAAA;AACpC,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAC3C,OAAO,KAAK,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAElD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,aAAa,CACjC,OAAO,GAAE,aAAa,CAAC,OAAY,GAClC,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAmBnC;yBArBqB,aAAa;4BAqCA,OAAO,KAE/B,aAAa,CAAC,SAAS;;AAhBlC,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,KAAK,OAAO,GAAG;QACb,qIAAqI;QACrI,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAClC,CAAA;IAED,KAAK,UAAU,GAAG,OAAO,CAAC;QACxB,UAAU,EAAE,SAAS,CAAA;QACrB,SAAS,EAAE,SAAS,CAAC,SAAS,CAAA;KAC/B,CAAC,CAAA;IAEF,KAAK,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACnE;AAMD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAsB,IAAI,CACxB,OAAO,EAAE,IAAI,CAAC,OAAO,GACpB,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAerC;yBAjBqB,IAAI;4BA8BA,OAAO,KAEtB,IAAI,CAAC,SAAS;;AAbzB,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,KAAK,OAAO,GAAG;QACb,uBAAuB;QACvB,OAAO,EAAE,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,CAAA;QAC9B,yBAAyB;QACzB,UAAU,EAAE,SAAS,CAAA;KACtB,CAAA;IAED,KAAK,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACpE;AAMD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAsB,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAoBtE;yBApBqB,MAAM;4BAmCA,OAAO,KAExB,MAAM,CAAC,SAAS;;AAf3B,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,KAAK,OAAO,GAAG;QACb,0CAA0C;QAC1C,SAAS,EAAE,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;QACvC,gCAAgC;QAChC,SAAS,EAAE,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;QACrC,+BAA+B;QAC/B,OAAO,EAAE,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,CAAA;KAC/B,CAAA;IAED,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC"}

package/_types/Withdrawal.d.ts

@@ -0,0 +1,74 @@
+import type * as Errors from './Errors.js';
+import * as Hex from './Hex.js';
+/** A Withdrawal as defined in the [Execution API specification](https://github.com/ethereum/execution-apis/blob/main/src/schemas/withdrawal.yaml). */
+export type Withdrawal<bigintType = bigint, numberType = number> = {
+    address: Hex.Hex;
+    amount: bigintType;
+    index: numberType;
+    validatorIndex: numberType;
+};
+/** An RPC Withdrawal as defined in the [Execution API specification](https://github.com/ethereum/execution-apis/blob/main/src/schemas/withdrawal.yaml). */
+export type Rpc = Withdrawal<Hex.Hex, Hex.Hex>;
+/**
+ * Converts a {@link ox#Withdrawal.Rpc} to an {@link ox#Withdrawal.Withdrawal}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Withdrawal } from 'ox'
+ *
+ * const withdrawal = Withdrawal.fromRpc({
+ *   address: '0x00000000219ab540356cBB839Cbe05303d7705Fa',
+ *   amount: '0x620323',
+ *   index: '0x0',
+ *   validatorIndex: '0x1',
+ * })
+ * // @log: {
+ * // @log:   address: '0x00000000219ab540356cBB839Cbe05303d7705Fa',
+ * // @log:   amount: 6423331n,
+ * // @log:   index: 0,
+ * // @log:   validatorIndex: 1
+ * // @log: }
+ * ```
+ *
+ * @param withdrawal - The RPC withdrawal to convert.
+ * @returns An instantiated {@link ox#Withdrawal.Withdrawal}.
+ */
+export declare function fromRpc(withdrawal: Rpc): Withdrawal;
+export declare namespace fromRpc {
+    var parseError: (error: unknown) => fromRpc.ErrorType;
+}
+export declare namespace fromRpc {
+    type ErrorType = Errors.GlobalErrorType;
+}
+/**
+ * Converts a {@link ox#Withdrawal.Withdrawal} to an {@link ox#Withdrawal.Rpc}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Withdrawal } from 'ox'
+ *
+ * const withdrawal = Withdrawal.toRpc({
+ *   address: '0x00000000219ab540356cBB839Cbe05303d7705Fa',
+ *   amount: 6423331n,
+ *   index: 0,
+ *   validatorIndex: 1,
+ * })
+ * // @log: {
+ * // @log:   address: '0x00000000219ab540356cBB839Cbe05303d7705Fa',
+ * // @log:   amount: '0x620323',
+ * // @log:   index: '0x0',
+ * // @log:   validatorIndex: '0x1',
+ * // @log: }
+ * ```
+ *
+ * @param withdrawal - The Withdrawal to convert.
+ * @returns An RPC Withdrawal.
+ */
+export declare function toRpc(withdrawal: Withdrawal): Rpc;
+export declare namespace toRpc {
+    var parseError: (error: unknown) => toRpc.ErrorType;
+}
+export declare namespace toRpc {
+    type ErrorType = Errors.GlobalErrorType;
+}
+//# sourceMappingURL=Withdrawal.d.ts.map

package/_types/Withdrawal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Withdrawal.d.ts","sourceRoot":"","sources":["../Withdrawal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAE/B,sJAAsJ;AACtJ,MAAM,MAAM,UAAU,CAAC,UAAU,GAAG,MAAM,EAAE,UAAU,GAAG,MAAM,IAAI;IACjE,OAAO,EAAE,GAAG,CAAC,GAAG,CAAA;IAChB,MAAM,EAAE,UAAU,CAAA;IAClB,KAAK,EAAE,UAAU,CAAA;IACjB,cAAc,EAAE,UAAU,CAAA;CAC3B,CAAA;AAED,2JAA2J;AAC3J,MAAM,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAA;AAE9C;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,OAAO,CAAC,UAAU,EAAE,GAAG,GAAG,UAAU,CAOnD;yBAPe,OAAO;4BAaM,OAAO,KAEzB,OAAO,CAAC,SAAS;;AAN5B,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,KAAY,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CAC/C;AAMD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,KAAK,CAAC,UAAU,EAAE,UAAU,GAAG,GAAG,CAOjD;yBAPe,KAAK;4BAaM,OAAO,KAEvB,KAAK,CAAC,SAAS;;AAN1B,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,KAAY,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CAC/C"}