@imwatsi shares an update on the development of the Hive Global Notification System (GNS).
- GitHub: https://github.com/FreeBeings-io/hive-gns
- API: https://gns.freebeings.io/docs
- Preview: https://preview.gns.freebeings.io/
Summary
- Added available modules and categories to status endpoint
- Added more granular filtering on account endpoints
- Preview site now available
Status endpoint updates
The root endpoint /
has been updated to show the following additional app_data
:
categories
: notification categories to help apps categorise notifications- Each category contains a notification type, with the human readable description as key (e.g. Votes) and a pair of module name and notification code to uniquely identify that notification. For example
{“Votes”: “core:vot”}
.
- Each category contains a notification type, with the human readable description as key (e.g. Votes) and a pair of module name and notification code to uniquely identify that notification. For example
available_modules
: shows the modules that are live on that GNS node
Account based endpoints
/api/{account}/notifications
: to get notifications for an account, with the option to filter by onemodule
and onenotif_code
(found inapp_data
above)/api/{account}/notifications/category
: to get all notifications consisting of allnotif_codes
within a category. You pass a category as param, for exampleCurrency
./api/{account}/notifications/custom
: retrieve an account’s notifications by passing a list ofmodule:notif_code
pairings, effectively retrieving a custom data set, which can span multiple categories and modules.
Preview site
We have developed a showcase frontend that you can use to interact with GNS and see how it works. More features will be added as functionality expands on the GNS API.
It is deployed here: https://preview.gns.freebeings.io.
Example of transfer notifications for the @taskmaster4450 account:
Login
There’s a relaxed login method available. If you just want to view data, select the “view only” option on the login modal and enter the username of the account you want to view. It can be any account on the Hive blockchain.
The posting key login will be used to set account preferences for your account on GNS. We are also working on adding support for other Hive login methods, like Hive Keychain.
Account preferences are still being developed and an announcement will be made when they are ready for use.
Issues
We are investigating an issue that’s causing the calculation of vote amount ($) to zero out in the votes notifications.
What’s next?
- Add support for more notification types
- Add more login options on the preview site
- Integrate account preferences
by @imwatsi - Co-Founder | CEO | Blockchain Developer
Vote for our witness
Witness Name: @imwatsi
We're glad to be building on Hive. Follow the @freebeings account for more updates.