Instalação

Procurando pela versão beta? Consulte Instalação Beta para imagens Docker e kora-cli@2.2.0-beta.7.

Comece a usar o Kora instalando a ferramenta CLI para operar um nó Kora ou o SDK TypeScript para aplicações cliente que interagem com um nó Kora.

Requisitos do Sistema

Para CLI (Servidor)

Rust: Versão 1.86 ou superior (não necessário para Docker)

Para SDK TypeScript (Cliente)

Node.js: Versão LTS ou superior
TypeScript: versão mais recente

Dependências Opcionais

Solana CLI: Útil para geração de chaves e testes
Docker: Para implantações containerizadas

CLI Kora

A CLI Kora é a principal forma de executar e gerenciar nós Kora. Escolha seu método de instalação preferido:

Opção 1: Instalar pelo Cargo

Instale diretamente do crates.io usando o Cargo:

cargo install kora-cli

Opção 2: Compilar a Partir do Código-Fonte

Clone e compile a versão estável mais recente a partir do código-fonte:

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

Nota: A branch main do Kora é uma branch de integração e pode conter alterações não lançadas ou em fase beta. Sempre faça checkout da tag de versão estável mais recente. Consulte a página de lançamentos para a versão estável mais recente.

Isso irá compilar e instalar o binário kora no diretório local bin do Cargo.

Opção 3: Docker

Baixe a imagem Docker oficial do GitHub Container Registry:

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

Execute com seus arquivos de configuração 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 Instalação

Verifique se a CLI do Kora está instalada corretamente:

kora --version

SDK TypeScript

Instale o SDK TypeScript do Kora para aplicações cliente:

pnpm add @solana/kora

O Kora requer @solana/kit e vários pacotes de plugins do Kit como dependências peer. A maioria dos gerenciadores de pacotes (pnpm v7+, npm v7+) instalam automaticamente as dependências peer, então normalmente você só precisa de:

pnpm add @solana/kora @solana/kit

Se o seu gerenciador de pacotes não instalar automaticamente as dependências peer, instale-as 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 Versão

KoraClient (independente): Funciona com @solana/kit v5.0+
koraPlugin() (componível): Requer @solana/kit v5.4+ para o padrão createEmptyClient().use()
createKitKoraClient() (cliente Kit): Requer @solana/kit v6.1+ para composição completa de plugins

Consulte a Visão Geral da API JSON-RPC para exemplos detalhados de uso do cliente.

Verificar Instalação do SDK

Verifique a instalação do SDK com um teste de conexão simples:

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();

Resolução de Problemas

Problemas com a CLI

"kora: comando não encontrado": Certifique-se de que ~/.cargo/bin está no seu PATH:

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

Falha na compilação: Atualize o Rust para a versão estável mais recente:

rustup update stable

Problemas com o SDK

Avisos de dependência de pares: Instale as dependências Solana necessárias listadas acima.

Erros de TypeScript: Certifique-se de que sua versão do TypeScript seja 4.5+ e instale as definições de tipo:

pnpm add -D @types/node

Conexão recusada: Certifique-se de que seu servidor Kora esteja em execução e acessível no endpoint especificado.