Skip to content

Feat/add storage ttl doc#1687

Merged
Baskarayelu merged 3 commits into
QuickLendX:mainfrom
AugistineCreates:feat/add-storage-ttl-doc
Jun 27, 2026
Merged

Feat/add storage ttl doc#1687
Baskarayelu merged 3 commits into
QuickLendX:mainfrom
AugistineCreates:feat/add-storage-ttl-doc

Conversation

@AugistineCreates

Copy link
Copy Markdown
Contributor

This pr closes #1577

This PR resolves the issue by introducing a central reference document for the Time-To-Live (TTL) storage keys and extension strategy used across the Soroban smart contracts. It maps out each key, its storage class, and bump parameters, preserving tribal knowledge and making reviewers and contributors more productive.

Type of Change

  • Documentation update

Changes Made

Files Modified

  • README.md
  • quicklendx-contracts/README.md

New Files Added

  • docs/STORAGE_TTL.md

Key Changes

  • Documented all Persistent and Instance keys used in the codebase.
  • Mapped keys to PERSISTENT_TTL_THRESHOLD (~402 days) where applicable.
  • Provided concrete, compiler-ready Rust examples demonstrating how TTL extensions should be handled when reading, writing, or sweeping keys.
  • Cross-linked the documentation from root and contract-level READMEs.

Testing

  • Manual testing completed (Verified code formatting and validity of Rust/Soroban SDK examples)
  • No breaking changes introduced (No logic modifications made)

Contract-Specific Checks

  • Security considerations reviewed (Ensured all documented details match current implementation behavior)

Code Quality

  • Functions/keys are properly documented
  • Code formatting follows standards

Documentation

  • README updated
  • API/Storage documentation updated

@drips-wave

drips-wave Bot commented Jun 27, 2026

Copy link
Copy Markdown

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

@Baskarayelu

Copy link
Copy Markdown
Contributor

add storage ttl doc — solid — merging 👍

@Baskarayelu Baskarayelu merged commit 1fe8e83 into QuickLendX:main Jun 27, 2026
1 check failed
@grantfox-oss grantfox-oss Bot mentioned this pull request Jun 27, 2026
5 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

Development

Successfully merging this pull request may close these issues.

Add per-storage-key TTL doc

2 participants