以太坊API使用详解：解锁区块链世界的钥匙

以太坊 API 使用指南：解锁区块链世界的钥匙

以太坊 API (Application Programming Interface) 是一组预定义的函数和协议，允许软件应用程序与以太坊区块链进行交互。理解并有效利用以太坊 API 是构建去中心化应用程序 (dApps)，执行智能合约，以及分析区块链数据的关键。本文将深入探讨如何使用以太坊 API，并提供实际示例。

1. 核心概念

在开始使用以太坊 API 与以太坊区块链进行交互之前，充分理解以下几个核心概念至关重要。这些概念是构建和部署去中心化应用 (DApps) 以及与以太坊网络进行有效通信的基础：

• 以太坊区块链：

  以太坊是一个去中心化的、开源的区块链平台，它支持智能合约的创建和执行。与比特币主要用于价值转移不同，以太坊旨在构建一个通用的分布式计算平台。区块链本身是一个由区块组成的链式结构，每个区块包含交易数据，并通过密码学方式链接到前一个区块，从而保证数据的不可篡改性和透明性。

• 账户 (Accounts)：

  以太坊中有两种类型的账户：外部拥有账户 (EOA) 和合约账户。EOA 由私钥控制，用于发起交易。合约账户则包含代码 (智能合约) 和存储，由其代码控制，并在收到交易时执行相应的逻辑。每个账户都有一个唯一的以太坊地址，用于标识该账户。

• 交易 (Transactions)：

  交易是用户与以太坊网络交互的基本方式。交易可以用于转移以太币 (ETH) 或调用智能合约的功能。每笔交易都必须由发送方的私钥签名，并支付一定的 gas 费用，用于补偿矿工验证和执行交易所需的计算资源。

• Gas：

  Gas 是以太坊虚拟机 (EVM) 执行操作的燃料。每项操作 (例如，加法、乘法、存储数据) 都需要消耗一定数量的 gas。交易发起者需要为交易设置 gas 限制 (gas limit) 和 gas 价格 (gas price)。gas limit 是交易允许消耗的最大 gas 量，gas price 是用户愿意为每单位 gas 支付的以太币数量。矿工会优先选择 gas price 较高的交易进行处理。

• 智能合约 (Smart Contracts)：

  智能合约是部署在以太坊区块链上的、用 Solidity 等编程语言编写的程序。智能合约包含代码和数据，可以自动执行预定义的规则和逻辑。它们被广泛用于构建各种去中心化应用，例如去中心化金融 (DeFi)、供应链管理和数字身份验证。

• 以太坊虚拟机 (EVM)：

  EVM 是以太坊的核心组件，负责执行智能合约的代码。它是一个沙盒环境，可以安全地执行代码，而不会对底层系统造成影响。EVM 采用堆栈式架构，并支持一套完整的指令集，用于执行各种计算操作。

• Web3.js/Ethers.js：

  Web3.js 和 Ethers.js 是用于与以太坊区块链交互的 JavaScript 库。它们提供了 API，允许开发者连接到以太坊节点、发送交易、调用智能合约的功能以及监听区块链事件。这些库简化了与以太坊网络的交互，并为 DApp 开发提供了便利。

• 节点 (Nodes)：

  以太坊网络由许多节点组成，每个节点都维护着区块链的一个副本。节点可以是完整节点 (full node)，存储完整的区块链历史记录；也可以是轻节点 (light node)，仅存储部分区块链数据。开发者可以通过连接到节点来访问以太坊网络，并与区块链进行交互。Infura 和 Alchemy 等服务提供了托管的以太坊节点服务，方便开发者使用。

节点 (Node): 以太坊网络由许多节点组成，每个节点都存储着区块链的完整或部分副本。我们需要连接到至少一个节点才能与区块链交互。

Provider: Provider 是一个抽象层，它封装了与以太坊节点通信的细节。它提供了一组简单的 API，允许我们发送请求并接收响应。常见的 Provider 包括：

• HTTP Provider: 通过 HTTP 连接到节点。
• WebSocket Provider: 通过 WebSocket 连接到节点，提供实时的事件订阅功能。
• Infura/Alchemy: 第三方托管的 Provider，提供稳定且可扩展的节点基础设施，无需自己运行节点。

Web3.js/Ethers.js: JavaScript 库，简化了与 Provider 交互的过程，提供了更友好的 API，例如调用智能合约函数，发送交易等。

账户 (Account): 以太坊账户用于存储和发送以太币 (Ether) 和其他代币，以及部署和执行智能合约。账户由一个公钥 (地址) 和一个私钥组成。私钥用于签名交易，证明交易的授权。

交易 (Transaction): 交易是状态变更的原子单元。它可以是发送以太币，部署智能合约，调用智能合约函数等操作。

智能合约 (Smart Contract): 在以太坊区块链上运行的计算机程序，它定义了规则和逻辑，自动执行合约条款。

2. 选择 Provider

选择合适的 Provider 是使用以太坊 API 的关键第一步。Provider 是以太坊网络的一个接入点，它允许你的应用程序与区块链进行交互。它本质上是你的应用程序和以太坊网络之间的桥梁。

Provider 的选择直接影响到你的应用程序的性能、安全性以及与以太坊网络的兼容性。常见的 Provider 类型包括：

