npm 包 @typechain/ethers-v5 使用教程

AI 编程助手，豆包旗下的编程助手，提供智能补全、智能预测、智能问答等能力，节省开发时间，释放脑海中的创造力，支持 VSCode，点击体验 AI

什么是 @typechain/ethers-v5

@typechain/ethers-v5 是一个基于 ethers.js 的 TypeScript 类型生成器，可用于增强 Solidity 智能合约与 JavaScript 应用程序之间的类型安全性，使其支持 ethers.js v5 版本。

如何使用 @typechain/ethers-v5

安装：

--- ------- ---------- --------------------

第一步：编写 Solidity 智能合约

在 Solidity 智能合约中定义好要使用的智能合约：

-- --------------
------ -------- -------

-------- ---------- -
  ------ ------ -----
  
  ------------------ ------ ------ -
    ---- - ------
  -
-

第二步：编写 TypeScript 类型定义

在 TypeScript 文件中编写与 Solidity 智能合约对应的 TypeScript 类型定义：

-- -------------
------ - ------ - ---- ---------
------ - --------------- - ---- -----------------------

----- ------------- - - -- -- --- -- --
----- ------------------ - ----------- -- -- -------- --

------ ---- ---------- - -
    ----- -- -- ----------------
-

------ ----- ----------------- - --- ------------------------------------------ -------------------------------------------------------- -- ----

第三步：使用类型定义与智能合约交互：

在 TypeScript 文件中使用 MyContractFactory 创建智能合约实例，通过调用类型定义中定义的方法访问智能合约：

-- --------
------ - ----------------- - ---- ---------------

----- -------- ------ -
  ----- -------- - ------------------------------------- --------

  ----------------- ----------------- -- -------
-

----------------------------

@typechain/ethers-v5 示例代码

代码结构

├── contracts │ └── MyContract.sol ├── src │ ├── MyContract.ts │ └── index.ts ├── test │ └── MyContract.test.ts ├── typechain │ └── index.d.ts ├── hardhat.config.ts ├── package.json └── tsconfig.json

使用步骤

  1. 安装依赖
--- ------- ---------- ------ --------- ------- --------------------
  1. 创建 Solidity 智能合约

在项目的 contracts 文件夹中创建 MyContract.sol 文件:

-- ------------------------
-- ------------------------ ---
------ -------- -------

-------- ---------- -
  ------ ------ -----

  ------------------ ------ ------ -
    ---- - ------
  -
-
  1. 编译 Solidity 智能合约

在项目的根目录中创建 hardhat.config.ts 文件：

-- -----------------
------ - ----------------- - ---- -----------------------

----- ------- ----------------- - -
  --------- -
    -------- --------
  --
--

------ ------- -------

在项目根目录中运行下面的命令来编译智能合约：

--- ------- -------
  1. 自动生成 TypeScript 类型定义

运行下面的命令来生成 TypeScript 类型定义：

--- --------- -------- --------- --------- --------- ----- ---------------
  1. 编写使用 TypeScript 类型定义的代码
-- -----------------
------ - ------ - ---- ---------
------ - --------------- - ---- -----------------------
------ - ---------- - ---- --------------------------

----- ------------- - --- -- --- ----
----- ------------------ - ----------- -- -- -------- --

------ ----- ----------------- - --- ------------------------------------------ ---------------------------
  -------
- -- ----

-- ------------
------ - ----------------- - ---- ---------------

----- -------- ------ -
  ----- -------- - ---------------------------------- ----------

  ----------------- ----------------- -- -------
-

----------------------------

-- -----------------------
------ - ------ - ---- ---------
------ - ----------------- - ---- --------------------

---------------------- -- -- -
  --- --------- ----

  ---------------- -- -- -
    ----- ------ - --- ------------------------------- ----------
    -------- - ----- -------------------------------------------- -------
  ---

  ---------- ---- - ------ ----- -- -- -
    ------------ ---------------------------- -------
  ---
---

结论

@typechain/ethers-v5 是一个使得 Solidity 智能合约与 JavaScript 应用程序之间类型更加安全的 TypeScript 类型生成器，可以充分利用 TypeScript 的类型系统来减少团队之间的沟通，增强代码的可维护性和可读性。通过本文的介绍和示例代码，读者可以更加深入地了解和使用 @typechain/ethers-v5。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/5f30d7dc3b0ab45f74a8bccd

阅读全文

