confirmerator

module
v0.0.0-...-8ad73b1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 11, 2021 License: GPL-3.0

README

Confirmerator

Listen to blockchain networks such as Bitcoin and Ethereum for transactions on given addresses and publish messages to NATS to be handled for by other programs such as a notification pusher.

Confirmerator provides users with the ability receive notifications when their transactions are confirmed.

Currently functioning as intended for Ethereum but is with a Work-in-Progress.

Quickstart

a relative link

Docker

Example docker command $ docker build -f api/Dockerfile -t confirmerator . && docker run -p 80:80 --name confirmerator confirmerator

TODO list
  • Connect to bitcoin zmq
  • Monitor smart-contracts
  • Respond to confirmation count request

Contribution

Thank you for considering to help out with the source code! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!

If you'd like to contribute to Confirmerator, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base.

Please make sure your contributions adhere to our coding guidelines:

  • Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
  • Code must be documented adhering to the official Go commentary guidelines.
  • Pull requests need to be based on and opened against the master branch.

License

The Confirmerator binaries (i.e. all code inside of this project) is licensed under the GNU General Public License v3.0, also included in our repository in the LICENSE file.

Directories

Path Synopsis
api
account
Handle information related to the account, tracks wallet addresses
Handle information related to the account, tracks wallet addresses
user
Handle user related information
Handle user related information
cmd
database
mongodb
Read information from the database, no writes done here.
Read information from the database, no writes done here.
Using queue system nats
Using queue system nats
firebase
Send message to mobile devices through fcm
Send message to mobile devices through fcm
Generic functions that can be used across projects
Generic functions that can be used across projects

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL