Estándares de Código y Programas

Estándares consistentes reducen el tiempo de revisión y los hallazgos de auditoría: dónde viven los PDA, cómo se nombran los errores, cómo los clientes codifican las cantidades. Esta página define las convenciones del equipo para programas nativos y de Anchor en Agave 4.1.1.

Receta

Tarjeta de referencia rápida - lista para copiar y pegar.

// programs/<name>/src/constants.rs
pub const JUPITER_PROGRAM_ID: Pubkey = pubkey!("JUP6LkbZbjS1jKKwapdHNy74zcZ3tLUZoi5QNyVTaV4");
 
// programs/<name>/src/error.rs
#[error_code]
pub enum VaultError {
    #[msg("El programa está pausado")]
    Paused,
}

Cuándo consultar esto:

• Incorporación de nuevos ingenieros
• Redacción de reglas de linter y CI
• Lista de verificación de preparación para auditoría
• Referencia para guías de contribuyentes de código abierto

Ejemplo de Trabajo

// Nomenclatura de cuentas: <Entidad><Rol> ej. UserPosition, PoolConfig
#[account(
    init,
    payer = user,
    space = 8 + UserPosition::INIT_SPACE,
    seeds = [b"position", user.key().as_ref(), pool.key().as_ref()],
    bump
)]
pub user_position: Account<'info, UserPosition>,
 
// Aritmética
let new_total = config.total_deposits
    .checked_add(amount)
    .ok_or(VaultError::Overflow)?;

// packages/clients - cantidades como bigint
const amountLamports = parseSolToLamports(userInput); // nunca Number() para tokens

Lo que esto demuestra:

• IDs de CPI centralizados en constants.rs
• Patrón obligatorio checked_add
• INIT_SPACE para el dimensionamiento de cuentas de Anchor 0.32.1
• Política de enteros para tokens del cliente

Análisis Profundo

Diseño del Repositorio

programs/          Crates de Anchor/nativos
tests/litesvm/     Pruebas de integración
app/               dApp Next.js
packages/idl/      IDL publicado + generación de código
docs/adr/          Decisiones de arquitectura

Nomenclatura

Trampas Comunes

• Números mágicos en semillas - Confusión en auditoría. Solución: pub const SEED_VAULT: &[u8] = b"vault";
• unwrap() en programas - Pánico = superficie de explotación. Solución: ? y ErrorCode.
• Cadenas de ID de programa duplicadas - Desfase cliente/servidor. Solución: Un solo crate de constantes o env de un paquete.
• Omitir rustfmt en CI - Ruido en la revisión. Solución: Se requiere cargo fmt --check.
• Mezcla de web3.js y kit - Dos pilas RPC. Solución: Solo kit para código nuevo según ADR.

Alternativas

Preguntas Frecuentes

Relacionado

• Gobernanza de Dependencias y Crates - política de crates
• Convenciones de Documentación - documentación junto al código
• Cultura de Revisión de Código - aplicación humana

Versiones de la Pila: Esta página fue escrita para Agave 4.1.1, Solana CLI 3.0.10, Anchor 0.32.1, anchor-lang 0.32.1, Rust 1.91.1, @solana/kit 7.0.0, Surfpool 0.12.0, y LiteSVM 0.6.x.