Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.neynar.com/llms.txt

Use this file to discover all available pages before exploring further.

Wrap your application in an AuthKitProvider to use Farcaster Auth. This provider component stores configuration information about your app and makes it available to auth-kit components and hooks. Note: You must create an AuthKitProvider to use Farcaster Connect. Don’t forget to create one at the top level of your application. 
const config = {
  domain: 'example.com',
  siweUri: 'https://example.com/login',
  rpcUrl: process.env.OP_MAINNET_RPC_URL,
  relay: 'https://relay.farcaster.xyz',
};

const App = () => {
  return (
    <AuthKitProvider config={config}>{/*   Your App   */}</AuthKitProvider>
  );
};

​
Props

PropTypeRequiredDescription
configAuthKitConfigNoConfiguration object. See the options in the table below.
config object options:
ParameterTypeRequiredDescriptionDefault
domainstringNoThe domain of your application.window.location.host
siweUristringNoThe login URL of your application.window.location.href
relaystringNoFarcaster Auth relay server URLhttps://relay.farcaster.xyz
rpcUrlstringNoOptimism RPC server URLhttps://mainnet.optimism.io
versionstringNoFarcaster Auth versionv1