radixir v0.0.5

View Source Radixir.Util (radixir v0.0.5)

Utility functions that do various things.

Link to this section Summary

Types

address()
atto()
data()
encoded_data()
encoded_message()
encrypted_message()
error_message()
error_note()
keys_values()
message()
payload_to_sign()
private_key()
public_key()
rounding()
unsigned_transaction()
xrd()

Functions

atto_to_xrd(atto)

Converts atto, the smallest unit of value, to xrd.

decode16(encoded_data, error_note)

Base16 decodes encoded_data.

decode_message(encoded_message)

Decodes a message.

decrypt_message(encrypted_message, private_key, address)

Decrypts encrypted_message with private_key and address.

encode16(data)

Base16 encodes data.

encode_message(message)

Encodes message by

encrypt_message(message, private_key, address)

Encrypts message with private_key and address.

verify_hash(unsigned_transaction, payload_to_sign)

Verifies double hash of base16 decoded unsigned_transaction matches payload_to_sign.

xrd_abs(num)

Absolute value of XRD amount.

xrd_add(num1, num2)

Adds two XRD amounts.

xrd_compare(num1, num2)

Compares two XRD amounts.

xrd_div(num1, num2)

Divides two XRD amounts.

xrd_div_int(num1, num2)

Divides two XRD amounts and returns the integer part.

xrd_div_rem(num1, num2)

Divides two XRD amounts and returns the integer part and remainder part.

xrd_equal?(num1, num2)

Checks if two XRD amounts are equal.

xrd_gt?(num1, num2)

Checks if num1 is greater than num2.

xrd_lt?(num1, num2)

Checks if num1 is less than num2.

xrd_max(num1, num2)

Returns the max of two XRD amounts.

xrd_min(num1, num2)

Returns the min of two XRD amounts.

xrd_mult(num1, num2)

Multiplies two XRD amounts.

xrd_negate(num)

Negates the given XRD amount.

xrd_negative?(num)

Checks if an XRD amount is negative.

xrd_positive?(num)

Checks if an XRD amount is positive.

xrd_rem(num1, num2)

Returns the remainder of integer division of two XRD amounts.

xrd_round(num, places \\ 0, mode \\ :half_up)

Rounds an XRD amount.

xrd_sqrt(num)

Finds square root of XRD amount.

xrd_sub(num1, num2)

Subtracts two XRD amounts.

xrd_to_atto(xrd)

Converts xrd to atto, smallest unit of value.

Link to this section Types

Link to this type

address()

View Source 
@type address() :: String.t()
Link to this type

atto()

View Source 
@type atto() :: String.t()
Link to this type

data()

View Source 
@type data() :: String.t()
Link to this type

encoded_data()

View Source 
@type encoded_data() :: String.t()
Link to this type

encoded_message()

View Source 
@type encoded_message() :: String.t()
Link to this type

encrypted_message()

View Source 
@type encrypted_message() :: String.t()
Link to this type

error_message()

View Source 
@type error_message() :: String.t()
Link to this type

error_note()

View Source 
@type error_note() :: String.t()
Link to this type

keys_values()

View Source 
@type keys_values() :: [keyword()]
Link to this type

message()

View Source 
@type message() :: String.t()
Link to this type

payload_to_sign()

View Source 
@type payload_to_sign() :: String.t()
Link to this type

private_key()

View Source 
@type private_key() :: String.t()
Link to this type

public_key()

View Source 
@type public_key() :: String.t()
Link to this type

rounding()

View Source 
@type rounding() ::
  :down | :half_up | :half_even | :ceiling | :floor | :half_down | :up
Link to this type

unsigned_transaction()

View Source 
@type unsigned_transaction() :: String.t()
Link to this type

xrd()

View Source 
@type xrd() :: String.t()

Link to this section Functions

Link to this function

atto_to_xrd(atto)

View Source 
@spec atto_to_xrd(atto()) :: xrd()

Converts atto, the smallest unit of value, to xrd.

parameters

 Parameters

  • atto: Amount of XRD, in atto units.

examples

 Examples 

iex> Radixir.Util.atto_to_xrd("1500000000000000000")
"1.5"
Link to this function

decode16(encoded_data, error_note)

View Source 
@spec decode16(encoded_data(), error_note()) ::
  {:ok, data()} | {:error, error_message()}

Base16 decodes encoded_data.

parameters

 Parameters

  • encoded_data: Data to be decoded.
  • error_note: Note to add to error message.

examples

 Examples 

iex> Radixir.Util.decode16("68656c6c6f207468657265", "obi wan's message")
{:ok, "hello there"}

iex> Radixir.Util.decode16("zzzz", "obi wan's message")
{:error, "could not base16 decode obi wan's message"}
Link to this function

decode_message(encoded_message)

View Source 
@spec decode_message(encoded_message()) ::
  {:ok, message()} | {:error, error_message()}

Decodes a message.

parameter

 Parameter

  • encoded_message: Encoded message.

examples

 Examples 

