@gnosis.pm/safe-service-client

中文文档
1.4.0发布于 2022/11/23MITTypeScriptCommonJS近 30 天下载 3714

安全服务客户端

此软件包已被标记为弃用

Package no longer supported. It has been migrated to @safe-global/api-kit. Please, update your dependencies.

中文使用文档
文档目录36 节
  1. 目录
  2. 安装
  3. 构建
  4. 初始化
  5. 证明 EthAdapter
  6. 初始化安全服务客户端
  7. API 参考
  8. 获取服务信息
  9. 获取服务MasterCopiesInfo
  10. 解码数据
  11. 获取SafesByOwner
  12. 获取SafesByMudule
  13. 获取交易
  14. 获取交易确认
  15. 确认交易
  16. 获取安全信息
  17. 获得安全代表
  18. 添加安全
  19. 删除所有安全代表
  20. 删除安全
  21. 获取安全创建信息
  22. 估计安全交易
  23. 建议交易
  24. 获取交易
  25. 获取模块交易
  26. 获得多相转换
  27. 获取待定交易
  28. 获取全部交易
  29. 获取下一个 Nonce
  30. 获取基准
  31. 获取UsdBalances
  32. 获取可拼贴
  33. 获取托肯列表
  34. 获取托肯
  35. 许可证
  36. 贡献者

安全服务客户端

NPM Version GitHub Release GitHub

软件开发包,便利与 安全交易服务API。 。 。 .

目录

安装

用纱线或npm安装软件包 :

yarn install
npm install

构建

用纱线或npm来构建软件包 :

yarn build
npm build

初始化

证明 EthAdapter

首先,我们需要创建一个 EthAdapter,包含SDKs与区块链互动所需的所有公用事业. 用来包装 网络3.js 或者说 乙醚(js) 伊特鲁姆图书馆.

根据Dapp所使用的库,有两个选项:

一旦发生 EthersAdapter 或者说 Web3Adapter 被创建,可用于SDK初始化.

初始化安全服务客户端

import SafeServiceClient from '@gnosis.pm/safe-service-client'

const safeService = new SafeServiceClient({
  txServiceUrl: 'https://safe-transaction-mainnet.safe.global',
  ethAdapter
})

API 参考

获取服务信息

返回服务的信息和配置.

const serviceInfo: SafeServiceInfoResponse = await safeService.getServiceInfo()

获取服务MasterCopiesInfo

返回安全主副本列表.

const masterCopies: MasterCopyResponse = await safeService.getServiceMasterCopiesInfo()

解码数据

解码指定的安全交易数据.

const decodedData = await safeService.decodeData(data)

获取SafesByOwner

返回地址为所有者的保险箱列表.

const safes: OwnerResponse = await safeService.getSafesByOwner(ownerAddress)

获取SafesByMudule

返回启用模块地址的“安全”列表.

const safes: ModulesResponse = await getSafesByModule(moduleAddress)

获取交易

返回安全交易的所有信息.

const tx: SafeMultisigTransactionResponse = await safeService.getTransaction(safeTxHash)

获取交易确认

返回给定的安全交易的确认列表.

const confirmations: SafeMultisigConfirmationListResponse = await safeService.getTransactionConfirmations(safeTxHash)

确认交易

添加安全交易的确认.

const signature: SignatureResponse = await safeService.confirmTransaction(safeTxHash, signature)

获取安全信息

返回所提供安全地址的信息和配置.

const safeInfo: SafeInfoResponse = await safeService.getSafeInfo(safeAddress)

获得安全代表

返回给定安全地址的代表名单.

const delegates: SafeDelegateListResponse = await safeService.getSafeDelegates(safeAddress)

添加安全

为给定的安全地址添加新的代表.

const delegateConfig: SafeDelegateConfig = {
  safe,
  delegate,
  label,
  signer
}
await safeService.addSafeDelegate(delegateConfig)

删除所有安全代表

删除给定的安全地址的所有代表.

await safeService.removeAllSafeDelegates(safeAddress, signer)

删除安全

删除给定的安全地址的代表.

const delegateConfig: SafeDelegateDeleteConfig = {
  safe,
  delegate,
  signer
}
await safeService.removeSafeDelegate(delegateConfig)

获取安全创建信息

返回安全器的创建信息.

const safeCreationInfo: SafeCreationInfoResponse = await safeService.getSafeCreationInfo(safeAddress)

估计安全交易

估计特定安全多签名交易的安全性TxGas.

const estimateTx: SafeMultisigTransactionEstimateResponse = await safeService.estimateSafeTransaction(
  safeAddress,
  safeTransaction
)

建议交易

