Merge pull request #1269 from rainlanguage/2025-02-11-field-checks-gui

Add missing field checks for js api
rainlanguage · Feb 12, 2025 · 8a875fc · 8a875fc
2 parents 90f2feb + d194d85
commit 8a875fc
Show file tree

Hide file tree

Showing 5 changed files with 105 additions and 0 deletions.
diff --git a/crates/js_api/src/gui/deposits.rs b/crates/js_api/src/gui/deposits.rs
@@ -97,4 +97,20 @@ impl DotrainOrderGui {
             .ok_or(GuiError::DepositTokenNotFound(key.clone()))?;
         Ok(gui_deposit.presets.clone().unwrap_or(vec![]))
     }
+
+    pub fn check_deposits(&self) -> Result<(), GuiError> {
+        let deployment = self.get_current_deployment()?;
+
+        for deposit in deployment.deposits.iter() {
+            if deposit.token.is_none() {
+                return Err(GuiError::TokenMustBeSelected("deposit".to_string()));
+            }
+
+            let token = deposit.token.as_ref().unwrap();
+            if !self.deposits.contains_key(&token.key) {
+                return Err(GuiError::DepositNotSet(token.key.clone()));
+            }
+        }
+        Ok(())
+    }
 }
diff --git a/crates/js_api/src/gui/field_values.rs b/crates/js_api/src/gui/field_values.rs
@@ -113,4 +113,15 @@ impl DotrainOrderGui {
         let deployment = self.get_current_deployment()?;
         Ok(deployment.fields.clone())
     }
+
+    pub fn check_field_values(&self) -> Result<(), GuiError> {
+        let deployment = self.get_current_deployment()?;
+
+        for field in deployment.fields.iter() {
+            if !self.field_values.contains_key(&field.binding) {
+                return Err(GuiError::FieldValueNotSet(field.binding.clone()));
+            }
+        }
+        Ok(())
+    }
 }
