Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Access the raw KeyStone Elements context for advanced use cases.
import { useKeystone } from '@keystoneos/react';
function CustomApiCall() {
const { baseUrl, tokenManager } = useKeystone();
const fetchCustomData = async () => {
const authHeader = await tokenManager.getAuthHeader();
const res = await fetch(`${baseUrl}/v1/some-endpoint`, {
headers: { Authorization: authHeader },
});
return res.json();
};
// ...
}
<KeystoneProvider>.
interface KeystoneContextValue {
baseUrl: string;
tokenManager: SessionTokenManager;
eventBus: EventBus;
depositOrchestrator: DepositOrchestrator;
actionDelegates?: ActionDelegates;
}
| Property | Type | Description |
|---|---|---|
baseUrl | string | The KeyStone API base URL. |
tokenManager | SessionTokenManager | Manages session token lifecycle and auth headers. |
eventBus | EventBus | Real-time event subscription system. |
depositOrchestrator | DepositOrchestrator | Manages multi-step deposit flows. |
actionDelegates | ActionDelegates | undefined | Action delegates from the provider. |
useSettlement, useDeposit, etc.). Use useKeystone when you need:
function useCustomEndpoint(path: string) {
const { baseUrl, tokenManager } = useKeystone();
const [data, setData] = useState(null);
useEffect(() => {
(async () => {
const auth = await tokenManager.getAuthHeader();
const res = await fetch(`${baseUrl}${path}`, {
headers: { Authorization: auth },
});
setData(await res.json());
})();
}, [baseUrl, path, tokenManager]);
return data;
}
function useCustomEvents(settlementId: string) {
const { eventBus } = useKeystone();
useEffect(() => {
const unsubscribe = eventBus.subscribe(settlementId, (event) => {
console.log('Settlement event:', event);
});
return unsubscribe;
}, [settlementId, eventBus]);
}