@gnosis.pm/safe-apps-provider

中文文档
0.15.1发布于 2022/12/02MITTypeScriptCommonJS近 30 天下载 3.3万

A provider wrapper of Safe Apps SDK

原始使用文档
文档目录4 节
  1. How to use
  2. SafeAppProvider
  3. A note on gas limit
  4. More scenarios

Safe Apps Provider

npm

This is a provider that follows common standards (e.g. EIP-1193) and can be used with various Web3 libraries (e.g. web3.js or Ethers)

How to use

  • Add npm package
yarn add @gnosis.pm/safe-apps-provider

npm i @gnosis.pm/safe-apps-provider

SafeAppProvider

The provider can be used with the safe-apps-react-sdk and common web3 libraries.

With Ethers.js

import React, { useMemo } from 'react';
import { ethers } from 'ethers';
import { useSafeAppsSDK } from '@gnosis.pm/safe-apps-react-sdk';
import { SafeAppProvider } from '@gnosis.pm/safe-apps-provider';

const App = () => {
  const { sdk, safe } = useSafeAppsSDK();
  const web3Provider = useMemo(() => new ethers.providers.Web3Provider(new SafeAppProvider(safe, sdk)), [sdk, safe]);

  // use provider with contracts

  return;
};

export default App;

With web3.js

import React, { useMemo } from 'react';
import Web3 from 'web3';
import { useSafeAppsSDK } from '@gnosis.pm/safe-apps-react-sdk';
import { SafeAppProvider } from '@gnosis.pm/safe-apps-provider';

const App = () => {
  const { sdk, safe } = useSafeAppsSDK();
  const web3Provider = useMemo(() => new Web3(new SafeAppProvider(safe, sdk)), [sdk, safe]);

  // use provider with contracts

  return;
};

export default App;

A note on gas limit

The ethereum transaction gas limit passed to the safe-apps-provider will be treated as safeTxGas, which is an equivalent of the ethereum transaction gas limit in the Safe context. To learn more about the safe transaction gas, read here:
https://github.com/safe-global/safe-contracts/blob/c36bcab46578a442862d043e12a83fec41143dec/docs/safe_tx_gas.md

If you don't want to pass a calculation and leave it to the Safe, pass 0 as the gas limit.

More scenarios

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

版本与发布记录

@gnosis.pm/safe-apps-provider 共发布 41 个版本,首次发布于 2021/03/05;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.15.1latest2022/12/023 年前
0.15.02022/11/303 年前
0.14.02022/10/114 年前
0.13.22022/09/164 年前
0.13.12022/09/014 年前
0.13.02022/08/254 年前

其他发布通道:next → 0.8.1-next.1。

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

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

A provider wrapper of Safe Apps SDK

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

在项目目录运行 npm install @gnosis.pm/safe-apps-provider,或使用 pnpm add / yarn add / bun add。

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

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

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

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

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

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

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

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

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

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