Skip to content

docs: align CDP config examples with actual API in typescript/agentkit README #1270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
memosr wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: align CDP config examples with actual API in typescript/agentkit README #1270

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions typescript/agentkit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,10 @@ npm install @coinbase/agentkit

## Usage

### Create an AgentKit instance. If no wallet or action providers are specified, the agent will use the `CdpWalletProvider` and `WalletProvider` action provider.
### Create an AgentKit instance. If no wallet or action providers are specified, the agent will use the `CdpSmartWalletProvider` and `WalletActionProvider` action provider.

```typescript
// When using the AgentKit.from() shortcut:
const agentKit = await AgentKit.from({
cdpApiKeyId: "CDP API KEY NAME",
cdpApiKeySecret: "CDP API KEY SECRET",
Expand All @@ -92,7 +93,7 @@ const agentKit = await AgentKit.from({

### Create an AgentKit instance

If no wallet or action provider are specified, the agent will use the `CdpWalletProvider` and `WalletActionProvider` action provider by default.
If no wallet or action provider are specified, the agent will use the `CdpSmartWalletProvider` and `WalletActionProvider` action provider by default.

```typescript
const agentKit = await AgentKit.from({
Expand All @@ -106,9 +107,10 @@ const agentKit = await AgentKit.from({
```typescript
import { CdpWalletProvider } from "@coinbase/agentkit";

// When constructing a wallet provider manually:
const walletProvider = await CdpWalletProvider.configureWithWallet({
apiKeyId: "CDP API KEY NAME",
apiKeyPrivate: "CDP API KEY SECRET",
apiKeySecret: "CDP API KEY SECRET",
networkId: "base-mainnet",
});

Expand All @@ -127,7 +129,7 @@ const agentKit = await AgentKit.from({
actionProviders: [
cdpApiActionProvider({
apiKeyId: "CDP API KEY NAME",
apiKeyPrivate: "CDP API KEY SECRET",
apiKeySecret: "CDP API KEY SECRET",
}),
pythActionProvider(),
],
Expand Down Expand Up @@ -1355,7 +1357,7 @@ import { ZeroDevWalletProvider, CdpWalletProvider } from "@coinbase/agentkit";
// First create a CDP wallet provider as the signer
const cdpWalletProvider = await CdpWalletProvider.configureWithWallet({
apiKeyId: "CDP API KEY NAME",
apiKeyPrivate: "CDP API KEY SECRET",
apiKeySecret: "CDP API KEY SECRET",
networkId: "base-mainnet",
});

Expand Down
Loading