Supported Operations

An Operation is internal type that blockchain is working with. Every transaction consists of some static fields like “ref_block_num”, “expiration”, “signatures”, etc… that are always present + list of “operations” that may vary and actually express what is such transaction really supposed to write into blockchain.

Each type of operation express different data structure that can be sent into blockchain and saved or somehow change the blockchain state. The main API call to send transaction with user defined operations is: alexandria_api.broadcast_transaction
There are also simplified methods that enable this functionality as well but are more suited for testing than production development:
alexandria_api.send_and_sign_operation
alexandria_api.send_and_sign_transaction

All other alexandria_api method’s (except of a few helper method to create transaction, etc…) are ONLY FOR READING DATA from blockchain !!!

Final required format of the operations is always in "Example. op" section.

We provide simplified helper methods that return the required format of some of the supported operations, but applications should not call these methods at all as the format does not change. Instead, SDK should take care of that.

List of supported operations:

• transfer
• transfer_to_vesting
• withdraw_vesting
• transfer_from_promotion_pool
• account_create
• account_update
• account_delete
• request_account_recovery
• recover_account
• change_recovery_account
• reset_account
• set_reset_account
• application_create
• application_update
• application_delete
• buy_application
• cancel_application_buying
• custom_binary
• custom_json
• sponsor_fees
• witness_stop
• witness_update
• account_witness_proxy
• witness_set_properties
• admin_witness_update
• account_witness_vote
• feed_publish
• escrow_transfer
• escrow_approve
• escrow_dispute
• escrow_release

transfer

Helper API simplified call to create this operation in required format exists! See below!

alexandria_api.transfer

Transfers SOPHIATX from one account to another. API call creates "transfer" operation in requested json format.

Request:

Result:

Query Parameters JSON

{
  "from": "",
  "to": "",
  "amount": "0.000000 SPHTX",
  "memo": ""
}

Example Op. (& Expected Response JSON)

{
  "op": [
    "transfer",
    {
      "fee": "0.000000 SPHTX",
      "from": "",
      "to": "",
      "amount": "0.000000SPHTX",
      "memo": ""
    }
  ]
}

Real Example curl

curl -s --data '{"jsonrpc": "2.0", "method": "alexandria_api.transfer", "params": {"from": "7HLPQ1kpnAIWawkAEgcoN4I7qJY", "to": "YWV2w-Q5eB3e0gt_nKS1m85sc0U", "amount": "1000.000000 SPHTX","memo": "some note"}, "id": 1}' https://API_URL

Response curl

'{
  "jsonrpc": "2.0",
  "result": {
    "op": [
      "transfer",
      {
        "fee": "0.000000 SPHTX",
        "from": "user1",
        "to": "7HLPQ1kpnAIWawkAEgcoN4I7qJY",
        "amount": "1000.000000 SPHTX",
        "memo": "some note"
      }
    ]
  },
  "id": 1
}'

transfer_to_vesting

Helper API simplified call to create this operation in required format exists! See below!

alexandria_api.transfer_to_vesting

Transfer SPHTX into a vesting fund represented by vesting shares (VESTS). VESTS are required to vesting for a minimum of one coin year and can be withdrawn once a week over a two year withdraw period. VESTS are protected against dilution up until 90% of SPHTX is vesting.
API call creates "transfer_to_vesting" operation in requested json format.

Request:

Result:

Query Parameters JSON

{"from": "", "to": "", "amount": "0.000000 SPHTX"}

Example Op. (& Expected Response JSON)

{
  "op": [
    "transfer_to_vesting",
    {
      "fee": "0.000000 SPHTX",
      "from": "",
      "to": "",
      "amount": "0.000000SPHTX"
    }
  ]
}

Default (Incomplete params values) Example curl

curl -s --data '{"jsonrpc": "2.0", "method": "alexandria_api.transfer_to_vesting", "params": {"from":"","to":"","amount":"0.000000 SPHTX"}, "id": 1}' https://API_URL

withdraw_vesting

Helper API simplified call to create this operation in required format exists! See below!

alexandria_api.withdraw_vesting

Set up a vesting withdraw request. The request is fulfilled once a week over the next two year (104 weeks).
API call creates "withdraw_vesting" operation in requested json format.

Request:

Result:

Query Parameters JSON

{"from": "", "vesting_shares": "0.000000 SPHTX"}

