![見出し画像](https://assets.st-note.com/production/uploads/images/68728879/rectangle_large_type_2_065c26db1716bfb184982c853f1bc9ac.jpeg?width=1200)
【保存版】そのトークン、誰がいくつ持っているの?リストの作り方(The Graph入門)
こんにちは、CryptoGamesの高橋です。
クリスペ・TCG Verseの会社です。
本日、TCGVerse構想を発表いたしました!https://t.co/1zeMA2VbH4 pic.twitter.com/FIOXwADoEc
— 小澤孝太@CryptoSpells / CryptoGames CEO (@kotaozawa) December 28, 2021
本日は特定のトークンの所有者リストを作成する方法の一つである、The Graphの使い方を説明していきます。
これを使うことで、非常に簡単にブロックチェーンの情報を取ってくることができます。
また、この記事はこちらの素晴らしい記事をもとに作っています。
ぜひこちらもご参照ください。
では、始めていきましょう。
1 コントラクトを用意する
まずはトークン情報をとってくるためのコントラクトを作りました。
もし、みなさんがこのコントラクトを元にテストを行いたい場合は、第9章にコントラクトアドレス、ABIを置きましたので、使ってください。
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
contract TheGraphTestToken is ERC20 {
string private _name = "TheGraphTestToken";
string private _symbol = " TGTT";
uint8 private _decimals = 18;
address account = msg.sender;
uint value = 10000000000000000000000;
constructor() ERC20( _name, _symbol) public {
_mint(account, value);
}
}
2 @graphprotocol/graph-cliのインストール
次のようにインストールしましょう。
yarn global add @graphprotocol/graph-cli
下のようになれば成功です。
3 abi.jsonを格納する(verifyしていない時)
こちらの処理は「etherscan」でverifyを行わない場合の処理になります。
verifyを行うと「etherscan」からABIの取得が可能になるためです。
私は今回、「Hardhat」を使ってコントラクトを作りましたが、コンパイルを行うと、下のような「ABI」が作られます。
これによって、機械がコントラクトの内容を理解できるようになります。
このABIを下のように格納します。(この後、subgraphの直下に場所を変えました。)
4 graph initを行う
次のように、「subgraph」ディレクトリを作成・移動の後、graph initを実施します。
graph init
色々聞かれるので、次のように回答していきました。
おそらく、一番引っかかるのが「ABI file (path)」だと思います。
第3章で格納した場所を指定しましょう。
成功しましたら、このように「the-graph-test-token」ディレクトリができました。
5 Subgraphの実装
5ー1 スタートブロックの設定
まずは、「subgraph.yml」でスタートブロックの設定を行います。
今回使うコントラクトがブロック番号「9895970」 番にできたとすると、それ以前のブロックはこのコントラクトには関係ありませんね。
これを設定することで処理(同期)の時間が大幅に削減されます。
コントラクトが作られた時のブロックは、下のように「Etherscan」で確認ができます。
5ー2 取得データの設定(schema.graphql)
では、次にブロックチェーンからどんな情報を持ってきたいでしょうか。
それを決めるのが「shcema.ts」です。
反映させるために、まずは「schema.graphql」に次のように書いていきましょう。
type AccountTokenBalance @entity {
id: ID! #wallet address
token: String! #token address
balance: BigInt! #現在のトークン残高
}
これにより、どんなデータに格納したいかを決定できます。
そして、これを具体的に実現してくれるのが、次の「shcema.ts」です。
5ー3 shcema.tsの関数を見てみよう
次のようにして、「shcema.ts」を作ってみましょう。
graph codegen
「generated」ディレクトリに「schema.ts」ができたようですね。
では、見てみると、次のように先ほど設定した項目のget関数とset関数ができていますね。
そして、その他にも次のように必要なコンストラクタ(最初に行う処理)や関数が作られています。
① constructor(最初に行う処理)
② save
③ load
5ー4 イベントが取得する値を見てみよう。
The graphはイベントをもとにして値を取得します。
今回のERC20には次の2つのイベントがあります。
① Transfer
② Approval
今回はトークンがAさんからBさんに移った時に発火される「Transfer」イベントを使います。
Transferは上の画像のように、次の3つを発火します。
① address from
② address to
③ uint256 value
では、第4章で作られたファイルを見てみましょう。
これはコントラクトから自動的に作られました。
Transferの部分を見てみると、上の3つが取得できることがわかりますね。
5ー5 イベント取得時の処理を作ろう
実際の処理は「mapping.ts」に書いていきます。
ざっくりと、AさんからBさんに50移動したら
① Aさん :50減る
② Bさん :50増える
と書いてあります。
import { BigInt } from "@graphprotocol/graph-ts";
import { Transfer } from "../generated/AdventCalendarToken/AdventCalendarToken";
import { AccountTokenBalance } from "../generated/schema";
// Transferのイベントが発火された時に実行されるfunction
export function handleTransfer(event: Transfer): void {
let tokenId = event.address.toHex();
let toAddress = event.params.to.toHex();
let toAccount = AccountTokenBalance.load(toAddress);
if (toAccount == null) {
toAccount = new AccountTokenBalance(toAddress);
toAccount.balance = BigInt.fromI32(0);
}
toAccount.balance = toAccount.balance.plus(event.params.value);
toAccount.token = tokenId;
toAccount.save();
let fromAddress = event.params.from.toHex();
if (fromAddress == "0x0000000000000000000000000000000000000000") {
return;
}
let fromAccount = AccountTokenBalance.load(fromAddress);
if (fromAccount == null) {
fromAccount = new AccountTokenBalance(fromAddress);
fromAccount.balance = BigInt.fromI32(0);
}
fromAccount.balance = fromAccount.balance.minus(event.params.value);
fromAccount.token = tokenId;
fromAccount.save();
}
おそらく、5ー3、5ー4を読み進めていただければ、内容もしっくり来るのかなと思います。
6 Subgraphを作ってみよう
では、The Graphのサイトから実際にSubgraphを作ってみましょう。
↑こちらのSubgraphの名前は第4章で作った名前と一致させましょう。
これでSubGraphができました!
デプロイはまだされていません。デプロイ時に
① Subgraph Slug
② Deploy Key
が必要になるようです。
7 Subgraphをデプロイしよう
さて、第6章で作ったSubgraphをデプロイしてみましょう。
このように、Subgraphの「Details」にやり方が書いてありますので、これをそのまま実行するだけです。
認証やビルドを行い、(必要でしたら移動もしてください)
subgraph.yamlファイルにビルドされたものが格納されました。
続いてはデプロイです。
versionを聞かれたので、例と同じにしました。
ビルド結果は、IPFSに格納されるようです。
せっかくなので、見てみましょう。
このように格納されたことがわかります。
少し待つと、下のようにSubgraphがデプロイ・同期されることがわかります。
8 SubGraphを使ってみよう。
では、実際にデプロイしたSubgraphを使ってみましょう。
「Playground」に行って、紫のボタンを押してみます。
上のようになりました。これでこのコントラクトのトークンの情報をとってきました。
現在、トークンを作っただけで誰にも渡していないので、持ち主に「1000~00」のトークンが入っています。
では、このトークンをAさんからBさんに3,333渡してから紫を押してみましょう。
すると、上のように2人分が現れました。
残高を大きい順にしたいときは「Query」をこのように変えてみます。
このように順番が変わりました。
なお、このクエリの書き方はこちらに詳しく載っています。
9 最後に
このSubgraphの特徴として、自分が作ったコントラクトではないコントラクトでも作成が可能です。
今回使ったコントラクトは以下になりますので、もしよかったらご自由にテストとして使ってください。
コントラクトアドレス:0x8dc84bfa7ac407711575ee63d370b794340bac00
↓ ABI
{
"_format": "hh-sol-artifact-1",
"contractName": "TheGraphTestToken",
"sourceName": "contracts/TheGraphTestToken.sol",
"abi": [
{
"inputs": [],
"stateMutability": "nonpayable",
"type": "constructor"
},
{
"anonymous": false,
"inputs": [
{
"indexed": true,
"internalType": "address",
"name": "owner",
"type": "address"
},
{
"indexed": true,
"internalType": "address",
"name": "spender",
"type": "address"
},
{
"indexed": false,
"internalType": "uint256",
"name": "value",
"type": "uint256"
}
],
"name": "Approval",
"type": "event"
},
{
"anonymous": false,
"inputs": [
{
"indexed": true,
"internalType": "address",
"name": "from",
"type": "address"
},
{
"indexed": true,
"internalType": "address",
"name": "to",
"type": "address"
},
{
"indexed": false,
"internalType": "uint256",
"name": "value",
"type": "uint256"
}
],
"name": "Transfer",
"type": "event"
},
{
"inputs": [
{
"internalType": "address",
"name": "owner",
"type": "address"
},
{
"internalType": "address",
"name": "spender",
"type": "address"
}
],
"name": "allowance",
"outputs": [
{
"internalType": "uint256",
"name": "",
"type": "uint256"
}
],
"stateMutability": "view",
"type": "function"
},
{
"inputs": [
{
"internalType": "address",
"name": "spender",
"type": "address"
},
{
"internalType": "uint256",
"name": "amount",
"type": "uint256"
}
],
"name": "approve",
"outputs": [
{
"internalType": "bool",
"name": "",
"type": "bool"
}
],
"stateMutability": "nonpayable",
"type": "function"
},
{
"inputs": [
{
"internalType": "address",
"name": "account",
"type": "address"
}
],
"name": "balanceOf",
"outputs": [
{
"internalType": "uint256",
"name": "",
"type": "uint256"
}
],
"stateMutability": "view",
"type": "function"
},
{
"inputs": [],
"name": "decimals",
"outputs": [
{
"internalType": "uint8",
"name": "",
"type": "uint8"
}
],
"stateMutability": "view",
"type": "function"
},
{
"inputs": [
{
"internalType": "address",
"name": "spender",
"type": "address"
},
{
"internalType": "uint256",
"name": "subtractedValue",
"type": "uint256"
}
],
"name": "decreaseAllowance",
"outputs": [
{
"internalType": "bool",
"name": "",
"type": "bool"
}
],
"stateMutability": "nonpayable",
"type": "function"
},
{
"inputs": [
{
"internalType": "address",
"name": "spender",
"type": "address"
},
{
"internalType": "uint256",
"name": "addedValue",
"type": "uint256"
}
],
"name": "increaseAllowance",
"outputs": [
{
"internalType": "bool",
"name": "",
"type": "bool"
}
],
"stateMutability": "nonpayable",
"type": "function"
},
{
"inputs": [],
"name": "name",
"outputs": [
{
"internalType": "string",
"name": "",
"type": "string"
}
],
"stateMutability": "view",
"type": "function"
},
{
"inputs": [],
"name": "symbol",
"outputs": [
{
"internalType": "string",
"name": "",
"type": "string"
}
],
"stateMutability": "view",
"type": "function"
},
{
"inputs": [],
"name": "totalSupply",
"outputs": [
{
"internalType": "uint256",
"name": "",
"type": "uint256"
}
],
"stateMutability": "view",
"type": "function"
},
{
"inputs": [
{
"internalType": "address",
"name": "recipient",
"type": "address"
},
{
"internalType": "uint256",
"name": "amount",
"type": "uint256"
}
],
"name": "transfer",
"outputs": [
{
"internalType": "bool",
"name": "",
"type": "bool"
}
],
"stateMutability": "nonpayable",
"type": "function"
},
{
"inputs": [
{
"internalType": "address",
"name": "sender",
"type": "address"
},
{
"internalType": "address",
"name": "recipient",
"type": "address"
},
{
"internalType": "uint256",
"name": "amount",
"type": "uint256"
}
],
"name": "transferFrom",
"outputs": [
{
"internalType": "bool",
"name": "",
"type": "bool"
}
],
"stateMutability": "nonpayable",
"type": "function"
}
],
"bytecode": "0x60c060405260116080819052702a3432a3b930b8342a32b9ba2a37b5b2b760791b60a09081526200003491600591906200030a565b5060408051808201909152600580825264081511d51560da1b602090920191825262000063916006916200030a565b5060078054601260ff1990911617610100600160a81b031916610100330217905569021e19e0c9bab24000006008553480156200009f57600080fd5b5060058054620000af9062000415565b80601f0160208091040260200160405190810160405280929190818152602001828054620000dd9062000415565b80156200012e5780601f1062000102576101008083540402835291602001916200012e565b820191906000526020600020905b8154815290600101906020018083116200011057829003601f168201915b505050505060068054620001429062000415565b80601f0160208091040260200160405190810160405280929190818152602001828054620001709062000415565b8015620001c15780601f106200019557610100808354040283529160200191620001c1565b820191906000526020600020905b815481529060010190602001808311620001a357829003601f168201915b50508451620001db9350600392506020860191506200030a565b508051620001f19060049060208401906200030a565b5050506200021d600760019054906101000a90046001600160a01b03166008546200022360201b60201c565b62000452565b6001600160a01b038216620002555760405162461bcd60e51b81526004016200024c90620003b0565b60405180910390fd5b620002636000838362000305565b8060026000828254620002779190620003f0565b90915550506001600160a01b03821660009081526020819052604081208054839290620002a6908490620003f0565b90915550506040516001600160a01b038316906000907fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef90620002eb908590620003e7565b60405180910390a3620003016000838362000305565b5050565b505050565b828054620003189062000415565b90600052602060002090601f0160209004810192826200033c576000855562000387565b82601f106200035757805160ff191683800117855562000387565b8280016001018555821562000387579182015b82811115620003875782518255916020019190600101906200036a565b506200039592915062000399565b5090565b5b808211156200039557600081556001016200039a565b6020808252601f908201527f45524332303a206d696e7420746f20746865207a65726f206164647265737300604082015260600190565b90815260200190565b600082198211156200041057634e487b7160e01b81526011600452602481fd5b500190565b6002810460018216806200042a57607f821691505b602082108114156200044c57634e487b7160e01b600052602260045260246000fd5b50919050565b6109bd80620004626000396000f3fe608060405234801561001057600080fd5b50600436106100a95760003560e01c80633950935111610071578063395093511461012957806370a082311461013c57806395d89b411461014f578063a457c2d714610157578063a9059cbb1461016a578063dd62ed3e1461017d576100a9565b806306fdde03146100ae578063095ea7b3146100cc57806318160ddd146100ec57806323b872dd14610101578063313ce56714610114575b600080fd5b6100b6610190565b6040516100c391906106dd565b60405180910390f35b6100df6100da3660046106a9565b610222565b6040516100c391906106d2565b6100f461023f565b6040516100c39190610911565b6100df61010f36600461066e565b610245565b61011c6102de565b6040516100c3919061091a565b6100df6101373660046106a9565b6102e3565b6100f461014a36600461061b565b610337565b6100b6610356565b6100df6101653660046106a9565b610365565b6100df6101783660046106a9565b6103de565b6100f461018b36600461063c565b6103f2565b60606003805461019f9061094c565b80601f01602080910402602001604051908101604052809291908181526020018280546101cb9061094c565b80156102185780601f106101ed57610100808354040283529160200191610218565b820191906000526020600020905b8154815290600101906020018083116101fb57829003601f168201915b5050505050905090565b600061023661022f61041d565b8484610421565b50600192915050565b60025490565b60006102528484846104d5565b6001600160a01b03841660009081526001602052604081208161027361041d565b6001600160a01b03166001600160a01b03168152602001908152602001600020549050828110156102bf5760405162461bcd60e51b81526004016102b6906107fb565b60405180910390fd5b6102d3856102cb61041d565b858403610421565b506001949350505050565b601290565b60006102366102f061041d565b8484600160006102fe61041d565b6001600160a01b03908116825260208083019390935260409182016000908120918b16815292529020546103329190610928565b610421565b6001600160a01b0381166000908152602081905260409020545b919050565b60606004805461019f9061094c565b6000806001600061037461041d565b6001600160a01b03908116825260208083019390935260409182016000908120918816815292529020549050828110156103c05760405162461bcd60e51b81526004016102b6906108cc565b6103d46103cb61041d565b85858403610421565b5060019392505050565b60006102366103eb61041d565b84846104d5565b6001600160a01b03918216600090815260016020908152604080832093909416825291909152205490565b3390565b6001600160a01b0383166104475760405162461bcd60e51b81526004016102b690610888565b6001600160a01b03821661046d5760405162461bcd60e51b81526004016102b690610773565b6001600160a01b0380841660008181526001602090815260408083209487168084529490915290819020849055517f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925906104c8908590610911565b60405180910390a3505050565b6001600160a01b0383166104fb5760405162461bcd60e51b81526004016102b690610843565b6001600160a01b0382166105215760405162461bcd60e51b81526004016102b690610730565b61052c8383836105ff565b6001600160a01b038316600090815260208190526040902054818110156105655760405162461bcd60e51b81526004016102b6906107b5565b6001600160a01b0380851660009081526020819052604080822085850390559185168152908120805484929061059c908490610928565b92505081905550826001600160a01b0316846001600160a01b03167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef846040516105e69190610911565b60405180910390a36105f98484846105ff565b50505050565b505050565b80356001600160a01b038116811461035157600080fd5b60006020828403121561062c578081fd5b61063582610604565b9392505050565b6000806040838503121561064e578081fd5b61065783610604565b915061066560208401610604565b90509250929050565b600080600060608486031215610682578081fd5b61068b84610604565b925061069960208501610604565b9150604084013590509250925092565b600080604083850312156106bb578182fd5b6106c483610604565b946020939093013593505050565b901515815260200190565b6000602080835283518082850152825b81811015610709578581018301518582016040015282016106ed565b8181111561071a5783604083870101525b50601f01601f1916929092016040019392505050565b60208082526023908201527f45524332303a207472616e7366657220746f20746865207a65726f206164647260408201526265737360e81b606082015260800190565b60208082526022908201527f45524332303a20617070726f766520746f20746865207a65726f206164647265604082015261737360f01b606082015260800190565b60208082526026908201527f45524332303a207472616e7366657220616d6f756e7420657863656564732062604082015265616c616e636560d01b606082015260800190565b60208082526028908201527f45524332303a207472616e7366657220616d6f756e74206578636565647320616040820152676c6c6f77616e636560c01b606082015260800190565b60208082526025908201527f45524332303a207472616e736665722066726f6d20746865207a65726f206164604082015264647265737360d81b606082015260800190565b60208082526024908201527f45524332303a20617070726f76652066726f6d20746865207a65726f206164646040820152637265737360e01b606082015260800190565b60208082526025908201527f45524332303a2064656372656173656420616c6c6f77616e63652062656c6f77604082015264207a65726f60d81b606082015260800190565b90815260200190565b60ff91909116815260200190565b6000821982111561094757634e487b7160e01b81526011600452602481fd5b500190565b60028104600182168061096057607f821691505b6020821081141561098157634e487b7160e01b600052602260045260246000fd5b5091905056fea2646970667358221220dfd3d8a35108791c605272cbe64bdcc2f4cbbd14648805847b92fa1ae5800de764736f6c63430008010033",
"deployedBytecode": "0x608060405234801561001057600080fd5b50600436106100a95760003560e01c80633950935111610071578063395093511461012957806370a082311461013c57806395d89b411461014f578063a457c2d714610157578063a9059cbb1461016a578063dd62ed3e1461017d576100a9565b806306fdde03146100ae578063095ea7b3146100cc57806318160ddd146100ec57806323b872dd14610101578063313ce56714610114575b600080fd5b6100b6610190565b6040516100c391906106dd565b60405180910390f35b6100df6100da3660046106a9565b610222565b6040516100c391906106d2565b6100f461023f565b6040516100c39190610911565b6100df61010f36600461066e565b610245565b61011c6102de565b6040516100c3919061091a565b6100df6101373660046106a9565b6102e3565b6100f461014a36600461061b565b610337565b6100b6610356565b6100df6101653660046106a9565b610365565b6100df6101783660046106a9565b6103de565b6100f461018b36600461063c565b6103f2565b60606003805461019f9061094c565b80601f01602080910402602001604051908101604052809291908181526020018280546101cb9061094c565b80156102185780601f106101ed57610100808354040283529160200191610218565b820191906000526020600020905b8154815290600101906020018083116101fb57829003601f168201915b5050505050905090565b600061023661022f61041d565b8484610421565b50600192915050565b60025490565b60006102528484846104d5565b6001600160a01b03841660009081526001602052604081208161027361041d565b6001600160a01b03166001600160a01b03168152602001908152602001600020549050828110156102bf5760405162461bcd60e51b81526004016102b6906107fb565b60405180910390fd5b6102d3856102cb61041d565b858403610421565b506001949350505050565b601290565b60006102366102f061041d565b8484600160006102fe61041d565b6001600160a01b03908116825260208083019390935260409182016000908120918b16815292529020546103329190610928565b610421565b6001600160a01b0381166000908152602081905260409020545b919050565b60606004805461019f9061094c565b6000806001600061037461041d565b6001600160a01b03908116825260208083019390935260409182016000908120918816815292529020549050828110156103c05760405162461bcd60e51b81526004016102b6906108cc565b6103d46103cb61041d565b85858403610421565b5060019392505050565b60006102366103eb61041d565b84846104d5565b6001600160a01b03918216600090815260016020908152604080832093909416825291909152205490565b3390565b6001600160a01b0383166104475760405162461bcd60e51b81526004016102b690610888565b6001600160a01b03821661046d5760405162461bcd60e51b81526004016102b690610773565b6001600160a01b0380841660008181526001602090815260408083209487168084529490915290819020849055517f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925906104c8908590610911565b60405180910390a3505050565b6001600160a01b0383166104fb5760405162461bcd60e51b81526004016102b690610843565b6001600160a01b0382166105215760405162461bcd60e51b81526004016102b690610730565b61052c8383836105ff565b6001600160a01b038316600090815260208190526040902054818110156105655760405162461bcd60e51b81526004016102b6906107b5565b6001600160a01b0380851660009081526020819052604080822085850390559185168152908120805484929061059c908490610928565b92505081905550826001600160a01b0316846001600160a01b03167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef846040516105e69190610911565b60405180910390a36105f98484846105ff565b50505050565b505050565b80356001600160a01b038116811461035157600080fd5b60006020828403121561062c578081fd5b61063582610604565b9392505050565b6000806040838503121561064e578081fd5b61065783610604565b915061066560208401610604565b90509250929050565b600080600060608486031215610682578081fd5b61068b84610604565b925061069960208501610604565b9150604084013590509250925092565b600080604083850312156106bb578182fd5b6106c483610604565b946020939093013593505050565b901515815260200190565b6000602080835283518082850152825b81811015610709578581018301518582016040015282016106ed565b8181111561071a5783604083870101525b50601f01601f1916929092016040019392505050565b60208082526023908201527f45524332303a207472616e7366657220746f20746865207a65726f206164647260408201526265737360e81b606082015260800190565b60208082526022908201527f45524332303a20617070726f766520746f20746865207a65726f206164647265604082015261737360f01b606082015260800190565b60208082526026908201527f45524332303a207472616e7366657220616d6f756e7420657863656564732062604082015265616c616e636560d01b606082015260800190565b60208082526028908201527f45524332303a207472616e7366657220616d6f756e74206578636565647320616040820152676c6c6f77616e636560c01b606082015260800190565b60208082526025908201527f45524332303a207472616e736665722066726f6d20746865207a65726f206164604082015264647265737360d81b606082015260800190565b60208082526024908201527f45524332303a20617070726f76652066726f6d20746865207a65726f206164646040820152637265737360e01b606082015260800190565b60208082526025908201527f45524332303a2064656372656173656420616c6c6f77616e63652062656c6f77604082015264207a65726f60d81b606082015260800190565b90815260200190565b60ff91909116815260200190565b6000821982111561094757634e487b7160e01b81526011600452602481fd5b500190565b60028104600182168061096057607f821691505b6020821081141561098157634e487b7160e01b600052602260045260246000fd5b5091905056fea2646970667358221220dfd3d8a35108791c605272cbe64bdcc2f4cbbd14648805847b92fa1ae5800de764736f6c63430008010033",
"linkReferences": {},
"deployedLinkReferences": {}
}
いいなと思ったら応援しよう!
![ユウキ](https://assets.st-note.com/production/uploads/images/52347520/profile_e7d36b385c74618d7fec56da47f68a35.jpeg?width=600&crop=1:1,smart)