More integration tests (#103)

* Add configurable test actor

* WIP configurable actor tests

* Add operator_data to MintParams in the basic token actor

* Don't blindly flush state after minting

Doing this can unintentionally revert to the pre-hook state if the receiver hook carried out further operations on the balance received

* test: receiver hook burns incoming tokens after mint

* MintParams formatting

* wip make minting aware of changed state after receiver hook returns

* wip better state reloading mechanism

* more common stuff

* single-actor tests

* keep TestAction and ActionParams as part of test_actor

* duplicate MintParams in common to avoid linking in the token actor everywhere

can only link against one actor for shared structs, because of the invoke methods using un-mangled names (causing collisions at link time if more than one is included)

* wip multi-actor tests

* don't explode the test actor if transfer within receiver hook fails

original recipient just keeps the tokens in this case, instead of rejecting the transfer they originally received

* add test to mint tokens and then transfer inside the receiver hook

* update Transfer and TransferFrom to have the same post-hook state handling as Mint does

* return Transfer call result in test actor

the caller can check for success or failure of the transfer and also has the TransferReturn data available for use

* add transfer->hook transfer->accept/burn tests

* update transfer_tokens test to use the common helpers

* improve Token::replace and make public

* abort with an error instead of ignoring calls to Accept or Reject in an Action

* rename get_balance to token_balance to avoid confusion with native token balance

* separate individual frc46 tests into blocks

* add call_method_ok and mint_tokens_ok helpers to assert success and reduce test case size

* add token balance assertion helpers to further compress test case code

* add more balance asserts and check the more complex transfer results

* remove unnecessary comment

* return intermediate data through hook call and construct MintReturn afterwards

* return intermediate data through hook call and construct TransferFromReturn afterwards

* return intermediate data through hook call and construct TransferReturn afterwards

* move transfer and burn actions in the test actor into separate functions

* bump frc46_token version to 0.2.0

Author: abright

Cargo.toml

@@ -15,4 +15,5 @@ members = [
     "testing/fil_token_integration/actors/basic_receiving_actor",
     "testing/fil_token_integration/actors/basic_nft_actor",
     "testing/fil_token_integration/actors/basic_transfer_actor",
+    "testing/fil_token_integration/actors/test_actor"
 ]

Makefile

@@ -22,7 +22,8 @@ test-coverage: install-toolchain
 		--exclude basic_token_actor \
 		--exclude basic_receiving_actor \
 		--exclude basic_nft_actor \
-		--exclude basic_transfer_actor
+		--exclude basic_transfer_actor \
+		--exclude test_actor
 
 # separate actor testing stage to run from CI without coverage support
 test-actors: install-toolchain

frc46_token/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "frc46_token"
 description = "Filecoin FRC-0046 fungible token reference implementation"
-version = "0.1.0"
+version = "0.2.0"
 license = "MIT OR Apache-2.0"
 keywords = ["filecoin", "fvm", "token", "frc-0046"]
 repository = "https://github.com/helix-onchain/filecoin/"

frc46_token/src/token/mod.rs

@@ -129,7 +129,17 @@ pub struct MintReturn {
 }
 
 impl Cbor for MintReturn {}
-impl RecipientData for MintReturn {
+
+/// Intermediate data used by mint_return to construct the return data
+#[derive(Debug)]
+pub struct MintIntermediate {
+    /// Recipient address to use for querying balance
+    pub recipient: Address,
+    /// (Optional) data returned from receiver hook
+    pub recipient_data: RawBytes,
+}
+
+impl RecipientData for MintIntermediate {
     fn set_recipient_data(&mut self, data: RawBytes) {
         self.recipient_data = data;
     }
@@ -158,7 +168,17 @@ pub struct TransferReturn {
 
 impl Cbor for TransferParams {}
 impl Cbor for TransferReturn {}
-impl RecipientData for TransferReturn {
+
+/// Intermediate data used by transfer_return to construct the return data
+#[derive(Debug)]
+pub struct TransferIntermediate {
+    pub from: Address,
+    pub to: Address,
+    /// (Optional) data returned from receiver hook
+    pub recipient_data: RawBytes,
+}
+
+impl RecipientData for TransferIntermediate {
     fn set_recipient_data(&mut self, data: RawBytes) {
         self.recipient_data = data;
     }
@@ -190,7 +210,18 @@ pub struct TransferFromReturn {
 
 impl Cbor for TransferFromParams {}
 impl Cbor for TransferFromReturn {}
-impl RecipientData for TransferFromReturn {
+
+/// Intermediate data used by transfer_from_return to construct the return data
+#[derive(Debug)]
+pub struct TransferFromIntermediate {
+    pub operator: Address,
+    pub from: Address,
+    pub to: Address,
+    /// (Optional) data returned from receiver hook
+    pub recipient_data: RawBytes,
+}
+
+impl RecipientData for TransferFromIntermediate {
     fn set_recipient_data(&mut self, data: RawBytes) {
         self.recipient_data = data;
     }

frc46_token/src/token/types.rs

@@ -10,7 +10,7 @@ cid = { version = "0.8.5", default-features = false }
 fvm = { version = "2.0.0-alpha.2", default-features = false }
 frcxx_nft = { path = "../../frcxx_nft" }
 frc42_dispatch = { path = "../../frc42_dispatch" }
-frc46_token = { version = "0.1.0", path = "../../frc46_token" }
+frc46_token = { version = "0.2.0", path = "../../frc46_token" }
 fvm_integration_tests = "2.0.0-alpha.1"
 fvm_ipld_blockstore = "0.1.1"
 fvm_ipld_encoding = "0.2.2"
@@ -24,3 +24,4 @@ basic_nft_actor = {path = "actors/basic_nft_actor"}
 basic_receiving_actor = { path = "actors/basic_receiving_actor" }
 basic_token_actor = { path = "actors/basic_token_actor" }
 basic_transfer_actor = { path = "actors/basic_transfer_actor" }
+test_actor = { path = "actors/test_actor" }

testing/fil_token_integration/Cargo.toml

@@ -4,7 +4,7 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-frc46_token = { version = "0.1.0", path = "../../../../frc46_token" }
+frc46_token = { version = "0.2.0", path = "../../../../frc46_token" }
 frc42_dispatch = { path = "../../../../frc42_dispatch" }
 fvm_ipld_blockstore = "0.1.1"
 fvm_ipld_encoding = "0.2.2"

testing/fil_token_integration/actors/basic_receiving_actor/Cargo.toml

@@ -5,12 +5,13 @@ repository = "https://github.com/helix-collective/filecoin"
 edition = "2021"
 
 [dependencies]
+cid = { version = "0.8.5", default-features = false }
 fvm_actor_utils = { version = "0.1.0", path = "../../../../fvm_actor_utils" }
 fvm_ipld_blockstore = { version = "0.1.1" }
 fvm_ipld_encoding = { version = "0.2.2" }
 fvm_sdk = { version = "2.0.0-alpha.2" }
 fvm_shared = { version = "2.0.0-alpha.2" }
-frc46_token = { version = "0.1.0", path = "../../../../frc46_token" }
+frc46_token = { version = "0.2.0", path = "../../../../frc46_token" }
 num-traits = { version = "0.2.15" }
 serde = { version = "1.0.136", features = ["derive"] }
 serde_tuple = { version = "0.5.0" }

testing/fil_token_integration/actors/basic_token_actor/Cargo.toml

@@ -1,5 +1,6 @@
 mod util;
 
+use cid::Cid;
 use frc46_token::token::types::{
     AllowanceReturn, BalanceReturn, BurnFromReturn, BurnParams, BurnReturn,
     DecreaseAllowanceParams, FRC46Token, GetAllowanceParams, GranularityReturn,
@@ -63,7 +64,10 @@ impl FRC46Token<RuntimeError> for BasicToken<'_> {
         let cid = self.util.flush()?;
         sdk::sself::set_root(&cid).unwrap();
 
-        let ret = hook.call(self.util.msg())?;
+        let hook_ret = hook.call(self.util.msg())?;
+
+        self.reload(&cid)?;
+        let ret = self.util.transfer_return(hook_ret)?;
 
         Ok(ret)
     }
@@ -85,7 +89,10 @@ impl FRC46Token<RuntimeError> for BasicToken<'_> {
         let cid = self.util.flush()?;
         sdk::sself::set_root(&cid).unwrap();
 
-        let ret = hook.call(self.util.msg())?;
+        let hook_ret = hook.call(self.util.msg())?;
+
+        self.reload(&cid)?;
+        let ret = self.util.transfer_from_return(hook_ret)?;
 
         Ok(ret)
     }
@@ -141,24 +148,37 @@ impl FRC46Token<RuntimeError> for BasicToken<'_> {
 pub struct MintParams {
     pub initial_owner: Address,
     pub amount: TokenAmount,
+    pub operator_data: RawBytes,
 }
 
 impl Cbor for MintParams {}
 
 impl BasicToken<'_> {
+    fn reload(&mut self, initial_cid: &Cid) -> Result<(), RuntimeError> {
+        // todo: revise error type here so it plays nice with the result and doesn't need unwrap
+        let new_cid = sdk::sself::root().unwrap();
+        if new_cid != *initial_cid {
+            self.util.load_replace(&new_cid)?;
+        }
+        Ok(())
+    }
+
     fn mint(&mut self, params: MintParams) -> Result<MintReturn, RuntimeError> {
         let mut hook = self.util.mint(
             &caller_address(),
             &params.initial_owner,
             &params.amount,
-            Default::default(),
+            params.operator_data,
             Default::default(),
         )?;
 
         let cid = self.util.flush()?;
         sdk::sself::set_root(&cid).unwrap();
 
-        let ret = hook.call(self.util.msg())?;
+        let hook_ret = hook.call(self.util.msg())?;
+
+        self.reload(&cid)?;
+        let ret = self.util.mint_return(hook_ret)?;
 
         Ok(ret)
     }
@@ -269,28 +289,21 @@ pub fn invoke(params: u32) -> u32 {
                     // TransferFrom
                     let params = deserialize_params(params);
                     let res = token_actor.transfer_from(params).unwrap();
-                    let cid = token_actor.util.flush().unwrap();
-                    sdk::sself::set_root(&cid).unwrap();
                     return_ipld(&res).unwrap()
                 }
                 1303003700 => {
                     // Transfer
                     let params = deserialize_params(params);
                     let res = token_actor.transfer(params).unwrap();
-                    let cid = token_actor.util.flush().unwrap();
-                    sdk::sself::set_root(&cid).unwrap();
                     return_ipld(&res).unwrap()
                 }
 
                 // Custom actor interface, these are author-defined methods that extend beyond the
                 // FRC46 Token standard
                 3839021839 => {
                     // Mint
-                    let params = deserialize_params(params);
+                    let params: MintParams = deserialize_params(params);
                     let res = token_actor.mint(params).unwrap();
-
-                    let cid = token_actor.util.flush().unwrap();
-                    sdk::sself::set_root(&cid).unwrap();
                     return_ipld(&res).unwrap()
                 }
                 _ => {

testing/fil_token_integration/actors/basic_token_actor/src/lib.rs

@@ -5,7 +5,7 @@ edition = "2021"
 
 [dependencies]
 cid = { version = "0.8.5", default-features = false }
-frc46_token = { version = "0.1.0", path = "../../../../frc46_token" }
+frc46_token = { version = "0.2.0", path = "../../../../frc46_token" }
 frc42_dispatch = { path = "../../../../frc42_dispatch" }
 fvm_ipld_blockstore = { version = "0.1.1" }
 fvm_ipld_encoding = { version = "0.2.2" }