Example Op. (& Expected Response JSON)

{
  "op": [
    "withdraw_vesting",
    {
      "fee": "0.000000 SPHTX",
      "account": "",
      "vesting_shares": "0.000000SPHTX"
    }
  ]
}

Default (Incomplete params values) Example curl

curl -s --data '{"jsonrpc": "2.0", "method": "alexandria_api.withdraw_vesting", "params": {"from":"","vesting_shares":"0.000000 SPHTX"}, "id": 1}' https://API_URL

transfer_from_promotion_pool

Recovers funds from the promotion pool. Only initminer can do that.

Example Op.

"{\"op\":[\"transfer_from_promotion_pool\",{...}]}"

account_create

Helper API simplified call to create this operation in required format exists! See below!

alexandria_api.create_account

Creates new account in blockchain.
API call creates operation ‘account_create’ in required json format

Request

Response

Query Parameters JSON

{
  "creator": "",
  "name_seed": "",
  "json_meta": "",
  "owner": "SPH1111111111111111111111111111111114T1Anm",
  "active": "SPH1111111111111111111111111111111114T1Anm",
  "memo": "SPH1111111111111111111111111111111114T1Anm"
}

Example Op. (& Expected Response JSON)

{
  "op": [
    "account_create",
    {
      "fee": "0.000000 SPHTX",
      "creator": "",
      "name_seed": "",
      "owner": {
        "weight_threshold": 0,
        "account_auths": [],
        "key_auths": []
      },
      "active": {
        "weight_threshold": 0,
        "account_auths": [],
        "key_auths": []
      },
      "memo_key": "SPH1111111111111111111111111111111114T1Anm",
      "json_metadata": ""
    }
  ]
}

Real Example curl

curl -s --data '{"jsonrpc": "2.0", "method": "alexandria_api.create_account", "params": {"creator": "user1","name_seed": "sophiatx_user","json_meta": "{\"data\":\"anything related to the sophiatx_user\"}","owner": "SPH7qASF1CfENDRWdKC5gQCktydRQM2aY3i1d9wFdu1fjpURgTxiw","active": "SPH5ekkeER1xi3EDoxoggo2ruMgPazKsGa8Pj44qrD326oDk5rgKP","memo": "SPH4vtSio7iGMggFboydFjgRZknPEH1BExcN3r4rjb9iznJQr7Mqy"}, "id": 1}' https://API_URL

Response curl

'{
  "jsonrpc": "2.0",
  "result": {
    "op": [
      "account_create",
      {
        "fee": "0.000000 SPHTX",
        "creator": "user1",
        "name_seed": "sophiatx_user",
        "owner": {
          "weight_threshold": 1,
          "account_auths": [],
          "key_auths": [
            [
              "SPH7qASF1CfENDRWdKC5gQCktydRQM2aY3i1d9wFdu1fjpURgTxiw",
              1
            ]
          ]
        },
        "active": {
          "weight_threshold": 1,
          "account_auths": [],
          "key_auths": [
            [
              "SPH5ekkeER1xi3EDoxoggo2ruMgPazKsGa8Pj44qrD326oDk5rgKP",
              1
            ]
          ]
        },
        "memo_key": "SPH4vtSio7iGMggFboydFjgRZknPEH1BExcN3r4rjb9iznJQr7Mqy",
        "json_metadata": "{\"data\":\"anything related to the sophiatx_user\"}"
      }
    ]
  },
  "id": 1
}'

account_update

Helper API simplified call to create this operation in required format exists! See below!

alexandria_api.update_account

Updates existing account in blockchain.
API call creates "account_update" operation in requested json format. Updates the keys of an existing account.

Request:

Result:

Query Parameters JSON

{
  "account_name": "",
  "json_meta": "",
  "owner": "SPH1111111111111111111111111111111114T1Anm",
  "active": "SPH1111111111111111111111111111111114T1Anm",
  "memo": "SPH1111111111111111111111111111111114T1Anm"
}

Example Op. (& Expected Response JSON)

{
  "op": [
    "account_update",
    {
      "fee": "0.000000 SPHTX",
      "account": "",
      "memo_key": "SPH1111111111111111111111111111111114T1Anm",
      "json_metadata": ""
    }
  ]
}

Default (Incomplete params values) Example curl

