Add Entrypoint enum

Author: chipshort

Cargo.lock

@@ -35,7 +35,7 @@ allow_interface_version_7 = []
 bench = false
 
 [dependencies]
-bytes = "1.4.0" # need a higher version than the one required by Wasmer for the Bytes -> Vec<u8> implementation
+bytes = "1.4.0"     # need a higher version than the one required by Wasmer for the Bytes -> Vec<u8> implementation
 clru = "0.6.1"
 crc32fast = "1.3.2"
 # Uses the path when built locally; uses the given version from crates.io when published
@@ -50,12 +50,13 @@ sha2 = "0.10.3"
 thiserror = "1.0.26"
 wasmer = { version = "=4.2.2", default-features = false, features = ["cranelift", "singlepass"] }
 wasmer-middlewares = "=4.2.2"
+strum = { version = "0.25.0", default-features = false, features = ["derive"] }
 
 # Dependencies that we do not use ourself. We add those entries
 # to bump the min version of them.
 bytecheck = "0.6.3" # With this version the simdutf8 dependency became optional
-enumset = "1.0.2" # Fixes https://github.com/Lymia/enumset/issues/17 (https://github.com/Lymia/enumset/commit/a430550cd6a3c9b1ef636d37f75dede7616f5b62)
-bitflags = "1.1.0" # https://github.com/CensoredUsername/dynasm-rs/pull/74
+enumset = "1.0.2"   # Fixes https://github.com/Lymia/enumset/issues/17 (https://github.com/Lymia/enumset/commit/a430550cd6a3c9b1ef636d37f75dede7616f5b62)
+bitflags = "1.1.0"  # https://github.com/CensoredUsername/dynasm-rs/pull/74
 
 # Wasmer git/local (used for quick local debugging or patching)
 # wasmer = { git = "https://github.com/wasmerio/wasmer", rev = "877ce1f7c44fad853c", default-features = false, features = ["cranelift", "singlepass"] }
@@ -64,7 +65,7 @@ bitflags = "1.1.0" # https://github.com/CensoredUsername/dynasm-rs/pull/74
 # wasmer-middlewares = { path = "../../../wasmer/lib/middlewares" }
 
 [dev-dependencies]
-criterion = { version = "0.4", features = [ "html_reports" ] }
+criterion = { version = "0.4", features = ["html_reports"] }
 glob = "0.3.1"
 hex-literal = "0.3.1"
 tempfile = "3.1.0"

packages/vm/Cargo.toml

@@ -3,6 +3,7 @@ use std::fs::{self, File, OpenOptions};
 use std::io::{Read, Write};
 use std::marker::PhantomData;
 use std::path::{Path, PathBuf};
+use std::str::FromStr;
 use std::sync::Mutex;
 use wasmer::{Engine, Store};
 
@@ -16,7 +17,7 @@ use crate::instance::{Instance, InstanceOptions};
 use crate::modules::{CachedModule, FileSystemCache, InMemoryCache, PinnedMemoryCache};
 use crate::parsed_wasm::ParsedWasm;
 use crate::size::Size;
-use crate::static_analysis::{ExportInfo, REQUIRED_IBC_EXPORTS};
+use crate::static_analysis::{Entrypoint, ExportInfo, REQUIRED_IBC_EXPORTS};
 use crate::wasm_backend::{compile, make_compiling_engine, make_runtime_engine};
 
 const STATE_DIR: &str = "state";
@@ -120,12 +121,8 @@ pub struct AnalysisReport {
     /// `true` if and only if all [`REQUIRED_IBC_EXPORTS`] exist as exported functions.
     /// This does not guarantee they are functional or even have the correct signatures.
     pub has_ibc_entry_points: bool,
-    /// `true` if the module has an `instantiate` export.
-    /// This does not guarantee it is functional or even has the correct signature.
-    pub has_instantiate_entry_point: bool,
-    /// `true` if the module has a `migrate` export.
-    /// This does not guarantee it is functional or even has the correct signature.
-    pub has_migrate_entry_point: bool,
+    /// A set of all entrypoints that are exported by the contract.
+    pub entrypoints: HashSet<Entrypoint>,
     /// The set of capabilities the contract requires.
     pub required_capabilities: HashSet<String>,
 }
@@ -285,12 +282,16 @@ where
         let module = ParsedWasm::parse(&wasm)?;
         let exports = module.exported_function_names(None);
 
