Skip to content

Latest commit

 

History

History
309 lines (193 loc) · 20.2 KB

README-CN.md

File metadata and controls

309 lines (193 loc) · 20.2 KB
Raw

Black IDE

Click here for English version

Black IDE 是一个帮助开发者快速开发 Ethereum 智能合约的集成化开发环境。Black IDE 现已提供运行于 macOS、Windows 和 Linux 的桌面版，以及运行于现代浏览器环境中的 Black IDE Web 版。

使用 Black IDE

Black IDE 桌面版

Black IDE 安装包可以在 Github Releases 进行下载。目前 Black IDE 桌面版支持 macOS、Linux 和 Windows 系统，请根据系统下载对应的版本 （macOS 下载 .dmg 或者 .zip，Linux 下载 .AppImage，Windows 下载 .exe）。

  • macOS: 双击打开 Black-IDE-x.x.x.dmg 并将 Black IDE 拖动到应用文件夹内；
    • 第一次运行 Black IDE 时，可能会收到系统 ”无法打开 Black IDE，因为 Apple 无法检查其是否包含恶意软件“ 的提示。此时请打开 系统偏好设置 ，前往 安全性与隐私。点按 通用 面板中 仍要打开 按钮以允许 Black IDE 运行；
  • Linux: 双击打开 Black-IDE-x.x.x.AppImage；
    • 如果双击打开无效，右键点击 Black-IDE-x.x.x.AppImage，选择 Properties => Permissions => Execute，将 Allow executing file as program 选项打勾。关闭属性设置窗口并双击打开应用（不同的 Linux 发行版可能会有不同的安装方式）；
  • Windows: 双击打开 Black-IDE-x.x.x.exe。

Black IDE Web 版

在浏览器中打开 https://eth.ide.black 以访问 Black IDE Web 版。

Black IDE Hub

在浏览器中打开 https://hub-ide-black.vercel.app/ 以访问 Black IDE Hub。

功能预览

以下示例以 Black IDE v0.18.0 macOS 桌面版为例，Black IDE 各版本操作界面和功能均保持一致，实际操作以界面显示为准。

准备工作

在正确安装 Black IDE 桌面版并初次启动时，你将看到一个欢迎页面，同时也是环境准备界面。这里列出了 Black IDE 正常运行所需要的依赖，包括了 Docker，Geth in Docker 以及 Truffle in Docker。Black IDE Web 版无需安装依赖，访问 Web 版将直接进入主界面。

  • Black IDE 使用 Docker 来启动 Ethereum 节点和进行项目编译。如果你之前没有安装过 Docker，可以点击 Install Docker 按钮访问 Docker 官方网站并进行下载安装；
  • Geth 全称 Go Ethereum，是以太坊基金会提供的基于 Go 语言编写的官方以太坊协议实现。Black IDE 使用这个工具运行以太坊节点；
  • Truffle 是一套应用广泛的 Solidity 智能合约开发框架和工具包。Black IDE 使用这个工具包进行项目的创建和编译。

当所有依赖都正确安装并运行后，灰色的 Skip 按钮将会变成蓝紫色的 Get Started 按钮。点击这个按钮进入 Black IDE 的主界面。

密钥管理器

进入主界面后，我们需要首先创建一些密钥对。在 Black IDE 的任意界面，点击应用左下⻆的钥匙图标，打开密钥管理器。

你可以在密钥管理器中创建、导入并管理密钥对。点击密钥管理器左下角的 Create 按钮，根据提示输入密钥对名称并选择网络以新建一个密钥对。密钥对名称是一个由用户自定义的名称，目的是方便在后续的使用中进行识别。Black IDE 支持以私钥或助记词的方式生成密钥。生成密钥时，默认以私钥方式生成。如需切换为助记词，请点击 Regenerate 按钮旁边的三角箭头切换。

如需导入密钥，点击密钥管理器左下角的 Import 按钮，输入密钥对名称，并在私钥/助记词输入框中输入希望导入的私钥或助记词，Black IDE 将根据输入格式自动检测。如果输入的是有效的私钥或助记词，输入框下方将显示对应的地址，确认无误后点击 Import 按钮即可完成导入。

在继续之前，请先在密钥管理器中创建一些密钥对，以便我们完成接下来的操作步骤。在本示例中，我们将使用 miner，keypair01，keypair02 三对密钥完成接下来的步骤。

