01 / OVERVIEW
React interfaces on top of real Tidelight contracts.
The package source lives in packages/react in the mother repository. It wraps the existing TypeScript SDK method shapes and adds loading, error, cancellation, and refresh behavior without duplicating API transport or research logic.
Supply a client that forwards through your authenticated application backend. This keeps project credentials and tenant authorization on your server while your browser receives only responses that your application has authorized.
02 / QUICKSTART
Install the published package or build from source.
Install the published package with the command shown above. You can also build the canonical source or link it locally.
import { TidelightProvider, useTokenizedEquities, TokenizedEquityGrid } from "@tidelight/react";
import "@tidelight/react/styles.css";
function MarketPanel() {
const result = useTokenizedEquities({ underlyingTicker: "NVDA", limit: 20 });
return <TokenizedEquityGrid
instruments={result.data?.data ?? []}
isLoading={result.isLoading}
error={result.error?.message}
onRetry={result.refresh}
/>;
}Do not place API keys in client-side React code. The provider takes an interface, not a credential. Put official SDK calls behind your application’s authenticated server route or server action.
03 / HOOKS
Small, explicit state surfaces.
useTokenizedEquities(query)Load supported instruments with an abort signal, stale-request cancellation, error details, and refresh action.useResearchJob(jobId, options)Read research job state; polling is opt-in and ends on a terminal state.useStartCompanyResearch()Start a durable research job with a generated or caller-supplied idempotency key, then cancel the returned job.useTidelightClient()Access the provider’s typed client and receive a clear error when used outside the provider.04 / UI COMPONENTS
Honest states, source-backed cards.
TokenizedEquityGrid renders returned instrument metadata, an accessible busy state, an actionable error state, and a real empty result. It does not generate sample prices or imply that tokenized equity spot products are direct stock shares.
05 / EXAMPLES
Connect through your own backend.
The applicationServerClient in the example is your application’s implementation of the small client interface. It should authenticate the signed-in user, call the official SDK from server-only code, enforce project and tenant access, and return contract-shaped responses. The package test suite verifies the hooks against injected client methods, not against fabricated live market results.
06 / SECURITY & TRUST
Keys never belong in a browser bundle.
- The provider receives callable methods and has no API key prop.
- Use the official API key only in trusted server-side configuration.
- Authorize the user and tenant before forwarding a request to Tidelight.
- Keep network limits, errors, scopes, and provider data rules at the server boundary.
- The UI displays server-returned source labels and never invents data.
The package does not implement user authentication or replace Tidelight’s server-side project authorization.
RELEASE / LIVE REGISTRY
Published release details
Version, installation, registry status, and archive details below are refreshed from the public registry.
Official Tidelight React package
npm install @tidelight/react@0.1.1