client request: make existing http-request response more generic

Author: Jamie C. Driver

main/process/pinclient.c

@@ -72,8 +72,13 @@ static void send_http_request_reply(jade_process_t* process, const char* documen
     JADE_ASSERT(data);
 
     // Prepare request data
-    data_request_t pin_data
-        = { .method = "POST", .accept = "json", .on_reply = "pin", .strdata = data, .rawdata_len = 0, .num_urls = 0 };
+    client_data_request_t pin_data = { .request_type = CLIENT_REQUEST_TYPE_HTTP,
+        .method = "POST",
+        .accept = "json",
+        .on_reply = "pin",
+        .strdata = data,
+        .rawdata_len = 0,
+        .num_urls = 0 };
 
     // Add urls - bespoke pinserver urls or defaults if not set
     char buf[MAX_PINSVR_URL_LENGTH];
@@ -114,7 +119,7 @@ static void send_http_request_reply(jade_process_t* process, const char* documen
     }
 
     // Send reply message
-    jade_process_reply_to_message_result(process->ctx, &pin_data, http_request_reply);
+    jade_process_reply_to_message_result(process->ctx, &pin_data, client_data_request_reply);
 }
 
 // Hepler to tweak the server static key into a session key

main/process/process_utils.c

@@ -444,6 +444,7 @@ void update_aggregate_scripts_flavour(
     }
 }
 
+// eg:
 // {
 //   "http_request": {
 //     //
@@ -456,13 +457,13 @@ void update_aggregate_scripts_flavour(
 //     }
 //     "on-reply": `on_reply`
 //   }
-void http_request_reply(const void* ctx, CborEncoder* container)
+void client_data_request_reply(const void* ctx, CborEncoder* container)
 {
     JADE_ASSERT(ctx);
     JADE_ASSERT(container);
 
-    const data_request_t* const request_data = (const data_request_t*)ctx;
-    JADE_ASSERT(request_data->num_urls);
+    const client_data_request_t* const request_data = (const client_data_request_t*)ctx;
+    JADE_ASSERT(request_data->request_type);
     JADE_ASSERT(request_data->on_reply);
     // method, accept and certificate and data fields are optional, but some combinations may be nonsensical
     JADE_ASSERT(request_data->rawdata || !request_data->rawdata_len);
@@ -473,7 +474,10 @@ void http_request_reply(const void* ctx, CborEncoder* container)
 
     JADE_ASSERT(!nested_json || !request_data->rawdata_len);
 
-    size_t num_params = 1; // urls
+    size_t num_params = 0;
+    if (request_data->num_urls) {
+        ++num_params;
+    }
     if (request_data->method) {
         ++num_params;
     }
@@ -491,8 +495,8 @@ void http_request_reply(const void* ctx, CborEncoder* container)
     CborError cberr = cbor_encoder_create_map(container, &root_map, 1);
     JADE_ASSERT(cberr == CborNoError);
 
-    // Envelope data for http request
-    cberr = cbor_encode_text_stringz(&root_map, "http_request");
+    // Envelope data for client request
+    cberr = cbor_encode_text_stringz(&root_map, request_data->request_type);
     JADE_ASSERT(cberr == CborNoError);
 
     CborEncoder http_encoder;
@@ -507,7 +511,9 @@ void http_request_reply(const void* ctx, CborEncoder* container)
     JADE_ASSERT(cberr == CborNoError);
 
     // The urls (http/tls/onion)
-    add_string_array_to_map(&params_encoder, "urls", (const char**)request_data->urls, request_data->num_urls);
+    if (request_data->num_urls) {
+        add_string_array_to_map(&params_encoder, "urls", (const char**)request_data->urls, request_data->num_urls);
+    }
 
     // Any additional root certificate that may be required
     if (request_data->certificate) {

main/process/process_utils.h

@@ -31,8 +31,11 @@ typedef struct {
 
 #define MAX_REQUEST_URLS 2
 
+#define CLIENT_REQUEST_TYPE_HTTP "http_request"
+
 typedef struct {
     const char* urls[MAX_REQUEST_URLS];
+    const char* request_type;
     const char* certificate;
     const char* method;
     const char* accept;
@@ -43,7 +46,7 @@ typedef struct {
     const char* on_reply;
     size_t rawdata_len; // zero implies may be char data
     uint8_t num_urls;
-} data_request_t;
+} client_data_request_t;
 
 #define HAS_NO_CURRENT_MESSAGE(process)                                                                                \
     (process && !process->ctx.cbor && !process->ctx.cbor_len && process->ctx.source == SOURCE_NONE)
@@ -138,7 +141,8 @@ bool params_get_bip85_rsa_key(CborValue* params, size_t* key_bits, size_t* index
 script_flavour_t get_script_flavour(const uint8_t* script, const size_t script_len, bool* is_p2tr);
 void update_aggregate_scripts_flavour(script_flavour_t new_script_flavour, script_flavour_t* aggregate_scripts_flavour);
 
-// A message reply which is actually a request for more data from a resource
-void http_request_reply(const void* ctx, CborEncoder* container);
+// A message reply which is actually a request for more data from the client
+// 'ctx' should be a 'client_data_request_t' struct as above
+void client_data_request_reply(const void* ctx, CborEncoder* container);
 
 #endif /* PROCESS_UTILS_H_ */