ox 0.0.1 → 0.1.0

package/_types/RpcResponse.d.ts

@@ -0,0 +1,266 @@
+import type { Errors, RpcRequest } from './index.js';
+import type { Compute, IsNarrowable, OneOf, UnionPartialBy } from './internal/types.js';
+/** A JSON-RPC response object as per the [JSON-RPC 2.0 specification](https://www.jsonrpc.org/specification#request_object). */
+export type RpcResponse<result = unknown, error extends ErrorObject = ErrorObject> = Compute<{
+    id: number;
+    jsonrpc: '2.0';
+} & OneOf<{
+    result: result;
+} | {
+    error: error;
+}>>;
+/** JSON-RPC error object as per the [JSON-RPC 2.0 specification](https://www.jsonrpc.org/specification#error_object). */
+export type ErrorObject = {
+    code: number;
+    message: string;
+    data?: unknown | undefined;
+};
+/**
+ * A type-safe interface to instantiate a JSON-RPC response object as per the [JSON-RPC 2.0 specification](https://www.jsonrpc.org/specification#response_object).
+ *
+ * @example
+ * ### Instantiating a Response Object
+ *
+ * ```ts twoslash
+ * import { RpcResponse } from 'ox'
+ *
+ * const response = RpcResponse.from({
+ *   id: 0,
+ *   jsonrpc: '2.0',
+ *   result: '0x69420',
+ * })
+ * ```
+ *
+ * @example
+ * ### Type-safe Instantiation
+ *
+ * If you have a JSON-RPC request object, you can use it to strongly-type the response. If a `request` is provided,
+ * then the `id` and `jsonrpc` properties will be overridden with the values from the request.
+ *
+ * ```ts twoslash
+ * import { RpcRequest, RpcResponse } from 'ox'
+ *
+ * const request = RpcRequest.from({ id: 0, method: 'eth_blockNumber' })
+ *
+ * const response = RpcResponse.from(
+ *   { result: '0x69420' },
+ *   { request },
+ * )
+ * ```
+ *
+ * @param response - Opaque JSON-RPC response object.
+ * @param options - Parsing options.
+ * @returns Typed JSON-RPC result, or response object (if `raw` is `true`).
+ */
+export declare function from<request extends RpcRequest.RpcRequest | undefined = undefined, const response = (request extends RpcRequest.RpcRequest ? request['_returnType'] : RpcResponse) | unknown>(response: from.Response<request, response>, options?: from.Options<request>): Compute<from.ReturnType<response>>;
+export declare namespace from {
+    type Response<request extends RpcRequest.RpcRequest | undefined = undefined, response = unknown> = response & (request extends RpcRequest.RpcRequest ? UnionPartialBy<RpcResponse<request['_returnType']>, 'id' | 'jsonrpc'> : RpcResponse);
+    type Options<request extends RpcRequest.RpcRequest | undefined = RpcRequest.RpcRequest | undefined> = {
+        request?: request | RpcRequest.RpcRequest | undefined;
+    };
+    type ReturnType<response> = IsNarrowable<response, RpcResponse> extends true ? RpcResponse : response & Readonly<{
+        id: number;
+        jsonrpc: '2.0';
+    }>;
+}
+/**
+ * A type-safe interface to parse a JSON-RPC response object as per the [JSON-RPC 2.0 specification](https://www.jsonrpc.org/specification#response_object), and extract the result.
+ *
+ * @example
+ * ```ts twoslash
+ * import { RpcRequest, RpcResponse } from 'ox'
+ *
+ * // 1. Create a request store.
+ * const store = RpcRequest.createStore()
+ *
+ * // 2. Get a request object.
+ * const request = store.prepare({
+ *   method: 'eth_getBlockByNumber',
+ *   params: ['0x1', false],
+ * })
+ *
+ * // 3. Send the JSON-RPC request via HTTP.
+ * const block = await fetch('https://1.rpc.thirdweb.com', {
+ *   body: JSON.stringify(request),
+ *   headers: {
+ *     'Content-Type': 'application/json',
+ *   },
+ *   method: 'POST',
+ * })
+ *  .then((response) => response.json())
+ *  // 4. Parse the JSON-RPC response into a type-safe result. // [!code focus]
+ *  .then((response) => RpcResponse.parse(response, { request })) // [!code focus]
+ *
+ * block // [!code focus]
+ * // ^?
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * ```
+ *
+ * :::tip
+ *
+ * If you don't need the return type, you can omit the options entirely.
+ *
+ * ```ts twoslash
+ * // @noErrors
+ * import { RpcResponse } from 'ox'
+ *
+ * const block = await fetch('https://1.rpc.thirdweb.com', {})
+ *  .then((response) => response.json())
+ *  .then((response) => RpcResponse.parse(response, { request })) // [!code --]
+ *  .then(RpcResponse.parse) // [!code ++]
+ * ```
+ * :::
+ *
+ * @example
+ * ### Raw Mode
+ *
+ * If `raw` is `true`, the response will be returned as an object with `result` and `error` properties instead of returning the `result` directly and throwing errors.
+ *
+ * ```ts twoslash
+ * import { RpcRequest, RpcResponse } from 'ox'
+ *
+ * const store = RpcRequest.createStore()
+ *
+ * const request = store.prepare({
+ *   method: 'eth_blockNumber',
+ * })
+ *
+ * const response = RpcResponse.parse({}, {
+ *   request,
+ *   raw: true, // [!code hl]
+ * })
+ *
+ * response.result
+ * //       ^?
+ *
+ *
+ * response.error
+ * //       ^?
+ *
+ *
+ * ```
+ *
+ * @param response - Opaque JSON-RPC response object.
+ * @param options - Parsing options.
+ * @returns Typed JSON-RPC result, or response object (if `raw` is `true`).
+ */
+export declare function parse<const response extends RpcResponse | unknown, returnType, raw extends boolean = false>(response: response, options?: parse.Options<returnType, raw>): parse.ReturnType<unknown extends response ? returnType : response extends RpcResponse ? response extends {
+    result: infer result;
+} ? result : never : returnType, raw>;
+export declare namespace parse {
+    var parseError: (error: unknown) => parse.ErrorType;
+}
+export declare namespace parse {
+    type Options<returnType, raw extends boolean = false> = {
+        /**
+         * JSON-RPC Method that was used to make the request. Used for typing the response.
+         */
+        request?: {
+            _returnType: returnType;
+        } | RpcRequest.RpcRequest | undefined;
+        /**
+         * Enables raw mode – responses will return an object with `result` and `error` properties instead of returning the `result` directly and throwing errors.
+         *
+         * - `true`: a JSON-RPC response object will be returned with `result` and `error` properties.
+         * - `false`: the JSON-RPC response object's `result` property will be returned directly, and JSON-RPC Errors will be thrown.
+         *
+         * @default false
+         */
+        raw?: raw | boolean | undefined;
+    };
+    type ReturnType<returnType, raw extends boolean = false> = Compute<raw extends true ? RpcResponse<returnType> : returnType>;
+    type ErrorType = ParseError | InvalidInputError | ResourceNotFoundError | ResourceUnavailableError | TransactionRejectedError | MethodNotSupportedError | LimitExceededError | VersionNotSupportedError | InvalidRequestError | MethodNotFoundError | InvalidParamsError | InternalError | BaseErrorType | Errors.GlobalErrorType;
+}
+export type BaseErrorType = BaseError & {
+    name: 'BaseError';
+};
+/** Thrown when a JSON-RPC error has occurred. */
+export declare class BaseError extends Error {
+    name: string;
+    readonly code: number;
+    readonly data?: unknown | undefined;
+    constructor(errorObject: ErrorObject);
+}
+/** Thrown when the input to a JSON-RPC method is invalid. */
+export declare class InvalidInputError extends BaseError {
+    static readonly code = -32000;
+    readonly code = -32000;
+    readonly name = "RpcResponse.InvalidInputError";
+}
+/** Thrown when a JSON-RPC resource is not found. */
+export declare class ResourceNotFoundError extends BaseError {
+    static readonly code = -32001;
+    readonly code = -32001;
+    readonly name = "RpcResponse.ResourceNotFoundError";
+}
+/** Thrown when a JSON-RPC resource is unavailable. */
+export declare class ResourceUnavailableError extends BaseError {
+    static readonly code = -32002;
+    readonly code = -32002;
+    readonly name = "RpcResponse.ResourceUnavailableError";
+}
+/** Thrown when a JSON-RPC transaction is rejected. */
+export declare class TransactionRejectedError extends BaseError {
+    static readonly code = -32003;
+    readonly code = -32003;
+    readonly name = "RpcResponse.TransactionRejectedError";
+}
+/** Thrown when a JSON-RPC method is not supported. */
+export declare class MethodNotSupportedError extends BaseError {
+    static readonly code = -32004;
+    readonly code = -32004;
+    readonly name = "RpcResponse.MethodNotSupportedError";
+}
+/** Thrown when a rate-limit is exceeded. */
+export declare class LimitExceededError extends BaseError {
+    static readonly code = -32005;
+    readonly code = -32005;
+    readonly name = "RpcResponse.LimitExceededError";
+}
+/** Thrown when a JSON-RPC version is not supported. */
+export declare class VersionNotSupportedError extends BaseError {
+    static readonly code = -32006;
+    readonly code = -32006;
+    readonly name = "RpcResponse.VersionNotSupportedError";
+}
+/** Thrown when a JSON-RPC request is invalid. */
+export declare class InvalidRequestError extends BaseError {
+    static readonly code = -32600;
+    readonly code = -32600;
+    readonly name = "RpcResponse.InvalidRequestError";
+}
+/** Thrown when a JSON-RPC method is not found. */
+export declare class MethodNotFoundError extends BaseError {
+    static readonly code = -32601;
+    readonly code = -32601;
+    readonly name = "RpcResponse.MethodNotFoundError";
+}
+/** Thrown when the parameters to a JSON-RPC method are invalid. */
+export declare class InvalidParamsError extends BaseError {
+    static readonly code = -32602;
+    readonly code = -32602;
+    readonly name = "RpcResponse.InvalidParamsError";
+}
+/** Thrown when an internal JSON-RPC error has occurred. */
+export declare class InternalError extends BaseError {
+    static readonly code = -32603;
+    readonly code = -32603;
+    readonly name = "RpcResponse.InternalErrorError";
+}
+/** Thrown when a JSON-RPC response is invalid. */
+export declare class ParseError extends BaseError {
+    static readonly code = -32700;
+    readonly code = -32700;
+    readonly name = "RpcResponse.ParseError";
+}
+//# sourceMappingURL=RpcResponse.d.ts.map

