Contributing#

This page covers how the repository is laid out, which toolchain it pins, and the commands to build, test and lint a change before you open a pull request. The project has a high verification bar: malformed encodings, signing mistakes or integer loss can produce transactions that look valid and are not. Expect to add fixtures and negative controls, not just happy-path tests.

Repository layout#

Some verification crates are excluded from the main workspace (listed under exclude in the root Cargo.toml) and have their own lockfiles. Run those with --manifest-path.

Toolchain#

rust-toolchain.toml pins Rust 1.99.1 with clippy, rustfmt and three Wasm targets: wasm32-unknown-unknown, wasm32-wasip1 and wasm32-wasip2. The workspace uses edition 2024 and declares an MSRV of 1.89 (rust-version). CI checks the MSRV for the core and selected crates with cargo +1.89.0.

There is no devenv or Nix setup. Runtime journeys need a few external executables, which you point at with environment variables:

Build and test#

From the repository root:

cargo fmt --all --check
cargo test --workspace --all-features --locked
cargo clippy --workspace --all-targets --all-features --locked -- -D warnings

Test a single crate with -p, for example cargo test -p solana_kit_jupiter --locked. Crates with optional features should also be checked with --no-default-features and each feature combination they document. CI does this for solana_kit_core (crypto, fixed-points) and solana_kit_pyth.

The shared conformance suite runs on its own. The corrupt-fixture run is a negative control: it must fail.

cargo run -p solana_kit_conformance --locked
cargo run -p solana_kit_conformance --locked -- --corrupt-fixture

Verification commands#

.cargo/config.toml defines the xtask alias. Each command validates its arguments before it does anything, and it does not forward Cargo flags.

Other commands take a path: style-report, imports, dependency-fixture, package-review, package-report, registry-fixture, artifact-capture, prepare-wallet and prepare-wallet-rpc. To keep nested Cargo calls offline, set the environment rather than a flag: CARGO_NET_OFFLINE=true cargo xtask consumer.

Style and formatting#

• Rust: rustfmt.toml sets edition 2024. Clippy runs with -D warnings.

• Monostyle: monostyle.toml requires readability and complexity scores of at least 90, a maximum line width of 100, and does not exempt generated code. Install the pinned revision and run the gate:

  cargo install monostyle --locked \
    --git https://github.com/ifiokjr/monostyle \
    --rev ae86916d5055fb2c15f665bbe4f0f90bd8abc26e
  cargo xtask style

  The xtask also checks every individual file, not just the aggregate score. See docs/verification/style.md.

• Markdown and TOML: dprint.json configures the dprint Markdown and TOML plugins, with textWrap: maintain.

Changesets and releases#

Releases are managed by monochange, configured in monochange.toml. Changesets are required: when a change touches crates, docs, tools or verification, add a Markdown file to .changeset/ that names the affected package and bump.

---
solana_kit_client: minor
---

# Add caller-driven reactive action and stream stores

Opt into cached action and stream snapshots, scoped cancellation, ...

Describe completed behavior only. Prospective work belongs in docs/planning/tasks.md, not in a changeset. CI runs monochange check, monochange step validate, monochange discover and monochange preview.

monochange.toml disables Cargo and npm publishing at the ecosystem level, and every configured package has publishing disabled. The solana_kit umbrella is configured as a placeholder publication with its own README. The publisher CLI is released separately through its own tag workflow (see dApp Store publisher).

Pull requests#

The repository has no PR template. The history and the plan show these conventions:

• Keep each PR small, ending in an independently observable result, and merge only after its checks and review pass.
• Use Conventional Commit titles with a scope, for example feat(publisher): …, fix(codecs): … or test(wallet): ….
• Record deviations and evidence in the relevant parity ledger and in docs/planning/decisions.tsv. Do not claim status the evidence does not support. See Parity and status.
• New project code is released under the Unlicense. Reused third-party material keeps its license and notices (THIRD_PARTY_NOTICES.md and the MIT-*.txt files in each crate).
• Solana Kit is off-chain only. Do not add on-chain program support.