Deploying your bot with the CLI
This page covers how to deploy your bot using the
forta-agent CLI tool.
Enable logging (optional)
Forta provides a logging feature that can be used to see what's happening inside of your bot across multiple scan nodes. To enable this feature, you need to add/uncomment the following line in the bot Dockerfile:
After deploying, you can view bot logs using the Forta API.
Documentation for your bot is required in order to deploy. It should let others know what conditions your bot is detecting and what sort of alerts it will fire. Documentation will always be in the README.md file in your project folder (we have provided example documentation to help you get started). Please update the README.md for your specific bot.
You will also find the Forta Detection Bot License included in your project LICENSE.md file (and copied over in your Dockerfile). This is required for every detection bot deployed to the network.
A few configuration values must be set in your package.json in order to deploy:
nameof your bot project should be specified
descriptionshould be a short human-readable description of what your bot does
versionof your bot should also be set as well
chainIdsof the blockchains that your bot will be scanning should be specified as an array of integers. You must specify at least one and up to as many as you need. The supported chain IDs are:
- 1 (Ethereum)
- 137 (Polygon)
- 56 (Binance Smart Chain)
- 43114 (Avalanche)
- 42161 (Arbitrum)
- 10 (Optimism)
- 250 (Fantom)
repositoryis optional, but providing a link to your code helps build trust in your bot
Make sure your Docker is running before proceeding. You can now run the following command from your project folder to deploy your bot:
This will build a Docker image for your bot using the Dockerfile in your project folder and push it to an image repository where scan nodes can find it. A manifest will be generated for your bot (which includes a reference to the Docker image) and be published to the Bot Registry contract.
Signing the manifest
The bot manifest will need to be signed using your keyfile (located in ~/.forta), so you will be prompted for the password (unless you specified
keyfilePassword in forta.config.json).
When successfully deployed, you should see a message in your output similar to
successfully added agent id 0x855b1556a45637abf05c63407437f6f305b4627c4361fb965a78e5731999c0c7 with manifest QmcWPhPQ3un47QpZKKJZxD5ih3TXgk91ehLeUw6we2ncYg
0x855b1556a45637abf05c63407437f6f305b4627c4361fb965a78e5731999c0c7) as well as your manifest IPFS reference (i.e.
QmcWPhPQ3un47QpZKKJZxD5ih3TXgk91ehLeUw6we2ncYg). You can view the manifest by requesting it from any IPFS gateway (e.g.
In order to enable your bot, it must be staked with 100 FORT tokens. You can easily stake on your detection bot using the following command:
If you prefer to stake using a UI, you can do so by following the steps here.
Congratulations! You have successfully deployed your first Forta bot!
Great job getting this far! You have created a project, developed a bot, written and run a test, and deployed it to the Forta network. We encourage you to share your bots with the Discord community as a way to showcase your ideas or receive general feedback! For any questions or feedback you may have, you can find us in the Forta Discord server as well.
Continue to the next page where you can learn more about subscribing to alerts.