Add more documentation for TBC and related RPC protocol #86
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joshuasing
changed the title
ClaytonNorthey92
approved these changes
Apr 22, 2024
joshuasing
force-pushed
the
marco/readme
branch
from
16fa759
to
48dacc1
Compare
joshuasing
added
type: documentation
joshuasing
reviewed
Apr 26, 2024
joshuasing
reviewed
Apr 29, 2024
joshuasing
reviewed
Apr 30, 2024
joshuasing
changed the title
Co-authored-by: ClaytonNorthey92 <clayton.northey@gmail.com>
jcvernaleo
requested changes
May 29, 2024
|
|
||
| On some linux systems you may need to increase the number of open files allowed (particularly with slower disks) and the maximum stack size. If you run into open file or OOM errors, in the shell you are going to run tbcd, run: | ||
| - **`testnet3`** requires approximately 40 GiB of disk space. | ||
| - **`mainnet`** requires over 300 GiB of disk space. <!-- XXX: add exact number here --> |
There was a problem hiding this comment.
We probably should fill something in rather than having a XXX note in docs.
There was a problem hiding this comment.
What do you mean by 'fill something in'? 🤔
I believe this was an estimation from when it was being run as a test for mainnet, so this amount is likely going to change quite a bit before we have a rough number.
There was a problem hiding this comment.
I pretty much just meant pick a number and go with it since nothing we put in there will be correct for too long anyway
joshuasing
approved these changes
May 29, 2024
|
Waiting for reviews from @ClaytonNorthey92 and if possible @jsorkin24 before merging. |
ClaytonNorthey92
approved these changes
May 29, 2024
web3cryptoguy
pushed a commit
to web3cryptoguy/heminetwork
that referenced
this pull request
Nov 1, 2024
* Add some more meat to the tbcd README * Tidy up wording and sections in tbcd readme * tbcd: add initial RPC docs * Fix command table formatting * Move RPC docs into separate files * Add RPC commands link to tbcd readme * Add docs for block-headers-by-height, add more details * Add docs for balance-by-address * Add docs for utxos-by-address * Add docs for tx-by-id * Add a link to tbcapi.go * Add errors section * Add table of contents * Better describe block header merkle_root, timestamp and nonce Co-authored-by: ClaytonNorthey92 <clayton.northey@gmail.com> * Add TBC_ADDRESS example and move protocol comment to protocol section * Add request/response examples for UTXOs by Address * Update limits information in tbc readme * Add example request/responses for tx-by-id * readme-docs: protocol & tbc api, tbcd cmd, and hemi * Issues Addressed (minor grammar changes) * Changes Updated * Remove Styling * docs: reformat tbcapi readme * docs: fix inconsistencies in tbcapi readme * docs: update tbcapi docs and fix a few errors * docs: fix error in tbcapi docs * docs: tidy up protocol docs * Add .DS_Store to gitignore * docs: tidy up tbcd readme * docs: clarify minimums for tbcd * docs: tidy up readme, update parts and fix a few errors * docs: fix formatting for notes in readme * docs: feedback from Jane * readme: specify Go v1.22.2 for building from source * readme: use `shell` syntax instead of `bash` * tbcd/readme: specify Go v1.22.2 for building from source * tbcd/readme: use ./bin/tbcd for help example * readme: reword services paragraph * protocol: remove id note from readme --------- Co-authored-by: Joshua Sing <joshua@bloq.com> Co-authored-by: ClaytonNorthey92 <clayton.northey@gmail.com> Co-authored-by: Jane <32560576+jsorkin24@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Changes