iex> Radixir.Util.decode_message("000068656c6c6f207468657265")
{:ok, "hello there"}
Link to this function

decrypt_message(encrypted_message, private_key, address)

View Source 
@spec decrypt_message(encrypted_message(), private_key(), address()) ::
  {:ok, message()} | {:error, error_message()}

Decrypts encrypted_message with private_key and address.

parameters

 Parameters

  • encrypted_message: Encrypted message to be decrypted.
  • private_key: Hex encoded private key.
  • address: Radix address.

examples

 Examples 

Radixir.Util.decrypt_message("01ff02479eac3d0e685437e3ec1c6401db8895c4ead94f2906c3380c6d442f9496c71d3b28e578a98284b112d1c3c7d45bb407e9c778d7ac3ec9349f9d517abee7bad13c521e517bc86f","b6b71fb3936ee2c7b6398bc5a25138292e0b470642bf70e1cea7f52707bce0e5", "rdx1qspzfaq8ccfzmrrx9xxqrm6uespgtt7mah0ry3qa2vsxajk462s5ttsmphsk4")
{:ok, "hello there"}
Link to this function

encode16(data)

View Source 
@spec encode16(data()) :: encoded_data()

Base16 encodes data.

parameters

 Parameters

  • data: Data to be encoded.

examples

 Examples 

iex> Radixir.Util.encode16("hello there")
"68656c6c6f207468657265"
Link to this function

encode_message(message)

View Source 
@spec encode_message(message()) :: encoded_message()

Encodes message by:

  • Base16 encoding the message
  • Prefixing "0000" to the front

parameter

 Parameter

  • message: Plain text.

examples

 Examples 

iex> Radixir.Util.encode_message("hello there")
"000068656c6c6f207468657265"
Link to this function

encrypt_message(message, private_key, address)

View Source 
@spec encrypt_message(message(), private_key(), address()) ::
  {:ok, encrypted_message()} | {:error, error_message()}

Encrypts message with private_key and address.

parameters

 Parameters

  • message: Plain text message to be encrypted.
  • private_key: Hex encoded private key.
  • address: Radix address.

examples

 Examples 

Radixir.Util.encrypt_message("hello there","83c060ae328c1e8bd238939aa78098c8eee5e18fc857ca3cc10336ad204e8f69", "rdx1qsp29qfgpy79ne7g92s8r5mvrzngyugf750ut7u76qtr9v0kzlt3pzgqr7vv6")
{:ok,
"01ff02479eac3d0e685437e3ec1c6401db8895c4ead94f2906c3380c6d442f9496c71d3b28e578a98284b112d1c3c7d45bb407e9c778d7ac3ec9349f9d517abee7bad13c521e517bc86f"}
Link to this function

verify_hash(unsigned_transaction, payload_to_sign)

View Source 
@spec verify_hash(unsigned_transaction(), payload_to_sign()) ::
  :ok | {:error, error_message()}

Verifies double hash of base16 decoded unsigned_transaction matches payload_to_sign.

Link to this function

xrd_abs(num)

View Source 
@spec xrd_abs(String.t()) :: String.t()

Absolute value of XRD amount.

parameters

 Parameters

  • num: Amount of XRD.

examples

 Examples 

iex> Radixir.Util.xrd_abs("-1.5")
"1.5"
Link to this function

xrd_add(num1, num2)

View Source 
@spec xrd_add(String.t(), String.t()) :: String.t()

Adds two XRD amounts.

parameters

 Parameters

  • num1: Amount of XRD.
  • num2: Amount of XRD.

examples

 Examples 

iex> Radixir.Util.xrd_add("12.0000000000000000014", "12.0000000000000000014")
"24.000000000000000002"
Link to this function

xrd_compare(num1, num2)

View Source 
@spec xrd_compare(String.t(), String.t()) :: :lt | :gt | :eq

Compares two XRD amounts.

parameters

 Parameters

  • num1: Amount of XRD.
  • num2: Amount of XRD.

examples

 Examples 

iex> Radixir.Util.xrd_compare("12.0000000000000000089", "12.0000000000000000079")
:gt
Link to this function

xrd_div(num1, num2)

View Source 
@spec xrd_div(String.t(), String.t()) :: String.t()

Divides two XRD amounts.

parameters

 Parameters

  • num1: Amount of XRD.
  • num2: Amount of XRD.

examples

 Examples 

iex> Radixir.Util.xrd_div("10.4", "5.2")
"2"
Link to this function

xrd_div_int(num1, num2)

View Source 
@spec xrd_div_int(String.t(), String.t()) :: String.t()

Divides two XRD amounts and returns the integer part.

parameters

 Parameters

  • num1: Amount of XRD.
  • num2: Amount of XRD.

examples

 Examples 

iex> Radixir.Util.xrd_div_int("6.9","4.3")
"1"
Link to this function

xrd_div_rem(num1, num2)

View Source 
@spec xrd_div_rem(String.t(), String.t()) :: {String.t(), String.t()}

Divides two XRD amounts and returns the integer part and remainder part.

