lesson-3_NFTキャラクターに実用的な属性を与えよう

🤝 フロントエンドと連携するための関数を作成する

これから、Webアプリケーションにゲームを構築していくので、コントラクトとフロントエンドを連携させるための関数を実装していきます。

下記で実装していく関数は、フロントエンドから呼び出すことを前提としています。
したがって、今わからないことがあったとしても、フロントエンドのスクリプトを実装する段階では、それらはクリアになるはずです。
まずは、MyEpicGame.solを更新することをゴールに進んでいきましょう。

✅ ユーザーが NFT キャラクターを持っているか確認する

checkIfUserHasNFT関数を作成していきます。

この関数の機能は下記の2つです。

ユーザーがすでにNFTキャラクターを持っているかどうかを確認する。
ユーザーのウォレットにNFTキャラクターがすでに存在する場合は、その属性を取得情報（HPなど）を取得する。

下記の関数をMyEpicGame.solに追加してください。

attackBoss関数のコードブロック直下がお勧めです。

function checkIfUserHasNFT() public view returns (CharacterAttributes memory) {
	// ユーザーの tokenId を取得します。
	uint256 userNftTokenId = nftHolders[msg.sender];

	// ユーザーがすでにtokenIdを持っている場合、そのキャラクターの属性情報を返します。
	if (userNftTokenId > 0) {
		return nftHolderAttributes[userNftTokenId];
	}
	// それ以外の場合は、空文字を返します。
	else {
		CharacterAttributes memory emptyStruct;
		return emptyStruct;
	}
}

上記のコードを詳しく見ていきましょう。

