docs: cycle cost docs follow-up — ICP formula, worked example, instruction profiling, cost traps
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 68/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Tranquilo
- Stack tecnológico
- markdown, rust
- Área
- documentation
Línea de trabajo
Empieza leyendo las secciones relevantes existentes en docs/references/cycle-costs.md, docs/guides/canister-management/cycles-management.mdx y docs/guides/canister-management/optimization.md. Comprueba la terminología del contexto y los enlaces existentes antes de documentar las fórmulas de ICP, el ejemplo de costes resuelto, los contadores de rendimiento, la advertencia sobre max_response_bytes, el cálculo del freezing threshold y la descripción de la calculadora. Se considera terminado cuando las seis lagunas estén cubiertas sin añadir archivos, realizar cambios estructurales ni modificar la barra lateral.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Follow-up to #272.
After reviewing the cycle cost documentation restructured in #272, the following gaps remain. All are additive changes to existing pages — no new files, no structural changes, no sidebar edits.
Gap 1: The "how much ICP to buy" formula is never written out
The cycle→XDR→ICP conversion chain is documented in pieces but never assembled. A developer cannot answer "I need 5T cycles — how much ICP do I buy?" without reading three separate sections.
Proposed fix: Add a concise formula + worked example in docs/guides/canister-management/cycles-management.mdx immediately after the budget guidance sentence:
icp_needed = (cycles_needed / 1_000_000_000_000) / (xdr_permyriad_per_icp / 10_000)
Example: need 5T cycles, CMC returns xdr_permyriad_per_icp = 19482 → 1 ICP = 1.9482 XDR → 5 / 1.9482 ≈ 2.57 ICP to purchase.
Gap 2: No worked cost estimation example
All per-operation numbers exist in docs/references/cycle-costs.md but there is no example that combines them. A developer with a canister using HTTPS outcalls + threshold signing + storage + compute cannot find a single synthesized monthly cost estimate.
Proposed fix: Add a "Worked example" section to docs/references/cycle-costs.md — e.g. a canister making 1,000 HTTPS outcalls/day, 10 ECDSA signatures/day, storing 500 MiB, executing 100M instructions/call × 50 calls/day — that walks through each cost line and arrives at a monthly cycle total and ICP purchase estimate.
Gap 3: Instruction count is impossible to estimate before deployment
The docs state "1B instructions = 1B cycles" but do not explain how to measure the instruction count of a canister call. performance_counter() (the Wasm instruction counter available via ic0.performance_counter(0)) is not mentioned anywhere.
Proposed fix: Add a "Measuring instruction counts" paragraph to docs/guides/canister-management/optimization.md showing ic0.performance_counter(0) in Rust (ic_cdk::api::performance_counter(0)) and the equivalent in Motoko (Prim.performanceCounter(0)), with a note that sampling before/after a block gives the instruction cost of that block.
Gap 4: HTTPS outcall max_response_bytes default is a silent cost trap
If max_response_bytes is not set it defaults to 2 MiB. On a 34-node subnet: 2_097_152 × 27_200 cycles/byte ≈ 57B cycles per call regardless of actual response size — even for a 200-byte response. This is not flagged as dangerous anywhere in the cost docs.
Proposed fix: Add a warning callout in the HTTPS outcalls section of docs/references/cycle-costs.md:
Always set
max_response_bytesexplicitly. The default (2 MiB) charges for the full reserved size even if the actual response is 1 KB. On a 34-node subnet that is approximately 57B cycles per call.
Gap 5: Freezing threshold and burn rate are never connected
The cycles-management guide recommends "90 days for production" but never explains that this requires estimated_daily_burn × threshold_days in cycle reserves. A developer setting a 90-day threshold on a canister burning 5B cycles/day needs 450B cycles reserved — this is non-obvious.
Proposed fix: Add a formula immediately below the freezing threshold section in docs/guides/canister-management/cycles-management.mdx:
required_balance ≥ estimated_daily_burn × threshold_days
Example: 5B cycles/day × 90 days = 450B cycles minimum balance before the threshold triggers.
Gap 6: Pricing calculator is mentioned without explanation
https://3d5wy-5aaaa-aaaag-qkhsq-cai.icp0.io/ is linked once with no description of inputs or how to interpret results. It should either get a one-sentence description or be promoted more visibly from cycles-management.mdx.
Files to change
| File | Changes |
|---|---|
docs/references/cycle-costs.md |
Gap 2 (worked example) + Gap 4 (max_response_bytes warning) |
docs/guides/canister-management/cycles-management.mdx |
Gap 1 (ICP formula) + Gap 5 (burn rate formula) + Gap 6 (calculator description) |
docs/guides/canister-management/optimization.md |
Gap 3 (performance_counter guidance) |
- Lenguaje dominante
- JavaScript
- Estrellas
- 4
- Forks
- 5
- Merge medio
- 1 d 6 h
- PR fusionados (30 d)
- 30
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de dfinity/developer-docs
-
Dificultad 4/5 3-5 días Aptitud para principiantes 55/100
dfinity/developer-docs#281 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
dfinity/developer-docs#279 ·
-
documentation enhancement
Dificultad 4/5 3-5 días Aptitud para principiantes 52/100
dfinity/developer-docs#232 · 1 comentario ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 65/100
dfinity/developer-docs#228 ·
-
feat(bitcoin): add region markers to basic_bitcoin examples for stable developer workflow embeds Abiertoenhancement
Dificultad 4/5 3-5 días Aptitud para principiantes 52/100
dfinity/developer-docs#168 ·
Todos los issues de dfinity/developer-docs
Issues similares
-
curation good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
amponce/archive-movie-browser#186 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
clerk/javascript#9852 ·
-
bug p1 tools
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
HarperFast/skills#96 ·
-
factory-active factory-automatic task-bug-reproduction-cannot-reproduce task-identify-harness-labels-done task-identify-issue-type-done
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100