docs: sharpen top-level README and fix inaccurate test/dependency docs#88
Merged
Conversation
Drop the "DeFi" framing in favor of a description that points at what actually differentiates this repo (documented invariants, LiteSVM test suites) and add the finance/lending example, which existed on disk but was never linked from the README.
The previous commit accidentally wrote a base64-encoded string as the literal file content instead of plain text, truncating the README. This restores the full file with the intended Financial Software section edits.
Replace the overwrought intro paragraph with a single sentence; each program already has its own description below, so the intro doesn't need to enumerate primitives or invariants.
- State the concrete toolchain (Anchor 1.1, multi-file layout, LiteSVM)
instead of a vague "current toolchain" claim.
- Orient newcomers ("what other chains call smart contracts").
- Fix the test instructions: examples run via their framework's command
(anchor test / cargo test / quasar test), not `pnpm test` — most
example dirs have no package.json. Reconcile the frameworks list and
Getting Started so they agree.
- Move the Solana Foundation acknowledgement to its own section near the
footer so it credits the origin without framing the top of the page.
- Tests run via the framework command (anchor test / cargo test / quasar test), not `pnpm test`; most example dirs have no package.json and the root has no test script. - Native/Pinocchio/ASM tests are Rust + LiteSVM exclusively; the web3.js v1 / solana-bankrun TS suites were removed (per CHANGELOG). The only remaining web3.js v1 is in two wallet-adapter frontend demo apps under tokens/token-extensions/, which the ecosystem still requires. Fix the Project structure note to match.
The full detail (invariant list, weekly schedule, the two findings, why the proofs are slow) lives in each finance/<program>/kani-proofs/ README. The front page only needs the differentiator and a pointer.
Both [Quicknode] links now resolve to https://www.quicknode.com/chains/solana.
End the bullet at where the remaining usage lives; drop the prescriptive tail (these demo apps will move to Solana Kit later).
End at "test with `anchor test`"; drop the cargo test / Anchor.toml aside.
mikemaccana
changed the title
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.
Summary
Documentation-only changes to the top-level
README.mdandCONTRIBUTING.md. Sharpens the lead, corrects test/dependency instructions that no longer matched the code, and tightens the Financial Software section.README.md
anchor test,cargo test --manifest-path=…,quasar test), notpnpm test— most example directories have nopackage.jsonand the repo root has notestscript. Reconciled the frameworks list with Getting Started so they agree.finance/<program>/kani-proofs/crates.finance/lendingexample, which existed on disk but was not linked from the README.[Quicknode]links at https://www.quicknode.com/chains/solana.CONTRIBUTING.md
pnpm testinstruction with the per-framework test commands.solana-bankrunis gone entirely, and Native/Pinocchio/ASM examples are tested exclusively with Rust + LiteSVM. The only remaining@solana/web3.jsv1 usage is in a couple of wallet-adapter frontend demo apps undertokens/token-extensions/. Updated the Project structure note to match.https://claude.ai/code/session_01Bg5jG3Fyx6cR4kkxPmksgA