Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
cashu
cashu
 
 
ADMIN_RPC_AND_DISPUTES.md
ADMIN_RPC_AND_DISPUTES.md
 
 
ANTI_ABUSE_BOND.md
ANTI_ABUSE_BOND.md
 
 
ARCHITECTURE.md
ARCHITECTURE.md
 
 
BRANCH_PROTECTION.md
BRANCH_PROTECTION.md
 
 
CASHU_ESCROW_ARCHITECTURE.md
CASHU_ESCROW_ARCHITECTURE.md
 
 
CONTRIBUTION_QUALITY_SPEC.md
CONTRIBUTION_QUALITY_SPEC.md
 
 
DEV_FEE.md
DEV_FEE.md
 
 
DEV_FEE_TIMEOUT_SAFETY.md
DEV_FEE_TIMEOUT_SAFETY.md
 
 
DISPUTE_AUTO_CLOSE_ON_USER_RESOLUTION.md
DISPUTE_AUTO_CLOSE_ON_USER_RESOLUTION.md
 
 
EVENT_ROUTING.md
EVENT_ROUTING.md
 
 
FIX_DUPLICATE_DEV_FEE.md
FIX_DUPLICATE_DEV_FEE.md
 
 
HEALTH.md
HEALTH.md
 
 
LIGHTNING_OPS.md
LIGHTNING_OPS.md
 
 
MAINTENANCE_MODE_LN_MIGRATION.md
MAINTENANCE_MODE_LN_MIGRATION.md
 
 
MUTATION_TESTING.md
MUTATION_TESTING.md
 
 
NIP01_KIND0_METADATA.md
NIP01_KIND0_METADATA.md
 
 
NOSTR_EXCHANGE_RATES.md
NOSTR_EXCHANGE_RATES.md
 
 
ORDERS_AND_ACTIONS.md
ORDERS_AND_ACTIONS.md
 
 
ORTSOM_PR_E2E_SPEC.md
ORTSOM_PR_E2E_SPEC.md
 
 
PAYER_HISTORY_ANTI_TRIANGULATION.md
PAYER_HISTORY_ANTI_TRIANGULATION.md
 
 
PRICE_PROVIDERS.md
PRICE_PROVIDERS.md
 
 
README.md
README.md
 
 
REPUTATION_PORTABILITY.md
REPUTATION_PORTABILITY.md
 
 
RPC.md
RPC.md
 
 
RPC_RATE_LIMITING.md
RPC_RATE_LIMITING.md
 
 
SEPARATE_EVENT_KINDS_SPEC.md
SEPARATE_EVENT_KINDS_SPEC.md
 
 
SOLVER_PERMISSION_LEVELS.md
SOLVER_PERMISSION_LEVELS.md
 
 
SOURCE_TAG_PUBKEY.md
SOURCE_TAG_PUBKEY.md
 
 
STARTUP_AND_CONFIG.md
STARTUP_AND_CONFIG.md
 
 
TRANSPORT_V2_SPEC.md
TRANSPORT_V2_SPEC.md
 
 
fix-rating-event-pubkey-format.md
fix-rating-event-pubkey-format.md
 
 

README.md

Mostro Documentation

Quick links to architecture and feature guides.

  • Architecture Overview: ARCHITECTURE.md
  • Startup & Configuration: STARTUP_AND_CONFIG.md (template keys are required; see notes on Rust Defaults)
  • Event Routing: EVENT_ROUTING.md
  • Lightning Operations: LIGHTNING_OPS.md (includes the runbook for migrating to a different Lightning node)
  • Orders & Actions: ORDERS_AND_ACTIONS.md
  • Admin RPC & Disputes: ADMIN_RPC_AND_DISPUTES.md
  • Anti-Abuse Bond: ANTI_ABUSE_BOND.md (opt-in maker/taker Lightning bond; off by default)
  • Payment-Account History / Anti-Triangulation: PAYER_HISTORY_ANTI_TRIANGULATION.md (opt-in buyer payer declaration + private success history; off by default)
  • Reputation Portability: REPUTATION_PORTABILITY.md (import reputation earned on lnp2pBot or another Mostro; opt-in, off by default; §11 has the status and the operator steps)
  • Maintenance Mode & LN Node Migration: MAINTENANCE_MODE_LN_MIGRATION.md (design spec; operator procedure lives in LIGHTNING_OPS.md)
  • Contribution Quality Bar: CONTRIBUTION_QUALITY_SPEC.md (design spec: PR template, Manual testing, triage bot, red test on main; label-only at first)
  • RPC Interface Reference: RPC.md
  • NIP-01 Kind 0 Metadata: NIP01_KIND0_METADATA.md
  • Ortsom on Pull Requests: ORTSOM_PR_E2E_SPEC.md (design spec for the automated e2e gate; label-only at first)

Tips

  • Run tests and lints before pushing: cargo test, cargo fmt, cargo clippy --all-targets --all-features.

  • After schema changes: add a migration under migrations/; run sqlx migrate run if needed (or let mostrod migrate on connect).

  • Solver Permission Levels