parameters

 Parameters

  • num1: Amount of XRD.
  • num2: Amount of XRD.

examples

 Examples 

iex> Radixir.Util.xrd_div_rem("6","4.3")
{"1", "1.7"}
Link to this function

xrd_equal?(num1, num2)

View Source 
@spec xrd_equal?(String.t(), String.t()) :: boolean()

Checks if two XRD amounts are equal.

parameters

 Parameters

  • num1: Amount of XRD.
  • num2: Amount of XRD.

examples

 Examples 

iex> Radixir.Util.xrd_equal?("1.0", "2.0")
false
Link to this function

xrd_gt?(num1, num2)

View Source 
@spec xrd_gt?(String.t(), String.t()) :: boolean()

Checks if num1 is greater than num2.

parameters

 Parameters

  • num1: Amount of XRD.
  • num2: Amount of XRD.

examples

 Examples 

iex> Radixir.Util.xrd_gt?("2.0", "3.0")
false
Link to this function

xrd_lt?(num1, num2)

View Source 
@spec xrd_lt?(String.t(), String.t()) :: boolean()

Checks if num1 is less than num2.

parameters

 Parameters

  • num1: Amount of XRD.
  • num2: Amount of XRD.

examples

 Examples 

iex> Radixir.Util.xrd_lt?("2.0", "3.0")
true
Link to this function

xrd_max(num1, num2)

View Source 
@spec xrd_max(String.t(), String.t()) :: String.t()

Returns the max of two XRD amounts.

parameters

 Parameters

  • num1: Amount of XRD.
  • num2: Amount of XRD.

examples

 Examples 

iex> Radixir.Util.xrd_max("1.3", "1")
"1.3"
Link to this function

xrd_min(num1, num2)

View Source 
@spec xrd_min(String.t(), String.t()) :: String.t()

Returns the min of two XRD amounts.

parameters

 Parameters

  • num1: Amount of XRD.
  • num2: Amount of XRD.

examples

 Examples 

iex> Radixir.Util.xrd_min("1.3", "1")
"1"
Link to this function

xrd_mult(num1, num2)

View Source 
@spec xrd_mult(String.t(), String.t()) :: String.t()

Multiplies two XRD amounts.

parameters

 Parameters

  • num1: Amount of XRD.
  • num2: Amount of XRD.

examples

 Examples 

iex> Radixir.Util.xrd_mult("5", "0.5")
"2.5"
Link to this function

xrd_negate(num)

View Source 
@spec xrd_negate(String.t()) :: String.t()

Negates the given XRD amount.

parameters

 Parameters

  • num: Amount of XRD.

example

 Example 

iex> Radixir.Util.xrd_negate("2.5")
"-2.5"
Link to this function

xrd_negative?(num)

View Source 
@spec xrd_negative?(String.t()) :: boolean()

Checks if an XRD amount is negative.

parameters

 Parameters

  • num: Amount of XRD.

example

 Example 

iex> Radixir.Util.xrd_negative?("-1.34")
true
Link to this function

xrd_positive?(num)

View Source 
@spec xrd_positive?(String.t()) :: boolean()

Checks if an XRD amount is positive.

parameters

 Parameters

  • num: Amount of XRD.

example

 Example 

iex> Radixir.Util.xrd_positive?("-1.34")
false
Link to this function

xrd_rem(num1, num2)

View Source 
@spec xrd_rem(String.t(), String.t()) :: String.t()

Returns the remainder of integer division of two XRD amounts.

parameters

 Parameters

  • num1: Amount of XRD.
  • num2: Amount of XRD.

examples

 Examples 

iex> Radixir.Util.xrd_rem("5.0", "2")
"1"
Link to this function

xrd_round(num, places \\ 0, mode \\ :half_up)

View Source 
@spec xrd_round(String.t(), integer(), rounding()) :: String.t()

Rounds an XRD amount.

parameters

 Parameters

  • num: Amount of XRD.

examples

 Examples 

iex> Radixir.Util.xrd_round("1.6")
"2"
Link to this function

xrd_sqrt(num)

View Source 
@spec xrd_sqrt(String.t()) :: String.t()

Finds square root of XRD amount.

parameters

 Parameters

  • num: Amount of XRD.

examples

 Examples 

iex> Radixir.Util.xrd_sqrt("36")
"6"
Link to this function

xrd_sub(num1, num2)

View Source 
@spec xrd_sub(String.t(), String.t()) :: String.t()

Subtracts two XRD amounts.

parameters

 Parameters

  • num1: Amount of XRD.
  • num2: Amount of XRD.

examples

 Examples 

iex> Radixir.Util.xrd_sub("5", "2")
"3"
Link to this function

xrd_to_atto(xrd)

View Source 
@spec xrd_to_atto(xrd()) :: atto()

Converts xrd to atto, smallest unit of value.

parameters

 Parameters

  • xrd: Amount of XRD.

examples

 Examples 

iex> Radixir.Util.xrd_to_atto("1.5")
"1500000000000000000"