@ixo/oracles-client-sdk

Overview

@ixo/oracles-client-sdk is the official React client for a QiForge oracle. It wraps:

The streaming chat endpoint over SSE.
The WebSocket event channel (tool calls, render components, browser tools, AG-UI actions).
UCAN auth — signing invocations (authentication) and delegations (downstream authorization).
Browser-side tools and AG-UI actions (so the agent can act on the user’s tab / UI).

If you’re building a Portal-like web UI for your oracle, use this. If you’re building a non-React client (CLI, mobile app), implement the HTTP/WS protocol directly — the API reference is API endpoints.

Install

pnpm add @ixo/oracles-client-sdk

react >= 18 and zod ^3 are peer dependencies.

OraclesProvider (required wrapper)

Every hook calls useOraclesContext(), which throws useOraclesContext must be used within a OraclesProvider if there’s no provider above it. Wrap your app once. The provider holds the wallet, signs transactions, and turns your createDelegation / createInvocation callbacks into the cached auth artifacts the hooks attach to requests.

import { OraclesProvider } from '@ixo/oracles-client-sdk';

function Root({ children }) {
  return (
    <OraclesProvider
      initialWallet={{
        address: 'ixo1...',
        did: 'did:ixo:ixo1...',
        matrix: { accessToken: 'syt_...', homeServer: 'https://matrix.ixo.world' },
      }}
      transactSignX={async (messages, memo) => {
        // sign + broadcast the chain tx with your wallet; return the result
        return undefined;
      }}
      createDelegation={async (oracleDid) => {
        // sign a user→oracle UCAN delegation (downstream authorization)
        return { serialized: '<base64-car>', expiresAt: Date.now() + 60 * 60 * 1000 };
      }}
      createInvocation={async (oracleDid) => {
        // sign a short-lived UCAN invocation (primary authentication)
        return { serialized: '<base64-car>', expiresAt: Date.now() + 15 * 60 * 1000 };
      }}
    >
      {children}
    </OraclesProvider>
  );
}

{ address, did, matrix: { accessToken, homeServer } }

required

The connected user’s wallet + Matrix session. Required.

(messages, memo?) => Promise<unknown>

required

Signs and broadcasts chain transactions (e.g. paying to contract the oracle).

(oracleDid: string) => Promise<{ serialized: string; expiresAt: number }>

required

Mints a user→oracle UCAN delegation. The provider caches it and sends it as x-ucan-delegation.

(oracleDid: string) => Promise<{ serialized: string; expiresAt: number }>

Optional (migration-safe). Mints a short-lived UCAN invocation; the provider sends it as Authorization: Bearer … + X-Auth-Type: ucan (primary auth). Omit to stay on delegation-only auth.

useChat

The primary hook. Provides the message thread, the send function, and live streaming state.

import { useChat, useOracleSessions, renderMessageContent } from '@ixo/oracles-client-sdk';

function Chat({ oracleDid }: { oracleDid: string }) {
  const { sessions, createSession } = useOracleSessions(oracleDid);
  const sessionId = sessions?.[0]?.sessionId ?? '';

  const { messages, sendMessage, isSending, status } = useChat({
    oracleDid,
    sessionId,
    onPaymentRequiredError: (claimIds) => {
      // the oracle needs payment before answering — surface a paywall
      console.log('Payment required:', claimIds);
    },
  });

  return (
    <div>
      <button onClick={() => createSession()}>New chat</button>
      {messages.map((m) => (
        <div key={m.id} className={m.type}>{renderMessageContent(m.content)}</div>
      ))}
      <form onSubmit={(e) => { e.preventDefault(); sendMessage(e.currentTarget.message.value); }}>
        <input name="message" />
        <button type="submit" disabled={isSending}>
          {status === 'streaming' ? 'Streaming…' : 'Send'}
        </button>
      </form>
    </div>
  );
}

Options (IChatOptions):

string

required

The oracle’s DID. The SDK resolves its API/WS URL from the oracle’s on-chain config.

string

required

The chat session to read/write. Create one with useOracleSessions().createSession().

(claimIds: string[]) => void

required

Called when the oracle returns a payment-required error. Surface a paywall.

Record<string, { toolName, description, schema, fn }>

Browser-side tools the agent may call on the user’s tab (see below).

UIComponents

Map of render-component name → React component for render_component events.

{ baseUrl?, wsUrl? }

Override the resolved API / WebSocket URLs (local dev, self-host).

'batched' | 'immediate'

How streamed tokens are flushed to state.

Returned values:

