Documentation Index

Fetch the complete documentation index at: https://docs.faremeter.xyz/llms.txt

Use this file to discover all available pages before exploring further.

​

internal

​

Type Aliases

​

DetectedVersion

DetectedVersion = 1 | 2

Defined in: packages/fetch/src/internal.ts:36

---

​

ProcessMPPOpts

ProcessMPPOpts = object

Defined in: packages/fetch/src/internal.ts:204 Attempts to process a 402 response as an MPP challenge. Checks for a WWW-Authenticate header with Payment challenges, then iterates handlers to find one that matches. Returns the Authorization header value on success, or undefined if no MPP challenges are present or no handler matches (allowing fallthrough to x402). Does not consume the response body.

​

Properties

bodyDigest?

optional bodyDigest: string

Defined in: packages/fetch/src/internal.ts:205

---

​

ProcessPaymentRequiredResponseOpts

ProcessPaymentRequiredResponseOpts = object

Defined in: packages/fetch/src/internal.ts:63 Options for processing a 402 Payment Required response.

​

Properties

handlers

handlers: PaymentHandler[]

Defined in: packages/fetch/src/internal.ts:65 Payment handlers that produce execers for payment requirements.

payerChooser()?

optional payerChooser: (execer) => Promise<PaymentExecer>

Defined in: packages/fetch/src/internal.ts:67 Optional function to select among multiple possible payers. Defaults to chooseFirstAvailable.

Parameters

execer

PaymentExecer[]

Returns

Promise<PaymentExecer>

---

​

ProcessPaymentRequiredResponseResult

ProcessPaymentRequiredResponseResult = object

Defined in: packages/fetch/src/internal.ts:73 Result of processing a 402 Payment Required response.

​

Properties

detectedVersion

detectedVersion: DetectedVersion

Defined in: packages/fetch/src/internal.ts:83 The detected protocol version (1 or 2).

payer

payer: PaymentExecer

Defined in: packages/fetch/src/internal.ts:75 The selected payment execer.

payerResult

payerResult: object

Defined in: packages/fetch/src/internal.ts:77 The result from executing the payment.

payload

payload: object

paymentHeader

paymentHeader: string

Defined in: packages/fetch/src/internal.ts:81 Base64-encoded payment header ready to attach to the retry request.

paymentPayload

paymentPayload: x402PaymentPayload | x402PaymentPayloadV1

Defined in: packages/fetch/src/internal.ts:79 The payment payload in the detected protocol version format.

​

Variables

​

V2_PAYMENT_HEADER

const V2_PAYMENT_HEADER: "PAYMENT-SIGNATURE" = "PAYMENT-SIGNATURE"

Defined in: packages/types/dist/src/x402v2.d.ts:4 HTTP header name for v2 client payment signatures.

---

​

V2_PAYMENT_REQUIRED_HEADER

const V2_PAYMENT_REQUIRED_HEADER: "PAYMENT-REQUIRED" = "PAYMENT-REQUIRED"

Defined in: packages/types/dist/src/x402v2.d.ts:8 HTTP header name for v2 402 payment required responses.

---

​

X_PAYMENT_HEADER

const X_PAYMENT_HEADER: "X-PAYMENT" = "X-PAYMENT"

Defined in: packages/types/dist/src/x402.d.ts:4 HTTP header name for v1 client payment payloads.

​

Functions

​

chooseFirstAvailable()

chooseFirstAvailable(possiblePayers): PaymentExecer

Defined in: packages/fetch/src/internal.ts:44 Default payer chooser that selects the first available payment execer.

​

Parameters

possiblePayers

PaymentExecer[] Array of payment execers that can handle the requirements

​

Returns

PaymentExecer The first execer in the array

---

​

processPaymentRequiredResponse()

processPaymentRequiredResponse(ctx, response, options): Promise<ProcessPaymentRequiredResponseResult>

Defined in: packages/fetch/src/internal.ts:94 Process a 402 Payment Required response, auto-detecting v1 or v2 protocol.

​

Parameters

ctx

RequestContext Request context

response

Response The 402 Response object (must not have been consumed)

options

ProcessPaymentRequiredResponseOpts Processing options including payment handlers

​

Returns

Promise<ProcessPaymentRequiredResponseResult> Payment information including header and detected version

---

​

processPaymentRequiredResponseMPP()

processPaymentRequiredResponseMPP(response, handlers, opts?): Promise<undefined | string>

Defined in: packages/fetch/src/internal.ts:208

​

Parameters

response

Response

handlers

MPPPaymentHandler[]

opts?

ProcessMPPOpts

​

Returns

Promise<undefined | string>