docs: updated tools.md for spvnode #168
Merged
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
edtubbs
force-pushed
the
0.1.3-dev-docs_spvnode
branch
2 times, most recently
from
5d8314c
to
aa0ec84
Compare
xanimo
requested changes
Nov 17, 2023
doc/tools.md
Outdated
|
|
||
| 1. **Header-Only Mode**: This mode is for quickly catching up with the blockchain by downloading only the block headers. It's ideal when resources like bandwidth and storage are limited. | ||
|
|
||
| 2. **Full Block Validation Mode**: After catching up with the blockchain headers, `spvnode` can switch to this mode to download full blocks for detailed transaction history scanning. This is essential for verifying transactions related to the user's wallet addresses. |
There was a problem hiding this comment.
would maybe change this to Full Block Mode instead of including validation since validation happens regardless of headers or full blocks.
doc/tools.md
Outdated
| @@ -2,7 +2,7 @@ | |||
|
|
|||
| ## Overview | |||
|
|
|||
| If you are looking to just explore the functionality of Libdogecoin without building a complicated project yourself, look no further than the CLI tools provided in this repo. The first tool, `such`, is an interactive CLI application that allows you to perform all Essential address and transaction operations with prompts to guide you through the process. The second tool, `sendtx`, handles the process of broadcasting a transaction built using Libdogecoin to eventually push it onto the blockchain. | |||
| If you are looking to just explore the functionality of Libdogecoin without building a complicated project yourself, look no further than the CLI tools provided in this repo. The first tool, `such`, is an interactive CLI application that allows you to perform all Essential address and transaction operations with prompts to guide you through the process. The second tool, `sendtx`, handles the process of broadcasting a transaction built using Libdogecoin to eventually push it onto the blockchain. The third tool, `spvnode`, run a Simple Payment Verification (SPV) node for the Dogecoin blockchain. It enables users to interact with the Dogecoin network, verify transactions, and stay in sync with the blockchain without the need for a full node's resource requirements. | |||
There was a problem hiding this comment.
i would strike without the need for a full node's resource requirements. unless you've done any testing to assert that that claim is true.
doc/tools.md
Outdated
| ## Examples | ||
|
|
||
| #### Sync up to the chain tip and stores all headers in `headers.db` (quit once synced): | ||
| spvnode scan |
There was a problem hiding this comment.
small nit with this and all the commands below as having to do with local vs installed. perhaps we should append ./ to ensure the binary being used is the local version to avoid confusion around the situation i encountered yesterday.
|
one last thing. i'm leaving a reminder that's applicable to #167 and this one and that is that the |
edtubbs
force-pushed
the
0.1.3-dev-docs_spvnode
branch
2 times, most recently
from
1e66318
to
ec0bcb6
Compare
edtubbs
force-pushed
the
0.1.3-dev-docs_spvnode
branch
from
ec0bcb6
to
a28b995
Compare
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.
No description provided.