Skip to content

Reference guide - #1394

Merged
DokaIzk merged 4 commits into
SoroScan:devfrom
AdeMi20:reference-guide
Aug 31, 2026
Merged

Reference guide#1394
DokaIzk merged 4 commits into
SoroScan:devfrom
AdeMi20:reference-guide

Conversation

@AdeMi20

@AdeMi20 AdeMi20 commented Aug 30, 2026

Copy link
Copy Markdown

Summary

This update significantly improves both the project's documentation and data efficiency. We introduced a comprehensive internal Admin Guide and formally linked our Architecture Decision Records in the main README for better developer onboarding. On the performance side, we overhauled the compression strategy by implementing a custom Gzip middleware (thresholded at 1KB to save CPU) and introducing high-performance zstandard compression. This zstd integration transparently compresses large event payloads in the PostgreSQL database via a custom JSON field, while a new API middleware allows supported clients to request zstd-compressed responses, drastically reducing bandwidth and storage costs.

Changes

Related Issues

Closes #978
Closes #1287
Closes #1298
Closes #1307

Testing

  • Unit tests added / updated
  • Manual test steps:
    1.
    2.

Screenshots / Recordings (if UI change)

Checklist

  • ruff / black (Python), ESLint / Prettier (TS), cargo fmt + clippy (Rust) all pass
  • Tests pass locally (pytest / pnpm test / cargo test)
  • Documentation updated (if applicable)
  • Conventional Commit message format used
  • PR is opened against develop, not main
  • No secrets, credentials, or .env files included

orunganiekan and others added 3 commits August 27, 2026 18:04
…, and contract bulk import (SoroScan#1330, SoroScan#1329, SoroScan#1328, SoroScan#1327) (SoroScan#1357)

* feat(ops/admin/webhooks): incident playbooks, replay, dedup UI, bulk import

Add operational playbooks with alert-to-action automation, webhook replay
jobs with filters/rate limits/status tracking, admin dedup configuration
UI plus REST test endpoint, and CSV/JSON contract metadata bulk import
with validation, rollback, and import reporting.

Closes SoroScan#1330
Closes SoroScan#1329
Closes SoroScan#1328
Closes SoroScan#1327

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(lint): resolve ruff unused import and variable warnings

Co-authored-by: Cursor <cursoragent@cursor.com>

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
…erts, structured logging docs (SoroScan#1384)

* Add observability: latency percentiles, OTel spans, error-rate alerts, structured logging docs

- SoroScan#1293: add RequestLatencyMiddleware exporting soroscan_request_latency_seconds
  histogram (p50/p95/p99) with per-endpoint/status labels
- SoroScan#1296: add OpenTelemetry custom spans for event recording, webhook
  signing/delivery, contract lookups and RPC/DB queries; optional OTLP exporter
- SoroScan#1294: per-service error-rate Prometheus alerts (>1% warn, >5% critical) with
  root-cause queries; add validating tests
- SoroScan#1297: add structured-logging standard doc and link from observability guide
- Fix pre-existing frontend lint errors and regenerate pnpm-lock.yaml so CI
  install steps pass

* Fix ResponsiveTable build: cast cell value to ReactNode

Using `unknown` for the cell value broke the Next.js production build
(Type 'unknown' is not assignable to ReactNode). Cast the fallback render
value to ReactNode so the no-explicit-any lint fix compiles.

---------

Co-authored-by: trinnode <trinnode@users.noreply.github.com>
@drips-wave

drips-wave Bot commented Aug 30, 2026

Copy link
Copy Markdown

@AdeMi20 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

@DokaIzk
DokaIzk merged commit e5e9d2a into SoroScan:dev Aug 31, 2026
3 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

4 participants