function checkIfUserHasNFT() public view returns (CharacterAttributes memory) {
	// ユーザーの tokenId を取得します。
	uint256 userNftTokenId = nftHolders[msg.sender];
	:

checkIfUserHasNFT関数がフロントエンドから呼び出されると、uint256 userNftTokenId = nftHolders[msg.sender];を実行して、ユーザーがすでにNFTキャラクターを持っているかチェックします。

userNftTokenIdには、WebアプリケーションにログインしたユーザーのtokenIdが入ります。

次に、下記のコードを見ていきましょう。

// ユーザーがすでにtokenIdを持っている場合、そのキャラクターの属性情報を返します。
if (userNftTokenId > 0) {
	return nftHolderAttributes[userNftTokenId];
}
// それ以外の場合は、空文字を返します。
else {
	CharacterAttributes memory emptyStruct;
	return emptyStruct;
}

constructorで_tokenIds.increment()を行っているので、tokenIdの0番を保持している人は存在しません。

よって、userNftTokenId > 0の場合、ユーザーは何かしらのtokenIdを保持していることになります。

同時に、nftHolders[msg.sender]に新しいユーザーのアドレスが渡された場合は、デフォルト値である0がuserNftTokenIdに格納されます。

もし、ユーザーがNFTキャラクターをまだ持っていない場合は、emptyStructが返されるので、そこに新しくNFTキャラクターの情報を格納していくことになります。

🎃 キャラクターを選ぶ

Webアプリケーションに、「キャラクター選択画面」を作成し、プレイヤーにMintするNFTキャラクターを選んでもらいます。

そのための関数getAllDefaultCharactersをMyEpicGame.solの中に作成していきます。

checkIfUserHasNFT関数のコードブロック直下がお勧めです。

function getAllDefaultCharacters() public view returns (CharacterAttributes[] memory) {
  return defaultCharacters;
}

これにより、Webアプリケーションから、3体のNFTキャラクターのデフォルト情報が取得できます。

💀 フロントエンドからボスのデータを取得する

フロントエンドに、ボスの情報（HP、名前、画像など）を反映させる関数を作成します。

getAllDefaultCharacters関数のコードブロック直下がお勧めです。

function getBigBoss() public view returns (BigBoss memory) {
  return bigBoss;
}

🧠 コントラクトにイベントを追加する

これから、イベントをコントラクトに実装していきます。

イベントは Webhooks のようなものです。

Solidityのeventはバックエンドであるスマートコントラクトから、フロントエンドであるクライアントへメッセージを「発射(emit)」するために宣言されます。

event / emitを使用することで、ブロックチェーン上で更新された情報が、フロントエンドに自動で反映されます。
次のレッスンで、App.jsというフロントエンド用のスクリプトを作成し、Webアプリケーションがイベントを「キャッチ」するための実装を行います。

それでは、mapping(address => uint256) public nftHoldersの直下に下記2つのイベントを宣言しましょう。

// ユーザーが NFT を Mint したこと示すイベント
event CharacterNFTMinted(address sender, uint256 tokenId, uint256 characterIndex);
// ボスへの攻撃が完了したことを示すイベント
event AttackComplete(uint newBossHp, uint newPlayerHp);

event CharacterNFTMintedは、ユーザーが NFT キャラクターを Mint し終えたときに発生します。

これにより、NFTキャラクターのMintが完了したことをフロントエンドに通知できます。

event AttackCompleteは NFT キャラクターがボスを攻撃したときに発生します。

イベントによって、ボスの新しいHP(newBossHp)とプレイヤーの新しいHP(newPlayerHp)がそれぞれ返されます。
event AttackCompleteをフロントエンドでキャッチすることで、ページを再度読み込みすることなく、プレイヤーやボスのHPを動的に更新できます。

次に、mintCharacterNFT関数の一番下 (_tokenIds.increment();の直下) に、次の行を追加していきましょう。

// ユーザーが NFT を Mint したことをフロントエンドに伝えます。
emit CharacterNFTMinted(msg.sender, newItemId, _characterIndex);

それから、attackBoss関数の一番下に次の行を追加しましょう。

// ボスへの攻撃が完了したことをフロントエンドに伝えます。
emit AttackComplete(bigBoss.hp, player.hp);

emitはeventの発射機能です。

これにより、フロントエンドで、イベントを受け取ることができます。

フロントエンドでイベントを「キャッチ」する方法に関しては、次のレッスンで説明します 🚀

✍️: event / emitについて補足

event / emitを使用することで、ブロックチェーン上で更新された情報が、フロントエンドに表示されるようになります。

➡️ コントラクトを更新して、もう一度デプロイする

これで、Webアプリケーション内で使用する機能の準備ができました。

これから、コントラクトを再度テストネットにデプロイしていきます。

まず、下記のように、deploy.jsを更新しましょう。

フロントエンド用のスクリプトにattackBoss()関数は実装していくので、deploy.jsでは排除しています。

const main = async () => {
  const gameContractFactory = await hre.ethers.getContractFactory("MyEpicGame");

  const gameContract = await gameContractFactory.deploy(
    ["ZORO", "NAMI", "USOPP"], // キャラクターの名前
    [
      "https://i.imgur.com/TZEhCTX.png", // キャラクターの画像
      "https://i.imgur.com/WVAaMPA.png",
      "https://i.imgur.com/pCMZeiM.png",
    ],
    [100, 200, 300],
    [100, 50, 25],
    "CROCODILE", // Bossの名前
    "https://i.imgur.com/BehawOh.png", // Bossの画像
    10000, // Bossのhp
    50 // Bossの攻撃力
  );
  // ここでは、nftGame コントラクトが、
  // ローカルのブロックチェーンにデプロイされるまで待つ処理を行っています。
  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();

それでは、ターミナルに向かい、下記のコマンドを実行していきましょう。

yarn contract deploy

下記のような結果がターミナルに出力されたことを確認してください。

Compiling 1 file with 0.8.9
Solidity compilation finished successfully
Contract deployed to: 0xEC4D62E631c4FdC9c293772b3897C64A07874B06

⚠️: 注意

次のセクションで、コントラクトのアドレス（ 0x.. ）が必要なので、保存しておいてください。

上記のような結果が出れば、デプロイは成功です!

🙋‍♂️ 質問する

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

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

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

これでセクション2は終了です!　おめでとうございます!

ぜひ、ターミナルの出力結果を#ethereumに投稿してください 😊

コミュニティであなたの成功を祝いましょう 🎉

次のレッスンでは、Webアプリケーションを作り始めます!

🤝 フロントエンドと連携するための関数を作成する​

✅ ユーザーが NFT キャラクターを持っているか確認する​

🎃 キャラクターを選ぶ​

💀 フロントエンドからボスのデータを取得する​

🧠 コントラクトにイベントを追加する​

➡️ コントラクトを更新して、もう一度デプロイする​

🙋‍♂️ 質問する​