注意：私钥和助记词是证明密钥所有权的关键凭证，请妥善保管，不要与他人分享。泄漏私钥或助记词，可能导致数字资产永久丢失。

网络管理

本地开发节点

点击顶部的 Network 标签，主页面将切换为网络管理器。在网络管理器中，我们可以进行 Geth 版本和节点实例的管理，包括下载、删除 Geth 节点版本，根据不同版本创建、删除和运行节点实例。

点击主页面中右上角的 New Instance 按钮打开创建新实例的弹窗，填写实例名称和选择合适的版本，点击 Create 按钮完成节点实例的创建。

创建新的 Ethereum 节点实例时，你需要在密钥管理器已保存的密钥地址中指定一个矿工（Miner）。Miner 将作为本地网络的矿工进行出块。此处我们选择 miner 密钥作为我们本地 Ethereum 节点的矿工。当本地节点启动时，会将矿工地址作为创世地址，并赋予创世地址一定数量的代币。

节点实例创建完成后，点击实例的绿色 Start 按钮启动 Ethereum 节点。启动完成后，你可以在下方的日志查看器中检查节点运行日志。

网络节点

Black IDE 现已支持多个区块链的主网以及测试网，包含： ETHEREUM， BNB CHAIN， AVALANCHE C-CHAIN， POLYGON， FANTOM， HARMONY， CONFLUX ESPACE， GNOSIS(XDAI)， AURORA(NEAR)， 和 EVMOS。下面以 EVM 为例。

EVM 测试网/主网

Black IDE 中已经内置了 Ethereum 四个测试网 Ropsten，Rinkeby, Kovan 和 Gorli以及 Ethereum 主网的连接信息。点击 Network 标签旁的三角箭头，可以直接一键切换希望使用的 Ethereum 网络。

同时还为内置的区块链分别设置了带有此区块链专属标志的主网与测试网，主网图标为彩色，测试网图标为灰色。

自定义网络

Black IDE 支持连接自定义远程网络节点。点击 Network 标签旁的三角箭头，选择 Custom Network。根据提示输入希望连接的 Node URL 信息即可连接。

区块浏览器

节点启动后，点击顶部的 Explorer 标签，主页面将切换为区块浏览器。在区块浏览器中，我们可以查询对应地址的信息。这些信息包括代币信息以及交易记录。

点击 Explorer 标签右侧的三角箭头，在下拉菜单中选择希望访问的密钥地址，即可查看对应地址的账户信息了。另外，也可以在区块浏览器的地址栏中输入待查看的密钥地址来查看信息。目前 Black IDE 暂不支持查看本地开发节点的历史交易记录。将网络切换到测试网或主网，区块浏览器中便可以查看历史交易记录了。

当连接主网查询信息时，区块浏览器可以显示地址下已被 Trust Wallet 收录的的 ERC-20 代币信息。

Black IDE 区块浏览器在地址栏右侧集成了常用工具以方便用户使用，可以单击按钮调用相应工具：

  • 点击 Transfer 按钮以进行快速转账，该转账功能支持使用 ETH 或当前地址拥有的 ERC-20 代币进行交易。在转账弹窗中选择需要转账代币，填写参数后点击 Sign and Push 以执行交易。每笔转账交易都会被存储在历史交易记录中，以便之后再次查看。这里，我们使用转账功能向 keypair01 转账 10,000 ETH 代币。

  • 当连接测试网时，点击 Faucet 按钮，Black IDE 会打开申请测试代币的网站，以供开发测试使用。测试网上所申请的代币均为测试代币，是没有实际价值的。

智能合约项目

创建新项目

点击顶部的 Project 标签，主页面将切换至项目管理器。点击页面右上角的 New 按钮打开创建项目弹窗，首先选择新建项目的储存位置，本地或者云端。然后输入项目名称，并选择合适的模版。Black IDE 目前提供了多种模版：

  • Coin：一个简单的 Coin 智能合约；
  • ERC20 Token：ERC-20 代币合约；
  • [Open Zeppelin] Basics：基于 Open Zeppelin 智能合约库的模板，提供了 ERC-20、ERC-721（NFT）、ERC-777 和 ERC-1155 等合约；
  • [Truffle] Metacoin：使用 Ethereum Truffle 创建的合约。目前 Black IDE 暂不支持部署 Metacoin 合约。

