Notifications Service for Everscale Blockchain. Service PROD version is already deployed here: https://ftns.freeton-stats.org/ and available via Notifications DeBot (Service ID - i4ins)

• Unique identifier and notification parameters - data is stored in MongoDB
• Guaranteed delivery of notifications - notifications will be delivered even after service shutdown, repeated delivery for 24h in case if webhook consumer unavailable
• Support for HTTPS protocol
• Verification of a domain ownership - via adding a validation file in a .well-known folder
• Logging of events of http notifications for the possibility of displaying them in charts - https://ftns.freeton-stats.org/log/info
• All HTTP API methods must return a 200 response if the requested operation is successful and corresponding HTTP error code otherwise
• Module information - available here https://ftns.freeton-stats.org/info/get
• Well documented with openapi
• http server with UI is provided for testing purposes

Api documention and schemas are provided here (openapi): https://ftns.freeton-stats.org/docs/api

Solution has a Demo server for testing purposes
Please, follow the guide in the repository: https://github.com/Strafi/everscale-notifications-service-demo

$ git clone [email protected]:Strafi/everscale-notifications-service.git i4ins
$ cd i4ins

$ npm install

or

$ yarn

To edit environment variables, create a file with name .env and copy values below.
Note: if you are going to use docker-compose, you should also update environment in .yml files.

$ docker-compose -f docker-compose.prod.yml up

$ docker pull asolodkov/i4ins
$ docker run -t -i \
      --env NODE_ENV=production \
      --env MONGO_URL=mongodb://mongo:27017/ftns \
      --env KAFKA_USERNAME={YOUR_KAFKA_USERNAME} \
      --env KAFKA_PASSWORD={YOUR_KAFKA_PASSWORD} \
      --env KAFKA_TOPIC={YOUR_KAFKA_TOPIC} \
      --env KAFKA_GROUP_ID={YOUR_KAFKA_GROUP_ID} \
      --env KAFKA_BROKER=notification.services.tonlabs.io:29092 \
      -p 3000:3000 \
      asolodkov/i4ins

The mongo container is only only available in dev environment. When you build and deploy the docker image, be sure to provide the correct environment variables.

$ npm run build && npm run start

or

$ yarn build && yarn start

$ docker build -t i4ins .
$ docker run -t -i \
      --env NODE_ENV=production \
      --env MONGO_URL=mongodb://mongo:27017/ftns \
      --env KAFKA_USERNAME={YOUR_KAFKA_USERNAME} \
      --env KAFKA_PASSWORD={YOUR_KAFKA_PASSWORD} \
      --env KAFKA_TOPIC={YOUR_KAFKA_TOPIC} \
      --env KAFKA_GROUP_ID={YOUR_KAFKA_GROUP_ID} \
      --env KAFKA_BROKER=notification.services.tonlabs.io:29092 \
      -p 3000:3000 \
      i4ins

$ docker-compose up

The application uses winston as the default logger. The configuration file is at src/logger.ts.

• All logs are saved in ./logs directory and at /logs in the docker container.
• The docker-compose file has a volume attached to container to expose host directory to the container for writing logs.
• Console messages are prettified
• Each line in error log file is a stringified JSON.

Application logs available here: https://ftns.freeton-stats.org/log/info