https://github.com/gjgd/element-slack-bot
A Slack Bot for Element DID running on AWS Lambda + AWS Dynamo DB
https://github.com/gjgd/element-slack-bot
awslambda dynamodb element serverless-framework slackbot
Last synced: 9 months ago
JSON representation
A Slack Bot for Element DID running on AWS Lambda + AWS Dynamo DB
- Host: GitHub
- URL: https://github.com/gjgd/element-slack-bot
- Owner: gjgd
- Created: 2020-01-02T15:11:11.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-06-25T09:48:30.000Z (over 3 years ago)
- Last Synced: 2025-02-11T13:42:03.479Z (11 months ago)
- Topics: awslambda, dynamodb, element, serverless-framework, slackbot
- Language: JavaScript
- Size: 770 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# To install
https://slack.com/oauth/authorize?client_id=526646871811.867617605379&scope=incoming-webhook,channels:history
# Overview
## Description
A Slack bot for [Element DID](https://github.com/decentralized-identity/element), the Ethereum implementation of the [Sidetree](https://github.com/decentralized-identity/sidetree) protocol
This bot parses Slack messages in order to extract transaction hashes from Element transactions, and then posts links to the [Element Block Explorer](https://medium.com/transmute-techtalk/element-block-explorer-bb6d2c712664) to provide richer context about the transaction.
## Screenshots
# Tech stack
- AWS Lambda for the webhooks
- AWS DynamoDB to store Oauth 2.0 tokens
- [Serverless framework](https://github.com/serverless/serverless) to build and deploy
# Deployment
1) Setup Serverless with AWS: https://github.com/serverless/serverless#quick-start
2) Create a new Slack app https://api.slack.com/apps and get your CLIENT_ID and CLIENT_SECRET
3) Create a `secret.dev.yml` file to store the values:
```
CLIENT_ID: 'YOUR_CLIENT_ID'
CLIENT_SECRET: 'YOUR_CLIENT_SECRET'
```
We use https://github.com/serverless/serverless-secrets-plugin to encrypt the secrets for our Bot
4) Deploy the hooks `serverless deploy`
5) In the Slack dashboard, setup
- The [Incoming Webhook](https://api.slack.com/messaging/webhooks) service to allow the bot to post messages
- The [Event Subscription](https://api.slack.com/events-api) service with the `message.channels` bot permissions using your `webhook` Lambda as the `Request URL`
- The [Oauth 2.0](https://api.slack.com/docs/oauth) service using your `redirectUrl` Lambda as the Redirect URL
# Useful commands
```
# Logs the activity of the webhook Lambda
serverless logs -t -f webhook
# Deploy only the webhook Lambda or all
serverless deploy function -f webhook
serverless deploy
# Encrypt / Decrypt secrets.dev.yml
serverless encrypt --stage dev --password 'your-password'
serverless decrypt --stage dev --password 'your-password'
# Remove all serverless services
serverless remove
```