Skip to content

Latest commit

 

History

History

solana-kit

README.md

@octanejs/solana-kit

Octane-native Solana client, Wallet Standard, TanStack Query, and transaction integration for the exactly aligned @solana/[email protected] family.

Installation

npm install @octanejs/solana-kit @solana/kit
pnpm add @octanejs/solana-kit @solana/kit

As in @solana/react, @solana/kit is a peer dependency. Use @solana/kit directly for addresses, codecs, RPC, signers, transaction messages, submission, and confirmation. This package is the reactive UI seam; it does not wrap or re-export Kit.

@octanejs/solana-kit/query also needs @octanejs/tanstack-query. Like @tanstack/react-query for @solana/react/query, it is an optional peer dependency, so useRequestQuery reads the application's QueryClientProvider:

npm install @octanejs/solana-kit @solana/kit @octanejs/tanstack-query
pnpm add @octanejs/solana-kit @solana/kit @octanejs/tanstack-query

Supported

  • ClientProvider, ClientContext, useClient, useClientCapability, and createClientStore
  • validated, generation-safe wallet discovery and account selection with createWalletStore
  • explicit-action sign/send/confirm orchestration with typed failure and indeterminate reconciliation
  • useRequestQuery from @octanejs/solana-kit/query, backed by @octanejs/tanstack-query

The Wallet Standard adapter is private and structural. Public types contain no React or @wallet-standard/react types, and there is no second Octane consumer that warrants a separately published package.

Deliberate limits

@solana/react/swr is excluded because Octane has no SWR binding. The upstream selected-wallet provider and signer hooks expose @wallet-standard/react or React dispatch types, so this first surface uses the narrower Octane-native wallet store instead. Subscription/tracked-data query hooks are deferred pending a dedicated streamed-query characterization.

Wallet discovery is browser-only and activates only when an application supplies a registry. Server rendering is inert. Browser hosts need BigInt, fetch, WebSocket, Web Crypto with Ed25519 support, and a Wallet Standard registry. Signing and submission must be called from an explicit user action and are never retried automatically.