[mkdocs] docs: add listen tx flow tutorial#916
Conversation
zero4862
force-pushed
the
docs-listen-transaction-flow
branch
from
209c9cd to
50f1500
Compare
zero4862
force-pushed
the
docs-listen-transaction-flow
branch
from
50f1500 to
b936694
Compare
segfaultxavi
left a comment
segfaultxavi
left a comment
There was a problem hiding this comment.
I have only reviewed the WebSocket reference page.
Apologies for spending so much time reviewing such a obscure corner of the docs, but I don't like the shape it has on Symbol and decided to fix it in this review.
I'll continue now to review the rest of the PR, but wanted to submit this early.
segfaultxavi
left a comment
segfaultxavi
left a comment
There was a problem hiding this comment.
Comments for the tutorial proper now.
|
|
||
| NODE_URL = os.getenv('NODE_URL', 'http://libertalia.nemtest.net:7778') | ||
| print(f'Using node {NODE_URL}') | ||
| NODE_HOST = os.getenv('NODE_HOST', 'libertalia.nemtest.net') |
There was a problem hiding this comment.
I understand this change simplifies creating URLs for the WebSocket tutorials, but I think this forces us to change ALL other tutorials to follow the same pattern.
Otherwise, different tutorials use different environment variables and it's a bit messy.
Do you want to apply this pattern to the rest of tutorials, including Symbol? :)
| NODE_URL = f'http://{NODE_HOST}:7890' | ||
| WS_URL = f'http://{NODE_HOST}:7778' |
There was a problem hiding this comment.
| NODE_URL = f'http://{NODE_HOST}:7890' | |
| WS_URL = f'http://{NODE_HOST}:7778' | |
| NODE_REST_URL = f'http://{NODE_HOST}:7890' | |
| NODE_WS_URL = f'http://{NODE_HOST}:7778' |
For consistency.
|
|
||
| {{ tutorial.code_snippet_tagged('step-5') }} | ||
|
|
||
| This tutorial builds a minimal [Transfer Transaction](../transactions/transfer-xem.md) to the monitored address, with a |
There was a problem hiding this comment.
I would make this link point to the Textbook, and then, below, instead of "as usual", I would say "following the same procedure as in the Transfer Transaction Tutorial", and include the tutorial link there.
2 participants
Adapts Listen tx flow tutorial to NEM and documents missing websocket channels and requests.