eosio-curl-command

eosio-curl-command

/**
@defgroup eosiorpc RPC Interface
@brief Describes how to interface with eosd over HTTP RPC

@section tableofcontent Table Of Contents
- [Configuration](#configuration)
- [Chain API](#chainrpc)
  - [get_info](#v1chaingetinfo)
  - [get_block](#v1chaingetblock)
  - [get_account](#v1chaingetaccount)
  - [get_code](#v1chaingetcode)
  - [get_table_rows](#v1chaingettablerows)
  - [abi_json_to_bin](#v1chainabijsontobin)
  - [abi_bin_to_json](#v1chainabibintojson)
  - [push_transaction](#v1chainpushtransaction)
  - [push_transactions](#v1chainpushtransactions)
  - [get_required_keys](#v1chaingetrequiredkeys)
- [Wallet API](#walletrpc)
  - [wallet_create](#v1walletcreate)
  - [wallet_open](#v1walletopen)
  - [wallet_lock](#v1walletlock)
  - [wallet_lock_all](#v1walletlockall)
  - [wallet_import_key](#v1walletimportkey)
  - [wallet_list](#v1walletlist)
  - [wallet_list_keys](#v1walletlistkeys)
  - [wallet_get_public_keys](#v1walletgetpublickeys)
  - [wallet_set_timeout](#v1walletsettimeout)
  - [wallet_sign_trx](#v1walletsigntrx)

@section configuration Configuration

`eosd` uses a REST RPC interface where plugins can register their own endpoints with the API server. This page
will explain how to use some of the APIs to get information about the blockchain and send transactions.

Before you can query `eosd` you must first enable the necessary API plugin(s). Depending on which API you want to enable, add the following line to your `eosd`'s `config.ini`:
```
plugin = eosio::chain_api_plugin // Enable Chain API
plugin = eosio::wallet_api_plugin // Enable Wallet API
```
Alternatively, for Wallet API, you can also have the wallet functionality separate from `eosd`, by running `eos-walletd` separately.

For the following guide, we will assume that we have `eosd` running on `127.0.0.1:8888` (Chain API Plugin enabled, Wallet API Plugin disabled) and `eos-walletd` running on `127.0.0.1:8889`.

===

@section chainrpc Chain API


@subsection v1chaingetinfo get_info

Get latest information related to a node

@subsubsection examplegetinfo  Example get_info Usage

```
curl http://127.0.0.1:8888/v1/chain/get_info
```

@subsubsection examplegetinforesult  Example get_info Result

```
{
  "server_version": "b2eb1667",
  "head_block_num": 259590,
  "last_irreversible_block_num": 259573,
  "head_block_id": "0003f60677f3707f0704f16177bf5f007ebd45eb6efbb749fb1c468747f72046",
  "head_block_time": "2017-12-10T17:05:36",
  "head_block_producer": "initp",
  "recent_slots": "1111111111111111111111111111111111111111111111111111111111111111",
  "participation_rate": "1.00000000000000000"
}
```

@subsection v1chaingetblock get_block

Get information related to a block.

@subsubsection examplegetblock  Example get_block Usage
```
$ curl  http://127.0.0.1:8888/v1/chain/get_block -X POST -d '{"block_num_or_id":5}'
$ curl  http://127.0.0.1:8888/v1/chain/get_block -X POST -d '{"block_num_or_id":0000000445a9f27898383fd7de32835d5d6a978cc14ce40d9f327b5329de796b}'
```

@subsubsection examplegetblockresult  Example get_block Result
```
{
  "previous": "0000000445a9f27898383fd7de32835d5d6a978cc14ce40d9f327b5329de796b",
  "timestamp": "2017-07-18T20:16:36",
  "transaction_merkle_root": "0000000000000000000000000000000000000000000000000000000000000000",
  "producer": "initf",
  "producer_changes": [ ],
  "producer_signature": "204cb94b3186c3b4a7f88be4e9db9f8af2ffdb7ef0f27a065c8177a5fcfacf876f684e59c39fb009903c0c59220b147bb07f1144df1c65d26c57b534a76dd29073",
  "cycles": [ ],
  "id":"000000050c0175cbf218a70131ddc3c3fab8b6e954edef77e0bfe7c36b599b1d",
  "block_num":5,
  "ref_block_prefix":27728114
}
```


@subsection v1chaingetaccount get_account

Get information related to an account.

@subsubsection examplegetaccount  Example get_account Usage
```
$ curl  http://127.0.0.1:8888/v1/chain/get_account -X POST -d '{"account_name":"inita"}'
```

@subsubsection examplegetaccountresult  Example get_account Result
```
{
  "name": "inita",
  "eos_balance": "999998.9574 EOS",
  "staked_balance": "0.0000 EOS",
  "unstaking_balance": "0.0000 EOS",
  "last_unstaking_time": "2106-02-07T06:28:15",
  "permissions": [
    {
      "name": "active",
      "parent": "owner",
      "required_auth": {
        "threshold": 1,
        "keys": [
          {
            "key": "EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV",
            "weight": 1
          }
        ],
        "accounts": []
      }
    },
    {
      "name": "owner",
      "parent": "owner",
      "required_auth": {
        "threshold": 1,
        "keys": [
          {
            "key": "EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV",
            "weight": 1
          }
        ],
        "accounts": []
      }
    }
  ]
}
```


@subsection v1chaingetcode get_code

Fetch smart contract code.

@subsubsection examplegetcode Example get_code Usage
```
$ curl  http://127.0.0.1:8888/v1/chain/get_code -X POST -d '{"account_name":"currency"}'
```

@subsubsection examplegetcoderesult  Example get_code Result
```
{
  "name":"currency",
  "code_hash":"a1c8c84b4700c09c8edb83522237439e33cf011a4d7ace51075998bd002e04c9",
  "wast":"(module\n  (type $0 (func (param i64 i64 i32) (result i32)))\n ...truncated",
  "abi": {
  "types": [{
      "new_type_name": "account_name",
      "type": "name"
    }
  ],
  "structs": [{
      "name": "transfer",
      "base": "",
      "fields": [
        {"name":"from", "type":"account_name"},
        {"name":"to", "type":"account_name"},
        {"name":"quantity", "type":"uint64"}
      ]
    },{
      "name": "account",
      "base": "",
      "fields": [
        {"name":"key", "type":"name"},
        {"name":"balance", "type":"uint64"}
      ]
    }
  ],
  "actions": [{
      "name": "transfer",
      "type": "transfer"
    }
  ],
  "tables": [{
      "name": "account",
      "type": "account",
      "index_type": "i64",
      "key_names" : ["key"],
      "key_types" : ["name"]
    }
  ]
}
```


@subsection v1chaingettablerows get_table_rows

Fetch smart contract data from an account.

@subsubsection examplegettablerows get_table_rows Usage
```
$ curl  http://127.0.0.1:8888/v1/chain/get_table_rows -X POST -d '{"scope":"inita", "code":"currency", "table":"account", "json": true}'
$ curl  http://127.0.0.1:8888/v1/chain/get_table_rows -X POST -d '{"scope":"inita", "code":"currency", "table":"account", "json": true, "lower_bound":0, "upper_bound":-1, "limit":10}'
```

@subsubsection examplegettablerowsresult  Example get_table_rows Result
```
{
  "rows": [
    {
      "account": "account",
      "balance": 1000
    }
  ],
  "more": false
}
```


@subsection v1chaingeabijsontobin abi_json_to_bin

Serialize json to binary hex. The resulting binary hex is usually used for the data field in [push_transaction](#v1chainpushtransaction).

@subsubsection exampleabijsontobin Example abi_json_to_bin Usage
```
$ curl  http://127.0.0.1:8888/v1/chain/abi_json_to_bin -X POST -d '{"code":"currency", "action":"transfer", "args":{"from":"initb", "to":"initc", "quantity":1000}}'
```

@subsubsection exampleabijsontobinresult  Example abi_json_to_bin Result
```
{
  "binargs": "000000008093dd74000000000094dd74e803000000000000",
  "required_scope": [],
  "required_auth": []
}
```


@subsection v1chaingeabibintojson abi_bin_to_json

Serialize back binary hex to json.

@subsubsection exampleabibintojson Example abi_bin_to_json Usage
```
$ curl  http://127.0.0.1:8888/v1/chain/abi_bin_to_json -X POST -d '{"code":"currency", "action":"transfer", "binargs":"000000008093dd74000000000094dd74e803000000000000"}'
```

@subsubsection exampleabibintojsonresult  Example abi_bin_to_json Result
```
{
  "args": {
    "from": "initb",
    "to": "initc",
    "quantity": 1000
  },
  "required_scope": [],
  "required_auth": []
}
```


@subsection v1chainpushtransaction push_transaction

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

<b>Success Response</b>
<p>
On success it will return HTTP 200 and the transaction ID.
</p>

```

{
  'transaction_id' : "..."
}


```

Just because the transaction is pushed locally does not mean that the transaction has been incorporated into a block.


<b>Error Response</b>
<p>
If an error occurs it will return either HTTP 400 (Invalid arguments) or 500 (Internal Server Error)
</p>

```

HTTP/1.1 500 Internal Server Error
Content-Length: 1466

...error message...

```

@subsubsection examplepushtrx Example push_transaction Usage
This example assumes a transfer operation. The `ref_block_num` and `ref_block_prefix` here are provided as a result of `/v1/chain/get_block` of the last_irreversible_block.
You also need to use /v1/wallet/sign_transaction to get the right signature.
```
curl  http://localhost:8888/v1/chain/push_transaction -X POST -d '{"ref_block_num":"100","ref_block_prefix":"137469861","expiration":"2017-09-25T06:28:49","scope":["initb","initc"],"actions":[{"code":"currency","type":"transfer","recipients":["initb","initc"],"authorization":[{"account":"initb","permission":"active"}],"data":"000000000041934b000000008041934be803000000000000"}],"signatures":[],"authorizations":[]}'
```


@subsection v1chainpushtransactions push_transactions

This method push multiple transactions at once.

@subsubsection examplepushtrxs Example push_transactions Usage
```
curl  http://localhost:8888/v1/chain/push_transaction -X POST -d '[{"ref_block_num":"101","ref_block_prefix":"4159312339","expiration":"2017-09-25T06:28:49","scope":["initb","initc"],"actions":[{"code":"currency","type":"transfer","recipients":["initb","initc"],"authorization":[{"account":"initb","permission":"active"}],"data":"000000000041934b000000008041934be803000000000000"}],"signatures":[],"authorizations":[]}, {"ref_block_num":"101","ref_block_prefix":"4159312339","expiration":"2017-09-25T06:28:49","scope":["inita","initc"],"actions":[{"code":"currency","type":"transfer","recipients":["inita","initc"],"authorization":[{"account":"inita","permission":"active"}],"data":"000000008040934b000000008041934be803000000000000"}],"signatures":[],"authorizations":[]}]'
```


@subsection v1chaingetrequiredkeys get_required_keys

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

@subsubsection examplegetrequiredkeys  Example get_required_keys Usage
```
curl  http://localhost:8888/v1/chain/get_required_keys -X POST -d '{"transaction": {"ref_block_num":"100","ref_block_prefix":"137469861","expiration":"2017-09-25T06:28:49","scope":["initb","initc"],"actions":[{"code":"currency","type":"transfer","recipients":["initb","initc"],"authorization":[{"account":"initb","permission":"active"}],"data":"000000000041934b000000008041934be803000000000000"}],"signatures":[],"authorizations":[]}, "available_keys":["EOS4toFS3YXEQCkuuw1aqDLrtHim86Gz9u3hBdcBw5KNPZcursVHq","EOS7d9A3uLe6As66jzN8j44TXJUqJSK3bFjjEEqR4oTvNAB3iM9SA","EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV"]}'
```

@subsubsection examplegetrequiredkeysresult  Example get_required_keys Result
```
{
  "required_keys": [
    "EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV"
  ]
}
```

@section walletrpc Wallet API

@subsection v1walletcreate wallet_create

Create a new wallet with the given name

@subsubsection examplewalletcreate Example wallet_create Usage
```
$ curl http://localhost:8888/v1/wallet/create -X POST -d '"default"'
```

@subsubsection examplewalletcreateresult  Example wallet_create Result
This command will return the password that can be used to unlock the wallet in the future
```
PW5KFWYKqvt63d4iNvedfDEPVZL227D3RQ1zpVFzuUwhMAJmRAYyX
```

@subsection v1walletcreatekey wallet_create_key

Creates a key within the specified wallet, wallet must be opened and unlocked.
Param are: 1.name of the wallet to create key in; 2. type of key to create, currently we support two values: K1 and R1

@subsubsection examplewalletcreatekey Example wallet_create_key Usage
```
$ curl http://localhost:8888/v1/wallet/create_key -X POST -d '["default","K1"]'
```

@subsubsection examplewalletcreatekeyresult  Example wallet_create_key Result
This command will return the public key of the created key
```
EOS6GZE1xeo6jX2AtP2Z6WTcxawQMH7cyYMNpG6Q3q7s514zyRhgo
```

@subsection v1walletopen wallet_open

Open an existing wallet of the given name

@subsubsection examplewalletopen Example wallet_open Usage
```
$ curl http://localhost:8888/v1/wallet/open -X POST -d '"default"'
```

@subsubsection examplewalletopenresult  Example wallet_open Result
```
{}
```


@subsection v1walletlock wallet_lock

Lock a wallet of the given name

@subsubsection examplewalletlock Example wallet_lock Usage
```
$ curl http://localhost:8888/v1/wallet/lock -X POST -d '"default"'
```

@subsubsection examplewalletlockresult  Example wallet_lock Result
```
{}
```


@subsection v1walletlockall wallet_lock_all

Lock all wallets

@subsubsection examplewalletlockall Example wallet_lock_all Usage
```
$ curl http://localhost:8888/v1/wallet/lock_all
```

@subsubsection examplewalletlockallresult  Example wallet_lock_all Result
```
{}
```

@subsection v1walletunlock wallet_unlock

Unlock a wallet with the given name and password

@subsubsection examplewalletunlock Example wallet_unlock Usage
```
$ curl http://localhost:8888/v1/wallet/unlock -X POST -d '["default", "PW5KFWYKqvt63d4iNvedfDEPVZL227D3RQ1zpVFzuUwhMAJmRAYyX"]'
```

@subsubsection examplewalletunlockresult  Example wallet_unlock Result
```
{}
```

@subsection v1walletimport wallet_import_key

Import a private key to the wallet of the given name

@subsubsection examplewalletimport Example wallet_import_key Usage
```
$ curl http://localhost:8888/v1/wallet/import_key -X POST -d '["default","5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3"]'
```

@subsubsection examplewalletimportresult  Example wallet_import_key Result
```
{}
```

@subsection v1walletlist wallet_list

List all wallets

@subsubsection examplewalletlist Example wallet_list Usage
```
$ curl http://localhost:8888/v1/wallet/list_wallets
```

@subsubsection examplewalletlistresult  Example wallet_list Result
```
["default *"]
```

@subsection v1walletlistkeys wallet_list_keys

List all key pairs across all wallets

@subsubsection examplewalletlistkeys Example wallet_list_keys Usage
```
$ curl http://localhost:8888/v1/wallet/list_keys
```

@subsubsection examplewalletlistkeysresult  Example wallet_list_keys Result
```
[["EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV","5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3"]]
```

@subsection v1walletgetpublickeys wallet_get_public_keys

List all public keys across all wallets

@subsubsection examplewalletgetpublickeys Example wallet_get_public_keys Usage
```
$ curl http://localhost:8888/v1/wallet/get_public_keys
```

@subsubsection examplewallegetpublickeysresult  Example wallet_get_public_keys Result
```
["EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV"]
```

@subsection v1walletsettimeout wallet_set_timeout

Set wallet auto lock timeout (in seconds)

@subsubsection examplewalletsettimeout Example wallet_set_timeout Usage
```
$ curl http://localhost:8888/v1/wallet/set_timeout -X POST -d '10'
```

@subsubsection examplewalletsettimeoutresult  Example wallet_set_timeout Result
```
{}
```

@subsection v1walletsigntrx wallet_sign_trx

Sign transaction given an array of transaction, require public keys, and chain id

@subsubsection examplewalletsigntrx Example wallet_sign_trx Usage
```
$ curl http://localhost:8888/v1/wallet/sign_transaction -X POST -d '[{"ref_block_num":21453,"ref_block_prefix":3165644999,"expiration":"2017-12-08T10:28:49","scope":["initb","initc"],"read_scope":[],"messages":[{"code":"currency","type":"transfer","authorization":[{"account":"initb","permission":"active"}],"data":"000000008093dd74000000000094dd74e803000000000000"}],"signatures":[]}, ["EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV"], ""]'
```

@subsubsection examplewalletsigntrxresult  Example wallet_sign_trx Result
```
{
  "ref_block_num": 21453,
  "ref_block_prefix": 3165644999,
  "expiration": "2017-12-08T10:28:49",
  "scope": [
    "initb",
    "initc"
  ],
  "read_scope": [],
  "messages": [
    {
      "code": "currency",
      "type": "transfer",
      "authorization": [
        {
          "account": "initb",
          "permission": "active"
        }
      ],
      "data": "000000008093dd74000000000094dd74e803000000000000"
    }
  ],
  "signatures": [
    "1f393cc5ce6a6951fb53b11812345bcf14ffd978b07be386fd639eaf440bca7dca16b14833ec661ca0703d15e55a2a599a36d55ce78c4539433f6ce8bcee0158c3"
  ]
}
```

*/