• Infura： 一个流行的托管 Provider，提供可靠的以太坊节点基础设施。Infura 简化了与以太坊网络的连接过程，无需运行自己的节点。它提供了分层定价，适合不同规模的应用。
• Alchemy： 与Infura类似，Alchemy也提供强大的API和开发者工具，专注于提供更高级的功能，例如增强的监控和调试工具，更适合对性能和可靠性有较高要求的项目。
• MetaMask： 一个流行的浏览器扩展，同时也是一个 Provider。MetaMask 允许用户管理自己的以太坊账户，并与 DApp 进行交互。当用户使用 MetaMask 时，它会自动将自己注入到网页中，作为Provider供DApp调用。
• Ganache： 一个本地的以太坊模拟器，用于开发和测试目的。Ganache 允许你在本地创建一个私有的以太坊区块链，方便你进行合约部署、测试和调试。
• 自定义节点： 你可以运行自己的以太坊节点（例如 Geth 或 Parity），并将其作为 Provider。这种方式提供了最大的控制权，但需要更多的技术知识和资源。

在选择 Provider 时，请考虑以下因素：

• 可靠性： Provider 是否稳定可靠？它是否能够处理大量的请求？你需要考察Provider的历史表现和SLA(服务水平协议)。
• 安全性： Provider 是否安全？它是否采取了必要的安全措施来保护你的数据？选择信誉良好且具有完善安全措施的Provider至关重要。
• 性能： Provider 的响应速度如何？选择延迟低的Provider可以显著提升用户体验。
• 成本： Provider 的价格如何？你需要根据你的预算和需求选择合适的 Provider。许多Provider提供免费套餐，适合开发和测试阶段使用，但通常会限制请求数量。
• 功能： Provider 提供了哪些功能？例如，它是否支持最新的以太坊改进提案（EIP）？不同的Provider支持的功能集可能不同，根据项目的具体需求选择。

理解这些因素将帮助你为你的以太坊应用程序选择最佳的 Provider，并确保你的应用程序能够平稳、安全地与区块链进行交互。

2.1 自己运行节点

这是参与以太坊网络最去中心化且无需信任中介的方式，但它也对资源和技术能力提出了较高要求。要实现这一点，你需要下载并持续运行一个以太坊客户端软件，例如 Geth、Parity（现已停止维护，建议使用 OpenEthereum 或其他替代方案）或 Nethermind。每个客户端都有其独特的配置选项和资源需求。

运行全节点需要下载并存储完整的以太坊区块链数据，这需要数百 GB 的硬盘空间，并且随着时间的推移还会不断增长。还需要稳定的网络连接和充足的内存 (RAM) 以确保节点能够同步并验证交易。节点运营者需要了解区块同步、交易验证、共识机制以及潜在的安全风险。

除了全节点，还有诸如轻节点（Light Node）这样的选择，它们只下载区块头，依赖全节点来获取交易相关信息，资源占用较少，但安全性也相对降低。还有Archive Node，它存储了以太坊区块链的历史状态，允许查询任何历史时间点的链上数据，但需要的存储空间巨大。

选择自己运行节点的优势在于完全掌控自己的数据和交易，无需信任第三方，并为网络的去中心化做出贡献。 但这也意味着需要承担节点维护、升级和安全防护的责任。

优点：

• 完全控制您的节点： 运行您自己的节点赋予您对区块链网络交互的绝对控制权。 您可以自定义节点配置、选择要验证的交易类型以及直接参与共识机制，无需依赖外部服务或妥协您的偏好。 这对于需要特定节点行为或参与高级网络功能的个人和组织来说至关重要。
• 最高级别的隐私保护： 通过直接与区块链交互，您无需通过第三方服务器路由您的交易或查询，从而最大程度地减少了您的数据暴露。 您的IP地址和交易历史记录不会与中心化服务相关联，从而显著增强了您的财务隐私。 这对于重视匿名性和防止数据收集的用户来说至关重要。
• 消除对第三方的信任依赖： 运行您自己的节点意味着您不需要信任任何中介机构来验证交易或维护区块链的完整性。 您可以独立验证区块链的状态和交易的有效性，从而避免了与托管服务相关的风险，例如审查、欺诈或服务器故障。 这种信任最小化的方法是去中心化技术的核心优势。

缺点：

• 硬件资源消耗高昂： 运行完整的区块链节点需要大量的计算能力、存储空间和网络带宽。这可能需要高性能的CPU、大容量的内存和快速的固态硬盘(SSD)，从而导致较高的硬件成本。对于个人用户或小型组织而言，这可能是一个显著的经济负担。
• 节点维护与更新复杂： 节点需要定期维护，包括软件更新、安全补丁应用以及硬件维护。区块链技术的不断发展意味着节点软件也需要频繁升级，以保持与最新协议的兼容性并修复潜在的安全漏洞。节点运营者需要具备一定的技术知识和时间投入。
• 初始同步时间较长： 首次启动节点时，需要下载并验证整个区块链历史记录。对于像比特币或以太坊这样已经存在多年的区块链，同步过程可能需要几天甚至几周的时间，具体取决于网络速度和硬件性能。这对于希望快速参与区块链网络的用户来说是一个明显的障碍。

2.2 使用第三方托管 Provider (Infura/Alchemy)

Infura 和 Alchemy 等第三方托管 Provider 提供了稳定且易于访问的以太坊节点基础设施，开发者无需自行维护和同步以太坊节点，从而显著简化了区块链应用的开发过程。这些服务商提供了 HTTP 和 WebSocket API 接口，方便开发者与以太坊网络进行交互，包括读取链上数据、发送交易等操作。

