Skip to main content

Constructor

new Facilitator({
  recipientAddress: string,
  relayer?: string,
  waitUntil?: "confirmed",
  baseUrl?: string,
  apiKey?: string,
});

Methods

  • verify(payload, requirements)
  • settle(payload, requirements, waitUntil?)
  • supported(filters?)

verify

verify(
  payload: PaymentPayload,
  requirements: PaymentRequirements
): Promise<{ success: true; payer: string } | { success: false; error: string }>;

settle

settle(
  payload: PaymentPayload,
  requirements: PaymentRequirements,
  waitUntil?: "confirmed"
): Promise<{ success: true; txHash: string; network: string } | { success: false; error: string }>;

supported

supported(filters?: {
  chainId?: number;
  tokenAddress?: string;
}): Promise<{
  success: true;
  chains: number[];
  tokens: { address: string; supportedMethods: ("eip3009" | "permit" | "permit2")[] }[];
} | { success: false; error: string }>;
Note: waitUntil currently only supports "confirmed".