Skip to content

Repository files navigation

ReserveOps API

ReserveOps helps Stellar wallet and payment teams inspect the XLM reserve committed to sponsored ledger entries. This Express/TypeScript service currently offers a read-only testnet preview: given a public sponsor address, it itemizes sponsored accounts, ordinary trustlines, and additional signers, then compares those entries with the sponsor's total reported by Horizon.

This is an early preview. It does not determine whether sponsorship can be revoked or prepare transactions. Other ledger entry types and cross-ledger consistency checks remain in the contributor backlog.

The dashboard is maintained separately. External integrations use this API; there is no duplicate API repository.

Run locally

Requires Node.js 24 and npm.

npm ci
Copy-Item .env.example .env
npm run dev

Skip the copy if the local environment file already exists.

Run npm run check for the validation pipeline and npm run format:check for formatting. Production: npm run build then npm start. Liveness: http://localhost:4000/health. Readiness: http://localhost:4000/ready. The current preview is ready without MongoDB; the readiness response still reports the database as unconfigured. See OpenAPI.

Run npm run proof:fixture to create and verify a fresh testnet sponsor fixture. Run npm run proof:inspect -- G_ADDRESS to inspect an existing testnet sponsor. These scripts are independent of MongoDB and the HTTP server.

The read-only preview endpoint is GET /v1/testnet/sponsors/{sponsorId}/inventory. It uses public Stellar testnet data and does not require MongoDB. Its response includes reserve totals, itemized entries, ledger window, and coverage limitations; see the OpenAPI contract.

To contribute, read CONTRIBUTING.md and the open issues. The backlog also tracks work that has not been opened as an issue yet.

About

Inspect Stellar sponsored-reserve commitments with a read-only testnet API

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages