Instalación

¿Buscas la versión beta? Consulta Instalación Beta para imágenes Docker y kora-cli@2.2.0-beta.7.

Comienza con Kora instalando la herramienta CLI para operar un nodo Kora o el SDK de TypeScript para aplicaciones cliente que interactúan con un nodo Kora.

Requisitos del Sistema

Para CLI (Servidor)

Rust: Versión 1.86 o superior (no requerido para Docker)

Para SDK de TypeScript (Cliente)

Node.js: Versión LTS o superior
TypeScript: última versión

Dependencias Opcionales

CLI de Solana: Útil para la generación de claves y pruebas
Docker: Para implementaciones en contenedores

CLI de Kora

La CLI de Kora es la forma principal de ejecutar y administrar nodos Kora. Elige tu método de instalación preferido:

Opción 1: Instalar desde Cargo

Instala directamente desde crates.io usando Cargo:

cargo install kora-cli

Opción 2: Compilar desde el Código Fuente

Clona y compila la última versión estable desde el código fuente:

git clone https://github.com/solana-foundation/kora.git
cd kora
git checkout v2.0.5
just install

Nota: La rama main de Kora es una rama de integración y puede contener cambios sin publicar o en versión beta. Siempre verifica la última etiqueta de versión estable. Consulta la página de lanzamientos para la última versión estable.

Esto compilará e instalará el binario kora en tu directorio local de binarios de Cargo.

Opción 3: Docker

Descarga la imagen oficial de Docker desde GitHub Container Registry:

docker pull ghcr.io/solana-foundation/kora:latest

Ejecuta con tus archivos de configuración montados:

docker run -v $(pwd)/kora.toml:/app/kora.toml \
  -v $(pwd)/signers.toml:/app/signers.toml \
  -p 8080:8080 \
  ghcr.io/solana-foundation/kora:latest \
  rpc start --signers-config /app/signers.toml

Verificar la Instalación

Verifica que la CLI de Kora esté instalada correctamente:

kora --version

SDK de TypeScript

Instala el SDK de TypeScript de Kora para aplicaciones cliente:

pnpm add @solana/kora

Kora requiere @solana/kit y varios paquetes de complementos de Kit como dependencias de pares. La mayoría de los gestores de paquetes (pnpm v7+, npm v7+) instalan automáticamente las dependencias de pares, por lo que normalmente solo necesitas:

pnpm add @solana/kora @solana/kit

Si tu gestor de paquetes no instala automáticamente las dependencias de pares, instálalas manualmente:

pnpm add @solana/kit @solana-program/token @solana-program/compute-budget \
  @solana/kit-plugin-instruction-plan @solana/kit-plugin-payer @solana/kit-plugin-rpc

Requisitos de Versión

KoraClient (independiente): Funciona con @solana/kit v5.0+
koraPlugin() (componible): Requiere @solana/kit v5.4+ para el patrón createEmptyClient().use()
createKitKoraClient() (cliente Kit): Requiere @solana/kit v6.1+ para la composición completa de complementos

Consulta la Descripción General de la API JSON-RPC para ver ejemplos detallados de uso del cliente.

Verificar la Instalación del SDK

Verifica la instalación de tu SDK con una prueba de conexión simple:

import { KoraClient } from "@solana/kora";

async function testConnection() {
  const client = new KoraClient({ rpcUrl: "http://localhost:8080" }); // Replace with your Kora server URL

  try {
    const config = await client.getConfig();
    console.log("✅ Successfully connected to Kora server");
  } catch (error) {
    console.error("❌ Connection failed:", error.message);
  }
}

testConnection();

Solución de Problemas

Problemas con la CLI

"kora: comando no encontrado": Asegúrate de que ~/.cargo/bin esté en tu PATH:

echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

Error en la compilación: Actualiza Rust a la última versión estable:

rustup update stable

Problemas con el SDK

Advertencias de dependencias peer: Instale las dependencias de Solana requeridas que se enumeran arriba.

Errores de TypeScript: Asegúrese de que su versión de TypeScript sea 4.5+ e instale las definiciones de tipos:

pnpm add -D @types/node

Conexión rechazada: Asegúrese de que su servidor Kora esté en ejecución y sea accesible en el endpoint especificado.