lesson-3_スマートコントラクトをつくってみよう

📝 スマートコントラクトを作成する

contractsディレクトリの下にWeb3Mint.solという名前のファイルを作成しましょう。

Hardhatを使用する場合、ファイル構造は非常に重要ですので、注意する必要があります。ファイル構造が下記のようになっていれば大丈夫です 😊

contract
 └── contracts
     └── Web3Mint.sol

次に、コードエディタでプロジェクトのコードを開きます。

ここでは、VS Codeの使用をお勧めします。ダウンロードはこちらから。

VS Codeをターミナルから起動する方法はこちらをご覧ください。今後VS Codeを起動するのが一段と楽になるので、ぜひ導入してみてください。
VS Code用の Solidity 拡張機能をダウンロードすることをお勧めします。この拡張機能により、構文が見やすくなります。

それでは、実際にコントラクトを書いていきましょう。

Web3Mint.solのファイル内に以下のコードを記載します。

// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.17;
import "hardhat/console.sol";
contract Web3Mint {
    constructor() {
        console.log("This is my NFT contract.");
    }
}

⚠️: 注意

上記のコードに対して、VS Code がエラーを表示する場合があります。例えば、import hardhatに下線が引かれ、don't existと表示される場合があります。

これは、グローバル Solidity コンパイラがローカルに設定されていないために発生します。

修正する方法がわからなくても心配しないでください。無視して問題ありません。さて、行ごとにコードをみていきましょう。

// Web3Mint.sol
// SPDX-License-Identifier: UNLICENSED

これは「SPDXライセンス識別子」と呼ばれます。

詳細については、ここを参照してみてください。

// Web3Mint.sol
pragma solidity ^0.8.17;

これは、コントラクトで使用するSolidityコンパイラのバージョンです。

上記の場合「このコントラクトを実行するときは、Solidityコンパイラのバージョン0.8.17のみを使用し、それ以下のものは使用しません」という意味です。

コンパイラのバージョンがhardhat.config.jsで同じであることを確認してください。

もし、hardhat.config.jsの中に記載されているSolidityのバージョンが0.8.17でなかった場合は、Web3Mint.solの中身をhardhat.config.jsに記載されているバージョンに変更しましょう。

// Web3Mint.sol
import "hardhat/console.sol";

Hardhatのおかげで、コントラクトでコンソールログを実行できます。

実際には、ブロックチェーン上にデプロイしたスマートコントラクトをデバッグすることは困難です。

なぜなら、一度デプロイしてしまったコントラクトを改変できないからです。

これには、ブロックチェーンが改ざんできない特性でもあります。

よって、Hardhatはローカル環境でコントラクトのデプロイを行えるため、ブロックチェーン上にアップロードする前に簡単にデバッグができる便利なツールといえます。

// Web3Mint.sol
contract Web3Mint {
    constructor() {
        console.log("This is my NFT contract.");
    }
}

contractは、ほかの言語でいうところの「class」のようなものなのです。

このcontractを初期化すると、constructorが実行されてconsole.logの中身がターミナル上に表示されます。

classの概念については、ここを参照してみてください。

🔩 constructor とは

constructorはオプションの関数で、contractの状態変数を初期化するために使用されます。これから詳しく説明していくので、constructorに関しては、まず以下の特徴を理解してください。

contractは1つのconstructorしか持つことができません。
constructorは、スマートコントラクトの作成時に一度だけ実行され、contractの状態を初期化するために使用されます。
constructorは、コントラクトがデプロイされたときに初めて実行されます。
constructorが実行された後、コードがブロックチェーンにデプロイされます。

😲 スマートコントラクトを実行する

スマートコントラクトを実行するためには以下の手順が必要です。

コンパイルする。
ローカル環境のブロックチェーンにデプロイする。
console.logが実行される。

ここでは、この3つのステップを処理して、テストするプログラムを作成していきます。

scriptsディレクトリに移動して、run.jsという名前のファイルを作成しましょう。

