Provider

The YieldProvider creates the context required for all @yo-protocol/react hooks.

Usage

import { YieldProvider } from '@yo-protocol/react'

<YieldProvider
  partnerId="my-app"
  defaultSlippageBps={50}
  onError={(error) => console.error(error)}
>
  {children}
</YieldProvider>

Props

Prop
Type
Default
Description

children

ReactNode

Required

partnerId

string

undefined

Optional partner identifier

defaultSlippageBps

number

50

Default slippage in basis points (50 = 0.5%)

onError

(error: Error) => void

undefined

Global error handler for action hooks

Placement

YieldProvider must be placed inside WagmiProvider and QueryClientProvider:

  • useYoClient() — Returns the YoClient instance (or null if not ready)

  • useYieldConfig() — Returns { partnerId, defaultSlippageBps, onError }