package/_types/RpcResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RpcResponse.d.ts","sourceRoot":"","sources":["../RpcResponse.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AACpD,OAAO,KAAK,EACV,OAAO,EACP,YAAY,EACZ,KAAK,EACL,cAAc,EACf,MAAM,qBAAqB,CAAA;AAE5B,gIAAgI;AAChI,MAAM,MAAM,WAAW,CACrB,MAAM,GAAG,OAAO,EAChB,KAAK,SAAS,WAAW,GAAG,WAAW,IACrC,OAAO,CACT;IACE,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,KAAK,CAAA;CACf,GAAG,KAAK,CAAC;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC,CACjD,CAAA;AAED,yHAAyH;AACzH,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAC3B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAgB,IAAI,CAClB,OAAO,SAAS,UAAU,CAAC,UAAU,GAAG,SAAS,GAAG,SAAS,EAC7D,KAAK,CAAC,QAAQ,GACV,CAAC,OAAO,SAAS,UAAU,CAAC,UAAU,GAClC,OAAO,CAAC,aAAa,CAAC,GACtB,WAAW,CAAC,GAChB,OAAO,EAEX,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,EAC1C,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAC9B,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAA;AAWrC,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,KAAK,QAAQ,CACX,OAAO,SAAS,UAAU,CAAC,UAAU,GAAG,SAAS,GAAG,SAAS,EAC7D,QAAQ,GAAG,OAAO,IAChB,QAAQ,GACV,CAAC,OAAO,SAAS,UAAU,CAAC,UAAU,GAClC,cAAc,CAAC,WAAW,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC,GACrE,WAAW,CAAC,CAAA;IAElB,KAAK,OAAO,CACV,OAAO,SAAS,UAAU,CAAC,UAAU,GAAG,SAAS,GAC7C,UAAU,CAAC,UAAU,GACrB,SAAS,IACX;QACF,OAAO,CAAC,EAAE,OAAO,GAAG,UAAU,CAAC,UAAU,GAAG,SAAS,CAAA;KACtD,CAAA;IAED,KAAK,UAAU,CAAC,QAAQ,IAAI,YAAY,CAAC,QAAQ,EAAE,WAAW,CAAC,SAAS,IAAI,GACxE,WAAW,GACX,QAAQ,GAAG,QAAQ,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,KAAK,CAAA;KAAE,CAAC,CAAA;CACxD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0FG;AACH,wBAAgB,KAAK,CACnB,KAAK,CAAC,QAAQ,SAAS,WAAW,GAAG,OAAO,EAC5C,UAAU,EACV,GAAG,SAAS,OAAO,GAAG,KAAK,EAE3B,QAAQ,EAAE,QAAQ,EAClB,OAAO,GAAE,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAM,GAC3C,KAAK,CAAC,UAAU,CACjB,OAAO,SAAS,QAAQ,GACpB,UAAU,GACV,QAAQ,SAAS,WAAW,GAC1B,QAAQ,SAAS;IAAE,MAAM,EAAE,MAAM,MAAM,CAAA;CAAE,GACvC,MAAM,GACN,KAAK,GACP,UAAU,EAChB,GAAG,CACJ,CA2BA;yBA3Ce,KAAK;4BAwFM,OAAO,KAEvB,KAAK,CAAC,SAAS;;AA7C1B,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,KAAK,OAAO,CAAC,UAAU,EAAE,GAAG,SAAS,OAAO,GAAG,KAAK,IAAI;QACtD;;WAEG;QACH,OAAO,CAAC,EACJ;YACE,WAAW,EAAE,UAAU,CAAA;SACxB,GACD,UAAU,CAAC,UAAU,GACrB,SAAS,CAAA;QACb;;;;;;;WAOG;QACH,GAAG,CAAC,EAAE,GAAG,GAAG,OAAO,GAAG,SAAS,CAAA;KAChC,CAAA;IAED,KAAK,UAAU,CAAC,UAAU,EAAE,GAAG,SAAS,OAAO,GAAG,KAAK,IAAI,OAAO,CAChE,GAAG,SAAS,IAAI,GAAG,WAAW,CAAC,UAAU,CAAC,GAAG,UAAU,CACxD,CAAA;IAED,KAAK,SAAS,GACV,UAAU,GACV,iBAAiB,GACjB,qBAAqB,GACrB,wBAAwB,GACxB,wBAAwB,GACxB,uBAAuB,GACvB,kBAAkB,GAClB,wBAAwB,GACxB,mBAAmB,GACnB,mBAAmB,GACnB,kBAAkB,GAClB,aAAa,GACb,aAAa,GACb,MAAM,CAAC,eAAe,CAAA;CAC3B;AAMD,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,CAAA;AAE7D,iDAAiD;AACjD,qBAAa,SAAU,SAAQ,KAAK;IACzB,IAAI,SAA0B;IAEvC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;gBAEvB,WAAW,EAAE,WAAW;CAMrC;AAED,6DAA6D;AAC7D,qBAAa,iBAAkB,SAAQ,SAAS;IAC9C,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAS;IAC7B,SAAkB,IAAI,UAAS;IAC/B,SAAkB,IAAI,mCAAkC;CACzD;AAED,oDAAoD;AACpD,qBAAa,qBAAsB,SAAQ,SAAS;IAClD,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAS;IAC7B,SAAkB,IAAI,UAAS;IAC/B,SAAkB,IAAI,uCAAsC;CAC7D;AAED,sDAAsD;AACtD,qBAAa,wBAAyB,SAAQ,SAAS;IACrD,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAS;IAC7B,SAAkB,IAAI,UAAS;IAC/B,SAAkB,IAAI,0CAAyC;CAChE;AAED,sDAAsD;AACtD,qBAAa,wBAAyB,SAAQ,SAAS;IACrD,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAS;IAC7B,SAAkB,IAAI,UAAS;IAC/B,SAAkB,IAAI,0CAAyC;CAChE;AAED,sDAAsD;AACtD,qBAAa,uBAAwB,SAAQ,SAAS;IACpD,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAS;IAC7B,SAAkB,IAAI,UAAS;IAC/B,SAAkB,IAAI,yCAAwC;CAC/D;AAED,4CAA4C;AAC5C,qBAAa,kBAAmB,SAAQ,SAAS;IAC/C,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAS;IAC7B,SAAkB,IAAI,UAAS;IAC/B,SAAkB,IAAI,oCAAmC;CAC1D;AAED,uDAAuD;AACvD,qBAAa,wBAAyB,SAAQ,SAAS;IACrD,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAS;IAC7B,SAAkB,IAAI,UAAS;IAC/B,SAAkB,IAAI,0CAAyC;CAChE;AAED,iDAAiD;AACjD,qBAAa,mBAAoB,SAAQ,SAAS;IAChD,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAS;IAC7B,SAAkB,IAAI,UAAS;IAC/B,SAAkB,IAAI,qCAAoC;CAC3D;AAED,kDAAkD;AAClD,qBAAa,mBAAoB,SAAQ,SAAS;IAChD,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAS;IAC7B,SAAkB,IAAI,UAAS;IAC/B,SAAkB,IAAI,qCAAoC;CAC3D;AAED,mEAAmE;AACnE,qBAAa,kBAAmB,SAAQ,SAAS;IAC/C,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAS;IAC7B,SAAkB,IAAI,UAAS;IAC/B,SAAkB,IAAI,oCAAmC;CAC1D;AAED,2DAA2D;AAC3D,qBAAa,aAAc,SAAQ,SAAS;IAC1C,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAS;IAC7B,SAAkB,IAAI,UAAS;IAC/B,SAAkB,IAAI,oCAAmC;CAC1D;AAED,kDAAkD;AAClD,qBAAa,UAAW,SAAQ,SAAS;IACvC,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAS;IAC7B,SAAkB,IAAI,UAAS;IAC/B,SAAkB,IAAI,4BAA2B;CAClD"}

