eosrpc v0.4.2 EOSRPC.Chain View Source

EOSRPC Wallet Wrapper for Elixir

Based on: https://developers.eos.io/eosio-nodeos/v1.2.0/reference on Chain section

Link to this section Summary

Functions

Serialize back binary hex to json

Serialize json to binary hex. The resulting binary hex is usually used for the data field in push_transaction

Perform a DELETE request

Perform a DELETE request

Perform a GET request

Perform a GET request

Get information related to an account

Get information related to a block

Fetch smart contract code

Get latest information related to a node

Get required keys to sign a transaction from list of your keys

Fetch smart contract data from an account

Perform a HEAD request

Perform a HEAD request

Perform a OPTIONS request

Perform a OPTIONS request

Perform a PATCH request

Perform a PATCH request

Perform a POST request

Perform a POST request

This method expects a transaction in JSON format and will attempt to apply it to the blockchain,

Perform a PUT request

Perform a PUT request

Perform request and raise in case of error

Perform a TRACE request

Perform a TRACE request

Link to this section Types

Link to this type option() View Source
option() ::
  {:method, Tesla.Env.method()}
  | {:url, Tesla.Env.url()}
  | {:query, Tesla.Env.query()}
  | {:headers, Tesla.Env.headers()}
  | {:body, Tesla.Env.body()}
  | {:opts, Tesla.Env.opts()}

Link to this section Functions

Link to this function abi_bin_to_json!(code, action, binargs) View Source
Link to this function abi_bin_to_json(code, action, binargs) View Source

Serialize back binary hex to json.

Link to this function abi_json_to_bin!(code, action, args) View Source
Link to this function abi_json_to_bin(code, action, args) View Source

Serialize json to binary hex. The resulting binary hex is usually used for the data field in push_transaction.

Perform a DELETE request.

See request!/1 or request!/2 for options definition.

delete!("/users")
delete!("/users", query: [scope: "admin"])
delete!(client, "/users")
delete!(client, "/users", query: [scope: "admin"])

Perform a DELETE request.

See request/1 or request/2 for options definition.

delete("/users")
delete("/users", query: [scope: "admin"])
delete(client, "/users")
delete(client, "/users", query: [scope: "admin"])

Perform a GET request.

See request!/1 or request!/2 for options definition.

get!("/users")
get!("/users", query: [scope: "admin"])
get!(client, "/users")
get!(client, "/users", query: [scope: "admin"])

Perform a GET request.

See request/1 or request/2 for options definition.

get("/users")
get("/users", query: [scope: "admin"])
get(client, "/users")
get(client, "/users", query: [scope: "admin"])
Link to this function get_account!(account_name) View Source
Link to this function get_account(account_name) View Source

Get information related to an account.

Link to this function get_block!(block_num_or_id) View Source
Link to this function get_block(block_num_or_id) View Source

Get information related to a block.

Fetch smart contract code.

Get latest information related to a node

Link to this function get_required_keys!(transaction_data, available_keys) View Source
Link to this function get_required_keys(transaction_data, available_keys) View Source

Get required keys to sign a transaction from list of your keys.

Link to this function get_table_rows!(contract, scope, table, json \\ true) View Source
Link to this function get_table_rows(contract, scope, table, json \\ true) View Source

Fetch smart contract data from an account.

Perform a HEAD request.

See request!/1 or request!/2 for options definition.

head!("/users")
head!("/users", query: [scope: "admin"])
head!(client, "/users")
head!(client, "/users", query: [scope: "admin"])

Perform a HEAD request.

See request/1 or request/2 for options definition.

head("/users")
head("/users", query: [scope: "admin"])
head(client, "/users")
head(client, "/users", query: [scope: "admin"])
Link to this function options!(client, url, opts) View Source

Perform a OPTIONS request.

See request!/1 or request!/2 for options definition.

options!("/users")
options!("/users", query: [scope: "admin"])
options!(client, "/users")
options!(client, "/users", query: [scope: "admin"])

Perform a OPTIONS request.

See request/1 or request/2 for options definition.

options("/users")
options("/users", query: [scope: "admin"])
options(client, "/users")
options(client, "/users", query: [scope: "admin"])

Perform a PATCH request.

See request!/1 or request!/2 for options definition.

patch!("/users", %{name: "Jon"})
patch!("/users", %{name: "Jon"}, query: [scope: "admin"])
patch!(client, "/users", %{name: "Jon"})
patch!(client, "/users", %{name: "Jon"}, query: [scope: "admin"])

