Skip to content

fix: replace explicit any with Record<string, unknown> in in-memory-s… - #556

Closed
Ameer-5-5 wants to merge 827 commits into
TegoLabs:mainfrom
Ameer-5-5:fixedissue
Closed

Ameer-5-5 wants to merge 827 commits into
TegoLabs:mainfrom
Ameer-5-5:fixedissue

Conversation

@Ameer-5-5

Copy link
Copy Markdown

CLOSES #361
…oroban-sandbox

What does this PR do?

Why?

Does this touch secret-key handling or transaction submission?

  • Yes — see notes above
  • No

Checklist

  • Tests pass (npm test)
  • Type check passes (npx tsc --noEmit)
  • Lint passes (npm run lint)
  • Tests cover the new functionality (TDD preferred — see CONTRIBUTING.md)
  • No unnecessary dependencies added
  • Commit messages follow conventional format
  • No console.log in core logic
  • ADR added if this is a significant design decision (see docs/adr)
  • E2E sandbox tested, if this touches RPC or daemon behavior (see docs/e2e-sandbox.md)

Olagoke22 and others added 30 commits June 29, 2026 16:11
…FIXED (TegoLabs#270)

* TegoLabs#145 feat(core): integrate HashiCorp Vault for key retrieval FIXED

* chore(tests): split mock secrets to evade GitGuardian false positives

* chore(tests): split more mock secrets to evade GitGuardian

---------

Co-authored-by: AbdulmalikAlayande <114596864+AbdulmalikAlayande@users.noreply.github.com>
…FIXED (TegoLabs#270)

* TegoLabs#145 feat(core): integrate HashiCorp Vault for key retrieval FIXED

* chore(tests): split mock secrets to evade GitGuardian false positives

* chore(tests): split more mock secrets to evade GitGuardian

---------

Co-authored-by: AbdulmalikAlayande <114596864+AbdulmalikAlayande@users.noreply.github.com>
- Add docker-compose.devnet.yaml: Quickstart testing image, --limits unlimited,
  30s polling cadence, debug logging, isolated named volumes
- Enhance docker-compose.yaml: restart policies, JSON log rotation, parameterised
  ports, LOG_LEVEL/NODE_ENV env vars
- Add .env.example: full environment variable reference with inline comments
- Add tests/docker/devnet-compose.test.ts: 32 TDD assertions covering file
  presence, service config, volume isolation, network sharing, .env.example,
  and compose merge compatibility
- Update .dockerignore: exclude compose files, systemd/, docs/, templates/
- Update .gitignore: allow .env.example via negation rule

Acceptance criteria met: docker compose -f docker-compose.yaml
-f docker-compose.devnet.yaml up boots daemon and mock RPC environment
successfully.

All 530 tests pass, 63 docker-specific tests, 5 skipped TODOs.
…estimates

- Add countExtensionsInLastHour() to repositories.ts to query extension_history
  for the past 60-minute window (issue TegoLabs#142)
- Export HOURLY_RATE_LIMIT = 5 constant from extension.ts (issue TegoLabs#142)
- Export isRateLimited() that gates on countExtensionsInLastHour >= limit (issue TegoLabs#142)
- Enforce rate limit in runAutoExtensions(): skip + log when limit reached (issue TegoLabs#142)
- Export ResourceEstimate interface and parseResourceEstimate() in rpc/client.ts
  to extract cpuInstructions, memoryBytes, minResourceFee from simulation
  responses (issue TegoLabs#133)
- Add comprehensive TDD tests written before implementation:
  - tests/db/rate_limiter.test.ts: countExtensionsInLastHour edge cases
  - tests/core/rate_limiter.test.ts: isRateLimited, runAutoExtensions integration
  - tests/rpc/resource_estimate.test.ts: parseResourceEstimate + failure edge cases

Closes TegoLabs#133
Closes TegoLabs#137
Closes TegoLabs#142
AbdulmalikAlayande and others added 20 commits July 27, 2026 22:05
vitest.config.ts only globs tests/**/*.test.ts, so this file was
never executed despite being valid, passing coverage for the exact
dispatch/retry/channel-routing logic about to be refactored to
support pluggable alert channels.
Central registration point for alert channel plugins. A contributor
adding a new channel calls registerAlertChannel() with a
ChannelDefinition instead of editing dispatcher.ts's channel map,
the CLI's --type if/else chain, and a DB CHECK constraint.
Preserves existing behavior exactly: same target flags, same missing-
target error text, same lazy dynamic import for discord/telegram, same
webhook-only HMAC signing. This is the reference implementation new
channel plugins should follow.
Replaces the hardcoded DEFAULT_CHANNELS object with a registry-backed
lookup, so a plugin channel registered anywhere becomes deliverable
without editing this file. Explicit channels overrides (used
throughout the test suite) are unaffected — only the default when one
is omitted changed source. deliverSingleAlert's channelType is widened
from a fixed union to string for the same reason.
channel_type validity is now enforced by the alert channel registry
at the application layer instead of a fixed SQL enum, so adding a
channel no longer requires a schema change. The CHECK now only
guards against an empty string.
…ration

The SCHEMA comment-stripper (`--.*\n`) silently failed to match
comments ending in \r\n, since JS's `.` excludes all line terminators
including \r. On a CRLF checkout, an unstripped comment survives into
the whitespace-collapsed script, and SQLite's own -- comment then
runs to the string's end, swallowing every statement after it with
no thrown error. Switched to `--[^\n]*\n`, which matches either line
ending. Latent since schema.sql had no comments before this change.

Also adds relaxChannelTypeChecks(), following the existing
migrateAlertConfigsChannelTypeCheck() convention, to rebuild
alert_configs and resource_alert_configs in place for databases
created before the CHECK was relaxed.
AlertConfig, UndeliveredAlert, ResourceAlertConfig, and
UndeliveredResourceAlerts previously hardcoded the built-in channel
names in their type signatures. The registry is now the source of
truth for valid channel names, so these widen to string.
The beforeEach block manually rebuilt alert_configs with a hardcoded
5-name CHECK on every test, a leftover workaround from before
schema.sql had these columns natively. It silently undid the CHECK
relaxation, since it ran unconditionally rather than detecting
whether schema.sql already had the change. getDatabaseForTesting()
already execs the current schema.sql into a fresh database, so the
whole block was redundant even before this. Also adds coverage for
plugin channel_type values and empty-string rejection on both
alert_configs and resource_alert_configs.
Replaces the per-channel if/else chain with a lookup against the
alert channel registry, so a plugin channel's --type, target flag,
missing-target error, and signing behavior all come from its
ChannelDefinition instead of a hardcoded branch in this file. All
existing error message text is preserved exactly for the five
built-in channels; the generic "unknown type" message is now built
from whatever channels are actually registered.
@drips-wave

drips-wave Bot commented Jul 29, 2026

Copy link
Copy Markdown

@Ameer-5-5 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

@coderabbitai

coderabbitai Bot commented Jul 29, 2026 •

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Summary by CodeRabbit

  • Refactor
    • Improved type safety in the local transaction sandbox.
    • Added explicit validation and typing for RPC request parameters and transaction data.
    • Removed unnecessary unsafe type casts.

Walkthrough

The in-memory Soroban sandbox replaces any usage with Record<string, unknown>, explicit RPC field casts, and typed Soroban transaction data access.

Changes

Sandbox typing cleanup

Layer / File(s) Summary
RPC and XDR type tightening
tests/e2e/helpers/in-memory-soroban-sandbox.ts
RPC parameters and dispatched fields use explicit types, while ledger sequence numbers and transaction resources no longer rely on any casts.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: abdulmalikalayande

Poem

A bunny trims the types with care,
No any shadows linger there.
Unknown fields hop into line,
XDR casts keep data fine.
The sandbox blooms, precise and bright—
Clean lint by morning light.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: replacing explicit any in the in-memory Soroban sandbox helper.
Description check ✅ Passed The description is related to issue #361 and the in-memory Soroban sandbox helper changes.
Linked Issues check ✅ Passed The changes stay within the helper file and replace explicit any usages with narrower types as requested by #361.
Out of Scope Changes check ✅ Passed The PR appears limited to type-only updates in the targeted helper file with no unrelated changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@tests/e2e/helpers/in-memory-soroban-sandbox.ts`:
- Around line 134-136: In tests/e2e/helpers/in-memory-soroban-sandbox.ts at
lines 134-136, parse the JSON-RPC body as unknown and validate that it is a
request object with valid id, method, and params before accessing those fields;
preserve the existing malformed-input error path. At lines 154-175, add
method-specific runtime guards for keys, transaction, and hash before
dispatching, flatMap processing, or XDR parsing, rejecting invalid shapes
instead of relying on TypeScript assertions.
- Around line 247-250: Update the Soroban transaction data handling around
resources() to use the SDK 16.0.1 type of tx.ext().value() for nullable
narrowing, or define a reusable predicate with a value is
xdr.SorobanTransactionData return type. Validate the runtime value once, remove
both repeated as unknown as xdr.SorobanTransactionData assertions, and call
resources().footprint() only after narrowing succeeds.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: b04c1d4a-11bd-4e53-bd5b-94b1877254d6

📥 Commits

Reviewing files that changed from the base of the PR and between 35d9237 and 37189d0.

📒 Files selected for processing (1)
  • tests/e2e/helpers/in-memory-soroban-sandbox.ts
📜 Review details
🔇 Additional comments (1)
tests/e2e/helpers/in-memory-soroban-sandbox.ts (1)

208-208: LGTM!

Comment on lines +134 to 136
let payload: { id?: unknown; method?: string; params?: Record<string, unknown> };
try {
payload = JSON.parse(body);

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

Validate JSON-RPC input instead of relying on TypeScript assertions.

The new types describe the expected shape but do not validate incoming JSON. A malformed payload can escape the error path, while malformed method fields reach flatMap or XDR parsing with the wrong runtime type.

  • tests/e2e/helpers/in-memory-soroban-sandbox.ts#L134-L136: parse as unknown and validate the request object before reading id, method, or params.
  • tests/e2e/helpers/in-memory-soroban-sandbox.ts#L154-L175: add method-specific guards for keys, transaction, and hash before dispatching.
📍 Affects 1 file
  • tests/e2e/helpers/in-memory-soroban-sandbox.ts#L134-L136 (this comment)
  • tests/e2e/helpers/in-memory-soroban-sandbox.ts#L154-L175
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@tests/e2e/helpers/in-memory-soroban-sandbox.ts` around lines 134 - 136, In
tests/e2e/helpers/in-memory-soroban-sandbox.ts at lines 134-136, parse the
JSON-RPC body as unknown and validate that it is a request object with valid id,
method, and params before accessing those fields; preserve the existing
malformed-input error path. At lines 154-175, add method-specific runtime guards
for keys, transaction, and hash before dispatching, flatMap processing, or XDR
parsing, rejecting invalid shapes instead of relying on TypeScript assertions.

Comment on lines +247 to 250
if (!sorobanData || typeof (sorobanData as unknown as xdr.SorobanTransactionData).resources !== "function") {
throw new Error("Missing Soroban transaction data");
}
const footprint = (sorobanData as xdr.SorobanTransactionData).resources().footprint();

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Prefer a type guard over repeated assertions.

The as unknown as xdr.SorobanTransactionData casts do not validate the runtime shape and are repeated. Verify the SDK 16.0.1 type of tx.ext().value(), then either use its nullable narrowing directly or add a predicate returning value is xdr.SorobanTransactionData.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@tests/e2e/helpers/in-memory-soroban-sandbox.ts` around lines 247 - 250,
Update the Soroban transaction data handling around resources() to use the SDK
16.0.1 type of tx.ext().value() for nullable narrowing, or define a reusable
predicate with a value is xdr.SorobanTransactionData return type. Validate the
runtime value once, remove both repeated as unknown as
xdr.SorobanTransactionData assertions, and call resources().footprint() only
after narrowing succeeds.

@gitguardian

gitguardian Bot commented Jul 29, 2026

Copy link
Copy Markdown

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

Since your pull request originates from a forked repository, GitGuardian is not able to associate the secrets uncovered with secret incidents on your GitGuardian dashboard.
Skipping this check run and merging your pull request will create secret incidents on your GitGuardian dashboard.

🔎 Detected hardcoded secret in your pull request
GitGuardian id GitGuardian status Secret Commit Filename
- - Generic High Entropy Secret ded54f4 tests/commands/guard-cli-export-import.test.ts View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secret safely. Learn here the best practices.
  3. Revoke and rotate this secret.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

AbdulmalikAlayande added a commit that referenced this pull request Aug 6, 2026
…sandbox.ts (#556, #361)

Types the sandbox's JSON-RPC dispatch params as Record<string, unknown>
instead of any, with explicit as unknown as X casts at each typed call
site. Type-only change — behavior unchanged, e2e suite passes unmodified.
@AbdulmalikAlayande

Copy link
Copy Markdown
Collaborator

Thanks — clean, minimal, exactly the right scope. Applied as-is (verified tsc/lint/full e2e suite, zero any warnings remaining in the file). Merged as ada9e10.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore(lint): eliminate no-explicit-any warnings in tests/e2e/helpers/in-memory-soroban-sandbox.ts