Black IDE 支持使用 Truffle, Hardhat 和 Waffle 三个框架来创建并管理一个合约项目。

这里我们使用 Open Zeppelin 的 Basics 模版，并选择 Truffle 框架，在本地创建一个名为 my-project 的项目，并使用这个项目完成后续操作。

项目编辑器

项目创建完成后，主页面将切换至项目编辑器。项目编辑器由几个部分组成，包括了左侧的文件浏览器，文件浏览器上方的工具栏，右侧上半部分的代码编辑器以及右侧下半部分的日志查看器等多个开发常用模块。

点击工具栏中右侧的 Project Settings（齿轮形状）图标，打开项目设置页。在这里可以查看和修改项目的基本配置，编译器配置以及 Linter 配置等信息。

Black IDE 的项目编辑器内置了 Linter，可以在代码编辑过程中自动检查代码并提示项目代码中的警告和错误。项目编辑器会在有警告的代码行前标注黄色的惊叹号，在错误的代码行前标注红色的叉作为提示。

编译智能合约

点击工具栏的 Build 按钮（锤子形状），Black IDE 将进行项目的编译，你可以通过下方的日志查看器来查看编译结果。编译后将在项目目录下的 build/contracts 文件夹中查看到编译完成的 *.json 文件，这些编译输出文件的数据格式可参阅 Solc 文档。

另外也可以通过右键点击一个 *.sol 文件，在菜单中选择 Compile，单独编译选中的合约文件。

部署智能合约

点击工具栏的 Deploy 按钮（船形状），合约部署弹窗将被打开，在这里可以输入部署合约所需要的各项参数：

  • Compiled Contract：等待部署的合约编译输出文件，为 JSON 格式。一个项目内可能存在多个合约，可以通过下拉菜单中选择需要部署合约的编译输出文件；
  • Constructor Parameters：合约构造函数需要的参数，Black IDE 将自动根据数据格式生成参数表单，在此填入创建合约所需要的各项参数，我们在这里点击 initialSupply 参数栏，输入 1000 ；
  • Signer：为合约部署交易进行签名的密钥地址，需要为密钥管理器中已有的密钥，通过下拉菜单选择 my-keypair-1 密钥对；
  • Gas Limit、Gas Price：合约部署的交易费用信息，部署前 Black IDE 会进行估算，也可使用自行填写的值进行覆盖。

另外，也可以在文件浏览器中，右键点击一个 JSON 格式的编译输出文件，在菜单中选择 Deploy，对该合约进行部署。

在合约部署弹窗中选择 GLDToken.json，填写构造函数参数，并选择 my-keypair-1 为签名密钥地址。在这个例子中，合约部署时，将会把初始的 1000 token 全部分配给为部署交易签名的地址 my-keypair-1。将点击 Estimate & Deploy 按钮，Black IDE 会自动估算所需的交易费用并填入对应栏目中。如需重新估算，请点击左侧绿色 Re-estimate 按钮。有时候预估的交易费用可能是不够的，如果部署的时候出现交易费用不足的错误，可以手动提高 Gas Limit 或 Gas Price 后重试。点击蓝紫色 Deploy 按钮，Black IDE 将发送合约部署交易。

部署交易需要一些时间被区块链网络处理。大约十几秒后，Black IDE 会弹出交易详情弹窗显示部署结果，包括部署参数（Parameters）、交易数据（Tx）、交易收据（Receipt）、ABI 等详细信息，可点击弹窗中的标签进行切换。若在本弹窗关闭之后仍想查看本次部署结果和交易详情信息，请参考历史交易记录。

调用合约

成功部署智能合约后，点击弹窗中 Contract Created 栏的合约地址，页面将自动切换至合约浏览器。你也可以点击顶部的 Contract 标签切换至合约浏览器，在地址栏中输入希望打开的合约地址。Black IDE 支持同时打开多个合约，方便进行多合约的调试工作。

合约浏览器页面主要分为三个部分：

  • 左边栏用于调用合约的写入方法：点击蓝紫色下拉框，选择希望调用该合约的写入方法；
  • 中间栏用于进行合约的数据读取：点击蓝紫色下拉框，选择希望查询该合约的读取方法；
  • 右边栏用于进行合约的事件查询，点击蓝紫色下拉框，选择希望查询该合约的事件。

