bitshares / bitshares/docs.bitshares.dev

Refactor tutorials/exchange_single_node.html

Aperta
#144 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
XSLT
Stelle
13
Fork
41
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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:

  1. Introduction
    What is this about? External exchange listening in on the blockchain for deposits/withdrawals, talk about last irreversible block and stuff
  2. Requirements and Environment
    Software/Hardware requirements
  3. 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)
  4. 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
  5. 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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia da tutorials/exchange_single_node.html e confrontalo con la documentazione precedente nella sezione collegata #others. Esamina le sezioni proposte Introduction, Requirements and Environment, Setup, Watching accounts, deposit, withdrawal e References. Il lavoro è completo quando il tutorial presenta una struttura coerente e indicazioni comprensibili e complete per il workflow exchange single-node.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
blockchain
Ambito
blockchain, documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.