Use new ExitCode type and values, change ActorError to make bad exit codes less likely (#191)

Co-authored-by: dignifiedquire <[email protected]>
Co-authored-by: Steven Allen <[email protected]>

Author: 3 people

Cargo.lock

@@ -39,6 +39,15 @@ members = [
      "test_vm",
 ]
 
+#[patch.crates-io]
+#fvm_shared = { git = "https://github.com/filecoin-project/ref-fvm" }
+#fvm_sdk = { git = "https://github.com/filecoin-project/ref-fvm" }
+#fvm_ipld_hamt = { git = "https://github.com/filecoin-project/ref-fvm" }
+#fvm_ipld_amt = { git = "https://github.com/filecoin-project/ref-fvm" }
+#fvm_ipld_bitfield = { git = "https://github.com/filecoin-project/ref-fvm" }
+#fvm_ipld_encoding = { git = "https://github.com/filecoin-project/ref-fvm" }
+#fvm_ipld_blockstore = { git = "https://github.com/filecoin-project/ref-fvm" }
+
 ## Uncomment when working locally on ref-fvm and this repo simultaneously.
 ## Assumes the ref-fvm checkout is in a sibling directory with the same name.
 ## (Valid while FVM modules aren't published to crates.io)
@@ -54,14 +63,14 @@ members = [
 ## Uncomment entries below when working locally on ref-fvm and this repo simultaneously.
 ## Assumes the ref-fvm checkout is in a sibling directory with the same name.
 ## (Valid once FVM modules are published to crates.io)
-#[patch.crates-io]
-#fvm_shared = { path = "../ref-fvm/shared" }
-#fvm_sdk = { path = "../ref-fvm/sdk" }
-#fvm_ipld_hamt = { path = "../ref-fvm/ipld/hamt" }
-#fvm_ipld_amt = { path = "../ref-fvm/ipld/amt" }
-#fvm_ipld_bitfield = { path = "../ref-fvm/ipld/bitfield"}
-#fvm_ipld_encoding = { path = "../ref-fvm/ipld/encoding"}
-#fvm_ipld_blockstore = { path = "../ref-fvm/ipld/blockstore"}
+# [patch.crates-io]
+# fvm_shared = { path = "../ref-fvm/shared" }
+# fvm_sdk = { path = "../ref-fvm/sdk" }
+# fvm_ipld_hamt = { path = "../ref-fvm/ipld/hamt" }
+# fvm_ipld_amt = { path = "../ref-fvm/ipld/amt" }
+# fvm_ipld_bitfield = { path = "../ref-fvm/ipld/bitfield"}
+# fvm_ipld_encoding = { path = "../ref-fvm/ipld/encoding"}
+# fvm_ipld_blockstore = { path = "../ref-fvm/ipld/blockstore"}
 
 [profile.wasm]
 inherits = "release"

Cargo.toml

@@ -14,7 +14,7 @@ crate-type = ["cdylib", "lib"]
 
 [dependencies]
 fil_actors_runtime = { version = "8.0.0-alpha.1", path = "../runtime", features = ["fil-actor"] }
-fvm_shared = { version = "0.4.0", default-features = false }
+fvm_shared = { version = "0.5.1", default-features = false }
 serde = { version = "1.0.136", features = ["derive"] }
 num-traits = "0.2.14"
 num-derive = "0.3.3"

actors/account/Cargo.toml

@@ -43,7 +43,7 @@ impl Actor {
         match address.protocol() {
             Protocol::Secp256k1 | Protocol::BLS => {}
             protocol => {
-                return Err(actor_error!(ErrIllegalArgument;
+                return Err(actor_error!(illegal_argument;
                     "address must use BLS or SECP protocol, got {}", protocol));
             }
         }
@@ -82,7 +82,7 @@ impl ActorCode for Actor {
                 let addr = Self::pubkey_address(rt)?;
                 Ok(RawBytes::serialize(addr)?)
             }
-            None => Err(actor_error!(SysErrInvalidMethod; "Invalid method")),
+            None => Err(actor_error!(unhandled_message; "Invalid method")),
         }
     }
 }

actors/account/src/lib.rs

@@ -51,18 +51,18 @@ macro_rules! account_tests {
 account_tests! {
     happy_construct_secp256k1_address: (
         Address::new_secp256k1(&[2; fvm_shared::address::SECP_PUB_LEN]).unwrap(),
-        ExitCode::Ok
+        ExitCode::OK
     ),
     happy_construct_bls_address: (
         Address::new_bls(&[1; fvm_shared::address::BLS_PUB_LEN]).unwrap(),
-        ExitCode::Ok
+        ExitCode::OK
     ),
     fail_construct_id_address: (
         Address::new_id(1),
-        ExitCode::ErrIllegalArgument
+        ExitCode::USR_ILLEGAL_ARGUMENT
     ),
     fail_construct_actor_address: (
         Address::new_actor(&[1, 2, 3]),
-        ExitCode::ErrIllegalArgument
+        ExitCode::USR_ILLEGAL_ARGUMENT
     ),
 }

actors/account/tests/account_actor_test.rs

@@ -15,7 +15,7 @@ crate-type = ["cdylib", "lib"]
 
 [dependencies]
 fil_actors_runtime = { version = "8.0.0-alpha.1", path = "../runtime", features = ["fil-actor"] }
-fvm_shared = { version = "0.4.0", default-features = false }
+fvm_shared = { version = "0.5.1", default-features = false }
 num-traits = "0.2.14"
 num-derive = "0.3.3"
 log = "0.4.14"

actors/cron/Cargo.toml

@@ -100,7 +100,7 @@ impl ActorCode for Actor {
                 Self::epoch_tick(rt)?;
                 Ok(RawBytes::default())
             }
-            None => Err(actor_error!(SysErrInvalidMethod; "Invalid method")),
+            None => Err(actor_error!(unhandled_message; "Invalid method")),
         }
     }
 }