创建新的多签名交易,并将其存储在安全交易处.

const transactionConfig: ProposeTransactionProps = {
  safeAddress,
  safeTxHash,
  safeTransactionData,
  senderAddress,
  senderSignature,
  origin
}
await safeService.proposeTransaction(transactionConfig)

获取交易

返回安全账户的进账历史.

const incomingTxs: TransferListResponse = await safeService.getIncomingTransactions(safeAddress)

获取模块交易

返回安全账户模块交易的历史.

const moduleTxs: SafeModuleTransactionListResponse = await safeService.getModuleTransactions(safeAddress)

获得多相转换

返回安全账户多签名交易的历史.

const multisigTxs: SafeMultisigTransactionListResponse = await safeService.getMultisigTransactions(safeAddress)

获取待定交易

返回正在等待安全所有人确认的多签名交易清单.

const pendingTxs: SafeMultisigTransactionListResponse = await safeService.getPendingTransactions(safeAddress)
const pendingTxs: SafeMultisigTransactionListResponse = await safeService.getPendingTransactions(
  safeAddress,
  currentNonce
)

获取全部交易

返回安全交易列表。 该列表根据交易类型有不同的结构.

const allTxs: SafeMultisigTransactionListResponse = await safeService.getAllTransactions(safeAddress)
const allTxsOptions: AllTransactionsOptions = {
  executed,
  queued,
  trusted
}
const allTxs: SafeMultisigTransactionListResponse = await safeService.getAllTransactions(
  safeAddress,
  allTxsOptions
)

获取下一个 Nonce

返回在上次待决交易后提出新交易的权利非ce.

const nextNonce = await safeService.getNextNonce(safeAddress)

获取基准

返回 Ether 和 ERC20 安全符的余额.

const balances: SafeBalanceResponse[] = await safeService.getBalances(safeAddress)

此方法可选择接受 options 参数 :

const options: SafeBalancesOptions = {
  excludeSpamTokens  // Optional. Default value is `true`.
}
const balances: SafeBalanceResponse[] = await safeService.getBalances(safeAddress, options)

获取UsdBalances

返回保险箱以太和 ERC20 代号的余额,并转换为美元.

const usdBalances: SafeBalanceUsdResponse[] = await safeService.getUsdBalances(safeAddress)

此方法可选择接受 options 参数 :

const options: SafeBalancesUsdOptions = {
  excludeSpamTokens // Optional. Default value is `true`.
}
const usdBalances: SafeBalanceUsdResponse[] = await safeService.getUsdBalances(safeAddress, options)

获取可拼贴

返回给定的“安全”拥有的集体(ERC721)及其相关信息.

const collectibles: SafeCollectibleResponse[] = await safeService.getCollectibles(safeAddress)

此方法可选择接受 options 参数 :

const options: SafeCollectiblesOptions = {
  excludeSpamTokens // Optional. Default value is `true`.
}
const collectibles: SafeCollectibleResponse[] = await safeService.getCollectibles(safeAddress, options)

获取托肯列表

返回保险箱处理的所有 ERC20 令牌的列表 .

const tokens: TokenInfoListResponse = await safeService.getTokenList()

获取托肯

返回给定的 ERC20 令牌的信息 .

const token: TokenInfoResponse = await safeService.getToken(tokenAddress)

许可证

这个库在麻省理工学院下发行.

贡献者

  • 热尔曼·马丁内斯(签名)德国(中文(简体) )

版本与发布记录

@gnosis.pm/safe-service-client 共发布 12 个版本,首次发布于 2021/06/03;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.4.0latest2022/11/233 年前
1.3.12022/09/224 年前
1.3.02022/09/214 年前
1.2.02022/07/154 年前
1.1.22022/04/054 年前
1.1.12022/02/014 年前

关于 @gnosis.pm/safe-service-client 的常见问题

@gnosis.pm/safe-service-client 是什么?

安全服务客户端注意:该包已被作者标记为弃用——Package no longer supported. It has been migrated to @safe-global/api-kit. Please, update your dependencies.

如何安装 @gnosis.pm/safe-service-client?

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

@gnosis.pm/safe-service-client 支持 TypeScript 吗?

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

@gnosis.pm/safe-service-client 支持 ESM 还是 CommonJS?

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

@gnosis.pm/safe-service-client 可以商用吗?

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

@gnosis.pm/safe-service-client 的下载量有多少?

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

@gnosis.pm/safe-service-client 还在维护吗?

最新版本 1.4.0 发布于 2022/11/23(3 年前);至今共发布 12 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/06/03。作者已将其标记为弃用,新项目建议寻找替代方案。