chore: add pre-commit hooks, docker-compose, WS protocol doc, and sta… - #202
Open
kulkan-IV wants to merge 3 commits into
Open
chore: add pre-commit hooks, docker-compose, WS protocol doc, and sta…#202kulkan-IV wants to merge 3 commits into
kulkan-IV wants to merge 3 commits into
Conversation
…te machine diagram - docs: document WebSocket event protocol (closes stellar-vortex-protocol#138) - docs: add intent state machine diagram to README (closes stellar-vortex-protocol#139) - feat: add docker-compose setup for local development (closes stellar-vortex-protocol#133) - chore: add pre-commit hooks for lint and typecheck (closes stellar-vortex-protocol#132) - fix: correct JSON syntax error in package.json (duplicate solver:demo key)
|
@kulkan-IV Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
Contributor
|
fix your conflicts |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR bundles four developer-experience
improvements shipped together as a single
branch.
Closes #138
Closes #139
Closes #133
Closes #132
Changes
#138 — WebSocket event protocol
reference (
docs/websocket-protocol.md)Added a standalone 450-line protocol
reference covering every event the
/wsfeed can emit:
connected,snapshot,subscribed,intent_created,intent_accepted,intent_filled,intent_cancelled,intent_expired,replay_start,replay_end,replay_too_oldsubscribe(chainfilter),
replay(gap recovery)every event
sequence-number gap-detection explanation
Intent,TokenInfo, andStellarTokentype referencescripts/solver-bot.ts(topic subscriptions) and Add an audit trail for cancelled and expired intents #62 (event
sequencing) land
#139 — Intent state machine diagram
(
README.md)Added a Mermaid
stateDiagram-v2diagramand a transition-rules table to the README,
covering all six states (
open,accepted,filled,cancelled,expired,slashed) and every validtransition with its trigger and guard
conditions.
#133 —
docker-compose.ymlfor localdevelopment
Added a compose file that starts the full
local stack with a single command:
postgresservice — PostgreSQL 16Alpine, healthcheck, named volume,
credentials matching
.env.examplebackendservice — builds from localDockerfile, waits for postgreshealthcheck, overrides
DATABASE_URLtouse the container hostname, optional
.envfile passthrough
full-stack, DB-only, and image-only usage
instructions
#132 — Pre-commit hooks (
husky+lint-staged)husky@9.1.7andlint-staged@17.2.0as pinned devdependencies
"prepare": "husky"script so hooksinstall automatically after
npm install.husky/pre-commitrunslint-staged(ESLint
--fixon staged.tsfiles) thennpm run typecheck(whole-project typecheck) — fast staged-only lint, full type
safety on every commit
error in
package.json(duplicatesolver:demokey that was breakingnpm install)Testing
npm run lint npm run typecheck npm test npm run test:e2e All checks pass. No runtime behaviour was changed — this PR is purely additive (docs, config, dev tooling).