From 3338ae0eee8719e69e71805357b3fa4901841154 Mon Sep 17 00:00:00 2001 From: dbth <1097224+believethehype@users.noreply.github.com> Date: Sun, 23 Feb 2025 22:35:46 +0100 Subject: [PATCH] NIP90: Add Ping/Pong to DVMs - rationale: This introduces kind 7007 (ping) to send a small request to a dvm to check if it is alive. The DVM replies with a kind 7000 feedback event and status pong, and optional information in content. This allows clients to test if a dvm is alive without sending an actual job request to the dvm. --- 90.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/90.md b/90.md index 785b539c..71909ac2 100644 --- a/90.md +++ b/90.md @@ -18,6 +18,7 @@ This NIP reserves the range `5000-7000` for data vending machine use. | 5000-5999 | Job request kinds | | 6000-6999 | Job result | | 7000 | Job feedback | +| 7007 | Ping | Job results always use a kind number that is `1000` higher than the job request kind. (e.g. request: `kind:5001` gets a result: `kind:6001`). @@ -176,9 +177,13 @@ Service providers can give feedback about a job back to the customer. | `error` | Service Provider was unable to process the job. | | `success` | Service Provider successfully processed the job. | | `partial` | Service Provider partially processed the job. The `.content` might include a sample of the partial results. | +| `pong` | Service Provider signals it's alive in response to a Kind 7007 Ping Request | Any job feedback event MIGHT include results in the `.content` field, as described in the [Job Result](#job-result-kind6000-6999) section. This is useful for service providers to provide a sample of the results that have been processed so far. +### DVM Ping request +DVMs should implement a listener for Kind 7007, which is defined as a Ping command. The DVM should reply to a ping command with a Kind 7000 feedback event with status "pong" and optional more details about the DVM in the content field. This allows clients to check if a DVM is currently running, without sending an actual job request to the DVM (triggering a job, requesting an invoice etc). + # Protocol Flow