Skip to content

docs: add SO4 developer integration guides - #618

Merged
IbrahimIjai merged 1 commit into
SO4-Markets:mainfrom
EmmanuelOchaje:docs/developer-integration-guides
Aug 25, 2026
Merged

docs: add SO4 developer integration guides#618
IbrahimIjai merged 1 commit into
SO4-Markets:mainfrom
EmmanuelOchaje:docs/developer-integration-guides

Conversation

@EmmanuelOchaje

Copy link
Copy Markdown
Contributor

Summary

  • add the indexer guide with the exact local integration workflow, manifest guidance, generated-type constraints, and real troubleshooting output
  • add copy-pasteable contract-client examples using committed testnet IDs and shared scaling helpers, with concrete Node/browser differences
  • compare RPC, indexer, and generated-reader paths with measured latency, pagination, polling, and app-aligned staleness handling
  • document the complete build, simulate, authorize, sign, submit, confirm, and recovery lifecycle for writes through Freighter and Wallets Kit

Testnet evidence

  • executed the generated reader example against testnet and documented its returned market value (protocol version 27)
  • measured five direct RPC reads: 2078 ms, 836 ms, 847 ms, 504 ms, and 568 ms (836 ms median)
  • submitted the documented market-increase flow on testnet: 3b24ce253249555072e6d96b835e2f7f61500e6783e9bc9cebbed5852ccb3822
  • documented the resulting pending-order key and the keeper-dependent execution boundary

Clean-clone indexer verification

Run from a clean clone with a frozen install:

bun run --cwd apps/s03-indexer codegen  -> generated all schemas and types
bun run --cwd apps/s03-indexer build    -> Project built successfully
bun run --cwd apps/s03-indexer test     -> 98 tests passed
sync:contracts:local                     -> 13 core, 5 tokens, 1 market
validate-manifest.sh                     -> manifest valid

Validation

  • bun lint (passes with existing warnings)
  • bun typecheck
  • bun run check:tokens (286 files, zero violations)
  • bun run test
  • CI=1 bun run test:coverage
  • bun run build
  • bun run --cwd apps/docs check:content (12 pages, zero orphans)
  • bun run --cwd apps/docs check:links (12 pages, zero broken internal links)
  • git diff --check

Closes #601
Closes #602
Closes #603
Closes #604

Document the indexer setup, generated contract clients, read-path tradeoffs, and the full transaction lifecycle using repository-native patterns and verified testnet examples. Export the shared protocol scaling helpers so the documented SDK import remains public and type-tested.
@vercel

vercel Bot commented Aug 25, 2026

Copy link
Copy Markdown

Someone is attempting to deploy a commit to the Ijai's projects Team on Vercel.

A member of the Team first needs to authorize it.

@drips-wave

drips-wave Bot commented Aug 25, 2026

Copy link
Copy Markdown

@EmmanuelOchaje 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! 🚀

Learn more about application limits

@vercel

vercel Bot commented Aug 25, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
interface-web Ready Ready Preview Aug 25, 2026 1:25pm

@IbrahimIjai
IbrahimIjai merged commit c620ab8 into SO4-Markets:main Aug 25, 2026
4 of 5 checks passed
@grantfox-oss grantfox-oss Bot mentioned this pull request Aug 25, 2026
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants