document entire HTTP request/response

Chia-Network · Dec 17, 2024 · 49a702e · 49a702e
1 parent b070708
commit 49a702e
Showing 1 changed file with 56 additions and 38 deletions.
diff --git a/CHIPs/chip-0039.md b/CHIPs/chip-0039.md
@@ -115,50 +115,68 @@ Fee services should:
 6. Service returns complete spend bundle to client
 7. Client can verify and submit the transaction
 
-### Example Spend Bundle Modification
+### HTTP Request/Response Examples
+
+#### Request
+
+```http
+POST /api/fees HTTP/1.1
+Content-Type: application/json
 
-```
-# Original spend bundle:
 {
-    "coin_spends": [
-        {
-            "coin": {
-                "parent_coin_info": "0x...",
-                "puzzle_hash": "0x...",
-                "amount": 1000
-            },
-            "puzzle_reveal": "0x...",
-            "solution": "0x..."
-        }
-    ],
-    "aggregated_signature": "0x..."
+    "network": "mainnet",
+    "spendBundle": {
+        "aggregated_signature": "0x..."
+        "coin_spends": [
+            {
+                "coin": {
+                    "parent_coin_info": "0x...",
+                    "puzzle_hash": "0x...",
+                    "amount": 1000
+                },
+                "puzzle_reveal": "0x...",
+                "solution": "0x..."
+            }
+        ],
+    },
+    "submit": false
 }
+```
+
+#### Success Response
+
+```http
+HTTP/1.1 201 OK
+Content-Type: application/json
 
-# After fee service:
 {
-    "coin_spends": [
-        # Original spend
-        {
-            "coin": {
-                "parent_coin_info": "0x...",
-                "puzzle_hash": "0x...",
-                "amount": 1000
-            },
-            "puzzle_reveal": "0x...",
-            "solution": "0x..."
-        },
-        # Added fee spend
-        {
-            "coin": {
-                "parent_coin_info": "0x...",
-                "puzzle_hash": "0x...",
-                "amount": 100
+    "spendBundle": {
+        "aggregated_signature": "0x...",
+        "coin_spends": [
+            # Original spend
+            {
+                "coin": {
+                    "parent_coin_info": "0x...",
+                    "puzzle_hash": "0x...",
+                    "amount": 1000
+                },
+                "puzzle_reveal": "0x...",
+                "solution": "0x..."
             },
-            "puzzle_reveal": "0x...",
-            "solution": "0x..."
-        }
-    ],
-    "aggregated_signature": "0x..."  # Updated to include fee spend
+            # Added fee spend
+            {
+                "coin": {
+                    "parent_coin_info": "0x...",
+                    "puzzle_hash": "0x...",
+                    "amount": 100
+                },
+                "puzzle_reveal": "0x...",
+                "solution": "0x..."
+            }
+        ],
+    },
+    "fees": 100000,
+    "submitted": false
 }
 ```