Add ContractMigrateVersion to AnalysisReport

Author: chipshort

ibc_test.go

@@ -302,6 +302,7 @@ func TestAnalyzeCode(t *testing.T) {
 	require.NoError(t, err)
 	require.False(t, report.HasIBCEntryPoints)
 	require.Equal(t, "", report.RequiredCapabilities)
+	require.Nil(t, report.ContractMigrateVersion)
 
 	// Store IBC contract
 	wasm2, err := os.ReadFile(IBC_TEST_CONTRACT)
@@ -313,6 +314,7 @@ func TestAnalyzeCode(t *testing.T) {
 	require.NoError(t, err)
 	require.True(t, report2.HasIBCEntryPoints)
 	require.Equal(t, "iterator,stargate", report2.RequiredCapabilities)
+	require.Nil(t, report2.ContractMigrateVersion)
 }
 
 func TestIBCMsgGetChannel(t *testing.T) {

internal/api/bindings.h

@@ -194,6 +194,14 @@ typedef struct UnmanagedVector {
   uintptr_t cap;
 } UnmanagedVector;
 
+/**
+ * A version of `Option<u64>` that can be used safely in FFI.
+ */
+typedef struct OptionalU64 {
+  bool is_some;
+  uint64_t value;
+} OptionalU64;
+
 /**
  * The result type of the FFI function analyze_code.
  *
@@ -217,6 +225,13 @@ typedef struct AnalysisReport {
    * This is never None/nil.
    */
   struct UnmanagedVector required_capabilities;
+  /**
+   * The migrate version of the contract.
+   * This is None if the contract does not have a migrate version and the `migrate` entrypoint
+   * needs to be called for every migration (if present).
+   * If it is `Some(version)`, it only needs to be called if the `version` increased.
+   */
+  struct OptionalU64 contract_migrate_version;
 } AnalysisReport;
 
 typedef struct Metrics {

internal/api/lib.go

@@ -161,10 +161,15 @@ func AnalyzeCode(cache Cache, checksum []byte) (*types.AnalysisReport, error) {
 	}
 	requiredCapabilities := string(copyAndDestroyUnmanagedVector(report.required_capabilities))
 	entrypoints := string(copyAndDestroyUnmanagedVector(report.entrypoints))
+	var contract_migrate_version *uint64
+	if report.contract_migrate_version.is_some {
+		contract_migrate_version = (*uint64)(&report.contract_migrate_version.value)
+	}
 	res := types.AnalysisReport{
-		HasIBCEntryPoints:    bool(report.has_ibc_entry_points),
-		RequiredCapabilities: requiredCapabilities,
-		Entrypoints:          strings.Split(entrypoints, ","),
+		HasIBCEntryPoints:      bool(report.has_ibc_entry_points),
+		RequiredCapabilities:   requiredCapabilities,
+		Entrypoints:            strings.Split(entrypoints, ","),
+		ContractMigrateVersion: contract_migrate_version,
 	}
 	return &res, nil
 }

libwasmvm/bindings.h

@@ -194,6 +194,14 @@ typedef struct UnmanagedVector {
   uintptr_t cap;
 } UnmanagedVector;
 
+/**
+ * A version of `Option<u64>` that can be used safely in FFI.
+ */
+typedef struct OptionalU64 {
+  bool is_some;
+  uint64_t value;
+} OptionalU64;
+
 /**
  * The result type of the FFI function analyze_code.
  *
@@ -217,6 +225,13 @@ typedef struct AnalysisReport {
    * This is never None/nil.
    */
   struct UnmanagedVector required_capabilities;
+  /**
+   * The migrate version of the contract.
+   * This is None if the contract does not have a migrate version and the `migrate` entrypoint
+   * needs to be called for every migration (if present).
+   * If it is `Some(version)`, it only needs to be called if the `version` increased.
+   */
+  struct OptionalU64 contract_migrate_version;
 } AnalysisReport;
 
 typedef struct Metrics {

libwasmvm/src/cache.rs

@@ -253,6 +253,11 @@ pub struct AnalysisReport {
     /// An UTF-8 encoded comma separated list of required capabilities.
     /// This is never None/nil.
     pub required_capabilities: UnmanagedVector,
+    /// The migrate version of the contract.
+    /// This is None if the contract does not have a migrate version and the `migrate` entrypoint
+    /// needs to be called for every migration (if present).
+    /// If it is `Some(version)`, it only needs to be called if the `version` increased.
+    pub contract_migrate_version: OptionalU64,
 }
 
 impl From<cosmwasm_vm::AnalysisReport> for AnalysisReport {
@@ -261,6 +266,8 @@ impl From<cosmwasm_vm::AnalysisReport> for AnalysisReport {
             has_ibc_entry_points,
             required_capabilities,
             entrypoints,
+            contract_migrate_version,
+            ..
         } = report;
 
         let required_capabilities_utf8 = set_to_csv(required_capabilities).into_bytes();
@@ -269,6 +276,30 @@ impl From<cosmwasm_vm::AnalysisReport> for AnalysisReport {
             has_ibc_entry_points,
             required_capabilities: UnmanagedVector::new(Some(required_capabilities_utf8)),
             entrypoints: UnmanagedVector::new(Some(entrypoints)),
+            contract_migrate_version: contract_migrate_version.into(),
+        }
+    }
+}
+
+/// A version of `Option<u64>` that can be used safely in FFI.
+#[derive(Copy, Clone, Default, Debug, PartialEq, Eq)]
+#[repr(C)]
+pub struct OptionalU64 {
+    is_some: bool,
+    value: u64,
+}
+
+impl From<Option<u64>> for OptionalU64 {
+    fn from(opt: Option<u64>) -> Self {
+        match opt {
+            None => OptionalU64 {
+                is_some: false,
+                value: 0, // value is ignored
+            },
+            Some(value) => OptionalU64 {
+                is_some: true,
+                value,
+            },
         }
     }
 }

types/types.go

@@ -169,6 +169,11 @@ type AnalysisReport struct {
 	HasIBCEntryPoints    bool
 	RequiredCapabilities string
 	Entrypoints          []string
+	// ContractMigrateVersion is the migrate version of the contract
+	// This is nil if the contract does not have a migrate version and the `migrate` entrypoint
+	// needs to be called for every migration (if present).
+	// If it is some number, the entrypoint only needs to be called if it increased.
+	ContractMigrateVersion *uint64
 }
 
 type Metrics struct {