run.jsの中身を下記のように更新しましょう。

const main = async () => {
  // コントラクトがコンパイルします
  // コントラクトを扱うために必要なファイルが `artifacts` ディレクトリの直下に生成されます。
  const nftContractFactory = await hre.ethers.getContractFactory("Web3Mint");
  // Hardhat がローカルの Ethereum ネットワークを作成します。
  const nftContract = await nftContractFactory.deploy();
  // コントラクトが Mint され、ローカルのブロックチェーンにデプロイされるまで待ちます。
  await nftContract.deployed();
  console.log("Contract deployed to:", nftContract.address);
};

// エラー処理を行っています。
const runMain = async () => {
  try {
    await main();
    process.exit(0);
  } catch (error) {
    console.log(error);
    process.exit(1);
  }
};

runMain();

一行ずつコードを見ていきましょう。

// run.js
const nftContractFactory = await hre.ethers.getContractFactory("Web3Mint");

実際にコントラクトがコンパイルされ、コントラクトを扱うために必要なファイルがartifactsディレクトリの直下に生成されます。

✍️: hre.ethers.getContractFactoryについて getContractFactory関数は、デプロイをサポートするライブラリのアドレスとWeb3Mintコントラクトの連携を行っています。

hre.ethersは、Hardhat プラグインの仕様です。 ✍️: const main = async ()とawaitについて Javascript でコードを書いていると、コードの上から順に実行されなくて困ることがあります。これを非同期処理に関する問題といいます。

解決法の一つとして、ここではasync / awaitを使用します。

これを使うと、awaitが先頭についている処理が終わるまで、main関数の他の処理は行われません。

つまり、hre.ethers.getContractFactory('Web3Mint')の処理が終わるまで、main関数の中に記載されている他の処理は実行されないということです。

// run.js
const nftContract = await nftContractFactory.deploy();

HardhatがローカルのEthereumネットワークを、コントラクトのためだけに作成します。そして、スクリプトの実行が完了した後、そのローカル・ネットワークを破棄します。つまり、コントラクトを実行するたびに、毎回ローカルサーバーを更新するかのようにブロックチェーンが新しくなります。

常にゼロリセットとなるので、エラーのデバッグがしやすくなります。

// run.js
await nftContract.deployed();

コントラクトがMintされ、ローカルのブロックチェーンにデプロイされるまで待ちます。 Hardhatは実際にあなたのマシン上に「マイナー」を作成し、ブロックチェーンを構築してくれます。

最後に、デプロイされると、nftContract.addressはデプロイされたコントラクトのアドレスを出力します。

// run.js
console.log("Contract deployed to:", nftContract.address);

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

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

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

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

💨 実行してみよう!

ターミナルを開いて下記を実行してください。

yarn contract run:script

コントラクト内からconsole.logが実行され、さらにコントラクトのアドレスがプリントアウトされるのが確認できるはずです!

以下、出力結果のサンプルです。

Compiling 1 file with 0.8.17
Solidity compilation finished successfully
This is my NFT contract.
Contract deployed to: 0x5FbDB2315678afecb367f032d93F642f64180aa3

上記のような結果がターミナルに出力されていれば、テストは成功です。

🌱 Mint とは

NFTにおける「Mint（ミント）」とは、スマートコントラクトを用いて、NFT を新らしく作成・発行することを意味します。mintの意味としては、〔貨幣を〕鋳造するというような意味合いがあるそうです。mint a gold coinというような使い方をします。

🎩 Hardhat Runtime Environment について

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

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

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

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

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

🙋‍♂️ 質問する

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

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

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

テストが終わったら、次のレッスンに進んで、NFTをMintするためにスマートコントラクトを更新していきましょう 🎉

📝 スマートコントラクトを作成する​

🔩 constructor とは​

😲 スマートコントラクトを実行する​

💨 実行してみよう!​

🌱 Mint とは​

🎩 Hardhat Runtime Environment について​

🙋‍♂️ 質問する​