Merge pull request #119 from next-game-solutions/dev-tx-functions-optimisation

Closes #119

Author: next-game-solutions

NEWS.md

@@ -1,3 +1,9 @@
+# tronr 0.1.2
+
+## Minor improvements
+
+* Functions `parse_tx_info()` (non-public utility function), `get_block_info()` and `get_blocks_for_time_range()` now work a little bit faster by doing less work (e.g., by not converting the API-defined variable names to snake case).
+
 # tronr 0.1.1
 
 ## Minor improvements and bug fixes

R/get_block_info.R

@@ -70,7 +70,6 @@ get_block_info <- function(latest = TRUE,
     attr(request_time, "tzone") <- "UTC"
 
     r <- api_request(url = url, max_attempts = max_attempts)
-
     names(r) <- snakecase::to_snake_case(names(r))
 
     result <- tibble::as_tibble(r) %>%
@@ -113,7 +112,7 @@ get_block_info <- function(latest = TRUE,
     params = list(
       sort = "-timestamp",
       count = tolower(TRUE),
-      limit = 25,
+      limit = 50,
       block = result$block_number
     )
   )

R/get_blocks_for_time_range.R

@@ -45,41 +45,39 @@ get_blocks_for_time_range <- function(min_timestamp,
     path = c("api", "block"),
     params = list(
       sort = "-number",
-      limit = 25,
+      limit = 50,
       start_timestamp = min_timestamp,
       end_timestamp = max_timestamp
     ),
     max_attempts = max_attempts
   )
 
   result <- lapply(data, function(x) {
-    names(x) <- snakecase::to_snake_case(names(x))
-
     tibble::as_tibble(x) %>%
       dplyr::mutate(
         number = as.character(.data$number),
         timestamp = from_unix_timestamp(.data$timestamp)
       ) %>%
       dplyr::rename(
-        tx_count = .data$nr_of_trx,
+        tx_count = .data$nrOfTrx,
         block_number = .data$number
       )
   }) %>%
     dplyr::bind_rows() %>%
     dplyr::select(
-      .data$block_number,
-      .data$timestamp,
-      .data$hash,
-      .data$parent_hash,
-      .data$tx_trie_root,
-      .data$confirmed,
-      .data$revert,
-      .data$size,
-      .data$witness_address,
-      .data$witness_name,
-      .data$tx_count,
-      .data$net_usage,
-      .data$energy_usage
+      block_number = .data$block_number,
+      timestamp = .data$timestamp,
+      hash = .data$hash,
+      parent_hash = .data$parentHash,
+      tx_trie_root = .data$txTrieRoot,
+      confirmed = .data$confirmed,
+      revert = .data$revert,
+      size = .data$size,
+      witness_address = .data$witnessAddress,
+      witness_name = .data$witnessName,
+      tx_count = .data$tx_count,
+      net_usage = .data$netUsage,
+      energy_usage = .data$energyUsage
     )
 
   return(result)

R/get_tx_for_time_range.R

@@ -43,7 +43,7 @@ get_tx_for_time_range <- function(min_timestamp = 0,
     path = c("api", "transaction"),
     params = list(
       sort = "timestamp",
-      limit = 25,
+      limit = 50,
       count = tolower(TRUE),
       start_timestamp = min_timestamp,
       end_timestamp = max_timestamp

R/parse_tx_info.R

@@ -23,12 +23,7 @@ parse_tx_info <- function(info) {
     ifelse(!is.null(x), x, NA)
   }
 
-  names(info) <- snakecase::to_snake_case(names(info))
-
-  contract_data_names <-
-    names(info$contract_data) <-
-    snakecase::to_snake_case(names(info$contract_data))
-
+  info_names <- names(info)
 
   # Core info:
   tx_id <- info$hash
@@ -37,28 +32,28 @@ parse_tx_info <- function(info) {
 
   timestamp <- from_unix_timestamp(info$timestamp)
 
-  contract_result <- info$contract_ret
+  contract_result <- info$contractRet
 
   confirmed <- info$confirmed
 
   confirmations_count <- info$confirmations
 
-  contract_type <- convert_contract_type_id(info$contract_type)
+  contract_type <- convert_contract_type_id(info$contractType)
 
-  from_address <- info$owner_address
+  from_address <- info$ownerAddress
 
-  to_address <- ifelse(nchar(info$to_address) != 0, info$to_address, NA)
+  to_address <- ifelse(nchar(info$toAddress) != 0, info$toAddress, NA)
 
-  is_contract_from_address <- unlist(info$contract_map[info$owner_address])
+  is_contract_from_address <- unlist(info$contract_map[info$ownerAddress])
 
   is_contract_to_address <- ifelse(is.na(to_address),
     to_address,
-    unlist(info$contract_map[info$to_address])
+    unlist(info$contract_map[info$toAddress])
   )
 
   costs <- list(tibble::as_tibble(info$cost))
 
-  sr_confirm_list <- lapply(info$sr_confirm_list, function(x) {
+  sr_confirm_list <- lapply(info$srConfirmList, function(x) {
     tibble::as_tibble(x) %>%
       dplyr::mutate(block = as.character(.data$block)) %>%
       dplyr::rename(block_number = .data$block) %>%
@@ -71,21 +66,19 @@ parse_tx_info <- function(info) {
   if (contract_type == "TransferAssetContract") {
     trx_transfer <- 0
 
-    if ("token_info" %in% contract_data_names &
-      is.list(info$contract_data$token_info) &
-      length(info$contract_data$token_info) != 0) {
-      token_info <- info$contract_data$token_info
-
-      names(token_info) <- snakecase::to_snake_case(names(token_info))
+    if ("tokenInfo" %in% names(info$contractData) &
+      is.list(info$contractData$tokenInfo) &
+      length(info$contractData$tokenInfo) != 0) {
+      token_info <- info$contractData$tokenInfo
 
       trc10_transfer <- tibble::tibble(
-        token_id = as.character(info$contract_data$asset_name),
-        token_name = null_checker(token_info$token_name),
-        token_abbr = null_checker(token_info$token_abbr),
+        token_id = as.character(info$contractData$asset_name),
+        token_name = null_checker(token_info$tokenName),
+        token_abbr = null_checker(token_info$tokenAbbr),
         vip = null_checker(token_info$vip),
         amount = apply_decimal(
-          info$contract_data$amount,
-          token_info$token_decimal
+          info$contractData$amount,
+          token_info$tokenDecimal
         )
       )
 
@@ -98,17 +91,17 @@ parse_tx_info <- function(info) {
 
   # TransferContract - used only to transfer TRX:
   if (contract_type == "TransferContract") {
-    trx_transfer <- apply_decimal(as.numeric(info$contract_data$amount), 6)
+    trx_transfer <- apply_decimal(as.numeric(info$contractData$amount), 6)
     trc10_transfer <- NA
   }
 
 
   # TriggerSmartContract:
   if (contract_type == "TriggerSmartContract") {
-    trx_transfer <- ifelse(!"call_value" %in% names(info$contract_data) ||
-      nchar(info$contract_data$call_value) == 0,
+    trx_transfer <- ifelse(!"call_value" %in% names(info$contractData) ||
+      nchar(info$contractData$call_value) == 0,
     0,
-    apply_decimal(as.numeric(info$contract_data$call_value), 6)
+    apply_decimal(as.numeric(info$contractData$call_value), 6)
     )
 
     trc10_transfer <- NA
@@ -126,10 +119,10 @@ parse_tx_info <- function(info) {
   }
 
 
-  if ("trc_20_transfer_info" %in% names(info) &
-    is.list(info$trc_20_transfer_info) &
-    length(info$trc_20_transfer_info) != 0) {
-    trc20_transfer <- lapply(info$trc_20_transfer_info, function(x) {
+  if ("trc20TransferInfo" %in% names(info) &
+    is.list(info$trc20TransferInfo) &
+    length(info$trc20TransferInfo) != 0) {
+    trc20_transfer <- lapply(info$trc20TransferInfo, function(x) {
       tibble::tibble(
         token_name = x$name,
         token_abbr = x$symbol,

R/run_paginated_tronscan_query.R

@@ -52,6 +52,11 @@ run_paginated_tronscan_query <- function(base_url,
       )
 
       r <- api_request(url = url, max_attempts = max_attempts)
+
+      if ("message" %in% names(r)) {
+        rlang::abort("Some API parameters are invalid or out of range")
+      }
+
       names(r) <- snakecase::to_snake_case(names(r))
 
       previous_data_length <- length(data)
@@ -85,6 +90,11 @@ run_paginated_tronscan_query <- function(base_url,
     )
 
     r <- api_request(url = url, max_attempts = max_attempts)
+
+    if ("message" %in% names(r)) {
+      rlang::abort("Some API parameters are invalid or out of range")
+    }
+
     names(r) <- snakecase::to_snake_case(names(r))
 
     previous_data_length <- length(data)