curl -s --data '{"jsonrpc": "2.0", "method": "alexandria_api.update_account", "params": {"account_name":"","json_meta":"","owner":"SPH1111111111111111111111111111111114T1Anm","active":"SPH1111111111111111111111111111111114T1Anm","memo":"SPH1111111111111111111111111111111114T1Anm"}, "id": 1}' https://API_URL

account_delete

Helper API simplified call to create this operation in required format exists! See below!

alexandria_api.delete_account

Deletes existing account in blockchain.
API call creates “account_delete” operation in requested json format.

Request:

Response:

Query Parameters JSON

{"account_name": ""}

Example Op. (& Expected Response JSON)

{
  "op": [
    "account_delete",
    {"fee": "0.000000 SPHTX", "account": ""}
  ]
}

Default (Incomplete params values) Example curl

curl -s --data '{"jsonrpc": "2.0", "method": "alexandria_api.delete_account", "params": {"account_name":""}, "id": 1}' https://API_URL

request_account_recovery

All account recovery requests come from a listed recovery account. This is secure based on the assumption that only a trusted account should be a recovery account. It is the responsibility of the recovery account to verify the identity of the account holder of the account to recover by whichever means they have agreed upon. The blockchain assumes identity has been verified when this operation is broadcast.

This operation creates an account recovery request which the account to recover has 24 hours to respond to before the request expires and is invalidated.

There can only be one active recovery request per account at any one time. Pushing this operation for an account to recover when it already has an active request will either update the request to a new new owner authority and extend the request expiration to 24 hours from the current head block time or it will delete the request. To cancel a request, simply set the weight threshold of the new owner authority to 0, making it an open authority.

Additionally, the new owner authority must be satisfiable. In other words, the sum of the key weights must be greater than or equal to the weight threshold.

This operation only needs to be signed by the the recovery account. The account to recover confirms its identity to the blockchain in the recover account operation.

Notes

Example Op.

{
  "op": [
    "request_account_recovery",
    {
      "recovery_account": "sophiatx",
      "account_to_recover": "alice",
      "new_owner_authority": {
        "weight_threshold": 1,
        "account_auths": [],
        "key_auths": [
          [
            "STM6LYxj96zdypHYqgDdD6Nyh2NxerN3P1Mp3ddNm7gci63nfrSuZ",
            1
          ]
        ]
      },
      "extensions": []
    }
  ]
}

recover_account

Recover an account to a new authority using a previous authority and verification of the recovery account as proof of identity. This operation can only succeed if there was a recovery request sent by the account’s recover account.

In order to recover the account, the account holder must provide proof of past ownership and proof of identity to the recovery account. Being able to satisfy an owner authority that was used in the past 30 days is sufficient to prove past ownership. The get_owner_history function in the database API returns past owner authorities that are valid for account recovery.

Proving identity is an off chain contract between the account holder and the recovery account. The recovery request contains a new authority which must be satisfied by the account holder to regain control. The actual process of verifying authority may become complicated, but that is an application level concern, not a blockchain concern.

This operation requires both the past and future owner authorities in the operation because neither of them can be derived from the current chain state. The operation must be signed by keys that satisfy both the new owner authority and the recent owner authority. Failing either fails the operation entirely.

If a recovery request was made inadvertantly, the account holder should contact the recovery account to have the request deleted.

The two setp combination of the account recovery request and recover is safe because the recovery account never has access to secrets of the account to recover. They simply act as an on chain endorsement of off chain identity. In other systems, a fork would be required to enforce such off chain state. Additionally, an account cannot be permanently recovered to the wrong account. While any owner authority from the past 30 days can be used, including a compromised authority, the account can be continually recovered until the recovery account is confident a combination of uncompromised authorities were used to recover the account. The actual process of verifying authority may become complicated, but that is an application level concern, not the blockchain’s concern.

Example Op.

{
  "op": [
    "recover_account",
    {
      "account_to_recover": "alice",
      "new_owner_authority": {
        "weight_threshold": 1,
        "account_auths": [],
        "key_auths": [
          [
            "STM7j3nhkhHTpXqLEvdx2yEGhQeeorTcxSV6WDL2DZGxwUxYGrHvh",
            1
          ]
        ]
      },
      "recent_owner_authority": {
        "weight_threshold": 1,
        "account_auths": [],
        "key_auths": [
          [
            "STM78Xth94gNxp8nmByFV2vNAhg9bsSdviJ6fQXUTFikySLK3uTxC",
            1
          ]
        ]
      },
      "extensions": []
    }
  ]
}

