@beblurt/blurt-nodes-checker 1.0.1 → 1.1.1

package/README.md

@@ -1,6 +1,10 @@
-# BLURT RPC nodes checker
+# Blurt RPC nodes checker
 
-ESM Typscript [BLURT blockchain](https://blurt.blog/) RPC nodes servers checker (latency, availability, methods). Checks the status of the RPC nodes servers of the BLURT blockchain at a specified interval and sends a report via a RxJS subscription. The result is stored in an array in memory and you can call it at any time.
+ESM Typscript [Blurt blockchain](https://gitlab.com/blurt/blurt) RPC nodes servers checker (latency, availability, methods).
+
+Checks the status of the RPC nodes servers of the Blurt blockchain at a specified interval and sends a report via a RxJS subscription. The result is stored in an array in memory and you can call it at any time.
+
+The library also allows you to identify the compatibility of an RPC node with [Nexus](https://gitlab.com/blurt/openblurt/nexus) (communities on the [Blurt blockchain](https://gitlab.com/blurt/blurt)) and to adapt the full test accordingly by including the Nexus methods.
 
 ## Getting Started
 
@@ -40,7 +44,7 @@ $  npm run build-browser
 
 ### Initialisation
 
-Initialise the BLURT nodes checker with **params**
+Initialise the Blurt nodes checker with **params**
 
 ```js
 /** Init the checker */
@@ -50,7 +54,9 @@ const nodesChecker = new BlurtNodesChecker(["url1", "url2", ...])
 ### Params
 - `url`: array of node url to check
 - `options` (optional):
+    - `debug` (boolean): if true show console info (default: false) 
     - `full` (boolean): if false perform only a `get_config` with response time (default: false)
+    - `nexus` (boolean): if true check if the rpc node is [Nexus](https://gitlab.com/blurt/openblurt/nexus) compatible (default: false)
     - `interval` (seconds): delay in seconds between each execution (default: 900 seconds)
     - `timeout` (seconds): timeout in seconds for node request (default: 3 seconds)
     - `reset` (number): number max of test before resetting the counters (default: no reset)
@@ -119,19 +125,21 @@ Performing a full checking:
 ```js
 import { BlurtNodesChecker } from '@beblurt/blurt-nodes-checker'
 
-/** BLURT nodes url to check */
+/** Blurt nodes url to check */
 const nodes = [
+  "https://rpc.beblurt.com",
   "https://blurt-rpc.saboin.com",
   "https://rpc.blurt.world",
-  "https://blurtrpc.actifit.io/",
+  "https://blurtrpc.actifit.io",
   "https://kentzz.blurt.world",
-  "https://rpc.blurtlatam.com/",
-  "https://rpc.blurt.live/"
+  "https://rpc.blurt.live",
+  "https://blurtdev.techcoderx.com"
 ]
 
 /** Options */
 const options = {
   full: true,
+  nexus: true,
   interval: 600, // 10 minutes
   reset: 144 // every 144 tests => 24 hours x 6 (10 minutes = 6 test per hours)
 }
@@ -158,7 +166,7 @@ nodesChecker.message.subscribe({
 
 ### Light checking
 
-In this case, only a call to the rpc method `condenser_api.get_config` is made.
+In this case, only a call to the rpc method `condenser_api.get_config` is made, if `nexus: true` in options there is a call to the rpc method `bridge.unread_notifications` too to check if it's a Nexus rcp node.
 
 #### Result
 ```ts
@@ -174,6 +182,7 @@ In this case, only a call to the rpc method `condenser_api.get_config` is made.
   "average_time"?:  number
   "version"?:       string
   "deactivated"?:   boolean
+  "nexus":          boolean
 
   "test_result":    []
 }]
@@ -182,18 +191,18 @@ In this case, only a call to the rpc method `condenser_api.get_config` is made.
 #### Exemple of result for a light checking
 ```js
 [
-{
-  url: 'https://blurtrpc.actifit.io/',
-  nb_ok: 1,
-  nb_error: 0,
-  nb_degraded: 0,
-  last_check: 1661768268483,
-  status: 'online',
-  test_result: [],
-  version: '0.8.2',
-  duration: 300,
-  average_time: 572
-},
+  {
+    url: "https://rpc.beblurt.com",
+    nb_ok: 1,
+    nb_error: 0,
+    nb_degraded: 0,
+    last_check: 1669607084463,
+    status: "online",
+    test_result: [],
+    version: "0.8.2",
+    duration: 598,
+    nexus: true
+  },
   ...
 ]
 ```
@@ -204,12 +213,20 @@ In this case the methods below are checked:
 
 - `condenser_api.get_config`
 - `condenser_api.get_accounts`
-- `block_api.get_block`
+- `condenser_api.get_block`
 - `condenser_api.get_blog_entries`
 - `condenser_api.get_content`
 - `condenser_api.get_dynamic_global_properties`
 - `condenser_api.get_discussions_by_blog`
 
+If it is a Nexus node the following methods are also checked:
+
+- `bridge.account_notifications`
+- `bridge.get_payout_stats`
+- `bridge.get_post`
+- `bridge.get_profile`
+- `bridge.list_communities`
+
 #### Result
 ```ts
 [{
@@ -240,67 +257,37 @@ In this case the methods below are checked:
 #### Exemple of result for a full checking
 ```js
 [
-{
-  url: 'https://blurtrpc.actifit.io/',
-  nb_ok: 1,
-  nb_error: 0,
-  nb_degraded: 0,
-  last_check: 1661768268483,
-  status: 'online',
-  test_result: [
-    {
-      name: 'Condenser | Get Dynamic Global Propertie',
-      description: 'Check chain global properties',
-      method: 'condenser_api.get_dynamic_global_properties',
-      success: true,
-      duration: 279,
-      last_check: 1661768268483
-    },
-    {
-      name: 'Condenser | Get Account',
-      description: 'Retrieve an account details',
-      method: 'condenser_api.get_accounts',
-      success: true,
-      duration: 314,
-      last_check: 1661768268483
-    },
-    {
-      name: 'Condenser | Get Block',
-      description: 'Get Block',
-      method: 'block_api.get_block',
-      success: true,
-      duration: 479,
-      last_check: 1661768268483
-    },
-    {
-      name: 'Condenser | Get Content',
-      description: 'Retrieve the content (post or comment))',
-      method: 'condenser_api.get_content',
-      success: true,
-      duration: 479,
-      last_check: 1661768268483
-    },
-    {
-      name: 'Condenser | Get Blog Entries',
-      description: 'Retrieve the list of blog entries for an account)',
-      method: 'condenser_api.get_blog_entries',
-      success: true,
-      duration: 481,
-      last_check: 1661768268483
-    },
-    {
-      name: 'Condenser | Get Disccusion By Blog',
-      description: 'Retrieve a list of discussions by blog)',
-      method: 'condenser_api.get_discussions_by_blog',
-      success: true,
-      duration: 685,
-      last_check: 1661768268483
-    }
-  ],
-  version: '0.8.2',
-  duration: 300,
-  average_time: 572
-},
+  {
+    url: "https://rpc.beblurt.com",
+    nb_ok: 1,
+    nb_error: 0,
+    nb_degraded: 0,
+    last_check: 1669607748639,
+    status: "online",
+    test_result: [
+        {
+            name: "Bridge | account_notifications ",
+            description: "Account notifications",
+            method: "bridge.account_notifications",
+            success: true,
+            duration: 314,
+            last_check: 1669607748639
+        },
+        ...
+        {
+            name: "Condenser | Get Disccusion By Blog",
+            description: "Retrieve a list of discussions by blog",
+            method: "condenser_api.get_discussions_by_blog",
+            success: true,
+            duration: 1181,
+            last_check: 1669607748639
+        }
+    ],
+    version: "0.8.2",
+    duration: 579,
+    nexus: true,
+    average_time: 1140,
+  },
   ...
 ]
 ```
@@ -311,7 +298,7 @@ Pull requests for new features, bug fixes, and suggestions are welcome!
 
 ## Author
 
-@beblurt (https://blurt.blog/@beblurt)
+@beblurt (https://beblurt.com/@beblurt)
 
 ## License