package/_types/RpcSchema.d.ts

@@ -0,0 +1,248 @@
+import type { ResolvedRegister } from './internal/register.js';
+import type { Compute, IsNarrowable } from './internal/types.js';
+export type { Eth } from './internal/rpcSchemas/eth.js';
+export type { Wallet } from './internal/rpcSchemas/wallet.js';
+/**
+ * Instantiates a statically typed Schema. This is a runtime-noop function, and is purposed
+ * to be used as a type-level tag to be used with {@link ox#Provider.(from:function)} or
+ * {@link ox#RpcTransport.(fromHttp:function)}.
+ *
+ * @example
+ * ### Using with `Provider.from`
+ *
+ * ```ts twoslash
+ * // @noErrors
+ * import 'ox/window'
+ * import { Provider, RpcSchema } from 'ox'
+ *
+ * const schema = RpcSchema.from<
+ *   | RpcSchema.Default
+ *   | {
+ *       Request: {
+ *         method: 'abe_foo',
+ *         params: [id: number],
+ *       }
+ *       ReturnType: string
+ *     }
+ *   | {
+ *       Request: {
+ *         method: 'abe_bar',
+ *         params: [id: string],
+ *       }
+ *       ReturnType: string
+ *     }
+ * >()
+ *
+ * const provider = Provider.from(window.ethereum, { schema })
+ *
+ * const blockNumber = await provider.request({ method: 'e' })
+ * //                                                    ^|
+ *
+ *
+ *
+ *
+ *
+ * ```
+ */
+export declare function from<schema extends Generic>(): schema;
+/**
+ * Extracts a schema item from a {@link ox#RpcSchema.Generic} or {@link ox#RpcSchema.MethodNameGeneric}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { RpcSchema } from 'ox'
+ *
+ * type Item = RpcSchema.ExtractItem<RpcSchema.Eth, 'eth_getBlockByNumber'>
+ * //   ^?
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * ```
+ */
+export type ExtractItem<schema extends Generic, methodName extends MethodNameGeneric<schema> = MethodNameGeneric<schema>> = Compute<{
+    Request: ExtractRequest<schema, methodName>;
+    ReturnType: ExtractReturnType<schema, methodName>;
+}>;
+/**
+ * Extracts request from a {@link ox#RpcSchema.Generic} or {@link ox#RpcSchema.MethodNameGeneric}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { RpcSchema } from 'ox'
+ *
+ * type Request = RpcSchema.ExtractRequest<RpcSchema.Eth, 'eth_getBlockByNumber'>
+ * //   ^?
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * ```
+ */
+export type ExtractRequest<schema extends Generic, methodName extends MethodNameGeneric<schema> = MethodNameGeneric<schema>> = Extract<schema['Request'], {
+    method: methodName;
+}>;
+/**
+ * Type-safe union of all JSON-RPC Method Names.
+ *
+ * @example
+ * ```ts twoslash
+ * import { RpcSchema } from 'ox'
+ *
+ * type MethodName = RpcSchema.ExtractMethodName<RpcSchema.Default>
+ * //   ^?
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * ```
+ */
+export type ExtractMethodName<schema extends Generic> = schema['Request']['method'];
+/**
+ * Extracts parameters from a {@link ox#RpcSchema.Generic} or {@link ox#RpcSchema.MethodNameGeneric}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { RpcSchema } from 'ox'
+ *
+ * type Eth_GetBlockByNumber = RpcSchema.ExtractParams<RpcSchema.Eth, 'eth_getBlockByNumber'>
+ * //   ^?
+ *
+ *
+ *
+ *
+ *
+ * ```
+ */
+export type ExtractParams<schema extends Generic, methodName extends MethodNameGeneric<schema> = MethodNameGeneric<schema>> = ExtractRequest<schema, methodName>['params'];
+/**
+ * Extracts return type from a {@link ox#RpcSchema.Generic} or {@link ox#RpcSchema.MethodNameGeneric}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { RpcSchema } from 'ox'
+ *
+ * type ReturnType = RpcSchema.ExtractReturnType<RpcSchema.Eth, 'eth_getBlockByNumber'>
+ * //   ^?
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * ```
+ */
+export type ExtractReturnType<schema extends Generic, methodName extends MethodNameGeneric<schema> = MethodNameGeneric<schema>> = methodName extends schema['Request']['method'] ? IsNarrowable<schema, Generic> extends true ? Extract<schema, {
+    Request: {
+        method: methodName;
+    };
+}>['ReturnType'] : unknown : unknown;
+/**
+ * Type to define a custom type-safe JSON-RPC Schema.
+ *
+ * @example
+ * ```ts twoslash
+ * import { RpcSchema, RpcRequest } from 'ox'
+ *
+ * type Schema = RpcSchema.From<{
+ *   Request: {
+ *     method: 'eth_foobar',
+ *     params: [id: number],
+ *   }
+ *   ReturnType: string
+ * }>
+ * ```
+ */
+export type From<schema extends Generic> = schema;
+/**
+ * Generic type to define a JSON-RPC Method.
+ *
+ * @example
+ * ```ts twoslash
+ * import { RpcSchema } from 'ox'
+ *
+ * type Schema = RpcSchema.Generic
+ * //   ^?
+ *
+ *
+ *
+ *
+ *
+ *
+ * ```
+ */
+export type Generic<name extends string = string, params = unknown> = {
+    Request: {
+        method: name;
+        params?: params | undefined;
+    };
+    ReturnType?: unknown;
+};
+/**
+ * Type-safe union of all JSON-RPC Methods.
+ *
+ * @example
+ * ```ts twoslash
+ * import { RpcSchema } from 'ox'
+ *
+ * type Schema = RpcSchema.Default
+ * //   ^?
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * ```
+ */
+export type Default = ResolvedRegister['RpcSchema'];
+/**
+ * Generic type to define a JSON-RPC Method Name.
+ *
+ * @example
+ * ```ts twoslash
+ * import { RpcSchema } from 'ox'
+ *
+ * type Name = RpcSchema.MethodNameGeneric
+ * //   ^?
+ *
+ *
+ *
+ *
+ *
+ * ```
+ */
+export type MethodNameGeneric<schema extends Generic = Generic> = schema['Request']['method'] | (string & {});
+//# sourceMappingURL=RpcSchema.d.ts.map

