@foundryprotocol/0gkit-react

Neutral React hooks for 0G: useUpload, useDownload, useInference, useAttestation.

What it does

Thin reactive wrappers over storage, compute, and attestation. Every hook returns the same shape — { data, error, loading, reset } plus a named runner. The runner resolves with the value and rejects, so a component can read state reactively or await the call directly. react is a peer dependency.

When to use it

A React UI that uploads to / downloads from 0G Storage, runs inference, or verifies an attestation.
You want loading/error state managed for you with a consistent shape.

Where to use it

A React 18/19 client component. Note the runtime boundary: useUpload / useDownload / useInference ultimately call the Node-only storage/compute SDKs, so they only work where those run (a server action, an Electron/Node host, or behind your own API). useAttestation is pure crypto and works fully in the browser.

Install

npm install @foundryprotocol/0gkit-react react
# plus whichever primitive you use:
npm install @foundryprotocol/0gkit-storage @0gfoundation/0g-storage-ts-sdk ethers # uploads
npm install @foundryprotocol/0gkit-compute ethers                                  # inference
npm install @foundryprotocol/0gkit-attestation                                     # verify

API surface

function useUpload(config: StorageConfig): UseUploadResult; // .upload(bytes)
function useDownload(config: StorageConfig): UseDownloadResult; // .download(root)
function useInference(config: ComputeConfig): UseInferenceResult; // .infer(args)
function useAttestation(): UseAttestationResult; // .verify(signed, expectedSigner)

Each result extends AsyncState<T> ({ data, error, loading }) and adds the named runner plus reset(). config is read per-call through a ref, so you may recompute it each render without the hook going stale.

Full signatures, return shapes, and a complete Next.js example are in the dedicated React guide.

Wraps storage, compute, attestation. Full guide: React guide. Template: npx degit rajkaria/0g-ai-kit/templates/react-app.

Exports

ZeroGErrorBoundary
ZeroGIndexerProvider
type AsyncAction
type AsyncState
type InferenceArgs
type UseAttestationResult
type UseDownloadResult
type UseEventOptions
type UseEventResult
type UseInferenceResult
type UseLogsOptions
type UseLogsResult
type UseUploadResult
type ZeroGErrorBoundaryProps
type ZeroGIndexerProviderProps
useEvent
useIndexer
useLogs