exw3 v0.3.0 ExW3.Contract View Source

Link to this section Summary

Functions

Returns the current Contract GenServer’s address

Sets the address for the contract specified by the name argument

Use a Contract’s method with an eth_call

Use a Contract’s method with an eth_call. Returns a Task to be awaited

Returns a specification to start this module under a supervisor

Deploys contracts with given arguments

Installs a filter on the Ethereum node. This also formats the parameters, and saves relevant information to format event logs

Using saved information related to the filter id, event logs are formatted properly

Invoked when the server is started. start_link/3 or start/3 will block until it returns

Registers the contract with the ContractManager process. Only :abi is required field

Use a Contract’s method with an eth_sendTransaction

Use a Contract’s method with an eth_sendTransaction. Returns a Task to be awaited

Begins the Contract process to manage all interactions with smart contracts

Returns a formatted transaction receipt for the given transaction hash(id)

Uninstalls the filter, and deletes the data associated with the filter id

Link to this section Functions

Link to this function address(name) View Source
address(keyword()) :: {:ok, binary()}

Returns the current Contract GenServer’s address

Link to this function at(name, address) View Source
at(keyword(), binary()) :: :ok

Sets the address for the contract specified by the name argument

Link to this function call(contract_name, method_name, args \\ []) View Source
call(keyword(), keyword(), []) :: {:ok, any()}

Use a Contract’s method with an eth_call

Link to this function call_async(contract_name, method_name, args \\ []) View Source
call_async(keyword(), keyword(), []) :: {:ok, any()}

Use a Contract’s method with an eth_call. Returns a Task to be awaited.

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function deploy(name, args) View Source
deploy(keyword(), []) :: {:ok, binary(), []}

Deploys contracts with given arguments

Link to this function deploy_helper(bin, abi, args) View Source
Link to this function eth_call_helper(address, abi, method_name, args) View Source
Link to this function eth_send_helper(address, abi, method_name, args, options) View Source
Link to this function filter(contract_name, event_name, event_data \\ %{}) View Source
filter(keyword(), binary(), %{}) :: {:ok, binary()}

Installs a filter on the Ethereum node. This also formats the parameters, and saves relevant information to format event logs.

Link to this function from_block_helper(event_data) View Source
Link to this function get_event_attributes(state, contract_name, event_name) View Source
Link to this function get_filter_changes(filter_id) View Source
get_filter_changes(binary()) :: {:ok, []}

Using saved information related to the filter id, event logs are formatted properly

Invoked when the server is started. start_link/3 or start/3 will block until it returns.

args is the argument term (second argument) passed to start_link/3.

Returning {:ok, state} will cause start_link/3 to return {:ok, pid} and the process to enter its loop.

Returning {:ok, state, timeout} is similar to {:ok, state} except handle_info(:timeout, state) will be called after timeout milliseconds if no messages are received within the timeout.

Returning {:ok, state, :hibernate} is similar to {:ok, state} except the process is hibernated before entering the loop. See c:handle_call/3 for more information on hibernation.

Returning {:ok, state, {:continue, continue}} is similar to {:ok, state} except that immediately after entering the loop the c:handle_continue/2 callback will be invoked with the value continue as first argument.

Returning :ignore will cause start_link/3 to return :ignore and the process will exit normally without entering the loop or calling c:terminate/2. If used when part of a supervision tree the parent supervisor will not fail to start nor immediately try to restart the GenServer. The remainder of the supervision tree will be started and so the GenServer should not be required by other processes. It can be started later with Supervisor.restart_child/2 as the child specification is saved in the parent supervisor. The main use cases for this are:

  • The GenServer is disabled by configuration but might be enabled later.
  • An error occurred and it will be handled by a different mechanism than the Supervisor. Likely this approach involves calling Supervisor.restart_child/2 after a delay to attempt a restart.

Returning {:stop, reason} will cause start_link/3 to return {:error, reason} and the process to exit with reason reason without entering the loop or calling c:terminate/2.

Callback implementation for GenServer.init/1.

Link to this function register(name, contract_info) View Source
register(keyword(), []) :: :ok

Registers the contract with the ContractManager process. Only :abi is required field.

Link to this function send(contract_name, method_name, args, options) View Source
send(keyword(), keyword(), [], %{}) :: {:ok, binary()}

Use a Contract’s method with an eth_sendTransaction

Link to this function send_async(contract_name, method_name, args, options) View Source
send_async(keyword(), keyword(), [], %{}) :: {:ok, binary()}

Use a Contract’s method with an eth_sendTransaction. Returns a Task to be awaited.

Link to this function start_link() View Source
start_link() :: {:ok, pid()}

Begins the Contract process to manage all interactions with smart contracts

Link to this function tx_receipt(contract_name, tx_hash) View Source
tx_receipt(keyword(), binary()) :: %{}

Returns a formatted transaction receipt for the given transaction hash(id)

Link to this function uninstall_filter(filter_id) View Source
uninstall_filter(binary()) :: :ok

Uninstalls the filter, and deletes the data associated with the filter id