Infura 和 Alchemy 通常提供分层定价模式，包括免费的 API 密钥，允许开发者在项目初期阶段免费使用其服务，进行测试和原型开发。免费套餐一般会有请求次数或流量限制。随着应用规模的增长和需求的增加，开发者可以选择付费升级到更高级的套餐，以获得更高的性能、更大的流量配额以及额外的功能支持，例如更快的响应时间、更高级的分析工具和专门的技术支持。

使用托管 Provider 还能降低开发者的运维成本，避免了因节点故障或同步问题导致的应用中断。Provider 负责维护节点的稳定性和可用性，并定期进行安全更新，确保开发者可以专注于应用逻辑的开发，而无需担心底层基础设施的问题。

优点:

• 易于使用: 用户界面友好，操作简单直观，降低了使用门槛，即使是区块链新手也能快速上手。同时，通常提供完善的文档和社区支持，方便用户学习和解决问题。
• 可扩展性强: 系统架构设计允许灵活扩展，能够适应不断增长的数据量和交易需求。通过模块化设计和可插拔组件，可以轻松添加新功能和优化性能，而不会影响现有系统的稳定性。水平扩展能力保证了在高并发情况下也能保持高效运行。
• 无需维护节点: 用户无需承担运行和维护区块链节点的复杂任务，例如节点同步、安全更新和硬件维护。平台或服务提供商负责基础设施的维护，用户可以专注于业务逻辑的开发和应用，大大降低了运营成本和技术负担。这使得用户能够更专注于核心业务，而不是底层技术细节。

缺点:

• 依赖第三方服务: 使用API Key调用第三方AI服务意味着您的应用功能依赖于这些服务的可用性和稳定性。 若第三方服务出现故障、维护或停止服务，您的应用功能也会受到影响。您需要仔细评估服务提供商的SLA(服务级别协议)，确保其能满足您的应用需求。
• 可能存在审查风险: 通过第三方API Key接入AI服务，数据可能需要经过第三方服务器，这可能会带来审查风险。 尤其是在处理敏感数据时，需要仔细评估服务提供商的数据安全和隐私保护措施，了解其数据处理策略是否符合相关法律法规要求，避免数据泄露或滥用风险。
• 免费版本有速率限制: 许多第三方AI服务提供免费版本，但通常会设置速率限制，例如每分钟或每天的API调用次数限制。 这可能会影响应用的性能和用户体验，特别是当应用需要处理大量请求时。 如果需要更高的调用频率，通常需要升级到付费版本，增加运营成本。 免费版本在功能上也可能受到限制。

3. 利用 Web3.js 或 Ethers.js 进行交互

Web3.js 和 Ethers.js 是在 JavaScript 环境中与以太坊区块链进行交互的主流库。它们通过封装底层的 RPC (Remote Procedure Call) 调用，简化了与以太坊节点的通信过程。这些库为开发者提供了全面的 API，以便执行各种区块链操作。选择哪个库通常取决于个人偏好和项目需求；Web3.js 历史更悠久，社区更庞大，而 Ethers.js 则以其更小的体积、更现代的设计和更好的 TypeScript 支持而著称。

• 建立与 Provider 的连接：

  要与以太坊区块链交互，首先需要连接到一个 Provider。Provider 是一个到以太坊节点的接口，可以是本地节点 (如 Ganache)，也可以是远程节点 (如 Infura 或 Alchemy)。Web3.js 和 Ethers.js 都提供了连接到不同 Provider 的方法。连接 Provider 允许你的应用程序读取区块链数据并提交交易。

• 获取账户余额：

  这些库允许你查询任何以太坊账户的余额。这对于显示用户的资产或在执行交易前验证账户是否有足够的资金至关重要。余额通常以 Wei 为单位返回，你需要将其转换为 Ether 以方便用户理解。

• 发送交易：

  发送交易是将数据写入区块链的关键操作。这可以包括转账 ETH、调用智能合约函数或部署新的智能合约。使用这些库，你可以创建、签名和广播交易。签名过程需要用户的私钥，因此通常需要通过 MetaMask 等钱包进行授权。

• 调用智能合约函数：

  智能合约是部署在区块链上的代码，可以通过交易调用其函数。Web3.js 和 Ethers.js 允许你创建合约对象，该对象代表智能合约，并提供调用其函数的便捷方法。你可以调用只读函数 (不改变区块链状态) 和需要付费的函数 (改变区块链状态)。

• 订阅事件：

  智能合约可以发出事件，这些事件是关于合约状态变化的通知。你可以使用 Web3.js 和 Ethers.js 订阅这些事件，并在事件发生时收到通知。这对于构建实时应用程序 (如交易所或游戏) 非常有用。通过监听特定事件，你的应用程序可以立即响应区块链上的变化。

3.1 安装 Web3.js

Web3.js 是一个与以太坊区块链交互的 JavaScript 库。它允许开发者通过 JavaScript 代码与以太坊节点通信，从而实现诸如读取区块链数据、发送交易、部署智能合约等功能。安装 Web3.js 是开发以太坊 DApp 的第一步。

你可以使用 npm（Node Package Manager）来安装 Web3.js。npm 是 Node.js 的默认包管理器，用于安装、更新和管理 JavaScript 项目的依赖项。如果你的系统中没有安装 Node.js 和 npm，需要先进行安装。你可以从 Node.js 官网下载并安装适合你操作系统的版本。

安装 Web3.js 的命令如下：

npm install web3

这条命令会在你的项目目录下安装 Web3.js 及其依赖项，并将 Web3.js 添加到你的 package. 文件中。安装完成后，你就可以在你的 JavaScript 代码中引入并使用 Web3.js 了。在你的JavaScript文件中，使用以下代码引入web3:

