Skip to content

Commit c9524a7

Browse files
John-peterson-coinbaseJohn-peterson-coinbase
committed
cdp-agentkit-core + cdp-langchain
1 parent f67ec4d commit c9524a7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+8830
-0
lines changed

‎.gitignore

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
**/.DS_Store
2+
3+
**/.python-version
4+
5+
# IDE
6+
.idea/*
7+
8+
## Emacs
9+
*~
10+
\#*\#
11+
.\#*
12+
**/.projectile
13+
14+
# Python cache files
15+
**/__pycache__/
16+
17+
# Wallet data
18+
**/wallet_data.txt
19+
20+
# Tools
21+
**/.pytest_cache
22+
23+
**/.ruff_cache
24+
25+
**/.mypy_cache
26+
27+
**/.coverage
28+
29+
# Build
30+
**/_build/
31+
32+
**/build/
33+
34+
**/dist/
35+
36+
# Virtual Environments
37+
**/venv/
38+
**/.venv/
39+
40+
# Environment Configurations
41+
**/env/
42+
**/.env/
43+
**/.env.local/
44+
**/.env.test/

‎CONTRIBUTING.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# CDP Agentkit Contributing Guide
2+
3+
## Development
4+
5+
### Python Version
6+
7+
Developing in this repository requires Python 3.10 or higher.
8+
9+
### Set-up
10+
11+
Clone the repo by running:
12+
13+
```bash
14+
git clone [email protected]:coinbase/cdp-agentkit.git
15+
```

‎LICENSE.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Apache-2.0 License
2+
3+
Copyright 2024 Coinbase
4+
5+
Licensed under the Apache License, Version 2.0 (the "License");
6+
you may not use this file except in compliance with the License.
7+
You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.

‎README.md

