Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eosauthority/eosio-watcher-plugin
EOSIO watcher plugin: HTTP POST to endpoint for on chain actions
https://github.com/eosauthority/eosio-watcher-plugin
eos eos-blockchain eos-resources eos-tutorials
Last synced: about 2 months ago
JSON representation
EOSIO watcher plugin: HTTP POST to endpoint for on chain actions
- Host: GitHub
- URL: https://github.com/eosauthority/eosio-watcher-plugin
- Owner: eosauthority
- License: mit
- Created: 2018-07-26T15:38:37.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-04-11T22:33:11.000Z (over 2 years ago)
- Last Synced: 2024-07-31T16:33:31.198Z (5 months ago)
- Topics: eos, eos-blockchain, eos-resources, eos-tutorials
- Language: C++
- Homepage:
- Size: 27.3 KB
- Stars: 66
- Watchers: 8
- Forks: 29
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# EOSIO Watcher Plugin by EOS Authority
The watcher plugin is useful to watch for specific actions on the chain and then send them to an HTTP url.
The HTTP POST is called as soon as the action is seen on the chain!
# Watcher plugin features
## Filter and get notifications for actions on any account
You can either get notifications for all actions on a account, or any specific actions. You get notifications in a form of http POST call to the url you specify.
**NOTE:** in case of forks plugin can end up sending notifications for same transaction twice. That's because notifications are sent as soon as block is accepted (so there is no guarantee block is not on a fork). Receiver of notifications should handle the duplicate notification appropriately.
## Age limit for actions
Usually you don't want to receive notifications for actions which happened months ago, just because your nodeos is resyncing. To prevent this you can specify age limit for blocks, which are filtered for actions you want to receive. This is by default set to 1 minute, but is configurable.
## Flexible configuration
Features just mentioned are configurable through options to nodeos (built with watcher_plugin) or in your config.ini. Use `nodeos --help` to see help for options.
## Asynchronous http calls
Notifications are sent asynchronously, which means it does not interfere with normal operation of nodeos, even in case of unreliable http connection to the notification receiver.
## Retry on failed calls
To make sure no action is missed, even when a connection to the receiver is lost, on failed first attempt to send, plugin retries once more before giving up.
# Installation instructions
## Requirements
- Works on any EOSIO node that runs v1.1.0 and up.
## Building the plugin [Install on your nodeos server]
### EOSIO v1.2.0 and up
You need to statically link this plugin with nodeos. To do that, pass the following flag to cmake command when building eosio:
```
-DEOSIO_ADDITIONAL_PLUGINS=
```
### EOSIO v1.1.0 and up
1. Remove or comment out this line in CMakeLists.txt:
```
eosio_additional_plugin(watcher_plugin)
```
2. Copy this repo to `/plugins/` You should now have `/plugins/watcher_plugin`
3. Add the following line to `/plugins/CMakeLists.txt` with other `add_subdirectory` items
```
add_subdirectory(watcher_plugin)
```
4. Add the following line to the bottom of `/programs/nodeos/CMakeLists.txt`
```
target_link_libraries( nodeos PRIVATE -Wl,${whole_archive_flag} watcher_plugin -Wl,${no_whole_archive_flag})
```
5. Build and install nodeos as usual. You could even just `cd /build` and then `sudo make install`
# How to setup on your nodeos
Enable this plugin using `--plugin` option to nodeos or in your config.ini. Use `nodeos --help` to see options used by this plugin.
## Edit your nodeos config.ini (probably easier)
```
#Enable plugin
plugin = eosio::watcher_plugin
#Set account:action so eosauthority:spaceinvader or just eosauthority: for all actions on eosauthority
watch = eosauthority:
#watch multiple if required
watch = b1:
#watch multiple if required
watch = eosabc:forum
#http endpoint for each action seen on the chain. JSON array if you there are multiple actions in one block.
#see sample json example. All "watch" above will be sent to this URL and the URL can handle processing as required
watch-receiver-url = http://127.0.0.1:8082/blockchain_action
#Age limit in seconds for blocks to send notifications. No age limit if set to negative.
#Used to prevent old actions from trigger HTTP request while on replay (seconds)
watch-age-limit = 5
```
## Check if the plugin has loaded
- You should see an entry for watcher_plugin in the logs when you restart nodeos.
- Your HTTP endpoint should receive POST requests as in [our sample JSON](sample-post.json)
- Thats it, you should be all set to get realtime actions on the chain.
# Feedback & development
- This plugin is used on production with space invaders. https://eosauthority.com/space/
- You also use this plugin to setup realtime alerts similar to https://eosauthority.com/alerts
- Any suggestions and pull requests are welcome :)