const Web3 = require('web3');

如果你的项目使用模块化打包工具，如 Webpack 或 Parcel，你可以直接使用 import 语句引入 Web3.js：

import Web3 from 'web3';

Web3.js 还提供了不同的版本。你可以选择安装特定版本的 Web3.js，以满足你的项目需求。例如，要安装 Web3.js 的 1.0 版本，可以使用以下命令：

npm install [email protected]

务必查阅 Web3.js 的官方文档，了解最新的 API 和使用方法。同时，注意不同版本的 Web3.js 可能存在 API 上的差异，选择合适的版本并保持代码的兼容性至关重要。

3.2 安装 Ethers.js

Ethers.js 是一个与以太坊区块链交互的完备且经过良好测试的 JavaScript 库。它提供了一系列实用工具，用于创建钱包、签署交易、与智能合约交互等。要开始使用 Ethers.js，您需要先将其安装到您的项目中。

您可以使用 npm（Node Package Manager）来安装 Ethers.js。npm 是 Node.js 的默认包管理器，如果您尚未安装 Node.js 和 npm，请先进行安装。

打开您的终端或命令提示符，导航到您的项目目录，然后运行以下命令：

npm install ethers

此命令将从 npm 仓库下载 Ethers.js 及其依赖项，并将它们安装到您的 node_modules 目录中。安装完成后，您就可以在您的 JavaScript 代码中导入和使用 Ethers.js 了。

如果您使用 yarn 作为您的包管理器，您可以使用以下命令安装 Ethers.js：

yarn add ethers

与 npm 类似，yarn 会下载并安装 Ethers.js 及其依赖项。选择您喜欢的包管理器，并使用相应的命令来安装 Ethers.js。

3.3 连接到 Provider (Web3.js)

Web3.js 是一个用于与以太坊区块链交互的 JavaScript 库。在使用 Web3.js 之前，你需要将其引入到你的项目中。可以使用 npm 或 yarn 等包管理器进行安装：

npm install web3

引入 Web3.js 库：

const Web3 = require('web3');

要与以太坊网络进行交互，你需要连接到一个 Provider。Provider 是一个中间件，它负责与以太坊节点通信。Web3.js 支持多种 Provider，包括 HTTP Provider 和 WebSocket Provider。

使用 Infura HTTP Provider：

Infura 是一个托管的以太坊节点服务，它允许你无需运行自己的以太坊节点即可访问以太坊网络。要使用 Infura，你需要注册一个账号并创建一个项目，获取你的 Infura 项目 ID。

// 使用 Infura HTTP Provider
const web3 = new Web3(new Web3.providers.HttpProvider('https://mainnet.infura.io/v3/YOUR_INFURA_PROJECT_ID'));

请将 YOUR_INFURA_PROJECT_ID 替换为你自己的 Infura 项目 ID。

使用 WebSocket Provider：

WebSocket Provider 提供了与以太坊节点的双向通信通道，这使得它更适合于需要实时更新的应用程序。

// 使用 WebSocket Provider
const web3 = new Web3(new Web3.providers.WebsocketProvider('wss://mainnet.infura.io/ws/v3/YOUR_INFURA_PROJECT_ID'));

同样，请将 YOUR_INFURA_PROJECT_ID 替换为你自己的 Infura 项目 ID。选择 HTTP Provider 还是 WebSocket Provider 取决于你的应用需求。对于大多数应用，HTTP Provider 已经足够。如果需要实时更新，WebSocket Provider 可能是更好的选择。

其他 Provider 选项：

除了 Infura，你还可以使用其他 Provider，例如：

• MetaMask： MetaMask 是一个浏览器扩展程序，它充当以太坊钱包和 dApp 之间的桥梁。它可以作为 Provider 使用，让用户可以直接从浏览器与以太坊网络交互。
• Ganache： Ganache 是一个用于本地以太坊开发的工具，它可以让你快速启动一个私有以太坊区块链，用于测试和开发。
• Alchemy： Alchemy 也是一个托管的以太坊节点服务，类似于 Infura，提供了可靠的基础设施来构建和运行 dApp。

选择合适的 Provider 取决于你的开发环境和应用需求。

3.4 连接到 Provider (Ethers.js)

Ethers.js 是一个强大的 JavaScript 库，用于与以太坊区块链及其生态系统进行交互。要开始使用 Ethers.js，你需要连接到一个 Provider。Provider 是一个抽象概念，代表了与以太坊网络的连接。它允许你读取区块链数据、查询账户余额以及发送交易。

你可以通过多种方式连接到 Provider，包括使用 HTTP Provider 或 WebSocket Provider。选择哪种 Provider 取决于你的需求和应用场景。

安装 Ethers.js 库：

确保你的项目中已经安装了 Ethers.js 库。你可以使用 npm 或 yarn 进行安装：

npm install ethers
# 或者
yarn add ethers

引入 Ethers.js：

在你的 JavaScript 代码中，引入 Ethers.js 库：

const { ethers } = require("ethers");

使用 Infura HTTP Provider：

Infura 是一个托管的以太坊节点基础设施，它提供了一个简单的方式来连接到以太坊网络，而无需自己运行节点。Infura 提供 HTTP 和 WebSocket 两种类型的 Provider。

使用 Infura HTTP Provider 的示例代码如下：

// 使用 Infura HTTP Provider
const provider = new ethers.providers.InfuraProvider("mainnet", "YOUR_INFURA_PROJECT_ID");

在上面的代码中，你需要将 YOUR_INFURA_PROJECT_ID 替换为你自己的 Infura 项目 ID。你可以在 Infura 网站上创建一个免费账户并获取你的项目 ID。

