lesson-2_Solidityでスマートコントラクトを作成しよう

section1のこれから先の作業は、AVAX-AMM/packages/contractディレクトリ内のファイルを操作していきます。🙌

👩‍💻 実装する内容の確認

AMM機能を実装したスマートコントラクトを作成していきます。

ユーザは私たちのスマートコントラクトを利用して、トークンの交換をすることができます。

具体的には、私たちのスマートコントラクトがUSDCというトークンとJOEというトークンを交換することができる場合、ユーザはスマートコントラクトへ接続し、USDCからJOEトークンへ（またはJOEトークンからUSDCトークンへ）交換することができます。

AMMを実装する上で重要なキーワードは以下の3つです。

🐦 プール

スマートコントラクトで交換可能なトークンの集まりのことを指します。

スマートコントラクトにUSDCとJOEのプールが存在する場合、ユーザはUSDCとJOE間で取引をすることができます。

🦒 流動性の提供

プール内にあるトークン量が少なく（= 取引する際の価格変動が大きくなる）、取引が成立しずらい市場の状態を流動性が低いという表現を使います。逆にトークン量が多く（= 価格変動が小さい）、取引がスムーズに成立しやすい状態を流動性が高いといいます。

多くのAMMでは、流動性の高い状態を作るために、トークン保有者にそのトークンをプールに預けてもらう（流動性の提供という）仕組みを用意しています。

例えば、USDCとJOEのプールがある場合はUSDCとJOEを所有している人に両トークンをプールへ預けてもらいます。（2つのトークンを提供しなければいけないかどうかはDEXによります）。

流動性の提供者には様々な報酬が用意されています。本プロジェクトでは、ユーザがトークンを交換する際に手数料を徴収し、その手数料を流動性の提供者へ与えるという形で報酬を実装します。

🦍 スワップ

トークンを交換することを指します。

本プロジェクトで実装する機能を整理します。

トークン保有者は流動性を提供することができる。
流動性を提供したユーザは預けたトークンを引き出すことができる。
ユーザはトークンをスワップすることができる。
スワップには手数料がかかる。
スワップで発生した手数料は、流動性提供者へ分配される。

🥮 コントラクトを作成する

今回作成するコントラクトは3つです。

本プロジェクトのスマートコントラクトとなるAMMコントラクトが1つと、AMMコントラクトの動きをシミュレーションするためのERC20Tokenコントラクトが2つです。

AMMコントラクトはFuji C-Chainにデプロイするため、すでにFuji C-Chainに存在するトークンを使用してAMMコントラクトを動かすことは可能ですが、 ERC20を実装したコントラクトを自前でデプロイし、トークン発行を自由に行えるとトークン取得のプロセスが柔軟で簡単になります。

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

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

contract
└── contracts
    ├── AMM.sol
    └── ERC20Tokens.sol

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

ERC20Tokens.solの中に以下のコードを貼り付けてください。

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.17;

import "@openzeppelin/contracts/token/ERC20/ERC20.sol";

contract USDCToken is ERC20 {
    constructor() ERC20("USDC Token", "USDC") {
        _mint(msg.sender, 10000 ether);
    }

    function faucet(address recipient, uint256 amount) external {
        _mint(recipient, amount);
    }
}

contract JOEToken is ERC20 {
    constructor() ERC20("JOE Token", "JOE") {
        _mint(msg.sender, 10000 ether);
    }

    function faucet(address recipient, uint256 amount) external {
        _mint(recipient, amount);
    }
}

0.8.17がhardhat.config.tsでも記載されていることを確認してください。

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

ここでは2つのERC20Tokenコントラクトを作成しています。

USDCTokenとJOETokenです。

USDCTokenを例に中身を見ます。

contract USDCToken is ERC20 {
    constructor() ERC20("USDC Token", "USDC") {
        _mint(msg.sender, 10000 ether);
    }

    function faucet(address recipient, uint256 amount) external {
        _mint(recipient, amount);
    }
}

コントラクトUSDCTokenはERC20を継承しているため、ERC20の関数を実装しています。

ERC20 はトークンの規格です。

USDCTokenのコンストラクタでERC20のコンストラクタを引数とともに呼んでおり、ここでトークンのシンボルなどを指定しています。

コンストラクタの中では、コントラクトをデプロイしたアカウントに10000 ether (= 10000 x 10^18)分USDCを発行しています。 ※ USDCとJOEは最小単位をetherと同じように扱うことにします。

_mintの実装は ERC20 の中にあります。内部では、コントラクトの保持する2つの値（トークン総量を表す値と、指定されたアカウントの所有トークン量を表す値）に指定されたトークンの量だけ加算しています。

USDCTokenはfaucetという関数も実装し、中で_mintを呼び出しています。

こちらは指定したアカウントに簡単にトークンを発行することができるように用意しました。

次にAMM.solのなかに以下のコードを貼り付けてください。

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.17;

import "@openzeppelin/contracts/token/ERC20/IERC20.sol";

contract AMM {
    IERC20 private _tokenX; // ERC20を実装したコントラクト
    IERC20 private _tokenY; // ERC20を実装したコントラクト
    uint256 public totalShare; // シェアの総量
    mapping(address => uint256) public share; // 各ユーザのシェア
    mapping(IERC20 => uint256) public totalAmount; // プールにロックされた各トークンの量

    uint256 public constant PRECISION = 1_000_000; // シェアの精度に使用する定数(= 6桁)

    // プールに使えるトークンを指定します。
    constructor(IERC20 tokenX, IERC20 tokenY) {
        _tokenX = tokenX;
        _tokenY = tokenY;
    }
}

ファイル上部では、openzeppelin/contractsからIERC20.solをインポートし、IERC20を使用できるようにしています。

