ox 0.0.1 → 0.1.0

package/_types/Block.d.ts

@@ -0,0 +1,190 @@
+import type * as Address from './Address.js';
+import type * as Errors from './Errors.js';
+import * as Hex from './Hex.js';
+import * as Transaction from './Transaction.js';
+import * as Withdrawal from './Withdrawal.js';
+import type { Compute } from './internal/types.js';
+/** A Block as defined in the [Execution API specification](https://github.com/ethereum/execution-apis/blob/main/src/schemas/block.yaml). */
+export type Block<includeTransactions extends boolean = false, blockTag extends Tag = 'latest', bigintType = bigint, numberType = number, transaction = Transaction.Transaction<blockTag extends 'pending' ? true : false, bigintType, numberType>> = Compute<{
+    /** Base fee per gas */
+    baseFeePerGas?: bigintType | undefined;
+    /** Total used blob gas by all transactions in this block */
+    blobGasUsed?: bigintType | undefined;
+    /** Difficulty for this block */
+    difficulty?: bigintType | undefined;
+    /** Excess blob gas */
+    excessBlobGas?: bigintType | undefined;
+    /** "Extra data" field of this block */
+    extraData?: Hex.Hex | undefined;
+    /** Maximum gas allowed in this block */
+    gasLimit: bigintType;
+    /** Total used gas by all transactions in this block */
+    gasUsed: bigintType;
+    /** Block hash or `null` if pending */
+    hash: blockTag extends 'pending' ? null : Hex.Hex;
+    /** Logs bloom filter or `null` if pending */
+    logsBloom: blockTag extends 'pending' ? null : Hex.Hex;
+    /** Address that received this block’s mining rewards */
+    miner: Address.Address;
+    /** Unique identifier for the block. */
+    mixHash: Hex.Hex;
+    /** Proof-of-work hash or `null` if pending */
+    nonce: blockTag extends 'pending' ? null : Hex.Hex;
+    /** Block number or `null` if pending */
+    number: blockTag extends 'pending' ? null : bigintType;
+    parentBeaconBlockRoot?: Hex.Hex | undefined;
+    /** Parent block hash */
+    parentHash: Hex.Hex;
+    /** Root of the this block’s receipts trie */
+    receiptsRoot: Hex.Hex;
+    sealFields?: readonly Hex.Hex[] | undefined;
+    /** SHA3 of the uncles data in this block */
+    sha3Uncles: Hex.Hex;
+    /** Size of this block in bytes */
+    size: bigintType;
+    /** Root of this block’s final state trie */
+    stateRoot: Hex.Hex;
+    /** Unix timestamp of when this block was collated */
+    timestamp: bigintType;
+    /** Total difficulty of the chain until this block */
+    totalDifficulty?: bigintType | undefined;
+    /** List of transaction objects or hashes */
+    transactions: includeTransactions extends true ? readonly transaction[] : readonly Hex.Hex[];
+    /** Root of this block’s transaction trie */
+    transactionsRoot: Hex.Hex;
+    /** List of uncle hashes */
+    uncles: readonly Hex.Hex[];
+    /** List of withdrawal objects */
+    withdrawals?: readonly Withdrawal.Withdrawal<bigintType, numberType>[] | undefined;
+    /** Root of the this block’s withdrawals trie */
+    withdrawalsRoot?: Hex.Hex | undefined;
+}>;
+/** A Block hash. */
+export type Hash = Hex.Hex;
+/** A Block number. */
+export type Number<bigintType = bigint> = bigintType;
+/** An RPC Block as defined in the [Execution API specification](https://github.com/ethereum/execution-apis/blob/main/src/schemas/block.yaml). */
+export type Rpc<includeTransactions extends boolean = boolean, blockTag extends Tag = 'latest', transaction = Transaction.Rpc<blockTag extends 'pending' ? true : false>> = Block<includeTransactions, blockTag, Hex.Hex, Hex.Hex, transaction>;
+/**
+ * A Block Tag as defined in the [Execution API specification](https://github.com/ethereum/execution-apis/blob/main/src/schemas/block.yaml).
+ *
+ * - `earliest`: The lowest numbered block the client has available;
+ * - `finalized`: The most recent crypto-economically secure block, cannot be re-orged outside of manual intervention driven by community coordination;
+ * - `safe`: The most recent block that is safe from re-orgs under honest majority and certain synchronicity assumptions;
+ * - `latest`: The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions;
+ * - `pending`: A sample next block built by the client on top of `latest` and containing the set of transactions usually taken from local mempool.
+ */
+export type Tag = 'latest' | 'earliest' | 'pending' | 'safe' | 'finalized';
+/**
+ * Converts a {@link ox#Block.Block} to an {@link ox#Block.Rpc}.
+ *
+ * @example
+ * ```ts twoslash
+ * // @noErrors
+ * import { Block } from 'ox'
+ *
+ * const block = Block.toRpc({
+ *   // ...
+ *   hash: '0xebc3644804e4040c0a74c5a5bbbc6b46a71a5d4010fe0c92ebb2fdf4a43ea5dd',
+ *   number: 19868020n,
+ *   size: 520n
+ *   timestamp: 1662222222n,
+ *   // ...
+ * })
+ * // @log: {
+ * // @log:   // ...
+ * // @log:   hash: '0xebc3644804e4040c0a74c5a5bbbc6b46a71a5d4010fe0c92ebb2fdf4a43ea5dd',
+ * // @log:   number: '0xec6fc6',
+ * // @log:   size: '0x208',
+ * // @log:   timestamp: '0x63198f6f',
+ * // @log:   // ...
+ * // @log: }
+ * ```
+ *
+ * @param block - The Block to convert.
+ * @returns An RPC Block.
+ */
+export declare function toRpc<includeTransactions extends boolean = false, blockTag extends Tag = 'latest'>(block: Block<includeTransactions, blockTag>, _options?: toRpc.Options<includeTransactions, blockTag>): Rpc<boolean, blockTag>;
+export declare namespace toRpc {
+    var parseError: (error: unknown) => toRpc.ErrorType;
+}
+export declare namespace toRpc {
+    type Options<includeTransactions extends boolean = false, blockTag extends Tag = 'latest'> = {
+        blockTag?: blockTag | Tag | undefined;
+        includeTransactions?: includeTransactions | boolean | undefined;
+    };
+    type ErrorType = Errors.GlobalErrorType;
+}
+/**
+ * Converts a {@link ox#Block.Rpc} to an {@link ox#Block.Block}.
+ *
+ * @example
+ * ```ts twoslash
+ * // @noErrors
+ * import { Block } from 'ox'
+ *
+ * const block = Block.fromRpc({
+ *   // ...
+ *   hash: '0xebc3644804e4040c0a74c5a5bbbc6b46a71a5d4010fe0c92ebb2fdf4a43ea5dd',
+ *   number: '0xec6fc6',
+ *   size: '0x208',
+ *   timestamp: '0x63198f6f',
+ *   // ...
+ * })
+ * // @log: {
+ * // @log:   // ...
+ * // @log:   hash: '0xebc3644804e4040c0a74c5a5bbbc6b46a71a5d4010fe0c92ebb2fdf4a43ea5dd',
+ * // @log:   number: 19868020n,
+ * // @log:   size: 520n,
+ * // @log:   timestamp: 1662222222n,
+ * // @log:   // ...
+ * // @log: }
+ * ```
+ *
+ * @example
+ * ### End-to-end
+ *
+ * Below is an end-to-end example of using `Block.fromRpc` to fetch a block from the network and convert it to an {@link ox#Block.Block}.
+ *
+ * ```ts twoslash
+ * import 'ox/window'
+ * import { Block } from 'ox'
+ *
+ * const block = await window.ethereum!
+ *   .request({
+ *     method: 'eth_getBlockByNumber',
+ *     params: ['latest', false],
+ *   })
+ *   .then(Block.fromRpc) // [!code hl]
+ * // @log: {
+ * // @log:   // ...
+ * // @log:   hash: '0xebc3644804e4040c0a74c5a5bbbc6b46a71a5d4010fe0c92ebb2fdf4a43ea5dd',
+ * // @log:   number: 19868020n,
+ * // @log:   size: 520n,
+ * // @log:   timestamp: 1662222222n,
+ * // @log:   // ...
+ * // @log: }
+ * ```
+ *
+ * :::note
+ *
+ * For simplicity, the above example uses `window.ethereum.request`, but you can use any
+ * type of JSON-RPC interface.
+ *
+ * :::
+ *
+ * @param block - The RPC block to convert.
+ * @returns An instantiated {@link ox#Block.Block}.
+ */
+export declare function fromRpc<const block extends Rpc | null, includeTransactions extends boolean = false, blockTag extends Tag = 'latest'>(block: block | Rpc | null, _options?: fromRpc.Options<includeTransactions, blockTag>): block extends Rpc ? Block<includeTransactions, blockTag> : null;
+export declare namespace fromRpc {
+    var parseError: (error: unknown) => fromRpc.ErrorType;
+}
+export declare namespace fromRpc {
+    type Options<includeTransactions extends boolean = false, blockTag extends Tag = 'latest'> = {
+        blockTag?: blockTag | Tag | undefined;
+        includeTransactions?: includeTransactions | boolean | undefined;
+    };
+    type ErrorType = Errors.GlobalErrorType;
+}
+//# sourceMappingURL=Block.d.ts.map

