@xmtp/botkit

@xmtp/botkit

Minimal viable package for creating bots.

CLI Quickstart

For a streamlined setup process, you can use the create-xmtp-bot CLI tool, which simplifies the creation and configuration of new XMTP bots.

npx create-xmtp-bot@latest bot-name

Please refer to its documentation.

Overview

Here's a basic example of the code with a bot that responds with a gm:

import { run, HandlerContext } from "@xmtp/botkit";

run(async (context: HandlerContext) => {
  // Get the message and the address from the sender
  const { content, senderAddress } = context.message;

  // To reply, just call `reply` on the HandlerContext.
  await context.reply(`gm`);
});

Examples

• Gm: Get started with a simple gm bot.
• Conversational: Drive retention with conversations and subscriptions with redisDb.
• GPT: Relay messages through Open AI APIs.

See more examples in the Awesome XMTP ⭐️ repo

Deployment

Here’s how to easily deploy this bot:

• Sign up at Railway.
• Click 'New Project' and select 'Node.js'.
• Create a Redis DB or other (Optional)
• Connect your GitHub repository
• Set your environment variables
• Deploy your application.
• Register an ENS domain and share your bot!

Head to the tutorial on how to deploy an XMTP bot on Railway

Development

To develop on this repo clone the repository containing the bot code:

git clone https://github.com/xmtp/botkit
cd botkit
# copy env variables template
cp .env.example .env

Set the variables

KEY= # 0x... the private key of the bot (with the 0x prefix)
XMTP_ENV=production # or `dev`

⚠️ Bot kit is not compatible with bun yet. Use npm or yarn

# install dependencies
yarn install

# running the bot
yarn build
yarn start

# to run with hot-reload
yarn build:watch
yarn start:watch

# run the gm example
yarn build:watch
yarn start:gm

Messaging apps 💬

Test the bots in messaging apps

• Converse: Own your conversations. Works with Frames (Transactions TBA) (prod)
• Coinbase Wallet: Your key to the world of crypto. (Frame support TBA) (prod)
• dev-inbox: Dev focused messaging client that renders Frames (Transactions TBA) (prod & dev)

Identities

Learn about the nearly 2 million identities part of XMTP by visiting this Dune dashboard.