diff --git a/crates/js_api/src/gui/mod.rs b/crates/js_api/src/gui/mod.rs
@@ -183,8 +183,12 @@ pub enum GuiError {
     DeploymentNotFound(String),
     #[error("Field binding not found: {0}")]
     FieldBindingNotFound(String),
+    #[error("Field value not set: {0}")]
+    FieldValueNotSet(String),
     #[error("Deposit token not found in gui config: {0}")]
     DepositTokenNotFound(String),
+    #[error("Deposit not set: {0}")]
+    DepositNotSet(String),
     #[error("Orderbook not found")]
     OrderbookNotFound,
     #[error("Deserialized dotrain mismatch")]

diff --git a/crates/js_api/src/gui/order_operations.rs b/crates/js_api/src/gui/order_operations.rs
@@ -161,6 +161,7 @@ impl DotrainOrderGui {
     ) -> Result<ApprovalCalldataResult, GuiError> {
         let deployment = self.get_current_deployment()?;
         self.check_select_tokens()?;
+        self.check_deposits()?;
 
         let calldatas = self
             .dotrain_order
@@ -201,6 +202,7 @@ impl DotrainOrderGui {
     pub async fn generate_deposit_calldatas(&mut self) -> Result<DepositCalldataResult, GuiError> {
         let deployment = self.get_current_deployment()?;
         self.check_select_tokens()?;
+        self.check_deposits()?;
         self.populate_vault_ids(&deployment)?;
         let deployment = self.get_current_deployment()?;
 
@@ -236,6 +238,7 @@ impl DotrainOrderGui {
     ) -> Result<AddOrderCalldataResult, GuiError> {
         let deployment = self.get_current_deployment()?;
         self.check_select_tokens()?;
+        self.check_field_values()?;
         self.populate_vault_ids(&deployment)?;
         self.update_bindings(&deployment)?;
         let deployment = self.get_current_deployment()?;
@@ -253,6 +256,8 @@ impl DotrainOrderGui {
     ) -> Result<DepositAndAddOrderCalldataResult, GuiError> {
         let deployment = self.get_current_deployment()?;
         self.check_select_tokens()?;
+        self.check_deposits()?;
+        self.check_field_values()?;
         self.populate_vault_ids(&deployment)?;
         self.update_bindings(&deployment)?;
         let deployment = self.get_current_deployment()?;

diff --git a/packages/orderbook/test/js_api/gui.test.ts b/packages/orderbook/test/js_api/gui.test.ts
@@ -841,6 +841,7 @@ ${dotrainWithoutTokens}`;
 					'0x00000000000000000000000000000000000000000000003635C9ADC5DEA00000'
 				);
 
+			gui.saveDeposit('token1', '1000');
 			gui.saveDeposit('token2', '5000');
 
 			const approvalCalldatas: ApprovalCalldataResult = await gui.generateApprovalCalldatas(
@@ -879,6 +880,7 @@ ${dotrainWithoutTokens}`;
 					'0x000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000021234000000000000000000000000000000000000000000000000000000000000'
 				);
 
+			gui.saveDeposit('token1', '1000');
 			gui.saveDeposit('token2', '5000');
 
 			const depositCalldatas: DepositCalldataResult = await gui.generateDepositCalldatas();
@@ -955,6 +957,7 @@ ${dotrainWithoutTokens}`;
 					'0x000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000021234000000000000000000000000000000000000000000000000000000000000'
 				);
 
+			gui.saveDeposit('token1', '1000');
 			gui.saveDeposit('token2', '5000');
 
 			gui.saveFieldValue('test-binding', {
@@ -1017,6 +1020,7 @@ ${dotrainWithoutVaultIds}`;
 					'0x000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000021234000000000000000000000000000000000000000000000000000000000000'
 				);
 
+			gui.saveDeposit('token1', '1000');
 			gui.saveDeposit('token2', '5000');
 
 			gui.saveFieldValue('test-binding', {
@@ -1061,6 +1065,71 @@ ${dotrainWithoutVaultIds}`;
 			);
 		});
 
+		it('should throw error if field value not set', async () => {
+			await mockServer
+				.forPost('/rpc-url')
+				.once()
+				.withBodyIncluding('0x82ad56cb')
+				.thenSendJsonRpcResult(
+					'0x00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000003000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000e000000000000000000000000000000000000000000000000000000000000001a0000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000007546f6b656e203100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000060000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000025431000000000000000000000000000000000000000000000000000000000000'
+				);
+			await mockServer
+				.forPost('/rpc-url')
+				.once()
+				.withBodyIncluding('0x82ad56cb')
+				.thenSendJsonRpcResult(
+					'0x00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000003000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000e000000000000000000000000000000000000000000000000000000000000001a000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000120000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000754656b656e203200000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000060000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000025432000000000000000000000000000000000000000000000000000000000000'
+				);
+
+			let testDotrain = `${guiConfig2}
+
+${dotrainWithoutVaultIds}`;
+			let gui = await DotrainOrderGui.chooseDeployment(testDotrain, 'other-deployment');
+
+			gui.saveDeposit('token1', '1000');
+			gui.saveDeposit('token2', '5000');
+
+			await expect(async () => await gui.generateAddOrderCalldata()).rejects.toThrow(
+				'Field value not set: test-binding'
+			);
+			await expect(async () => await gui.generateDepositAndAddOrderCalldatas()).rejects.toThrow(
+				'Field value not set: test-binding'
+			);
+		});
+
+		it('should throw error if deposit value not set', async () => {
+			await mockServer
+				.forPost('/rpc-url')
+				.once()
+				.withBodyIncluding('0x82ad56cb')
+				.thenSendJsonRpcResult(
+					'0x00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000003000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000e000000000000000000000000000000000000000000000000000000000000001a0000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000007546f6b656e203100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000060000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000025431000000000000000000000000000000000000000000000000000000000000'
+				);
+			await mockServer
+				.forPost('/rpc-url')
+				.once()
+				.withBodyIncluding('0x82ad56cb')
+				.thenSendJsonRpcResult(
+					'0x00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000003000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000e000000000000000000000000000000000000000000000000000000000000001a000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000120000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000754656b656e203200000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000060000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000025432000000000000000000000000000000000000000000000000000000000000'
+				);
+
+			let testDotrain = `${guiConfig2}
+
+${dotrainWithoutVaultIds}`;
+			let gui = await DotrainOrderGui.chooseDeployment(testDotrain, 'other-deployment');
+
+			await expect(
+				async () =>
+					await gui.generateApprovalCalldatas('0x1234567890abcdef1234567890abcdef12345678')
+			).rejects.toThrow('Deposit not set: token1');
+			await expect(async () => await gui.generateDepositCalldatas()).rejects.toThrow(
+				'Deposit not set: token1'
+			);
+			await expect(async () => await gui.generateDepositAndAddOrderCalldatas()).rejects.toThrow(
+				'Deposit not set: token1'
+			);
+		});
+
 		it('should set vault ids', async () => {
 			mockServer
 				.forPost('/rpc-url')