Skip to content

Commit

Permalink
Merge remote-tracking branch 'refs/remotes/origin/main'
Browse files Browse the repository at this point in the history
  • Loading branch information
karimodm committed Jan 31, 2025
2 parents 0e02092 + e02ad95 commit eef48c5
Show file tree
Hide file tree
Showing 309 changed files with 24,230 additions and 1,820 deletions.
123 changes: 43 additions & 80 deletions README.md
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).
![NPM Downloads](https://img.shields.io/npm/dm/%40goat-sdk%2Fcore)
![GitHub License](https://img.shields.io/github/license/goat-sdk/goat)

![goat](https://github.com/user-attachments/assets/f6aa46ce-5684-4136-be29-7867acab3f27)
![Static Badge](https://img.shields.io/badge/v20.12.2-1?label=typescript&color=blue)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/goat-sdk)

### 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 🐐
![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/goat-sdk)


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)
94 changes: 0 additions & 94 deletions docs/chains-wallets-plugins.mdx

This file was deleted.

93 changes: 0 additions & 93 deletions docs/chains.mdx

This file was deleted.

15 changes: 0 additions & 15 deletions docs/examples.mdx

This file was deleted.

Loading

0 comments on commit eef48c5

Please sign in to comment.