-
Notifications
You must be signed in to change notification settings - Fork 19
process: add docs for adding readonly request access #130
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
v9n
wants to merge
5
commits into
canton-foundation:main
Choose a base branch
from
fivenorth-io:add-docs-for-adding-readonly-ip
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
f74b81f
add docs for adding readonly request access
v9n b0bed08
Update processes/new-whitelisted-ip.md
v9n fe3a429
Update processes/new-whitelisted-ip.md
v9n d912a92
Merge branch 'main' into add-docs-for-adding-readonly-ip
v9n 4ef7eb3
Merge branch 'main' into add-docs-for-adding-readonly-ip
v9n File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||
|---|---|---|---|---|
|
|
@@ -33,3 +33,45 @@ You can use the script [new-whitelist.sh](https://github.com/global-synchronizer | |||
| #### 3. Notes | ||||
|
|
||||
| - SV operators are encouraged to document their current practices during review of this draft. | ||||
|
|
||||
|
|
||||
| ## How to Request Read-Only Access for Your IP Address | ||||
|
|
||||
| ### Purpose | ||||
|
|
||||
| This process allows an IP address to reach the **scan endpoint** of the **SV** (Synchronizer-Validator). It will not be able to access other components such as the **sequencer** or **CometBFT**. The primary purpose is to serve read-only applications such as **chain analytics** or **explorers**. | ||||
|
|
||||
| ### Process | ||||
|
|
||||
| Similar to the "`How to Ask for a New Whitelisted IP Process`" section above, you will need to submit a **PR** (Pull Request) to the same repository and file. | ||||
|
|
||||
| For each network, locate the `read-only clients` section in the `config/<(DevNet|Testnet|Mainnet)>/allowed-ip-ranges.json` file and add a new element in this format: | ||||
|
|
||||
| ``` | ||||
| "<org-name> / <operator-name-or-sponsor-name>" : [ | ||||
| "ip1/32", | ||||
| "ip2/32" | ||||
| ] | ||||
| ``` | ||||
|
|
||||
| When the organization runs the node themselves, list the sponsor in the second part after the dash (/). | ||||
|
|
||||
| The key needs to be sorted. You can perform a sort with a one-line script: | ||||
|
|
||||
| ``` | ||||
| jq '."read-only clients" |= (to_entries | sort_by(.key | ascii_downcase) | from_entries)' configs/<(DevNet|Testnet|Mainnet)>/allowed-ip-ranges.json > tmp.json && mv tmp.json configs/MainNet/allowed-ip-ranges.json | ||||
| ``` | ||||
|
|
||||
| Alternatively, you can use the script [new-whitelist.sh](https://github.com/global-synchronizer-foundation/configs-private/blob/main/scripts/new-whitelist.sh), which automates most of the steps above, including PR creation. | ||||
|
|
||||
| Currently, only individual IPs are allowed, so you will need to explicitly write out multiple `/32` entries if you have a range. There isn't an official limit on how many IPs are allowed, but keep it fewer than three. | ||||
|
|
||||
| Unlike validator IPs, read-only access IP addresses can be reused across all network environments (**Dev**, **Test**, and **Main**). | ||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Outdated, that's allowed for validator IPs now too |
||||
|
|
||||
| When submitting the PR, briefly provide information about: | ||||
|
|
||||
| * The application and the organization | ||||
|
|
||||
| * The access pattern your app will generate | ||||
|
|
||||
| * Your plan to ensure a reasonable request rate to the scan application, especially spreading the load across SV scans to avoid overloading an individual scan. Overloading may result in your IP being rate-limited and blocked by certain SVs. | ||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.