docs(specs): add PFM param

[rootulp]

Closes #3862

[coderabbitai]

Walkthrough

Walkthrough

The pull request introduces a new parameter, packetfowardmiddleware.FeePercentage, to the documentation for the packet forwarding middleware. This parameter specifies the percentage of the forwarded packet amount that is allocated to the community pool, with a default value set to 0. The documentation update enhances clarity regarding the fee structure for users interacting with the middleware without altering existing functionalities.

Changes

Files	Change Summary
specs/src/parameters_v2.md	Added documentation for packetfowardmiddleware.FeePercentage parameter.

Assessment against linked issues

Objective	Addressed	Explanation
Add the param to the specs (#3862)	✅
[optional] add the param to the CIP (#3862)	❌	No changes made to CIP documentation.

---

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

specs/src/parameters_v2.md (1)

57-57: LGTM! Consider adding a comma to improve readability.

The addition of the new packetfowardmiddleware.FeePercentage parameter is well-documented and provides clarity on the fee structure for packet forwarding. Making it changeable via governance is a good decision for future flexibility.

Consider adding a comma after "amount" to improve readability:

-| packetfowardmiddleware.FeePercentage          | 0                                           | % of the forwarded packet amount which will be subtracted and distributed to the community pool.                                    | True                      |
+| packetfowardmiddleware.FeePercentage          | 0                                           | % of the forwarded packet amount, which will be subtracted and distributed to the community pool.                                    | True                      |

Tools

LanguageTool

[uncategorized] ~57-~57: Possible missing comma found.
Context: ... | % of the forwarded packet amount which will be subtracted and distribute...

(AI_HYDRA_LEO_MISSING_COMMA)

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2c53ddb and 5357145.

Files selected for processing (1)

• specs/src/parameters_v2.md (1 hunks)

Additional context used

LanguageTool

specs/src/parameters_v2.md

[uncategorized] ~57-~57: Possible missing comma found.
Context: ... | % of the forwarded packet amount which will be subtracted and distribute...

(AI_HYDRA_LEO_MISSING_COMMA)