第一个参数 "mainnet" 指定了要连接的以太坊网络。你可以将其更改为 "ropsten" , "kovan" , "rinkeby" , 或 "goerli" 等测试网络。

使用 WebSocket Provider：

WebSocket Provider 提供了实时、双向的通信通道，可以用于订阅区块链事件，例如新的区块或交易。相比于 HTTP Provider，WebSocket Provider 具有更低的延迟和更高的效率。

使用 WebSocket Provider 的示例代码如下：

// 使用 WebSocket Provider
const provider = new ethers.providers.WebSocketProvider(`wss://mainnet.infura.io/ws/v3/YOUR_INFURA_PROJECT_ID`);

同样，你需要将 YOUR_INFURA_PROJECT_ID 替换为你自己的 Infura 项目 ID。 确保 URL 中的协议是 wss:// ，而不是 https:// 。

Provider的选择:

选择 HTTP Provider 还是 WebSocket Provider 取决于你的应用需求。如果你的应用需要实时更新，例如显示最新的交易信息，那么 WebSocket Provider 是一个更好的选择。如果你的应用只需要偶尔读取区块链数据，那么 HTTP Provider 就足够了。

注意: 将 YOUR_INFURA_PROJECT_ID 替换为你的 Infura 项目 ID。

4. 常用 API 使用示例

4.1 获取账户余额

Web3.js

Web3.js 是一个以太坊 JavaScript API，它允许开发者与以太坊区块链进行交互。使用 Web3.js，你可以读取区块链数据、发送交易、部署智能合约以及与现有的智能合约进行交互。以下代码展示了如何使用 Web3.js 获取指定以太坊账户的余额。你需要替换 0xYOUR_ACCOUNT_ADDRESS 为你要查询的实际以太坊账户地址。

JavaScript 示例：

const address = '0xYOUR_ACCOUNT_ADDRESS';

这段代码定义了一个名为 address 的常量，它存储了要查询余额的以太坊账户地址。请确保将 0xYOUR_ACCOUNT_ADDRESS 替换为你想要查询的真实地址。

接下来，我们使用 web3.eth.getBalance() 方法来获取指定账户的余额。这个方法返回一个 Promise 对象，该 Promise 对象在成功时会返回账户的余额，余额的单位是 Wei。Wei 是以太坊中最小的货币单位。

web3.eth.getBalance(address)
  .then(balance => {
    console.log(`账户余额: ${web3.utils.fromWei(balance, 'ether')} ETH`);
  });

在上面的代码中， web3.eth.getBalance(address) 调用返回一个 Promise。我们使用 .then() 方法来处理 Promise 成功返回的结果。 balance 参数包含了账户的余额，单位是 Wei。

为了更方便地阅读余额，我们使用 web3.utils.fromWei(balance, 'ether') 方法将 Wei 转换为 ETH。 web3.utils.fromWei() 方法接受两个参数：要转换的 Wei 值和目标单位（这里是 'ether'）。

我们使用 console.log() 将账户余额打印到控制台。输出的格式是 账户余额: [余额] ETH ，其中 [余额] 是以 ETH 为单位的账户余额。

要运行这段代码，你需要确保已经安装了 Web3.js 库，并且已经连接到了一个以太坊节点。你可以使用 Infura、Alchemy 等服务提供商来连接到以太坊节点，也可以运行自己的以太坊节点。

Ethers.js

使用 Ethers.js 获取以太坊账户余额。需要一个以太坊provider连接到区块链网络。然后，指定要查询余额的账户地址。

JavaScript 代码示例：

const address = '0xYOUR_ACCOUNT_ADDRESS'; // 替换为你的以太坊账户地址

// 使用 provider 获取指定地址的余额
provider.getBalance(address)
  .then(balance => {
    // 将余额从 Wei 转换为 ETH，Wei 是以太坊的最小单位
    const balanceInEth = ethers.utils.formatEther(balance);

    // 在控制台打印格式化后的余额
    console.log(`账户余额: ${balanceInEth} ETH`);
  })
  .catch(error => {
    console.error("获取余额时发生错误:", error);
  });

代码解释：

• address ：这是一个字符串变量，用于存储要查询余额的以太坊账户地址。请确保替换 0xYOUR_ACCOUNT_ADDRESS 为你想要查询的真实账户地址。
• provider.getBalance(address) ：这是一个异步函数调用，它使用 Ethers.js 提供的provider实例（需要在代码中预先配置），从以太坊网络获取指定地址的余额。余额以 Wei 为单位返回。
• .then(balance => { ... }) ：这是一个 Promise 的 then 方法，用于处理异步操作 provider.getBalance(address) 成功完成后的结果。回调函数中的 balance 参数包含了账户的余额（以 Wei 为单位）。
• ethers.utils.formatEther(balance) ：这是一个 Ethers.js 实用函数，用于将以 Wei 为单位的余额转换为 ETH（以太币）。它将一个大的整数值（Wei）转换为更易读的十进制数值字符串（ETH），方便显示。
• console.log( 账户余额: ${ethers.utils.formatEther(balance)} ETH ) ：这行代码使用模板字符串将格式化后的余额打印到浏览器的控制台或 Node.js 的标准输出。
• .catch(error => { ... }) ：这是一个 Promise 的 catch 方法，用于捕获异步操作中发生的任何错误。如果获取余额的过程中出现问题（例如，网络连接错误、无效的地址等），错误信息将被打印到控制台。

