0xMiden / 0xMiden/rust-sdk

Document and improve sync strategy for large public faucets

Abierto
#2,149 1 comentario 0 reacciones 0 asignados Ver en GitHub
enhancement
Lenguaje dominante
Rust
Estrellas
78
Forks
129
Merge medio
4 d 14 h
PR fusionados (30 d)
52

Descripción

## Problem

Pioneer feedback reports that public faucets become slow and difficult to reinitialize as usage grows.

When a public faucet has accumulated a large amount of history, client re-initialization and sync can take several minutes. Developers end up implementing custom sync logic to avoid full or unnecessary sync work.

## Why this matters

Faucets are one of the first account types app developers use. If the simple faucet path works only for small examples, every production-ish app has to rediscover the same sync strategy under load.

This is especially painful for public test faucets, where high usage is expected and where new clients may need to initialize from an already-large account.

## Proposed scope

Define the recommended sync strategy for large public faucets and improve the client where the current APIs make that strategy hard to implement.

Potential areas to cover:

- avoid unnecessary full sync work for large public faucet accounts,
- clarify when nullifier sync is required for faucet operators vs. ordinary users,
- expose or document a lighter initialization path for faucet clients,
- document how account storage/vault sync should be handled for large faucets,
- align with ongoing `StateSync` and large-account sync refactors.

## Acceptance criteria

- The client team has a documented recommended strategy for initializing/syncing large public faucets.
- Developers do not need custom ad hoc sync logic for common high-volume faucet use.
- Any required client API changes are identified or implemented.
- The docs explain which sync operations faucet operators actually need.
- The issue is linked to broader large-account / `StateSync` work.

## Related context

- 0xMiden/miden-client#2038
- 0xMiden/miden-client#2102
- 0xMiden/miden-client#2015

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Revise los issues vinculados (#2038, #2102, #2015) en el repositorio miden-client para comprender los problemas de sincronización. Examine las APIs de sincronización del cliente y las refactorizaciones de StateSync. Identifique qué operaciones son necesarias para los operadores de faucet en comparación con los usuarios. Documente una estrategia para evitar sincronizaciones completas y proponga cambios en la API si es necesario.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
rust
Área
backend-api-design, documentation
Tipo de issue
Documentación
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Tranquilo
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.