lesson-3_コントラクトを完成させよう

⚔️ `cross contract call`の`event pattern`を実装しよう

まだ実装していない残りの機能は以下です！

バイクを使用するためにユーザがコントラクトへ ft を支払う 処理の流れを整理します。

ユーザがバイクを使用するためにbikeコントラクトへftを送信する。
bikeコントラクトはftの受信を確認する
bikeコントラクトはftの送信者によるバイクの使用手続きを進める

これを実現するには以下の処理を同期的に行う必要があります。

ユーザがftコントラクトのft転送メソッドを呼ぶ。
ftコントラクトがbikeコントラクトへftの転送をするメソッドを実行。
ft転送のメソッドをトリガーに, bikeコントラクトは受信したftの確認、バイクの使用手続きをするメソッドを実行。

あるコントラクトのメソッドの実行が、他のコントラクトのメソッドの実行に繋がるような機能を cross contract callのevent patternで実装することができます。 2つのコントラクトにそのように動作するメソッドをあらかじめ用意しておくのです。例えばftコントラクトにはft_transfer_callというメソッドが存在します。このメソッドはftの転送を行いますが、同時にftの転送をする相手のアカウントに ft_on_transferというメソッドを実装したコントラクトがあることを期待します。そしてftの転送と共にft_on_transferの実行をcross contract callで行います。つまり先ほどの処理フローはこのように書き換えることができます。

ユーザがftコントラクトのft_transfer_callメソッドを呼ぶ。
ftコントラクトがbikeコントラクトへft_transfer_callメソッドを実行。
bikeコントラクトはft_on_transferにてftの確認、バイクの使用手続きを進めます。

ft_transfer_callについて詳しくはこちらをご覧ください。それではbikeコントラクトにft_on_transferを実装しましょう！ src/lib.rs内をこのように書き換えてください！

use near_sdk::{
    borsh::{self, BorshDeserialize, BorshSerialize},
    env, ext_contract,
    json_types::{self, U128},
    log, near_bindgen, AccountId, Gas, PanicOnDefault, Promise, PromiseOrValue, PromiseResult,
};

const FT_CONTRACT_ACCOUNT: &str = "sub.ft_account.testnet"; // <- あなたのftコントラクトをデプロイしたアカウントに変更してください！
const AMOUNT_REWARD_FOR_INSPECTIONS: u128 = 15;
const AMOUNT_TO_USE_BIKE: u128 = 30; // <- 追加！

/// 外部コントラクト(ftコントラクト)に実装されているメソッドをトレイトで定義
// ...

/// バイクの状態遷移を表します。
// ...

/// コントラクトを定義します
// ...

/// メソッドの実装です。
#[near_bindgen]
impl Contract {
    // ...

    /* use_bikeを削除して、以降のコードを挿入してください！
    pub fn use_bike(&mut self, index: usize) {
        // env::predecessor_account_id(): このメソッドを呼び出しているアカウント名を取得
        let user_id = env::predecessor_account_id();
        log!("{} uses bike", &user_id);

        match &self.bikes[index] {
            Bike::Available => self.bikes[index] = Bike::InUse(user_id),
            _ => panic!("Bike is not available"),
        }
    }
    */

    /// AMOUNT_TO_USE_BIKEを返却します。
    // コントラクト内の変数にアクセスしていませんが、viewメソッドにするためには&selfを明記します.
    pub fn amount_to_use_bike(&self) -> U128 {
        json_types::U128::from(AMOUNT_TO_USE_BIKE)
    }

    /// 他のコントラクトのft_transfer_call()によるftの転送がトリガーとなって呼び出されるメソッドです.
    /// ft_transfer_call()は転送先のコントラクトにft_on_transfer()があることを期待しています.
    pub fn ft_on_transfer(
        &mut self,
        sender_id: String,
        amount: String,
        msg: String,
    ) -> PromiseOrValue<U128> {
        assert_eq!(
            amount,
            AMOUNT_TO_USE_BIKE.to_string(),
            "Require {} ft to use the bike",
            AMOUNT_TO_USE_BIKE
        );

        log!(
            "in ft_on_transfer: sender:{}, amount:{}, msg:{}",
            sender_id,
            amount,
            msg
        );

        // 使用するバイク: msgによってindexを指定してもらうことを期待
        // sender_id.try_into().unwrap(): String型からAccountId型へ変換しています。
        self.use_bike(msg.parse().unwrap(), sender_id.try_into().unwrap());
        // 受信したFTは全て受け取るので、返却する残金は0.
        PromiseOrValue::Value(U128::from(0))
    }

    /// バイク 使用可 -> 使用中
    fn use_bike(&mut self, index: usize, user_id: AccountId) {
        log!("{} uses bike", &user_id);
        match &self.bikes[index] {
            Bike::Available => self.bikes[index] = Bike::InUse(user_id),
            _ => panic!("Bike is not available"),
        }
    }

    // ...
}

主な変更点は以下です。

AMOUNT_TO_USE_BIKEという定数を用意。フロント側からその値を取得できるようにamount_to_use_bikeメソッドを実装。
ft_on_transferを実装し、use_bikeはそのヘルパー関数として編集。

ft_on_transferのプロトタイプ宣言をドキュメントやソースコードを参考に実装しています。 ft_on_transferの引数について整理しましょう。

sender_id: ft_transfer_callを呼び出した（つまりユーザの）アカウントID
amount : ftの量
msg : 何かを伝えるためのメッセージ、オプション

msgはft_transfer_callによって実行したい関数が複数存在する場合にどれを実行するのかを指定するなど用途は自由です。今回は実行する関数がuse_bikeと決まっているので, msgをuse_bikeに渡すバイクのindex番号の指定に使用することにします。

🙋‍♂️ 質問する

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

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

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

おめでとうございます！

コントラクトの機能を全て実装することができました！

次のレッスンではさらに機能を増やしていきます！

⚔️ cross contract callのevent patternを実装しよう​

🙋‍♂️ 質問する​

⚔️ `cross contract call`の`event pattern`を実装しよう

🙋‍♂️ 質問する