Skip to content

feat(#483): add ContractStorageExporter for contract storage snapshots - #568

Open
maisamariwanta-crypto wants to merge 1 commit into
Stellar-split:mainfrom
maisamariwanta-crypto:feat/contract-storage-exporter-483
Open

feat(#483): add ContractStorageExporter for contract storage snapshots#568
maisamariwanta-crypto wants to merge 1 commit into
Stellar-split:mainfrom
maisamariwanta-crypto:feat/contract-storage-exporter-483

Conversation

@maisamariwanta-crypto

Copy link
Copy Markdown

Implements ContractStorageExporter which reads all persistent and temporary storage entries for a given Soroban contract via SorobanRpc.Server.getLedgerEntries(), deserialises ScVal keys and values to typed ScValJson objects, and exports them as a typed JSON ContractStorageSnapshot.

New files:

  • src/diagnostics/ContractStorageExporter.ts
    • ContractStorageSnapshot, StorageEntry, StorageDiff types
    • ScValJson union type covering i128, u64, bool, str, vec, map, address and all other ScVal variants
    • ContractStorageExporter class with export(), diff(), fromJson()
    • scValToJson() helper exported for direct use
  • src/diagnostics/DiagnosticEventsParser.ts
    • DiagnosticEvent type and re-exports ScValJson

Updated:

  • src/index.ts — exports ContractStorageExporter, scValToJson and all related types from the package root

Tests (test/diagnostics/ContractStorageExporter.test.ts, 39 tests):

  • empty contract returns zero entries
  • persistent and temporary entries combined
  • ScVal types: void, bool, i32, u32, i64, u64, i128, str, sym, address, vec, map, nested structures
  • diff() correctly identifies added, removed, and modified entries across all three categories simultaneously
  • JSON round-trip preserves bigint-encoded-as-string values (i128, u64 max) and expiresAt metadata

closes #483

…rage snapshots

Implements ContractStorageExporter which reads all persistent and
temporary storage entries for a given Soroban contract via
SorobanRpc.Server.getLedgerEntries(), deserialises ScVal keys and
values to typed ScValJson objects, and exports them as a typed JSON
ContractStorageSnapshot.

New files:
- src/diagnostics/ContractStorageExporter.ts
  - ContractStorageSnapshot, StorageEntry, StorageDiff types
  - ScValJson union type covering i128, u64, bool, str, vec, map,
    address and all other ScVal variants
  - ContractStorageExporter class with export(), diff(), fromJson()
  - scValToJson() helper exported for direct use
- src/diagnostics/DiagnosticEventsParser.ts
  - DiagnosticEvent type and re-exports ScValJson

Updated:
- src/index.ts — exports ContractStorageExporter, scValToJson and
  all related types from the package root

Tests (test/diagnostics/ContractStorageExporter.test.ts, 39 tests):
- empty contract returns zero entries
- persistent and temporary entries combined
- ScVal types: void, bool, i32, u32, i64, u64, i128, str, sym,
  address, vec, map, nested structures
- diff() correctly identifies added, removed, and modified entries
  across all three categories simultaneously
- JSON round-trip preserves bigint-encoded-as-string values (i128,
  u64 max) and expiresAt metadata
@drips-wave

drips-wave Bot commented Jul 28, 2026

Copy link
Copy Markdown

@maisamariwanta-crypto 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

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.

Add contract storage entry snapshot exporter

1 participant