change_recovery_account

Each account lists another account as their recovery account. The recovery account has the ability to create account_recovery_requests for the account to recover. An account can change their recovery account at any time with a 30 day delay. This delay is to prevent an attacker from changing the recovery account to a malicious account during an attack. These 30 days match the 30 days that an owner authority is valid for recovery purposes.

On account creation the recovery account is set either to the creator of the account (The account that pays the creation fee and is a signer on the transaction) or to the empty string if the account was mined. An account with no recovery has the top voted witness as a recovery account, at the time the recover request is created. Note - This does mean the effective recovery account of an account with no listed recovery account can change at any time as witness vote weights. The top voted witness is explicitly the most trusted witness according to stake.

Example Op.

{
  "op": [
    "change_recovery_account",
    {
      "account_to_recover": "alice",
      "new_recovery_account": "bob",
      "extensions": []
    }
  ]
}

reset_account

This operation allows recovery_accoutn to change account_to_reset’s owner authority to new_owner_authority after 60 days of inactivity.

Example Op.

{
  "op": [
    "reset_account",
    {
      "reset_account": "alice",
      "account_to_reset": "bob",
      "new_owner_authority": {
        "weight_threshold": 1,
        "account_auths": [],
        "key_auths": [
          [
            "STM7j3nhkhHTpXqLEvdx2yEGhQeeorTcxSV6WDL2DZGxwUxYGrHvh",
            1
          ]
        ]
      }
    }
  ]
}

set_reset_account

This operation allows ‘account’ owner to control which account has the power to execute the ‘reset_account_operation’ after 60 days.

Example Op.

{
  "op": [
    "set_reset_account",
    {
      "account": "alice",
      "current_reset_account": "bob",
      "reset_account": "sophiatx"
    }
  ]
}

application_create

Helper API simplified call to create this operation in required format exists! See below!

alexandria_api.create_application

Creates custom application in blockchain
. API call returns “application_create” operation in required format. There is a fee associated with account creation that is paid by the creator. The current account creation fee can be found with the ‘info’ alexandria command.

Request

Response

Query Parameters JSON

{
  "author": "",
  "app_name": "",
  "url": "",
  "meta_data": "",
  "price_param": 0
}

Example Op. (& Expected Response JSON)

{
  "op": [
    "application_create",
    {
      "fee": "0.000000 SPHTX",
      "author": "",
      "name": "",
      "url": "",
      "metadata": "",
      "price_param": 0
    }
  ]
}

Default (Incomplete params values) Example curl

curl -s --data '{"jsonrpc": "2.0", "method": "alexandria_api.create_application", "params": {"author":"","app_name":"","url":"","meta_data":"","price_param":0}, "id": 1}' https://API_URL

application_update

Helper API simplified call to create this operation in required format exists! See below!

alexandria_api.update_application

Updates custom application in blockchain
. API call returns "application_update" operation in requested json format. Updates existing application object.

Request:

Result:

Query Parameters JSON

{
  "author": "",
  "app_name": "",
  "new_author": "",
  "url": "",
  "meta_data": "",
  "price_param": 0
}

Example Op. (& Expected Response JSON)

{
  "op": [
    "application_update",
    {
      "fee": "0.000000 SPHTX",
      "author": "",
      "name": "",
      "url": "",
      "metadata": ""
    }
  ]
}

Default (Incomplete params values) Example curl

curl -s --data '{"jsonrpc": "2.0", "method": "alexandria_api.update_application", "params": {"author":"","app_name":"","new_author":"","url":"","meta_data":"","price_param":0}, "id": 1}' https://API_URL

application_delete

Helper API simplified call to create this operation in required format exists! See below!

alexandria_api.delete_application

Deletes custom application in blockchain
. API call returns “application_delete” operation in required format. Request

Response

Query Parameters JSON

{"author": "", "app_name": ""}

Example Op. (& Expected Response JSON)

{
  "op": [
    "application_delete",
    {
      "fee": "0.000000 SPHTX",
      "author": "",
      "name": ""
    }
  ]
}

Default (Incomplete params values) Example curl

