-
Notifications
You must be signed in to change notification settings - Fork 372
refactor(nns): Replace pb_api with api #8256
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
base: master
Are you sure you want to change the base?
Conversation
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.
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
f661a67 to
6e13c06
Compare
91c76d6 to
52fb90f
Compare
No behavior change - trivial renaming
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.
Pull request overview
This pull request performs a straightforward refactoring to rename the pb_api alias to api throughout the codebase. The change is motivated by the fact that the Governance API types are no longer protocol buffer (pb) types, making the old name misleading. This is a pure rename operation with no functional changes.
Key Changes
- Renamed the import alias from
use ic_nns_governance_api as pb_apitouse ic_nns_governance_api as api - Updated all references to
pb_api::to useapi::instead - Updated function names containing
pb_apito useapi(e.g.,convert_guest_launch_measurements_from_pb_to_pb_api→convert_guest_launch_measurements_from_pb_to_api)
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| rs/nns/governance/src/pb/proposal_conversions.rs | Updated import alias and all type references from pb_api to api throughout conversion functions |
| rs/nns/governance/src/pb/conversions/tests.rs | Updated test code to use api instead of pb_api |
| rs/nns/governance/src/pb/conversions/mod.rs | Extensive updates to conversion implementations and function names to use api instead of pb_api |
| rs/nns/governance/src/governance/tests/neurons_fund.rs | Updated test code to use api instead of pb_api |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The Governance API types are no longer pb, so it shouldn't be called pb_api. This PR is simply s/pb_api/api/.