注意：在使用此代码之前，你需要确保已经安装了 Ethers.js 库，并且正确配置了一个以太坊provider。 你需要替换 '0xYOUR_ACCOUNT_ADDRESS' 为你要查询的实际地址。你需要处理可能发生的错误，例如provider未连接或地址无效的情况。

注意: 将 0xYOUR_ACCOUNT_ADDRESS 替换为你要查询的账户地址。

4.2 发送交易

Web3.js

Web3.js 是一个以太坊 JavaScript API，它允许你与本地或远程以太坊节点进行交互。 下面的代码片段展示了如何使用 Web3.js 从一个账户向另一个账户发送以太币。

javascript
// 替换为你的账户地址和私钥。 请务必安全地保管你的私钥！
const account = '0xYOUR ACCOUNT ADDRESS';
const privateKey = 'YOUR PRIVATE KEY';
// 替换为接收者的以太坊地址
const to = '0xRECIPIENT_ADDRESS';
// 定义要发送的以太币数量，这里设置为0.01 ETH
const amount = web3.utils.toWei('0.01', 'ether');

下一步，我们需要创建一个交易对象，指定交易的接收者地址、发送的以太币数量以及 Gas Limit。

javascript
const transactionObject = {
to: to,
value: amount,
gas: 21000, // 预估 Gas Limit。根据实际情况调整，过低的 Gas Limit 会导致交易失败。
};

现在，我们使用 web3.eth.accounts.signTransaction 方法对交易进行签名。 这需要你的私钥。 签名后，我们将获得一个包含已签名交易信息的对象。

javascript
web3.eth.accounts.signTransaction(transactionObject, privateKey)
.then(signedTransaction => {
// 使用 web3.eth.sendSignedTransaction 发送已签名的交易
web3.eth.sendSignedTransaction(signedTransaction.rawTransaction)
.then(receipt => {
// 交易成功，receipt 对象包含交易的详细信息，例如交易哈希、区块号等。
console.log('交易成功!', receipt);
})
.catch(error => {
// 交易失败，打印错误信息。常见的错误包括余额不足、Gas Limit 不足等。
console.error('交易失败:', error);
});
});

重要提示： 在生产环境中，强烈建议使用更安全的方式管理私钥，例如使用硬件钱包或密钥管理系统。 直接在代码中存储私钥是非常不安全的做法。

Ethers.js

Ethers.js 是一个流行的 JavaScript 库，用于与以太坊区块链及其生态系统进行交互。它简化了与智能合约的交互、发送交易、查询链上数据等操作。以下代码展示了如何使用 Ethers.js 从一个以太坊地址向另一个地址发送以太币。

// 引入 ethers.js 库
const ethers = require('ethers');

// 定义账户地址、私钥、接收者地址和发送金额
const account = '0xYOUR_ACCOUNT_ADDRESS'; // 替换为你的以太坊地址
const privateKey = 'YOUR_PRIVATE_KEY'; // 替换为你的私钥，请务必安全保管！
const to = '0xRECIPIENT_ADDRESS'; // 替换为接收者地址
const amount = ethers.utils.parseEther('0.01'); // 发送 0.01 ETH，ethers.utils.parseEther 用于将 ETH 转换为 Wei

// 配置 Provider，连接到以太坊网络
// 这里使用 Infura 提供的 Goerli 测试网节点，你需要替换为自己的 Infura 项目 ID 或其他 Provider
const provider = new ethers.providers.JsonRpcProvider('https://goerli.infura.io/v3/YOUR_INFURA_PROJECT_ID');

// 使用私钥创建 Wallet 实例
const wallet = new ethers.Wallet(privateKey, provider);

// 打印 Wallet 地址，用于验证是否正确加载
console.log('Wallet 地址:', wallet.address);

上述代码片段展示了配置账户和 Provider 的过程。 `ethers.Wallet` 类用于管理以太坊账户的私钥和签署交易。Provider 用于连接到以太坊网络，可以是 Infura、Alchemy 等提供的远程节点，也可以是本地运行的 Ganache 节点。 `ethers.utils.parseEther` 函数用于将以太币（ETH）转换为其最小单位 Wei，因为以太坊上的所有交易都以 Wei 为单位。

// 发送交易
wallet.sendTransaction({
  to: to, // 接收者地址
  value: amount, // 发送金额 (Wei)
  gasLimit: 21000 // Gas Limit，指定交易的最大 gas 消耗量，对于简单的 ETH 转移，21000 通常足够
})
.then(transaction => {
  console.log('交易已发送!', transaction);
  console.log('交易哈希:', transaction.hash); // 输出交易哈希，用于查询交易状态
  // 可以使用 provider.getTransactionReceipt(transaction.hash) 查询交易回执
})
.catch(error => {
  console.error('交易失败:', error);
});

这段代码展示了如何使用 `wallet.sendTransaction` 方法发送交易。需要指定接收者地址、发送金额以及 Gas Limit。Gas Limit 用于限制交易执行过程中消耗的最大 Gas 数量，防止恶意智能合约消耗过多的 Gas。交易发送成功后，会返回一个 transaction 对象，其中包含交易哈希等信息，可以用于查询交易状态。可以使用 `provider.getTransactionReceipt(transaction.hash)` 查询交易回执，确认交易是否已被矿工打包到区块中。

重要提示： 请务必妥善保管你的私钥！泄露私钥会导致你的资产被盗。在生产环境中，不要直接在代码中硬编码私钥，而是使用更安全的密钥管理方案，例如硬件钱包或密钥管理服务。

