Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (58 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

77 lines (58 loc) · 2.28 KB
Raw

Contributing to OverSync

Thanks for helping improve OverSync. This guide is for developers opening pull requests against the codebase. If you want to operate a resolver, use docs/RESOLVERS.md instead.

Prerequisites

  • Node.js 22.5+ and pnpm
  • Rust with the wasm32-unknown-unknown and wasm32v1-none targets
  • stellar-cli 22.8.1 for Soroban contract builds
  • Foundry or Hardhat tooling for Solidity contract work

Repository layout

  • packages/sdk - shared TypeScript SDK
  • coordinator - SQLite-backed v2 coordinator REST and WebSocket service
  • contracts - Solidity contracts and Hardhat tests
  • soroban - Rust workspace for Stellar Soroban contracts
  • frontend - React and Vite bridge UI
  • resolver - reference community resolver runner

Local setup

pnpm install
cp env.example .env
pnpm --filter @oversync/sdk build

Run the parts of the stack you are changing. For example:

pnpm --filter @oversync/coordinator dev
pnpm --filter @oversync/frontend dev

CI test matrix

Run the checks that match your change before opening a PR:

pnpm --filter @oversync/sdk build
pnpm --filter @oversync/sdk exec tsc --noEmit
pnpm --filter @oversync/coordinator exec tsc --noEmit
pnpm --filter @oversync/resolver exec tsc --noEmit
pnpm --filter @oversync/frontend exec tsc --noEmit
pnpm --filter @oversync/sdk test
pnpm --filter @oversync/coordinator test
pnpm --filter @oversync/contracts compile
pnpm --filter @oversync/contracts exec hardhat test test/v2/HTLCEscrow.test.ts test/v2/ResolverRegistry.test.ts

For Soroban changes:

cd soroban
stellar contract build
cargo test --release

For Solidity contract changes, the contracts workflow also runs Slither on contracts/contracts/v2.

Pull request expectations

  • Write PR descriptions and code comments in English.
  • Link the issue your PR addresses.
  • Keep secrets, private keys, RPC credentials, and .env files out of commits.
  • Include verification notes that list the commands you ran.
  • Keep contributor docs focused on development. Resolver operations belong in docs/RESOLVERS.md.

Security

Report security-sensitive issues privately using docs/SECURITY.md. Do not open public issues or PRs that reveal exploitable details.