Skip to content

Latest commit

 

History

History
150 lines (123 loc) · 5.5 KB

CONTRIBUTING.md

File metadata and controls

150 lines (123 loc) · 5.5 KB
Raw

CDP Agentkit Contributing Guide

Thank you for your interest in contributing to CDP Agentkit! We welcome all contributions, no matter how big or small. Some of the ways you can contribute include:

  • Adding new actions to the core package
  • Updating existing Langchain Toolkits or adding new Langchain Toolkits to support new tools
  • Creating new AI frameworks extensions
  • Adding tests and improving documentation

Development

Prerequisites

cdp-langchain also requires a CDP API Key.

Set-up

Clone the repo by running:

git clone [email protected]:coinbase/cdp-agentkit.git

Adding an Action to Agentkit Core

  • Actions are defined in ./cdp_agentkit_core/actions module. See ./cdp_agentkit_core/actions/mint_nft.py for an example.
  • Actions are created by subclassing CdpAction E.g.
class DeployNftAction(CdpAction):
    """Deploy NFT action."""

    name: str = "mint_nft"
    description: str = MINT_NFT_PROMPT
    args_schema: type[BaseModel] | None = MintNftInput
    func: Callable[..., str] = mint_nft

Components of an Agentic Action

  • name - Name of the action.
  • description - A string that will provide the AI Agent with context on what the function does and a natural language description of the input.
    • E.g.
MINT_NFT_PROMPT = """
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."""
  • arg_schema - A Pydantic Model that defines the input argument schema for the action.
    • E.g.
class MintNftInput(BaseModel):
    """Input argument schema for mint NFT action."""

    contract_address: str = Field(
        ...,
        description="The contract address of the NFT (ERC-721) to mint, e.g. `0x036CbD53842c5426634e7929541eC2318f3dCF7e`",
    )
    destination: str = Field(
        ...,
        description="The destination address that will receieve the NFT onchain, e.g. `0x036CbD53842c5426634e7929541eC2318f3dCF7e`",
    )
  • func - A function (or Callable class) that executes the action.
    • E.g.
def mint_nft(wallet: Wallet, contract_address: str, destination: str) -> str:
    """Mint an NFT (ERC-721) to a specified destination address onchain via a contract invocation.

    Args:
        wallet (Wallet): The wallet to trade the asset from.
        contract_address (str): The contract address of the NFT (ERC-721) to mint, e.g. `0x036CbD53842c5426634e7929541eC2318f3dCF7e`.
        destination (str): The destination address that will receieve the NFT onchain, e.g. `0x036CbD53842c5426634e7929541eC2318f3dCF7e`.

    Returns:
        str: A message containing the NFT mint details.

    """
    mint_args = {"to": destination, "quantity": "1"}

    mint_invocation = wallet.invoke_contract(
        contract_address=contract_address, method="mint", args=mint_args
    ).wait()

    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}"

Adding an Agentic Action to Langchain Toolkit

  1. Ensure the action is implemented in cdp-agentkit-core and in a released version.
  2. Update the cdp-agentkit-core dependency to the latest version.
  3. Add the action to the list of tools in the CdpToolkit class documentation.

Adding an Agentic Action to the Twitter Toolkit

  1. Ensure the action is implemented in cdp-agentkit-core/actions/social/twitter.
  2. Add a wrapper method to TwitterApiWrapper in ./twitter_langchain/twitter_api_wrapper.py
    • E.g.
    def post_tweet_wrapper(self, tweet: str) -> str:
        """Post tweet to Twitter.

        Args:
            client (tweepy.Client): The tweepy client to use.
            tweet (str): The text of the tweet to post to twitter. Tweets can be maximum 280 characters.

        Returns:
            str: A message containing the result of the post action and the tweet.

        """

        return post_tweet(client=self.client, tweet=tweet)
  1. Add call to the wrapper in TwitterApiWrapper.run in ./twitter_langchain/twitter_api_wrapper.py
    • E.g.
        if mode == "post_tweet":
            return self.post_tweet_wrapper(**kwargs)
  1. Add the action to the list of available tools in the TwitterToolkit in ./twitter_langchain/twitter_toolkit.py
    • E.g.
        actions: List[Dict] = [
            {
                "mode": "post_tweet",
                "name": "post_tweet",
                "description": POST_TWEET_PROMPT,
                "args_schema": PostTweetInput,
            },
        ]
  1. Update TwitterToolkit documentation
    • Add the action to the list of tools
    • Add any additional ENV requirements

Development Tools

Formatting

make format

Linting

  • Check linter make lint

  • Fix linter errors make lint-fix

Unit Testing

  • Run unit tests make test

Changelog

  • For new features and bug fixes, please add a new changelog entry to the CHANGELOG.md file in the appropriate packages and include that in your Pull Request.