package/_types/Block.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Block.d.ts","sourceRoot":"","sources":["../Block.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,KAAK,MAAM,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAC/C,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAElD,4IAA4I;AAC5I,MAAM,MAAM,KAAK,CACf,mBAAmB,SAAS,OAAO,GAAG,KAAK,EAC3C,QAAQ,SAAS,GAAG,GAAG,QAAQ,EAC/B,UAAU,GAAG,MAAM,EACnB,UAAU,GAAG,MAAM,EACnB,WAAW,GAAG,WAAW,CAAC,WAAW,CACnC,QAAQ,SAAS,SAAS,GAAG,IAAI,GAAG,KAAK,EACzC,UAAU,EACV,UAAU,CACX,IACC,OAAO,CAAC;IACV,uBAAuB;IACvB,aAAa,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IACtC,4DAA4D;IAC5D,WAAW,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IACpC,gCAAgC;IAChC,UAAU,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IACnC,sBAAsB;IACtB,aAAa,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IACtC,uCAAuC;IACvC,SAAS,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG,SAAS,CAAA;IAC/B,wCAAwC;IACxC,QAAQ,EAAE,UAAU,CAAA;IACpB,uDAAuD;IACvD,OAAO,EAAE,UAAU,CAAA;IACnB,sCAAsC;IACtC,IAAI,EAAE,QAAQ,SAAS,SAAS,GAAG,IAAI,GAAG,GAAG,CAAC,GAAG,CAAA;IACjD,6CAA6C;IAC7C,SAAS,EAAE,QAAQ,SAAS,SAAS,GAAG,IAAI,GAAG,GAAG,CAAC,GAAG,CAAA;IACtD,wDAAwD;IACxD,KAAK,EAAE,OAAO,CAAC,OAAO,CAAA;IACtB,uCAAuC;IACvC,OAAO,EAAE,GAAG,CAAC,GAAG,CAAA;IAChB,8CAA8C;IAC9C,KAAK,EAAE,QAAQ,SAAS,SAAS,GAAG,IAAI,GAAG,GAAG,CAAC,GAAG,CAAA;IAClD,wCAAwC;IACxC,MAAM,EAAE,QAAQ,SAAS,SAAS,GAAG,IAAI,GAAG,UAAU,CAAA;IACtD,qBAAqB,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG,SAAS,CAAA;IAC3C,wBAAwB;IACxB,UAAU,EAAE,GAAG,CAAC,GAAG,CAAA;IACnB,6CAA6C;IAC7C,YAAY,EAAE,GAAG,CAAC,GAAG,CAAA;IACrB,UAAU,CAAC,EAAE,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,SAAS,CAAA;IAC3C,4CAA4C;IAC5C,UAAU,EAAE,GAAG,CAAC,GAAG,CAAA;IACnB,kCAAkC;IAClC,IAAI,EAAE,UAAU,CAAA;IAChB,4CAA4C;IAC5C,SAAS,EAAE,GAAG,CAAC,GAAG,CAAA;IAClB,qDAAqD;IACrD,SAAS,EAAE,UAAU,CAAA;IACrB,qDAAqD;IACrD,eAAe,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IACxC,4CAA4C;IAC5C,YAAY,EAAE,mBAAmB,SAAS,IAAI,GAC1C,SAAS,WAAW,EAAE,GACtB,SAAS,GAAG,CAAC,GAAG,EAAE,CAAA;IACtB,4CAA4C;IAC5C,gBAAgB,EAAE,GAAG,CAAC,GAAG,CAAA;IACzB,2BAA2B;IAC3B,MAAM,EAAE,SAAS,GAAG,CAAC,GAAG,EAAE,CAAA;IAC1B,iCAAiC;IACjC,WAAW,CAAC,EACR,SAAS,UAAU,CAAC,UAAU,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE,GACxD,SAAS,CAAA;IACb,gDAAgD;IAChD,eAAe,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG,SAAS,CAAA;CACtC,CAAC,CAAA;AAEF,oBAAoB;AACpB,MAAM,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,CAAA;AAE1B,sBAAsB;AACtB,MAAM,MAAM,MAAM,CAAC,UAAU,GAAG,MAAM,IAAI,UAAU,CAAA;AAEpD,iJAAiJ;AACjJ,MAAM,MAAM,GAAG,CACb,mBAAmB,SAAS,OAAO,GAAG,OAAO,EAC7C,QAAQ,SAAS,GAAG,GAAG,QAAQ,EAC/B,WAAW,GAAG,WAAW,CAAC,GAAG,CAAC,QAAQ,SAAS,SAAS,GAAG,IAAI,GAAG,KAAK,CAAC,IACtE,KAAK,CAAC,mBAAmB,EAAE,QAAQ,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAA;AAEvE;;;;;;;;GAQG;AACH,MAAM,MAAM,GAAG,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,MAAM,GAAG,WAAW,CAAA;AAE1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,KAAK,CACnB,mBAAmB,SAAS,OAAO,GAAG,KAAK,EAC3C,QAAQ,SAAS,GAAG,GAAG,QAAQ,EAE/B,KAAK,EAAE,KAAK,CAAC,mBAAmB,EAAE,QAAQ,CAAC,EAC3C,QAAQ,GAAE,KAAK,CAAC,OAAO,CAAC,mBAAmB,EAAE,QAAQ,CAAM,GAC1D,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAmDxB;yBAzDe,KAAK;4BAuEM,OAAO,KAEvB,KAAK,CAAC,SAAS;;AAd1B,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,KAAK,OAAO,CACV,mBAAmB,SAAS,OAAO,GAAG,KAAK,EAC3C,QAAQ,SAAS,GAAG,GAAG,QAAQ,IAC7B;QACF,QAAQ,CAAC,EAAE,QAAQ,GAAG,GAAG,GAAG,SAAS,CAAA;QACrC,mBAAmB,CAAC,EAAE,mBAAmB,GAAG,OAAO,GAAG,SAAS,CAAA;KAChE,CAAA;IAED,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACH,wBAAgB,OAAO,CACrB,KAAK,CAAC,KAAK,SAAS,GAAG,GAAG,IAAI,EAC9B,mBAAmB,SAAS,OAAO,GAAG,KAAK,EAC3C,QAAQ,SAAS,GAAG,GAAG,QAAQ,EAE/B,KAAK,EAAE,KAAK,GAAG,GAAG,GAAG,IAAI,EACzB,QAAQ,GAAE,OAAO,CAAC,OAAO,CAAC,mBAAmB,EAAE,QAAQ,CAAM,GAC5D,KAAK,SAAS,GAAG,GAAG,KAAK,CAAC,mBAAmB,EAAE,QAAQ,CAAC,GAAG,IAAI,CA2BjE;yBAlCe,OAAO;4BAgDM,OAAO,KAEzB,OAAO,CAAC,SAAS;;AAd5B,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,KAAK,OAAO,CACV,mBAAmB,SAAS,OAAO,GAAG,KAAK,EAC3C,QAAQ,SAAS,GAAG,GAAG,QAAQ,IAC7B;QACF,QAAQ,CAAC,EAAE,QAAQ,GAAG,GAAG,GAAG,SAAS,CAAA;QACrC,mBAAmB,CAAC,EAAE,mBAAmB,GAAG,OAAO,GAAG,SAAS,CAAA;KAChE,CAAA;IAED,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC"}