+        let entrypoints = exports
+            .iter()
+            .filter_map(|export| Entrypoint::from_str(export).ok())
+            .collect();
+
         Ok(AnalysisReport {
             has_ibc_entry_points: REQUIRED_IBC_EXPORTS
                 .iter()
                 .all(|required| exports.contains(*required)),
-            has_instantiate_entry_point: exports.contains("instantiate"),
-            has_migrate_entry_point: exports.contains("migrate"),
+            entrypoints,
             required_capabilities: required_capabilities_from_module(&module),
         })
     }
@@ -1296,6 +1297,7 @@ mod tests {
 
     #[test]
     fn analyze_works() {
+        use Entrypoint as E;
         let cache: Cache<MockApi, MockStorage, MockQuerier> =
             unsafe { Cache::new(make_stargate_testing_options()).unwrap() };
 
@@ -1305,8 +1307,13 @@ mod tests {
             report1,
             AnalysisReport {
                 has_ibc_entry_points: false,
-                has_instantiate_entry_point: true,
-                has_migrate_entry_point: true,
+                entrypoints: HashSet::from([
+                    E::Instantiate,
+                    E::Migrate,
+                    E::Sudo,
+                    E::Execute,
+                    E::Query
+                ]),
                 required_capabilities: HashSet::new(),
             }
         );
@@ -1317,8 +1324,7 @@ mod tests {
             report2,
             AnalysisReport {
                 has_ibc_entry_points: true,
-                has_instantiate_entry_point: true,
-                has_migrate_entry_point: true,
+                entrypoints: HashSet::from([E::Instantiate, E::Reply, E::Query]),
                 required_capabilities: HashSet::from_iter([
                     "iterator".to_string(),
                     "stargate".to_string()
@@ -1332,8 +1338,7 @@ mod tests {
             report3,
             AnalysisReport {
                 has_ibc_entry_points: false,
-                has_instantiate_entry_point: false,
-                has_migrate_entry_point: false,
+                entrypoints: HashSet::new(),
                 required_capabilities: HashSet::from(["iterator".to_string()]),
             }
         );

packages/vm/src/cache.rs

@@ -1,9 +1,40 @@
 use std::collections::HashSet;
 
+use strum::{Display, EnumString};
 use wasmer::wasmparser::ExternalKind;
 
 use crate::parsed_wasm::ParsedWasm;
 
+/// An enum containing all available contract entrypoints.
+/// This also provides conversions to and from strings.
+#[derive(PartialEq, Eq, Debug, Clone, Copy, Hash, EnumString, Display)]
+pub enum Entrypoint {
+    #[strum(serialize = "instantiate")]
+    Instantiate,
+    #[strum(serialize = "execute")]
+    Execute,
+    #[strum(serialize = "migrate")]
+    Migrate,
+    #[strum(serialize = "sudo")]
+    Sudo,
+    #[strum(serialize = "reply")]
+    Reply,
+    #[strum(serialize = "query")]
+    Query,
+    #[strum(serialize = "ibc_channel_open")]
+    IbcChannelOpen,
+    #[strum(serialize = "ibc_channel_connect")]
+    IbcChannelConnect,
+    #[strum(serialize = "ibc_channel_close")]
+    IbcChannelClose,
+    #[strum(serialize = "ibc_packet_receive")]
+    IbcPacketReceive,
+    #[strum(serialize = "ibc_packet_ack")]
+    IbcPacketAck,
+    #[strum(serialize = "ibc_packet_timeout")]
+    IbcPacketTimeout,
+}
+
 pub const REQUIRED_IBC_EXPORTS: &[&str] = &[
     "ibc_channel_open",
     "ibc_channel_connect",
@@ -62,6 +93,8 @@ impl ExportInfo for &wasmer::Module {
 
 #[cfg(test)]
 mod tests {
+    use std::str::FromStr;
+
     use crate::VmError;
 
     use super::*;
@@ -215,4 +248,22 @@ mod tests {
             HashSet::from_iter(vec!["bar".to_string(), "baz".to_string()])
         );
     }
+
+    #[test]
+    fn entrypoint_from_string_works() {
+        assert_eq!(
+            Entrypoint::from_str("ibc_channel_open").unwrap(),
+            Entrypoint::IbcChannelOpen
+        );
+
+        assert!(Entrypoint::from_str("IbcChannelConnect").is_err());
+    }
+
+    #[test]
+    fn entrypoint_display_works() {
+        assert_eq!(
+            Entrypoint::IbcPacketTimeout.to_string(),
+            "ibc_packet_timeout".to_string()
+        );
+    }
 }