actors/cron/src/lib.rs

@@ -73,31 +73,31 @@ fn epoch_tick_with_entries() {
         RawBytes::default(),
         0u8.into(),
         RawBytes::default(),
-        ExitCode::Ok,
+        ExitCode::OK,
     );
     rt.expect_send(
         entry2.receiver,
         entry2.method_num,
         RawBytes::default(),
         0u8.into(),
         RawBytes::default(),
-        ExitCode::ErrIllegalArgument,
+        ExitCode::USR_ILLEGAL_ARGUMENT,
     );
     rt.expect_send(
         entry3.receiver,
         entry3.method_num,
         RawBytes::default(),
         0u8.into(),
         RawBytes::default(),
-        ExitCode::Ok,
+        ExitCode::OK,
     );
     rt.expect_send(
         entry4.receiver,
         entry4.method_num,
         RawBytes::default(),
         0u8.into(),
         RawBytes::default(),
-        ExitCode::Ok,
+        ExitCode::OK,
     );
 
     epoch_tick_and_verify(&mut rt);

actors/cron/tests/cron_actor_test.rs

@@ -15,7 +15,7 @@ crate-type = ["cdylib", "lib"]
 
 [dependencies]
 fil_actors_runtime = { version = "8.0.0-alpha.1", path = "../runtime", features = ["fil-actor"] }
-fvm_shared = { version = "0.4.0", default-features = false }
+fvm_shared = { version = "0.5.1", default-features = false }
 fvm_ipld_hamt = "0.4.0"
 serde = { version = "1.0.136", features = ["derive"] }
 num-traits = "0.2.14"

actors/init/Cargo.toml

@@ -44,7 +44,7 @@ impl Actor {
         let sys_ref: &Address = &SYSTEM_ACTOR_ADDR;
         rt.validate_immediate_caller_is(std::iter::once(sys_ref))?;
         let state = State::new(rt.store(), params.network_name).map_err(|e| {
-            e.downcast_default(ExitCode::ErrIllegalState, "failed to construct init actor state")
+            e.downcast_default(ExitCode::USR_ILLEGAL_STATE, "failed to construct init actor state")
         })?;
 
         rt.create(&state)?;
@@ -63,13 +63,13 @@ impl Actor {
         log::trace!("called exec; params.code_cid: {:?}", &params.code_cid);
 
         let caller_code = rt.get_actor_code_cid(&rt.message().caller()).ok_or_else(|| {
-            actor_error!(ErrIllegalState, "no code for caller as {}", rt.message().caller())
+            actor_error!(illegal_state, "no code for caller as {}", rt.message().caller())
         })?;
 
         log::trace!("caller code CID: {:?}", &caller_code);
 
         if !can_exec(rt, &caller_code, &params.code_cid) {
-            return Err(actor_error!(ErrForbidden;
+            return Err(actor_error!(forbidden;
                     "called type {} cannot exec actor type {}",
                     &caller_code, &params.code_cid
             ));
@@ -87,7 +87,7 @@ impl Actor {
         // Store mapping of pubkey or actor address to actor ID
         let id_address: ActorID = rt.transaction(|s: &mut State, rt| {
             s.map_address_to_new_id(rt.store(), &robust_address).map_err(|e| {
-                e.downcast_default(ExitCode::ErrIllegalState, "failed to allocate ID address")
+                e.downcast_default(ExitCode::USR_ILLEGAL_STATE, "failed to allocate ID address")
             })
         })?;
 
@@ -126,7 +126,7 @@ impl ActorCode for Actor {
                 let res = Self::exec(rt, cbor::deserialize_params(params)?)?;
                 Ok(RawBytes::serialize(res)?)
             }
-            None => Err(actor_error!(SysErrInvalidMethod; "Invalid method")),
+            None => Err(actor_error!(unhandled_message; "Invalid method")),
         }
     }
 }