lesson-3_スマートコントラクトを作ろう
👩💻 コントラクトを作成する
NFTを作成するスマートコントラクトを作成します。
- ここで作成するスマートコントラクトは、後でユースケースに合わせて自由に変更できます。
contracts
ディレクトリの下にMyEpicGame.sol
という名前のファイルを作成します。
Hardhatを使用する場合、ファイル構造は非常に重要ですので、注意する必要があります。ファイル構造が下記のようになっていれば大丈夫です 😊
contract
|_ contracts
|_ MyEpicGame.sol
次に、コードエディタでプロジェクトのコードを開きます。
ここでは、VS Codeの使用をお勧めします。ダウンロードはこちらから。
VS Codeをターミナルから起動する方法はこちらをご覧ください。今後VS Codeを起動するのが一段と楽になるので、ぜひ導入してみてください。
それでは、これからMyEpicGame.sol
の中身の作成していきます。MyEpicGame.sol
をVS Codeで開き、下記を入力します。
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.17;
import "hardhat/console.sol";
contract MyEpicGame {
constructor() {
console.log("THIS IS MY GAME CONTRACT.");
}
}
コーディングのサポートツールとして、VS Code上でSolidityの拡張機能をダウンロードすることをお勧めします。ダウンロードは こちら から。
一行ずつコードを見ていきましょう。
// SPDX-License-Identifier: MIT
これは「SPDXライセンス識別子」と呼ばれ、ソフトウェア・ライセンスの種類が一目でわかるようにするための識別子です。
詳細については、ここを参照してみてください。
pragma solidity ^0.8.17;
これは、コントラクトで使用するSolidityコンパイラのバージョンです。上記の場合「このコントラクトを実行するときは、Solidityコンパイラのバージョン0.8.17のみを使用し、それ以下のものは使用しません」という意味です。コンパイラのバージョンがhardhat.config.js
で同じであることを確認してください。
もし、hardhat.config.js
の中に記載されているSolidityのバージョンが0.8.17
でなかった場合は、MyEpicGame.sol
の中身をhardhat.config.js
に記載されているバージョンに変更しましょう。
import "hardhat/console.sol";
コントラクトを実行する際、コンソールログをターミナルに出力するためにHardhatのconsole.sol
のファイルをインポートしています。これは、今後スマートコントラクトのデバッグが発生した場合に、とても役立つツールです。
contract MyEpicGame {
constructor() {
console.log("THIS IS MY GAME CONTRACT.");
}
}
contract
は、ほかの言語でいうところの「class」のようなものなのです。
このcontract
を初期化すると、constructor
が実行されてconsole.log
の中身がターミナル上に表示されます。
classの概念については、ここを参照してみてください。
🔩 constructorとは
constructor
はオプションの関数で、contract
の状態変数を初期化するために使用されます。これから詳しく説明していくので、constructor
に関しては、まず以下の特徴を理解してください。
-
contract
は1つのconstructor
しか持つことができません。 -
constructor
は、スマートコントラクトの作成時に一度だけ実行され、contract
の状態を初期化するために使用されます。 -
constructor
が実行された後、コードがブロックチェーンにデプロイされます。
🔥 スマートコントラクトをテスト環境で実行しよう
前回のレッスンでは、MyEpicGame.sol
というスマートコントラクトを作成しました。
今回のレッスンでは下記を実行します。
1. MyEpicGame.sol
をコンパイルします。
2. MyEpicGame.sol
をテスト環境(=ローカル環境)でブロックチェーン上にデプロイします。
3. 上記が完了したら、console.log
の中身がターミナル上に表示されます。
このプロジェクトの最終ゴールは、あなたのスマートコントラクトをブロックチェーン上にのせ、あなたのWebアプリケーションを介して世界中の人々がそのスマートコントラクトにアクセスできる状態を実現することです。
まずは、上記の作業をテスト環境で行います。
📝 コントラクトを実行するためのプログラムを作成する
scripts
ディレクトリに移動し、run.js
という名前のファイルを作成してください。
run.js
はローカル環境でスマートコントラクトのテストを行うためのプログラムです。
run.js
の中身に、以下を記入しましょう。
const main = async () => {
const gameContractFactory = await hre.ethers.getContractFactory("MyEpicGame");
const gameContract = await gameContractFactory.deploy();
const nftGame = await gameContract.deployed();
console.log("Contract deployed to:", nftGame.address);
};
const runMain = async () => {
try {
await main();
process.exit(0);
} catch (error) {
console.log(error);
process.exit(1);
}
};
runMain();
それでは、1行ずつコードの理解を深めましょう。
const gameContractFactory = await hre.ethers.getContractFactory("MyEpicGame");
これにより、MyEpicGame
コントラクトがコンパイルされます。
コントラクトがコンパイルされたら、コントラクトを扱うために必要なファイルがartifacts
ディレクトリの直下に生成されます 。
✍️:
hre.ethers.getContractFactory
についてgetContractFactory
関数は、デプロイをサポートするライブラリのアドレスとMyEpicGame
コントラクトの連携を行っています。
hre.ethers
は、Hardhat プラグインの仕様です。
✍️:
const main = async ()
とawait
について Javascript でコードを書いていると、コードの上から順に実行されなくて困ることがあります。これを非同期処理に関する問題といいます。解決法の一つとして、ここでは
async
/await
を使用します。これを使うと、
await
が先頭についている処理が終わるまで、main
関数の他の処理は行われません。つまり、
hre.ethers.getContractFactory("MyEpicGame")
の処理が終わるまで、main
関数の中に記載されている他の処理は実行されないということです。
次に、下記の処理を見ていきましょう。
const gameContract = await gameContractFactory.deploy();
HardhatがローカルのEthereumネットワークを、コントラクトのためだけに作成します。 そして、スクリプトの実行が完了した後、そのローカル・ネットワークを破棄します。 つまり、コントラクトを実行するたびに、毎回ローカルサーバーを更新するかのようにブロックチェーンが新しくなります。
- 常にゼロリセットとなるので、エラーのデバッグがしやすくなります。
次に下記の処理を見ていきましょう。
const nftGame = await gameContract.deployed();
ここでは、nftGame
コントラクトが、ローカルのブロックチェーンにデプロイされるまで待つ処理を行っています。
Hardhatは実際にあなたのマシン上に「マイナー」を作成し、ブロックチェーンを構築してくれます。
私たちのconstructor
は、私たちが実際に完全にデプロイされたときに実行されます!
console.log("Contract deployed to:", gameContract.address);
最後に、デプロイされると、gameContract.address
はデプロイされたコントラクトのアドレスを出力します。
このアドレスから、ブロックチェーン上でコントラクトを見つけることができますが、今回はローカルのイーサリアムネットワーク(=ブロックチェーン)に実装しているため、世界中の人がアクセスできるわけでありません。
一方、イーサリアムメインネット上のブロックチェーンにデプロイしていれば、世界中の誰でもコントラクトにアクセスできます。