-
Notifications
You must be signed in to change notification settings - Fork 163
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'refs/remotes/origin/main'
- Loading branch information
Showing
309 changed files
with
24,230 additions
and
1,820 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,91 +1,54 @@ | ||
|
||
|
||
<div align="center"> | ||
Go out and eat some grass. | ||
|
||
[Docs](https://ohmygoat.dev) | [Examples](https://github.com/goat-sdk/goat/tree/main/typescript/examples) | [Chains](https://ohmygoat.dev/chains-wallets-plugins) | [Plugins](https://ohmygoat.dev/chains-wallets-plugins#plugins) | [Discord](https://discord.gg/goat-sdk) | ||
[Website](https://ohmygoat.dev) | [X](https://x.com/goat_sdk) | [Discord](https://discord.gg/goat-sdk) | ||
|
||
GOAT is free software, MIT licensed, sponsored by [Crossmint](https://www.crossmint.com) | ||
</div> | ||
|
||
## Goat 🐐 | ||
GOAT 🐐 (Great Onchain Agent Toolkit) is an open-source framework for adding blockchain tools such as wallets, being able to hold or trade tokens, or interacting with blockchain smart contracts, to your AI agent. | ||
|
||
**Problem**: | ||
|
||
Making agents perform onchain actions is tedious. The ecosystem is heavily fragmented, spanning 5+ popular agent development frameworks, multiple programming languages, and dozens of different blockchains and wallet architectures. | ||
For developers without blockchain expertise, finding clear instructions to perform simple actions - like sending USDC payments or placing Polymarket bets - is nearly impossible. | ||
|
||
**Solution**: | ||
|
||
GOAT solves this by providing an open-source, provider-agnostic framework that abstracts away all these combinations. | ||
|
||
- **For agent developers**: GOAT offers an always-growing catalog of ready made blockchain actions (sending tokens, using a DeFi protocol, ...) that can be imported as tools into your existing agent. It works with the most popular agent frameworks (Langchain, Vercel's AI SDK, Eliza, etc), Typescript and Python, 30+ blockchains (Solana, Base, Polygon, Mode, ...), and many wallet providers. | ||
|
||
- **For dApp / smart contract developers**: develop a plug-in in GOAT, and allow agents built with any of the most popular agent development frameworks to access your service. | ||
|
||
### Key features | ||
1. **Works Everywhere**: Compatible with Langchain, Vercel’s AI SDK, Eliza, and more. | ||
2. **Wallet Agnostic**: Supports all wallets, from your own key pairs to [Crossmint Smart Wallets](https://docs.crossmint.com/wallets/smart-wallets/overview) and Coinbase. | ||
3. **Multi-Chain**: Supports EVM chains and Solana (more coming 👀). | ||
4. **Customizable**: Use or build plugins for any onchain functionality (sending tokens, checking wallet balance, etc) and protocol (Polymarket, Uniswap, etc). | ||
 | ||
 | ||
|
||
 | ||
 | ||
 | ||
|
||
### How it works | ||
GOAT plugs into your agents tool calling capabilities adding all the functions your agent needs to interact with the blockchain. | ||
|
||
High-level, here's how it works: | ||
|
||
#### Configure the wallet you want to use | ||
```typescript | ||
// ... Code to connect your wallet (e.g createWalletClient from viem) | ||
const wallet = ... | ||
|
||
const tools = getOnChainTools({ | ||
wallet: viem(wallet), | ||
}) | ||
``` | ||
|
||
#### Add the plugins you need to interact with the protocols you want | ||
```typescript | ||
const wallet = ... | ||
|
||
const tools = getOnChainTools({ | ||
wallet: viem(wallet), | ||
plugins: [ | ||
sendETH(), | ||
erc20({ tokens: [USDC, PEPE] }), | ||
faucet(), | ||
polymarket(), | ||
// ... | ||
], | ||
}) | ||
``` | ||
|
||
#### Connect it to your agent framework of choice | ||
```typescript | ||
// ... Code to connect your wallet (e.g createWalletClient from viem) | ||
const wallet = ... | ||
|
||
const tools = getOnChainTools({ | ||
wallet: viem(wallet), | ||
plugins: [ | ||
sendETH(), | ||
erc20({ tokens: [USDC, PEPE] }), | ||
faucet(), | ||
polymarket(), | ||
// ... | ||
], | ||
}) | ||
|
||
// Vercel's AI SDK | ||
const result = await generateText({ | ||
model: openai("gpt-4o-mini"), | ||
tools: tools, | ||
maxSteps: 5, | ||
prompt: "Send 420 ETH to ohmygoat.eth", | ||
}); | ||
``` | ||
</div> | ||
|
||
See [here](https://github.com/goat-sdk/goat/tree/main/typescript/examples) for more examples. | ||
# GOAT 🐐 | ||
 | ||
|
||
|
||
GOAT (Great Onchain Agent Toolkit) is a library that adds more than +200 onchain tools to your AI agent. | ||
|
||
* **+200 tools**: DeFi (Uniswap, Jupiter, KIM, Orca, etc.), minting (OpenSea, MagicEden, etc.), betting (Polymarket, etc.), analytics (CoinGecko, BirdEye, Allora, etc.) and more | ||
* **Chains**: EVM (Base, Polygon, Mode, Sei, etc.), Solana, Aptos, Chromia, Fuel, Sui, Starknet, Zilliqa, etc. | ||
* **Wallets**: keypair, smart wallets (Crossmint, etc.), LIT, MPC (Coinbase, etc.) | ||
* **Agent Frameworks**: AI SDK, Langchain, Eliza, ZerePy, GAME, ElevenLabs, etc. | ||
|
||
|
||
## Table of Contens | ||
- [📘 Typescript](https://github.com/goat-sdk/goat/tree/main/typescript) | ||
- [See all plugins](https://github.com/goat-sdk/goat/tree/main/typescript#plugins) | ||
- [Installation](https://github.com/goat-sdk/goat/tree/main/typescript#installation) | ||
- [Usage](https://github.com/goat-sdk/goat/tree/main/typescript#usage) | ||
- [Examples](https://github.com/goat-sdk/goat/tree/main/typescript/examples) | ||
- [How to create a plugin](https://github.com/goat-sdk/goat/tree/main/typescript#how-to-create-a-plugin) | ||
- [How to add a chain](https://github.com/goat-sdk/goat/tree/main/typescript#how-to-add-a-chain) | ||
- [How to add a wallet provider](https://github.com/goat-sdk/goat/tree/main/typescript#how-to-add-a-wallet-provider) | ||
- [Packages](https://github.com/goat-sdk/goat/tree/main/typescript#packages) | ||
- [Plugins](https://github.com/goat-sdk/goat/tree/main/typescript#plugins) | ||
- [Wallets](https://github.com/goat-sdk/goat/tree/main/typescript#wallets) | ||
- [Adapters](https://github.com/goat-sdk/goat/tree/main/typescript#agent-framework-adapters) | ||
- [🐍 Python](https://github.com/goat-sdk/goat/tree/main/python) | ||
- [See all plugins](https://github.com/goat-sdk/goat/tree/main/python#plugins) | ||
- [Installation](https://github.com/goat-sdk/goat/tree/main/python#installation) | ||
- [Usage](https://github.com/goat-sdk/goat/tree/main/python#usage) | ||
- [Examples](https://github.com/goat-sdk/goat/tree/main/python/examples) | ||
- [How to create a plugin](https://github.com/goat-sdk/goat/tree/main/python#how-to-create-a-plugin) | ||
- [How to add a chain](https://github.com/goat-sdk/goat/tree/main/python#how-to-add-a-chain) | ||
- [How to add a wallet provider](https://github.com/goat-sdk/goat/tree/main/python#how-to-add-a-wallet-provider) | ||
- [Packages](https://github.com/goat-sdk/goat/tree/main/python#packages) | ||
- [Plugins](https://github.com/goat-sdk/goat/tree/main/python#plugins) | ||
- [Wallets](https://github.com/goat-sdk/goat/tree/main/python#wallets) | ||
- [Adapters](https://github.com/goat-sdk/goat/tree/main/python#agent-framework-adapters) |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.