curl -s --data '{"jsonrpc": "2.0", "method": "alexandria_api.delete_application", "params": {"author":"","app_name":""}, "id": 1}' https://API_URL

buy_application

Helper API simplified call to create this operation in required format exists! See below!

alexandria_api.buy_application

Buys custom application in blockchain
. API call returns “buy_application” operation in required format.

Request

Response

Query Parameters JSON

{"buyer": "", "app_id": 0}

Example Op. (& Expected Response JSON)

{
  "op": [
    "buy_application",
    {
      "fee": "0.000000 SPHTX",
      "buyer": "",
      "app_id": 0
    }
  ]
}

Default (Incomplete params values) Example curl

curl -s --data '{"jsonrpc": "2.0", "method": "alexandria_api.buy_application", "params": {"buyer":"","app_id":0}, "id": 1}' https://API_URL

cancel_application_buying

Helper API simplified call to create this operation in required format exists! See below!

alexandria_api.cancel_application_buying

Cancel custom application buying in blockchain
. API call returns “cancel_application_buying” operation in required format.

Request

Response

Query Parameters JSON

{"app_owner": "", "buyer": "", "app_id": 0}

Example Op. (& Expected Response JSON)

{
  "op": [
    "cancel_application_buying",
    {
      "fee": "0.000000 SPHTX",
      "app_owner": "",
      "buyer": "",
      "app_id": 0
    }
  ]
}

Default (Incomplete params values) Example curl

curl -s --data '{"jsonrpc": "2.0", "method": "alexandria_api.cancel_application_buying", "params": {"app_owner":"","buyer":"","app_id":0}, "id": 1}' https://API_URL

custom_binary

Helper API simplified call to create this operation in required format exists! See below!

alexandria_api.make_custom_binary_operation

Saves custom binary data in blockchain
. API call returns "custom_binary" operation in requested json format. Request:

Result:

Query Parameters JSON

{"app_id": 0, "from": "", "to": [], "data": ""}

Example Op. (& Expected Response JSON)

{
  "op": [
    "custom_binary",
    {
      "fee": "0.000000 SPHTX",
      "sender": "",
      "recipients": [],
      "app_id": 0,
      "data": ""
    }
  ]
}

Real Example curl

curl -s --data '{"jsonrpc": "2.0", "method": "alexandria_api.make_custom_binary_operation", "params": {"app_id": 10, "from": "user1", "to": ["user2", "user3"], "data": "SGVsbG8gU29waGlhVFg="}, "id": 1}' https://API_URL

Response curl

'{
  "op": [
    "custom_binary",
    {
      "fee": "0.000000 SPHTX",
      "sender": "user1",
      "recipients": ["user2", "user3"],
      "app_id": 10,
      "data": "48656c6c6f20536f706869615458"
    }
  ]
}'

custom_json

Helper API simplified call to create this operation in required format exists! See below!

alexandria_api.make_custom_json_operation

Saves custom json data in blockchain
. API call returns "custom_json" operation in requested json format.

Request:

Result:

Query Parameters JSON

{"app_id": 0, "from": "", "to": [], "json": ""}

Example Op. (& Expected Response JSON)

{"op": []}

Real Example curl

curl -s --data '{"jsonrpc": "2.0", "method": "alexandria_api.make_custom_json_operation", "params": {"app_id": 10, "from": "user1", "to": ["user2", "user3"], "json": "{\"data\":\"any valid json data\"}"}, "id": 1}' https://API_URL

Response curl

'{
  "op": [
    "custom_json",
    {
      "fee": "0.000000 SPHTX",
      "sender": "user1",
      "recipients": ["user2", "user3"],
      "app_id": 10,
      "json": "{\"data\":\"any valid json data\"}"
    }
  ]
}'

sponsor_fees

Helper API simplified call to create this operation in required format exists! See below!

alexandria_api.sponsor_account_fees

Sets up sponsoring account for another account fees
. API call returns "sponsor_fees" operation in requested json format.

Request

Response

Query Parameters JSON

{
  "sponsoring_account": "",
  "sponsored_account": "",
  "is_sponsoring": false
}

Example Op. (& Expected Response JSON)

{
  "op": [
    "sponsor_fees",
    {
      "fee": "0.000000 SPHTX",
      "sponsor": "",
      "sponsored": "",
      "is_sponsoring": false
    }
  ]
}

