fix: rectify shrine assets in frontend data provider (#583)

Author: tserg

.gitignore

@@ -8,6 +8,7 @@ target/
 .snfoundry_cache/
 
 scripts/deployment/deploy_devnet_alpha-sepolia_state.json
+scripts/deployment/upgrade_fdp_devnet_alpha-sepolia_state.json
 
 scripts/simulation/open_trove_alpha-sepolia_state.json
 scripts/simulation/open_trove_max_forge_alpha-sepolia_state.json

README.md

@@ -22,18 +22,18 @@ Once you kill your Devnet instance, the state is lost unless the latest `devnet_
 
 | Module | Address |
 | ------ | --------|
-| Abbot       | `0x55753ea07d7c53b0d512dd14aa1fb536b02efc179907905610619eecaac1e97` |
-| Absorber    | `0x32e5f6bfc937e239e9f1c7c2c30f0d8ce59d7d703d82bc69382b4d2b0be1e4e` |
-| Allocator   | `0x470ad58d601501eab46479e69c0d9367e2b429aca88a1775114e3b074b2117b` |
-| Caretaker   | `0x1461305951ac7fb7af835a9a19b99ae5e135ba1fb64477d4b92a871fb85a2b1` |
-| Controller  | `0x5c4d4b9ce7f54dc50354b99dfca29c3ba3935501e5244e048fa87b83043ddc2` |
-| Equalizer   | `0x54b46ed341533fe4da0116f27e201276165e3a3fd030ac391b6e9967668996d` |
-| Flash Mint  | `0x6f1577c508f95e633d22eaa65c5781442651336d30a95ba149a80fd85db29bc` |
-| Frontend Data Provider | `0x6f7cf629552047a337324712571068b3f8f2deddcc0454533596ef5dfa192d` |
-| Gate[ETH]   | `0x23dbc80de342f86f2b33b27d5593c259809961d9ecbd9f69b7088babba1016f` |
-| Gate[STRK]  | `0x2918116ed1154cfe378eaefa5ee83914c9bed787815cdb5a82d25185737dad` |
-| Pragma      | `0xa163eb702f1cba67680cb67a2ad018dd6d349b76ebc9d85102a83857948304` |
-| Purger      | `0x1e188c4223245660e692e7f0b9834d11687cec5aa37da0889cbe2e2e2743c28` |
-| Seer        | `0x1ba77782ba5dea67bcf4f71c2b98849b598d030df02952bf8f62e3eb6b5b192` |
-| Sentinel    | `0x255e43013fd414520d27a0491c64aa03705e6f728999d0ceb44e395ac5c9c1d` |
-| Shrine      | `0x7d2a06078ee45540e9507a0daf01ac94f0550b675958dda88cbbc6fc8993708` |
+| Abbot       | `0x04280b97ecb8f1e0536e41888e387a04c3796e393f7086e5e24d61614927bc30` |
+| Absorber    | `0x05cf86333b32580be7a73c8150f2176047bab151df7506b6e30217594798fab5` |
+| Allocator   | `0x00dd24daea0f6cf5ee0a206e6a27c4d5b66a978f19e3a4877de23ab5a76f905d` |
+| Caretaker   | `0x004eb68cdc4009f0a7af80ecb34b91822649b139713e7e9eb9b11b10ee47aada` |
+| Controller  | `0x0005efaa9df09e86be5aa8ffa453adc11977628ddc0cb493625ca0f3caaa94b2` |
+| Equalizer   | `0x013be5f3de034ca1a0dec2b2da4cce2d0fe5505511cbea7a309979c45202d052` |
+| Flash Mint  | `0x0726e7d7bef2bcfc2814e0d5f0735b1a9326a98f2307a5edfda8db82d60d3f5f` |
+| Frontend Data Provider | `0x03d124e4166a09fb92787d480d44d6c25e6f638f706f8ae4074ee2766b634293` |
+| Gate[ETH]   | `0x02e1e0988565d99cd3a384e9f9cf2d348af50ee1ad549880aa37ba625e8c98d6` |
+| Gate[STRK]  | `0x05c6ec6e1748fbab3d65c2aa7897aeb7d7ec843331c1a469666e162da735fd5f` |
+| Pragma      | `0x02a67fac89d6921b05067b99e2491ce753778958ec89b0b0221b22c16a3073f7` |
+| Purger      | `0x0397fda455fd16d76995da81908931057594527b46cc99e12b8e579a9127e372` |
+| Seer        | `0x07bdece1aeb7f2c31a90a6cc73dfdba1cb9055197cca24b6117c9e0895a1832d` |
+| Sentinel    | `0x04c4d997f2a4b1fbf9db9c290ea1c97cb596e7765e058978b25683efd88e586d` |
+| Shrine      | `0x0398c179d65929f3652b6b82875eaf5826ea1c9a9dd49271e0d749328186713e` |

devnet_dump.json

@@ -41,5 +41,8 @@ build-external-contracts = [
 deploy_devnet = "rm deploy_devnet_alpha-sepolia_state.json 2> /dev/null; sncast --profile devnet script run deploy_devnet --package deployment"
 deploy_sepolia = "sncast --profile sepolia script run deploy_sepolia --package deployment"
 
+upgrade_fdp_devnet = "rm upgrade_fdp_devnet_alpha-sepolia_state.json 2> /dev/null; sncast --profile devnet script run upgrade_fdp_devnet --package deployment"
+upgrade_fdp_sepolia = "sncast --profile sepolia script run upgrade_fdp_sepolia --package deployment"
+
 [tool]
 fmt.workspace = true

scripts/deployment/Scarb.toml

@@ -3,4 +3,6 @@ mod deploy_devnet;
 mod deploy_sepolia;
 pub mod mock_deployment;
 pub mod periphery_deployment;
+mod upgrade_fdp_devnet;
+mod upgrade_fdp_sepolia;
 pub mod utils;

scripts/deployment/deploy_sepolia_alpha-sepolia_state.json

@@ -0,0 +1,23 @@
+use scripts::addresses;
+use scripts::constants::MAX_FEE;
+use sncast_std::{declare, DeclareResult, invoke, InvokeResult, DisplayContractAddress};
+use starknet::{ClassHash, ContractAddress};
+
+fn main() {
+    println!("Declaring new frontend data provider contract");
+
+    let declare_frontend_data_provider = declare("frontend_data_provider", Option::Some(MAX_FEE), Option::None)
+        .expect('failed FDP declare');
+
+    println!("Upgrading frontend data provider with new class hash");
+
+    let calldata: Array<felt252> = array![declare_frontend_data_provider.class_hash.into()];
+    invoke(
+        addresses::devnet::frontend_data_provider(),
+        selector!("upgrade"),
+        calldata,
+        Option::Some(MAX_FEE),
+        Option::None,
+    )
+        .expect('upgrade failed');
+}

scripts/deployment/src/lib.cairo

@@ -0,0 +1,23 @@
+use scripts::addresses;
+use scripts::constants::MAX_FEE;
+use sncast_std::{declare, DeclareResult, invoke, InvokeResult, DisplayContractAddress};
+use starknet::{ClassHash, ContractAddress};
+
+fn main() {
+    println!("Declaring new frontend data provider contract");
+
+    let declare_frontend_data_provider = declare("frontend_data_provider", Option::Some(MAX_FEE), Option::None)
+        .expect('failed FDP declare');
+
+    println!("Upgrading frontend data provider with new class hash");
+
+    let calldata: Array<felt252> = array![declare_frontend_data_provider.class_hash.into()];
+    invoke(
+        addresses::sepolia::frontend_data_provider(),
+        selector!("upgrade"),
+        calldata,
+        Option::Some(MAX_FEE),
+        Option::None,
+    )
+        .expect('upgrade failed');
+}

scripts/deployment/src/upgrade_fdp_devnet.cairo

@@ -125,4 +125,65 @@ pub mod sepolia {
             .try_into()
             .expect('invalid pragma twap address')
     }
+
+    // deployments
+    pub fn abbot() -> ContractAddress {
+        0x04280b97ecb8f1e0536e41888e387a04c3796e393f7086e5e24d61614927bc30.try_into().unwrap()
+    }
+
+    pub fn absorber() -> ContractAddress {
+        0x05cf86333b32580be7a73c8150f2176047bab151df7506b6e30217594798fab5.try_into().unwrap()
+    }
+
+    pub fn allocator() -> ContractAddress {
+        0x00dd24daea0f6cf5ee0a206e6a27c4d5b66a978f19e3a4877de23ab5a76f905d.try_into().unwrap()
+    }
+
+    pub fn caretaker() -> ContractAddress {
+        0x004eb68cdc4009f0a7af80ecb34b91822649b139713e7e9eb9b11b10ee47aada.try_into().unwrap()
+    }
+
+    pub fn controller() -> ContractAddress {
+        0x0005efaa9df09e86be5aa8ffa453adc11977628ddc0cb493625ca0f3caaa94b2.try_into().unwrap()
+    }
+
+    pub fn equalizer() -> ContractAddress {
+        0x013be5f3de034ca1a0dec2b2da4cce2d0fe5505511cbea7a309979c45202d052.try_into().unwrap()
+    }
+
+    pub fn eth_gate() -> ContractAddress {
+        0x02e1e0988565d99cd3a384e9f9cf2d348af50ee1ad549880aa37ba625e8c98d6.try_into().unwrap()
+    }
+
+    pub fn flash_mint() -> ContractAddress {
+        0x0726e7d7bef2bcfc2814e0d5f0735b1a9326a98f2307a5edfda8db82d60d3f5f.try_into().unwrap()
+    }
+
+    pub fn frontend_data_provider() -> ContractAddress {
+        0x03d124e4166a09fb92787d480d44d6c25e6f638f706f8ae4074ee2766b634293.try_into().unwrap()
+    }
+
+    pub fn pragma() -> ContractAddress {
+        0x02a67fac89d6921b05067b99e2491ce753778958ec89b0b0221b22c16a3073f7.try_into().unwrap()
+    }
+
+    pub fn purger() -> ContractAddress {
+        0x0397fda455fd16d76995da81908931057594527b46cc99e12b8e579a9127e372.try_into().unwrap()
+    }
+
+    pub fn seer() -> ContractAddress {
+        0x07bdece1aeb7f2c31a90a6cc73dfdba1cb9055197cca24b6117c9e0895a1832d.try_into().unwrap()
+    }
+
+    pub fn sentinel() -> ContractAddress {
+        0x04c4d997f2a4b1fbf9db9c290ea1c97cb596e7765e058978b25683efd88e586d.try_into().unwrap()
+    }
+
+    pub fn shrine() -> ContractAddress {
+        0x0398c179d65929f3652b6b82875eaf5826ea1c9a9dd49271e0d749328186713e.try_into().unwrap()
+    }
+
+    pub fn strk_gate() -> ContractAddress {
+        0x05c6ec6e1748fbab3d65c2aa7897aeb7d7ec843331c1a469666e162da735fd5f.try_into().unwrap()
+    }
 }

scripts/deployment/src/upgrade_fdp_sepolia.cairo

@@ -110,6 +110,7 @@ pub mod frontend_data_provider {
             let shrine: IShrineDispatcher = self.shrine.read();
             let sentinel: ISentinelDispatcher = self.sentinel.read();
 
+            let mut shrine_yang_balances: Span<YangBalance> = shrine.get_shrine_deposits();
             let mut trove_yang_balances: Span<YangBalance> = shrine.get_trove_deposits(trove_id);
             let mut yang_addresses: Span<ContractAddress> = sentinel.get_yang_addresses();
 
@@ -125,7 +126,11 @@ pub mod frontend_data_provider {
 
                         let (shrine_asset_info, yang_price) = self
                             .get_shrine_asset_info_helper(
-                                shrine, sentinel, yang, *yang_balance.amount, current_rate_era
+                                shrine,
+                                sentinel,
+                                yang,
+                                (*shrine_yang_balances.pop_front().unwrap()).amount,
+                                current_rate_era
                             );
 
                         let asset_amt: u128 = sentinel.convert_to_assets(yang, *yang_balance.amount);