-
Notifications
You must be signed in to change notification settings - Fork 39
Add agent configuration guide #451
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.
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
Draft
neekolas
wants to merge
1
commit into
main
Choose a base branch
from
10-22-add_agent_configuration_guide
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,63 @@ | ||||||||||||||||||
| # Configure your agent | ||||||||||||||||||
|
|
||||||||||||||||||
| Your agent needs to pay for the messages it sends on the XMTP network. To get started, you'll need. | ||||||||||||||||||
|
|
||||||||||||||||||
| 1. An agent built using our Node or Agent SDK | ||||||||||||||||||
| 2. A payer wallet that has been [funded through the XMTP Funding Portal](./fund-your-app.mdx) | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Setup your Signer | ||||||||||||||||||
|
|
||||||||||||||||||
| When you create a client, you already specify a `Signer` that is used to link your XMTP identity to a wallet. You can choose to use the same `Signer` to pay for messages, or create a new one purely for this purpose. | ||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||
|
|
||||||||||||||||||
| This Signer must be of type `eoa`. The `messagePayer` may not be a smart contract wallet, since the signatures need to be able to be verified offchain. | ||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||
|
|
||||||||||||||||||
| :::code-group | ||||||||||||||||||
|
|
||||||||||||||||||
| ```js [Agent] | ||||||||||||||||||
| import { Agent } from '@xmtp/agent-sdk'; | ||||||||||||||||||
| import { createSigner, createUser } from '@xmtp/agent-sdk/user'; | ||||||||||||||||||
| import { getRandomValues } from 'node:crypto'; | ||||||||||||||||||
|
|
||||||||||||||||||
| // Option 1: Create a local user + signer | ||||||||||||||||||
| const user = createUser('0xprivateKey'); | ||||||||||||||||||
| const xmtpChainRPCUrl = 'https://xmtp-testnet.my-rpc-provider.com/1234' | ||||||||||||||||||
| const baseRPCUrl = 'https://base-sepolia.my-rpc-provider.com/1234' | ||||||||||||||||||
| const signer = createSigner(user); | ||||||||||||||||||
|
|
||||||||||||||||||
| const agent = await Agent.create(signer, { | ||||||||||||||||||
| env: 'testnet', // or 'production' | ||||||||||||||||||
| dbEncryptionKey: getRandomValues(new Uint8Array(32)), // save it for later | ||||||||||||||||||
| rpcUrls: { | ||||||||||||||||||
| xmtp: xmtpChainRPCUrl, | ||||||||||||||||||
| base: baseRPCUrl, | ||||||||||||||||||
| }, | ||||||||||||||||||
| messagePayer: signer, // use the same signer to pay for messages or use a different wallet | ||||||||||||||||||
| }); | ||||||||||||||||||
| ``` | ||||||||||||||||||
| ::: | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Specify a RPC URL | ||||||||||||||||||
|
|
||||||||||||||||||
| In order to connect to the XMTP Chain, your client needs to set a blockchain RPC URL to a provider that supports XMTP, as well as a RPC URL for Base (or Base Sepolia for testnet). | ||||||||||||||||||
|
|
||||||||||||||||||
| For example, you can use [Alchemy](https://alchemy.com/) and create an app with XMTP and Base enabled. | ||||||||||||||||||
|
|
||||||||||||||||||
| :::code-group | ||||||||||||||||||
| ```js [Agent] | ||||||||||||||||||
| import { Agent } from '@xmtp/agent-sdk'; | ||||||||||||||||||
|
|
||||||||||||||||||
| const user = createUser('0xprivateKey'); | ||||||||||||||||||
| const xmtpChainRPCUrl = 'https://xmtp-testnet.my-rpc-provider.com/1234' | ||||||||||||||||||
| const baseRPCUrl = 'https://base-sepolia.my-rpc-provider.com/1234' | ||||||||||||||||||
| const signer = createSigner(user); | ||||||||||||||||||
|
|
||||||||||||||||||
| const agent = await Agent.create(signer, { | ||||||||||||||||||
| // ... other config options | ||||||||||||||||||
| rpcUrls: { | ||||||||||||||||||
| xmtp: xmtpChainRPCUrl, | ||||||||||||||||||
| base: baseRPCUrl, | ||||||||||||||||||
| } | ||||||||||||||||||
| }) | ||||||||||||||||||
| ```` | ||||||||||||||||||
|
|
||||||||||||||||||
| ::: | ||||||||||||||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.