R/convert.R

In dapped/eth: Interact with Ethereum

#' Convert between Ether units
#'
#' Convert between Ether units.
#'
#' @param x Numeric. A vector giving values to be converted.
#' @param from Character. The units of Ether in which `x` is given. See
#'   [eth_units()] for valid values. Default is `'wei'`.
#' @param to Character. The target unit of Ether to which `x` will be
#'   converted. See [eth_units()] for valid values.
#' @return A vector giving `x` in units specified by `to`.
#' @keywords Ethereum, units, currency, ETH
#' @seealso [eth_units()]
#' @importFrom dplyr %>%
#' @importFrom stats setNames
#' @export
convert <- function(x, from='wei', to) {
  from <- tolower(from)
  to <- tolower(to)
  if(!from %in% names(units))
    stop(from, ' is not a valid unit. See `eth_units()`.', call.=FALSE)
  if(!to %in% names(units))
    stop(to, ' is not a valid unit. See `eth_units()`.', call.=FALSE)
  unname(x * units[from]/units[to])
}