Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API Broadcast Operation Type Definitions #118

Closed
3 tasks done
inertia186 opened this issue Apr 17, 2018 · 0 comments
Closed
3 tasks done

API Broadcast Operation Type Definitions #118

inertia186 opened this issue Apr 17, 2018 · 0 comments
Assignees
Labels
8 - SW Steemworks Points priority/high

Comments

@inertia186
Copy link
Contributor

inertia186 commented Apr 17, 2018

Similar to API Definitions, we should also document the 50 or so broadcast operation types. The list of operations can be found here:

https://raw.githubusercontent.com/steemit/steem-js/master/src/broadcast/operations.js

In a way, these are just parameters to network_broadcast_api.*, but I don't think these should be documented directly in the network_broadcast_api page. But they should be linked to from network_broadcast_api.

For example, to broadcast a limit_order_create operation, pass this to network_broadcast_api.broadcast_transaction_synchronous:

{
   "trx":{
      "expiration":"2018-04-17T19:33:42",
      "ref_block_num":27480,
      "ref_block_prefix":3216881081,
      "operations":[
         [
            "claim_reward_balance",
            {
               "account":"social",
               "reward_steem":["0", 3, "@@000000021"],
               "reward_sbd":["0", 3, "@@000000013"],
               "reward_vests":["1", 6, "@@000000037"]
            }
         ]
      ],
      "extensions":[],
      "signatures":["1b180eb5b7be3d3eba1e114ca2aea3e1161554d465e200527b98d9ef438a794a5a647ca2556a69546e204d1015ba7893c3afbd9cd9de4b89b5453246d1e53886bb"
      ]
   }
}

Which responds with:

{
   "id":"ccc59dcb3b5a0ebd8c46b1638fac393877733b7b",
   "block_num":21654377,
   "trx_num":48,
   "expired":false
}

AC

  • all 50 ops are documented on one, separate page
  • there is a link in the main nav to that page in the api section
  • the network_broadcast_api description section includes a high level explanation of the operation (in total, with 1 or 2 commonly used operations) and link to the page.
@inertia186 inertia186 changed the title API Broadcast Definitions API Broadcast Operation Type Definitions Apr 17, 2018
inertia186 added a commit that referenced this issue Apr 28, 2018
inertia186 added a commit that referenced this issue Apr 28, 2018
@inertia186 inertia186 self-assigned this Apr 30, 2018
@relativityboy relativityboy added the 8 - SW Steemworks Points label Apr 30, 2018
inertia186 added a commit that referenced this issue Apr 30, 2018
inertia186 added a commit that referenced this issue Apr 30, 2018
relativityboy pushed a commit that referenced this issue May 1, 2018
* all known ops & virtual ops w/details, "also see" references #118
inertia186 added a commit to inertia186/hivedocs that referenced this issue Dec 18, 2018
* all known ops & virtual ops w/details, "also see" references steemit#118
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8 - SW Steemworks Points priority/high
Projects
None yet
Development

No branches or pull requests

2 participants