Stellopay Core

Stellopay Core is a Soroban-based payroll contract workspace for Stellar. It contains the on-chain contracts, documentation, and supporting scripts for payroll escrow, recurring salary disbursement, multi-currency payroll flows, governance, compliance, and related operational modules.

Repository Layout

Path	Purpose
docs/	Project documentation, API notes, integration guides, architecture docs, migration guidance, examples, and Windows build notes.
onchain/	Rust/Soroban workspace for smart contracts and integration tests.
onchain/contracts/	Individual contract crates for payroll, governance, compliance, payment scheduling, vesting, withdrawal controls, and related modules.
scripts/	Repository helper scripts, including migration/build helpers.
tools/	Supporting tooling for repository workflows.

Start with the documentation index for product and integration context, then use the on-chain workspace guide for contract build and test details.

On-Chain Workspace

The Soroban workspace is defined in onchain/Cargo.toml. It includes all crates under onchain/contracts/* plus onchain/integration_tests.

Notable contract modules include:

Contract	Focus
stello_pay_contract	Core payroll contract implementation.
payroll_escrow	Escrowed salary funding and release flows.
payment_scheduler	Scheduled and recurring payment support.
payment_retry	Retry handling for failed payment attempts.
payment_splitter	Split-payment logic.
price_oracle	Pricing and conversion support for multi-currency flows.
governance, multisig, rbac	Administrative controls and permissioning.
compliance_checker, compliance_reporting, tax_withholding	Compliance and reporting support.
token_vesting, withdrawal_timelock, slashing_penalty	Vesting, withdrawal constraints, and penalty flows.
audit_logger, payment_history	Audit and historical payment records.

See onchain/contracts/ for the full contract list.

Documentation Map

• API documentation
• Integration guide
• Architecture
• Examples
• Best practices
• Developer tools
• Migrations
• Upgrade and migration strategy
• Windows build notes

Build And Test

Install Rust and the Soroban CLI before running contract commands locally. The on-chain README pins the Soroban CLI example to 20.0.0-rc.1:

rustup install stable
cargo install --locked --version 20.0.0-rc.1 soroban-cli

Common local checks from the on-chain workspace:

cd onchain
cargo build
cargo test

For Soroban contract builds, use:

cd onchain
stellar contract build

On Windows GNU/MinGW, the repository documents a WASM-only path for the known export ordinal too large linker issue:

rustup target add wasm32-unknown-unknown
.\scripts\migrations\build_wasm_only.ps1

See Building on Windows for the full Windows guidance.

CI

The on-chain workspace uses GitHub Actions to build and test Soroban contracts on pull requests and pushes to the main branches. See onchain/README.md for the CI overview and local setup notes.

Contributing and security

• Contributing guide — workspace layout, build/test workflow, and PR expectations
• Security policy — responsible disclosure for contracts under onchain/contracts/
• Open an issue — bug, feature, or security report templates

Safety Notes

This repository contains smart contract code. Review migrations, upgrades, and deployment steps carefully before using any live network or production asset. Keep private keys, RPC credentials, wallet secrets, and production database or ledger data out of commits, issue comments, and logs.

For upgrade and migration planning, start with Migrations and Upgrade and migration strategy.

License

This project is licensed under the MIT License. See onchain/README.md for the existing license note.