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はデプロイされたコントラクトのアドレスを出力します。

このアドレスから、ブロックチェーン上でコントラクトを見つけることができますが、今回はローカルのイーサリアムネットワーク（＝ブロックチェーン）に実装しているため、世界中の人がアクセスできるわけでありません。

一方、イーサリアムメインネット上のブロックチェーンにデプロイしていれば、世界中の誰でもコントラクトにアクセスできます。

実際のブロックチェーン上には、すでに何百万ものスマートコントラクトがデプロイされています。

アドレスさえわかれば、世界中どこにいても、私たちが興味を持っているコントラクトに簡単にアクセスできます。

🪄 実行してみよう

まずは、packages/contract/package.jsonのscript部分を以下のように編集してください。

"scripts": {
    "run:script":"npx hardhat run scripts/run.js",
    "test": "npx hardhat test",
    "deploy": "npx hardhat run scripts/deploy.js --network sepolia",
    "start":"npx hardhat node",
  },

ターミナル上で下記を実行してみましょう。

yarn contract run:script

ターミナル上でconsole.logの中身とコントラクトアドレスが表示されていることを確認してください。

例)ターミナル上でのアウトプット:

Compiling 1 file with 0.8.17
Solidity compilation finished successfully
THIS IS MY GAME CONTRACT.
Contract deployed to: 0x5FbDB2315678afecb367f032d93F642f64180aa3

上記のようなアウトプットターミナルに表示されていればテストは成功です。

🎩 Hardhat Runtime Environment について

run.jsの中で、hre.ethersが登場します。

しかし、hreはどこにもインポートされていません。それはなぜでしょうか？

それは、ずばり、HardhatがHardhat Runtime Environment（HRE）を呼び出しているからです。

HREは、Hardhatが用意したすべての機能を含むオブジェクト（＝コードの束）です。hardhatで始まるターミナルコマンドを実行するたびに、HREにアクセスしているので、hreをrun.jsにインポートする必要はありません。

詳しくは、Hardhat 公式ドキュメント（英語） にて確認できます。

🙋‍♂️ 質問する

ここまでの作業で何かわからないことがある場合は、Discordの#ethereumで質問をしてください。

ヘルプをするときのフローが円滑になるので、エラーレポートには下記の3点を記載してください ✨

1. 質問が関連しているセクション番号とレッスン番号
2. 何をしようとしていたか
3. エラー文をコピー&ペースト
4. エラー画面のスクリーンショット

---

ターミナル上にconsole.logの中身とコントラクトアドレスを出力できたら、次のレッスンに進んでください 🎉