如何在Conflux网络中使用js-conflux-sdk来构建一个简单的DApp

在这篇文章/教程中,我将展示如何使用js-conflux-sdk来构建一个简单的DApp。

通过使用js-conflux-sdk这一基于JavaScript语言的集成开发库配合npm包管理,能够开发基于Conflux网络的DApp,开发编译部署感兴趣的智能合约到Conflux网络中。希望通过本文的记录与整理,为更多对Conflux这一高性能公链感兴趣的同学们尝试使用js-conflux-sdk更加方便的开发自己所感兴趣的项目提供可能。

相较于web3,js-conflux-sdk对其逻辑进行了一系列改进与优化,本文将重点介绍使用该SDK开发调用相关智能合约的方法。如果您熟悉编写智能合约的方法,能够利用智能合约做更多有意思的事情。

环境配置

首先您需要安装nodejs作为运行环境,参考文档完成对nodejs环境的部署操作。

  1. 选择您希望存放DAPP的文件夹作为您的工作目录

  2. 在工作目录下运行npm的init命令以创建 package.json 文件,该文件能够帮助您存储项目名称、项目版本、项目描述、入口点文件、项目依赖信息等关键信息:

npm init -y
  1. package.json 文件内容需要满足您的项目配置,此处为我创建的DAPP所对应的内容:

{
  "name": "contract-project",
  "version": "1.0.0",
  "description": "smart Contract",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Yumingyuan",
  "license": "ISC"
}

此外需要通过npm包管理工具在项目路径下安装一些必要的依赖包,其命令如下:

通过@操作符控制安装的版本,以确保编译器与我们的代码兼容。

  1. 此外还需要通过npm命令在同一工作目录下安装JavaScript Conflux Software Development Kit

安装完后,您会发现在相应的目录下出现了一个文件夹 node_modules,他是在安装sdk时自动生成的。

尝试开发

  1. 如果需要编写智能合约,我们还需要尝试使用Solidity这门面向智能合约且为了实现智能合约而创建的高级编程语言开发智能合约。Solidity文件的对应后缀为sol,为了方便进行开发,我们在项目文件夹下创建了一个contracts文件夹。并将我们编写的智能合约代码存入 ./contracts/test.sol 内,其内容如下:

  1. 尝试Solidity编程的方式可以是使用Remix,可以通过将自己编写的test.sol文件上传至Remix进行编译,但我们看到了另外一个有意思的方法(后续步骤有说明),固此处截图仅为样例:

test.sol at Remix
  1. 有位外国大佬,他编写了一份专门可以用于编译 sol 的JS脚本,其内容如下,我们将它保存为 compile.js 并将我们编写的 test.sol 文件放入 ./contracts/test.sol 下,同时将 compile.js 放在 ./ 下,这段代码的逻辑是读取 contracts 文件夹内合约并保存其abi和bytecode为json文件,存储到项目 ./build 文件夹下:

  1. 通过在命令行运行 compile.js 编译 ./Contracts/test.sol

编译成功情况下的运行结果如下:

  1. 可以看一下 ./build 文件夹内的数据,发现该编译工具生成了一个文件 ERC20.jsonSafeMath.json ,其中 ERC20.json 的内容如下:

这还没完,您需要在其中找到 bytecode 并将这一键对应的值前增加 0x ,增加后的效果如下:

为了方便大家比较差异,只能把内容全部贴到这里,还请大家包容理解,请您一定要找到这个差异并在编译后添加 0x 否则,在后续部署合约时,会出现错误。abi和bytecode都写在同一个json文件内的好处是,我们只需要读取 ERC20.json 文件就可以使用它们调用Conflux创建智能合约

  1. 智能合约编译完了,我们需要把它部署到Conflux网络中,还需要您花一些时间做如下的准备工作:

  • 参考如何创建Conflux网页钱包创建属于您自己的Conflux钱包;

  • 登录钱包后,点击页面中 申领测试币 按钮,申请100CFX测试币,后续部署合约需要进行消费;

  • 点击左侧栏目中的 钱包私钥 获取您的私钥,这个私钥仅仅用于部署合约,不要告诉别人,因为可以直接通过私钥进入到您的钱包,不能进行公开。

  1. 编写 deploy.js ,其目的是将所写合约部署到Conflux网络,且部署的位置就是您填写私钥对应的合约地址(后续会有讲解哦,不要着急!)

需要说明的是:nonce是账户的交易序号每次一发起交易(包括部署合约)会使用一个nonce成功后nonce自增1,而如果交易执行不成功时nonce不会自增1(在这里指定了nonce,您也可以把它删除以使用Conflux的默认值),再次部署的时候,因为系统中已存在一个错误而不能执行的nonce,会报nonce已存在错误运行效果如下图所示:

const config = require('./config.json'); 语句所读取的 config.json 文件内容如下所示,其中private_key使用与 deploy.js 相同的私钥:

部署与调用

  1. 运行 deploy.js 的方法如下:

以我们撰写的合约为例,方法如下:

需要说明的是 ERC20 是命令行参数,通过 deploy.js 内的代码 process.argv[2] 获得,帮助我们程序去 ./contracts/ 文件夹内寻找名为 test.json 并进行部署,其输出结果如下图所示:

  1. 通过程序回显 recv:0x846ba74923c670a5aec4e58b7551396b9bed5658 获取到了我们部署合约的地址为 0x846ba74923c670a5aec4e58b7551396b9bed5658 ,使用该地址继续编写 call.js 代码,访问并调用合约:

  1. 调用结果如下 :

后记

  1. 经过上述环境配置这一波操作后,我们的 package.json 文件内容也有所改变:

  1. 项目的路径文件树如下所示:


感谢社区小伙伴:余銘缘的辛苦整理~ 鸣谢:刺客panpan 两位大佬的指导与帮助。

Last updated