Skip to content

Document a dependency update cadence and a lockfile policy #338

Description

@Otaiki1

Context

The repo pins exact versions in several places (react 19.2.7, vite 8.1.3, poseidon-bls12381 1.0.2) and uses carets in others (@stellar/stellar-sdk ^16.2.0 in two workspaces,
^16.0.1 in a third — already a version skew across workspaces). scripts/check-stellar-sdk-version.mjs
exists to police that one dependency specifically, which suggests the problem has bitten before.

A dependency audit runbook was written; a cadence and a policy were not.

Where to build it

  • CONTRIBUTING.md or a new docs/dependencies.md.
  • scripts/check-stellar-sdk-version.mjs — the existing guard.
  • The four package.json files and contracts/Cargo.toml.

What to do

  • Write down which dependencies are pinned exactly and why — poseidon-bls12381 and its circom twin must move together and are correctly pinned; state that reasoning.
  • Resolve the @stellar/stellar-sdk skew between app (^16.0.1) and the others (^16.2.0).
  • Define a cadence (monthly npm audit + cargo audit, quarterly minor bumps) and who does it.
  • Note that this repo runs no CI, so updates are verified by just verify locally before merge.

Acceptance criteria

  • Every workspace agrees on the Stellar SDK version range.
  • The pinning rationale for the crypto dependencies is written down.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentationdxDeveloper experience & toolingsecuritySecurity & robustness

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions