Thanks for helping build the Soroban developer toolkit! This guide gets you from a clean checkout to passing checks.
| Tool | Version | Notes |
|---|---|---|
| Node.js | ≥ 20 | Use nvm use (see .nvmrc). |
| pnpm | ≥ 9 | npm i -g pnpm |
| Rust | stable | For the template contracts. |
| Stellar CLI | ≥ 22 | For sforge build/deploy. |
| wasm target | — | rustup target add wasm32v1-none |
git clone https://github.com/thefifthdev/stellarforge.git
cd stellarforge
make install
make build # build the CLI
make link # link `sforge` globally (optional)| Path | What it is |
|---|---|
packages/cli/ |
The sforge CLI (TypeScript) + tests. |
templates/*/ |
Starter Soroban contracts (Cargo workspace). |
docs/ |
Usage and template reference. |
These mirror CI — run them before opening a PR:
# CLI
pnpm lint
pnpm format:check
pnpm test
pnpm build
# Templates
cargo fmt --check
cargo clippy --all-targets -- -D warnings
cargo testSee docs/templates.md. In short: add
templates/<name>/ (Cargo.toml + src/lib.rs with tests); the templates/*
workspace glob and sforge templates pick it up automatically.
Conventional Commits: feat:, fix:,
docs:, refactor:, test:, ci:, chore:.
StellarForge participates in the Stellar Wave Program via
Drips. Issues labeled Stellar Wave and
good first issue are open for contributors to earn rewards.