docs: node.store usage updates for celestia-node #1532
Conversation
WalkthroughThe changes streamline the handling of Changes
Sequence Diagram(s)The changes are too varied and simple to warrant generating a sequence diagram. Assessment against linked issues
Possibly related issues
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
jcstein
changed the title
|
Apologies for delay. LGTM otherwise 🎉 |
|
this is ready for review ahead of it being live on Mocha next week |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
Outside diff range and nitpick comments (10)
developers/celestia-node-key.md (1)
93-94: Clarify the default paths for node data and configurations.The documentation on default paths for node data and configurations is a bit unclear. It might be helpful to explicitly state that these paths are used when the
--node.storeflag is not provided, ensuring that users fully understand the defaults without ambiguity.nodes/celestia-node-troubleshooting.md (1)
83-85: Review the automation of node detection logic.The automation of node detection logic in v0.14.0+ is a significant enhancement. It would be beneficial to include more detailed examples or a deeper explanation of how this automation works under the hood, especially for users who might need to troubleshoot or understand the automated processes in detail.
developers/node-tutorial.md (8)
Line range hint
504-504: Clarify the subject in the sentence to enhance readability.- If user passes auth token, auth token is used. + If a user passes an auth token, that token is used.
Line range hint
509-509: Simplify the sentence to enhance clarity.- In order to interact with the API using RPC CLI, you will need to set the authentication token. + To interact with the API using RPC CLI, you need to set the authentication token.
Line range hint
533-533: Simplify the sentence to enhance clarity.- In order to interact with the API using RPC CLI, you can also use your node store to set your auth token. + To interact with the API using RPC CLI, you can also use your node store to set your auth token.
Line range hint
1031-1031: Clarify the term to match the context.- Then, transfer the amount of tokens that you would like, while setting the recipient's address, gas fee, and gasLimit. + Then, transfer the number of tokens that you would like, while setting the recipient's address, gas fee, and gasLimit.
Line range hint
1061-1061: Improve the sentence structure for formal documentation.- To get help and view the CLI menu, use the following command: + To view the CLI menu and get help, use the following command:
Line range hint
1088-1088: Simplify the sentence to enhance clarity.- In order to post a blob using curl, you will need a light node running with the `--core.ip string` flag, providing access to a consensus endpoint. + To post a blob using curl, you need a light node running with the `--core.ip string` flag, providing access to a consensus endpoint.
Line range hint
1092-1092: Clarify the subject in the sentence to enhance readability.- The flag indicates node to connect to the given core consensus node. + The flag indicates the node to connect to the given core consensus node.
Line range hint
1162-1162: Add a comma for grammatical correctness.- Ensure the testnet faucet has funded your account with tokens and then try again. + Ensure the testnet faucet has funded your account with tokens, and then try again.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- developers/celestia-node-key.md (1 hunks)
- developers/node-tutorial.md (21 hunks)
- nodes/celestia-node-troubleshooting.md (2 hunks)
Additional context used
LanguageTool
developers/celestia-node-key.md
[uncategorized] ~13-~13: The grammatical number of this noun doesn’t look right. Consider replacing it. (AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
Context: ... celestia-node. While this tutorial will go over installation process ofcel-key, it is r...
[uncategorized] ~86-~86: A comma might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
Context: ...!-- markdownlint-enable MD013 --> ::: This will load the key<key-name>into the...
[uncategorized] ~91-~91: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...key are the following: ---node.store: Specifies a different directory you can...
[uncategorized] ~95-~95: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...for Mocha and Arabica. ---p2p.network: Specifies which network you want the ke...
[uncategorized] ~96-~96: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...ues arearabicaandmocha. Please note the default network will bemocha. K...nodes/celestia-node-troubleshooting.md
[style] ~38-~38: ‘take into account’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_TAKE_INTO_ACCOUNT)
Context: ... with celestia-node, it is important to take into account the different chain IDs for different n...
[grammar] ~54-~54: If the situation that you’re describing is mandatory or essential, you can use the subjunctive mood here. (SUBJUNCTIVE_MOOD)
Context: ...es. It is essential that specific ports are accessible. Make sure that your firewal...
[typographical] ~136-~136: It seems that a comma is missing. (IN_ORDER_TO_VB_COMMA)
Context: ..., the process is different. To show the keys you should add--keyring-dirlike thi...
[uncategorized] ~179-~179: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...est will go to the Mocha full node, and result shown as expected. #### Using a custom...
[grammar] ~196-~196: A verb may be missing. Did you mean “you have” or “you do”? (IF_YOU_ANY)
Context: ...st" } ``` ## Resetting your config If you an encounter an error, it is likely tha...
[uncategorized] ~209-~209: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ...owing commands: :::tip Save your config so custom values are not lost. ::: Run th...
[grammar] ~299-~299: The verb form ‘value’ does not seem to be suitable in this context. (THIS_VBP_DT)
Context: ...ng file descriptor limits. Setting this value too high might affect system performanc...developers/node-tutorial.md
[uncategorized] ~184-~184: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...the correct version of Go was installed correctly run:bash go version...
[typographical] ~488-~488: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (HOWEVER_SENTENCE)
Context: ...hat can be used to interact with the API, however, none are necessary using default config...
[uncategorized] ~504-~504: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...se flags in the following order: 1. If user passes auth token, auth token is used. ...
[style] ~509-~509: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ore. #### Auth token 🔐 {#auth-token} In order to interact with the API using RPC CLI, yo...
[style] ~533-~533: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ....network arabica) ``` #### Node store In order to interact with the API using RPC CLI, yo...
[style] ~862-~862: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...# Get your node ID This is an RPC call in order to get your node's peerId information: ``...
[style] ~890-~890: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ur account address This is an RPC call in order to get your node's account address: ```ba...
[uncategorized] ~1031-~1031: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case. (AMOUNTOF_TO_NUMBEROF)
Context: ...c02gxspa29wmh0d ``` Then, transfer the amount of tokens that you would like, while se...
[grammar] ~1061-~1061: The word ‘help’ is a conjunction. In formal texts, use “to”. (HELP_AND_VB)
Context: ...a node info ``` #### Help To get help and view the CLI menu, use the following co...
[uncategorized] ~1067-~1067: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...:bash celestia --helpTo view help menu for a specific method, use the fol...
[style] ~1088-~1088: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...rces ### Submitting a blob using curl In order to post a blob using curl, you will need a...
[uncategorized] ~1092-~1092: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ... consensus endpoint. The flag indicates node to connect to the given core consensus ...
[uncategorized] ~1162-~1162: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...net faucet has funded your account with tokens and then try again.
Additional comments not posted (3)
developers/node-tutorial.md (3)
472-472: Ensure the command usage is consistent with the new flag settings.
540-544: The command for setting a custom node store has been updated to reflect a more general directory path. This change aligns with the PR's goal of making documentation more flexible for user configurations.
465-470: The note about the removal of the--node.storeflag is clear and informative. It helps users understand the version changes and the simplification of command usage.
| - The presence of a lock signifies a running node. | ||
| - Networks are ordered as Mainnet, Mocha, Arabica, private, custom. | ||
| - Node types are ordered as bridge, full, and light. | ||
| - Each network has only one running node type. | ||
| - Multiple nodes of the same network and type are prohibited | ||
| (resulting in an `Error: node: store is in use`). | ||
|
|
There was a problem hiding this comment.
Revise the assumptions section for clarity and accuracy.
The assumptions listed about the ordering of networks and node types, as well as the prohibition of multiple nodes of the same network and type, are crucial for understanding the operational constraints. Consider expanding on why these assumptions are necessary and how they impact the node's operation to provide clearer guidance to users.
| - `skipAuth` allows bypassing authentication for trusted setups and follows | ||
| Unix daemon conventions. | ||
| - Non-default node store and cel-key configurations still require specific | ||
| flags in the configuration settings. |
There was a problem hiding this comment.
Ensure the skipAuth feature is clearly documented.
The skipAuth feature allows bypassing authentication in trusted setups, which is a significant configuration option. It might be helpful to provide a warning or note about the security implications of using this feature, especially in production environments. Would you like me to draft a security advisory note for this feature?
| ### Examples | ||
|
|
||
| #### Mainnet Beta full and Mocha light | ||
|
|
||
| This example uses a Mainnet Beta full node and a Mocha light node. When | ||
| making the request: | ||
|
|
||
| ```bash | ||
| ❯ celestia blob get 1318129 0x42690c204d39600fddd3 0MFhYKQUi2BU+U1jxPzG7QY2BVV1lb3kiU+zAK7nUiY= | ||
| { | ||
| "result": "RPC client error: sendRequest failed: http status 401 Unauthorized unmarshaling response: EOF" | ||
| } | ||
| ``` | ||
|
|
||
| The request will go to the Mainnet Beta node, and a 401 will show in | ||
| this node's logs. Note that a 401 is expected because this blob was | ||
| posted to Mocha and neither the namespace nor the blob exist on Mainnet. | ||
|
|
||
| #### Mocha full and Arabica light | ||
|
|
||
| This example uses a Mocha full node and an Arabica light node. When | ||
| making the request: | ||
|
|
||
| ```bash | ||
| ❯ celestia blob get 1318129 0x42690c204d39600fddd3 0MFhYKQUi2BU+U1jxPzG7QY2BVV1lb3kiU+zAK7nUiY= | ||
| { | ||
| "result": { | ||
| "namespace": "AAAAAAAAAAAAAAAAAAAAAAAAAEJpDCBNOWAP3dM=", | ||
| "data": "0x676d", | ||
| "share_version": 0, | ||
| "commitment": "0MFhYKQUi2BU+U1jxPzG7QY2BVV1lb3kiU+zAK7nUiY=", | ||
| "index": 23 | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| The request will go to the Mocha full node, and result shown as expected. | ||
|
|
||
| #### Using a custom rpc.config address | ||
|
|
||
| When using a custom RPC config address `0.0.0.1` and port `25231`, | ||
| the CLI accurately routes to the custom address and port, where no | ||
| node is running. It fails as expected: | ||
|
|
||
| ```bash | ||
| ❯ celestia blob get 1318129 0x42690c204d39600fddd3 0MFhYKQUi2BU+U1jxPzG7QY2BVV1lb3kiU+zAK7nUiY= | ||
| { | ||
| "result": "RPC client error: sendRequest failed: Post \"http://0.0.0.1:25231\": dial tcp 0.0.0.1:25231: connect: no route to host" | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Enhance the examples section with more detailed outcomes.
The examples provided for different node setups and their expected results are very useful. To enhance understanding, consider adding more context about why certain results are expected, such as the 401 Unauthorized error, and how users can resolve or investigate these issues further.
Tools
LanguageTool
[uncategorized] ~179-~179: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...est will go to the Mocha full node, and result shown as expected. #### Using a custom...
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 5
Outside diff range and nitpick comments (3)
developers/node-tutorial.md (3)
Line range hint
1031-1031: Correct the phrase "amount of tokens" to "number of tokens".- Then, transfer the amount of tokens that you would like, while setting the recipient's address, gas fee, and gasLimit. + Then, transfer the number of tokens that you would like, while setting the recipient's address, gas fee, and gasLimit.
Line range hint
1061-1061: Simplify the instruction for viewing help.- To get help and view the CLI menu, use the following command: + To view the CLI menu, use the following command:
Line range hint
1088-1088: Simplify the introduction to posting a blob using curl.- In order to post a blob using curl, you will need a light node running with the `--core.ip string` flag, providing access to a consensus endpoint. + To post a blob using curl, ensure a light node is running with the `--core.ip string` flag to access a consensus endpoint.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- developers/node-tutorial.md (21 hunks)
Additional context used
LanguageTool
developers/node-tutorial.md
[style] ~509-~509: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ore. #### Auth token 🔐 {#auth-token} In order to interact with the API using RPC CLI, yo...
[style] ~533-~533: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ....network arabica) ``` #### Node store In order to interact with the API using RPC CLI, yo...
[style] ~862-~862: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...# Get your node ID This is an RPC call in order to get your node's peerId information: ``...
[style] ~890-~890: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ur account address This is an RPC call in order to get your node's account address: ```ba...
[uncategorized] ~1031-~1031: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case. (AMOUNTOF_TO_NUMBEROF)
Context: ...c02gxspa29wmh0d ``` Then, transfer the amount of tokens that you would like, while se...
[grammar] ~1061-~1061: The word ‘help’ is a conjunction. In formal texts, use “to”. (HELP_AND_VB)
Context: ...a node info ``` #### Help To get help and view the CLI menu, use the following co...
[style] ~1088-~1088: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...rces ### Submitting a blob using curl In order to post a blob using curl, you will need a...
[uncategorized] ~1162-~1162: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...net faucet has funded your account with tokens and then try again.
| interact with the API; however, none are necessary using | ||
| default configurations. |
There was a problem hiding this comment.
Simplify language to enhance clarity.
- All RPC CLI commands have basic flags that can be used to interact with the API; however, none are necessary using default configurations.
+ All RPC CLI commands have basic flags, but they are optional with default configurations.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| interact with the API; however, none are necessary using | |
| default configurations. | |
| All RPC CLI commands have basic flags, but they are optional with default configurations. |
jcstein
added
documentation
There was a problem hiding this comment.
Actionable comments posted: 5
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- developers/node-tutorial.md (21 hunks)
Additional context used
LanguageTool
developers/node-tutorial.md
[uncategorized] ~287-~287: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...se flags in the following order: 1. If user passes auth token, auth token is used. ...
[style] ~292-~292: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ore. #### Auth token 🔐 {#auth-token} In order to interact with the API using RPC CLI, yo...
[style] ~316-~316: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ....network arabica) ``` #### Node store In order to interact with the API using RPC CLI, yo...
[style] ~645-~645: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...# Get your node ID This is an RPC call in order to get your node's peerId information: ``...
[style] ~673-~673: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ur account address This is an RPC call in order to get your node's account address: ```ba...
[uncategorized] ~814-~814: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case. (AMOUNTOF_TO_NUMBEROF)
Context: ...c02gxspa29wmh0d ``` Then, transfer the amount of tokens that you would like, while se...
[grammar] ~844-~844: The word ‘help’ is a conjunction. In formal texts, use “to”. (HELP_AND_VB)
Context: ...a node info ``` #### Help To get help and view the CLI menu, use the following co...
[style] ~871-~871: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...rces ### Submitting a blob using curl In order to post a blob using curl, you will need a...
[uncategorized] ~938-~938: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...net faucet has funded your account with tokens and then try again.
Additional comments not posted (5)
developers/node-tutorial.md (5)
271-272: Simplify language to enhance clarity.Consider rephrasing to reduce complexity and enhance understanding.
- All RPC CLI commands have basic flags that can be used to interact with the API; however, none are necessary using default configurations. + All RPC CLI commands have basic flags, but they are optional with default configurations.
Line range hint
396-427: Approve removal of--node.storeflag in blob submission commands.The removal of the
--node.storeflag from the blob submission commands aligns with the new automated handling of the node store path. Ensure that all related documentation and examples are updated to reflect this change.
Line range hint
518-540: Approve removal of--node.storeflag in blob retrieval commands for all blobs.The consistent removal of the
--node.storeflag across blob retrieval commands supports the new automated handling of the node store path. This change should simplify the command usage for users.
598-598: Overall approval of updates related to the--node.storeflag.The removal of the
--node.storeflag from various commands is consistent with the objectives of the PR and the linked issue. This should simplify the user experience and reduce the need for manual configuration.Also applies to: 619-627, 648-648, 676-676, 694-703, 797-797, 803-803, 819-831, 839-839, 850-865
Line range hint
473-496: Verify removal of--node.storeflag in blob retrieval commands.The removal of the
--node.storeflag from the blob retrieval commands should be verified to ensure it aligns with the intended behavior in the new version. Check that the automated handling of the node store path is correctly reflected in all examples.Verification successful
Verification successful: The
--node.storeflag has been correctly removed from thecelestia blob getcommands in the documentation. The remaining occurrences of the flag are in different contexts and do not affect the blob retrieval commands.
developers/node-tutorial.mdnodes/celestia-node-troubleshooting.mdScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the removal of `--node.store` flag in blob retrieval commands. # Test: Search for the command usage. Expect: No occurrences of the old flag. rg --type markdown $'celestia blob get'Length of output: 938
Script:
#!/bin/bash # Description: Verify the removal of `--node.store` flag in blob retrieval commands. # Test: Search for the presence of the --node.store flag in the relevant markdown files. rg --type markdown '--node.store'Length of output: 448
Script:
#!/bin/bash # Description: Verify the removal of `--node.store` flag in blob retrieval commands. # Test: Search for the presence of the --node.store flag in the relevant markdown files using correct ripgrep syntax. rg --type markdown -e '--node.store'Length of output: 1124
| :::note | ||
| Previously, the `node.store` flag had to be specified manually for each | ||
| request. This has changed in v0.14.0+ and you can | ||
| [read more about the implementation in celestia-node troubleshooting](../nodes/celestia-node-troubleshooting.md#changing-the-location-of-your-node-store). | ||
| ::: | ||
|
|
There was a problem hiding this comment.
Clarification and link addition needed for node.store flag change.
While the note mentions the change in the usage of the node.store flag, it would be beneficial for users if a direct link to the section discussing this change in detail is provided.
| This is only required if you are using a non-default node store path. | ||
|
|
||
| To set your node store for a light node on {{constants.mochaChainId}}, | ||
| To set a custom node store for a light node on {{constants.mochaChainId}}, | ||
| you can use the following command: | ||
|
|
||
| ```bash-vue | ||
| export NODE_STORE=$HOME/.celestia-light-{{constants.mochaChainId}} | ||
| export NODE_STORE=$HOME/your-custom-path/celestia-light-{{constants.mochaChainId}} |
There was a problem hiding this comment.
Clarify the need for custom node store paths.
The instructions for setting a custom node store path are clear, but adding a brief explanation of why a user might need or want to use a custom path can provide better context and help users make informed decisions.
| If you are using a private and custom network with a custom node store path, | ||
| you will **need to set the location of the node store in your auth command.** | ||
| ::: | ||
|
|
||
| ```bash | ||
| --node.store $HOME/.celestia-light-private) | ||
| --node.store $HOME/your-custom-path/.celestia-light-private |
There was a problem hiding this comment.
Emphasize the necessity of setting the node store location in custom networks.
The tip about needing to set the node store location for custom and private networks is crucial and should be highlighted or made more prominent to ensure users do not overlook this requirement.
| @@ -359,7 +367,7 @@ | |||
|
|
|||
| # Set auth token | |||
| export AUTH_TOKEN=$(celestia light auth admin --p2p.network private \ | |||
| --node.store $HOME/.celestia-light-robusta-22) | |||
| --node.store $HOME/your-custom-path/.celestia-light-robusta-22) | |||
There was a problem hiding this comment.
Ensure consistency in custom network setup instructions.
The instructions for setting up a custom network and the associated auth token use different node store paths. This inconsistency could confuse users. It would be helpful to standardize the node store path across these instructions.
| @@ -566,8 +571,7 @@ | |||
| To set a higher gas price of 0.004 utia, use the `--gas.price 0.004` flag: | |||
|
|
|||
| ```bash | |||
| celestia blob submit 0x42690c204d39600fddd3 'gm' --gas.price 0.004 \ | |||
| --node.store $NODE_STORE | |||
| celestia blob submit 0x42690c204d39600fddd3 'gm' --gas.price 0.004 | |||
There was a problem hiding this comment.
Clarify the usage of the --gas.price flag.
The introduction of the --gas.price flag in the context of submitting blobs should be accompanied by clear documentation on its usage and implications on transaction costs.
Overview
Resolves #1531
This PR should be merged after feature is live in v0.14.xx in a celestia-node release, Mainnet Beta, Mocha, and Arabica.
Summary by CodeRabbit
node-tutorial.mdto reflect the removal of the--node.storeflag from various Celestia API commands.celestia-node-key.md.celestia-node-troubleshooting.md, including new examples and assumptions on network and node type orders.