注意: 将 0xYOUR_ACCOUNT_ADDRESS 替换为你的账户地址，YOUR_PRIVATE_KEY 替换为你的私钥，0xRECIPIENT_ADDRESS 替换为接收者的账户地址。绝对不要在客户端代码中硬编码私钥！这极其不安全。你应该使用更安全的方式管理私钥，例如 Metamask 或硬件钱包。

4.3 调用智能合约函数

Web3.js

Web3.js 是一个允许你与以太坊区块链交互的 JavaScript 库。它提供了一系列方法，用于连接到本地或远程的以太坊节点，读取区块链数据，以及部署和调用智能合约。使用 Web3.js 之前，需要先将其引入到你的项目中。你可以通过 npm 安装： npm install web3 ，或者直接在 HTML 文件中引入 CDN 链接。

javascript

// 替换为你的智能合约地址
const contractAddress = '0xYOUR_CONTRACT_ADDRESS';
// 替换为你的合约 ABI (Application Binary Interface)
const abi = [
  {
    "inputs": [
      {
        "internalType": "string",
        "name": "param1",
        "type": "string"
      },
      {
        "internalType": "string",
        "name": "param2",
        "type": "string"
      }
    ],
    "name": "myFunction",
    "outputs": [
      {
        "internalType": "string",
        "name": "",
        "type": "string"
      }
    ],
    "stateMutability": "view",
    "type": "function"
  }
];
  

ABI 定义了合约的接口，包含了合约中所有可调用函数的信息，例如函数名、参数类型和返回值类型。你需要从你的合约编译结果中获取 ABI。

javascript

// 创建合约实例
const contract = new web3.eth.Contract(abi, contractAddress);
  

通过 Web3 实例和合约的 ABI 及地址，可以创建一个合约对象，该对象允许你与部署在区块链上的特定合约进行交互。

javascript

// 调用合约的只读函数 (不消耗 Gas)
contract.methods.myFunction('参数1', '参数2').call()
  .then(result => {
    console.log('函数调用结果:', result);
  })
  .catch(error => {
    console.error('调用失败:', error);
  });
  

使用 `call()` 方法调用合约的只读函数（`view` 或 `pure` 函数），这些函数不会修改区块链的状态，因此不需要消耗 Gas。`call()` 方法返回一个 Promise，你可以使用 `.then()` 处理调用结果，使用 `.catch()` 处理错误。

javascript

// 发送交易调用合约函数 (需要私钥签名)
const account = '0xYOUR_ACCOUNT_ADDRESS'; // 替换为你的账户地址
const privateKey = 'YOUR_PRIVATE_KEY'; // 替换为你的私钥，请谨慎处理私钥安全！

//对交易进行签名
const tx = {
    from: account,
    to: contractAddress,
    gas: 100000, // 预估 Gas Limit，根据实际情况调整
    data: contract.methods.myFunction('参数1', '参数2').encodeABI()
};

web3.eth.accounts.signTransaction(tx, privateKey)
.then(signedTx => {
    web3.eth.sendSignedTransaction(signedTx.rawTransaction)
    .then(receipt => {
        console.log('交易成功!', receipt);
    })
    .catch(error => {
        console.error('交易失败:', error);
    });
});


//旧的发送交易调用合约函数方式，已弃用。
//contract.methods.myFunction('参数1', '参数2').send({
//  from: account,
//  gas: 100000 // 预估 Gas Limit，根据实际情况调整
//})
//  .then(receipt => {
//    console.log('交易成功!', receipt);
//  })
//  .catch(error => {
//    console.error('交易失败:', error);
//  });
  

要修改区块链状态（例如，调用 `payable` 或 `nonpayable` 函数），需要发送一个交易。发送交易需要消耗 Gas，并且需要使用你的私钥对交易进行签名。`send()` 方法也返回一个 Promise，你可以使用 `.then()` 处理交易收据，使用 `.catch()` 处理错误。 `gas` 属性指定了 Gas Limit，你需要根据合约函数的复杂度预估 Gas Limit，过低的 Gas Limit 会导致交易失败。 请务必妥善保管你的私钥，不要将其泄露给任何人。推荐使用硬件钱包或安全的密钥管理方案。 Web3.js 1.0 之后推荐使用`web3.eth.accounts.signTransaction`进行签名交易。 `encodeABI()` 用于对函数和参数进行编码，以便包含在交易数据中。

Ethers.js

Ethers.js 是一个流行的 JavaScript 库，用于与以太坊区块链及其兼容的 Layer2 网络进行交互。它简化了与智能合约的交互、交易的创建和签名，以及对链上数据的读取。以下代码片段展示了如何使用 Ethers.js 与智能合约进行交互的基本方法。

需要定义合约地址和 ABI（应用程序二进制接口）。合约地址是合约在区块链上部署的唯一标识符，而 ABI 描述了合约的函数、事件及其参数类型，Ethers.js 依赖 ABI 来了解如何与合约交互。

// 合约地址，替换为你的实际合约地址
const contractAddress = '0xYOUR_CONTRACT_ADDRESS';

// 合约 ABI，描述了合约的函数和事件
const abi = [
  // 示例 ABI 条目，根据你的合约定义进行修改
  {
    "inputs": [
      {
        "internalType": "string",
        "name": "param1",
        "type": "string"
      },
      {
        "internalType": "string",
        "name": "param2",
        "type": "string"
      }
    ],
    "name": "myFunction",
    "outputs": [],
    "stateMutability": "nonpayable",
    "type": "function"
  },
  // 更多函数和事件的 ABI 定义...
];

