|
1 |
| -# XMTP agent examples |
2 |
| - |
3 |
| -This repository contains examples of agents that use the [XMTP](https://docs.xmtp.org/) network. |
4 |
| - |
5 |
| -#### Why XMTP? |
6 |
| - |
7 |
| -- **End-to-end & compliant**: Data is encrypted in transit and at rest, meeting strict security and regulatory standards. |
8 |
| -- **Open-source & trustless**: Built on top of the [MLS](https://messaginglayersecurity.rocks/) protocol, it replaces trust in centralized certificate authorities with cryptographic proofs. |
9 |
| -- **Privacy & metadata protection**: Offers anonymous or pseudonymous usage with no tracking of sender routes, IPs, or device and message timestamps. |
10 |
| -- **Decentralized**: Operates on a peer-to-peer network, eliminating single points of failure. |
11 |
| -- **Multi-agent**: Allows multi-agent multi-human confidential communication over MLS group chats. |
12 |
| - |
13 |
| -> See [FAQ](https://docs.xmtp.org/intro/faq) for more detailed information. |
14 |
| -
|
15 |
| -## Environment variables |
16 |
| - |
17 |
| -To run your XMTP agent, you must create a `.env` file with the following variables: |
18 |
| - |
19 |
| -```bash |
20 |
| -WALLET_KEY= # the private key of the wallet |
21 |
| -ENCRYPTION_KEY= # encryption key for the local database |
22 |
| -``` |
23 |
| - |
24 |
| -You can generate random keys with the following command: |
25 |
| - |
26 |
| -```bash |
27 |
| -yarn gen:keys |
28 |
| -``` |
29 |
| - |
30 |
| -> [!WARNING] |
31 |
| -> Running the `gen:keys` script will overwrite the existing `.env` file. |
32 |
| -
|
33 |
| -## Examples |
34 |
| - |
35 |
| -- [gm](/examples/gm/): A simple agent that replies to all text messages with "gm". |
36 |
| -- [gpt](/examples/gpt/): An example using GPT API's to answer messages. |
37 |
| -- [gated-group](/examples/gated-group/): Add members to a group that hold a certain NFT. |
38 |
| - |
39 |
| -> See all the available [examples](/examples/). |
40 |
| -
|
41 |
| -## Web inbox |
42 |
| - |
43 |
| -Interact with the XMTP network using [xmtp.chat](https://xmtp.chat), the official web inbox for developers. |
44 |
| - |
45 |
| - |
46 |
| - |
47 |
| -> [!WARNING] |
48 |
| -> This React app isn't a complete solution. For example, the list of conversations doesn't update when new messages arrive in existing conversations. |
0 commit comments