Class OmpxClient

OMPX client — automatically handles payments for both X402 and MPP services.

Example: Basic usage (global fetch polyfill)

import { OmpxClient } from '@ompx/client'
import { tempo } from '@ompx/tempo'
import { privateKeyToAccount } from 'viem/accounts'

const client = new OmpxClient({
  methods: [tempo({ account: privateKeyToAccount('0x...') })],
})

client.polyfill() // Patches globalThis.fetch
const response = await fetch('https://api.example.com/resource')

Example: Manual control

const { fetch: ompxFetch } = client.wrapFetch(globalThis.fetch)
const response = await ompxFetch('https://api.example.com/resource')
const receipt = client.parseReceipt(response)

Index

Constructors

constructor

Methods

createCredential parseReceipt polyfill wrapFetch

Constructors

constructor

new OmpxClient(config: OmpxClientConfig): OmpxClient
Parameters
- config: OmpxClientConfig
Returns OmpxClient
- Defined in client/src/index.ts:50

Methods

createCredential

createCredential(
response: Response,
): Promise<{ headers: Record<string, string> }>
Manually create a payment credential for a 402 response. Returns the headers to include in the retry request.
Parameters
- response: Response
Returns Promise<{ headers: Record<string, string> }>
- Defined in client/src/index.ts:185

parseReceipt

parseReceipt(response: Response, protocol?: Protocol): Settlement | null
Parse the payment receipt from a successful response. Returns null if no receipt is present.
Parameters
- response: Response
- Optionalprotocol: Protocol
Returns Settlement | null
- Defined in client/src/index.ts:200

polyfill

polyfill(): void
Polyfill globalThis.fetch to automatically handle 402 Payment Required responses. After calling this, all fetch() calls will transparently pay for resources.

Returns void
- Defined in client/src/index.ts:61

wrapFetch

wrapFetch(
    fetchFn: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    },
): {
    fetch: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    };
}
Wrap a fetch function to automatically handle 402 Payment Required responses. Returns a new fetch function that transparently pays for resources.
Parameters
- fetchFn: {
  (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
  (input: string | URL | Request, init?: RequestInit): Promise<Response>;
  }
  - (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
    MDN Reference
    
    Parameters
    input: URL | RequestInfo
    Optionalinit: RequestInit
    Returns Promise<Response>
    (input: string | URL | Request, init?: RequestInit): Promise<Response>
    MDN Reference
    
    Parameters
    input: string | URL | Request
    Optionalinit: RequestInit
    Returns Promise<Response>
Returns {
    fetch: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    };
}
- fetch: {
  (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
  (input: string | URL | Request, init?: RequestInit): Promise<Response>;
  }
- Defined in client/src/index.ts:71

Class OmpxClient

Example: Basic usage (global fetch polyfill)

Example: Manual control

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns OmpxClient

Methods

createCredential

Parameters

Returns Promise<{ headers: Record<string, string> }>

parseReceipt

Parameters

Returns Settlement | null

polyfill

Returns void

wrapFetch

Parameters

Parameters

Returns Promise<Response>

Parameters

Returns Promise<Response>

Returns {
    fetch: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    };
}

fetch: {
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | URL | Request, init?: RequestInit): Promise<Response>;
}

Settings

On This Page

Class OmpxClient

Example: Basic usage (global fetch polyfill)

Example: Manual control

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns OmpxClient

Methods

createCredential

Parameters

Returns Promise<{ headers: Record<string, string> }>

parseReceipt

Parameters

Returns Settlement | null

polyfill

Returns void

wrapFetch

Parameters

Parameters

Returns Promise<Response>

Parameters

Returns Promise<Response>

Returns { fetch: { (input: URL | RequestInfo, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; };}

fetch: { (input: URL | RequestInfo, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>;}

Settings

On This Page

Returns {
fetch: {
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | URL | Request, init?: RequestInit): Promise<Response>;
};
}

fetch: {
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | URL | Request, init?: RequestInit): Promise<Response>;
}