Refactor tutorials/exchange_single_node.html
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- blockchain
- Domain
- blockchain, documentation
Research direction
Start with tutorials/exchange_single_node.html and compare it with the older documentation at the linked #others section. Review the proposed Introduction, Requirements and Environment, Setup, Watching accounts, deposit, withdrawal, and References sections. Done means the tutorial has a coherent structure and understandable, complete guidance for the exchange single-node workflow.
Written by the indexing model from the issue text.
Description
I find this very confusing
https://dev.bitshares.works/en/master/bts_guide/tutorials/exchange_single_node.html
I think lots of it got lost in translation, but it would also make sense to review this content wise. I find it hard to understand.
Thougts on the TOC and some pointers on the content from my side, built out as we go:
- Introduction
What is this about? External exchange listening in on the blockchain for deposits/withdrawals, talk about last irreversible block and stuff - Requirements and Environment
Software/Hardware requirements - Setup
Running one normal node, delayed node or processing lib and whatnot (cli wallet, python or js backend on abstract high level), how everything should be setup (as system services, or docker, or something) - Watching accounts
Best practice to listen to events on the blockchain
4.1 Processing deposits
Listen on external database/blockchain for incoming deposits, and broadcast the issue/transfer operation
4.2. Recognizing withdrawal requests
Listen to incoming blocks on specified account with memo and act accordingly in external database/blockchain - References
Old docs had this (also not complete): https://dev.bitshares.works/en/master/bts_guide/tutorials/exchange_single_node.html#others
Thougts?
@abitmore @oxarbitrage @jmjatlanta @xeroc
- Dominant language
- XSLT
- Stars
- 13
- Forks
- 41
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from bitshares/docs.bitshares.dev
-
Page should be added to portal "Exchange running on BitShares have full control over their balance"Open
Difficulty 2/5 1-3 hours Newbie friendliness 42/100
bitshares/docs.bitshares.dev#173 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 25/100
bitshares/docs.bitshares.dev#172 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
bitshares/docs.bitshares.dev#146 · 1 comment ·
-
Add redirectionsOpen
Difficulty 3/5 1-2 days Newbie friendliness 38/100
bitshares/docs.bitshares.dev#145 · 1 comment ·
-
claim translation task of the chapter Development in BitShares Developer Portal from Oct 21-Oct 28Open
Difficulty 2/5 1-3 hours Newbie friendliness 20/100
bitshares/docs.bitshares.dev#64 · 1 comment ·
All issues in bitshares/docs.bitshares.dev
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
btclib-org/btclib-wallet#265 ·
Maintainers usually reply within 1 day
-
plutus
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
IntersectMBO/cardano-ledger#6152 ·
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
ethersphere/bee#5650 ·
Maintainers usually reply within 2 days
-
blocklist addition needs more information
Difficulty 1/5 Under an hour Newbie friendliness 78/100
MetaMask/eth-phishing-detect#300355 · 1 comment ·
Maintainers usually reply within 1 day
-
ci
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
polkadot-js/apps#12471 ·