improve submitter docs #2824
improve submitter docs #2824
Conversation
|
Warning Rate limit exceeded@trajan0x has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 2 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughRecent updates span across several documentation and technical files to enhance functionality, improve observability, and update configurations and metrics for various modules within the project. Noteworthy additions include observability metrics, updated Grafana dashboard configurations, detailed Submitter module documentation, and other minor enhancements aimed at maintaining coherence and efficiency. Changes
Poem
Tip Early access features: enabledWe are currently testing the following features in early access:
Note:
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 (
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
- Added recommendation to set up the submitter dashboard in
docs/bridge/docs/CCTP/Relayer.md - Updated image paths in
docs/bridge/docs/Services/Signer.md - Comprehensive documentation for Ethergo Submitter module in
docs/bridge/docs/Services/Submitter.md - Enhanced observability section in
docs/bridge/docs/rfq/Relayer/Relayer.md - New section on Grafana Dashboard in
ethergo/submitter/README.md - Updated Grafana dashboard in
ethergo/submitter/dashboard.json - Added new Grafana dashboard configuration in
services/rfq/relayer/dashboards/dashboard.json
7 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings
| "showLineNumbers": false, | ||
| "showMiniMap": false | ||
| }, | ||
| "content": "This is the rfq. It is used to track metrics for the rfq relayer. \n\nIf you update this dashboard please be sure to update the [docs](https://bridge-docs-theta.vercel.app/docs/rfq/Relayer/#observability) at `docs/bridge/` and the dashboard folder in `services/rfq/relayer/dashbords/dashboard.json`", |
There was a problem hiding this comment.
📚 spelling: Typo in the URL path: 'dashbords' should be 'dashboards'.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2824 +/- ##
===================================================
+ Coverage 25.58173% 25.58355% +0.00181%
===================================================
Files 766 766
Lines 54922 54922
Branches 80 80
===================================================
+ Hits 14050 14051 +1
- Misses 39423 39424 +1
+ Partials 1449 1447 -2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Deploying sanguine-fe with
|
| Latest commit: |
ae359fb
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a381b1fa.sanguine-fe.pages.dev |
| Branch Preview URL: | https://fix-document-submitter-dashb.sanguine-fe.pages.dev |
There was a problem hiding this comment.
PR Summary
(updates since last review)
- Added comment in
ethergo/submitter/metrics.goto ensure documentation and Grafana dashboard updates with metric changes. - No major changes found since last review.
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 11
Outside diff range and nitpick comments (18)
ethergo/submitter/README.md (1)
Line range hint
3-3: Add a period after "etc".Ensure proper punctuation for clarity.
Submitter is a module that submits transactions to an evm based-blockchain and bumps them/checks for completion until they are done. It is designed to abstract away gas bumping, confirmation checking, etc from the caller. + etc. from the caller.docs/bridge/docs/Services/Signer.md (5)
Line range hint
5-5: Correct the verb form "setup".The word “setup” is a noun. The verb is spelled with a white space.
## Setup with AWS KMS In order to setup the signer with AWS KMS, you will need to create a KMS key and give the appropriate permissions to a user that will be using the signer. While we do not have IAC (Infrastructure as Code) for this, you can follow the steps below to setup the KMS key and the user. + In order to set up the signer with AWS KMS, you will need to create a KMS key and give the appropriate permissions to a user that will be using the signer. While we do not have IAC (Infrastructure as Code) for this, you can follow the steps below to set up the KMS key and the user.Tools
LanguageTool
[grammar] ~26-~26: There may an error in the verb form ‘be create’.
Context: ...iam-preview-user.png) 5. The user will be create and appear in the list of users. Click ...(MD_BE_NON_VBP)
Markdownlint
11-11: null
Bare URL used(MD034, no-bare-urls)
Line range hint
7-7: Add missing commas.Add commas for better readability.
**Note**: If you already have an IAM user you can skip to the [Create a KMS Key](#create-a-kms-key) section. If you have a custom IAM setup/role skip this and assign the permissions to the user or role you want to use. + **Note**: If you already have an IAM user, you can skip to the [Create a KMS Key](#create-a-kms-key) section. If you have a custom IAM setup/role, skip this and assign the permissions to the user or role you want to use.Tools
LanguageTool
[grammar] ~26-~26: There may an error in the verb form ‘be create’.
Context: ...iam-preview-user.png) 5. The user will be create and appear in the list of users. Click ...(MD_BE_NON_VBP)
Markdownlint
11-11: null
Bare URL used(MD034, no-bare-urls)
Line range hint
97-97: Add a comma before "and".Add a comma for better readability.
Note: this is a very basic example and you should not use this in production. You should store your key in a secure location and use it securely. + Note: this is a very basic example, and you should not use this in production. You should store your key in a secure location and use it securely.Tools
LanguageTool
[grammar] ~26-~26: There may an error in the verb form ‘be create’.
Context: ...iam-preview-user.png) 5. The user will be create and appear in the list of users. Click ...(MD_BE_NON_VBP)
Markdownlint
11-11: null
Bare URL used(MD034, no-bare-urls)
Line range hint
100-108: Fix multiple consecutive blank lines and loose punctuation marks.Remove the extra blank lines and fix the loose punctuation marks for better readability.
- - `signer.yml`: ```yaml signer_config: type: "aws" file: "/path/to/aws.yaml"
aws.yaml:region: "us-east-1" # should match the region of your key! access_key: "YOUR_ACCESS_KEY" access_secret: "YOUR_ACCESS_SECRET" key_id: "f15fa759-7c13-44eb-a868-e7388aa1387b" # this will be the id from above.<details> <summary>Tools</summary> <details> <summary>LanguageTool</summary><blockquote> [grammar] ~26-~26: There may an error in the verb form ‘be create’. Context: ...iam-preview-user.png) 5. The user will be create and appear in the list of users. Click ... (MD_BE_NON_VBP) </blockquote></details> <details> <summary>Markdownlint</summary><blockquote> 11-11: null Bare URL used (MD034, no-bare-urls) </blockquote></details> </details> --- Line range hint `99-99`: **Fix multiple consecutive blank lines.** Remove the extra blank lines for better readability. ```diff - Note: this is a very basic example and you should not use this in production. You should store your key in a secure location and use it securely.Tools
LanguageTool
[grammar] ~26-~26: There may an error in the verb form ‘be create’.
Context: ...iam-preview-user.png) 5. The user will be create and appear in the list of users. Click ...(MD_BE_NON_VBP)
Markdownlint
11-11: null
Bare URL used(MD034, no-bare-urls)
docs/bridge/docs/CCTP/Relayer.md (2)
Line range hint
18-18: Consider replacing "only" with a different word.Consider replacing ‘only’ with a different word to let your writing stand out.
This mode can only be used for USDC to USDC bridges and is not commonly used. + This mode can exclusively be used for USDC to USDC bridges and is not commonly used.
Line range hint
32-32: Consider a more expressive alternative to "To do this".Consider a more expressive alternative for better readability.
The CCTP Relayer can also be run with docker. To do this, you will need to pull the [docker image](https://github.com/synapsecns/sanguine/pkgs/container/sanguine%2Fcctp-relayer) and run it with the config file: + The CCTP Relayer can also be run with docker. To achieve this, you will need to pull the [docker image](https://github.com/synapsecns/sanguine/pkgs/container/sanguine%2Fcctp-relayer) and run it with the config file:docs/bridge/docs/rfq/Relayer/Relayer.md (10)
Line range hint
26-26: Add a comma after 'Right now'.The phrase "Right now" should be followed by a comma for correct punctuation.
- Right now only the CCTP rebalancer is supported and works like this: + Right now, only the CCTP rebalancer is supported and works like this:
Line range hint
28-28: Add a preposition after 'continue'.It seems like a preposition is missing after 'continue'. Consider adding 'with' or 'to' for clarity.
- If the balance is below the `maintenance_balance_pct`, continue + If the balance is below the `maintenance_balance_pct`, continue with
Line range hint
41-41: Add a definite article 'the' before 'transaction'.The phrase "if transaction is finalized" should be "if the transaction is finalized".
- Check the chain to see if transaction is finalized yet, if not wait until it is. + Check the chain to see if the transaction is finalized yet, if not wait until it is.
Line range hint
41-41: Add a comma after 'yet'.The phrase "if not wait until it is" should be "if not, wait until it is".
- Check the chain to see if transaction is finalized yet, if not wait until it is. + Check the chain to see if the transaction is finalized yet, if not, wait until it is.
Line range hint
42-42: Add a comma before 'and'.Use a comma before 'and' if it connects two independent clauses.
- This means the transaction is finalized on chain and we can now relay it to the destination chain. + This means the transaction is finalized on chain, and we can now relay it to the destination chain.
Line range hint
44-44: Add a comma after 'it'.The phrase "Once we get it we mark the transaction" should be "Once we get it, we mark the transaction".
- Listen for the relay in the logs. Once we get it we mark the transaction as [`RelayComplete`](https://pkg.go.dev/github.com/synapsecns/sanguine/services/rfq/relayer/reldb#RelayComplete) + Listen for the relay in the logs. Once we get it, we mark the transaction as [`RelayComplete`](https://pkg.go.dev/github.com/synapsecns/sanguine/services/rfq/relayer/reldb#RelayComplete)
Line range hint
61-61: Consider a more expressive alternative to 'To do this'.The phrase "To do this" is a bit wordy. Consider using a more concise alternative.
- To do this, you will need to pull the [docker image](https://github.com/synapsecns/sanguine/pkgs/container/sanguine%2Frfq-relayer) and run it with the config file: + Simply pull the [docker image](https://github.com/synapsecns/sanguine/pkgs/container/sanguine%2Frfq-relayer) and run it with the config file:
Line range hint
87-87: Use a proper markdown link instead of a bare URL.Replace the bare URL with a proper markdown link.
- You can install Go by following the instructions [here](https://golang.org/doc/install). + You can install Go by following the instructions [here](https://golang.org/doc/install).
Line range hint
88-88: Use a proper markdown link instead of a bare URL.Replace the bare URL with a proper markdown link.
- git clone https://github.com/synapsecns/sanguine --recursive + `git clone https://github.com/synapsecns/sanguine --recursive`
Line range hint
89-89: Use a proper markdown link instead of a bare URL.Replace the bare URL with a proper markdown link.
- docker run ghcr.io/synapsecns/sanguine/rfq-relayer:latest --config /path/to/config + `docker run ghcr.io/synapsecns/sanguine/rfq-relayer:latest --config /path/to/config`
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files ignored due to path filters (18)
docs/bridge/docs/Services/img/signer/aws/create-acces-key.pngis excluded by!**/*.pngdocs/bridge/docs/Services/img/signer/aws/create-access-key.pngis excluded by!**/*.pngdocs/bridge/docs/Services/img/signer/aws/iam-dash.pngis excluded by!**/*.pngdocs/bridge/docs/Services/img/signer/aws/iam-preview-user.pngis excluded by!**/*.pngdocs/bridge/docs/Services/img/signer/aws/key-details.pngis excluded by!**/*.pngdocs/bridge/docs/Services/img/signer/aws/kms-1.pngis excluded by!**/*.pngdocs/bridge/docs/Services/img/signer/aws/kms-2.pngis excluded by!**/*.pngdocs/bridge/docs/Services/img/signer/aws/kms-advanced.pngis excluded by!**/*.pngdocs/bridge/docs/Services/img/signer/aws/kms-labels.pngis excluded by!**/*.pngdocs/bridge/docs/Services/img/signer/aws/kms-permissons.pngis excluded by!**/*.pngdocs/bridge/docs/Services/img/signer/aws/kms-user-permissions.pngis excluded by!**/*.pngdocs/bridge/docs/Services/img/signer/aws/kms-user.pngis excluded by!**/*.pngdocs/bridge/docs/Services/img/signer/aws/perms.pngis excluded by!**/*.pngdocs/bridge/docs/Services/img/signer/aws/review.pngis excluded by!**/*.pngdocs/bridge/docs/Services/img/signer/aws/user-list.pngis excluded by!**/*.pngdocs/bridge/docs/Services/img/signer/aws/user-perms.pngis excluded by!**/*.pngdocs/bridge/docs/Services/img/submitter/metrics.pngis excluded by!**/*.pngdocs/bridge/docs/rfq/Relayer/dashboard.pngis excluded by!**/*.png
Files selected for processing (7)
- docs/bridge/docs/CCTP/Relayer.md (1 hunks)
- docs/bridge/docs/Services/Signer.md (2 hunks)
- docs/bridge/docs/Services/Submitter.md (1 hunks)
- docs/bridge/docs/rfq/Relayer/Relayer.md (1 hunks)
- ethergo/submitter/README.md (1 hunks)
- ethergo/submitter/dashboard.json (18 hunks)
- services/rfq/relayer/dashboards/dashboard.json (1 hunks)
Files skipped from review due to trivial changes (1)
- services/rfq/relayer/dashboards/dashboard.json
Additional context used
LanguageTool
docs/bridge/docs/Services/Submitter.md
[uncategorized] ~30-~30: Loose punctuation mark.
Context: .... The metrics are: -num_pending_txs: The number of pending transactions. - ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...pending transactions. -current_nonce: The current nonce. - `oldest_pending_t...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~32-~32: Loose punctuation mark.
Context: ...he current nonce. -oldest_pending_tx: The age of the oldest pending transacti...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~33-~33: Loose punctuation mark.
Context: ...ending transaction. -confirmed_queue: The number of confirmed transactions. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~34-~34: Loose punctuation mark.
Context: ...confirmed transactions. -gas_balance: The current gas balance. The metrics ...(UNLIKELY_OPENING_PUNCTUATION)
ethergo/submitter/README.md
[style] ~3-~3: In American English, abbreviations like “etc.” require a period.
Context: ...way gas bumping, confirmation checking, etc from the caller. ## Understanding `Su...(ETC_PERIOD)
docs/bridge/docs/Services/Signer.md
[grammar] ~5-~5: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...ner ## Setup with AWS KMS In order to setup the signer with AWS KMS, you will need ...(NOUN_VERB_CONFUSION)
[grammar] ~5-~5: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...this, you can follow the steps below to setup the KMS key and the user. Note: If...(NOUN_VERB_CONFUSION)
[uncategorized] ~7-~7: Possible missing comma found.
Context: .... Note: If you already have an IAM user you can skip to the [Create a KMS Key](...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~7-~7: Possible missing comma found.
Context: ...section. If you have a custom IAM setup/role skip this and assign the permissions to...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~26-~26: There may an error in the verb form ‘be create’.
Context: ...iam-preview-user.png) 5. The user will be create and appear in the list of users. Click ...(MD_BE_NON_VBP)
[uncategorized] ~71-~71: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...key in the signer. The field is required but the value doesn't matter. - Description...(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~87-~87: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...review.png) 7. Your key will be created and you will be redirected to the key detai...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~97-~97: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...key. Note: this is a very basic example and you should not use this in production. ...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~100-~100: Loose punctuation mark.
Context: ...tion and use it securely.signer.yml: ```yaml signer_config: type: "aws" ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~107-~107: Loose punctuation mark.
Context: ...ile: "/path/to/aws.yaml"`aws.yaml`:yaml region: "us-east-1" # should ma...(UNLIKELY_OPENING_PUNCTUATION)
-docs/bridge/docs/CCTP/Relayer.md
[style] ~18-~18: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ....sol) events are relayed. This mode can only be used for USDC to USDC bridges and is...(ONLY_EXCLUSIVELY_STYLE)
[style] ~32-~32: Consider a more expressive alternative.
Context: ...Relayer can also be run with docker. To do this, you will need to pull the [docker...(DO_ACHIEVE)
[uncategorized] ~96-~96: Loose punctuation mark.
Context: ...559: true ```cctp_type: The type of CCTP to listen to. Can be e...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~96-~96: To form a complete sentence, be sure to include a subject or ‘there’.
Context: ...p_type: The type of CCTP to listen to. Can be eithersynapseorcircle. -ch...(MISSING_IT_THERE)
[uncategorized] ~97-~97: Loose punctuation mark.
Context: ...ithersynapseorcircle. -chains: A list of chain ids and their correspon...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~98-~98: Loose punctuation mark.
Context: ...d if both are set. -base_omnirpc_url: The base URL for the OmniRPC service. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~99-~99: Loose punctuation mark.
Context: ...he OmniRPC service. -unbonded_signer: The signer to use for transactions. Can...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~99-~99: To form a complete sentence, be sure to include a subject or ‘there’.
Context: ...r: The signer to use for transactions. Can be eitherAWS,FileorGCP`. The f...(MISSING_IT_THERE)
[uncategorized] ~100-~100: Loose punctuation mark.
Context: ...nd here. -port: The port to run the relayer on (e.g. 80...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~103-~103: Loose punctuation mark.
Context: ... in milliseconds. -retry_interval_ms: The interval to wait between attestatio...(UNLIKELY_OPENING_PUNCTUATION)
docs/bridge/docs/rfq/Relayer/Relayer.md
[style] ~11-~11: Consider a shorter alternative to avoid wordiness.
Context: ...n the origin chain. - Rebalancing - In order to handle the complexity of user flows, th...(IN_ORDER_TO_PREMIUM)
[typographical] ~26-~26: It appears that a comma is missing after this introductory phrase.
Context: ...yer has enough liquidity on each chain. Right now only the CCTP rebalancer is supported a...(RIGHT_NOW_PUNCTUATION_COMMA)
[grammar] ~28-~28: Probably a preposition is missing after ‘continue’.
Context: ...is below themaintenance_balance_pct, continue 2. Calculate the amount to rebalance by taking the d...(ATD_VERBS_TO_COLLOCATION)
[style] ~30-~30: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ebalance to themax_rebalance_amount. If the amount to rebalance is less than th...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~41-~41: Possible missing article found.
Context: ...committed. 1. Check the chain to see if transaction is finalized yet, if not wait until it ...(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~41-~41: Possible missing comma found.
Context: ...see if transaction is finalized yet, if not wait until it is. 1. Once the transacti...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~42-~42: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ns the transaction is finalized on chain and we can now relay it to the destination ...(COMMA_COMPOUND_SENTENCE)
[typographical] ~44-~44: There might be a comma missing.
Context: ... for the relay in the logs. Once we get it we mark the transaction as [`RelayCompl...(IF_PRP_PRP_COMMA)
[style] ~61-~61: Consider a more expressive alternative.
Context: ...relayer can also be run with docker. To do this, you will need to pull the [docker...(DO_ACHIEVE)
Markdownlint
docs/bridge/docs/Services/Submitter.md
30-30: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
31-31: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
32-32: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
33-33: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
34-34: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
36-36: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
5-5: null
Multiple top-level headings in the same document(MD025, single-title, single-h1)
ethergo/submitter/README.md
5-5: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
50-50: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
51-51: Expected: 1; Actual: 3
Multiple consecutive blank lines(MD012, no-multiple-blanks)
52-52: Expected: 1; Actual: 4
Multiple consecutive blank lines(MD012, no-multiple-blanks)
docs/bridge/docs/Services/Signer.md
39-39: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
99-99: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
50-50: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
101-101: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
108-108: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
51-51: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
11-11: null
Bare URL used(MD034, no-bare-urls)
51-51: null
Bare URL used(MD034, no-bare-urls)
docs/bridge/docs/CCTP/Relayer.md
5-5: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
96-96: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
97-97: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
98-98: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
99-99: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
100-100: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
101-101: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
102-102: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
103-103: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
18-18: Expected: #configuration; Actual: #Configuration
Link fragments should be valid(MD051, link-fragments)
docs/bridge/docs/rfq/Relayer/Relayer.md
20-20: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
21-21: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
22-22: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
218-218: Column: 5
Hard tabs(MD010, no-hard-tabs)
17-17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
181-181: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
87-87: null
Bare URL used(MD034, no-bare-urls)
88-88: null
Bare URL used(MD034, no-bare-urls)
89-89: null
Bare URL used(MD034, no-bare-urls)
167-167: null
Bare URL used(MD034, no-bare-urls)
175-175: null
Bare URL used(MD034, no-bare-urls)
181-181: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Gitleaks
docs/bridge/docs/Services/Signer.md
112-112: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
docs/bridge/docs/rfq/Relayer/Relayer.md
109-109: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
129-129: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
171-171: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
174-174: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
Additional comments not posted (10)
docs/bridge/docs/Services/Submitter.md (1)
11-17: Correct list indentation and punctuation.Ensure consistent indentation and punctuation in the list items.
- - **Transaction Submission**: The main function of the module is the `SubmitTransaction` method, which returns a nonce and ensures that the transaction will eventually be confirmed. - - **Gas Bumping**: Automatically adjusts the gas price to ensure timely transaction confirmation. - - **Confirmation Checking**: Continuously checks the status of submitted transactions to confirm their inclusion in the blockchain. - - **Reaper Functionality**: Flushes old entries in the database that have reached a terminal state. + - **Transaction Submission**: The main function of the module is the `SubmitTransaction` method, which returns a nonce and ensures that the transaction will eventually be confirmed. + - **Gas Bumping**: Automatically adjusts the gas price to ensure timely transaction confirmation. + - **Confirmation Checking**: Continuously checks the status of submitted transactions to confirm their inclusion in the blockchain. + - **Reaper Functionality**: Flushes old entries in the database that have reached a terminal state.Likely invalid or redundant comment.
docs/bridge/docs/rfq/Relayer/Relayer.md (2)
224-227: Good documentation on observability.The section provides detailed information about the observability features of the relayer, including metrics and Grafana dashboards.
228-231: Good documentation on metrics.The section provides a clear and concise list of the metrics exposed by the relayer.
ethergo/submitter/dashboard.json (7)
26-31: Good documentation on required plugins.The section provides a clear list of the required plugins and their versions.
67-86: Good documentation on the "Submitter Dashboard" panel.The section provides a clear configuration for the "Submitter Dashboard" panel.
88-99: Good documentation on the "Submitter" panel.The section provides a clear configuration for the "Submitter" panel.
Line range hint
160-196: Good documentation on the "Pending Transactions" panel.The section provides a clear configuration for the "Pending Transactions" panel.
Line range hint
228-295: Good documentation on the "Nonce" panel.The section provides a clear configuration for the "Nonce" panel.
Line range hint
327-395: Good documentation on the "Oldest Pending TX" panel.The section provides a clear configuration for the "Oldest Pending TX" panel.
Line range hint
427-494: Good documentation on the "Confirmed Queue Size" panel.The section provides a clear configuration for the "Confirmed Queue Size" panel.
|
|
||
| 3. Choose `Next` and fill in the following options: | ||
|
|
||
|  | ||
|  | ||
|
|
||
| - Alias: This is an alias that will be used to reference the key in the signer. The field is required but the value doesn't matter. |
There was a problem hiding this comment.
Add a comma before "but".
Add a comma for better readability.
- Alias: This is an alias that will be used to reference the key in the signer. The field is required but the value doesn't matter.
+ - Alias: This is an alias that will be used to reference the key in the signer. The field is required, but the value doesn't matter.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.
| - Alias: This is an alias that will be used to reference the key in the signer. The field is required but the value doesn't matter. | |
| - Alias: This is an alias that will be used to reference the key in the signer. The field is required, but the value doesn't matter. |
Tools
LanguageTool
[uncategorized] ~71-~71: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...key in the signer. The field is required but the value doesn't matter. - Description...(COMMA_COMPOUND_SENTENCE_2)
|
|
||
| 4. Add tags if you want and click `Create User` | ||
|
|
||
|  | ||
|  | ||
|
|
||
| 5. The user will be create and appear in the list of users. Click on the user to view the user details. |
There was a problem hiding this comment.
Fix verb form "be create".
Correct the verb form for grammatical accuracy.
5. The user will be create and appear in the list of users. Click on the user to view the user details.
+ 5. The user will be created and appear in the list of users. Click on the user to view the user details.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.
| 5. The user will be create and appear in the list of users. Click on the user to view the user details. | |
| 5. The user will be created and appear in the list of users. Click on the user to view the user details. |
Tools
LanguageTool
[grammar] ~26-~26: There may an error in the verb form ‘be create’.
Context: ...iam-preview-user.png) 5. The user will be create and appear in the list of users. Click ...(MD_BE_NON_VBP)
|
|
||
| 8. Click on `Create access key` | ||
|
|
||
|  | ||
|  | ||
|
|
||
| Note down the `Access key ID` and `Secret access key` as you will need these to configure the signer. | ||
|
|
||
| ### Create a KMS Key | ||
| 1. Sign in to the AWS Management Console and open the KMS console at https://console.aws.amazon.com/kms. |
There was a problem hiding this comment.
Avoid bare URLs.
Use markdown link syntax instead of bare URLs.
1. Sign in to the AWS Management Console and open the KMS console at https://console.aws.amazon.com/kms.
+ 1. Sign in to the AWS Management Console and open the KMS console at [AWS KMS Console](https://console.aws.amazon.com/kms).Committable suggestion was skipped due to low confidence.
Tools
Markdownlint
51-51: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
51-51: null
Bare URL used(MD034, no-bare-urls)
| @@ -9,23 +9,23 @@ | |||
| ### Create an IAM User | |||
|
|
|||
| 1. Sign in to the AWS Management Console and open the IAM console at https://console.aws.amazon.com/iam. | |||
There was a problem hiding this comment.
Avoid bare URLs.
Use markdown link syntax instead of bare URLs.
1. Sign in to the AWS Management Console and open the IAM console at https://console.aws.amazon.com/iam.
+ 1. Sign in to the AWS Management Console and open the IAM console at [AWS IAM Console](https://console.aws.amazon.com/iam).Committable suggestion was skipped due to low confidence.
Tools
Markdownlint
11-11: null
Bare URL used(MD034, no-bare-urls)
|
|
||
| 6. Choose `Next` and review your key settings. If everything looks good, choose `Finish`. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| 7. Your key will be created and you will be redirected to the key details page. Note down the `Key ID` as you will need this to configure the signer. |
There was a problem hiding this comment.
Add a comma before "and".
Add a comma for better readability.
7. Your key will be created and you will be redirected to the key details page. Note down the `Key ID` as you will need this to configure the signer.
+ 7. Your key will be created, and you will be redirected to the key details page. Note down the `Key ID` as you will need this to configure the signer.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.
| 7. Your key will be created and you will be redirected to the key details page. Note down the `Key ID` as you will need this to configure the signer. | |
| 7. Your key will be created, and you will be redirected to the key details page. Note down the `Key ID` as you will need this to configure the signer. |
Tools
LanguageTool
[uncategorized] ~87-~87: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...review.png) 7. Your key will be created and you will be redirected to the key detai...(COMMA_COMPOUND_SENTENCE)
There was a problem hiding this comment.
PR Summary
(updates since last review)
- Added sorting functionality for slices of big integers in
/ethergo/submitter/util_test.go - Introduced new type
bigIntSlicefor sorting - Updated
TestMapToBigIntSliceandTestMapToBigIntSliceWithStructto include sorting before comparison
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings
There was a problem hiding this comment.
PR Summary
(updates since last review)
- Documentation
- Updated observability sections in
docs/bridge/docs/CCTP/Relayer.mdanddocs/bridge/docs/rfq/Relayer/Relayer.mdto recommend setting up the submitter dashboard for enhanced monitoring.
- Updated observability sections in
No major changes found since last review.
2 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings
Description
Adds documentation for the submitter dashboard
Summary by CodeRabbit
Documentation
New Features
Chores