@gnosis.pm/safe-apps-wagmi

中文文档
2.1.0发布于 2023/01/30MITTypeScriptCommonJS近 30 天下载 4629

WAGMI connector for Safe Apps

原始使用文档
文档目录4 节
  1. Installation
  2. Integration steps
  3. Example
  4. More scenarios

Safe Apps wagmi connector

npm

A connector to be used with wagmi library

Installation

yarn add @gnosis.pm/safe-apps-wagmi @wagmi/core

npm install @gnosis.pm/safe-apps-wagmi @wagmi/core

Integration steps

  1. Configure wagmi client
import { SafeConnector } from '@gnosis.pm/safe-apps-wagmi';

const chains = ...

const client = createClient({
    connectors: [
        new SafeConnector({ chains }),
        new MetaMaskConnector({ chains }),
        new WalletConnectConnector({
            chains,
            options: {
                qrcode: true,
            },
        }),
        new InjectedConnector({
            chains,
            options: {
                name: 'Injected',
                shimDisconnect: true,
            },
        }),
    ],
    ...
});

Make sure to omit the autoConnect property or set it to false. Wagmi library automatically connects to the last used provider, but instead we want to automatically connect to the Safe if the app is loaded in the Safe Context. Autoconnect logic may be implemented via a separate hook.

  1. Create an autoconnect hook
import { useConnect } from 'wagmi';
import { useEffect } from 'react';

const AUTOCONNECTED_CONNECTOR_IDS = ['safe'];

function useAutoConnect() {
  const { connect, connectors } = useConnect();

  useEffect(() => {
    AUTOCONNECTED_CONNECTOR_IDS.forEach((connector) => {
      const connectorInstance = connectors.find((c) => c.id === connector && c.ready);

      if (connectorInstance) {
        connect({ connector: connectorInstance });
      }
    });
  }, [connect, connectors]);
}

export { useAutoConnect };

This hook tries to connect to the Safe wallet automatically on the app load. The hook can be extended with other connectors that use a similar iframe approach (e.g., Ledger Live). It can also be extended with fallback logic such as the last used wallet if the connection to the Safe doesn't succeed.

Example

An example application can be found here

More scenarios

For the SDK overview documentation, please refer to the safe-apps-sdk documentation

版本与发布记录

@gnosis.pm/safe-apps-wagmi 共发布 8 个版本,首次发布于 2022/06/27;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.1.0latest2023/01/303 年前
1.2.02022/11/303 年前
1.1.02022/10/264 年前
1.0.42022/10/114 年前
1.0.32022/08/254 年前
1.0.22022/07/284 年前

关于 @gnosis.pm/safe-apps-wagmi 的常见问题

@gnosis.pm/safe-apps-wagmi 是什么?

WAGMI connector for Safe Apps

如何安装 @gnosis.pm/safe-apps-wagmi?

在项目目录运行 npm install @gnosis.pm/safe-apps-wagmi,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@wagmi/core(^0.8.3)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@gnosis.pm/safe-apps-wagmi 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gnosis.pm/safe-apps-wagmi 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@gnosis.pm/safe-apps-wagmi 可以商用吗?

@gnosis.pm/safe-apps-wagmi 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gnosis.pm/safe-apps-wagmi 的下载量有多少?

根据 npm 官方下载统计,@gnosis.pm/safe-apps-wagmi 在 2026/10/17 – 2026/11/15 这 30 天内被下载 4,629 次,日均约 154 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gnosis.pm/safe-apps-wagmi 还在维护吗?

最新版本 2.1.0 发布于 2023/01/30(3 年前);至今共发布 8 个版本,其中过去 12 个月发布了 0 个;首次发布于 2022/06/27。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。