package/_types/Bloom.d.ts

@@ -0,0 +1,54 @@
+import * as Bytes from './Bytes.js';
+import type * as Errors from './Errors.js';
+import * as Hash from './Hash.js';
+import * as Hex from './Hex.js';
+/**
+ * Checks if an input is matched in the bloom filter.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Bloom } from 'ox'
+ *
+ * Bloom.contains(
+ *   '0x00000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002020000000000000000000000000000000000000000000008000000001000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000',
+ *   '0xef2d6d194084c2de36e0dabfce45d046b37d1106',
+ * )
+ * // @log: true
+ * ```
+ *
+ * @param bloom - Bloom filter value.
+ * @param input - Input to check.
+ * @returns Whether the input is matched in the bloom filter.
+ */
+export declare function contains(bloom: Hex.Hex, input: Hex.Hex | Bytes.Bytes): boolean;
+export declare namespace contains {
+    var parseError: (error: unknown) => contains.ErrorType;
+}
+export declare namespace contains {
+    type ErrorType = Bytes.fromHex.ErrorType | Hash.keccak256.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Checks if a string is a valid bloom filter value.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Bloom } from 'ox'
+ *
+ * Bloom.validate('0x')
+ * // @log: false
+ *
+ * Bloom.validate('0x00000000000000000000008000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000044000200000000000000000002000000000000000000000040000000000000000000000000000020000000000000000000800000000000800000000000800000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000808002000000000400000000000000000000000060000000000000000000000000000000000000000000000100000000000002000000')
+ * // @log: true
+ * ```
+ *
+ * @param value - Value to check.
+ * @returns Whether the value is a valid bloom filter.
+ */
+export declare function validate(value: string): value is Hex.Hex;
+export declare namespace validate {
+    var parseError: (error: unknown) => validate.ErrorType;
+}
+export declare namespace validate {
+    type ErrorType = Hex.validate.ErrorType | Hex.size.ErrorType | Errors.GlobalErrorType;
+}
+//# sourceMappingURL=Bloom.d.ts.map

package/_types/Bloom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Bloom.d.ts","sourceRoot":"","sources":["../Bloom.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,KAAK,MAAM,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAE/B;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,GAAG,CAAC,GAAG,EACd,KAAK,EAAE,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,GAC3B,OAAO,CAWT;yBAde,QAAQ;4BAuBM,OAAO,KAE1B,QAAQ,CAAC,SAAS;;AAT7B,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,KAAK,SAAS,GACV,KAAK,CAAC,OAAO,CAAC,SAAS,GACvB,IAAI,CAAC,SAAS,CAAC,SAAS,GACxB,MAAM,CAAC,eAAe,CAAA;CAC3B;AAMD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,GAAG,CAAC,GAAG,CAExD;yBAFe,QAAQ;4BAYM,OAAO,KAAc,QAAQ,CAAC,SAAS;;AARrE,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,KAAK,SAAS,GACV,GAAG,CAAC,QAAQ,CAAC,SAAS,GACtB,GAAG,CAAC,IAAI,CAAC,SAAS,GAClB,MAAM,CAAC,eAAe,CAAA;CAC3B"}

package/_types/Bls.d.ts

@@ -0,0 +1,365 @@
+import type * as BlsPoint from './BlsPoint.js';
+import * as Bytes from './Bytes.js';
+import type * as Errors from './Errors.js';
+import * as Hex from './Hex.js';
+import type { OneOf } from './internal/types.js';
+export type Size = 'short-key:long-sig' | 'long-key:short-sig';
+/** Re-export of noble/curves BLS12-381 utilities. */
+export declare const noble: import("@noble/curves/abstract/bls.js").CurveFn;
+/**
+ * Aggregates a set of BLS points that are either on the G1 or G2 curves (ie. public keys or signatures).
+ *
+ * @example
+ * ### Aggregating Signatures
+ *
+ * ```ts twoslash
+ * import { Bls, Hex } from 'ox'
+ *
+ * const payload = Hex.random(32)
+ *
+ * const signatures = [
+ *   Bls.sign({ payload, privateKey: '0x...' }),
+ *   Bls.sign({ payload, privateKey: '0x...' }),
+ * ]
+ * const signature = Bls.aggregate(signatures)
+ * ```
+ *
+ * @example
+ * ### Aggregating Public Keys
+ *
+ * ```ts twoslash
+ * import { Bls } from 'ox'
+ *
+ * const publicKeys = [
+ *   Bls.getPublicKey({ privateKey: '0x...' }),
+ *   Bls.getPublicKey({ privateKey: '0x...' }),
+ * ]
+ * const publicKey = Bls.aggregate(publicKeys)
+ * ```
+ *
+ * @param points - The points to aggregate.
+ * @returns The aggregated point.
+ */
+export declare function aggregate<const points extends readonly BlsPoint.BlsPoint[]>(points: points): points extends readonly BlsPoint.G1[] ? BlsPoint.G1 : BlsPoint.G2;
+export declare namespace aggregate {
+    var parseError: (error: unknown) => aggregate.ErrorType;
+}
+export declare namespace aggregate {
+    type ErrorType = Errors.GlobalErrorType;
+}
+/**
+ * Computes the BLS12-381 public key from a provided private key.
+ *
+ * Public Keys can be derived as a point on one of the BLS12-381 groups:
+ *
+ * - G1 Point (Default):
+ *   - short (48 bytes)
+ *   - computes longer G2 Signatures (96 bytes)
+ * - G2 Point:
+ *   - long (96 bytes)
+ *   - computes short G1 Signatures (48 bytes)
+ *
+ * @example
+ * ### Short G1 Public Keys (Default)
+ *
+ * ```ts twoslash
+ * import { Bls } from 'ox'
+ *
+ * const publicKey = Bls.getPublicKey({ privateKey: '0x...' })
+ * //    ^?
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * ```
+ *
+ * @example
+ * ### Long G2 Public Keys
+ *
+ * A G2 Public Key can be derived as a G2 point (96 bytes) using `size: 'long-key:short-sig'`.
+ *
+ * This will allow you to compute G1 Signatures (48 bytes) with {@link ox#Bls.(sign:function)}.
+ *
+ * ```ts twoslash
+ * import { Bls } from 'ox'
+ *
+ * const publicKey = Bls.getPublicKey({
+ *   privateKey: '0x...',
+ *   size: 'long-key:short-sig',
+ * })
+ *
+ * publicKey
+ * // ^?
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * ```
+ *
+ * ### Serializing
+ *
+ * Public Keys can be serialized to hex or bytes using {@link ox#BlsPoint.(toHex:function)} or {@link ox#BlsPoint.(toBytes:function)}:
+ *
+ * ```ts twoslash
+ * import { Bls, BlsPoint } from 'ox'
+ *
+ * const publicKey = Bls.getPublicKey({ privateKey: '0x...' })
+ *
+ * const publicKeyHex = BlsPoint.toHex(publicKey)
+ * //    ^?
+ *
+ *
+ * const publicKeyBytes = BlsPoint.toBytes(publicKey)
+ * //    ^?
+ *
+ * ```
+ *
+ * They can also be deserialized from hex or bytes using {@link ox#BlsPoint.(fromHex:function)} or {@link ox#BlsPoint.(fromBytes:function)}:
+ *
+ * ```ts twoslash
+ * import { Bls, BlsPoint } from 'ox'
+ *
+ * const publicKeyHex = '0x...'
+ *
+ * const publicKey = BlsPoint.fromHex(publicKeyHex, 'G1')
+ * //    ^?
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * ```
+ *
+ * @param options - The options to compute the public key.
+ * @returns The computed public key.
+ */
+export declare function getPublicKey<size extends Size = 'short-key:long-sig'>(options: getPublicKey.Options<size>): size extends 'short-key:long-sig' ? BlsPoint.G1 : BlsPoint.G2;
+export declare namespace getPublicKey {
+    type Options<size extends Size = 'short-key:long-sig'> = {
+        /**
+         * Private key to compute the public key from.
+         */
+        privateKey: Hex.Hex | Bytes.Bytes;
+        /**
+         * Size of the public key to compute.
+         *
+         * - `'short-key:long-sig'`: 48 bytes; computes long signatures (96 bytes)
+         * - `'long-key:short-sig'`: 96 bytes; computes short signatures (48 bytes)
+         *
+         * @default 'short-key:long-sig'
+         */
+        size?: size | Size | undefined;
+    };
+    type ErrorType = Hex.from.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Generates a random BLS12-381 private key.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Bls } from 'ox'
+ *
+ * const privateKey = Bls.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;
+}
+/**
+ * Signs the payload with the provided private key.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Bls, Hex } from 'ox'
+ *
+ * const signature = Bls.sign({ // [!code focus]
+ *   payload: Hex.random(32), // [!code focus]
+ *   privateKey: '0x...' // [!code focus]
+ * }) // [!code focus]
+ * ```
+ *
+ * @example
+ * ### Serializing
+ *
+ * Signatures can be serialized to hex or bytes using {@link ox#BlsPoint.(toHex:function)} or {@link ox#BlsPoint.(toBytes:function)}:
+ *
+ * ```ts twoslash
+ * import { Bls, BlsPoint, Hex } from 'ox'
+ *
+ * const signature = Bls.sign({ payload: Hex.random(32), privateKey: '0x...' })
+ *
+ * const signatureHex = BlsPoint.toHex(signature)
+ * //    ^?
+ *
+ *
+ *
+ * const signatureBytes = BlsPoint.toBytes(signature)
+ * //    ^?
+ *
+ *
+ * ```
+ *
+ * They can also be deserialized from hex or bytes using {@link ox#BlsPoint.(fromHex:function)} or {@link ox#BlsPoint.(fromBytes:function)}:
+ *
+ * ```ts twoslash
+ * import { Bls, BlsPoint } from 'ox'
+ *
+ * const signatureHex = '0x...'
+ *
+ * const signature = BlsPoint.fromHex(signatureHex, 'G2')
+ * //    ^?
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * ```
+ *
+ * @param options - The signing options.
+ * @returns BLS Point.
+ */
+export declare function sign<size extends Size = 'short-key:long-sig'>(options: sign.Options<size>): size extends 'short-key:long-sig' ? BlsPoint.G2 : BlsPoint.G1;
+export declare namespace sign {
+    var parseError: (error: unknown) => sign.ErrorType;
+}
+export declare namespace sign {
+    type Options<size extends Size = 'short-key:long-sig'> = {
+        /**
+         * Payload to sign.
+         */
+        payload: Hex.Hex | Bytes.Bytes;
+        /**
+         * BLS private key.
+         */
+        privateKey: Hex.Hex | Bytes.Bytes;
+        /**
+         * Ciphersuite to use for signing. Defaults to "Basic".
+         *
+         * @see https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-bls-signature-05#section-4
+         * @default 'BLS_SIG_BLS12381G2_XMD:SHA-256_SSWU_RO_NUL_'
+         */
+        suite?: string | undefined;
+        /**
+         * Size of the signature to compute.
+         *
+         * - `'long-key:short-sig'`: 48 bytes
+         * - `'short-key:long-sig'`: 96 bytes
+         *
+         * @default 'short-key:long-sig'
+         */
+        size?: size | Size | undefined;
+    };
+    type ErrorType = Bytes.from.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Verifies a payload was signed by the provided public key(s).
+ *
+ * @example
+ *
+ * ```ts twoslash
+ * import { Bls, Hex } from 'ox'
+ *
+ * const payload = Hex.random(32)
+ * const privateKey = Bls.randomPrivateKey()
+ *
+ * const publicKey = Bls.getPublicKey({ privateKey })
+ * const signature = Bls.sign({ payload, privateKey })
+ *
+ * const verified = Bls.verify({ // [!code focus]
+ *   payload, // [!code focus]
+ *   publicKey, // [!code focus]
+ *   signature, // [!code focus]
+ * }) // [!code focus]
+ * ```
+ *
+ * @example
+ * ### Verify Aggregated Signatures
+ *
+ * We can also pass a public key and signature that was aggregated with {@link ox#Bls.(aggregate:function)} to `Bls.verify`.
+ *
+ * ```ts twoslash
+ * import { Bls, Hex } from 'ox'
+ *
+ * const payload = Hex.random(32)
+ * const privateKeys = Array.from({ length: 100 }, () => Bls.randomPrivateKey())
+ *
+ * const publicKeys = privateKeys.map((privateKey) =>
+ *   Bls.getPublicKey({ privateKey }),
+ * )
+ * const signatures = privateKeys.map((privateKey) =>
+ *   Bls.sign({ payload, privateKey }),
+ * )
+ *
+ * const publicKey = Bls.aggregate(publicKeys) // [!code focus]
+ * const signature = Bls.aggregate(signatures) // [!code focus]
+ *
+ * const valid = Bls.verify({ payload, publicKey, signature }) // [!code focus]
+ * ```
+ *
+ * @param options - Verification options.
+ * @returns Whether the payload was signed by the provided public key.
+ */
+export declare function verify(options: verify.Options): boolean;
+export declare namespace verify {
+    var parseError: (error: unknown) => verify.ErrorType;
+}
+export declare namespace verify {
+    type Options = {
+        /**
+         * Payload that was signed.
+         */
+        payload: Hex.Hex | Bytes.Bytes;
+        /**
+         * Ciphersuite to use for verification. Defaults to "Basic".
+         *
+         * @see https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-bls-signature-05#section-4
+         * @default 'BLS_SIG_BLS12381G2_XMD:SHA-256_SSWU_RO_NUL_'
+         */
+        suite?: string | undefined;
+    } & OneOf<{
+        publicKey: BlsPoint.G1;
+        signature: BlsPoint.G2;
+    } | {
+        publicKey: BlsPoint.G2;
+        signature: BlsPoint.G1;
+    }>;
+    type ErrorType = Errors.GlobalErrorType;
+}
+//# sourceMappingURL=Bls.d.ts.map

package/_types/Bls.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Bls.d.ts","sourceRoot":"","sources":["../Bls.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,QAAQ,MAAM,eAAe,CAAA;AAC9C,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,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAEhD,MAAM,MAAM,IAAI,GAAG,oBAAoB,GAAG,oBAAoB,CAAA;AAE9D,qDAAqD;AACrD,eAAO,MAAM,KAAK,iDAAM,CAAA;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAgB,SAAS,CAAC,KAAK,CAAC,MAAM,SAAS,SAAS,QAAQ,CAAC,QAAQ,EAAE,EACzE,MAAM,EAAE,MAAM,GACb,MAAM,SAAS,SAAS,QAAQ,CAAC,EAAE,EAAE,GAAG,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,EAAE,CAAA;yBAFpD,SAAS;4BAwBM,OAAO,KAE3B,SAAS,CAAC,SAAS;;AAN9B,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsGG;AACH,wBAAgB,YAAY,CAAC,IAAI,SAAS,IAAI,GAAG,oBAAoB,EACnE,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,GAClC,IAAI,SAAS,oBAAoB,GAAG,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,EAAE,CAAA;AAWhE,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,KAAK,OAAO,CAAC,IAAI,SAAS,IAAI,GAAG,oBAAoB,IAAI;QACvD;;WAEG;QACH,UAAU,EAAE,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,CAAA;QACjC;;;;;;;WAOG;QACH,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,CAAA;KAC/B,CAAA;IAED,KAAK,SAAS,GAAG,GAAG,CAAC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CAC7D;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACH,wBAAgB,IAAI,CAAC,IAAI,SAAS,IAAI,GAAG,oBAAoB,EAC3D,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAC1B,IAAI,SAAS,oBAAoB,GAAG,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,EAAE,CAAA;yBAFhD,IAAI;4BAwDM,OAAO,KAEtB,IAAI,CAAC,SAAS;;AAjCzB,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,KAAK,OAAO,CAAC,IAAI,SAAS,IAAI,GAAG,oBAAoB,IAAI;QACvD;;WAEG;QACH,OAAO,EAAE,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,CAAA;QAC9B;;WAEG;QACH,UAAU,EAAE,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,CAAA;QACjC;;;;;WAKG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAC1B;;;;;;;WAOG;QACH,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,CAAA;KAC/B,CAAA;IAED,KAAK,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CAC/D;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,GAAG,OAAO,CA8CvD;yBA9Ce,MAAM;4BA4EM,OAAO,KAAc,MAAM,CAAC,SAAS;;AA5BjE,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,KAAK,OAAO,GAAG;QACb;;WAEG;QACH,OAAO,EAAE,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,CAAA;QAC9B;;;;;WAKG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAC3B,GAAG,KAAK,CACL;QACE,SAAS,EAAE,QAAQ,CAAC,EAAE,CAAA;QACtB,SAAS,EAAE,QAAQ,CAAC,EAAE,CAAA;KACvB,GACD;QACE,SAAS,EAAE,QAAQ,CAAC,EAAE,CAAA;QACtB,SAAS,EAAE,QAAQ,CAAC,EAAE,CAAA;KACvB,CACJ,CAAA;IAED,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC"}