Merge pull request #27 from octopus-network/v2.4.0

Upgrade to v2.4.0

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "appchain-anchor-wrapper"
-version = "2.3.1"
+version = "2.4.0"
 authors = ["Octopus Network"]
 edition = "2021"
 
@@ -24,7 +24,7 @@ mock-appchain-registry = { path = "./mock-appchain-registry" }
 mock-oct-token = { path = "./mock-oct-token" }
 wrapped-appchain-token = { git = "https://github.com/octopus-network/wrapped-appchain-token.git", branch = "v2.0.0" }
 wrapped-appchain-nft = { git = "https://github.com/octopus-network/wrapped-appchain-nft.git", branch = "main" }
-octopus-council = { git = "https://github.com/octopus-network/octopus-dao", branch = "main" }
+council-keeper = { git = "https://github.com/octopus-network/octopus-dao", branch = "main" }
 tokio = { version = "1.14", features = ["full"] }
 workspaces = "0.4"
 

appchain-anchor/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "appchain-anchor"
-version = "2.3.1"
+version = "2.4.0"
 authors = ["Octopus Network"]
 edition = "2021"
 

appchain-anchor/src/interfaces.rs

@@ -159,8 +159,8 @@ pub trait AnchorViewer {
 }
 
 pub trait AppchainLifecycleManager {
-    /// Verify and change the state of corresponding appchain to `booting`.
-    fn go_booting(&mut self);
+    /// Generate the initial validator set for the appchain.
+    fn generate_initial_validator_set(&mut self);
     /// Verify and change the state of corresponding appchain to `active`.
     fn go_live(&mut self);
     /// Initialize the beefy light client
@@ -276,6 +276,8 @@ pub trait ProtocolSettingsManager {
     fn change_validator_commission_percent(&mut self, value: u16);
     ///
     fn change_maximum_allowed_unprofitable_era_count(&mut self, value: u16);
+    ///
+    fn change_subaccount_for_council_keeper_contract(&mut self, subaccount_name: String);
 }
 
 pub trait AppchainSettingsManager {

appchain-anchor/src/lib.rs

@@ -53,7 +53,7 @@ use validator_set::ValidatorSetViewer;
 register_custom_getrandom!(get_random_in_near);
 
 /// Version of this contract (the same as in Cargo.toml)
-const ANCHOR_VERSION: &str = "v2.3.1";
+const ANCHOR_VERSION: &str = "v2.4.0";
 /// Constants for gas.
 const T_GAS_FOR_FT_TRANSFER: u64 = 10;
 const T_GAS_FOR_BURN_FUNGIBLE_TOKEN: u64 = 10;
@@ -265,7 +265,7 @@ impl AppchainAnchor {
                 StorageKey::ProtocolSettings.into_bytes(),
                 Some(&ProtocolSettings::default()),
             ),
-            appchain_state: AppchainState::Staging,
+            appchain_state: AppchainState::Booting,
             staking_histories: LazyOption::new(
                 StorageKey::StakingHistories.into_bytes(),
                 Some(&LookupArray::new(StorageKey::StakingHistoriesMap)),
@@ -502,7 +502,7 @@ impl AppchainAnchor {
         let predecessor_account_id = env::predecessor_account_id();
         match deposit_message {
             FTDepositMessage::RegisterValidator { .. }
-            | FTDepositMessage::IncreaseStake
+            | FTDepositMessage::IncreaseStake { .. }
             | FTDepositMessage::RegisterDelegator { .. }
             | FTDepositMessage::IncreaseDelegation { .. } => {
                 assert!(

appchain-anchor/src/permissionless_actions/switching_era.rs

@@ -240,7 +240,15 @@ impl AppchainAnchor {
                 let args = near_sdk::serde_json::to_vec(&args)
                     .expect("Failed to serialize the cross contract args using JSON.");
                 let contract_account = AccountId::from_str(
-                    format!("octopus-council.{}", self.appchain_registry).as_str(),
+                    format!(
+                        "{}.{}",
+                        self.protocol_settings
+                            .get()
+                            .unwrap()
+                            .subaccount_for_council_keeper_contract,
+                        self.appchain_registry
+                    )
+                    .as_str(),
                 )
                 .unwrap();
                 Promise::new(contract_account).function_call(

appchain-anchor/src/storage_migration.rs

@@ -3,6 +3,86 @@ use near_sdk::borsh::{self, BorshDeserialize, BorshSerialize};
 use near_sdk::collections::{LazyOption, LookupMap};
 use near_sdk::{env, near_bindgen, AccountId, Balance};
 
+#[derive(Clone, Serialize, Deserialize, BorshDeserialize, BorshSerialize, Debug, PartialEq)]
+#[serde(crate = "near_sdk::serde")]
+pub enum OldAppchainState {
+    /// The initial state of an appchain, after it is successfully registered.
+    /// This state is managed by appchain registry.
+    Registered,
+    /// The state while the appchain is under auditing by Octopus Network.
+    /// This state is managed by appchain registry.
+    Auditing,
+    /// The state while voter can upvote or downvote an appchain.
+    /// This state is managed by appchain registry.
+    InQueue,
+    /// The state while validator and delegator can deposit OCT tokens to this contract
+    /// to indicate their willing of staking for an appchain.
+    Staging,
+    /// The state while an appchain is booting.
+    Booting,
+    /// The state while an appchain is active normally.
+    Active,
+    /// The state while an appchain is under challenging, which all deposit and withdraw actions
+    /// are frozen.
+    Frozen,
+    /// The state which an appchain is broken for some technical or governance reasons.
+    Broken,
+    /// The state which the lifecycle of an appchain is end.
+    Dead,
+}
+
+#[derive(BorshDeserialize, BorshSerialize, Serialize, Deserialize, Clone)]
+#[serde(crate = "near_sdk::serde")]
+pub struct OldProtocolSettings {
+    /// A validator has to deposit a certain amount of OCT token to this contract for
+    /// being validator of the appchain.
+    pub minimum_validator_deposit: U128,
+    /// The minimum amount for a validator to increase or decrease his/her deposit.
+    pub minimum_validator_deposit_changing_amount: U128,
+    /// The maximum percent value that the deposit of a validator in total stake
+    pub maximum_validator_stake_percent: u16,
+    /// The minimum deposit amount for a delegator to delegate his voting weight to
+    /// a certain validator.
+    pub minimum_delegator_deposit: U128,
+    /// The minimum amount for a delegator to increase or decrease his/her delegation
+    /// to a validator.
+    pub minimum_delegator_deposit_changing_amount: U128,
+    /// The minimum price (in USD) of total stake in this contract for
+    /// booting corresponding appchain
+    pub minimum_total_stake_price_for_booting: U128,
+    /// The maximum percentage of the total market value of all NEP-141 tokens to the total
+    /// market value of OCT token staked in this contract
+    pub maximum_market_value_percent_of_near_fungible_tokens: u16,
+    /// The maximum percentage of the total market value of wrapped appchain token to the total
+    /// market value of OCT token staked in this contract
+    pub maximum_market_value_percent_of_wrapped_appchain_token: u16,
+    /// The minimum number of validator(s) registered in this contract for
+    /// booting the corresponding appchain and keep it alive.
+    pub minimum_validator_count: U64,
+    /// The maximum number of validator(s) registered in this contract for
+    /// the corresponding appchain.
+    pub maximum_validator_count: U64,
+    /// The maximum number of validator(s) which a delegator can delegate to.
+    pub maximum_validators_per_delegator: U64,
+    /// The unlock period (in days) for validator(s) can withdraw their deposit after
+    /// they are removed from the corresponding appchain.
+    pub unlock_period_of_validator_deposit: U64,
+    /// The unlock period (in days) for delegator(s) can withdraw their deposit after
+    /// they no longer delegates their stake to a certain validator on the corresponding appchain.
+    pub unlock_period_of_delegator_deposit: U64,
+    /// The maximum number of historical eras that the validators or delegators are allowed to
+    /// withdraw their reward
+    pub maximum_era_count_of_unwithdrawn_reward: U64,
+    /// The maximum number of valid appchain message.
+    /// If the era number of appchain message is smaller than the latest era number minus
+    /// this value, the message will be considered as `invalid`.
+    pub maximum_era_count_of_valid_appchain_message: U64,
+    /// The percent of commission fees of a validator's reward in an era
+    pub validator_commission_percent: u16,
+    /// The maximum unprofitable era count for auto-unbonding a validator
+    pub maximum_allowed_unprofitable_era_count: u16,
+}
+
 #[derive(BorshDeserialize, BorshSerialize)]
 pub struct OldAppchainAnchor {
     /// The id of corresponding appchain.
@@ -41,9 +121,9 @@ pub struct OldAppchainAnchor {
     /// The anchor settings for appchain.
     anchor_settings: LazyOption<AnchorSettings>,
     /// The protocol settings for appchain anchor.
-    protocol_settings: LazyOption<ProtocolSettings>,
+    protocol_settings: LazyOption<OldProtocolSettings>,
     /// The state of the corresponding appchain.
-    appchain_state: AppchainState,
+    appchain_state: OldAppchainState,
     /// The staking history data happened in this contract.
     staking_histories: LazyOption<LookupArray<StakingHistory>>,
     /// The appchain notification history data.
@@ -66,6 +146,8 @@ pub struct OldAppchainAnchor {
     appchain_challenges: LazyOption<LookupArray<AppchainChallenge>>,
     /// The wrapped appchain NFT data
     wrapped_appchain_nfts: LazyOption<WrappedAppchainNFTs>,
+    /// The native NEAR token data
+    native_near_token: LazyOption<NativeNearToken>,
 }
 
 #[near_bindgen]
@@ -95,8 +177,13 @@ impl AppchainAnchor {
             validator_profiles: old_contract.validator_profiles,
             appchain_settings: old_contract.appchain_settings,
             anchor_settings: old_contract.anchor_settings,
-            protocol_settings: old_contract.protocol_settings,
-            appchain_state: old_contract.appchain_state,
+            protocol_settings: LazyOption::new(
+                StorageKey::ProtocolSettings.into_bytes(),
+                Some(&ProtocolSettings::from_old_version(
+                    old_contract.protocol_settings.get().unwrap(),
+                )),
+            ),
+            appchain_state: AppchainState::from_old_version(old_contract.appchain_state),
             staking_histories: old_contract.staking_histories,
             appchain_notification_histories: old_contract.appchain_notification_histories,
             permissionless_actions_status: old_contract.permissionless_actions_status,
@@ -108,13 +195,59 @@ impl AppchainAnchor {
             appchain_messages: old_contract.appchain_messages,
             appchain_challenges: old_contract.appchain_challenges,
             wrapped_appchain_nfts: old_contract.wrapped_appchain_nfts,
-            native_near_token: LazyOption::new(
-                StorageKey::NativeNearToken.into_bytes(),
-                Some(&NativeNearToken::default()),
-            ),
+            native_near_token: old_contract.native_near_token,
         };
         //
         //
         new_contract
     }
 }
+
+impl AppchainState {
+    pub fn from_old_version(old_version: OldAppchainState) -> Self {
+        match old_version {
+            OldAppchainState::Registered => AppchainState::Registered,
+            OldAppchainState::Auditing => AppchainState::Audited,
+            OldAppchainState::InQueue => AppchainState::Voting,
+            OldAppchainState::Staging => AppchainState::Booting,
+            OldAppchainState::Booting => AppchainState::Booting,
+            OldAppchainState::Active => AppchainState::Active,
+            OldAppchainState::Frozen => AppchainState::Closing,
+            OldAppchainState::Broken => AppchainState::Closing,
+            OldAppchainState::Dead => AppchainState::Closed,
+        }
+    }
+}
+
+impl ProtocolSettings {
+    pub fn from_old_version(old_version: OldProtocolSettings) -> Self {
+        ProtocolSettings {
+            minimum_validator_deposit: old_version.minimum_validator_deposit,
+            minimum_validator_deposit_changing_amount: old_version
+                .minimum_validator_deposit_changing_amount,
+            maximum_validator_stake_percent: old_version.maximum_validator_stake_percent,
+            minimum_delegator_deposit: old_version.minimum_delegator_deposit,
+            minimum_delegator_deposit_changing_amount: old_version
+                .minimum_delegator_deposit_changing_amount,
+            minimum_total_stake_price_for_booting: old_version
+                .minimum_total_stake_price_for_booting,
+            maximum_market_value_percent_of_near_fungible_tokens: old_version
+                .maximum_market_value_percent_of_near_fungible_tokens,
+            maximum_market_value_percent_of_wrapped_appchain_token: old_version
+                .maximum_market_value_percent_of_wrapped_appchain_token,
+            minimum_validator_count: old_version.minimum_validator_count,
+            maximum_validator_count: old_version.maximum_validator_count,
+            maximum_validators_per_delegator: old_version.maximum_validators_per_delegator,
+            unlock_period_of_validator_deposit: old_version.unlock_period_of_validator_deposit,
+            unlock_period_of_delegator_deposit: old_version.unlock_period_of_delegator_deposit,
+            maximum_era_count_of_unwithdrawn_reward: old_version
+                .maximum_era_count_of_unwithdrawn_reward,
+            maximum_era_count_of_valid_appchain_message: old_version
+                .maximum_era_count_of_valid_appchain_message,
+            validator_commission_percent: old_version.validator_commission_percent,
+            maximum_allowed_unprofitable_era_count: old_version
+                .maximum_allowed_unprofitable_era_count,
+            subaccount_for_council_keeper_contract: "octopus-council".to_string(),
+        }
+    }
+}