feat(em. controller): add bulk whitelist check (#117)

* feat(em. controller): add bulk whitelist check * add schema
astroport-fi · Nov 5, 2024 · 4c05ad5 · 4c05ad5
1 parent c4a954d
commit 4c05ad5
Show file tree

Hide file tree

Showing 10 changed files with 131 additions and 4 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/contracts/emissions_controller/Cargo.toml b/contracts/emissions_controller/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "astroport-emissions-controller"
-version = "1.1.1"
+version = "1.1.2"
 authors = ["Astroport"]
 edition = "2021"
 description = "Astroport vxASTRO Emissions Voting Contract"

diff --git a/contracts/emissions_controller/src/migration.rs b/contracts/emissions_controller/src/migration.rs
@@ -12,7 +12,7 @@ pub fn migrate(deps: DepsMut, _env: Env, _msg: Empty) -> Result<Response, Contra
 
     match contract_version.contract.as_ref() {
         CONTRACT_NAME => match contract_version.version.as_ref() {
-            "1.1.0" => Ok(()),
+            "1.1.0" | "1.1.1" => Ok(()),
             _ => Err(ContractError::MigrationError {}),
         },
         _ => Err(ContractError::MigrationError {}),

diff --git a/contracts/emissions_controller/src/query.rs b/contracts/emissions_controller/src/query.rs
@@ -122,6 +122,17 @@ pub fn query(deps: Deps<NeutronQuery>, env: Env, msg: QueryMsg) -> Result<Binary
 
             Ok(to_json_binary(pools_whitelist)?)
         }
+        QueryMsg::CheckWhitelist { lp_tokens } => {
+            let whitelist = POOLS_WHITELIST.load(deps.storage)?;
+            let is_whitelisted = lp_tokens
+                .into_iter()
+                .map(|lp_token| {
+                    let is_whitelisted = whitelist.contains(&lp_token);
+                    (lp_token, is_whitelisted)
+                })
+                .collect_vec();
+            Ok(to_json_binary(&is_whitelisted)?)
+        }
         QueryMsg::SimulateTune {} => {
             let deps = deps.into_empty();
 

diff --git a/contracts/emissions_controller/tests/common/helper.rs b/contracts/emissions_controller/tests/common/helper.rs
@@ -573,6 +573,13 @@ impl ControllerHelper {
         )
     }
 
+    pub fn check_whitelist(&self, lp_tokens: Vec<String>) -> StdResult<Vec<(String, bool)>> {
+        self.app.wrap().query_wasm_smart(
+            &self.emission_controller,
+            &emissions_controller::hub::QueryMsg::CheckWhitelist { lp_tokens },
+        )
+    }
+
     pub fn query_pools_vp(&self, limit: Option<u8>) -> StdResult<Vec<(String, Uint128)>> {
         self.query_voted_pools(limit).map(|res| {
             res.into_iter()

diff --git a/contracts/emissions_controller/tests/emissions_controller_integration.rs b/contracts/emissions_controller/tests/emissions_controller_integration.rs
@@ -225,6 +225,25 @@ fn test_whitelist() {
 
     let whitelist = helper.query_whitelist().unwrap();
     assert_eq!(whitelist, vec![lp_token.to_string()]);
+
+    let check_result = helper
+        .check_whitelist(vec![
+            lp_token.to_string(),
+            "random_lp".to_string(),
+            "factory/neutron1invalidaddr/astroport/share".to_string(),
+        ])
+        .unwrap();
+    assert_eq!(
+        check_result,
+        vec![
+            (lp_token.to_string(), true),
+            ("random_lp".to_string(), false),
+            (
+                "factory/neutron1invalidaddr/astroport/share".to_string(),
+                false
+            )
+        ]
+    );
 }
 
 #[test]

diff --git a/packages/astroport-governance/src/emissions_controller/hub.rs b/packages/astroport-governance/src/emissions_controller/hub.rs
@@ -132,6 +132,10 @@ pub enum QueryMsg {
         limit: Option<u8>,
         start_after: Option<String>,
     },
+    /// CheckWhitelist checks all the pools in the list and returns whether they are whitelisted.
+    /// Returns array of tuples (LP token, is_whitelisted).
+    #[returns(Vec<(String, bool)>)]
+    CheckWhitelist { lp_tokens: Vec<String> },
     /// SimulateTune simulates the ASTRO amount that will be emitted in the next epoch per pool
     /// considering if the next epoch starts right now.
     /// This query is useful for the UI to show the expected ASTRO emissions

diff --git a/schemas/astroport-emissions-controller/astroport-emissions-controller.json b/schemas/astroport-emissions-controller/astroport-emissions-controller.json
@@ -1,6 +1,6 @@
 {
   "contract_name": "astroport-emissions-controller",
-  "contract_version": "1.1.1",
+  "contract_version": "1.1.2",
   "idl_version": "1.0.0",
   "instantiate": {
     "$schema": "http://json-schema.org/draft-07/schema#",
@@ -882,6 +882,31 @@
         },
         "additionalProperties": false
       },
+      {
+        "description": "CheckWhitelist checks all the pools in the list and returns whether they are whitelisted. Returns array of tuples (LP token, is_whitelisted).",
+        "type": "object",
+        "required": [
+          "check_whitelist"
+        ],
+        "properties": {
+          "check_whitelist": {
+            "type": "object",
+            "required": [
+              "lp_tokens"
+            ],
+            "properties": {
+              "lp_tokens": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            },
+            "additionalProperties": false
+          }
+        },
+        "additionalProperties": false
+      },
       {
         "description": "SimulateTune simulates the ASTRO amount that will be emitted in the next epoch per pool considering if the next epoch starts right now. This query is useful for the UI to show the expected ASTRO emissions as well as might be useful for integrator estimations. It filters out pools which don't belong to any of outposts and invalid Hub-based LP tokens. Returns TuneResultResponse object which contains emissions state and next pools grouped by outpost prefix.",
         "type": "object",
@@ -901,6 +926,24 @@
   "migrate": null,
   "sudo": null,
   "responses": {
+    "check_whitelist": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "title": "Array_of_Tuple_of_String_and_Boolean",
+      "type": "array",
+      "items": {
+        "type": "array",
+        "items": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "boolean"
+          }
+        ],
+        "maxItems": 2,
+        "minItems": 2
+      }
+    },
     "config": {
       "$schema": "http://json-schema.org/draft-07/schema#",
       "title": "Config",

diff --git a/schemas/astroport-emissions-controller/raw/query.json b/schemas/astroport-emissions-controller/raw/query.json
@@ -175,6 +175,31 @@
       },
       "additionalProperties": false
     },
+    {
+      "description": "CheckWhitelist checks all the pools in the list and returns whether they are whitelisted. Returns array of tuples (LP token, is_whitelisted).",
+      "type": "object",
+      "required": [
+        "check_whitelist"
+      ],
+      "properties": {
+        "check_whitelist": {
+          "type": "object",
+          "required": [
+            "lp_tokens"
+          ],
+          "properties": {
+            "lp_tokens": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
     {
       "description": "SimulateTune simulates the ASTRO amount that will be emitted in the next epoch per pool considering if the next epoch starts right now. This query is useful for the UI to show the expected ASTRO emissions as well as might be useful for integrator estimations. It filters out pools which don't belong to any of outposts and invalid Hub-based LP tokens. Returns TuneResultResponse object which contains emissions state and next pools grouped by outpost prefix.",
       "type": "object",

diff --git a/schemas/astroport-emissions-controller/raw/response_to_check_whitelist.json b/schemas/astroport-emissions-controller/raw/response_to_check_whitelist.json
@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Array_of_Tuple_of_String_and_Boolean",
+  "type": "array",
+  "items": {
+    "type": "array",
+    "items": [
+      {
+        "type": "string"
+      },
+      {
+        "type": "boolean"
+      }
+    ],
+    "maxItems": 2,
+    "minItems": 2
+  }
+}