CONTRIBUTING.md

Contributing to SolSab

Thank you for your interest in contributing to SolSab! This guide will help you get set up for development.

Pre-Requisites

Ensure you have the following software installed and configured on your machine:

• Rust (Nightly)
• Solana CLI v2.1.21
• Anchor CLI v0.31.1 (Solana development framework)
• Node.js v23+
• Just (command runner)
• Bun (package manager)
• Ni (package manager resolver)
• shfmt (shell script formatter) - install via brew install shfmt (macOS), apt install shfmt (Ubuntu), or download from releases

Set Up

Wallet

Make sure to configure your local Solana wallet.

Clone the repository

git clone git@github.com:sablier-labs/solsab.git && cd solsab

Install dependencies

bun install

Run one-time setup script:

just setup

List available scripts

To see a list of all available scripts, run this command:

just --list

Build the programs

just build

Run full code checks

Tip

Make sure to build the programs first.

just full-check

This will check:

• TypeScript/JavaScript formatting and linting (Biome)
• Markdown and YAML formatting (Prettier)
• Bash script formatting (shfmt)
• TypeScript type checking
• Rust code formatting and linting

Testing

just test

VSCode Extensions

See the recommended VSCode extensions in .vscode/extensions.json.

Other useful information

Solana Cluster RPC URLs:

• Mainnet Beta: https://api.mainnet-beta.solana.com
• Devnet: https://api.devnet.solana.com
• Testnet: https://api.testnet.solana.com
• Localnet: http://127.0.0.1:8899