接下来，创建一个合约实例。你需要提供合约地址、ABI 和一个 Provider。Provider 是一个到以太坊网络的只读连接，允许你查询链上数据。Ethers.js 提供了各种 Provider，例如 JsonRpcProvider（通过 HTTP/HTTPS 连接到节点）和 WebSocketProvider（通过 WebSocket 连接到节点）。

// 连接到以太坊网络 (例如使用 Infura 或 Alchemy)
const provider = new ethers.providers.JsonRpcProvider('YOUR_INFURA_ALCHEMY_ENDPOINT');

// 创建合约实例
const contract = new ethers.Contract(contractAddress, abi, provider);

要调用合约的只读函数（不改变链上状态），你可以直接使用合约实例的方法。例如：

// 调用合约的 myFunction 函数，传递两个字符串参数
contract.myFunction('参数1', '参数2')
  .then(result => {
    console.log('函数调用结果:', result);
  })
  .catch(error => {
    console.error('函数调用失败:', error);
  });

要发送交易来调用合约的函数（改变链上状态），你需要一个 Signer。Signer 是一个拥有以太坊账户私钥的对象，用于对交易进行签名。你可以使用 Ethers.js 的 Wallet 类创建一个 Signer，并使用你的私钥初始化它。请务必安全地存储你的私钥，避免泄露。

// 你的私钥，请勿分享！
const privateKey = 'YOUR_PRIVATE_KEY';

// 使用私钥创建一个 Wallet 实例
const wallet = new ethers.Wallet(privateKey, provider);

// 将 Wallet 连接到 Provider
const signer = wallet.connect(provider);

// 使用 Signer 创建合约实例
const contractWithSigner = new ethers.Contract(contractAddress, abi, signer);

现在，你可以使用 `contractWithSigner` 对象调用合约的函数并发送交易。在发送交易时，你可以指定 `gasLimit` 选项来限制交易消耗的最大 Gas 量。Gas 用于支付执行智能合约代码所需的计算资源。指定足够的 `gasLimit` 以确保交易成功执行。

// 调用合约的 myFunction 函数并发送交易
contractWithSigner.myFunction('参数1', '参数2', { gasLimit: 100000 })
  .then(transaction => {
    console.log('交易已发送:', transaction);
    // 等待交易被确认
    return transaction.wait();
  })
  .then(receipt => {
    console.log('交易成功!', receipt);
  })
  .catch(error => {
    console.error('交易失败:', error);
  });

请注意，上述代码只是一个示例。你需要根据你的实际合约地址、ABI、私钥和网络端点进行修改。请务必了解以太坊 Gas 费的概念，并根据网络拥塞情况调整 `gasLimit` 和 `gasPrice`，以确保交易能够及时被处理。

注意: 将 0xYOUR_CONTRACT_ADDRESS 替换为你的智能合约地址，abi 替换为你的智能合约 ABI (Application Binary Interface)。ABI 描述了智能合约的函数和事件。

5. 安全注意事项

• 私钥安全: 绝对不要在客户端代码中硬编码私钥。这会将私钥暴露给潜在的攻击者，导致资产损失。使用安全的密钥管理方案，例如：
  • MetaMask: 浏览器扩展程序，允许用户安全地存储和管理其以太坊账户和私钥。MetaMask 为 dApp 提供了一个用户友好的界面来请求交易签名。
  • 硬件钱包: Ledger 或 Trezor 等硬件钱包将私钥存储在离线设备上，从而显著降低了被盗风险。它们需要物理确认才能签署交易，提供额外的安全层。
  • 密钥库文件 (KeyStore): 一种加密的私钥存储方式，需要密码才能访问。虽然比硬编码安全，但仍应谨慎处理，避免泄露。
  始终注意保护你的助记词（也称为恢复短语），这是恢复你的账户的唯一途径。
• Gas Limit: 为每笔交易设置合理的 Gas Limit 至关重要。Gas Limit 是你愿意为执行交易支付的最大 Gas 量。
  • 过低的 Gas Limit: 如果 Gas Limit 低于交易所需的 Gas 量，交易将“Out of Gas” (OOG) 而失败。尽管交易失败，你仍然需要支付已经消耗的 Gas 费用。
  • 过高的 Gas Limit: 如果 Gas Limit 远高于交易所需的 Gas 量，你将支付不必要的 Gas 费用。剩余的 Gas 将被返还，但交易费用仍然会高于预期。
  使用以太坊客户端提供的 Gas 估算功能来确定合适的 Gas Limit。 根据网络拥塞情况和交易的复杂性调整 Gas Price 和 Gas Limit。
• 合约安全: 在使用或集成任何智能合约之前，务必仔细审查合约代码。
  • 代码审计: 聘请专业的智能合约审计员来审查合约代码，查找潜在的漏洞和安全风险。
  • 已知漏洞: 了解常见的智能合约漏洞，例如重入攻击、算术溢出和下溢，以及未经授权的访问。
  • 形式化验证: 使用形式化验证工具来验证合约代码的正确性，并确保其符合预期规范。
  • Bug赏金计划: 实施 Bug 赏金计划，鼓励社区成员发现并报告合约中的漏洞。
  永远不要信任未经审计的智能合约。在将资金转移到智能合约之前，请进行彻底的调查。

掌握以太坊 API 的使用方法，意味着你拥有了与区块链世界进行互动、读取数据、发送交易和构建创新 dApp 的强大能力。 你可以自由地探索去中心化金融 (DeFi)、NFT、游戏等领域，并为 Web3 的未来做出贡献。