Skip to content

Commit

Permalink
slap on readme and license
Browse files Browse the repository at this point in the history
  • Loading branch information
piotrostr committed Feb 6, 2025
1 parent 4c6f577 commit 3765779
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 2 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2025 3L
Copyright (c) 2025 piotrostr

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
63 changes: 62 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,62 @@
# rig-onchain-kit
# Rig Onchain Kit

A robust framework for building AI-powered applications that interact natively
with blockchain networks. Combines LLM capabilities with secure blockchain
operations to create intelligent agents capable of executing complex on-chain
interactions across Solana and EVM networks.

## Features

- **Dual-chain Support** - Native support for Solana and EVM ecosystems
- **Secure by Design** - Thread-local signer isolation and Privy-based
authentication
- **Real-time Streaming** - SSE-enabled HTTP service for concurrent user
sessions
- **Extensible Tool System** - Combine prebuilt DeFi operations with custom
logic
- **Wallet Agnostic** - Supports local key management and Privy-embedded
wallets

## Quick Start

```bash
# Add to your project
cargo add rig-onchain-kit --features full

# For custom tools
cargo add rig-tool-macro
```

Basic usage:

```rust
use rig_onchain_kit::agent::create_solana_agent;
use rig_onchain_kit::signer::SignerContext;
use rig_onchain_kit::signer::solana::LocalSolanaSigner;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
let private_key = std::env::var("SOLANA_PRIVATE_KEY")?;
let signer = LocalSolanaSigner::new(private_key);

SignerContext::with_signer(Arc::new(signer), async {
let agent = create_solana_agent();
let response = agent.prompt("what is my public key?")?);
println!("{}", response);
});

Ok(())
}
```

## Documentation

Read the [full documentation](https://docs.rig.ai/rig-onchain-kit) to learn more

## License

[MIT](https://github.com/0xPlaygrounds/rig-onchain-kit/blob/main/LICENSE)

---

build with <3 by [listen](https://github.com/piotrostr/listen)

0 comments on commit 3765779

Please sign in to comment.