feat(vault): client release version

crates/vault-registry/src/lib.rs

@@ -29,8 +29,8 @@ use mocktopus::macros::mockable;
 use primitives::VaultCurrencyPair;
 
 use crate::types::{
-    BalanceOf, BtcAddress, CurrencyId, DefaultSystemVault, RichSystemVault, RichVault, SignedInner, UnsignedFixedPoint,
-    UpdatableVault, Version,
+    BalanceOf, BtcAddress, ClientRelease, CurrencyId, DefaultSystemVault, RichSystemVault, RichVault, SignedInner,
+    UnsignedFixedPoint, UpdatableVault, Version,
 };
 
 use crate::types::DefaultVaultCurrencyPair;
@@ -417,6 +417,21 @@ pub mod pallet {
             Self::_set_liquidation_collateral_threshold(currency_pair, threshold);
             Ok(())
         }
+
+        /// Changes the collateral liquidation threshold for a currency (only executable by the Root account)
+        ///
+        /// # Arguments
+        /// * `version` - the semver version, where the zero-index element is the major version
+        /// * `checksum` - the SHA256 checksum of the client binary
+        #[pallet::weight(<T as Config>::WeightInfo::set_liquidation_collateral_threshold())]
+        #[transactional]
+        pub fn set_client_release(origin: OriginFor<T>, version: [u32; 3], checksum: [u8; 32]) -> DispatchResult {
+            ensure_root(origin)?;
+            // TODO: Should the new semver version have a check that ensures it is striclty ascending?
+            LatestClientRelease::<T>::put(ClientRelease { version, checksum });
+            Self::deposit_event(Event::<T>::ClientRelease { version, checksum });
+            Ok(())
+        }
     }
 
     #[pallet::event]
@@ -528,6 +543,10 @@ pub mod pallet {
             vault_id: DefaultVaultId<T>,
             banned_until: T::BlockNumber,
         },
+        ClientRelease {
+            version: [u32; 3],
+            checksum: [u8; 32],
+        },
     }
 
     #[pallet::error]
@@ -651,6 +670,12 @@ pub mod pallet {
     pub(super) type TotalUserVaultCollateral<T: Config> =
         StorageMap<_, Blake2_128Concat, DefaultVaultCurrencyPair<T>, BalanceOf<T>, ValueQuery>;
 
+    /// Tuple of (semver_version, sha256_checksum) indicating the latest vault client release.
+    /// `semver_version`: The element at index zero is the major semver version.
+    #[pallet::storage]
+    #[pallet::getter(fn latest_client_release)]
+    pub(super) type LatestClientRelease<T: Config> = StorageValue<_, ClientRelease, ValueQuery>;
+
     #[pallet::type_value]
     pub(super) fn DefaultForStorageVersion() -> Version {
         Version::V0

crates/vault-registry/src/types.rs

@@ -33,6 +33,14 @@ pub enum Version {
     V4,
 }
 
+#[derive(Encode, Decode, Default, TypeInfo, Eq, PartialEq, Debug)]
+pub struct ClientRelease {
+    /// The semver version, where the zero-index element is the major version
+    pub version: [u32; 3],
+    /// SHA256 checksum of the client binary
+    pub checksum: [u8; 32],
+}
+
 #[derive(Debug, PartialEq)]
 pub enum CurrencySource<T: frame_system::Config + orml_tokens::Config> {
     /// Used by vault to back issued tokens

standalone/runtime/tests/test_vault_registry.rs

@@ -159,6 +159,8 @@ mod deposit_collateral_test {
     }
 }
 mod withdraw_collateral_test {
+    use vault_registry::types::ClientRelease;
+
     use super::{assert_eq, *};
 
     fn required_collateral(vault_id: VaultId) -> Amount<Runtime> {
@@ -227,6 +229,22 @@ mod withdraw_collateral_test {
             );
         });
     }
+
+    #[test]
+    fn integration_test_vault_registry_set_client_release_works() {
+        test_with(|_vault_id| {
+            let new_release = ClientRelease {
+                version: [1, 0, 2],
+                checksum: [1u8; 32],
+            };
+            assert_ok!(Call::VaultRegistry(VaultRegistryCall::set_client_release {
+                version: new_release.version,
+                checksum: new_release.checksum
+            })
+            .dispatch(root()));
+            assert_eq!(VaultRegistryPallet::latest_client_release(), new_release);
+        });
+    }
 }
 
 #[test]