npx hardhat
Chose: Create a basic sample project
基础项目依赖如下：
# package.json
{
"name": "hardhat-project",
"devDependencies": {
"@nomiclabs/hardhat-ethers": "^2.0.6",
"@nomiclabs/hardhat-waffle": "^2.0.3",
"chai": "^4.3.6",
"ethereum-waffle": "^3.4.4",
"ethers": "^5.6.9",
"hardhat": "^2.9.9"
}
}
基础项目配置如下
require("@nomiclabs/hardhat-waffle");
module.exports = {
solidity: "0.8.4",
};
安装subgraph依赖
# subgraph 命令行工具以及对应的ts库
npm install --save-dev @graphprotocol/graph-cli @graphprotocol/graph-ts
# 生成 subgraph scaffold
npm install --save-dev git+https://github.com/graphprotocol/hardhat-graph/\#main
# subgraph unit test
npm install --save-dev matchstick-as
安装完成后修改hardhat.config.js文件，开始配置subgraph项目
require("@nomiclabs/hardhat-waffle");
// 这里一定要引入，是为了引入 hardhat-graph 定义的 hardhat 一些 task ，就是来创建和初始化subgraph项目的
require('hardhat-graph')
const {task} = require('hardhat/config')
module.exports = {
defaultNetwork:"localhost",
networks:{
localhost:{
url:"http://127.0.0.1:8545"
}
},
//subgraph初始化相关配置，'hhq/MySubgraph' 表示 前缀/项目名称
subgraph: {
name: 'hhq/MySubgraph', // Defaults to the name of the root folder of the hardhat project
product: 'subgraph-studio', // Defaults to 'subgraph-studio'
indexEvents: true|false, // Defaults to false
allowSimpleName: true|false // Defaults to `false` if product is `hosted-service` and `true` if product is `subgraph-studio`
},
//subgraph 项目目录
paths: {
subgraph: './subgraph' // Defaults to './subgraph'
},
solidity: "0.8.4",
};
// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.7.0 <0.9.0;
contract HqToken {
string public name;
string public symbol;
uint256 public decimals;
uint256 private _totalSupply;
address public owner;
mapping(address=>uint256) private _balances;
mapping(address=>mapping(address=>uint256)) _allowances;
event Transfer(address indexed from, address indexed to, uint256 value);
event Approval(address indexed owner, address indexed spender, uint256 value);
constructor(string memory _name, string memory _symbol, uint256 _decimals) {
name = _name;
symbol = _symbol;
decimals = _decimals;
owner = msg.sender;
}
function totalSupply() public view returns(uint256){
return _totalSupply;
}
function mint(address to, uint256 amount) public {
require(to != address(0), "mint: mint to the zero address");
_balances[to] += amount;
_totalSupply += amount;
emit Transfer(address(0),to,amount);
}
function balanceOf(address account) public view returns(uint256){
return _balances[account];
}
function allowance(address account, address sender) public view returns(uint256){
return _allowances[account][sender];
}
function approve(address spender, uint256 amount) public {
require(spender != address(0), "approve: approve to the zero address");
_allowances[msg.sender][spender] = amount;
emit Approval(msg.sender,spender,amount);
}
function transfer(address to, uint256 amount) public returns(bool) {
require(to != address(0), "transfer: transfer to the zero address");
require(to != msg.sender, "transfer: can't transfer to yourself");
_balances[msg.sender] -= amount;
_balances[to] += amount;
emit Transfer(msg.sender,to,amount);
return true;
}
function transferFrom(address from,address to, uint256 amount) public returns(bool) {
require(to != address(0), "transferFrom: from can't zero address");
require(to != address(0), "transferFrom: transfer to the zero address");
require(to != from, "transferFrom:can't transfer to yourself");
uint256 allowAmount = allowance(from,msg.sender);
require(allowAmount >= amount, "from allow tranfer amount not enough");
_balances[from] -= amount;
_balances[to] += amount;
_allowances[from][msg.sender] -= amount;
emit Transfer(from,to,amount);
return true;
}
}
修改部署项目 scripts/sample-script.js 如下
async function main() {
const HqToken = await hre.ethers.getContractFactory("HqToken");
const contract = await HqToken.deploy("HqToken", "HQT", 18);
await contract.deployed();
console.log("HqToken deployed to:", contract.address);
//这里返回合约的名称和地址作为subgraph项目的初始化参数
return { contractName: "HqToken", address: contract.address }
}
// 部署完合约后初始化subgraph项目
main()
.then((result) => hre.run('graph', result))
.then(() => process.exit(0))
.catch((error) => {
console.error(error);
process.exit(1);
});
package.json
{
"name": "hardhat-project",
"license": "GPL",
"scripts": {
"start": "npx hardhat node",
"deploy": "npx hardhat run scripts/sample-script.js",
"test": "npx hardhat test",
"graph-local-node-start": "cd ./docker && docker-compose up",
"graph-local-node-stop": "cd ./docker && docker-compose down -v && docker-compose rm -v && rm -rf data/ipfs data/postgres",
"graph-local-codegen": "cd ./subgraph && npm run codegen",
"graph-local-build": "cd ./subgraph && npm run build",
"create-local-subgraph-node": "cd ./subgraph && npm run create-local",
"deploy-local-subgraph-node": "cd ./subgraph && npm run deploy-local",
"remove-local-subgraph-node": "cd ./subgraph && npm run remove-local",
},
"devDependencies": {
"@graphprotocol/graph-cli": "^0.31.0",
"@graphprotocol/graph-ts": "^0.27.0",
"@nomiclabs/hardhat-ethers": "^2.0.6",
"@nomiclabs/hardhat-waffle": "^2.0.3",
"chai": "^4.3.6",
"ethereum-waffle": "^3.4.4",
"ethers": "^5.6.9",
"hardhat": "^2.9.9",
"hardhat-graph": "git+https://github.com/graphprotocol/hardhat-graph.git#main"
"matchstick-as": "^0.5.0"
}
}
克隆graph-node到本地并进入docker目录
# 这里可省略，直接将graph-node项目的docker文目录复制到本地项目即可
git clone https://github.com/graphprotocol/graph-node
cd docker
修改graph-node节点类型
编辑docker目录下的 docker-compose.yml 文件，找到如下配置
services->graph-node->environment->ethereum: 'mainnet:http://host.docker.internal:8545'
修改如下，
services->graph-node->environment->ethereum: 'localhost:http://host.docker.internal:8545'
mainnet、localhost 代表着是哪个eth节点，还有rinkeby、Ropsten等，或者自定义节点
这个节点名称也是你要测试子图 subgraph.yaml 清单文件 dataSources->network 的节点名称，需要保持一致
npm run start
npm run graph-local-node-start
npm run deploy
npm run graph-local-codegen && npm run graph-local-build
npm run create-local-subgraph-node && npm run deploy-local-subgraph-node
npm run remove-local-subgraph-node
npm run graph-local-node-stop
http://127.0.0.1:8000/subgraphs/name/hhq/MySubgraph
subgraph项目的单元测试的准备与测试首先注意安装 npm install -D matchstick-as 单元测试框架依赖
在 subgraph项目下创建tests文件夹,并在其中创建 hq-token.test.ts 测试文件内容如下
import { describe, test, newMockEvent, assert, clearStore } from "matchstick-as/assembly/index";
import { Bytes, ethereum, BigInt, Address,log } from "@graphprotocol/graph-ts";
import { Transfer as TransferEvent } from "../generated/HqToken/HqToken";
import { handleTransfer } from "../src/hq-token";
import { Transfer } from "../generated/schema"
function newParamms():ethereum.EventParam[]{
const fadr = '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266';
const tadr = '0x9a705eEda44f392691eBAE3EF1801c754dEf260d';
const from = Address.fromString(fadr);
const to = Address.fromString(tadr);
const value = BigInt.fromString('2000000000000000000000');
let params:ethereum.EventParam[] = [];
let fromP = new ethereum.EventParam("from", ethereum.Value.fromAddress(from));
let toP = new ethereum.EventParam("to", ethereum.Value.fromAddress(to));
let valueP = new ethereum.EventParam("value", ethereum.Value.fromUnsignedBigInt(value));
params.push(fromP);
params.push(toP);
params.push(valueP);
return params;
}
describe("handleTransfer()", () => {
test("Tranfser use newMockEvent() ",()=>{
const fadr = '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266';
const tadr = '0x9a705eEda44f392691eBAE3EF1801c754dEf260d';
const value = '2000000000000000000000';
// 使用mockEvent快速创建对象
// changetype<>() AssemblyScript 默认类型转换函数
let tEvent = changetype<TransferEvent>(newMockEvent())
tEvent.parameters = newParamms();
handleTransfer(tEvent);
const transferId = tEvent.transaction.hash.toHexString() + '-' + tEvent.logIndex.toString();
// log.info(transferId,[])
assert.fieldEquals('Transfer', transferId.toLowerCase() , 'id', transferId.toLowerCase())
assert.fieldEquals('Transfer',transferId,'from',fadr.toLowerCase());
assert.fieldEquals('Transfer',transferId,'to',tadr.toLowerCase());
assert.fieldEquals('Transfer',transferId,'value',value);
clearStore();
});
})
matchstick 框架 准备运行单元测试, 已经编译好只有MacOS和Linux平台
https://github.com/LimeChain/matchstick/releases
MacOS 平台
brew install postgresql
#下载到项目根目录
curl https://github.com/LimeChain/matchstick/releases/download/0.5.1/binary-macos-11 > binary-macos-11
sudo chmod u+x binary-macos-11
# 运行单元测试 binary-macos-11
Linux平台
sudo apt install postgresql
curl https://github.com/LimeChain/matchstick/releases/download/0.5.1/binary-linux-18 > binary-linux-18
sudo chmod u+x binary-linux-18
# 运行单元测试
./binary-linux-18
npm run graph-test
执行上面的命令 graph-cli 会自动下载对应平台的命令行测试工具，具体会下载到目录
node_modules/binary-install-raw/bin/0.5.1
根据平台的不同对应的下载名称也不同，等待下载完成自动执行单元测试，经测试发现不如下载完后放在项目根目自动执行效果更好，
如果自动下载失败，也可手动下载后放入对应目录，再执行测试即可。
一行命令构建整个项目
# 代理替换为自己的或者去掉，此脚本适用于MacOS和Linux
sh -c "$(curl --proxy http://127.0.0.1:4780 https://raw.githubusercontent.com/HeHuiqi/project_scaffold_shell/main/subgraph_scaffold.sh)" -p hello --proxy http://127.0.0.1:4780
https://github.com/HeHuiqi/hello_subgraph
欢迎分享，转载请注明来源：内存溢出
微信扫一扫
支付宝扫一扫
评论列表（0条）