@coinbase/cdp-agentkit-core - npm Package Compare versions

Comparing version 0.0.6 to 0.0.7

dist/actions/cdp/defi/wow/actions/buy_token.js

@@ -10,3 +10,18 @@ "use strict";
 const WOW_BUY_TOKEN_PROMPT = `
-This tool will buy a Zora Wow ERC20 memecoin with ETH. This tool takes the WOW token contract address, the address to receive the tokens, and the amount of ETH to spend (in wei, meaning "1" is 1 wei or 0.000000000000000001 of ETH). The amount is a string and cannot have any decimal points, since the unit of measurement is wei. Make sure to use the exact amount provided, and if there's any doubt, check by getting more information before continuing with the action. The minimum to buy is 100000000000000 wei which is 0.0000001 ether. It is only supported on Base Sepolia and Base Mainnet.
+This tool can only be used to buy a Zora Wow ERC20 memecoin (also can be referred to as a bonding curve token) with ETH.
+Do not use this tool for any other purpose, or trading other assets.
+
+Inputs:
+- WOW token contract address
+- Address to receive the tokens  
+- Amount of ETH to spend (in wei)
+
+Important notes:
+- The amount is a string and cannot have any decimal points, since the unit of measurement is wei.
+- Make sure to use the exact amount provided, and if there's any doubt, check by getting more information before continuing with the action. 
+- 1 wei = 0.000000000000000001 ETH
+- Minimum purchase amount is 100000000000000 wei (0.0000001 ETH)
+- Only supported on the following networks:
+  - Base Sepolia (ie, 'base-sepolia')
+  - Base Mainnet (ie, 'base', 'base-mainnnet')
 `;
