imp: documentation improvements#181
Merged
Merged
Conversation
- Makefile: point EARN_PROGRAM_ID at the live v2 earn program
(mz2vDzjb..., matches lib.rs declare_id); previous value targeted
the legacy v1 deployment. NOTE for ops review: this changes the
target of make upgrade-earn-{devnet,mainnet}.
- Makefile: drop publish-api-sdk (services/api was removed) and
prune .PHONY entries for nonexistent targets.
- pnpm-workspace.yaml: remove nonexistent dashboard package.
- tests/package.json: drop deleted portal/ext_earn test files
from default jest pattern.
- package.json: remove cli:test script (services/cli/test.ts
does not exist).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- README: drop v1 claim-cycle/cooldown design prose and the v1 program diagram reference; describe ScaledUiAmount yield flow, actual repo layout, and correct toolchain prerequisites (Solana 2.1.0, Anchor 0.31.1, Rust 1.75, pnpm; was 1.18.10 / 0.29.0 / Yarn). Document the build-test-earn-programs step. - CLAUDE.md: earn is the only program in this repo (portal -> solana-portal, ext_earn -> solana-m-extensions); correct program IDs (v2 earn live, v1 marked legacy); complete feature flag list; remove nonexistent services/api and upgrade targets. - sdk/README: fix broken example (undefined vars, wrong call signatures) using verified method signatures; document exports and MongoDB requirement. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Uniform Purpose / Run / Configuration structure; env vars verified against source (shared/environment.ts is the canonical table for common vars, services list only their extras). programs/earn README is the single home for instruction reference, PDAs, mint extension requirements, index->multiplier math, and feature flags. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…s config - README/CLAUDE.md: make build-test-earn-programs moves the regular build artifacts, so anchor build -p earn must re-run afterwards (verified empirically; matches CI order in .github/setup/action.yml). - pnpm-workspace.yaml: pnpm 11 migrated ignoredBuiltDependencies/ onlyBuiltDependencies to allowBuilds; values resolved to match the previous explicit allow/ignore sets. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The v2 earn program is already deployed on mainnet, so the upgrade-earn-* targets (which upgrade the legacy v1 program) are kept for historic reference only. Revert the EARN_PROGRAM_ID change and note this in the Makefile and CLAUDE.md instead. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The note about the upgrade-earn-* targets being historic now sits directly above those targets; the variable name makes explicit that they operate on the legacy v1 program. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refreshes and expands repository documentation to reflect the current Solana $M architecture (Token-2022 + ScaledUiAmount; earn as the only on-chain program in this repo) and documents the surrounding off-chain tooling (services and substreams). It also includes a few small build/test and workspace hygiene updates.
Changes:
- Added/updated READMEs across the repo to document system flow, service responsibilities, and how to run/build/test components.
- Updated build/deploy ergonomics and naming in the Makefile (incl. clarifying legacy v1 earn upgrade targets).
- Tweaked workspace/scripts (pnpm workspace config, removed an unused root script, adjusted tests package
pnpm testcommand).
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
tests/package.json |
Adjusts the default Jest pnpm test command for the tests package. |
substreams/README.md |
New documentation for substreams layout and deployment workflow. |
services/yield-bot/README.md |
New run/signing/config documentation for yield-bot. |
services/switchboard/README.md |
New documentation for the Switchboard feed tooling and env vars. |
services/shared/README.md |
New documentation for the internal shared service library and common env vars. |
services/index-bot/README.md |
New documentation for index-bot purpose, run, and configuration. |
services/cli/README.md |
New documentation for the admin CLI and its commands/config. |
sdk/README.md |
Expanded SDK overview, exports list, sample usage, and build/publish notes. |
README.md |
Rewrites top-level overview to match current architecture and adds updated build/test/lint instructions. |
programs/earn/README.md |
New program-specific documentation: instructions, PDAs, math, features, and build/test. |
pnpm-workspace.yaml |
Workspace cleanup (drops dashboard) and adds build-related pnpm workspace settings. |
package.json |
Removes an unused cli:test script. |
Makefile |
Updates phony targets list, clarifies legacy v1 earn upgrade targets, removes an unused publish target. |
CLAUDE.md |
Updates repo guidance to match current architecture, commands, and key addresses. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Oighty
approved these changes
Jun 24, 2026
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
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.
This PR improves the repo's contained documentation, like extending
README.md, updatingCLAUDE.md, add corresponding documents for the different (previously undocumented) parts like CLI commands, services, etc.