docs(readme): align mainnet program IDs, instruction tags, and hyperp mode#2146
Open
asastuai wants to merge 1 commit intodcccrypto:mainfrom
Open
docs(readme): align mainnet program IDs, instruction tags, and hyperp mode#2146asastuai wants to merge 1 commit intodcccrypto:mainfrom
asastuai wants to merge 1 commit intodcccrypto:mainfrom
Conversation
|
@asastuai is attempting to deploy a commit to the Khubair Nasir's projects Team on Vercel. A member of the Team first needs to authorize it. |
📝 WalkthroughWalkthroughREADME documentation updated to reflect new mainnet program addresses for Percolator, Matcher, Stake, and NFT, introduce Pricing Modes and Instruction Tags sections, and document new pricing-focused tests with execution commands. ChangesDocumentation Updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
359-360: ⚡ Quick winAvoid hardcoding the instruction-tag count.
Line 359 will drift again as tags evolve. Since you already link
tags.rs, prefer wording like “see canonical inventory” without a fixed total.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 359 - 360, Replace the hardcoded "80 instruction tags" text with a non-numeric reference to the canonical inventory by rewording the sentence to point readers to the linked tags.rs (the canonical instruction-tag list) instead of asserting a fixed total; update the README phrasing around "instruction tags" to something like "see the canonical inventory in tags.rs" so it won't drift as tags evolve.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@README.md`:
- Around line 359-360: Replace the hardcoded "80 instruction tags" text with a
non-numeric reference to the canonical inventory by rewording the sentence to
point readers to the linked tags.rs (the canonical instruction-tag list) instead
of asserting a fixed total; update the README phrasing around "instruction tags"
to something like "see the canonical inventory in tags.rs" so it won't drift as
tags evolve.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
what
three things in the top-level README that drifted out of sync with the rest of the ecosystem. all in adjacent sections so I bundled them into one PR.
mainnet program ID is stale. the README listed
GM8zjJ8LTBMv9xEsverh6H6wLyevgMHEJXcEzyY3rY24, which has had no transactions since 2026-03-11 and is now frozen (upgrade authority = none). the live mainnet program isESa89R5Es3rJ5mnwGybVRG1GrNt9etP11Z5V2QWD4edv. that's the one already inpercolator-sdk/README.mdand in thedeclare_id!of squid's feat: portfolio PnL tracking + liquidation warnings (PERC-039) #267 in percolator-prog. the launch README also didn't include stake or nft addresses that the SDK README does carry.instruction tag table is out of sync with
percolator-prog/src/tags.rs. the README's "Key Instructions" table had tag numbers that don't match the current program. some examples:Tag 8 = KeeperCrank. program definesTAG_KEEPER_CRANK = 5.Tag 23 = RenounceAdmin. program has noRenounceAdminconstant; tag 23 isTAG_WITHDRAW_INSURANCE_LIMITED.TAG_UPDATE_AUTHORITY = 83(gaps at 16, 17, 31, 57).a contributor or integrator using the README to construct instructions sends to the wrong handler.
hyperp mode is supported and tested but never explained in the README.
tests/t3-hyperp-lifecycle.tsandtests/t10-pricing-engine.tsboth exercise hyperp, but the README only mentions "hyperp" inside test filenames. new integrators have to dig intopercolator-progto learn what it is.why
mainnet IDs verified onchain via
getSignaturesForAddressagainstapi.mainnet-beta.solana.comon 2026-05-05:GM8zjJ8LT...ESa89R5Es...tag list cross-referenced from
dcccrypto/percolator-prog/src/tags.rs(currentmain).changes
README.md: replace inline commentTags 0-28with a pointer topercolator-prog/src/tags.rsas source of truth.README.md: addt10-pricing-engine.tsandt10-pricing-edge-cases.tsto the tests tree.README.md: replace the misnumbered "Key Instructions" table with a grouped overview by use case, with link totags.rsfor canonical numbers.README.md: rewrite the Deployed Programs section. mainnet now usesESa89R5Es.... add stake (DC5fovFQD5SZYsetwvEqd4Wi4PFY1Yfnc669VMe6oa7F) and nft (FqhKJT9gtScjrmfUuRMjeg7cXNpif1fqsy5Jh65tJmTS) addresses.README.md: add t10s to the integration test command list.### Pricing Modes— documents oracle mode vs hyperp mode in 6-8 lines, with pointers to t3-hyperp-lifecycle.ts and percolator-prog/README.md.open question
three READMEs (
percolator-launch,percolator-sdk,percolator-prog) each carry their own program-ID table. the IDs drift between them, this PR is the third instance of fixing one of those drifts I noticed in a week. worth opening a separate issue to discuss centralizing program IDs in one source (e.g. exporting from@percolator/sdkand having every README reference the SDK rather than hardcoding addresses). happy to open that issue if you want.caveat
the launch repo no longer contains a
program/directory locally, per the recent monorepo split documented indocs/plans/2026-02-24-repo-split-plan.md. the Project Structure tree at lines 208-210 still references it. this PR keeps the entry but the comment now points topercolator-progas the source of truth. a fuller restructure of "Project Structure" felt out of scope here, flagging for follow-up.test plan
pnpm installsucceedsESa89R5Es...,DC5fovFQ...,FqhKJT9g...) exist on mainnet viagetAccountInfotags.rslink resolvesSummary by CodeRabbit