@@ -13,0 +28,0 @@ /**

dist/actions/cdp/defi/wow/actions/create_token.js

@@ -8,3 +8,15 @@ "use strict";
 const WOW_CREATE_TOKEN_PROMPT = `
-This tool will create a Zora Wow ERC20 memecoin using the WoW factory. This tool takes the token name, token symbol, and optionally a token URI containing metadata about the token. It uses a bonding curve so there is no need to add liquidity to the pool upfront. It is only supported on Base Sepolia and Base Mainnet.
+This tool can only be used to create a Zora Wow ERC20 memecoin (also can be referred to as a bonding curve token) using the WoW factory.
+Do not use this tool for any other purpose, or for creating other types of tokens.
+
+Inputs:
+- Token name (e.g. WowCoin)
+- Token symbol (e.g. WOW) 
+- Token URI (optional) - Contains metadata about the token
+
+Important notes:
+- Uses a bonding curve - no upfront liquidity needed
+- Only supported on the following networks:
+  - Base Sepolia (ie, 'base-sepolia')
+  - Base Mainnet (ie, 'base', 'base-mainnnet')
 `;
@@ -11,0 +23,0 @@ /**

dist/actions/cdp/defi/wow/actions/sell_token.js

@@ -10,3 +10,17 @@ "use strict";
 const WOW_SELL_TOKEN_PROMPT = `
-This tool will sell a Zora Wow ERC20 memecoin for ETH. This tool takes the WOW token contract address, and the amount of tokens to sell (in wei, meaning 1 is 1 wei or 0.000000000000000001 of the token). The minimum to sell is 100000000000000 wei which is 0.0000001 ether. The amount is a string and cannot have any decimal points, since the unit of measurement is wei. Make sure to use the exact amount provided, and if there's any doubt, check by getting more information before continuing with the action. It is only supported on Base Sepolia and Base Mainnet.
+This tool can only be used to sell a Zora Wow ERC20 memecoin (also can be referred to as a bonding curve token) for ETH.
+Do not use this tool for any other purpose, or trading other assets.
+
+Inputs:
+- WOW token contract address
+- Amount of tokens to sell (in wei)
+
+Important notes:
+- The amount is a string and cannot have any decimal points, since the unit of measurement is wei.
+- Make sure to use the exact amount provided, and if there's any doubt, check by getting more information before continuing with the action. 
+- 1 wei = 0.000000000000000001 ETH
+- Minimum purchase amount is 100000000000000 wei (0.0000001 ETH)
+- Only supported on the following networks:
+  - Base Sepolia (ie, 'base-sepolia')
+  - Base Mainnet (ie, 'base', 'base-mainnnet')
 `;
@@ -13,0 +27,0 @@ /**

dist/actions/cdp/deploy_nft.js

@@ -7,3 +7,5 @@ "use strict";
 const DEPLOY_NFT_PROMPT = `
-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.`;
+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.
+`;
 /**
@@ -10,0 +12,0 @@ * Input schema for deploy NFT action.

dist/actions/cdp/deploy_token.js

@@ -7,3 +7,5 @@ "use strict";
 const DEPLOY_TOKEN_PROMPT = `
-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.`;
+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.
+`;
 /**
@@ -10,0 +12,0 @@ * Input schema for deploy token action.

dist/actions/cdp/get_balance.js

@@ -7,3 +7,5 @@ "use strict";
 const GET_BALANCE_PROMPT = `
-This tool will get the balance of all the addresses in the wallet for a given asset. It takes the asset ID as input. Always use 'eth' for the native asset ETH and 'usdc' for USDC.`;
+This tool will get the balance of all the addresses in the wallet for a given asset. 
+It takes the asset ID as input. Always use 'eth' for the native asset ETH and 'usdc' for USDC.
+`;
 /**
@@ -10,0 +12,0 @@ * Input schema for get balance action.

dist/actions/cdp/mint_nft.js

@@ -7,3 +7,6 @@ "use strict";
 const 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. Do not use the contract address as the destination address. If you are unsure of the destination address, please ask the user before proceeding.`;
+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. 
+Do not use the contract address as the destination address. If you are unsure of the destination address, please ask the user before proceeding.
+`;
 /**
@@ -10,0 +13,0 @@ * Input schema for mint NFT action.

dist/actions/cdp/register_basename.js

@@ -11,5 +11,6 @@ "use strict";
 This tool will register a Basename for the agent. The agent should have a wallet associated to register a Basename.
-When your network ID is 'base-mainnet', the name must end with .base.eth and when your network ID is 'base-sepolia', it must ends with .basetest.eth.
+When your network ID is 'base-mainnet' (also sometimes known simply as 'base'), the name must end with .base.eth, and when your network ID is 'base-sepolia', it must ends with .basetest.eth.
 Do not suggest any alternatives and never try to register a Basename with another postfix. The prefix of the name must be unique so if the registration of the
-Basename fails, you should prompt to try again with a more unique name.`;
+Basename fails, you should prompt to try again with a more unique name.
+`;
 // Contract addresses
@@ -16,0 +17,0 @@ exports.BASENAMES_REGISTRAR_CONTROLLER_ADDRESS_MAINNET = "0x4cCb0BB02FCABA27e82a56646E81d8c5bC4119a5";

dist/actions/cdp/request_faucet_funds.js

@@ -10,3 +10,4 @@ "use strict";
 You are not allowed to faucet with any other network or asset ID. If you are on another network, suggest that the user sends you some ETH
-from another wallet and provide the user with your wallet details.`;
+from another wallet and provide the user with your wallet details.
+`;
 /**
@@ -13,0 +14,0 @@ * Input schema for request faucet funds action.

dist/actions/cdp/trade.js

@@ -7,3 +7,14 @@ "use strict";
 const TRADE_PROMPT = `
-This tool will trade a specified amount of a from asset to a to asset for the wallet. It takes the the amount of the from asset to trade, the from asset ID to trade, and the to asset ID to receive from the trade as inputs. Trades are only supported on Mainnets (e.g. 'base-mainnet', 'ethereum-mainnet'). Never allow trades on any other network.`;
+This tool will trade a specified amount of a 'from asset' to a 'to asset' for the wallet.
+
+It takes the following inputs:
+- The amount of the 'from asset' to trade
+- The from asset ID to trade 
+- The asset ID to receive from the trade
+
+Important notes:
+- Trades are only supported on mainnet networks (ie, 'base-mainnet', 'base', 'ethereum-mainnet', 'ethereum', etc.)
+- Never allow trades on any non-mainnet network (ie, 'base-sepolia', 'ethereum-sepolia', etc.)
+- When selling a native asset (e.g. 'eth' on base-mainnet), ensure there is sufficient balance to pay for the trade AND the gas cost of this trade
+`;
 /**
@@ -10,0 +21,0 @@ * Input schema for trade action.

dist/actions/cdp/transfer.js

@@ -7,3 +7,17 @@ "use strict";
 const TRANSFER_PROMPT = `
-This tool will transfer an asset from the wallet to another onchain address. It takes the amount, the asset ID to transfer, the destination to send the funds (either an onchain address, an ENS 'example.eth', or Basename 'example.base.eth'), and whether to do a gasless transfer as inputs. The gasless option is available on 'base-sepolia' and 'base-mainnet' networks for 'usdc' asset only. Always use the gasless option when it is available. Always use the asset ID 'usdc' when attempting to transfer USDC. Always ensure that you have enough balance of the input asset ID to complete the transfer.`;
+This tool will transfer an asset from the wallet to another onchain address.
+
+It takes the following inputs:
+- amount: The amount to transfer
+- assetId: The asset ID to transfer
+- destination: Where to send the funds (can be an onchain address, ENS 'example.eth', or Basename 'example.base.eth')
+- gasless: Whether to do a gasless transfer
+
+Important notes:
+- Gasless transfers are only available on base-sepolia and base-mainnet (base) networks for 'usdc' asset
+- Always use gasless transfers when available
+- Always use asset ID 'usdc' when transferring USDC
+- Ensure sufficient balance of the input asset before transferring
+- When sending native assets (e.g. 'eth' on base-mainnet), ensure there is sufficient balance for the transfer itself AND the gas cost of this transfer
+`;
 /**
@@ -10,0 +24,0 @@ * Input schema for transfer action.

dist/index.js

@@ -22,4 +22,4 @@ "use strict";
 __exportStar(require("./actions/cdp/defi/wow"), exports);
-// Export CDP Agentkit
+// Export CDP AgentKit
 var cdp_agentkit_1 = require("./cdp_agentkit");
 Object.defineProperty(exports, "CdpAgentkit", { enumerable: true, get: function () { return cdp_agentkit_1.CdpAgentkit; } });

package.json

@@ -5,3 +5,5 @@ {
   "repository": "https://github.com/coinbase/cdp-agentkit-nodejs",
-  "version": "0.0.6",
+  "version": "0.0.7",
+  "author": "Coinbase Inc.",
+  "license": "Apache-2.0",
   "main": "dist/index.js",
@@ -8,0 +10,0 @@ "types": "dist/index.d.ts",

README.md

@@ -1,4 +0,4 @@
-# Agentkit Core
+# AgentKit Core
 
-Framework agnostic primitives that are meant to be composable and used via Agentkit framework extensions.
+Framework agnostic primitives that are meant to be composable and used via AgentKit framework extensions.
 
@@ -10,1 +10,15 @@ You can find all of the supported actions under `./cdp_agentkit_core/actions`
 See [CONTRIBUTING.md](../CONTRIBUTING.md) for more information.
+
+## Security and bug reports
+
+The CDP AgentKit team takes security seriously.
+See [SECURITY.md](../SECURITY.md) for more information.
+
+## Documentation
+
+- [CDP AgentKit Documentation](https://docs.cdp.coinbase.com/agentkit/docs/welcome)
+- [API Reference: CDP AgentKit Core](https://coinbase.github.io/cdp-agentkit-nodejs/cdp-agentkit-core/index.html)
+
+## License
+
+Apache-2.0

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

Found 1 instance in 1 package

No License Found

License

(Experimental) License information could not be found.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

115746

increased by1.35%

Number of low license alerts

0

decreased by-100%

Lines of code

3090

increased by2.01%

Number of low maintenance alerts

1

decreased by-50%

Number of lines in readme file

24

increased by140%

No dependency changes