@faremeter/types 0.16.0 → 0.17.1

package/dist/src/client.d.ts

@@ -1,13 +1,78 @@
-import { x402PaymentRequirements } from "./x402.js";
+import type { x402PaymentRequirements as x402PaymentRequirementsV1 } from "./x402.js";
+import type { x402PaymentRequirements } from "./x402v2.js";
+import { type NetworkTranslator } from "./x402-adapters.js";
 export type RequestContext = {
     request: RequestInfo | URL;
 };
 export type PaymentExecResult = {
     payload: object;
 };
+/**
+ * Payment execer - the primary interface for payment execution.
+ * Uses requirements with the `amount` field.
+ */
 export type PaymentExecer = {
     requirements: x402PaymentRequirements;
     exec(): Promise<PaymentExecResult>;
 };
+/**
+ * Payment handler - the primary interface for payment handlers.
+ * Receives requirements and returns execers.
+ */
 export type PaymentHandler = (context: RequestContext, accepts: x402PaymentRequirements[]) => Promise<PaymentExecer[]>;
+/**
+ * V1 requirements with mimeType guaranteed to be a string.
+ * Used for compatibility with legacy handlers that expect mimeType to be required.
+ */
+type x402PaymentRequirementsV1Strict = x402PaymentRequirementsV1 & {
+    mimeType: string;
+};
+/**
+ * @deprecated Use PaymentExecer instead
+ */
+export type PaymentExecerV1 = {
+    requirements: x402PaymentRequirementsV1;
+    exec(): Promise<PaymentExecResult>;
+};
+/**
+ * Legacy payment execer type for handlers that expect mimeType to be required.
+ * @deprecated Use PaymentExecer instead
+ */
+type PaymentExecerV1Strict = {
+    requirements: x402PaymentRequirementsV1Strict;
+    exec(): Promise<PaymentExecResult>;
+};
+/**
+ * @deprecated Use PaymentHandler instead
+ */
+export type PaymentHandlerV1 = (context: RequestContext, accepts: x402PaymentRequirementsV1[]) => Promise<PaymentExecerV1[]>;
+/**
+ * Legacy payment handler type for handlers that expect mimeType to be required.
+ * @deprecated Use PaymentHandler instead
+ */
+type PaymentHandlerV1Strict = (context: RequestContext, accepts: x402PaymentRequirementsV1Strict[]) => Promise<PaymentExecerV1Strict[]>;
+/**
+ * Adapt a v1 PaymentHandlerV1 to the PaymentHandler interface.
+ *
+ * This allows existing v1 payment handlers to be used with v2 infrastructure.
+ * Requirements are converted from v2 to v1 before being passed to the handler,
+ * and the resulting execers are wrapped to convert requirements back to v2.
+ *
+ * Accepts both spec-compliant handlers (with optional mimeType) and legacy
+ * handlers (with required mimeType) for backwards compatibility.
+ *
+ * @param handler - The v1 payment handler to adapt
+ * @param translateNetwork - Function to translate legacy network IDs to CAIP-2
+ */
+export declare function adaptPaymentHandlerV1ToV2(handler: PaymentHandlerV1 | PaymentHandlerV1Strict, translateNetwork: NetworkTranslator): PaymentHandler;
+/**
+ * Adapt a PaymentHandler to the v1 PaymentHandlerV1 interface.
+ *
+ * This allows v2 payment handlers to be used with v1 infrastructure.
+ *
+ * @param handler - The v2 payment handler to adapt
+ * @param translateNetwork - Function to translate legacy network IDs to CAIP-2
+ */
+export declare function adaptPaymentHandlerV2ToV1(handler: PaymentHandler, translateNetwork: NetworkTranslator): PaymentHandlerV1;
+export {};
 //# sourceMappingURL=client.d.ts.map

