https://github.com/solana-foundation/kora
Reference implementation for a Solana relayer. Provides a lib, rpc, and cli crate in order to enable gasless experiences on Solana.
https://github.com/solana-foundation/kora
Last synced: 4 months ago
JSON representation
Reference implementation for a Solana relayer. Provides a lib, rpc, and cli crate in order to enable gasless experiences on Solana.
- Host: GitHub
- URL: https://github.com/solana-foundation/kora
- Owner: solana-foundation
- Created: 2024-11-30T20:29:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-24T16:30:45.000Z (about 1 year ago)
- Last Synced: 2025-04-09T22:10:48.368Z (about 1 year ago)
- Language: Rust
- Homepage:
- Size: 251 KB
- Stars: 25
- Watchers: 2
- Forks: 96
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome - solana-foundation/kora - Implementation of a Solana relayer. Provides a lib and cli crate in order to enable signing experiences on Solana (Rust)
README
Kora: Solana Signing Infrastructure
[](https://github.com/solana-foundation/kora/actions/workflows/rust.yml)
[](https://deepwiki.com/solana-foundation/kora)
[](https://crates.io/crates/kora-cli)
[](https://www.npmjs.com/package/@solana/kora)
[](https://opensource.org/licenses/MIT)
> **Branch Update (Jan 6, 2025):** We migrated pre-release features to [`release/2.2.0`](https://github.com/solana-foundation/kora/tree/release/2.2.0). The `main` branch now only contains audited releases plus minor hotfixes/docs. See [v2.0.3](https://github.com/solana-foundation/kora/releases/tag/v2.0.3) for the latest stable release.
**Kora is your Solana signing infrastructure.** Enable gasless transactions where users pay fees in any token—USDC, BONK, or your app's native token—or handle any transaction signing that requires a trusted signer.
### Why Kora?
- **Better UX**: Users never need SOL
- **Revenue Control**: Collect fees in USDC, your token, or anything else
- **Production Ready**: Secure validation, rate limiting, monitoring built-in
- **Easy Integration**: JSON-RPC API + TypeScript SDK
- **Flexible Deployment**: Railway, Docker, or any cloud platform
### Architecture
- **Language**: Rust with TypeScript SDK
- **Protocol**: JSON-RPC 2.0
- **Signers**: Solana Private Key, Turnkey, Privy
- **Authentication**: API Key, HMAC, or none
- **Deployment**: Flexible deployment options (Docker, Railway, etc.)
### Features
- Configurable validation rules and allowlists
- Full Token-2022 support with extension filtering
- Redis caching for improved performance
- Rate limiting and spend protection
- Secure key management (Turnkey, Privy, Vault)
- HMAC and API key authentication
- Prometheus metrics and monitoring
- Enhanced fee payer protection policies
## Quick Start
Install Kora:
```bash
cargo install kora-cli
```
Basic usage:
```bash
kora rpc [OPTIONS] # --help for full list of options
```
**[→ Full Documentation](https://launch.solana.com/docs/kora/getting-started)** - Learn how Kora works
**[→ Quick Start Guide](https://launch.solana.com/docs/kora/getting-started/quick-start)** - Get Kora running locally minutes
**[→ Node Operator Guide](https://launch.solana.com/docs/kora/operators)** - Run a paymaster
## TypeScript SDK
Kora provides a simple JSON-RPC interface:
```typescript
// Initialize Kora client
import { KoraClient } from '@solana/kora';
const kora = new KoraClient({ rpcUrl: 'http://localhost:8080' });
// Sign transaction as paymaster
const signed = await kora.signTransaction({ transaction });
```
**[→ API Reference](https://launch.solana.com/docs/kora/json-rpc-api)**
## Local Development
### Prerequisites
- Rust 1.86+ or
- Solana CLI 2.2+
- Node.js 20+ and pnpm (for SDK)
### Installation
```bash
git clone https://github.com/solana-foundation/kora.git
cd kora
make install
```
### Build
```bash
make build
```
### Running the Server
Basic usage:
```bash
kora rpc [OPTIONS]
```
Or for running with a test configuration, run:
```bash
make run
```
### Local Testing
And run all tests:
```bash
make test-all
```
## Repository Structure
```
kora/
├── crates/ # Rust workspace
│ ├── kora-lib/ # Core library with RPC server (signers, validation, transactions)
│ └── kora-cli/ # Command-line interface and RPC server
├── sdks/ # Client SDKs
│ └── ts/ # TypeScript SDK
├── tests/ # Integration tests
├── docs/ # Documentation
│ ├── getting-started/ # Quick start guides
│ └── operators/ # Node operator documentation
├── Makefile # Build and development commands
└── kora.toml # Example configuration
```
## Security Audit
Kora has been audited by [Runtime Verification](https://runtimeverification.com/). View the [audit report](audits/20251119_runtime-verification.pdf). (Audited up to commit [8c592591](https://github.com/solana-foundation/kora/commit/8c592591debd08424a65cc471ce0403578fd5d5d))
**Note:** Kora uses the `solana-keychain` package which has not been audited. Use at your own risk.
## Community & Support
- **Questions?** Ask on [Solana Stack Exchange](https://solana.stackexchange.com/) (use the `kora` tag)
- **Issues?** Report on [GitHub Issues](https://github.com/solana-foundation/kora/issues)
- **Operators:** Running Kora in production? Reach out to [@a_milz](https://x.com/a_milz) or [@dev_jodee](https://x.com/dev_jodee) on X to join our operator Slack channel for updates and support
## Other Resources
- [Kora CLI Crates.io](https://crates.io/crates/kora-cli) - Rust crate for running a Kora node
- [Kora Lib Crates.io](https://crates.io/crates/kora-lib) - Rust crate for the Kora library
- [@solana/kora](https://www.npmjs.com/package/@solana/kora) - TypeScript SDK for Kora
---
Built and maintained by the [Solana Foundation](https://solana.org).
Licensed under MIT. See [LICENSE](LICENSE) for details.