Relate payment status properties to drivers

golemfactory · Sep 28, 2023 · d803ecb · d803ecb
1 parent 2db22ce
commit d803ecb
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 23 deletions.
diff --git a/model/src/payment/params.rs b/model/src/payment/params.rs
@@ -34,12 +34,6 @@ pub struct PaymentId {
     pub payment_id: String,
 }
 
-#[derive(Deserialize, Serialize)]
-pub struct PaymentStatusQuery {
-    #[serde(default)]
-    network: Option<String>,
-}
-
 #[derive(Deserialize, Serialize)]
 pub struct Timeout {
     #[serde(default)]

diff --git a/model/src/payment/payment.rs b/model/src/payment/payment.rs
@@ -24,27 +24,33 @@ pub struct Payment {
 #[serde(tag = "kind")]
 pub enum PaymentStatusProperty {
     InsufficientGas {
+        driver: String,
         network: String,
         #[serde(rename = "neededGasEst")]
         needed_gas_est: String,
     },
     InsufficientToken {
+        driver: String,
         network: String,
         #[serde(rename = "neededTokenEst")]
         needed_token_est: String,
     },
     InvalidChainId {
+        driver: String,
         #[serde(rename = "chainId")]
         chain_id: i64,
     },
     CantSign {
+        driver: String,
         network: String,
         address: String,
     },
     TxStuck {
+        driver: String,
         network: String,
     },
     RpcError {
+        driver: String,
         network: String,
     },
 }
@@ -58,11 +64,13 @@ mod tests {
     fn status_prop_serialization() {
         assert_eq!(
             json!({
+                "driver": "erc20",
                 "kind": "InsufficientGas",
                 "network": "foo",
                 "neededGasEst": "bar",
             }),
             to_value(&PaymentStatusProperty::InsufficientGas {
+                driver: "erc20".into(),
                 network: "foo".into(),
                 needed_gas_est: "bar".into()
             })
@@ -74,12 +82,14 @@ mod tests {
     fn status_prop_deserialization() {
         assert_eq!(
             PaymentStatusProperty::TxStuck {
+                driver: "erc20".into(),
                 network: "baz".into(),
             },
             from_str(
                 r#"{
-                "kind": "TxStuck",
-                "network": "baz"
+                    "driver": "erc20",
+                    "kind": "TxStuck",
+                    "network": "baz"
             }"#
             )
             .unwrap()

diff --git a/specs/payment-api.yaml b/specs/payment-api.yaml
@@ -695,7 +695,8 @@ paths:
         problems like missing funds or misconfigured max fee per gas on a per-chain
         (network) basis.
       parameters:
-        - $ref: '#components/parameters/paymentStatusQuery'
+        - $ref: 'common.yaml#/parameters/network'
+        - $ref: 'common.yaml#/parameters/driver'
       responses:
         200:
           $ref: '#/components/responses/PaymentStatus'
@@ -776,13 +777,6 @@ components:
       schema:
         type: string
 
-    paymentStatusQuery:
-      name: paymentStatusQuery
-      required: true
-      in: path
-      schema:
-        $ref: '#/components/schemas/PaymentStatusQuery'
-
     allocationIds:
       name: allocationIds
       required: true
@@ -1280,13 +1274,6 @@ components:
         - activityPayments
         - details
 
-    PaymentStatusQuery:
-      description: Filter for driver status properties
-      type: object
-      properties:
-        network:
-          type: string
-
     PaymentStatusProperty:
       type: object
       description: Individual actionable property of the payment driver status
@@ -1314,6 +1301,9 @@ components:
           - CantSign
           - TxStuck
           - RpcError
+        driver:
+          description: Payment driver to which this status property is applicable
+          type: string
         network:
           description: >
             Indicates which chain the problem occurs on. No statuses other than
@@ -1348,6 +1338,7 @@ components:
           type: integer
       required:
         - kind
+        - driver
 
     AgreementPayment:
       description: >

diff --git a/src/payment/api.rs b/src/payment/api.rs
@@ -456,11 +456,14 @@ impl PaymentApi {
 
     pub async fn payment_status(
         &self,
+        driver: Option<String>,
         network: Option<String>,
     ) -> Result<Vec<PaymentStatusProperty>> {
         let url = url_format!(
             "payments/status/",
             #[query]
+            driver,
+            #[query]
             network
         );