Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
SEP-41 token per deployment — USDC or native XLM SAC) and settles them to
contributors via three strategies:

1. **Merkle-proof claims** — Wave-cycle points payouts. The oracle posts a
1. **Merkle-proof claims** — Cycle-based points payouts. The oracle posts a
payout-manifest root per cycle; after a 24-hour dispute window contributors
claim by proving a `(contributor, amount)` leaf against the root and are
credited a pull-payment balance they withdraw themselves.
Expand Down Expand Up @@ -155,8 +155,6 @@ feature idea? [Open an issue](https://github.com/Oyinkans0la12/splitstream-core/

- 💬 **GitHub Issues** — bug reports, feature requests, and design discussion
- 🔒 **Security** — report vulnerabilities privately per [SECURITY.md](SECURITY.md)
- 📋 **Wave** — this repo participates in the
[Drips Stellar Wave](https://www.drips.network/wave/stellar)

## Socials

Expand Down
2 changes: 1 addition & 1 deletion assets/splitstream-banner.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion contracts/vault/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
//! A Soroban contract that pools funds (a single SEP-41 token per deployment)
//! and settles them to contributors via three strategies:
//!
//! 1. **Merkle-proof claims** — Wave-cycle points payouts. A cycle root is
//! 1. **Merkle-proof claims** — Cycle-based points payouts. A cycle root is
//! posted by the oracle and enters a 24h challenge window during which the
//! admin may replace it (once) before any claim can extract funds against
//! it. After the window, contributors claim by proving a `(contributor,
Expand Down
2 changes: 1 addition & 1 deletion contracts/vault/src/types.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

use soroban_sdk::{contracttype, Address, BytesN};

/// Challenge-window state for one Wave cycle payout.
/// Challenge-window state for one payout cycle.
///
/// A posted root is not immediately claimable: maintainers have a fixed
/// [`CHALLENGE_WINDOW_SECS`] window to catch a bad points calculation and
Expand Down
9 changes: 5 additions & 4 deletions docs/introduction.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Introduction

SplitStream is a Soroban settlement protocol that lets a Drips Wave team turn
pooled treasury funds into a verifiable, disputable, on-chain distribution to
contributors, instead of manual off-chain calculation. It spans three repos:
SplitStream is a Soroban settlement protocol that lets an open source team
turn pooled treasury funds into a verifiable, disputable, on-chain
distribution to contributors, instead of manual off-chain calculation. It
spans three repos:
[splitstream-actions](https://splitstream.gitbook.io/splitstream-actions/)
(the GitHub→chain bridge that computes each cycle's payout manifest and relays
its Merkle root on-chain),
Expand All @@ -23,7 +24,7 @@ that was posted, and whether the rules allow the payout to happen yet.

## The problem it solves

Wave payouts are usually settled off-chain. That produces three failures:
Contributor payouts are usually settled off-chain. That produces three failures:

- **Squabbling over splits.** Points, weights, and shares are argued over in
chat, with no authoritative artifact to point at.
Expand Down
2 changes: 1 addition & 1 deletion docs/protocol-mechanics.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ admin lever over pooled funds is the sweep (72-hour timelock, below).

## The three settlement strategies

**Merkle-proof claims** — Wave-cycle points payouts. The oracle posts a
**Merkle-proof claims** — Cycle-based points payouts. The oracle posts a
manifest root with `post_cycle_root` (oracle auth). After the challenge window,
contributors call `credit_claim` (contributor auth) to prove a
`(contributor, amount)` leaf against the stored root and are credited a
Expand Down
Loading