docs: clarify SNS ledger fee parameter updates#10609
Conversation
daniel-wong-dfinity-org-twin
left a comment
There was a problem hiding this comment.
Ideally, we'd get rid of this footgun, but ofc, that would require more effort, which we do not want to spend now.
There was a problem hiding this comment.
This pull request changes code owned by the Governance team. Therefore, make sure that
you have considered the following (for Governance-owned code):
-
Update
unreleased_changelog.md(if there are behavior changes, even if they are
non-breaking). -
Are there BREAKING changes?
-
Is a data migration needed?
-
Security review?
How to Satisfy This Automatic Review
-
Go to the bottom of the pull request page.
-
Look for where it says this bot is requesting changes.
-
Click the three dots to the right.
-
Select "Dismiss review".
-
In the text entry box, respond to each of the numbered items in the previous
section, declare one of the following:
-
Done.
-
$REASON_WHY_NO_NEED. E.g. for
unreleased_changelog.md, "No
canister behavior changes.", or for item 2, "Existing APIs
behave as before.".
Brief Guide to "Externally Visible" Changes
"Externally visible behavior change" is very often due to some NEW canister API.
Changes to EXISTING APIs are more likely to be "breaking".
If these changes are breaking, make sure that clients know how to migrate, how to
maintain their continuity of operations.
If your changes are behind a feature flag, then, do NOT add entrie(s) to
unreleased_changelog.md in this PR! But rather, add entrie(s) later, in the PR
that enables these changes in production.
Reference(s)
For a more comprehensive checklist, see here.
GOVERNANCE_CHECKLIST_REMINDER_DEDUP
|
✅ No security or compliance issues detected. Reviewed everything up to df0ab23. Security Overview
Detected Code Changes
|
Summary
Clarifies the SNS Governance protobuf/API comments around ledger fee updates:
ManageLedgerParameters.transfer_feeis the intended way to change the SNS ledger's actual transfer fee.ManageLedgerParametersexecution also syncsNervousSystemParameters.transaction_fee_e8sin Governance.NervousSystemParameters.transaction_fee_e8sdoes not update the ledger.Why
DAO operators can otherwise infer that changing
transaction_fee_e8sthroughManageNervousSystemParameterschanges the ledger fee. That can leave Governance and the SNS ledger fee out of sync, causing ordinary ledger transfers initiated by Governance to use a stale fee.Validation
git diff --checkrustfmt --check rs/sns/governance/src/gen/ic_sns_governance.pb.v1.rsNo runtime tests were run because this is a comment-only documentation change.