package/dist/src/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,QAAQ,CAAC;AAEjD,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,WAAW,GAAG,GAAG,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,YAAY,EAAE,uBAAuB,CAAC;IACtC,IAAI,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,CAC3B,OAAO,EAAE,cAAc,EACvB,OAAO,EAAE,uBAAuB,EAAE,KAC/B,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,IAAI,yBAAyB,EAAE,MAAM,QAAQ,CAAC;AACnF,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAC;AACxD,OAAO,EAGL,KAAK,iBAAiB,EACvB,MAAM,iBAAiB,CAAC;AAEzB,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,WAAW,GAAG,GAAG,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,YAAY,EAAE,uBAAuB,CAAC;IACtC,IAAI,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACpC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,CAC3B,OAAO,EAAE,cAAc,EACvB,OAAO,EAAE,uBAAuB,EAAE,KAC/B,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;AAE9B;;;GAGG;AACH,KAAK,+BAA+B,GAAG,yBAAyB,GAAG;IACjE,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,YAAY,EAAE,yBAAyB,CAAC;IACxC,IAAI,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACpC,CAAC;AAEF;;;GAGG;AACH,KAAK,qBAAqB,GAAG;IAC3B,YAAY,EAAE,+BAA+B,CAAC;IAC9C,IAAI,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAC7B,OAAO,EAAE,cAAc,EACvB,OAAO,EAAE,yBAAyB,EAAE,KACjC,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;AAEhC;;;GAGG;AACH,KAAK,sBAAsB,GAAG,CAC5B,OAAO,EAAE,cAAc,EACvB,OAAO,EAAE,+BAA+B,EAAE,KAEvC,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAAC;AAEtC;;;;;;;;;;;;GAYG;AACH,wBAAgB,yBAAyB,CAEvC,OAAO,EAAE,gBAAgB,GAAG,sBAAsB,EAClD,gBAAgB,EAAE,iBAAiB,GAClC,cAAc,CAwBhB;AAED;;;;;;;GAOG;AACH,wBAAgB,yBAAyB,CACvC,OAAO,EAAE,cAAc,EACvB,gBAAgB,EAAE,iBAAiB,GAElC,gBAAgB,CAoBlB"}

package/dist/src/client.js

@@ -1 +1,52 @@
-import { x402PaymentRequirements } from "./x402.js";
+import { adaptRequirementsV1ToV2, adaptRequirementsV2ToV1, } from "./x402-adapters.js";
+/**
+ * Adapt a v1 PaymentHandlerV1 to the PaymentHandler interface.
+ *
+ * This allows existing v1 payment handlers to be used with v2 infrastructure.
+ * Requirements are converted from v2 to v1 before being passed to the handler,
+ * and the resulting execers are wrapped to convert requirements back to v2.
+ *
+ * Accepts both spec-compliant handlers (with optional mimeType) and legacy
+ * handlers (with required mimeType) for backwards compatibility.
+ *
+ * @param handler - The v1 payment handler to adapt
+ * @param translateNetwork - Function to translate legacy network IDs to CAIP-2
+ */
+export function adaptPaymentHandlerV1ToV2(
+// eslint-disable-next-line @typescript-eslint/no-deprecated -- adapter for legacy v1 handlers
+handler, translateNetwork) {
+    return async (context, accepts) => {
+        // Convert v2 requirements to v1 for the handler
+        // adaptRequirementsV2ToV1 always provides mimeType as a string
+        const v1Accepts = accepts.map((req) => adaptRequirementsV2ToV1(req, { url: "" }));
+        // Call the v1 handler - v1Accepts has mimeType: string so it works with both
+        // PaymentHandlerV1 and PaymentHandlerV1Strict
+        const v1Execers = await handler(context, v1Accepts);
+        // Wrap v1 execers to return v2 requirements
+        return v1Execers.map((execer) => ({
+            requirements: adaptRequirementsV1ToV2(execer.requirements, translateNetwork),
+            exec: () => execer.exec(),
+        }));
+    };
+}
+/**
+ * Adapt a PaymentHandler to the v1 PaymentHandlerV1 interface.
+ *
+ * This allows v2 payment handlers to be used with v1 infrastructure.
+ *
+ * @param handler - The v2 payment handler to adapt
+ * @param translateNetwork - Function to translate legacy network IDs to CAIP-2
+ */
+export function adaptPaymentHandlerV2ToV1(handler, translateNetwork) {
+    return async (context, accepts) => {
+        // Convert v1 requirements to v2 for the handler
+        const v2Accepts = accepts.map((req) => adaptRequirementsV1ToV2(req, translateNetwork));
+        // Call the v2 handler
+        const v2Execers = await handler(context, v2Accepts);
+        // Wrap v2 execers to return v1 requirements
+        return v2Execers.map((execer) => ({
+            requirements: adaptRequirementsV2ToV1(execer.requirements, { url: "" }),
+            exec: () => execer.exec(),
+        }));
+    };
+}

package/dist/src/evm.d.ts

@@ -1,8 +1,26 @@
+/**
+ * Validator for EVM hex addresses (40 hex characters, optional 0x prefix).
+ */
 export declare const Address: import("arktype/internal/methods/string.ts").StringType<`0x${string}`, {}>;
 export type Address = typeof Address.infer;
+/**
+ * Type guard that checks if a value is a valid EVM address.
+ *
+ * @param maybe - The value to check
+ * @returns True if the value matches the EVM address format
+ */
 export declare function isAddress(maybe: unknown): maybe is Address;
+/**
+ * Validator for EVM private keys (64 hex characters with 0x prefix).
+ */
 export declare const PrivateKey: import("arktype/internal/methods/string.ts").StringType<`0x${string}`, {}>;
 export type PrivateKey = typeof Address.infer;
