Steemit Dev Portal: Document Transaction Polling API

in #utopian-io6 years ago (edited)

Repository

<p dir="auto"><span><a href="https://github.com/steemit/devportal" target="_blank" rel="nofollow noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://github.com/steemit/devportal <h4>Site <p dir="auto"><span><a href="https://developers.steem.io/" target="_blank" rel="nofollow noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/ <h3><a href="https://github.com/steemit/devportal/issues/361" target="_blank" rel="nofollow noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">Issue <ul> <li>What was the issue(s)?<br /> As an application developer using the Steem blockchain, I want to know the status of transactions I broadcast, so that I can determine if/when my transactions become irreversible. <li>What was the solution?<br /> The Steemit Dev Portal has several <code>.yml files that contain details about APIs and methods. I just need to add a new <code>.yml file that contains details on a new API called <code>transaction_status_api. That file shall contain details on a single method: <code>transaction_status_api. find_transaction <p dir="auto">Once this PR is approved, the final version will look like this: <p dir="auto"><a href="https://cdn.steemitimages.com/DQmf4RNKV8JQFNF6z5MbfuuWXDPRVgFKgrPB1itNxtXVr8Z/image.png" target="_blank" rel="nofollow noreferrer noopener" title="This link will take you away from hive.blog" class="external_link"><img src="https://images.hive.blog/768x0/https://cdn.steemitimages.com/DQmf4RNKV8JQFNF6z5MbfuuWXDPRVgFKgrPB1itNxtXVr8Z/image.png" srcset="https://images.hive.blog/768x0/https://cdn.steemitimages.com/DQmf4RNKV8JQFNF6z5MbfuuWXDPRVgFKgrPB1itNxtXVr8Z/image.png 1x, https://images.hive.blog/1536x0/https://cdn.steemitimages.com/DQmf4RNKV8JQFNF6z5MbfuuWXDPRVgFKgrPB1itNxtXVr8Z/image.png 2x" /> <h4>Notes <p dir="auto">To help implement this issue, I am using the following tintoy ref <a href="https://gist.github.com/inertia186/b88e7bfff8862858e54c59392e2bce20" target="_blank" rel="nofollow noreferrer noopener" title="This link will take you away from hive.blog" class="external_link"><code>ed1ca68. <pre><code># Start the tintoy tag with transaction-status-api enabled ... docker run -d -p 8090:8090 inertia/tintoy:transaction-status-api # After waiting for the node to fully sych, check list of methods ... curl -s --data '{"jsonrpc":"2.0", "method":"jsonrpc.get_methods", "id":1}' http://localhost:8090 | jq # If we see transaction_status_api.find_transaction, we're ready to test ... curl -s --data '{"jsonrpc":"2.0", "method":"transaction_status_api.find_transaction", "params": {"transaction_id": "0000000000000000000000000000000000000000"}, "id":1}' http://localhost:8090 | jq <h4>Expected result: <pre><code>{ "jsonrpc": "2.0", "result": { "status": "unknown" }, "id": 1 } <h4>Scrape API <pre><code>TEST_NODE=http://localhost:8090 rake scrape:api_defs <p dir="auto">Once the <code>rake command was executed, I had a new <code>transaction_status_api.yml file to fill in. The rest of the changes are detailed here: <p dir="auto"><span><a href="https://github.com/steemit/devportal/pull/395/files" target="_blank" rel="nofollow noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://github.com/steemit/devportal/pull/395/files <h4>GitHub Account <p dir="auto"><span><a href="https://github.com/inertia186" target="_blank" rel="nofollow noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://github.com/inertia186
Sort:  

Hello @inertia,

Sorry but the PR mentioned in the contribution is not yet merged so the contribution cannot be scored.

You can post a contribution about it when the PR is merged and remove the contribution for now.

I will request you to please check the guidelines and make a contribution in the documentation category when the PR is merged in the official documentation.

Your contribution has been evaluated according to Utopian policies and guidelines.



Chat with us on Discord.
[utopian-moderator]Need help? Write a ticket on https://support.utopian.io/.

Thought so. We’re kinda in between processes at the moment, so merging is pretty unlikely for the time being.

There is another contribution posted by you and for the same reason it will not be scored.

I am sorry for the inconvenience but the PR needs to be merged for the contribution to be reviewed.

So, for this particular example, I get it. It's highly dependent on being merged for it to be useful to anyone, which is why I included a screen shot showing how it will eventually look once it's merged and deployed.

But for the other one I think you're talking about, the change is entirely presented in the blog entry and just references the pull request. No one has to look at the PR to understand the article.

Thank you for your review, @ms10398! Keep up the good work!

Hi @inertia!


Your UA account score is currently 6.470 which ranks you at #166 across all Steem accounts.
Your rank has dropped 1 places in the last three days (old rank 165).Your post was upvoted by @steem-ua, new Steem dApp, using UserAuthority for algorithmic post curation!

In our last Algorithmic Curation Round, consisting of 339 contributions, your post is ranked at #257.

Evaluation of your UA score:
  • You've built up a nice network.
  • The readers appreciate your great work!
  • Try to work on user engagement: the more people that interact with you via the comments, the higher your UA score!

Feel free to join our @steem-ua Discord server

Approved 😂

The sad thing is, at the moment anyway, there’s a snowball’s chance in hell that this will get approval merged anytime soon by the bearded one. And I’m not going to initiate a drive-by.

Anyway, it’s not like it has urgency. My intent here is to develop a repeatable process.

Hi, @inertia!

You just got a 3.28% upvote from SteemPlus!
To get higher upvotes, earn more SteemPlus Points (SPP). On your Steemit wallet, check your SPP balance and click on "How to earn SPP?" to find out all the ways to earn.
If you're not using SteemPlus yet, please check our last posts in here to see the many ways in which SteemPlus can improve your Steem experience on Steemit and Busy.