Conflux 测试网水龙头

开发者或用户可以使用 Conflux 测试网水龙头获取 Conflux 测试网 CFX 或 CRC20 代币。

Conflux 测试网水龙头

项目主体结构

项目大体分为 solidity 合约与 vue 前端两部分。

/contracts 与 /build/contracts 为合约部分。其中 /contracts 中为 solidity 合约源码，/build/contracts 为编译后得到的 JSON 文件。
/frontend 中为 vue 前端的源码。

环境配置

安装依赖

npm install

cd ./frontend

npm install

本项目中合约已经编译完毕(于/build/contracts)，未修改合约前不必再次编译。
如果需要编译合约，需要安装 truffle 或 cfxtruffle。

其余 solidity 编译工具理论上也可以使用，但是没有进行过测试

npm install -g conflux-truffle

此外，本项目前端依赖于浏览器扩展 Conflux Portal

前端命令说明

前端基于 vue-cli 搭建，下面进行简单说明

启动前端开发环境

开发环境下允许热重载

cd ./frontend
npm run serve

生成前端静态文件

npm run build

部署静态文件

npm run deploy

该命令会执行 /frontend/deploy.sh 脚本，将 /frontend/dist 文件中内容推送至远程对应的仓库与分支。如果提前部署了 github pages 类似的服务（或提前设置了远端仓库的钩子函数）可以实现部署的效果。

前端配置说明

水龙头合约地址与水龙头支持的代币种类通过读取前端的合约配置文件 /frontend/src/contracts-config/faucetContractConfig.js 与 /frontend/src/contracts-config/tokenConfig.js 获取。下面简单介绍如何修改

// faucetContractConfig.js

// 水龙头合约地址
// 要求为 CIP-37 格式的测试网地址
const faucetAddress = "cfxtest:.........";

// tokenConfig.js

/*
 options 数组中为支持的代币
 需要新增代币时只需要向 options 数组中增加新的对象即可
*/
const options = [
  // ...
  {
    symbol: "GLD", // 唯一标识符，数组内元素该字段不可重复
    label: "GLD - testnet token", // 前端页面会显示此名称
    address: "cfxtest:ace0ea1x6st1spm1jwfces43tder2yewz2vtx8hxrt", // 要求为 CIP-37 格式的测试网地址
  },
  // ....
];

此外，如果部署了新的合约或在配置列表中增加了新 Token，请向合约中转入足量的 Token，否则水龙头功能会因 CFX 余额不足或代币不足而无法完成相应的功能。

如果需要设置代付，每次领取cfx的gas消耗约为36000，每次领取token的gas消耗约为59000，可以参考这两个数据进行代付的设置

编译合约（可选）

使用 cfxtruffle 编译

cfxtruffle compile

修改水龙头合约配置

水龙头可以对领取的每种 Token（包括 CFX）的领取额度与最小领取间隔时间进行配置。对于没有进行手动配置的代币，将会使用合约中的默认值。

设置默认领取额度与最小领取间隔时间

水龙头合约有两个初始配置参数分别为 defaultAmount 与 defaultInterval，分别代表用户每次领取的代币数量与用户两次领取之间的最小时间间隔(秒)。合约的管理者可以通过调用合约的下面两个接口进行修改。

function setDefaultIntervalSeconds(uint256 intervalSeconds) public onlyManager {
    defaultInterval = intervalSeconds;
}

// 设置默认领取 Token 的数量 注意该数是未考虑 decimals 的数，因此一般需要设置为一个大数
function setDefaultAmount(uint256 amount) public onlyManager {
    defaultAmount = amount;
}

对某种 Token 的领取额度与最小领取间隔时间进行配置

调用下面的接口对某种 Token 的领取额度与最小领取间隔时间进行配置。

/**
@param tokenContractAddress 代币地址。如果传入0地址代表设置的是CFX
@param interval 领取的间隔 单位为秒
@param amount 设置每次领取 Token 的数量 注意该数是未考虑 decimals 的数，因此一般需要设置为一个大数
  */
function setClaimSetting(address tokenContractAddress, uint256 interval, uint256 amount) public onlyManager {
    tokenClaimSettings[tokenContractAddress].interval = interval;
    tokenClaimSettings[tokenContractAddress].amount = amount;
}

更新日志

2021/06/07 1.0.1 修复生产模式下claim按钮处无提示的bug 2021/06/07 正式版1.0.0

TODOS

用户自行添加合约
ui 优化
github flow for deployment

Pana/conflux-faucet