package/_types/RpcSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RpcSchema.d.ts","sourceRoot":"","sources":["../RpcSchema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AAC9D,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAEhE,YAAY,EAAE,GAAG,EAAE,MAAM,8BAA8B,CAAA;AACvD,YAAY,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAA;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAgB,IAAI,CAAC,MAAM,SAAS,OAAO,KAAK,MAAM,CAErD;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,WAAW,CACrB,MAAM,SAAS,OAAO,EACtB,UAAU,SAAS,iBAAiB,CAAC,MAAM,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC,IACtE,OAAO,CAAC;IACV,OAAO,EAAE,cAAc,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IAC3C,UAAU,EAAE,iBAAiB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;CAClD,CAAC,CAAA;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,MAAM,cAAc,CACxB,MAAM,SAAS,OAAO,EACtB,UAAU,SAAS,iBAAiB,CAAC,MAAM,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC,IACtE,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;IAAE,MAAM,EAAE,UAAU,CAAA;CAAE,CAAC,CAAA;AAEtD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,iBAAiB,CAAC,MAAM,SAAS,OAAO,IAClD,MAAM,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAA;AAE7B;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,aAAa,CACvB,MAAM,SAAS,OAAO,EACtB,UAAU,SAAS,iBAAiB,CAAC,MAAM,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC,IACtE,cAAc,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAA;AAEhD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,MAAM,iBAAiB,CAC3B,MAAM,SAAS,OAAO,EACtB,UAAU,SAAS,iBAAiB,CAAC,MAAM,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC,IACtE,UAAU,SAAS,MAAM,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,GAC9C,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,IAAI,GACxC,OAAO,CAAC,MAAM,EAAE;IAAE,OAAO,EAAE;QAAE,MAAM,EAAE,UAAU,CAAA;KAAE,CAAA;CAAE,CAAC,CAAC,YAAY,CAAC,GAClE,OAAO,GACT,OAAO,CAAA;AAEX;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,IAAI,CAAC,MAAM,SAAS,OAAO,IAAI,MAAM,CAAA;AAEjD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,OAAO,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,OAAO,IAAI;IACpE,OAAO,EAAE;QACP,MAAM,EAAE,IAAI,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAC5B,CAAA;IACD,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,OAAO,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAA;AAEnD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,iBAAiB,CAAC,MAAM,SAAS,OAAO,GAAG,OAAO,IAC1D,MAAM,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,GAC3B,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA"}