Default (Incomplete params values) Example curl

curl -s --data '{"jsonrpc": "2.0", "method": "alexandria_api.sponsor_account_fees", "params": {"sponsoring_account":"","sponsored_account":"","is_sponsoring":false}, "id": 1}' https://API_URL

witness_stop

Helper API simplified call to create this operation in required format exists! See below!

alexandria_api.stop_witness

Stops witness.
. API call returns "witness_stop" operation in requested json format. Stop being a witness,effectively deleting the witness object owned by the given account.

Request

Response

Query Parameters JSON

{"witness_account_name": ""}

Example Op. (& Expected Response JSON)

{
  "op": [
    "witness_stop",
    {"fee": "0.000000 SPHTX", "owner": ""}
  ]
}

Default (Incomplete params values) Example curl

curl -s --data '{"jsonrpc": "2.0", "method": "alexandria_api.stop_witness", "params": {"witness_account_name":""}, "id": 1}' https://API_URL

witness_update

Helper API simplified call to create this operation in required format exists! See below!

alexandria_api.update_witness

Updates witness.
. API call returns "witness_update" operation in requested json format. Updates a witness object owned by the given account.

Request:

Result:

Query Parameters JSON

{
  "witness_account_name": "",
  "url": "",
  "block_signing_key": "SPH1111111111111111111111111111111114T1Anm",
  "props": {
    "account_creation_fee": "0.000000 SPHTX",
    "maximum_block_size": 262144,
    "price_feeds": []
  }
}

Example Op. (& Expected Response JSON)

{
  "op": [
    "witness_update",
    {
      "fee": "0.000000 SPHTX",
      "owner": "",
      "url": "",
      "block_signing_key": "SPH1111111111111111111111111111111114T1Anm",
      "props": {
        "account_creation_fee": "0.000000SPHTX",
        "maximum_block_size": 262144,
        "price_feeds": []
      }
    }
  ]
}

Default (Incomplete params values) Example curl

curl -s --data '{"jsonrpc": "2.0", "method": "alexandria_api.update_witness", "params": {"witness_account_name":"","url":"","block_signing_key":"SPH1111111111111111111111111111111114T1Anm","props":{"account_creation_fee":"0.000000 SPHTX","maximum_block_size":262144,"price_feeds":[]}}, "id": 1}' https://API_URL

account_witness_proxy

Helper API simplified call to create this operation in required format exists! See below!

alexandria_api.set_voting_proxy

Sets the voting proxy for an account. If a user does not wish to take an active part in voting,they can choose to allow another account to vote their stake. Setting a vote proxy does not remove your previous votes from the blockchain, they remain there but are ignored. If you later null out your vote proxy, your previous votes will take effect again. This setting can be changed at any time.
API call returns "account_witness_proxy" operation in requested json format.

Request

Response

Query Parameters JSON

{"account_to_modify": "", "proxy": ""}

Example Op. (& Expected Response JSON)

{
  "op": [
    "account_witness_proxy",
    {
      "fee": "0.000000 SPHTX",
      "account": "",
      "proxy": ""
    }
  ]
}

Default (Incomplete params values) Example curl

curl -s --data '{"jsonrpc": "2.0", "method": "alexandria_api.set_voting_proxy", "params": {"account_to_modify":"","proxy":""}, "id": 1}' https://API_URL

witness_set_properties

Replaces the witness_update which was not easily extendable. While it is recommended to use witness_set_properties, witness_update will continue to work

Example Op.

{
  "op": [
    "witness_set_properties",
    {
      "owner": "alice",
      "props": {
        "account_creation_fee": "0.000 SPHTX",
        "account_subsidy_budget": 10000,
        "account_subsidy_decay": 330782,
        "maximum_block_size": 65536,
        "sbd_interest_rate": "0.000 SPHTX",
        "sbd_exchange_rate": {
          "base": "0.000 SBD",
          "quote": "0.000 SPHTX"
        },
        "url": "68747470733A2F2F737465656D69742E636F6D",
        "new_signing_key": "25688bbe7b1204f26e40be054c8b2ff1997eec6d4e7be6a105aab8a0e6f11c616d7cb6066"
      },
      "extensions": []
    }
  ]
}

admin_witness_update

Add description.
This opertion can be used only in private nets.

Example Op.

{"op": ["add name", {}]}

account_witness_vote

