Skip to content

AuthKitProvider

使用 Farcaster Auth 时,请将您的应用程序包裹在 AuthKitProvider 中。该提供者组件存储了关于您应用的配置信息,并使其可供 auth-kit 组件和钩子使用。

注意: 您必须创建一个 AuthKitProvider 才能使用 Farcaster Connect。别忘了在应用的顶层创建该组件。

tsx
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}>{/*   您的应用   */}</AuthKitProvider>
  );
};

属性

属性类型必填描述
configAuthKitConfig配置对象。请参阅下方表格中的选项。

config 对象选项:

参数类型必填描述默认值
domainstring您的应用程序域名。window.location.host
siweUristring您的应用程序登录 URL。window.location.href
relaystringFarcaster Auth 中继服务器 URLhttps://relay.farcaster.xyz
rpcUrlstringOptimism RPC 服务器 URLhttps://mainnet.optimism.io
versionstringFarcaster Auth 版本v1