+/**
+ * Type guard that checks if a value is a valid EVM private key.
+ *
+ * @param maybe - The value to check
+ * @returns True if the value matches the private key format
+ */
 export declare function isPrivateKey(maybe: unknown): maybe is PrivateKey;
 export type ChainInfo = {
     id: number;

package/dist/src/evm.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"evm.d.ts","sourceRoot":"","sources":["../../src/evm.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,OAAO,4EAEnB,CAAC;AACF,MAAM,MAAM,OAAO,GAAG,OAAO,OAAO,CAAC,KAAK,CAAC;AAE3C,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,OAAO,CAE1D;AAED,eAAO,MAAM,UAAU,4EAEtB,CAAC;AACF,MAAM,MAAM,UAAU,GAAG,OAAO,OAAO,CAAC,KAAK,CAAC;AAE9C,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,UAAU,CAEhE;AAKD,MAAM,MAAM,SAAS,GAAG;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG;IACzC,OAAO,EAAE;QACP,OAAO,EAAE;YACP,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;SACzB,CAAC;KACH,CAAC;CACH,CAAC"}
+{"version":3,"file":"evm.d.ts","sourceRoot":"","sources":["../../src/evm.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,eAAO,MAAM,OAAO,4EAEnB,CAAC;AACF,MAAM,MAAM,OAAO,GAAG,OAAO,OAAO,CAAC,KAAK,CAAC;AAE3C;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,OAAO,CAE1D;AAED;;GAEG;AACH,eAAO,MAAM,UAAU,4EAEtB,CAAC;AACF,MAAM,MAAM,UAAU,GAAG,OAAO,OAAO,CAAC,KAAK,CAAC;AAE9C;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,UAAU,CAEhE;AAGD,MAAM,MAAM,SAAS,GAAG;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG;IACzC,OAAO,EAAE;QACP,OAAO,EAAE;YACP,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;SACzB,CAAC;KACH,CAAC;CACH,CAAC"}

package/dist/src/evm.js

@@ -1,10 +1,28 @@
 import { type } from "arktype";
 import { isValidationError } from "./validation.js";
+/**
+ * Validator for EVM hex addresses (40 hex characters, optional 0x prefix).
+ */
 export const Address = type(/^(0x)?[0-9a-fA-F]{40}$/);
+/**
+ * Type guard that checks if a value is a valid EVM address.
+ *
+ * @param maybe - The value to check
+ * @returns True if the value matches the EVM address format
+ */
 export function isAddress(maybe) {
     return !isValidationError(Address(maybe));
 }
+/**
+ * Validator for EVM private keys (64 hex characters with 0x prefix).
+ */
 export const PrivateKey = type(/^0x[0-9a-fA-F]{64}$/);
+/**
+ * Type guard that checks if a value is a valid EVM private key.
+ *
+ * @param maybe - The value to check
+ * @returns True if the value matches the private key format
+ */
 export function isPrivateKey(maybe) {
     return !isValidationError(PrivateKey(maybe));
 }

package/dist/src/facilitator.d.ts

@@ -1,8 +1,29 @@
-import { x402PaymentRequirements, x402SettleResponse, x402PaymentPayload, x402SupportedKind, x402VerifyResponse } from "./x402.js";
-export type FacilitatorHandler = {
+import type { x402PaymentRequirements, x402SettleResponse, x402PaymentPayload, x402SupportedKind, x402VerifyResponse, x402ResourceInfo } from "./x402v2.js";
+/**
+ * Arguments passed to the facilitator's getRequirements method.
+ */
+export interface GetRequirementsArgs {
+    /** Payment requirements the server is willing to accept */
+    accepts: x402PaymentRequirements[];
+    /** Optional resource information for the protected content */
+    resource?: x402ResourceInfo;
+}
+/**
+ * Handler interface implemented by payment scheme facilitators.
+ *
+ * Each method returns null when the request doesn't match the handler's
+ * payment scheme, allowing multiple handlers to be composed.
+ */
+export interface FacilitatorHandler {
+    /** Returns the payment schemes this handler supports */
     getSupported?: () => Promise<x402SupportedKind>[];
-    getRequirements: (req: x402PaymentRequirements[]) => Promise<x402PaymentRequirements[]>;
+    /** Filters and enriches payment requirements this handler can process */
+    getRequirements: (args: GetRequirementsArgs) => Promise<x402PaymentRequirements[]>;
+    /** Verifies a payment without settling it (optional) */
     handleVerify?: (requirements: x402PaymentRequirements, payment: x402PaymentPayload) => Promise<x402VerifyResponse | null>;
+    /** Settles a payment by executing the on-chain transaction */
     handleSettle: (requirements: x402PaymentRequirements, payment: x402PaymentPayload) => Promise<x402SettleResponse | null>;
-};
+    /** Returns signer addresses organized by network (optional) */
+    getSigners?: () => Promise<Record<string, string[]>>;
+}
 //# sourceMappingURL=facilitator.d.ts.map

package/dist/src/facilitator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"facilitator.d.ts","sourceRoot":"","sources":["../../src/facilitator.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EACnB,MAAM,QAAQ,CAAC;AAEhB,MAAM,MAAM,kBAAkB,GAAG;IAC/B,YAAY,CAAC,EAAE,MAAM,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC;IAClD,eAAe,EAAE,CACf,GAAG,EAAE,uBAAuB,EAAE,KAC3B,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC;IACxC,YAAY,CAAC,EAAE,CACb,YAAY,EAAE,uBAAuB,EACrC,OAAO,EAAE,kBAAkB,KACxB,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;IACxC,YAAY,EAAE,CACZ,YAAY,EAAE,uBAAuB,EACrC,OAAO,EAAE,kBAAkB,KACxB,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;CACzC,CAAC"}
+{"version":3,"file":"facilitator.d.ts","sourceRoot":"","sources":["../../src/facilitator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uBAAuB,EACvB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EACjB,MAAM,UAAU,CAAC;AAElB;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,2DAA2D;IAC3D,OAAO,EAAE,uBAAuB,EAAE,CAAC;IACnC,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,wDAAwD;IACxD,YAAY,CAAC,EAAE,MAAM,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC;IAClD,yEAAyE;IACzE,eAAe,EAAE,CACf,IAAI,EAAE,mBAAmB,KACtB,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC;IACxC,wDAAwD;IACxD,YAAY,CAAC,EAAE,CACb,YAAY,EAAE,uBAAuB,EACrC,OAAO,EAAE,kBAAkB,KACxB,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;IACxC,8DAA8D;IAC9D,YAAY,EAAE,CACZ,YAAY,EAAE,uBAAuB,EACrC,OAAO,EAAE,kBAAkB,KACxB,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;IACxC,+DAA+D;IAC/D,UAAU,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;CACtD"}

package/dist/src/facilitator.js

@@ -1 +1 @@
-import { x402PaymentRequirements, x402SettleResponse, x402PaymentPayload, x402SupportedKind, x402VerifyResponse, } from "./x402.js";
+export {};

package/dist/src/index.d.ts

@@ -1,8 +1,51 @@
+/**
+ * @title Types Package
+ * @sidebarTitle Types
+ * @description TypeScript type definitions and validators for the x402 protocol
+ * @packageDocumentation
+ */
+/**
+ * @title x402 Protocol Types (v1)
+ * @sidebarTitle Types / x402 v1
+ * @description Type definitions for x402 v1 protocol messages and payloads
+ */
 export * as x402 from "./x402.js";
+/**
+ * @title x402 Protocol Types (v2)
+ * @sidebarTitle Types / x402 v2
+ * @description Type definitions for x402 v2 protocol messages and payloads
+ */
+export * as x402v2 from "./x402v2.js";
+/**
+ * @title x402 Version Adapters
+ * @sidebarTitle Types / Adapters
+ * @description Conversion utilities between x402 v1 and v2 protocol formats
+ */
+export * as x402Adapters from "./x402-adapters.js";
+/**
+ * @title Client Types
+ * @sidebarTitle Types / Client
+ * @description Type definitions for payment handlers and execers
+ */
 export * as client from "./client.js";
+/**
+ * @title Facilitator Types
+ * @sidebarTitle Types / Facilitator
+ * @description Type definitions for facilitator handlers and requirements
+ */
 export * as facilitator from "./facilitator.js";
 export * from "./validation.js";
 export * from "./literal.js";
+/**
+ * @title Solana Types
+ * @sidebarTitle Types / Solana
+ * @description Type definitions for Solana base58 addresses
+ */
 export * as solana from "./solana.js";
+/**
+ * @title EVM Types
+ * @sidebarTitle Types / EVM
+ * @description Type definitions for EVM addresses, private keys, and chains
+ */
 export * as evm from "./evm.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,WAAW,MAAM,eAAe,CAAC;AAC7C,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH;;;;GAIG;AACH,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B;;;;GAIG;AACH,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC;;;;GAIG;AACH,OAAO,KAAK,YAAY,MAAM,iBAAiB,CAAC;AAChD;;;;GAIG;AACH,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC;;;;GAIG;AACH,OAAO,KAAK,WAAW,MAAM,eAAe,CAAC;AAC7C,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B;;;;GAIG;AACH,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC;;;;GAIG;AACH,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC"}

package/dist/src/index.js

@@ -1,7 +1,50 @@
+/**
+ * @title Types Package
+ * @sidebarTitle Types
+ * @description TypeScript type definitions and validators for the x402 protocol
+ * @packageDocumentation
+ */
+/**
+ * @title x402 Protocol Types (v1)
+ * @sidebarTitle Types / x402 v1
+ * @description Type definitions for x402 v1 protocol messages and payloads
+ */
 export * as x402 from "./x402.js";
+/**
+ * @title x402 Protocol Types (v2)
+ * @sidebarTitle Types / x402 v2
+ * @description Type definitions for x402 v2 protocol messages and payloads
+ */
+export * as x402v2 from "./x402v2.js";
+/**
+ * @title x402 Version Adapters
+ * @sidebarTitle Types / Adapters
+ * @description Conversion utilities between x402 v1 and v2 protocol formats
+ */
+export * as x402Adapters from "./x402-adapters.js";
+/**
+ * @title Client Types
+ * @sidebarTitle Types / Client
+ * @description Type definitions for payment handlers and execers
+ */
 export * as client from "./client.js";
+/**
+ * @title Facilitator Types
+ * @sidebarTitle Types / Facilitator
+ * @description Type definitions for facilitator handlers and requirements
+ */
 export * as facilitator from "./facilitator.js";
 export * from "./validation.js";
 export * from "./literal.js";
+/**
+ * @title Solana Types
+ * @sidebarTitle Types / Solana
+ * @description Type definitions for Solana base58 addresses
+ */
 export * as solana from "./solana.js";
+/**
+ * @title EVM Types
+ * @sidebarTitle Types / EVM
+ * @description Type definitions for EVM addresses, private keys, and chains
+ */
 export * as evm from "./evm.js";

package/dist/src/literal.d.ts

@@ -1,2 +1,10 @@
+/**
+ * Creates an arktype validator for case-insensitive string literals.
+ *
+ * Input strings are lowercased before matching against the allowed values.
+ *
+ * @param l - The literal string values to accept (case-insensitive)
+ * @returns An arktype validator that accepts any case variant of the literals
+ */
 export declare function caseInsensitiveLiteral<T extends string>(...l: T[]): import("arktype/internal/methods/instantiate.ts").instantiateType<(Extract<[((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_1 ? T_1 extends Lowercase<T> ? T_1 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_1> : never : never, import("arktype/internal/attributes.ts").InferredMorph<any, import("arktype").Out<any>>> extends " anyOrNever" ? never : Extract<[((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_2 ? T_2 extends Lowercase<T> ? T_2 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_2> : never : never, import("arktype/internal/attributes.ts").InferredMorph<any, import("arktype").Out<any>>> extends import("arktype/internal/attributes.ts").InferredMorph<infer i, infer o extends import("arktype").Out<any>> ? [([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_3 ? T_3 extends Lowercase<T> ? T_3 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_3> : never : never) extends infer T_4 ? T_4 extends ([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_5 ? T_5 extends Lowercase<T> ? T_5 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_5> : never : never) ? T_4 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer o_1 extends import("arktype").Out<any>> ? [o_1] extends [import("arktype/internal/attributes.ts").To<infer unwrappedOut>] ? import("arktype/internal/attributes.ts").To<unwrappedOut> : o_1 : never : never : never] extends [o] ? (In: ([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_6 ? T_6 extends Lowercase<T> ? T_6 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_6> : never : never) extends infer T_7 ? T_7 extends ([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_8 ? T_8 extends Lowercase<T> ? T_8 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_8> : never : never) ? T_7 extends import("arktype/internal/attributes.ts").InferredMorph<infer i_1, import("arktype").Out<any>> ? i_1 : never : never : never) => o & (([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_9 ? T_9 extends Lowercase<T> ? T_9 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_9> : never : never) extends infer T_10 ? T_10 extends ([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_11 ? T_11 extends Lowercase<T> ? T_11 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_11> : never : never) ? T_10 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer o_1 extends import("arktype").Out<any>> ? [o_1] extends [import("arktype/internal/attributes.ts").To<infer unwrappedOut>] ? import("arktype/internal/attributes.ts").To<unwrappedOut> : o_1 : never : never : never) : [([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_6 ? T_6 extends Lowercase<T> ? T_6 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_6> : never : never) extends infer T_7 ? T_7 extends ([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_8 ? T_8 extends Lowercase<T> ? T_8 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_8> : never : never) ? T_7 extends import("arktype/internal/attributes.ts").InferredMorph<infer i_1, import("arktype").Out<any>> ? i_1 : never : never : never] extends [i] ? (In: i & (([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_9 ? T_9 extends Lowercase<T> ? T_9 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_9> : never : never) extends infer T_10 ? T_10 extends ([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_11 ? T_11 extends Lowercase<T> ? T_11 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_11> : never : never) ? T_10 extends import("arktype/internal/attributes.ts").InferredMorph<infer i_1, import("arktype").Out<any>> ? i_1 : never : never : never)) => ([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_12 ? T_12 extends Lowercase<T> ? T_12 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_12> : never : never) extends infer T_13 ? T_13 extends ([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_14 ? T_14 extends Lowercase<T> ? T_14 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_14> : never : never) ? T_13 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer o_1 extends import("arktype").Out<any>> ? [o_1] extends [import("arktype/internal/attributes.ts").To<infer unwrappedOut>] ? import("arktype/internal/attributes.ts").To<unwrappedOut> : o_1 : never : never : never : [((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_9 ? T_9 extends Lowercase<T> ? T_9 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_9> : never : never : never) | Exclude<[((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_10 ? T_10 extends Lowercase<T> ? T_10 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_10> : never : never, import("arktype/internal/attributes.ts").InferredMorph<any, import("arktype").Out<any>>> extends infer _ ? _ : never, {}> extends infer T_11 ? T_11 extends import("arktype/internal/methods/instantiate.ts").instantiateType<(Extract<[((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_12 ? T_12 extends Lowercase<T> ? T_12 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_12> : never : never, import("arktype/internal/attributes.ts").InferredMorph<any, import("arktype").Out<any>>> extends " anyOrNever" ? never : Extract<[((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_13 ? T_13 extends Lowercase<T> ? T_13 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_13> : never : never, import("arktype/internal/attributes.ts").InferredMorph<any, import("arktype").Out<any>>> extends import("arktype/internal/attributes.ts").InferredMorph<infer i, infer o extends import("arktype").Out<any>> ? [([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_14 ? T_14 extends Lowercase<T> ? T_14 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_14> : never : never) extends infer T_15 ? T_15 extends ([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_16 ? T_16 extends Lowercase<T> ? T_16 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_16> : never : never) ? T_15 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer o_1 extends import("arktype").Out<any>> ? [o_1] extends [import("arktype/internal/attributes.ts").To<infer unwrappedOut>] ? import("arktype/internal/attributes.ts").To<unwrappedOut> : o_1 : never : never : never] extends [o] ? (In: ([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_17 ? T_17 extends Lowercase<T> ? T_17 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_17> : never : never) extends infer T_18 ? T_18 extends ([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_19 ? T_19 extends Lowercase<T> ? T_19 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_19> : never : never) ? T_18 extends import("arktype/internal/attributes.ts").InferredMorph<infer i_1, import("arktype").Out<any>> ? i_1 : never : never : never) => o & (([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_20 ? T_20 extends Lowercase<T> ? T_20 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_20> : never : never) extends infer T_21 ? T_21 extends ([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_22 ? T_22 extends Lowercase<T> ? T_22 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_22> : never : never) ? T_21 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer o_1 extends import("arktype").Out<any>> ? [o_1] extends [import("arktype/internal/attributes.ts").To<infer unwrappedOut>] ? import("arktype/internal/attributes.ts").To<unwrappedOut> : o_1 : never : never : never) : [([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_17 ? T_17 extends Lowercase<T> ? T_17 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_17> : never : never) extends infer T_18 ? T_18 extends ([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_19 ? T_19 extends Lowercase<T> ? T_19 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_19> : never : never) ? T_18 extends import("arktype/internal/attributes.ts").InferredMorph<infer i_1, import("arktype").Out<any>> ? i_1 : never : never : never] extends [i] ? (In: i & (([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_20 ? T_20 extends Lowercase<T> ? T_20 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_20> : never : never) extends infer T_21 ? T_21 extends ([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_22 ? T_22 extends Lowercase<T> ? T_22 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_22> : never : never) ? T_21 extends import("arktype/internal/attributes.ts").InferredMorph<infer i_1, import("arktype").Out<any>> ? i_1 : never : never : never)) => ([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_23 ? T_23 extends Lowercase<T> ? T_23 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_23> : never : never) extends infer T_24 ? T_24 extends ([((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_25 ? T_25 extends Lowercase<T> ? T_25 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_25> : never : never) ? T_24 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer o_1 extends import("arktype").Out<any>> ? [o_1] extends [import("arktype/internal/attributes.ts").To<infer unwrappedOut>] ? import("arktype/internal/attributes.ts").To<unwrappedOut> : o_1 : never : never : never : [((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_20 ? T_20 extends Lowercase<T> ? T_20 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_20> : never : never : never) | Exclude<[((In: string) => import("arktype/internal/attributes.ts").To<string>) & Lowercase<T>] extends [infer t extends " anyOrNever"] ? t : Lowercase<T> extends infer T_21 ? T_21 extends Lowercase<T> ? T_21 extends import("arktype/internal/attributes.ts").InferredMorph<any, infer rOut extends import("arktype").Out<any>> ? (In: string) => rOut : (In: string) => import("arktype/internal/attributes.ts").To<T_21> : never : never, import("arktype/internal/attributes.ts").InferredMorph<any, import("arktype").Out<any>>> extends infer _ ? _ : never, {}> ? T_11 extends infer __1 ? __1 : never : never : never;
 //# sourceMappingURL=literal.d.ts.map

package/dist/src/literal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"literal.d.ts","sourceRoot":"","sources":["../../src/literal.ts"],"names":[],"mappings":"AAEA,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,EAAE,y6iBAMjE"}
+{"version":3,"file":"literal.d.ts","sourceRoot":"","sources":["../../src/literal.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,EAAE,y6iBAMjE"}

package/dist/src/literal.js

@@ -1,4 +1,12 @@
 import { type } from "arktype";
+/**
+ * Creates an arktype validator for case-insensitive string literals.
+ *
+ * Input strings are lowercased before matching against the allowed values.
+ *
+ * @param l - The literal string values to accept (case-insensitive)
+ * @returns An arktype validator that accepts any case variant of the literals
+ */
 export function caseInsensitiveLiteral(...l) {
     return type("string.lower").to(type.enumerated(...l.map((s) => s.toLowerCase())));
 }

package/dist/src/solana.d.ts

@@ -1,4 +1,62 @@
+/**
+ * Validator for Solana base58-encoded addresses.
+ */
 export declare const Base58Address: import("arktype/internal/methods/string.ts").StringType<string, {}>;
 export type Base58Address = typeof Base58Address.infer;
+/**
+ * Type guard that checks if a value is a valid Solana base58 address.
+ *
+ * @param maybe - The value to check
+ * @returns True if the value matches the base58 address format
+ */
 export declare function isBaseAddress(maybe: unknown): maybe is Base58Address;
+/**
+ * Validator for Solana cluster names.
+ */
+export declare const SolanaCluster: import("arktype/internal/methods/string.ts").StringType<"mainnet-beta" | "devnet" | "testnet", {}>;
+export type SolanaCluster = typeof SolanaCluster.infer;
+/**
+ * Type guard that checks if a value is a valid Solana cluster name.
+ *
+ * @param maybe - The value to check
+ * @returns True if the value is a known cluster name
+ */
+export declare function isSolanaCluster(maybe: unknown): maybe is SolanaCluster;
+/**
+ * Validator for Solana CAIP-2 network identifier strings.
+ *
+ * Format: solana:<genesis-hash> where genesis-hash is base58-encoded.
+ */
+export declare const SolanaCAIP2NetworkString: import("arktype/internal/methods/string.ts").StringType<string, {}>;
+/**
+ * Type guard that checks if a value is a valid Solana CAIP-2 network string.
+ *
+ * @param maybe - The value to check
+ * @returns True if the value matches the Solana CAIP-2 format
+ */
+export declare function isSolanaCAIP2NetworkString(maybe: unknown): maybe is string;
+/**
+ * Solana network identifier with associated metadata.
+ */
+export type SolanaCAIP2Network = {
+    readonly hash: string;
+    readonly name?: string;
+    readonly caip2: string;
+};
+/**
+ * Type guard that checks if a value is a SolanaCAIP2Network object.
+ *
+ * @param maybe - The value to check
+ * @returns True if the value is a SolanaCAIP2Network object
+ */
+export declare function isSolanaCAIP2Network(maybe: unknown): maybe is SolanaCAIP2Network;
+/**
+ * Creates a SolanaCAIP2Network object from a CAIP-2 string.
+ *
+ * @param caip2 - The CAIP-2 network identifier string (e.g., "solana:5eykt...")
+ * @param name - Optional display name for the network
+ * @returns A SolanaCAIP2Network object
+ * @throws Error if the CAIP-2 string is invalid
+ */
+export declare function createSolanaNetwork(caip2: string, name?: string): SolanaCAIP2Network;
 //# sourceMappingURL=solana.d.ts.map

package/dist/src/solana.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"solana.d.ts","sourceRoot":"","sources":["../../src/solana.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,aAAa,qEAAwC,CAAC;AACnE,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,KAAK,CAAC;AAEvD,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa,CAEpE"}
+{"version":3,"file":"solana.d.ts","sourceRoot":"","sources":["../../src/solana.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,eAAO,MAAM,aAAa,qEAAwC,CAAC;AACnE,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,KAAK,CAAC;AAEvD;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa,CAEpE;AAED;;GAEG;AACH,eAAO,MAAM,aAAa,oGAAgD,CAAC;AAC3E,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,KAAK,CAAC;AAEvD;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa,CAEtE;AAED;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,qEAAyC,CAAC;AAE/E;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAE1E;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,kBAAkB,CAO7B;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,MAAM,EACb,IAAI,CAAC,EAAE,MAAM,GACZ,kBAAkB,CAYpB"}

package/dist/src/solana.js

@@ -1,6 +1,76 @@
 import { type } from "arktype";
 import { isValidationError } from "./validation.js";
+/**
+ * Validator for Solana base58-encoded addresses.
+ */
 export const Base58Address = type(/^[1-9A-HJ-NP-Za-km-z]{32,44}$/);
+/**
+ * Type guard that checks if a value is a valid Solana base58 address.
+ *
+ * @param maybe - The value to check
+ * @returns True if the value matches the base58 address format
+ */
 export function isBaseAddress(maybe) {
     return !isValidationError(Base58Address(maybe));
 }
+/**
+ * Validator for Solana cluster names.
+ */
+export const SolanaCluster = type("'mainnet-beta' | 'devnet' | 'testnet'");
+/**
+ * Type guard that checks if a value is a valid Solana cluster name.
+ *
+ * @param maybe - The value to check
+ * @returns True if the value is a known cluster name
+ */
+export function isSolanaCluster(maybe) {
+    return !isValidationError(SolanaCluster(maybe));
+}
+/**
+ * Validator for Solana CAIP-2 network identifier strings.
+ *
+ * Format: solana:<genesis-hash> where genesis-hash is base58-encoded.
+ */
+export const SolanaCAIP2NetworkString = type(/^solana:[1-9A-HJ-NP-Za-km-z]+$/);
+/**
+ * Type guard that checks if a value is a valid Solana CAIP-2 network string.
+ *
+ * @param maybe - The value to check
+ * @returns True if the value matches the Solana CAIP-2 format
+ */
+export function isSolanaCAIP2NetworkString(maybe) {
+    return !isValidationError(SolanaCAIP2NetworkString(maybe));
+}
+/**
+ * Type guard that checks if a value is a SolanaCAIP2Network object.
+ *
+ * @param maybe - The value to check
+ * @returns True if the value is a SolanaCAIP2Network object
+ */
+export function isSolanaCAIP2Network(maybe) {
+    return (typeof maybe === "object" &&
+        maybe !== null &&
+        "hash" in maybe &&
+        "caip2" in maybe);
+}
+/**
+ * Creates a SolanaCAIP2Network object from a CAIP-2 string.
+ *
+ * @param caip2 - The CAIP-2 network identifier string (e.g., "solana:5eykt...")
+ * @param name - Optional display name for the network
+ * @returns A SolanaCAIP2Network object
+ * @throws Error if the CAIP-2 string is invalid
+ */
+export function createSolanaNetwork(caip2, name) {
+    if (!isSolanaCAIP2NetworkString(caip2)) {
+        throw new Error(`Invalid Solana CAIP-2 network: ${caip2}`);
+    }
+    const hash = caip2.slice(7);
+    return {
+        hash,
+        ...(name !== undefined && { name }),
+        get caip2() {
+            return `solana:${this.hash}`;
+        },
+    };
+}

package/dist/src/validation.d.ts

@@ -1,4 +1,17 @@
 import { type } from "arktype";
+/**
+ * Type guard that checks if a value is an arktype validation error.
+ *
+ * @param possibleErrors - The value to check
+ * @returns True if the value is a validation error
+ */
 export declare function isValidationError(possibleErrors: unknown): possibleErrors is type.errors;
+/**
+ * Throws an error with the validation error messages appended.
+ *
+ * @param message - Context message describing what was being validated
+ * @param errors - The arktype validation errors
+ * @throws Error with the message and error details
+ */
 export declare function throwValidationError(message: string, errors: type.errors): never;
 //# sourceMappingURL=validation.d.ts.map

package/dist/src/validation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAE/B,wBAAgB,iBAAiB,CAC/B,cAAc,EAAE,OAAO,GACtB,cAAc,IAAI,IAAI,CAAC,MAAM,CAE/B;AAED,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,IAAI,CAAC,MAAM,GAClB,KAAK,CAEP"}
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAE/B;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,cAAc,EAAE,OAAO,GACtB,cAAc,IAAI,IAAI,CAAC,MAAM,CAE/B;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,IAAI,CAAC,MAAM,GAClB,KAAK,CAEP"}

package/dist/src/validation.js

@@ -1,7 +1,20 @@
 import { type } from "arktype";
+/**
+ * Type guard that checks if a value is an arktype validation error.
+ *
+ * @param possibleErrors - The value to check
+ * @returns True if the value is a validation error
+ */
 export function isValidationError(possibleErrors) {
     return possibleErrors instanceof type.errors;
 }
+/**
+ * Throws an error with the validation error messages appended.
+ *
+ * @param message - Context message describing what was being validated
+ * @param errors - The arktype validation errors
+ * @throws Error with the message and error details
+ */
 export function throwValidationError(message, errors) {
     throw new Error(message + ": " + errors.map((e) => e.message).join(","));
 }