Skip to content

docs: add STREAM_MATH.md with worked examples and edge cases (#791) #831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tilljack60-cmd wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add STREAM_MATH.md with worked examples and edge cases (#791) #831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,8 @@ sequenceDiagram

3) Stream Math Model

> **Full derivations, worked examples, and edge cases:** [docs/STREAM_MATH.md](docs/STREAM_MATH.md)

For each stream defined by a total amount ($A_{total}$), a start timestamp ($t_{start}$), and a duration in seconds ($d$), the completion timestamp ($t_{end}$) is calculated as:

$$t_{end} = t_{start} + d$$
Expand Down
4 changes: 4 additions & 0 deletions docs/CONTRACT_BINDINGS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ This document explains how to generate, version, and consume TypeScript bindings
for the StellarStream Soroban contract. Follow this guide whenever the contract
ABI changes or you are setting up the frontend for the first time.

> **Stream vesting math** — for the formula derivations behind `claimable()`,
> `claim()`, and `cancel()` accounting (including worked examples and edge cases),
> see [STREAM_MATH.md](./STREAM_MATH.md).

---

## Overview
Expand Down
Loading