Skip to main content
REST client

Facilitator

The 2 operations under facilitator, as typed calls on the generated REST client.

1 min read
View MarkdownEdit on GitHub

Facilitator

Available from @codespar/sdk 0.12.0, which is not on npm yet. The published version today is 0.11.0, and it has no cs.api; 0.12.0 is on the main branch of codespar-core. The examples below are not compiled against the installed package for that reason.

Every call below is cs.api reaching one operation of the OpenAPI document this page was generated from; the REST client overview explains request, response, the option bag and the errors. The values are placeholders shaped by the document.

import { CodeSpar } from "@codespar/sdk";

const cs = new CodeSpar({ apiKey: process.env.CODESPAR_API_KEY });

POST /v1/facilitator/x402/executions

POST/v1/facilitator/x402/executions
Moves money

A 200 here means USDC MOVED.

Ingest and execute a foreign x402 authorization

const r = await cs.api.response("post", "/v1/facilitator/x402/executions", {
  body: {
    authorization: {
      from: "string",
      to: "string",
      value: "string",
      validAfter: "string",
      validBefore: "string",
      nonce: "string"
    },
    domain: {
      name: "Example",
      version: "string",
      chainId: 0,
      verifyingContract: "string"
    },
    signature: "string",
    intent: {
      payee: "string",
      resource: "string",
      seller: "string",
      purpose: "string",
      max_amount_minor: 1000,
      total_cap_minor: 1,
      resource_url: "https://example.com/hook"
    }
  }
});
// r.status is one of the documented statuses (200, 422),
// each with its own body shape in r.data; nothing here throws on 422.
if (r.ok) {
  console.log(r.data);
}

Parameters, body and every documented response: POST /v1/facilitator/x402/executions in the HTTP reference.

GET /v1/facilitator/x402/executions/{id}

GET/v1/facilitator/x402/executions/{id}

Read one ingested foreign authorization

const result = await cs.api.get("/v1/facilitator/x402/executions/{id}", {
  path: {
    id: "execution_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/facilitator/x402/executions/{id} in the HTTP reference.

Facilitator | CodeSpar