diff --git a/README.md b/README.md index 36bd996..8c105dc 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,15 @@ A minimalistic server-based allocator for [The Compact](https://github.com/Unisw - 💾 Persistent storage using PGLite to track attested compacts and used nonces - ✅ Comprehensive validation pipeline to ensure resource locks never end up in an overallocated state +## Intentionally Minimal Scope + + - 🌱 Single-resource-lock, single-chain compacts only: No `BatchCompact` or `MultichainCompact` attestations + - 🔢 Strict nonce usage: Ensures every attested nonce is unique; no reuse on expirations and no direct onchain nonce consumption + - 🧭 No `attest()` callbacks for ERC6909 transfers: focused solely on attesting compacts + - 🪞 No compact qualification: Attests to the exact compact provided to it without adding qualifiers or extra metadata + - 🔮 No direct on-chain awareness: Relies entirely on indexer and internal attestation state + - ⏳ Straightforward finalization: Uses a simple, time-based approach per chain for determining transaction finality + ## API Usage ### Health Check