Skip to main content

<SunbreakProvider /> Props

PropTypeRequiredDescription
clientIdstringyesSunbreak client ID
basestringnoAPI base (default https://api.sunbreak.com)
walletstringnoActive wallet address or public key
proofProofnoProvider JWT, SIWE/EIP-191, or ed25519 proof
providerAdapterProviderAdapternoDynamic, Privy, custom adapters
refreshDepsunknown[]noValues that trigger re-evaluation (e.g., wallet, user)
timeoutMsnumbernoRequest timeout (ms; default 15000)
fetchImpltypeof fetchnoCustom fetch implementation
Some of these props are not strictly required for the SDK provider, but a combination of them are needed for it to work. Read the providers section to learn more.

Behavior

  • When wallet + valid proof (or providerAdapter token) are present, the SDK attempts registration automatically.
  • If a refresh session exists, the SDK refreshes silently and calls session() once.
  • Authorization is intentionally skipped when walletboundWallet to prevent cross‑wallet leakage.