+40
Original file line numberDiff line numberDiff line change
@@ -1 +1,41 @@
11
# CDP Agentkit
2+
3+
[![Release Notes](https://img.shields.io/github/release/coinbase/?style=flat-square)](https://github.com/coinbase/cdp-agentkit/releases)
4+
[![PyPI - Downloads](https://img.shields.io/pypi/dm/cdp-agentkitcore?style=flat-square)](https://pypistats.org/packages/cdp-agentkit-core)
5+
[![GitHub star chart](https://img.shields.io/github/stars/coinbase/cdp-agentkit?style=flat-square)](https://star-history.com/#coinbase/cdp-agentkit)
6+
[![Open Issues](https://img.shields.io/github/issues-raw/coinbase/cdp-agentkit?style=flat-square)](https://github.com/coinbase/cdp-agentkit/issues)
7+
8+
The Coinbase Developer Platform (CDP) Agentkit simplifies bringing your AI Agents onchain!
9+
10+
Agentkit is powered by the [CDP SDK](https://github.com/coinbase/cdp-sdk-python)
11+
12+
Every AI Agent deserves a Wallet!
13+
14+
## Examples
15+
Check out `cdp-langchain/examples` for inspiration and help getting started! Learn more about each one in its README.
16+
17+
- [Chatbot](./cdp-langchain/examples/chatbot/README.md): Simple example of a Chatbot that can perform complex onchain interactions.
18+
19+
## Repository Structure
20+
CDP Agentkit is organized as a [monorepo](https://en.wikipedia.org/wiki/Monorepo) that contains multiple packages.
21+
22+
### cdp-agentkit-core
23+
Core primitives and framework agnostic tools that are meant to be composable and used via CDP Agentkit framework extensions.
24+
See [CDP Agentkit Core](./cdp-agentkit-core/README.md) to get started!
25+
26+
### CDP Agentkit Extensions
27+
CDP Agentkit integrations with popular AI frameworks.
28+
29+
#### cdp-langchain
30+
Langchain Toolkit extension of CDP Agentkit.
31+
See [CDP Langchain](./cdp-langchain/README.md) to get started!
32+
33+
## Contributing
34+
CDP Agentkit welcomes community contributions.
35+
See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
36+
37+
## Contributors
38+
<a href="https://github.com/coinbase/cdp-agentkit/graphs/contributors">
39+
<img src="https://contrib.rocks/image?repo=coinbase/cdp-agentkit" />
40+
</a>
41+

‎SECURITY.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Security Policy
2+
3+
The Coinbase team takes security seriously. Please do not file a public ticket discussing a potential vulnerability.
4+
5+
Please report your findings through our [HackerOne][1] program.
6+
7+
[1]: https://hackerone.com/coinbase

‎cdp-agentkit-core/Makefile

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.PHONY: format
2+
format:
3+
ruff format .
4+
5+
.PHONY: lint
6+
lint:
7+
ruff check .
8+
9+
.PHONY: lint-fix
10+
lint-fix:
11+
ruff check . --fix
12+
13+
.PHONY: test
14+
test:
15+
pytest

‎cdp-agentkit-core/README.md

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Agentkit Core
2+
Core primitives and framework agnostic tools that are meant to be composable and used via Agentkit framework extensions.
3+
4+
## Developing
5+
- Agentkit uses `poetry` for package management and tooling
6+
- [Poetry Installation Instructions](https://python-poetry.org/docs/#installation)
7+
- Run `poetry install` to install `cdp-agentkit-core` dependencies
8+
- Run `poetry shell` to activate the virtual environment
9+
10+
### Formatting
11+
`make format`
12+
13+
### Linting
14+
- Check linter
15+
`make lint`
16+
17+
- Fix linter errors
18+
`make lint-fix`
19+
20+
### Unit Testing
21+
- Run unit tests
22+
`make test`
23+
24+
## Contributing Agentic Actions
25+
- Actions are defined in `./cdp_agentkit_core/actions` module. See `./cdp_agentkit_core/actions/mint_nft.py` for an example.
26+
27+
### Components of an Agentic Action
28+
Each action will define and export 3 components:
29+
- Prompt - A string that will provide the AI Agent with context on what the function does and a natural language description of the input.
30+
- E.g.
31+
```python
32+
MINT_NFT_PROMPT = """
33+
This tool will mint an NFT (ERC-721) to a specified destination address onchain via a contract invocation. It takes the contract address of the NFT onchain and the destination address onchain that will receive the NFT as inputs."""
34+
```
35+
- ArgSchema - A Pydantic Model that defines the input argument schema for the action.
36+
- E.g.
37+
```python
38+
class MintNftInput(BaseModel):
39+
"""Input argument schema for mint NFT action."""
40+
41+
contract_address: str = Field(
42+
...,
43+
description="The contract address of the NFT (ERC-721) to mint, e.g. `0x036CbD53842c5426634e7929541eC2318f3dCF7e`",
44+
)
45+
destination: str = Field(
46+
...,
47+
description="The destination address that will receieve the NFT onchain, e.g. `0x036CbD53842c5426634e7929541eC2318f3dCF7e`",
48+
)
49+
```
50+
- Action Callable - A function (or Callable class) that executes the action.
51+
- E.g.
52+
```python
53+
def mint_nft(wallet: Wallet, contract_address: str, destination: str) -> str:
54+
"""Mint an NFT (ERC-721) to a specified destination address onchain via a contract invocation.
55+
56+
Args:
57+
wallet (Wallet): The wallet to trade the asset from.
58+
contract_address (str): The contract address of the NFT (ERC-721) to mint, e.g. `0x036CbD53842c5426634e7929541eC2318f3dCF7e`.
59+
destination (str): The destination address that will receieve the NFT onchain, e.g. `0x036CbD53842c5426634e7929541eC2318f3dCF7e`.
60+
61+
Returns:
62+
str: A message containing the NFT mint details.
63+
64+
"""
65+
mint_args = {"to": destination, "quantity": "1"}
66+
67+
mint_invocation = wallet.invoke_contract(
68+
contract_address=contract_address, method="mint", args=mint_args
69+
).wait()
70+
71+
return f"Minted NFT from contract {contract_address} to address {destination} on network {wallet.network_id}.\nTransaction hash for the mint: {mint_invocation.transaction.transaction_hash}\nTransaction link for the mint: {mint_invocation.transaction.transaction_link}"
72+
```

‎cdp-agentkit-core/cdp_agentkit_core/__init__.py

Whitespace-only changes.

‎cdp-agentkit-core/cdp_agentkit_core/actions/__init__.py

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
from cdp_agentkit_core.actions.deploy_nft import (
2+
DEPLOY_NFT_PROMPT,
3+
DeployNftInput,
4+
deploy_nft,
5+
)
6+
from cdp_agentkit_core.actions.deploy_token import (
7+
DEPLOY_TOKEN_PROMPT,
8+
DeployTokenInput,
9+
deploy_token,
10+
)
11+
from cdp_agentkit_core.actions.get_balance import (
12+
GET_BALANCE_PROMPT,
13+
GetBalanceInput,
14+
get_balance,
15+
)
16+
from cdp_agentkit_core.actions.get_wallet_details import (
17+
GET_WALLET_DETAILS_PROMPT,
18+
GetWalletDetailsInput,
19+
get_wallet_details,
20+
)
21+
from cdp_agentkit_core.actions.mint_nft import (
22+
MINT_NFT_PROMPT,
23+
MintNftInput,
24+
mint_nft,
25+
)
26+
from cdp_agentkit_core.actions.register_basename import (
27+
REGISTER_BASENAME_PROMPT,
28+
RegisterBasenameInput,
29+
register_basename,
30+
)
31+
from cdp_agentkit_core.actions.request_faucet_funds import (
32+
REQUEST_FAUCET_FUNDS_PROMPT,
33+
RequestFaucetFundsInput,
34+
request_faucet_funds,
35+
)
36+
from cdp_agentkit_core.actions.trade import (
37+
TRADE_PROMPT,
38+
TradeInput,
39+
trade,
40+
)
41+
from cdp_agentkit_core.actions.transfer import (
42+
TRANSFER_PROMPT,
43+
TransferInput,
44+
transfer,
45+
)
46+
47+
__all__ = [
48+
"DEPLOY_NFT_PROMPT",
49+
"DeployNftInput",
50+
"deploy_nft",
51+
"DEPLOY_TOKEN_PROMPT",
52+
"DeployTokenInput",
53+
"deploy_token",
54+
"GET_BALANCE_PROMPT",
55+
"GetBalanceInput",
56+
"get_balance",
57+
"GET_WALLET_DETAILS_PROMPT",
58+
"GetWalletDetailsInput",
59+
"get_wallet_details",
60+
"MINT_NFT_PROMPT",
61+
"MintNftInput",
62+
"mint_nft",
63+
"REGISTER_BASENAME_PROMPT",
64+
"RegisterBasenameInput",
65+
"register_basename",
66+
"REQUEST_FAUCET_FUNDS_PROMPT",
67+
"RequestFaucetFundsInput",
68+
"request_faucet_funds",
69+
"TRADE_PROMPT",
70+
"TradeInput",
71+
"trade",
72+
"TRANSFER_PROMPT",
73+
"TransferInput",
74+
"transfer",
75+
]

‎cdp-agentkit-core/cdp_agentkit_core/actions/deploy_nft.py

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
from cdp import Wallet
2+
from pydantic import BaseModel, Field
3+
4+
DEPLOY_NFT_PROMPT = """
5+
This tool will deploy an NFT (ERC-721) contract onchain from the wallet. It takes the name of the NFT collection, the symbol of the NFT collection, and the base URI for the token metadata as inputs."""
6+
7+
8+
class DeployNftInput(BaseModel):
9+
"""Input argument schema for deploy NFT action."""
10+
11+
name: str = Field(
12+
...,
13+
description="The name of the NFT (ERC-721) token collection to deploy, e.g. `Helpful Hippos`",
14+
)
15+
symbol: str = Field(
16+
...,
17+
description="The symbol of the NFT (ERC-721) token collection to deploy, e.g. `HIPPO`",
18+
)
19+
base_uri: str = Field(
20+
...,
21+
description="The base URI for the NFT (ERC-721) token collection's metadata, e.g. `https://www.helpfulhippos.xyz/metadata/`",
22+
)
23+
24+
25+
def deploy_nft(wallet: Wallet, name: str, symbol: str, base_uri: str) -> str:
26+
"""Deploy an NFT (ERC-721) token collection onchain from the wallet.
27+
28+
Args:
29+
wallet (Wallet): The wallet to deploy the NFT from.
30+
name (str): The name of the NFT (ERC-721) token collection to deploy, e.g. `Helpful Hippos`.
31+
symbol (str): The symbol of the NFT (ERC-721) token collection to deploy, e.g. `HIPPO`.
32+
base_uri (str): The base URI for the NFT (ERC-721) token collection's metadata, e.g. `https://www.helpfulhippos.xyz/metadata/`.
33+
34+
Returns:
35+
str: A message containing the NFT token deployment details.
36+
37+
"""
38+
nft_contract = wallet.deploy_nft(name=name, symbol=symbol, base_uri=base_uri).wait()
39+
40+
return f"Deployed NFT Collection {name} to address {nft_contract.contract_address} on network {wallet.network_id}.\nTransaction hash for the deployment: {nft_contract.transaction.transaction_hash}\nTransaction link for the deployment: {nft_contract.transaction.transaction_link}"

‎cdp-agentkit-core/cdp_agentkit_core/actions/deploy_token.py

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
from cdp import Wallet
2+
from pydantic import BaseModel, Field
3+
4+
DEPLOY_TOKEN_PROMPT = """
5+
This tool will deploy an ERC20 token smart contract. It takes the token name, symbol, and total supply as input. The token will be deployed using the wallet's default address as the owner and initial token holder.
6+
"""
7+
8+
9+
class DeployTokenInput(BaseModel):
10+
"""Input argument schema for deploy token action."""
11+
12+
name: str = Field(..., description='The name of the token (e.g., "My Token")')
13+
symbol: str = Field(..., description='The token symbol (e.g., "USDC", "MEME", "SYM")')
14+
total_supply: str = Field(
15+
..., description='The total supply of tokens to mint (e.g., "1000000")'
16+
)
17+
18+
19+
def deploy_token(wallet: Wallet, name: str, symbol: str, total_supply: str) -> str:
20+
"""Deploy an ERC20 token smart contract.
21+
22+
Args:
23+
wallet (wallet): The wallet to deploy the Token from.
24+
name (str): The name of the token (e.g., "My Token")
25+
symbol (str): The token symbol (e.g., "USDC", "MEME", "SYM")
26+
total_supply (str): The total supply of tokens to mint (e.g., "1000000")
27+
28+
Returns:
29+
str: A message containing the deployed token contract address and details
30+
31+
"""
32+
token_contract = wallet.deploy_token(name=name, symbol=symbol, total_supply=total_supply)
33+
34+
token_contract.wait()
35+
36+
return f"Deployed ERC20 token contract {name} ({symbol}) with total supply of {total_supply} tokens at address {token_contract.contract_address}. Transaction link: {token_contract.transaction.transaction_link}"

0 commit comments

Comments
 (0)