Solidity 入門: オラクルの基本的な使い方(Chainlink Data Feeds)
Feb 27, 2022このページはこんな人におすすめ
- イーサリアム上で価格情報を使いたい
- スマートコントラクトのオラクルについて知りたい
- Chainlink の Ethereum Data Feed を使いたい
Solidity by Example のサンプルコードを使ってスマートコントラクトを作る方法を解説します。
Price Oracle (Solidity by Example)
このページで実際に使ったソースコードはGitHubからダウンロードできます。
オラクルと Chainlink について
オラクルは、オンチェーンのスマートコントラクトがオフチェーンの情報を利用するときに使います。
一般的な Web サービスの場合、API を呼び出しますが、EVM のスマートコントラクトは、ダイレクトにオフチェーンの API を実行することはできません。
そこで Chainlink では以下のようなしくみで、オフチェーンのデータをオンチェーンで使えるようにしています。
上図の Consumer がこのページで作るスマートコントラクトです。
Proxy や Aggregator は Chainlink がデプロイしたスマートコントラクトです。
Consumer は Proxy の latestRoundData() という関数を実行して、Aggregator コントラクトが保持している state を参照します。
新しいプロジェクトを作る
price-oracle というディレクトリを作り npm パッケージの hardhat をインストールします。
mkdir price-oracle
cd price-oracle
npm init -y
npm i --save-dev hardhat
Hardhat のサンプルプロジェクトを作ります。
npx hardhat
Create a sample project
を選択して、すべて Yes で回答します。
? What do you want to do? …
❯ Create a sample project
Create an empty hardhat.config.js
Quit
これで hardhat.config.js の初期設定や ether.js などプラグインを追加した状態になります。
コーディング
以下のファイルを作ります。
contracts/ChainlinkPriceFeed.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.10;
// import "@chainlink/contracts/src/v0.8/interfaces/AggregatorV3Interface.sol";
contract ChainlinkPriceOracle {
AggregatorV3Interface internal priceFeed;
constructor() {
// ETH / USD
priceFeed = AggregatorV3Interface(
0x8A753747A1Fa494EC906cE90E9f37563A8AF630e
);
}
function getLatestPrice() public view returns (int256) {
(
uint80 roundID,
int256 price,
uint256 startedAt,
uint256 timeStamp,
uint80 answeredInRound
) = priceFeed.latestRoundData();
// for ETH / USD price is scaled up by 10 ** 8
return price / 1e8;
}
}
interface AggregatorV3Interface {
function latestRoundData()
external
view
returns (
uint80 roundId,
int256 answer,
uint256 startedAt,
uint256 updatedAt,
uint80 answeredInRound
);
}
Solidity by Example のコードをベースに PriceFeed のコントラクトアドレスを Rinkeby のアドレスに置換しています。
Ethereum Data Feed
Rinkeby Testnet (ETH / USD)
- 0x8A753747A1Fa494EC906cE90E9f37563A8AF630e
デプロイ (Rinkeby テストネット)
必要なもの
- Rinkeby のアカウント(秘密鍵)
- Rinkeby の RPC エンドポイント(Alchemy を利用)
- Rinkeby の ETH 少量
Hardhat でデプロイする方法の詳細はこちらに書かれています。 参照先はテストネットが Ropsten になっているので、Rinkeby に読み替えてください。
環境変数
以下の環境変数を設定します。デプロイのコマンドを実行するターミナルで実行するかログインシェル用の設定ファイルに追加してください。
RINKEBY_PRIVATE_KEY=<Rinkebyのアカウント秘密鍵>
RINKEBY_RPC_URL=<RinkebyのRPCエンドポイント>
export RINKEBY_PRIVATE_KEY RINKEBY_RPC_URL
hardhat.config.js
Hardhat の設定ファイルを作ります。
require("@nomiclabs/hardhat-waffle");
const RINKEBY_PRIVATE_KEY = process.env.RINKEBY_PRIVATE_KEY;
const RINKEBY_RPC_URL = process.env.RINKEBY_RPC_URL;
/**
* @type import('hardhat/config').HardhatUserConfig
*/
module.exports = {
solidity: "0.8.10",
networks: {
rinkeby: {
url: `${RINKEBY_RPC_URL}`,
accounts: [`${RINKEBY_PRIVATE_KEY}`],
},
},
};
scripts/deploy.js
デプロイスクリプトを用意します。
const hre = require("hardhat");
async function main() {
const Factory = await hre.ethers.getContractFactory("ChainlinkPriceOracle");
const contract = await Factory.deploy();
await contract.deployed();
console.log("Contract deployed to:", contract.address);
}
main()
.then(() => process.exit(0))
.catch((error) => {
console.error(error);
process.exit(1);
});
以下のコマンドを実行してコンパイルします。
npx hardhat compile
以下のコマンドを実行して、rinkeby テストネットにデプロイします。
npx hardhat run scripts/deploy.js --network rinkeby
出力
Contract deployed to: 0xc701F8eaeF74f3DE1FEe8613855884d02CfE9517
デプロイが成功すると上記のようにコントラクトアドレスが表示されます。
実行
Rinkeby の Etherscan を使って getLatestPrice 関数を実行してみましょう。
- Rinkeby の Etherscan を開く
- 自分がデプロイしたコントラクトアドレスを検索する
- Contract タブの Read Contract をクリック
- getLatestPrice 関数をクリック
現在の Chainlink の PriceFeed コントラクト(ETH/USD)から取得した値が表示されます。
もし、自分のコントラクトがうまくいかない場合は、筆者がデプロイしたコントラクトで試してみましょう。 https://rinkeby.etherscan.io/address/0xc701F8eaeF74f3DE1FEe8613855884d02CfE9517
解説
デプロイしたコントラクトの中では Chainlink の PriceFeed のコントラクトを実行しています。 そのコントラクトは同じネットワーク(Rinkeby)上にデプロイされたコントラクトです。
https://rinkeby.etherscan.io/address/0x8A753747A1Fa494EC906cE90E9f37563A8AF630e
PriceFeed コントラクトの latestRoundData()は手動でも実行できます。
この関数の戻り値の中の 2 番目の answer が ETH/USD の価格を表しています。
ただし、以下の 2 つの結果は単位が違います。
- PriceFeed コントラクトの latestRoundData(): 321770736905
- 自分が作ったコントラクトの getLatestPrice(): 3217
今回デプロイしたコードは以下のようになっています。
) = priceFeed.latestRoundData();
// for ETH / USD price is scaled up by 10 ** 8
return price / 1e8;
PriceFeed コントラクトの結果を 10 の 8 乗で除しています。 getLatestPrice()の戻り値は、int256 型なので小数点以下は切り捨てられます。
321,770,736,905 / 100,000,000 = 3,217(int256)