Field	Type	Notes
`messages`	`IMessage[]`	Thread history, including in-flight streamed content.
`sendMessage`	`(message: string) => void`	Submit a user message.
`abortStream`	`() => Promise<void>`	Abort the in-flight response.
`status`	`'submitted' \| 'streaming' \| 'ready' \| 'error'`	Current chat state.
`isSending`	`boolean`	`true` while submitting or streaming.
`isLoading`	`boolean`	Initial history fetch in flight.
`error` / `sendMessageError`	`Error \| undefined`	Load error / send error.
`refetchMessages`	`() => Promise<…>`	Re-pull the thread from the server.
`isRealTimeConnected`	`boolean`	WebSocket connection status.
`isConfigReady`	`boolean`	The oracle’s config has resolved.

There is no isStreaming or events field — use status / isSending for streaming state.

Browser tools

Browser tools let the agent call DOM/UI actions on the user’s tab. Pass them as the browserTools option to useChat — a map keyed by tool name. The SDK advertises them to the agent, forwards each call to your fn, and returns the result over the WebSocket.

import { useChat } from '@ixo/oracles-client-sdk';
import { z } from 'zod';

const browserTools = {
  open_portal_route: {
    toolName: 'open_portal_route',
    description: 'Navigate to a route inside the Portal.',
    schema: z.object({ route: z.string() }),
    fn: async ({ route }: { route: string }) => {
      router.push(route);
      return { ok: true };
    },
  },
};

const { messages, sendMessage } = useChat({
  oracleDid,
  sessionId,
  onPaymentRequiredError: () => {},
  browserTools,
});

There is no registerBrowserTools export — browser tools are the browserTools option above.

AG-UI actions

useAgAction registers an agent-invokable action with an optional render. The provider tracks registered actions; useChat advertises them and renders their output inline.

import { useAgAction } from '@ixo/oracles-client-sdk';
import { z } from 'zod';

useAgAction({
  name: 'create_data_table',
  description: 'Render a data table from structured rows.',
  parameters: z.object({
    title: z.string().optional(),
    columns: z.array(z.any()),
    data: z.array(z.any()),
  }),
  handler: async ({ data }) => ({ ok: true, rowCount: data.length }),
  render: ({ status, args }) =>
    status === 'done' && args ? <DataTable {...args} /> : null,
});

Events

Streamed and WebSocket events are surfaced as the typed AnyEvent union and rendered through renderMessageContent / your uiComponents map. The event eventName values match the wire names:

`eventName`	What it carries
`tool_call`	A tool invocation (and its result).
`render_component`	A structured UI component the agent wants displayed.
`browser_tool_call`	A call to one of your `browserTools`.

The full server/client WebSocket event catalog is in API endpoints → WebSocket.

Other exports

Export	Purpose
`useOracleSessions(oracleDid)`	Create, list, and delete chat sessions.
`useOraclesConfig(oracleDid)`	The oracle’s resolved public config (API URL, model, price).
`useContractOracle()`	Pay to contract (subscribe to) an oracle.
`useMemoryEngine()`	Read/write the optional persistent memory engine.
`useGetOpenIdToken()` / `getOpenIdToken()`	Mint a Matrix OpenID token for the user.
`renderMessageContent(content)`	Turn stored message content into React nodes.
`OraclesProvider`, `useOraclesContext`	The provider + its context accessor.
`@ixo/oracles-client-sdk/live-agent` → `useLiveAgent`	Encrypted voice/video live-agent calls (separate entry point).

Auth lifecycle

The provider owns auth. From your createDelegation / createInvocation callbacks it:

Caches the signed delegation and invocation per (userDid, oracleDid).
Attaches Authorization: Bearer <invocation> + X-Auth-Type: ucan (primary) and x-ucan-delegation (downstream / fallback) to every request.
Passes the same artifacts on the WebSocket handshake (auth.invocation / auth.ucanDelegation).

When a stored delegation is missing or expired, the oracle nudges the user to re-authorize; your app calls createDelegation again to mint a fresh one (the client-sdk POSTs it to /delegation).

Start here

Build

Deep dive

Reference

Help

@ixo/oracles-client-sdk

Overview

Install

OraclesProvider (required wrapper)

useChat

Browser tools

AG-UI actions

Events

Other exports

Auth lifecycle

Where to read next

API endpoints

Identity and auth

​Overview

​Install

​OraclesProvider (required wrapper)

​useChat

​Browser tools

​AG-UI actions

​Events

​Other exports

​Auth lifecycle

​Where to read next

API endpoints

Identity and auth

Overview

Install

OraclesProvider (required wrapper)

useChat

Browser tools

AG-UI actions

Events

Other exports

Auth lifecycle

Where to read next