@gnosis-guild/eth-sdk

中文文档
0.4.0发布于 2025/09/29MITTypeScriptCommonJS近 30 天下载 3742

🛠 为你的"伊特鲁姆"智能合同生成型号安全而轻巧的 SDK

中文使用文档
文档目录10 节
  1. 灰尘
  2. 特征
  3. 叉状通知
  4. 许可证
  5. CLI 选项
  6. 开始
  7. 配置
  8. contracts
  9. outputPath
  10. 视频

灰尘

为您的Ethereum智能合同生成类型安全而轻巧的 SDK

与伊特鲁姆互动的最快最便捷的方法

特征

  • 只要提供您想与
  • 容易使用 - ABIs 将自动从 Etherscan 下载
  • 熟悉的 API - 生成醚.js 合同包装
  • 型式安全 - 最大型式安全的液体类型

叉状通知

这是一个社区叉 @ dethcrypto/eth-sdk (英语) 用于制造乙醚 v6 兼容.

eth-sdk由deth(@dethcrypto)创建和维护.

许可证

(@dethcrypto) 麻省理工学院

由Gnosis Guard(@gnosguild)麻省理工学院提供


安装

yarn add --dev @gnosis-guild/eth-sdk @gnosis-guild/eth-sdk-client

eth-sdk 使用醚 v6 和 TypeScript,所以这些依赖性也必须安装.

使用量

eth-sdk [options]

CLI 选项

选项 :

  • -p, --path <path> 工作目录( 默认 ): ./eth-sdk(中文(简体) )

    eth-sdk 查找此目录中的配置文件, 并保存已下载的 ABIs .

开始

eth-sdk 取 JSON 配置文件, 并带有 ethereum 地址, 并生成一个完全类型安全的 SDK, 您可以右用 离开。 SDK是一个由乙醚构成的物体。js 合同以乙醚扫描提供的ABI 初始化,并且有种类 通过TypeChain生成.

第一步是创建一个配置文件来指定我们希望与之互动的合同. 此文件的默认路径 实值 eth-sdk/config.ts。 。 。 .

import { defineConfig } from '@gnosis-guild/eth-sdk'

export default defineConfig({
  contracts: {
    mainnet: {
      dai: '0x6b175474e89094c44da98b954eedeac495271d0f',
    },
  },
})

直接在下面的密钥 "contracts" 是一个网络标识符, eth-sdk 需要自动查询 ABI 信息. 下面是合同名称和地址的钥匙值对。 这些可以深深地筑巢.

现在你准备逃跑了 yarn eth-sdk在引擎盖下发生的事情很少:

  1. 将询问Etherscan API, 以查找与地址相对应的 ABI 。 ABI 将下载到 eth-sdk 目录(你应当承诺他们在未来加快进程).
  2. 最小 SDK 将生成诸如 getMainnetSdk 暴露了 暴露了 这些功能带ABIs的有线地址 并创建 ethers.js 合同实例.
  3. TypeScript类型将使用TypeChain为SDK生成.
  4. SDK直接生成到 node_modules,作为 @gnosis-guild/eth-sdk-client。 。 。 .

使用生成的 sdk 很容易:

import { getMainnetSdk } from '@gnosis-guild/eth-sdk-client' // yay, our SDK! It's tailored especially for our needs
import { ethers } from 'ethers'

async function main() {
  const mainnetProvider = ethers.getDefaultProvider('mainnet')
  const defaultSigner = ethers.Wallet.createRandom().connect(mainnetProvider)

  const sdk = getMainnetSdk(defaultSigner) // default signer will be wired with all contract instances
  // sdk is an object like { dai: DaiContract }

  const balance = sdk.dai.balanceOf(defaultSigner.address)
}

main()
  .then(() => console.log('DONE'))
  .catch((error) => {
    console.error(error)
    process.exit(1)
  })

配置

eth-sdk 查找名为的文件 config 或者说 eth-sdk.config 与 .ts, (中文(简体) ), .json, (中文(简体) ), .js 或者说 .cjs 扩展到 指定目录 --path CLI论点.

您可以使用导出 @gnosis-guild/eth-sdk 利用你的IDE的智慧 导出类型为 EthSdkConfig, (中文(简体) ), EthSdkContracts, (中文(简体) ), NestedAddresses 财务报告和审定财务报表 Address。 。 。 .

import type { EthSdkConfig } from '@gnosis-guild/eth-sdk'
const config: EthSdkConfig = {
  // ...
}
export default config

或者,你可以使用 defineConfig 函数可以将配置以安全的方式写入,而不需要附加说明.

import { defineConfig } from '@gnosis-guild/eth-sdk'
export default defineConfig({
  // ...
})

contracts

从网络标识符到深层密钥值对的合同名称和地址的地图.

{
  "contracts": {
    "eth": {
      "dai": "0x6b175474e89094c44da98b954eedeac495271d0f",
      "dao": {
        "mkr": "0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2"
      }
    }
  }
}

支持的网络标识符有:

"eth"                 "holesky"              "sep"
"gno"                 "base"                 "basesep"
"bsc"                 "oeth"                 "matic"
"arb1"                "avax"                 "celo"
"sonic"               "berachain"            "mantle"
"zkevm"               "unichain"             "wc"
"bob"                 "hemi"                 "katana"
"linea"               "ink"                  "blast"
"flare"

outputPath

生成的 SDK 输出目录 .

默认为 ./node_modules/.gnosisguild/eth-sdk

{
  "outputPath": "./node_modules/.gnosisguild/eth-sdk"
}

实例

检查使用实例 eth-sdk 内 /examples 目录.

视频

动机和使用案件

项目的主要动机是减少与Ethereum上的智能合同互动所需的仪式 同时使用 JavaScript 或 TypeScript 。 它照顾无聊的部分,如ABI管理 和自动基因所有 安装乙醚所需的锅炉板.js合同实例。 最后,它让DX大 通过确保所有的合同 拥有类型信息以便您的 IDE 帮助您 .

它与各种脚本,后端服务,甚至前端的app都效果很好. 注:如果开发智能合同 最好直接使用TypeChain(特别是通过HardHat集成).

捐款

看看我们 提供指南。 。 。 .

版本与发布记录

@gnosis-guild/eth-sdk 共发布 8 个版本,首次发布于 2024/08/28;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.4.0latest2025/09/291.1 年前
0.3.102025/07/261.3 年前
0.3.92025/05/291.5 年前
0.3.82025/04/031.6 年前
0.3.72024/08/292 年前
0.3.62024/08/282 年前

关于 @gnosis-guild/eth-sdk 的常见问题

@gnosis-guild/eth-sdk 是什么?

🛠 为你的"伊特鲁姆"智能合同生成型号安全而轻巧的 SDK

如何安装 @gnosis-guild/eth-sdk?

在项目目录运行 npm install @gnosis-guild/eth-sdk,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:ethers(^6)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。它还提供命令行工具 eth-sdk,可以用 npx eth-sdk 直接运行。

@gnosis-guild/eth-sdk 支持 TypeScript 吗?

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

@gnosis-guild/eth-sdk 支持 ESM 还是 CommonJS?

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

@gnosis-guild/eth-sdk 可以商用吗?

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

@gnosis-guild/eth-sdk 的下载量有多少?

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

@gnosis-guild/eth-sdk 还在维护吗?

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