docs(readme): Cost — when to use the enclave#29
Conversation
Address the natural 'isn't this expensive?' question with real, measured numbers (~20 tokens per enclave op) and honest guidance: frequency×value fit, plus the three cost levers (release-once-reuse, seal selectively, proxy where it matters). Placed mid-README (after integrations, before the CLI reference) with a TOC link + anchor. Co-authored-by: algsoch <algsoch@gmail.com>
PR Summary by Qododocs(readme): Add Cost section with measured token usage guidance
AI Description
High-Level Assessment
Files changed (1)
|
Code Review by Qodo
1. Token/credit ambiguity
|
| **How small?** Measured live: **~20 tokens per operation** (a `use`/release or a | ||
| proxy forward). The self-serve `signup` grant (~20,000 tokens) is roughly | ||
| **1,000 secret-uses**, free, on testnet. |
There was a problem hiding this comment.
1. Token/credit ambiguity 🐞 Bug ⚙ Maintainability
The new Cost section calls the signup grant “~20,000 tokens” while the Installation section describes the same grant as “~20,000 credits,” leaving it unclear whether these are synonyms or different units. This can confuse users comparing the cost math with the balance shown by `blindfold credit`.
Agent Prompt
## Issue description
The README uses inconsistent terminology for the same signup grant amount: it’s described as “credits” in one place and “tokens” in another. This makes the pricing/balance units ambiguous.
## Issue Context
Other docs/CLI help text uses combined wording (“token/credit”), suggesting these terms may be synonymous, but the README should be explicit and consistent.
## Fix Focus Areas
- README.md[127-135]
- README.md[492-500]
- docs/AGENTS.md[83-93]
## Suggested fix
Pick one term and use it consistently throughout README (and ideally match the CLI wording), e.g.:
- Change both places to “tokens (credits)” if both terms are in use, **or**
- Standardize on “tokens” everywhere (including the earlier “~20,000 credits” mention), **or**
- Standardize on “credits” everywhere and adjust the new Cost section accordingly.
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
Adds a mid-README 💸 Cost section answering the honest 'isn't this expensive?' question:
use/release or proxy forward); the ~20k signup grant ≈ 1,000 uses, free on testnet.Placed after the integration sections, before the CLI reference; TOC link +
#costanchor added.Co-authored-by: algsoch algsoch@gmail.com
Summary by cubic
Adds a "Cost — when to use the enclave" section to the README with measured cost (~20 tokens per op), fit guidance, free testnet grant (~20k tokens ≈ 1,000 uses), and three levers to reduce spend (release once/reuse, seal selectively, proxy where it matters).
Placed after the integrations section, with a TOC link and a
#costanchor.Written for commit 2c52814. Summary will update on new commits.