SymmioProvider

The single React context every other SDK hook consumes. Builds the core Config, bridges wagmi’s viem clients into it, and exposes the config + connected chain via useSymmioConfig / useSymmioChainId.

Setup


import { SymmioSupportedChainId } from "@symmio/trading-core";
import { SymmioProvider } from "@symmio/trading-react";
import { zeroAddress } from "viem";
 
const symmioConfig = {
  // `zeroAddress` works out of the box (no fee share) — swap in your registered affiliate to earn fees.
  [SymmioSupportedChainId.HYPER_EVM]: { addresses: { affiliatesAddress: zeroAddress } },
};
 
<SymmioProvider symmioConfig={symmioConfig}>{children}</SymmioProvider>;

Must be mounted inside a WagmiProvider and QueryClientProvider. The SDK reads wagmi’s connection state via useConfig() and shares the caller’s QueryClient; it does not mount either itself.


<WagmiProvider config={wagmiConfig}>
  <QueryClientProvider client={queryClient}>
    <SymmioProvider symmioConfig={symmioConfig}>{children}</SymmioProvider>
  </QueryClientProvider>
</WagmiProvider>

Props

`symmioConfig`

Type: Partial<Record<number, SymmioChainConfigInput>>
Required. Every supported chain must set addresses.affiliatesAddress, or the provider throws AFFILIATE_ADDRESS_REQUIRED (via createConfig) when it is missing. The affiliate is mandatory in the type — a chain entry without one is a compile error. The zero address is accepted (presence-only check) as a testing placeholder — on-chain it is a no-affiliate sentinel, so the trade still opens; you just receive no share of the trading fee. A non-zero unregistered affiliate is what reverts, with PartyAFacet: Invalid affiliate at trade time. Use a registered affiliate to earn the fee share.

Per-chain SYMMIO configuration, keyed by chain id, deep-merged onto the SDK’s built-in defaults (addresses, subgraphs, solver, …).

Its one mandatory field is addresses.affiliatesAddress for every supported chain — your frontend’s on-chain affiliate (your identity in SYMMIO on that chain), attached to every quote so the protocol knows who sourced the trade and routes your share of the trading fee to you. Affiliate addresses are per chain (a registration on one chain is not valid on another). Registration lets you collect a share of the trading fees — register your affiliate and set the registered address. The zero address is accepted as a no-affiliate test placeholder — trades still open but you earn no fee share. See the Providers section of the DEX guide for the full explanation.


<SymmioProvider
  symmioConfig={{
    [SymmioSupportedChainId.HYPER_EVM]: {
      addresses: { affiliatesAddress: "0xYourHyperEvmAffiliate…" },
      // optional per-chain overrides:
      subgraphs: { analytics: "https://staging.example/subgraphs/analytics" },
    },
  }}
>
  {children}
</SymmioProvider>

`defaultChainId`

Type: number
Default: first built-in supported chain

Chain used when an action or hook omits chainId. Set to pin the SDK in single-chain apps; wagmi’s active chain still overrides for the connected wallet.

`getWalletClient`

Type: (parameters: { chainId: number; from?: Address }) => Promise<SymmioWalletClient>
Default: wagmi-connected wallet resolver

Custom wallet-client resolver. Receives { chainId, from } from the SDK; the caller decides which wallet to return.

Use this to plug in a session-key wallet (return the session key when from matches it, wagmi otherwise) or a multi-signer flow (a router that picks based on from).


function useAppGetWalletClient() {
  return useCallback(
    async ({ chainId, from }) => {
      if (sessionKey && from?.toLowerCase() === sessionKey.address.toLowerCase()) {
        return sessionKey.walletClient;
      }
      return await getWalletClient(wagmiConfig, { chainId });
    },
    [sessionKey],
  );
}
 
<SymmioProvider
  symmioConfig={{
    [SymmioSupportedChainId.HYPER_EVM]: { addresses: { affiliatesAddress: "0xYourRegisteredAffiliate…" } },
  }}
  getWalletClient={useAppGetWalletClient()}
>
  {children}
</SymmioProvider>;

When omitted, the provider falls back to wagmi/actions#getWalletClient — the SDK signs with whatever wallet wagmi has connected, ignoring from.

What the provider does

Reads the host wagmi config via useConfig().
Calls createConfig(...) once, memoized against the wagmi config reference.
Wires getClient to wagmi/actions#getPublicClient and getWalletClient to the prop (or wagmi’s default).
Exposes the Config via context.

The wagmi bridge is the only place the SDK touches wagmi — that’s why core stays wagmi-free and non-React consumers can pass their own viem clients.

Reading the config in a hook

`useSymmioConfig(parameters?)`

Reads the config from context. Every SDK hook accepts an optional config override via its parameters; useSymmioConfig mirrors that convention (parameters?.config ?? contextConfig).


import { useSymmioConfig } from "@symmio/trading-react";
 
const config = useSymmioConfig(); // from context
const configOverride = useSymmioConfig({ config: customConfig }); // override

Throws when called outside SymmioProvider and no config override was passed.

`useSymmioChainId()`

Reads the connected chain id from wagmi. Falls back to the provider’s defaultChainId when no wallet is connected.


import { useSymmioChainId } from "@symmio/trading-react";
 
const chainId = useSymmioChainId();

Chain-config utilities

Re-exported from core:

SymmioSupportedChainId — enum of the SDK’s built-in chain ids.
isSymmioSupportedChainId(id) — narrow an arbitrary id.
getChainConfig(config, chainId?) / listSupportedChains(config) — standalone helpers on the resolved config.

Config — the underlying createConfig.
Hook pattern — how every downstream hook consumes context.
Wallet hooks — the higher-level wallet + chain-switch API.

SymmioProvider

Setup

Props

symmioConfig

defaultChainId

getWalletClient