Helper API simplified call to create this operation in required format exists! See below!

alexandria_api.vote_for_witness

Creates "account_witness_vote" operation in requested json format. Vote for a witness to become a block producer. By default an account has not voted positively or negatively for a witness. The account can either vote for with positively votes or against with negative votes. The vote will remain until updated with another vote. Vote strength is determined by the accounts vesting shares.

Request:

Result:

Query Parameters JSON

{
  "voting_account": "",
  "witness_to_vote_for": "",
  "approve": false
}

Example Op. (& Expected Response JSON)

{
  "op": [
    "account_witness_vote",
    {
      "fee": "0.000000 SPHTX",
      "account": "",
      "witness": "",
      "approve": true
    }
  ]
}

Default (Incomplete params values) Example curl

curl -s --data '{"jsonrpc": "2.0", "method": "alexandria_api.vote_for_witness", "params": {"voting_account":"","witness_to_vote_for":"","approve":false}, "id": 1}' https://API_URL

feed_publish

Feeds can only be published by the top N witnesses which are included in every round and are used to define the exchange rate between sophiatx and the fiat currencies.

Represents quotation of the relative value of asset against another asset. Similar to "currency pair" used to determine value of currencies.

For example:
1 SPHTX / 1.25 USD where:
1 SPHTX is an asset specified as a base
1.25 USD us an asset specified as a quote

can determine value of SPHTX against USD.

Example Op.

{
  "op": [
    "feed_publish",
    {
      "publisher": "user1",
      "exchange_rate": {
        "base": {"amount": 1, "symbol": "SPHTX"},
        "quote": {"amount": 1.25, "symbol": "USD"}
      }
    }
  ]
}

escrow_transfer

The purpose of this operation is to enable someone to send money contingently to another individual. The funds leave the from account and go into a temporary balance where they are held until from releases it to to or to refunds it to from.

In the event of a dispute the agent can divide the funds between the to/from account. Disputes can be raised any time before or on the dispute deadline time, after the escrow has been approved by all parties.

This operation only creates a proposed escrow transfer. Both the agent and to must agree to the terms of the arrangement by approving the escrow.

The escrow agent is paid the fee on approval of all parties. It is up to the escrow agent to determine the fee.

Escrow transactions are uniquely identified by ‘from’ and ‘escrow_id’, the ‘escrow_id’ is defined by the sender.

Example Op.

{
  "op": [
    "escrow_transfer",
    {
      "from": "alice",
      "to": "bob",
      "sophiatx_amount": {"amount": "1.000000", "symbol": "SPHTX"},
      "escrow_id": 23456789,
      "agent": "charlie",
      "escrow_fee": {"amount": "0.1", "symbol": "USD"},
      "json_meta": "{}",
      "ratification_deadline": "2017-02-26T11:22:39",
      "escrow_expiration": "2017-02-28T11:22:39"
    }
  ]
}

escrow_approve

The agent and to accounts must approve an escrow transaction for it to be valid on the blockchain. Once a part approves the escrow, they cannot revoke their approval. Subsequent escrow approve operations, regardless of the approval, will be rejected.

Example Op.

{
  "op": [
    "escrow_approve",
    {
      "from": "alice",
      "to": "bob",
      "agent": "charlie",
      "who": "charlie",
      "escrow_id": 59102208,
      "approve": true
    }
  ]
}

escrow_dispute

If either the sender or receiver of an escrow payment has an issue, they can raise it for dispute. Once a payment is in dispute, the agent has authority over who gets what.

Example Op.

{
  "op": [
    "escrow_dispute",
    {
      "from": "alice",
      "to": "bob",
      "agent": "charlie",
      "who": "alice",
      "escrow_id": 72526562
    }
  ]
}

escrow_release

This operation can be used by anyone associated with the escrow transfer to release funds if they have permission.

The permission scheme is as follows

Example Op.

{
  "op": [
    "escrow_release",
    {
      "from": "alice",
      "to": "bob",
      "agent": "charlie",
      "who": "charlie",
      "receiver": "bob",
      "escrow_id": 72526562,
      "sbd_amount": {
        "amount": "5000",
        "precision": 3,
        "nai": "@@000000013"
      },
      "steem_amount": {
        "amount": "0",
        "precision": 3,
        "nai": "@@000000021"
      }
    }
  ]
}