Black IDE 在部署合约后将自动保存合约 ABI，并在读取合约时候通过 ABI 中的数据，生成上面的写入方法、数据读取、事件查询，和它们各自的参数表单。更多 ABI 的使用方法可以参考 ABI Storage。

接下来我们在合约浏览器中打开刚刚部署的 GLDToken 合约，演示如何使用写入方法、读取数据和查询事件。

首先在写入方法调用窗口中选择 transfer 方法，这个方法将指定数量的代币从一个地址转账到另外一个地址。接下来填入完成交易必须的各项参数：

  • 在 Parameters 下从 recipient 下拉菜单中选择 keypair02 作为收款人地址（也可以输入其它密钥管理器中未保存的地址），并在 amount 中填入合适的数量，例子中我们本次转账 100 token ；
  • 无需填写 Gas & Storage 栏目中的交易费用（由 Black IDE 自动估算）；
  • 在 Authorization 的 Signer 下拉菜单中选择 keypair01 作为汇款人地址。

完成后，点击上方的方法名称旁的 Execute 按钮（三角形状）执行交易。稍后弹窗会提示交易成功及交易费用信息。

接下来，我们来验证一下上笔交易的结果。在合约读取窗口中选择 balanceOf 数据栏，在 Parameters 下 account 下拉菜单中选择 keypair02 地址，最后点击上方的数据名称旁的 Execute 按钮（三角形状）。结果会显示在下方 Result 栏目中，可以看到查询到的值为 100。这个结果与我们上笔交易中向 keypair02 转账的 amount 数量一致，这验证了我们之前交易的结果。

最后我们在事件查询窗口中选择 Transfer 事件，并点击 Get event logs 按钮（三角形状）以查询合约中所有 Transfer 相关事件，结果会显示在下方 Event Logs 表格中。在进行事件查询时，Black IDE 允许自定义查询范围。但当连接本地开发节点或者测试网时，事件查询最多只能返回 10,000 条记录，请保持自定义范围小于等于该数字。默认情况下事件查询窗口将返回最新 10,000 条记录。当连接 Ethereum 主网时，事件查询最多只能返回 1,000 条记录。

ABI Storage

在使用合约浏览器时，Black IDE 需要基于合约 ABI 生成各读写方法和查询事件的界面，底部栏中的 ABI Storage 就是保存这些合约 ABI 的地方。在合约部署成功后，Black IDE 将自动保存合约的 ABI。当鼠标移动到 ABI 条目上时，可以点击 Edit 按钮（铅笔形状）查看 ABI 原始数据，也可以点击 Delete 按钮删除 ABI 条目。

如果需要调用其它合约（例如线上合约），就需要将合约的 ABI 添加到 ABI Storage 中。使用 ABI Storage 中的 New 按钮即可完成该操作。为方便使用，Black IDE 也会自动读取当前项目中已编译过合约的 ABI，单击弹窗左下角 Select from the current project 按钮，从列表中选择即可。

历史交易记录

Black IDE 会记录每笔发布到链上的交易。如需查看最近的交易记录，点击底部栏的 Transactions 按钮即可唤出最近交易记录的列表。可以点击单笔交易以打开交易确认弹窗，并查看交易详情、参数 （Parameters） 、交易数据 （Tx）、交易收据 （Receipt）等详细信息。

网络按钮

Black IDE 的底部栏有网络图标，可以直观的看到网络连接状态。网络未连接时，图标置灰。网络连接时，图标亮起。点击网络按钮可选择断开或者重练网络连接。

RPC Client

Black IDE 还提供了直接从底层调用 Ethereum 节点 RPC 接口的功能。点击底部栏的网络按钮，在弹出菜单中选择并打开 RPC Client 后，可以看到 Ethereum 节点的全部 RPC 接口。对每个 RPC 接口，Black IDE 也将生成对应的参数表格，填写数据后点击 Execute 按钮运行，即可完成调用并查看返回数据。

分享功能

Black IDE 还提供了项目分享功能，点击桌面版 Cloud 按钮，在 Cloud 中创建的项目，可以被公开分享。点击项目中的 README.md 页面，能看见 Private 按钮，表示此项目现状为私密。

点击 Private 按钮切换成 Public 状态后，此项目将会显示在 Black IDE Hub 的同时出现 Share 按钮。

点击 Share 按钮，出现弹窗，复制弹窗中的链接后即可将此项目的链接分享给任何人。

分享功能在桌面中的 Cloud 项目和 web 版均可使用。