Skip to content

Commit d439701

Browse files
authored
Merge pull request #318 from SYMBAxx/fix/csv-cliff-duration
docs: add CHANGELOG.md and dedupe README Security section
2 parents 4ff5067 + f886672 commit d439701

2 files changed

Lines changed: 52 additions & 6 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
The contract additionally tracks its own `CONTRACT_VERSION` constant
8+
(`contracts/streaming/src/lib.rs`), bumped whenever a deployed contract's
9+
storage layout changes and a `migrate()` pass is required after upgrade.
10+
11+
No versioned release has been tagged yet (the app is still pre-1.0, see
12+
`package.json`), so entries below are grouped under **Unreleased**. Once the
13+
first release is tagged, this section will be cut into a dated `[x.y.z]`
14+
entry and a new **Unreleased** section will start above it.
15+
16+
## [Unreleased]
17+
18+
### Added
19+
20+
- Batch stream creation via CSV upload, including cliff duration support
21+
- `create_streams_batch` contract method for atomic multi-stream creation
22+
- xBull and LOBSTR (WalletConnect) wallet adapters
23+
- Real-time token portfolio value with live price feeds
24+
- Stream metadata support (name, category, memo)
25+
- Deployment presets, fee estimation, and auto-withdraw settings
26+
- Root and route-level error UI with friendly messages and retry
27+
- Page metadata, Open Graph image, and Twitter card
28+
- Playwright end-to-end tests running in CI
29+
- Lighthouse CI for per-PR performance and accessibility scoring
30+
- Vitest unit test suite with enforced coverage thresholds
31+
32+
### Changed
33+
34+
- Reconciled `CONTRIBUTING.md`, which had duplicated/interleaved sections from
35+
an unresolved merge, into a single canonical guide per topic
36+
- Clarified that mock mode is automatic (`isMockMode = !config.streamContractId`)
37+
rather than a manually-set flag, in both `README.md` and `CONTRIBUTING.md`
38+
39+
### Fixed
40+
41+
- Cliff duration not being applied from CSV batch uploads
42+
- Notification events leaking across wallets instead of scoping to the
43+
connected wallet
44+
- Fabricated CPU/memory/storage fee breakdown removed from the UI
45+
- Rust contract merge corruption, plus related vesting and auth bugs
46+
- Missing `clippy`/`fmt --check` steps in contract CI
47+
48+
Project history prior to this file is available via `git log`.

‎README.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -178,11 +178,6 @@ You'll sign two transactions: one `approve` on the token contract, then `create_
178178

179179
---
180180

181-
## Security
182-
183-
Please report suspected vulnerabilities privately. See [SECURITY.md](./SECURITY.md)
184-
for the supported scope, reporting process, response timeline, and safe harbor
185-
policy.
186181
## Architecture Decision Records
187182

188183
Key design choices are documented in [`docs/adr/`](./docs/adr/README.md). Start there if you're wondering "why was it done this way?" before changing something fundamental.
@@ -191,7 +186,10 @@ Key design choices are documented in [`docs/adr/`](./docs/adr/README.md). Start
191186

192187
## Security
193188

194-
Found a vulnerability? Please read our [Security Policy](./SECURITY.md) before disclosing. We prefer private disclosure via [GitHub Security Advisories](https://github.com/FlowwStar/FlowStar/security/advisories/new).
189+
Found a suspected vulnerability? Please report it privately rather than opening a
190+
public issue. See [SECURITY.md](./SECURITY.md) for the supported scope, reporting
191+
process, response timeline, and safe harbor policy. We prefer private disclosure
192+
via [GitHub Security Advisories](https://github.com/FlowwStar/FlowStar/security/advisories/new).
195193

196194
---
197195

0 commit comments

Comments
 (0)