https://github.com/blackode/slack-backend-test
VHS Backend Test
https://github.com/blackode/slack-backend-test
Last synced: 11 months ago
JSON representation
VHS Backend Test
- Host: GitHub
- URL: https://github.com/blackode/slack-backend-test
- Owner: blackode
- Created: 2021-11-28T10:47:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-05T07:16:25.000Z (almost 4 years ago)
- Last Synced: 2025-03-04T16:46:29.888Z (over 1 year ago)
- Language: Elixir
- Size: 305 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Welcome Slack Notifications
## Project Highlighted Module
### Vhs.Servers.Transaction
This module simulates a Transaction Server for registering, updating, notifying slack, and listing transactions using `GenServer`
It will start as soon as our `vhs` app started
## Development Technologies
At the moment of developing this project, I used the following versions of
Elixir and Erlang.
```elixir
iex> mix hex.info
Hex: 0.21.2
Elixir: 1.12.2
OTP: 24.0.4
Built with: Elixir 1.11.4 and OTP 21.3
```
## API EndPoints
- POST `/blocknative/confirm` to watch transaction hash
```json
// Request body params to be sent
{
"hash": "0x51d49ccc52e0d00941f86a1bd67e020162a6e1041b4e904ecdae03ebf0f1a907"
}
```
- POST `/blocknative/webhook` webhook url to receive transaction updates
- POST `/blocknative/transactions/pending` to list the all pending transactions
```json
// response
{
"data": [
{
"hash": "0x51d49ccc52e0d00941f86a1bd67e020162a6e1041b4e904ecdae03ebf0f1a907",
"status": "pending"
}
],
"status": "ok"
}
```
# Running Application
## 1. Docker Setup & Running
Add `.env` file with following environment variables
```shell
BLOCKNATIVE_API_KEY=""
SLACK_WEBHOOK_KEY=""
```
After that just build and run using the following commands
```
docker build -t vhs .
docker run -t vhs
```
By default visit `172.17.0.2:4000/blocknative/transactions/pending`
## 2. Running Local
#### 2.1) mix release vhs
```
mix deps.get
mix release vhs
```
I added the releases path to `./releases`
So, we are provided with following commands.
```
Release created at releases!
# To start your system
releases/bin/vhs start
Once the release is running:
# To connect to it remotely
releases/bin/vhs remote
# To stop it gracefully (you may also send SIGINT/SIGTERM)
releases/bin/vhs stop
To list all commands:
releases/bin/vhs
```
visit `localhost:4000/blocknative/transactions/pending`
#### 2.2) iex -S mix
Running Interactively
# Receiving Transaction Updates as Webhooks
## Expose a local web server to the internet
The `ngrok` will allow local webserver running to internet. So, we can use our local webserver url as webhook url at `blocknative`.
run the following command
```shell
ngrok http 4000
```
You will see the following output.
```
Session Status online
Version 2.3.40
Region United States (us)
Web Interface http://127.0.0.1:4040
Forwarding http://14fc-136-185-52-176.ngrok.io -> http://localhost:4000
Forwarding https://14fc-136-185-52-176.ngrok.io -> http://localhost:4000
Connections ttl opn rt1 rt5 p50 p90
```
The urls may look different as `ngrok` assigns random hexadecimal names to the HTTP tunnels it opens.
Here the url is `http://14fc-136-185-52-176.ngrok.io` which will act our webhook base.
Make sure you add `http://14fc-136-185-52-176.ngrok.io/blocknative/webhook` as webhook url for `blocknative`.
## Project Challenges
- API Integration (Blocknative) Implementation
- Transaction Server callbacks for updating the transaction status.
- Using docker to releases with Elixir.
## TIL
- Learned how to use localhost web server as `webhook` using `ngrok`
- Docker setup for Elixir projects with releases
## Overall Project Experience
I felt it is a well framed to test core concepts of Elixir as project made me to code in all the core concepts of Elixir like `GenServers`, `Enumaration`, `collections`, `webhooks`.
## What I enjoyed?
I really enjoyed coding webhooks, playing with docker, and notifying over slack.
Thank You :)
Best Regards,
Ankanna