その下に続くAMMコントラクトの実装ではIERC20を型としたオブジェクトを2つ保持しています。

contract AMM {
    IERC20 private _tokenX; // ERC20を実装したコントラクト
    IERC20 private _tokenY; // ERC20を実装したコントラクト
    ...
}

この2つのオブジェクトはそれぞれ、私たちが作るAMMが用意するプールのトークンペアのコントラクトです。本プロジェクトではUSDCTokenとJOETokenのアドレスをここに記録してAMMを動かします。

IERC20 とはERC20のインタフェースであり、ERC20の関数のみ定義された（= ERC20がどのように振る舞うのかのみわかる）フレームのようなものです。

AMMコントラクトはtokenXとtokenYに特定のコントラクトを指定する必要はなく、「ERC20の関数を実装しているコントラクト」を保持すれば良いので、インタフェースで型を用意しています。

コントラクトから別のコントラクトの関数を呼び出す場合はインタフェースを使うことで呼び出すことができます。

例えばIERC20 tokenXの関数を呼び出す際はこのように呼び出すことができます。

tokenX.transfer()

インターフェースの参考記事

📓 シェアについて

次にシェアに関する状態変数について見ていきます。

本プロジェクトで使うシェアという言葉は、流動性の提供者がプールにどのくらいのトークンを預けているのかを表す数値を指します。 DEXで用意されていることが多いLPトークンと同じ役目を果たします。

今回は簡単に実装するため、コントラクト内で数値として保持します。

📓 LP トークンとは Liquidity Provider( = 流動性提供者) トークンの略です。流動性を提供したことを証明する債券のようなものであり、預けたトークンを返却して欲しい時には、LP トークンを提示することにより、元の資産および利子を受け取ることができます。

シェアに関する状態変数は以下です。

uint256 public totalShare; // シェアの総量
mapping(address => uint256) public share; // 各ユーザのシェア

uint256 public constant PRECISION = 1_000_000; // シェアの精度に使用する定数(= 6桁)

totalShareは全てのユーザのシェアの合計値で、shareは各ユーザのシェアの値を表します。

例えば、あるユーザ(アドレスをaddrで表す)の提供しているトークン量の、全てのユーザの提供量に対する割合を考える場合は次の式で求めることができます。

この考え方は、流動性の提供者が預けているトークンを引き出す時に、そのトークン量を計算する際に使います。

PRECISIONはshareの小数点以下を表すもので6桁分用意しています。 shareが1.23あるとすると、コントラクト内では1_230_000として保持します。 ethereumトークンにおけるetherとweiの関係のようなものです。見やすくなるため1_000_000で記載していますが、1000000と同じ意味です。

また、totalAmountという状態変数も用意していますが、提供されたトークンの量をそれぞれのトークンに対し保持します。

最後に、私たちが作るAMMコントラクトは、デプロイ時にコンストラクタによってプールのトークンペアを決定する仕様とします。そのため引数に２つのコントラクトアドレスを受け取れるようにしています。

🧪 テストを実装する

コントラクトを実装したのでテストを書きます。

testディレクトリの下にAMM.tsを作成し、以下のコードを記述してください。

import { ethers } from "hardhat";
import { BigNumber } from "ethers";
import { expect } from "chai";
import { loadFixture } from "@nomicfoundation/hardhat-network-helpers";

describe("AMM", function () {
  async function deployContract() {
    const [owner, otherAccount] = await ethers.getSigners();

    const amountForOther = ethers.utils.parseEther("5000");
    const USDCToken = await ethers.getContractFactory("USDCToken");
    const usdc = await USDCToken.deploy();
    await usdc.faucet(otherAccount.address, amountForOther);

    const JOEToken = await ethers.getContractFactory("JOEToken");
    const joe = await JOEToken.deploy();
    await joe.faucet(otherAccount.address, amountForOther);

    const AMM = await ethers.getContractFactory("AMM");
    const amm = await AMM.deploy(usdc.address, joe.address);

    return {
      amm,
      token0: usdc,
      token1: joe,
      owner,
      otherAccount,
    };
  }

  describe("init", function () {
    it("init", async function () {
      const { amm } = await loadFixture(deployContract);

      expect(await amm.totalShare()).to.eql(BigNumber.from(0));
    });
  });
});

ここで行っていることはデプロイの流れを確認するくらいのシンプルなものです。

deployContract関数内では、3つのコントラクトを順番にデプロイしています。

トークンのコントラクトのデプロイ時には、ownerだけでなくotherAccountに対してもfaucetを呼び出すことでトークンを発行しています。

AMMコントラクトのデプロイ時には、USDCToken、JoeTokenをコンストラクタに渡しています。

以下の部分では、デプロイしたAMMコントラクトの状態変数の初期値を確かめています。 ※ コントラクトからの数値の返り値はBigNumberです。

expect(await amm.totalShare()).to.eql(BigNumber.from(0));

本格的なテストは次のレッスンから実装していきます。

💁 hardhatで行うテストに関して詳しくはこちらを参考にしてください。

⭐ テストを実行しましょう

ターミナル上で以下のコマンドを実行してください。

yarn test

以下のような表示がされます。実行したテスト名とそのテストがパスしたことがわかります。

🙋‍♂️ 質問する

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

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

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

コントラクトの作成とテストまでの流れを知ることができました 🎉 次のレッスンでは、スマートコントラクトに機能を追加していきます。

👩‍💻 実装する内容の確認​

🥮 コントラクトを作成する​

🧪 テストを実装する​

⭐ テストを実行しましょう​

🙋‍♂️ 質問する​

👩‍💻 実装する内容の確認

🥮 コントラクトを作成する

🧪 テストを実装する

⭐ テストを実行しましょう

🙋‍♂️ 質問する