ExW3.Rpc (exw3 v0.6.1) View Source

Link to this section Summary

Types

earliest()

hex_block_number()

invalid_hex_string_error()

latest()

log_filter()

opts()

pending()

request_error()

Functions

accounts(opts \\ [])

returns all available accounts

balance(account, opts \\ [])

Returns current balance of account

block(block_number)

Returns block data for specified block number

block_number(opts \\ [])

Returns the current block number

eth_call(arguments)

Simple eth_call to client. Recommended to use ExW3.Contract.call instead.

eth_send(arguments)

Simple eth_send_transaction. Recommended to use ExW3.Contract.send instead.

eth_sign(data0, data1, opts \\ [])

Calculates an Ethereum specific signature and signs the data provided, using the accounts private key

get_filter_changes(filter_id)

Gets event changes (logs) by filter. Unlike ExW3.Contract.get_filter_changes it does not return the data in a formatted way

get_logs(filter, opts \\ [])

mine(num_blocks \\ 1)

Mines number of blocks specified. Default is 1

new_filter(map)

Creates a new filter, returns filter id. For more sophisticated use, prefer ExW3.Contract.filter.

personal_ec_recover(data0, data1, opts \\ [])

Using the personal api, this method returns the address associated with the private key that was used to calculate the signature with personal_sign.

personal_list_accounts(opts \\ [])

Using the personal api, returns list of accounts.

personal_new_account(password, opts \\ [])

Using the personal api, this method creates a new account with the passphrase, and returns new account address.

personal_send_transaction(param_map, passphrase, opts \\ [])

Using the personal api, this method sends a transaction and signs it in one call, and returns a transaction id hash.

personal_sign(data, address, passphrase, opts \\ [])

Using the personal api, this method calculates an Ethereum specific signature, and returns that signature.

personal_sign_transaction(param_map, passphrase, opts \\ [])

Using the personal api, this method signs a transaction, and returns the signed transaction.

personal_unlock_account(params, opts \\ [])

Using the personal api, this method unlocks account using the passphrase provided, and returns a boolean.

tx_receipt(tx_hash)

Returns transaction receipt for specified transaction hash(id)

uninstall_filter(filter_id)

Uninstalls filter from the ethereum node

Link to this section Types

earliest()

Specs

earliest() :: String.t()

hex_block_number()

Specs

hex_block_number() :: String.t()

invalid_hex_string_error()

Specs

invalid_hex_string_error() :: ExW3.Utils.invalid_hex_string_error()

latest()

Specs

latest() :: String.t()

log_filter()

Specs

log_filter() :: %{
  optional(:address) => String.t(),
  optional(:fromBlock) =>
    hex_block_number() | latest() | earliest() | pending(),
  optional(:toBlock) => hex_block_number() | latest() | earliest() | pending(),
  optional(:topics) => [String.t()],
  optional(:blockhash) => String.t()
}

opts()

Specs

opts() :: {:url, String.t()}

pending()

Specs

pending() :: String.t()

request_error()

Specs

request_error() :: Ethereumex.Client.Behaviour.error()

Link to this section Functions

accounts(opts \\ [])

Specs

accounts([opts()]) :: list()

returns all available accounts

balance(account, opts \\ [])

Specs

balance(binary(), [opts()]) :: integer() | {:error, any()}

Returns current balance of account

block(block_number)

Specs

block(integer()) :: any() | {:error, any()}

Returns block data for specified block number

block_number(opts \\ [])

Specs

block_number([opts()]) ::
  {:ok, non_neg_integer()} | {:error, ExW3.Utils.invalid_hex_string()}

Returns the current block number

eth_call(arguments)

Specs

eth_call(list()) :: any()

Simple eth_call to client. Recommended to use ExW3.Contract.call instead.

eth_send(arguments)

Specs

eth_send(list()) :: any()

Simple eth_send_transaction. Recommended to use ExW3.Contract.send instead.

eth_sign(data0, data1, opts \\ [])

Specs

eth_sign(binary(), binary(), list()) :: {:ok, binary()} | {:error, any()}

Calculates an Ethereum specific signature and signs the data provided, using the accounts private key

get_filter_changes(filter_id)

Specs

get_filter_changes(binary()) :: any()

Gets event changes (logs) by filter. Unlike ExW3.Contract.get_filter_changes it does not return the data in a formatted way

get_logs(filter, opts \\ [])

Specs

get_logs(log_filter(), [opts()]) ::
  {:ok, list()} | {:error, term()} | request_error()

mine(num_blocks \\ 1)

Specs

mine(integer()) :: any() | {:error, any()}

Mines number of blocks specified. Default is 1

new_filter(map)

Specs

new_filter(map()) :: binary() | {:error, any()}

Creates a new filter, returns filter id. For more sophisticated use, prefer ExW3.Contract.filter.

personal_ec_recover(data0, data1, opts \\ [])

Specs

personal_ec_recover(binary(), binary(), []) :: {:ok, binary()} | {:error, any()}

Using the personal api, this method returns the address associated with the private key that was used to calculate the signature with personal_sign.

personal_list_accounts(opts \\ [])

Specs

personal_list_accounts(list()) :: {:ok, list()} | {:error, any()}

Using the personal api, returns list of accounts.

personal_new_account(password, opts \\ [])

Specs

personal_new_account(binary(), list()) :: {:ok, binary()} | {:error, any()}

Using the personal api, this method creates a new account with the passphrase, and returns new account address.

personal_send_transaction(param_map, passphrase, opts \\ [])

Specs

personal_send_transaction(map(), binary(), list()) ::
  {:ok, binary()} | {:error, any()}

Using the personal api, this method sends a transaction and signs it in one call, and returns a transaction id hash.

personal_sign(data, address, passphrase, opts \\ [])

Specs

personal_sign(binary(), binary(), binary(), list()) ::
  {:ok, binary()} | {:error, any()}

Using the personal api, this method calculates an Ethereum specific signature, and returns that signature.

personal_sign_transaction(param_map, passphrase, opts \\ [])

Specs

personal_sign_transaction(map(), binary(), list()) ::
  {:ok, map()} | {:error, any()}

Using the personal api, this method signs a transaction, and returns the signed transaction.

personal_unlock_account(params, opts \\ [])

Specs

personal_unlock_account(binary(), list()) :: {:ok, boolean()} | {:error, any()}

Using the personal api, this method unlocks account using the passphrase provided, and returns a boolean.

tx_receipt(tx_hash)

Specs

tx_receipt(binary()) :: {:ok, map()} | {:error, any()}

Returns transaction receipt for specified transaction hash(id)

uninstall_filter(filter_id)

Specs

uninstall_filter(binary()) :: boolean() | {:error, any()}

Uninstalls filter from the ethereum node