package/_types/RpcTransport.d.ts

@@ -0,0 +1,65 @@
+import * as Errors from './Errors.js';
+import type * as RpcResponse from './RpcResponse.js';
+import type * as RpcSchema from './RpcSchema.js';
+import * as promise from './internal/promise.js';
+import type * as RpcSchema_internal from './internal/rpcSchema.js';
+import * as internal from './internal/rpcTransport.js';
+import type { Compute } from './internal/types.js';
+/** Root type for an RPC Transport. */
+export type RpcTransport<raw extends boolean = false, options extends Record<string, unknown> = {}, schema extends RpcSchema.Generic = RpcSchema.Default> = Compute<{
+    request: RequestFn<raw, options, schema>;
+}>;
+/** HTTP-based RPC Transport. */
+export type Http<raw extends boolean = false, schema extends RpcSchema.Generic = RpcSchema.Default> = RpcTransport<raw, HttpOptions, schema>;
+export type HttpOptions = {
+    /** Request configuration to pass to `fetch`. */
+    fetchOptions?: Omit<RequestInit, 'body'> | ((method: RpcSchema.Generic['Request']) => Omit<RequestInit, 'body'> | Promise<Omit<RequestInit, 'body'>>) | undefined;
+    /** Function to use to make the request. @default fetch */
+    fetchFn?: typeof fetch | undefined;
+    /** Timeout for the request in milliseconds. @default 10_000 */
+    timeout?: number | undefined;
+};
+export type RequestFn<raw extends boolean = false, options extends Record<string, unknown> = {}, schema extends RpcSchema.Generic = RpcSchema.Default> = <methodName extends RpcSchema.MethodNameGeneric, raw_override extends boolean | undefined = undefined>(parameters: Compute<RpcSchema_internal.ExtractRequestOpaque<schema, methodName>>, options?: internal.Options<raw_override, options, schema> | undefined) => Promise<raw_override extends boolean ? raw_override extends true ? RpcResponse.RpcResponse<RpcSchema.ExtractReturnType<schema, methodName>> : RpcSchema.ExtractReturnType<schema, methodName> : raw extends true ? RpcResponse.RpcResponse<RpcSchema.ExtractReturnType<schema, methodName>> : RpcSchema.ExtractReturnType<schema, methodName>>;
+/**
+ * Creates a HTTP JSON-RPC Transport from a URL.
+ *
+ * @example
+ * ```ts twoslash
+ * import { RpcTransport } from 'ox'
+ *
+ * const transport = RpcTransport.fromHttp('https://1.rpc.thirdweb.com')
+ *
+ * const blockNumber = await transport.request({ method: 'eth_blockNumber' })
+ * // @log: '0x1a2b3c'
+ * ```
+ *
+ * @param url - URL to perform the JSON-RPC requests to.
+ * @param options - Transport options.
+ * @returns HTTP JSON-RPC Transport.
+ */
+export declare function fromHttp<raw extends boolean = false, schema extends RpcSchema.Generic = RpcSchema.Default>(url: string, options?: fromHttp.Options<raw, schema>): Http<raw, schema>;
+export declare namespace fromHttp {
+    var parseError: (error: unknown) => fromHttp.ErrorType;
+}
+export declare namespace fromHttp {
+    type Options<raw extends boolean = false, schema extends RpcSchema.Generic = RpcSchema.Default> = internal.Options<raw, HttpOptions, schema>;
+    type ErrorType = promise.withTimeout.ErrorType | HttpError | Errors.GlobalErrorType;
+}
+/** Thrown when a HTTP request fails. */
+export declare class HttpError extends Errors.BaseError {
+    readonly name = "RpcTransport.HttpError";
+    constructor({ body, details, response, url, }: {
+        body: unknown;
+        details: string;
+        response: Response;
+        url: string;
+    });
+}
+/** Thrown when a HTTP response is malformed. */
+export declare class MalformedResponseError extends Errors.BaseError {
+    readonly name = "RpcTransport.MalformedResponseError";
+    constructor({ response }: {
+        response: string;
+    });
+}
+//# sourceMappingURL=RpcTransport.d.ts.map

