Interface IDiscoveryClient

Discovery client interface Spec compliance: x402 v2 - Discovery API

interface IDiscoveryClient {
    discover(params?: DiscoveryParams): Promise<DiscoveryResponse>;
    register(
        request: RegisterResourceRequest,
    ): Promise<RegisterResourceResponse>;
    unregister(
        resourceId: string,
    ): Promise<{ error?: string; success: boolean }>;
    update(
        resourceId: string,
        request: Partial<RegisterResourceRequest>,
    ): Promise<RegisterResourceResponse>;
}

Implemented by

DiscoveryClient

Index

Methods

discover register unregister update

Methods

discover

discover(params?: DiscoveryParams): Promise<DiscoveryResponse>
Discover x402-enabled resources
Parameters
- Optionalparams: DiscoveryParams
  Discovery parameters (filters, pagination)
Returns Promise<DiscoveryResponse>
Discovery response with resources
- Defined in discovery/client.ts:38

register

register(request: RegisterResourceRequest): Promise<RegisterResourceResponse>
Register a resource in the bazaar (for providers)
Parameters
- request: RegisterResourceRequest
  Resource registration request
Returns Promise<RegisterResourceResponse>
Registration response
- Defined in discovery/client.ts:45

unregister

unregister(resourceId: string): Promise<{ error?: string; success: boolean }>
Unregister a resource from the bazaar
Parameters
- resourceId: string
  Resource identifier to remove
Returns Promise<{ error?: string; success: boolean }>
Success status
- Defined in discovery/client.ts:52

update

update(
resourceId: string,
request: Partial<RegisterResourceRequest>,
): Promise<RegisterResourceResponse>
Refresh/update a resource's payment requirements
Parameters
- resourceId: string
  Resource identifier
- request: Partial<RegisterResourceRequest>
  Updated resource information
Returns Promise<RegisterResourceResponse>
Update response
- Defined in discovery/client.ts:60