-
Notifications
You must be signed in to change notification settings - Fork 207
chore: audit documentation #243
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
chore: audit documentation #243
Conversation
- update CONFIGURATION.md & FEES.md to provide security guidance for handling free/fixed fees and fee payer policies - add security warnings for FREE configuration to config validator Closes PRO-504
- update CONFIGURATION.md to warn about permanent delegate risk closes PRO-505
- Updates FEES.md to specifiy that calculation model is only used for margin option. Renamed "Price Adjustment" to "Margin Adjustment" and improved clarity of explanation to reflect actual behavior - Nit: updated Last updated of CONFIGURATION.md Closes PRO-506
- Update CONFIGURATION.md to include additional detail about the permanent limits of `useage_limit` Closes PRO-507
- updates CONFIGURATION.md with increased warning for feepayer policies (note: seperate PR will update this based on new fee payer policy configuration) Closes PRO-508
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.
Caution
Changes requested ❌
Reviewed everything up to ab5c034 in 1 minute and 45 seconds. Click for details.
- Reviewed
314lines of code in3files - Skipped
0files when reviewing. - Skipped posting
1draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. docs/operators/CONFIGURATION.md:8
- Draft comment:
The Overview bullet list has duplicate entries (e.g. 'RPC method availability' and 'Fee pricing models' appear twice). Consider removing the redundancies to improve clarity. - Reason this comment was not posted:
Comment was not on a location in the diff, so it can't be submitted as a review comment.
Workflow ID: wflow_Jv4ZX1QfCC8eAQaG
You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.
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.
Important
Looks good to me! 👍
Reviewed e17b2a4 in 1 minute and 13 seconds. Click for details.
- Reviewed
106lines of code in1files - Skipped
0files when reviewing. - Skipped posting
1draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. crates/lib/src/validator/config_validator.rs:257
- Draft comment:
Removed the entire PriceModel::Free branch (warnings on allow_transfer settings) and replaced it with a no-op (_ => {}). Confirm that security warnings for free pricing are intentionally removed and that documentation reflects this change. - Reason this comment was not posted:
Comment looked like it was already resolved.
Workflow ID: wflow_9FP1BE9qyBbazhvA
You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.
FEES.md(closes PRO-506)Closes PRO-503
Important
Update documentation to address security and configuration issues related to pricing models and fee payer policies, including new warnings and recommendations.
CONFIGURATION.mdto include security considerations forPermanentDelegateextension and fee payer policy settings.FEES.mdto clarify fee calculation components and pricing models.PermanentDelegateextension and fixed/free pricing models.CONFIGURATION.md.This description was created by
for e17b2a4. You can customize this summary. It will automatically update as commits are pushed.