@0xtrails/适应器-wagmi

使用有瓦克米的拖车.

这个适配器让Trails使用您的应用程序已经设置的wagmi. 当您的应用程序拥有时使用 WagmiProvider、链条、运输工具、连接器,你希望拖车部件或钩子能共享钱包状态。 主要融合目标为wagmi 3,而wagmi 2作为相容目标保留.

适配器自动检测周围 WagmiProvider 默认:

• 环绕 WagmiProvider 没有 wagmiConfig 选项 + 连接到主机拥有的 wagmi 运行时间
• 不变 wagmiConfig 实例 WagmiProvider * 进入东道主拥有的wagmi运行时间的桥梁
• 不匹配周围 WagmiProvider (单位:千美元) wagmiConfig 选项 → 用提供的配置挂载适配器拥有的 wagmi 运行时间

对于一个真正独立的Trails拥有的运行时间,创建和通过一个单独的wagmi配置实例.

安装

npm install 0xtrails @0xtrails/adapter-wagmi wagmi viem @tanstack/react-query

支持的wagmi 版本 :

• 小学: wagmi@^3.2.0
• 兼容性 : wagmi@^2.19.0

软件包的对等范围仍然存在 wagmi@^2.19.0 || ^3.2.0 因此,现有的wagmi 2主机可以继续使用相同的适配器.

快速启动: 带有您的 wagmi 提供者的部件

import { TrailsWidget } from '0xtrails'
import { wagmiAdapter } from '@0xtrails/adapter-wagmi'
import { WagmiProvider } from 'wagmi'

const apiKey = 'YOUR_TRAILS_API_KEY'

// Automatically uses the surrounding WagmiProvider.
const adapters = [wagmiAdapter()]

export function App() {
  return (
    <WagmiProvider config={wagmiConfig}>
      <TrailsWidget apiKey={apiKey} adapters={adapters} renderInline />
    </WagmiProvider>
  )
}

你只需要通过 wagmiConfig 当Trails能够搭载适配器拥有的 wagmi 运行时间倒计时.

有拖车的 App 级别设置

当拖车钩和部件共享同一适配器时使用此功能 .

import { TrailsProvider, TrailsWidget } from '0xtrails'
import { wagmiAdapter } from '@0xtrails/adapter-wagmi'
import { WagmiProvider } from 'wagmi'

const apiKey = 'YOUR_TRAILS_API_KEY'
const adapters = [wagmiAdapter()]

export function App() {
  return (
    <WagmiProvider config={wagmiConfig}>
      <TrailsProvider config={{ trailsApiKey: apiKey, adapters }}>
        <TrailsWidget renderInline />
      </TrailsProvider>
    </WagmiProvider>
  )
}

运行时间所有权

managedBy 仅在您通过多个适配器作为包裹条目时才需要。 它控制有轨电车的钱包生命周期所有权,而不是控制 wagmi 适配器桥通向母供应商.

const hostAdapter = wagmiAdapter({ wagmiConfig: hostWagmiConfig })
const trailsAdapter = wagmiAdapter({ wagmiConfig: trailsWagmiConfig })

const adapters = [
  { adapter: hostAdapter, managedBy: 'host' },
  { adapter: trailsAdapter, managedBy: 'trails' },
]

使用 managedBy: 'host' 当有轨电车可以使用钱包,但不应拥有其生命周期时,例如隐藏一个主机控制的钱包的断开动作. 使用 managedBy: 'trails' 用于拖车应当拥有的钱包选项.

可选: 自定义钱包标签

过 wallets 如果您想要控制主机钱包在轨迹中的出现. name 财务报告和审定财务报表 icon 替换目录中的标签和标志, 随处可见 Trails 显示钱包: 连接列表, 连接的芯片, 资助选择器和接收行 .

const adapters = [
  wagmiAdapter({
    wagmiConfig,
    wallets: [
      {
        id: 'host-wallet',
        name: 'My Wallet',
        icon: 'https://my.app/wallet.png',
        flow: 'direct',
        placement: 'featured',
      },
    ],
  }),
]

将嵌入式钱包标为自己的

嵌入式钱包(Privy,Sequence)是主机-登录身份,因此Trails从不自行列出;一个主机选择一个带有有特色描述符的输入. 同样的描述是您重新命名的地方. 使用Privoy软件的用户应该看到该应用程序的钱包,而不是Privoy:

wagmiAdapter({
  wagmiConfig: privyWagmiConfig,
  wallets: [
    {
      id: 'privy',
      name: 'XYZ Wallet',
      icon: 'https://xyz.app/wallet.png',
      flow: 'embedded',
      placement: 'featured',
      connect: connectPrivyEmbedded,
    },
  ],
})

轨迹解决任何 @privy-io/wagmi 与 id 连接器 privy,因此,描述符与连接匹配,无论用户是通过Trails连接还是已经签名。 枢密院自己的登录模式及其"由枢密院保护"脚印被配置在枢密院仪表板上,外有道道.

提示

• 打开适配器 TrailsProvider config.adapters 用于应用级设置.
• 打开适配器 TrailsWidget adapters 仅用于部件设置.
• 不要同时通过两个地方的适配器.
• 使用 wagmiAdapter() 当拖车自动检测 并共享您现有的 wagmi 运行时间.
• 传出同样的 wagmiConfig 例如,Trails应该分享运行时间,但仍有适配器的回落.
• 使用单独的 wagmiConfig 例如,拖车应安装单独的适配器自备运行时间.
• managedBy 控制复合适配器列表中的生命周期所有性;它不覆盖wagmi运行时间匹配.

许可证

阿帕奇 - 2.0