This bot runs entirely on the Internet Computer. It listens for open NNS proposals, using the IC heartbeat functionality to constantly poll the NNS governance canister. When an open proposal is found, its information is put into a text message that is then sent to the corresponding OpenChat group for that proposal's topic.
OpenChat currently isn't open source, but the team shared enough Candid information with me that I was able to get my bot to work. If you want to create your own bot, below I show what it took to get my bot going.
- Register the bot as a user on OpenChat
- Create the bot's user canister on OpenChat
- Join the bot to a group
- Test sending a message
Simply call register_governance_bot_user with the correct username. You will need to modify this function with your bot's username.
Simply call create_governance_bot_user_canister. This will instruct OpenChat to register the canister of this user.
Hopefully you have the bot user's canister id from the previous step. If not you can call get_governance_bot_user_canister_id to get it, or you can join a chat with the bot in the OpenChat UI and look at the canister id in the address bar of the browser.
Next you will call governance_bot_join_group and pass in the canister id of the group that you want to join. You should have created the group already. The canister id can be found in the address bar of the browser.
You can test your bot using the send_message function. You might need to modify it to update the message id (if you have already used 0 as a message id) and the bot's username.
The key to running the bot is the heartbeat function. Once you push that to the IC, the heartbeat function will run every few seconds. You can read more about canister_heartbeat here: https://smartcontracts.org/docs/interface-spec/index.html#_heartbeat
The logic should be pretty easy to follow if you start at the heartbeat function. Basically every few seconds the NNS governance canister is polled to see if there are any open proposals. As long as the proposal id has not already been processed (stored locally in a map), then a message is sent to the appropriate group.