猜你喜欢

  • npm 包 light-ts-loader 使用教程

    如果你是一名前端开发者，那么你一定知道 TypeScript 在现代的前端开发中扮演了很重要的角色。而使用 TypeScript 进行开发的话，建议使用 webpack 进行打包。

    4 年前
  • npm 包 jss-plugin-vendor-prefixer 使用教程

    在前端开发过程中，我们经常需要考虑浏览器的兼容性，特别是对于 CSS 样式的兼容性处理。而 jss-plugin-vendor-prefixer 是一款可以帮助我们在 CSS 样式中自动添加浏览器厂商...

    4 年前
  • npm 包 @asset-pipe/css-reader 使用教程

    前言 在前端开发中，CSS 是不可或缺的一部分，而我们在项目中往往需要频繁的操作 CSS，如读取、分析、修改等等。因此，如果有一款能够实现这些操作的工具，将会大大提升开发效率。

    4 年前
  • npm 包 @asset-pipe/js-reader 使用教程

    在前端开发中，我们经常需要读取并处理 JavaScript 文件。而此时，@asset-pipe/js-reader 的功能就变得非常有用了。该 npm 包可以让我们轻松地读取 JavaScript ...

    4 年前
  • npm 包 @asset-pipe/sink-fs 使用教程

    简介 @asset-pipe/sink-fs 是一个在 Node.js 中使用的 npm 包，用于将输入流的内容保存到文件系统中的指定位置。如果你需要将程序输出保存到文件中，如日志文件或者静态资源文件...

    4 年前
  • npm 包 @asset-pipe/sink-mem 使用教程

    前言 在前端开发中，流水线（pipe）的概念是非常重要的，它能够将代码构建、压缩、合并等工作进行整合，提高开发效率和代码质量。而其中的一个重要部分就是数据“汇流处”——sink。

    4 年前
  • npm 包 @asset-pipe/server 使用教程

    在现代的前端开发中，模块化已经成为主流，很多项目都采用了模块化的开发方式。而在模块化的开发中，前端经常需要使用一些模块化的资源，如 CSS、 JS 等。而这些资源的管理，包括资源的打包、压缩、版本管理...

    4 年前
  • npm 包 @4c/build 使用教程

    简介 npm 是前端开发不可或缺的工具之一。@4c/build 是一款专门为前端开发量身定制的 npm 包，它提供了一套高效，易用，可定制的前端项目构建工具。使用 @4c/build 可以大大简化前端...

    4 年前
  • npm 包 @4c/init 使用教程

    在前端领域中，我们经常需要创建新的项目或者初始化现有项目的依赖。npm 是一个非常好用的依赖管理工具，在 npm 中可以找到很多有用的包，其中 @4c/init 是一个非常实用的包，可以帮助我们快速初...

    4 年前
  • npm 包 @4c/intl 使用教程

    在前端开发过程中，多语言支持是一个必不可少的功能。在市场上有许多提供多语言支持的工具和库，其中 @4c/intl 是一款非常优秀的 NPM 包。本文将介绍如何正确地使用 @4c/intl 进行多语言支...

    4 年前
  • npm 包 svg2c 使用教程

    前言 SVG是一种基于XML语法的矢量图形，在Web前端开发中被广泛应用。而npm是JavaScript中最经典的包管理器之一，被众多开发者使用。本文将介绍如何使用npm包svg2c将SVG矢量图像转...

    4 年前
  • npm 包 @manypkg/find-root 使用教程

    前言 在前端开发项目中，我们使用 npm 进行包管理是非常常见的。但是，有时候我们需要找到项目的根目录，这对于一些工具库的开发和测试非常有用。在这种情况下，npm 包 @manypkg/find-ro...

    4 年前
  • npm 包 @manypkg/get-packages 使用教程

    介绍 npm 是 JavaScript 的包管理器，被广泛应用于前端、后端、桌面应用程序等领域。当使用多个 npm 包时，我们需要知道这些包之间的依赖关系和版本约束，以便正确引入和管理这些包。

    4 年前
  • 使用 npm 包 ts-doctor 进行 TypeScript 代码修复：教程

    在前端开发中，TypeScript 是一种比较流行的静态类型语言。但是，开发者也可能会遇到一些令人困惑的 TypeScript 错误，这些错误可能出现在编译期间，也可能出现在开发期间。

    4 年前
  • npm 包 @4c/cli 使用教程

    介绍 @4c/cli 是一个基于 Node.js 平台的脚手架工具，它基于 Vue.js 和 Element 两个优秀的前端开源项目进行封装，旨在提供更快捷舒适的前端项目创建和脚手架管理体验。

    4 年前
  • npm 包 signedsource 使用教程

    前言 在前端开发过程中，代码质量非常重要。为确保代码的完整性和安全性，许多公司使用代码签名来验证代码的来源和完整性。其中一个流行的签名方案是 Facebook 开源的 signedsource，本篇文...

    4 年前
  • npm 包 @jsenv/cancellation 使用教程

    在 Web 开发中，我们经常需要处理异步任务。在某些情况下，我们可能需要取消正在执行的异步任务。例如，当用户在搜索框中输入文字时，我们需要取消之前的搜索请求并发起一个新的搜索请求。

    4 年前
  • npm 包 @jsenv/import-map 的使用教程

    概述 在现代 web 应用程序中，JavaScript 依赖管理是一个关键的问题。为了解决这个问题，使用模块化编程已经成为了一种标准，而 ES Modules 是其中最为流行的模块化形式。

    4 年前
  • npm 包 @jsenv/logger 使用教程

    在前端开发过程中，我们经常需要记录一些调试信息或日志，便于排查问题或分析运行状况。而 npm 包 @jsenv/logger 提供了一种简单、灵活的日志记录方式，本文就来介绍如何使用它。

    4 年前
  • npm 包 @jsenv/node-module-import-map 使用教程

    随着前端发展的不断深入，前端工程化已成为现代前端开发的必须要掌握的技能之一。而随着前端应用日益庞大和复杂，模块化开发也变得越来越重要。npm 是一个非常强大、流行的包管理工具。

    4 年前

相关推荐

    暂无文章