Merge pull request #634 from HowJMay/fix_typo

cleanup: Fix typos

Author: jserv

accelerator/cli_info.h

@@ -88,7 +88,7 @@ static struct ta_cli_argument_s {
     {"proxy_passthrough", no_argument, NULL, PROXY_API, "Pass proxy API directly to IRI without processing"},
     {"health_track_period", no_argument, NULL, HEALTH_TRACK_PERIOD,
      "The period for checking IRI host connection status"},
-    {"no-gtta", no_argument, NULL, NO_GTTA, "Disable getTransactionToConfirm (gTTA) when sending transacation"},
+    {"no-gtta", no_argument, NULL, NO_GTTA, "Disable getTransactionToConfirm (gTTA) when sending transaction"},
     {"buffer_list", required_argument, NULL, BUFFER_LIST, "Set the value of `buffer_list_name`"},
     {"done_list", required_argument, NULL, DONE_LIST, "Set the value of `done_list_name`"},
     {"quiet", no_argument, NULL, QUIET, "Disable logger"},

accelerator/config.h

@@ -104,8 +104,8 @@ typedef struct ta_cache_s {
 
 /** struct type of accelerator core */
 typedef struct ta_core_s {
-  ta_config_t ta_conf;                /**< accelerator configiuration structure */
-  ta_cache_t cache;                   /**< redis configiuration structure */
+  ta_config_t ta_conf;                /**< accelerator configuration structure */
+  ta_cache_t cache;                   /**< redis configuration structure */
   iota_config_t iota_conf;            /**< iota configuration structure */
   iota_client_service_t iota_service; /**< iota connection structure */
 #ifdef DB_ENABLE

accelerator/core/apis.c

@@ -381,7 +381,7 @@ status_t api_send_transfer(const ta_core_t* const core, const iota_client_servic
 #ifdef DB_ENABLE
   ret = db_insert_tx_into_identity(&core->db_service, res->hash, PENDING_TXN, res->uuid_string);
   if (ret != SC_OK) {
-    ta_log_error("fail to insert new pending transaction for reattachement\n");
+    ta_log_error("fail to insert new pending transaction for reattachment\n");
     goto done;
   }
 #endif

accelerator/core/core.c

@@ -202,7 +202,7 @@ status_t ta_send_transfer(const ta_config_t* const info, const iota_config_t* co
   memcpy(transfer.tag, hash81_queue_peek(req->tag), FLEX_TRIT_SIZE_81);
   transfer_array_add(transfers, &transfer);
 
-  // TODO we may need args `remainder_address`, `inputs`, `timestampe` in the
+  // TODO we may need args `remainder_address`, `inputs`, `timestamp` in the
   // future and declare `security` field in `iota_config_t`
   flex_trit_t seed[NUM_FLEX_TRITS_ADDRESS];
   flex_trits_from_trytes(seed, NUM_TRITS_HASH, (tryte_t const*)iconf->seed, NUM_TRYTES_HASH, NUM_TRYTES_HASH);
@@ -321,7 +321,7 @@ status_t ta_find_transaction_objects(const iota_client_service_t* const service,
   cache_value[NUM_TRYTES_SERIALIZED_TRANSACTION] = '\0';
 
   // append transaction object which is already cached to transaction_array_t
-  // if not, append uncached to request object of `iota_client_find_transaction_objectss`
+  // if not, append uncached to request object of `iota_client_find_transaction_objects`
   hash243_queue_entry_t* q_iter = NULL;
   CDL_FOREACH(req->hashes, q_iter) {
     flex_trits_to_trytes((tryte_t*)txn_hash, NUM_TRYTES_HASH, q_iter->hash, NUM_TRITS_HASH, NUM_TRITS_HASH);
@@ -499,7 +499,7 @@ status_t ta_get_bundles_by_addr(const iota_client_service_t* const service, tryt
     goto done;
   }
 
-  // In case the requested transction hashes is an empty one
+  // In case the requested transaction hashes is an empty one
   if (hash243_queue_count(txn_res->hashes) > 0) {
     hash243_queue_copy(&obj_req->hashes, txn_res->hashes, hash243_queue_count(txn_res->hashes));
   } else {
@@ -582,7 +582,7 @@ status_t ta_get_iri_status(const iota_client_service_t* const service) {
   return ret;
 }
 
-status_t ta_update_iri_conneciton(ta_config_t* const ta_conf, iota_client_service_t* const service) {
+status_t ta_update_iri_connection(ta_config_t* const ta_conf, iota_client_service_t* const service) {
   status_t ret = SC_OK;
   for (int i = 0; i < MAX_IRI_LIST_ELEMENTS && ta_conf->iota_host_list[i]; i++) {
     // update new IRI host
@@ -689,7 +689,7 @@ status_t broadcast_buffered_txn(const ta_core_t* const core) {
     }
 
     // TODO Now we assume every time we call `cache_get()`, we would get a transaction object. However, in the future,
-    // the returned result may be a bunlde.
+    // the returned result may be a bundle.
     int trytes_array_len = 0;
     ret = cache_list_size(uuid, &trytes_array_len);
     if (ret) {

accelerator/core/core.h

@@ -215,7 +215,7 @@ status_t ta_send_bundle(const ta_config_t* const info, const iota_config_t* cons
  *
  * @param[in] service IRI node end point service
  * @param[in] addr searched address in tryte_t
- * @param[in] bundle_array a bundle array object that will contain the MAM transacitons
+ * @param[in] bundle_array a bundle array object that will contain the MAM transactions
  *
  * @return
  * - SC_OK on success
@@ -229,8 +229,8 @@ status_t ta_get_bundles_by_addr(const iota_client_service_t* const service, tryt
  *
  * We would check out the connection status with IRI core API getNodeInfo. At the first step, we would check whether
  * tangle-accelerator can connect to the IRI host which is assigned in iota_client_service_t object. If the
- * tangl-accelerator connects to the IRI host, the next step we are going to check out whether the connected IRI has
- * synchronized to the latest milestone. The mentioned two errors above would trigger tangle-acclerator connect to
+ * tangle-accelerator connects to the IRI host, the next step we are going to check out whether the connected IRI has
+ * synchronized to the latest milestone. The mentioned two errors above would trigger tangle-accelerator connect to
  * another IRI host on IRI priority host list.
  *
  * @param[in] service IRI node end point service
@@ -244,7 +244,7 @@ status_t ta_get_iri_status(const iota_client_service_t* const service);
 /**
  * @brief Update the binding IRI host to another valid host on priority list
  *
- * ta_update_iri_conneciton would check the connection status of all the IRI host on priority list iteratively. Once it
+ * ta_update_iri_connection would check the connection status of all the IRI host on priority list iteratively. Once it
  * connect to one of the IRI host on the priority list, it would return SC_OK.
  *
  * @param ta_conf[in] Tangle-accelerator configuration variables
@@ -254,7 +254,7 @@ status_t ta_get_iri_status(const iota_client_service_t* const service);
  * - SC_OK on success
  * - non-zero on error
  */
-status_t ta_update_iri_conneciton(ta_config_t* const ta_conf, iota_client_service_t* const service);
+status_t ta_update_iri_connection(ta_config_t* const ta_conf, iota_client_service_t* const service);
 
 /**
  * @brief Push failed transactions in raw trytes into transaction buffer
@@ -264,7 +264,7 @@ status_t ta_update_iri_conneciton(ta_config_t* const ta_conf, iota_client_servic
  * be popped from the buffer.
  *
  * @param cache[in] Redis configuration variables
- * @param raw_txn_flex_trit_array[in] Raw transction trytes array in flex_trit_t type
+ * @param raw_txn_flex_trit_array[in] Raw transcation trytes array in flex_trit_t type
  * @param uuid[out] Returned UUID for fetching transaction status and information
  *
  * @return
@@ -276,7 +276,7 @@ status_t push_txn_to_buffer(const ta_cache_t* const cache, hash8019_array_p raw_
 /**
  * @brief Broadcast transactions in transaction buffer
  *
- * Failed transactions would be stored in transaciton buffer. Once tangle-accelerator retrieve the connetion with
+ * Failed transactions would be stored in transaction buffer. Once tangle-accelerator retrieve the connetion with
  * Tangle, then tangle-accelerator will start to broadcast these failed transaction trytes.
  *
  * @param core[in] Pointer to Tangle-accelerator core configuration structure

accelerator/core/mam_core.c

@@ -335,7 +335,7 @@ static status_t ta_mam_written_msg_to_bundle(const iota_client_service_t *const
       }
 
       if (!msg_id_exist(tag_array, transaction_tag((iota_transaction_t *)utarray_front(*bundle)))) {
-        ta_log_debug("%s\n", "Found avialable msg_id");
+        ta_log_debug("%s\n", "Found available msg_id");
         break;
       }
 

accelerator/core/response/ta_send_mam.h

@@ -79,7 +79,7 @@ status_t send_mam_res_set_bundle_hash(ta_send_mam_res_t* res, const tryte_t* bun
 status_t send_mam_res_set_channel_id(ta_send_mam_res_t* res, const tryte_t* channel_id);
 
 /**
- * @brief Set the msgl_id field of send_mam_res object.
+ * @brief Set the msg_id field of send_mam_res object.
  *
  * @param[in] res ta_send_mam_res_t struct object
  * @param[in] msg_id Message id decoded in trytes string

accelerator/core/serializer/serializer.h

@@ -58,7 +58,7 @@ void serializer_logger_init();
 int serializer_logger_release();
 
 /**
- * @brief Serialze tangle accelerator info into JSON
+ * @brief Serialize tangle accelerator info into JSON
  *
  * @param[out] obj Tangle-accelerator info in JSON
  * @param[in] ta_config Tangle-accelerator configuration variables
@@ -75,7 +75,7 @@ status_t ta_get_info_serialize(char** obj, ta_config_t* const ta_config, iota_co
 
 #ifdef DB_ENABLE
 /**
- * @brief Serialze identity info into JSON
+ * @brief Serialize identity info into JSON
  *
  * @param[out] obj db identity info in JSON
  * @param[in] id_obj pointer to db_identity_t;
@@ -87,7 +87,7 @@ status_t db_identity_serialize(char** obj, db_identity_t* id_obj);
 #endif
 
 /**
- * @brief Serialze type of ta_generate_address_res_t to JSON string
+ * @brief Serialize type of ta_generate_address_res_t to JSON string
  *
  * @param[out] obj Address hash in JSON
  * @param[in] res Response data in type of ta_generate_address_res_t
@@ -99,7 +99,7 @@ status_t db_identity_serialize(char** obj, db_identity_t* id_obj);
 status_t ta_generate_address_res_serialize(const ta_generate_address_res_t* const res, char** obj);
 
 /**
- * @brief Serialze object `get_tips_res_t` into JSON
+ * @brief Serialize object `get_tips_res_t` into JSON
  *
  * @param[in] res Result `get_tips_res_t` object with tips inside
  * @param[out] obj Output tips in JSON
@@ -111,7 +111,7 @@ status_t ta_generate_address_res_serialize(const ta_generate_address_res_t* cons
 status_t ta_get_tips_res_serialize(const get_tips_res_t* const res, char** obj);
 
 /**
- * @brief Serialze the response of api_insert_identity()
+ * @brief Serialize the response of api_insert_identity()
  *
  * @param[in] hash Response transaction hash
  * @param[in] uuid_string Response uuid string
@@ -136,7 +136,7 @@ status_t ta_insert_identity_res_serialize(const char* hash, const char* uuid_str
 status_t ta_send_transfer_req_deserialize(const char* const obj, ta_send_transfer_req_t* req);
 
 /**
- * @brief Serialze the response of api_send_transfer()
+ * @brief Serialize the response of api_send_transfer()
  *
  * @param[in] res Response data in type of ta_send_transfer_res_t
  * @param[out] obj Input values in JSON
@@ -161,7 +161,7 @@ status_t ta_send_transfer_res_serialize(ta_send_transfer_res_t* res, char** obj)
 status_t ta_send_trytes_req_deserialize(const char* const obj, hash8019_array_p out_trytes);
 
 /**
- * @brief Serialze hash8019_array_p to JSON string
+ * @brief Serialize hash8019_array_p to JSON string
  *
  * @param[in] trytes trytes array returned in type of hash8019_array_p
  * @param[out] obj output serialized JSON values
@@ -173,7 +173,7 @@ status_t ta_send_trytes_req_deserialize(const char* const obj, hash8019_array_p
 status_t ta_send_trytes_res_serialize(const hash8019_array_p trytes, char** obj);
 
 /**
- * @brief Serialze response of api_transaction_object_single into JSON
+ * @brief Serialize response of api_transaction_object_single into JSON
  *
  * @param[in] res Transaction object array, but we take only the first one
  * @param[out] obj Result of serialization in JSON format.
@@ -198,7 +198,7 @@ status_t ta_find_transaction_objects_req_deserialize(const char* const obj,
                                                      ta_find_transaction_objects_req_t* const req);
 
 /**
- * @brief Serialze type of ta_find_transaction_objects_res_t to JSON string
+ * @brief Serialize type of ta_find_transaction_objects_res_t to JSON string
  *
  * @param[out] obj List of transaction object in JSON
  * @param[in] res Response data in type of ta_find_transaction_objects_res_t
@@ -210,7 +210,7 @@ status_t ta_find_transaction_objects_req_deserialize(const char* const obj,
 status_t ta_find_transaction_objects_res_serialize(const transaction_array_t* const res, char** obj);
 
 /**
- * @brief Serialze type of ta_find_transactions_by_tag_res_t to JSON string
+ * @brief Serialize type of ta_find_transactions_by_tag_res_t to JSON string
  *
  * @param[out] obj List of transaction hash in JSON
  * @param[in] res Response data in type of ta_find_transactions_by_tag_res_t
@@ -282,7 +282,7 @@ status_t send_mam_req_deserialize(const char* const obj, ta_send_mam_req_t* req)
 status_t send_mam_res_deserialize(const char* const obj, ta_send_mam_res_t* const res);
 
 /**
- * @brief Serialze type of ta_send_mam_res_t to JSON string
+ * @brief Serialize type of ta_send_mam_res_t to JSON string
  *
  * @param[out] obj send mam response object in JSON
  * @param[in] res Response data in type of ta_send_mam_res_t
@@ -358,7 +358,7 @@ status_t get_iri_status_milestone_deserialize(char const* const obj, int* const
                                               int* const latestSolidSubtangleMilestone);
 
 /**
- * @brief Serialze the response of IRI connection status.
+ * @brief Serialize the response of IRI connection status.
  *
  * @param[in] status Reponse status code
  * @param[out] obj Serialized API response
@@ -370,7 +370,7 @@ status_t get_iri_status_milestone_deserialize(char const* const obj, int* const
 status_t get_iri_status_res_serialize(const status_t status, char** obj);
 
 /**
- * @brief Serialze the response of `fetch_txn_with_uuid()`.
+ * @brief Serialize the response of `fetch_txn_with_uuid()`.
  *
  * @param[in] res ta_fetch_txn_with_uuid_res_t object
  * @param[out] obj Serialized API response

accelerator/main.c

@@ -26,7 +26,7 @@ static void* health_track(void* arg) {
     status_t ret = ta_get_iri_status(&core->iota_service);
     if (ret == SC_CORE_IRI_UNSYNC || ret == SC_CCLIENT_FAILED_RESPONSE) {
       ta_log_error("IRI status error %d. Try to connect to another IRI host on priority list\n", ret);
-      ret = ta_update_iri_conneciton(&core->ta_conf, &core->iota_service);
+      ret = ta_update_iri_connection(&core->ta_conf, &core->iota_service);
       if (ret) {
         ta_log_error("Update IRI host failed: %d\n", ret);
       }

accelerator/mqtt_main.c

@@ -65,7 +65,7 @@ int main(int argc, char *argv[]) {
   }
 
   // Initialize `mosq` and `cfg`
-  // if we want to opertate this program under multi-threading, see https://github.com/eclipse/mosquitto/issues/450
+  // if we want to operate this program under multi-threading, see https://github.com/eclipse/mosquitto/issues/450
   ret = duplex_config_init(&mosq, &cfg);
   if (ret != SC_OK) {
     ta_log_error("%d\n", ret);