package/_types/RpcTransport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RpcTransport.d.ts","sourceRoot":"","sources":["../RpcTransport.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,KAAK,WAAW,MAAM,kBAAkB,CAAA;AACpD,OAAO,KAAK,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAEhD,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAA;AAChD,OAAO,KAAK,KAAK,kBAAkB,MAAM,yBAAyB,CAAA;AAClE,OAAO,KAAK,QAAQ,MAAM,4BAA4B,CAAA;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAElD,sCAAsC;AACtC,MAAM,MAAM,YAAY,CACtB,GAAG,SAAS,OAAO,GAAG,KAAK,EAC3B,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,EAC5C,MAAM,SAAS,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,OAAO,IAClD,OAAO,CAAC;IACV,OAAO,EAAE,SAAS,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;CACzC,CAAC,CAAA;AAEF,gCAAgC;AAChC,MAAM,MAAM,IAAI,CACd,GAAG,SAAS,OAAO,GAAG,KAAK,EAC3B,MAAM,SAAS,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,OAAO,IAClD,YAAY,CAAC,GAAG,EAAE,WAAW,EAAE,MAAM,CAAC,CAAA;AAE1C,MAAM,MAAM,WAAW,GAAG;IACxB,gDAAgD;IAChD,YAAY,CAAC,EACT,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,GACzB,CAAC,CACC,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,KACjC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC,GACpE,SAAS,CAAA;IACb,0DAA0D;IAC1D,OAAO,CAAC,EAAE,OAAO,KAAK,GAAG,SAAS,CAAA;IAClC,+DAA+D;IAC/D,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,SAAS,CACnB,GAAG,SAAS,OAAO,GAAG,KAAK,EAC3B,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,EAC5C,MAAM,SAAS,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,OAAO,IAClD,CACF,UAAU,SAAS,SAAS,CAAC,iBAAiB,EAC9C,YAAY,SAAS,OAAO,GAAG,SAAS,GAAG,SAAS,EAEpD,UAAU,EAAE,OAAO,CACjB,kBAAkB,CAAC,oBAAoB,CAAC,MAAM,EAAE,UAAU,CAAC,CAC5D,EACD,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,GAAG,SAAS,KAClE,OAAO,CACV,YAAY,SAAS,OAAO,GACxB,YAAY,SAAS,IAAI,GACvB,WAAW,CAAC,WAAW,CAAC,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,GACxE,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,UAAU,CAAC,GACjD,GAAG,SAAS,IAAI,GACd,WAAW,CAAC,WAAW,CAAC,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,GACxE,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,UAAU,CAAC,CACtD,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,QAAQ,CACtB,GAAG,SAAS,OAAO,GAAG,KAAK,EAC3B,MAAM,SAAS,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,OAAO,EACpD,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAM,GAAG,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAqE7E;yBAxEe,QAAQ;4BAsFM,OAAO,KAE1B,QAAQ,CAAC,SAAS;;AAd7B,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,KAAK,OAAO,CACV,GAAG,SAAS,OAAO,GAAG,KAAK,EAC3B,MAAM,SAAS,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,OAAO,IAClD,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,WAAW,EAAE,MAAM,CAAC,CAAA;IAE9C,KAAK,SAAS,GACV,OAAO,CAAC,WAAW,CAAC,SAAS,GAC7B,SAAS,GACT,MAAM,CAAC,eAAe,CAAA;CAC3B;AAMD,wCAAwC;AACxC,qBAAa,SAAU,SAAQ,MAAM,CAAC,SAAS;IAC7C,SAAkB,IAAI,4BAA2B;gBAErC,EACV,IAAI,EACJ,OAAO,EACP,QAAQ,EACR,GAAG,GACJ,EAAE;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,QAAQ,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE;CAUvE;AAED,gDAAgD;AAChD,qBAAa,sBAAuB,SAAQ,MAAM,CAAC,SAAS;IAC1D,SAAkB,IAAI,yCAAwC;gBAElD,EAAE,QAAQ,EAAE,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE;CAK/C"}