Perform a PATCH request.

See request/1 or request/2 for options definition.

patch("/users", %{name: "Jon"})
patch("/users", %{name: "Jon"}, query: [scope: "admin"])
patch(client, "/users", %{name: "Jon"})
patch(client, "/users", %{name: "Jon"}, query: [scope: "admin"])

Perform a POST request.

See request!/1 or request!/2 for options definition.

post!("/users", %{name: "Jon"})
post!("/users", %{name: "Jon"}, query: [scope: "admin"])
post!(client, "/users", %{name: "Jon"})
post!(client, "/users", %{name: "Jon"}, query: [scope: "admin"])

Perform a POST request.

See request/1 or request/2 for options definition.

post("/users", %{name: "Jon"})
post("/users", %{name: "Jon"}, query: [scope: "admin"])
post(client, "/users", %{name: "Jon"})
post(client, "/users", %{name: "Jon"}, query: [scope: "admin"])
Link to this function push_transaction!(signed_transaction) View Source
Link to this function push_transaction(signed_transaction) View Source

This method expects a transaction in JSON format and will attempt to apply it to the blockchain,

signed_transaction should be a map like this JSON:

{
  "signatures": [
    "EOSKZ4pTehVfqs92wujRp34qRAvUjKJrUyufZfJDo9fdBLzhieyfUSUJpKz1Z12rxh1gTQZ4BcWvKourzxCLb2fMsvN898KSn"
  ],
  "compression": "none",
  "transaction": {
    "context_free_actions": [],
    "delay_sec": 0,
    "expiration": "2018-09-25T06:28:49",
    "max_cpu_usage_ms": 0,
    "net_usage_words": 0,
    "ref_block_num": 32697,
    "ref_block_prefix": 32649123,
    "transaction_extensions": []
    "actions": [
      {
        "account": "eosio",
        "name": "transfer",
        "authorization": [
          {
            "actor": "eosio",
            "permission": "active"
          }
        ],
        "data": "0000000050a430550000000000003ab60a000000000000000045434f0000000000"
      }
    ]
  }
}
Link to this function push_transactions!(signed_transactions) View Source
Link to this function push_transactions(signed_transactions) View Source

Perform a PUT request.

See request!/1 or request!/2 for options definition.

put!("/users", %{name: "Jon"})
put!("/users", %{name: "Jon"}, query: [scope: "admin"])
put!(client, "/users", %{name: "Jon"})
put!(client, "/users", %{name: "Jon"}, query: [scope: "admin"])

Perform a PUT request.

See request/1 or request/2 for options definition.

put("/users", %{name: "Jon"})
put("/users", %{name: "Jon"}, query: [scope: "admin"])
put(client, "/users", %{name: "Jon"})
put(client, "/users", %{name: "Jon"}, query: [scope: "admin"])
Link to this function request!(client \\ %Tesla.Client{}, options) View Source
request!(Tesla.Env.client(), [option()]) :: Tesla.Env.t() | no_return()

Perform request and raise in case of error.

This is similar to request/2 behaviour from Tesla 0.x

See request/2 for list of available options.

Link to this function request(client \\ %Tesla.Client{}, options) View Source

Perform a request

Options:

  • :method - the request method, one of [:head, :get, :delete, :trace, :options, :post, :put, :patch]
  • :url - either full url e.g. “http://example.com/some/path” or just “/some/path” if using Tesla.Middleware.BaseUrl
  • :query - a keyword list of query params, e.g. [page: 1, per_page: 100]
  • :headers - a keyworld list of headers, e.g. [{"content-type", "text/plain"}]
  • :body - depends on used middleware:

    • by default it can be a binary
    • if using e.g. JSON encoding middleware it can be a nested map
    • if adapter supports it it can be a Stream with any of the above
  • :opts - custom, per-request middleware or adapter options

Examples:

ExampleApi.request(method: :get, url: "/users/path")

You can also use shortcut methods like:

ExampleApi.get("/users/1")

or

ExampleApi.post(client, "/users", %{name: "Jon"})

Perform a TRACE request.

See request!/1 or request!/2 for options definition.

trace!("/users")
trace!("/users", query: [scope: "admin"])
trace!(client, "/users")
trace!(client, "/users", query: [scope: "admin"])

Perform a TRACE request.

See request/1 or request/2 for options definition.

trace("/users")
trace("/users", query: [scope: "admin"])
trace(client, "/users")
trace(client, "/users", query: [scope: "admin"])