nostr/nips
1
0
Fork 0
mirror of https://github.com/nostr-protocol/nips.git synced 2024-09-19 22:35:50 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

use different kinds per job request type

Browse Source
This commit is contained in:
pablof7z 2023-07-23 21:28:59 +02:00
parent e9924bdcde
commit 53bd97373b
1 changed files with 127 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

215
vending-machine.md
View File

@ -8,10 +8,19 @@ Data Vending Machine
This NIP defines the interaction between customers and Service Providers to perform on-demand computation. This NIP defines the interaction between customers and Service Providers to perform on-demand computation.
## Kinds
This NIP reserves the range `65000-69999` for data vending machine use.
| Kind | Description |
| ---- | ----------- |
| 65000 | Job feedback |
| 65001 | Job result |
| 65002-69999 | Job request kinds |
## Rationale ## Rationale
Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g. "speech-to-text", "summarization", etc.), but where they don't necessarily care about "who" processes the data. Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g. "speech-to-text", "summarization", etc.), but where they don't necessarily care about "who" processes the data.
This NIP is not to be confused with a 1:1 marketplace; but rather, a flow where user announces a desired output, willigness to pay, and service providers compete to fulfill the job requirement in the best way possible. This NIP is not to be confused with a 1:1 marketplace; but rather, a flow where user announces a desired output, willingness to pay, and service providers compete to fulfill the job requirement in the best way possible.
### Actors ### Actors
There are two actors to the workflow described in this NIP: There are two actors to the workflow described in this NIP:
@ -24,52 +33,44 @@ A request to have data processed -- published by a customer
```json ```json
{ {
"kind": 68001, "kind": 6xxxx,
"content": "", "content": "",
"tags": [ "tags": [
[ "j", "<job-type>", "<optional-model>" ], [ "i", "<data>", "<input-type>", "<marker>", "<relay>" ],
[ "i", "<data>", "<input-type>", "<marker>" ],
[ "output", "<mime-type>" ], [ "output", "<mime-type>" ],
[ "relays", "wss://..."], [ "relays", "wss://..."],
[ "bid", "<msat-amount>", "<optional-max-price>" ], [ "bid", "<msat-amount>" ],
[ "exp", "<timestamp>" ], [ "exp", "<timestamp>" ],
[ "p", "service-provider-1" ], [ "t", "bitcoin" ]
[ "p", "service-provider-2" ],
] ]
} }
``` ```
* `content` field: An optional, human-readable description of what this job is for. * `i` tag: Input data for the job, (zero or more inputs may exist)
* `j` tag: Job-type to be executed.
* A job request MUST have exactly one `j` tag.
* It MAY include a second value specifying the name of a model to be used when computing the result.
* `i` tag: Input data for the job.
* A job request CAN have zero or more inputs.
* Positional arguments: `["i", "<data>", "<input-type>", "<relay>", "<marker>"]`
* `<data>`: The argument for the input * `<data>`: The argument for the input
* `<input-type>`: The way this argument should be interpreted, one of: * `<input-type>`: The way this argument should be interpreted, MUST be one of:
* `url`: a URL to be fetched * `url`: a URL to be fetched
* `event`: a nostr event ID, include an optional relay-url extra param * `event`: a nostr event ID, include an optional relay-url extra param
* `job`: the output of a previous job with the specified event ID * `job`: the output of a previous job with the specified event ID
* `<relay>`: if `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string. * `content`:
* `<marker>`: an optional field indicating how this input should be used. * `<marker>`: an optional field indicating how this input should be used.
* `output` tag: MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format. * `<relay>`: if `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string.
* `bid` tag: Customer MAY specify a maximum amount (in millisats) they are willing to pay. * `output` tag (opt): MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format if it has been specified.
* `bid` tag (opt): Customer MAY specify a maximum amount (in millisats) they are willing to pay.
* `relays` tag: relays where Service Providers SHOULD publish responses to. * `relays` tag: relays where Service Providers SHOULD publish responses to.
* `p` tags: Service Providers the customer is interested in having process this job. Other SP MIGHT still choose to process the job. * `p` tags (opt): Service Providers the customer is interested in having process this job. Other SP MIGHT still choose to process the job.
* `exp`: Optional expiration timestamp. Service Providers SHOULD not send results after this timestamp. * `exp` (opt): expiration timestamp. Service Providers SHOULD not send results after this timestamp.
## Job result ## Job result
The output of processing the data -- published by the Service Provider. The output of processing the data -- published by the Service Provider.
```json ```json
{ {
"pubkey": "service-provider pubkey in hex", "pubkey": "<service-provider pubkey>",
"content": "<payload>", "content": "<payload>",
"kind": 68002, "kind": 65001,
"tags" [ "tags" [
[ "request", "<68001-event>" ], [ "request", "<job-request>" ],
[ "e", "<id-of-68001-event>" ], [ "e", "<job-request-id>", "<relay-hint>" ],
[ "p", "<Customer's pubkey>" ], [ "p", "<Customer's pubkey>" ],
[ "status", "success", "<more-info>" ], [ "status", "success", "<more-info>" ],
[ "amount", "requested-payment-amount", "<optional-bolt11>" ] [ "amount", "requested-payment-amount", "<optional-bolt11>" ]
@ -77,6 +78,9 @@ The output of processing the data -- published by the Service Provider.
} }
``` ```
* `request` tag: The job request event ID.
* `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice.
## Job feedback ## Job feedback
Both customers and service providers can give feedback about a job. Both customers and service providers can give feedback about a job.
@ -86,29 +90,25 @@ The result of the job SHOULD be included in the `content` field.
* `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice. * `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice.
# Protocol Flow # Protocol Flow
* Customer publishes a job request * Customer publishes a job request (e.g. `kind:65002`).
`{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` * Service Prpvoders can submit `kind:65000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.).
* Service Prpvoders can submit `kind:68003` job-feedback events (e.g. `payment-required`, `processing`, `unprocessable-entity`, etc.). * Upon completion, the service provider publishes the result of the job with a `kind:65001` job-result event.
* Upon completion, the service provider publishes the result of the job with a `kind:68002` job-result event. * At any point, the user can pay the included `bolt11` or zap any of the events the service provider has sent to the user.
* Upon acceptance, the user zaps the service provider, tagging the job result event with a `kind:7` 👍 reaction.
`kind:68002` and `kind:68003` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers `kind:65000` and `kind:65001` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers SHOULD use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. Custeroms are can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice.
SHOULD use the `payment-required` feedback event to signal that a payment must be done before moving on to the next step.
## Notes about the protocol flow ## Notes about the protocol flow
The flow is deliverately left ambiguos, allowing vast flexibility for the interaction between customers and service providers so that The flow is deliverately ambiguos, allowing vast flexibility for the interaction between customers and service providers so that service providers can model their behavior based on their own decisions. Some service providers might choose to submit a `payment-required` as the first reaction before sending an `processing` or before delivering `kind:65001` results, some might choose to serve partial results for the job (e.g. as a sample), send a `payment-required`to deliver the rest of the results, and some service providers might choose to assess likelyhood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX.
service providers can model their behavior based on their own decisions. Some service providers might choose to submit a `payment-required`
as the first reaction before sending an `processing` or before delivering `kind:68002` results, some might choose to serve partial results It's not up to this NIP to define how individual vending machines should choose to run their business.
for the job (e.g. as a sample), send a `payment-required`to deliver the rest of the results, and some service providers might choose to
assess likelyhood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX.
# Payment # Payment
Customers SHOULD pay service providers whose job results they accept by zapping the Service Provider and tagging the `kind:68002` job result. Customers SHOULD pay service providers whose job results they accept by either zapping the Service Provider and tagging the `kind:65001` job result or, if included, paying the bolt11 invoice.
Additionally, if a service provider requests full or partial prepayment via a `kind:68003` job-feedback event, the customer SHOULD zap that event to pay the service provider. Additionally, if a service provider requests full or partial prepayment via a `kind:65000` job-feedback event, the customer SHOULD zap that event to pay the service provider.
# Cancellation # Cancellation
A `kind:68001` job request might be cancelled by publishing a `kind:5` delete request event tagging the job request event. A job request might be cancelled by publishing a `kind:5` delete request event tagging the job request event.
# Job chaining # Job chaining
A Customer MAY request multiple jobs to be processed in a chained form, so that the output of a job can be the input of the next job. (e.g. summarization of a podcast's transcription). This is done by specifying as `input` an eventID of a different job with the `job` marker. A Customer MAY request multiple jobs to be processed in a chained form, so that the output of a job can be the input of the next job. (e.g. summarization of a podcast's transcription). This is done by specifying as `input` an eventID of a different job with the `job` marker.
@ -116,17 +116,31 @@ A Customer MAY request multiple jobs to be processed in a chained form, so that
Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted. Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted.
# Job Feedback # Job Feedback
The parties to a job request can use `kind:65000` to provide feedback about the job, using a `status` tag to indicate the type of feedback.
## Job request reactions Any job feedback event MIGHT include an `amount` tag, indicating the amount of millisats the party is requesting to be paid. An optional third value can be a bolt11 invoice.
Service Providers might opt to give feedback about a job.
### E.g. Payment required | status | description |
|--------|-------------|
| `payment-required` | Service Provider requires payment before continuing. |
| `processing` | Service Provider is processing the job. |
| `error` | Service Provider was unable to process the job. |
| `success` | Service Provider successfully processed the job. |
| `failure` | Service Provider failed to process the job. |
| `partial` | Service Provider partially processed the job. The `.content` might include a sample of the partial results. |
Any job feedback event MIGHT include an `amount` tag, as described in the [Job Result](#job-result) section.
Any job feedback event MIGHT include results in the `.content` field, as described in the [Job Result](#job-result) section.
### E.g. Payment required (with sample content)
```json ```json
{ {
"kind": 68003, "kind": 65000,
"content": "Please pay 7 sats for job xxxx", "content": "This is the transcription service that you",
"tags": [ "tags": [
[ "e", <job-request-id> ], [ "e", <job-request-id>, <relay-hint> ],
[ "p", <customer-pubkey> ],
[ "status", "payment-required" ], [ "status", "payment-required" ],
[ "amount", "7000" ], [ "amount", "7000" ],
] ]
@ -144,153 +158,160 @@ Service providers are at obvious risk of having their results not compensated. M
It's out of scope (and undesirable) to have this NIP address this issue; the market should. It's out of scope (and undesirable) to have this NIP address this issue; the market should.
### Encrypted job requests
Not to be included in the first draft of this NIP, but encrypted job requests should be added. A few ways:
* publish job requests with some useful metadata of the job "e.g. length of audio to be transcribed", service providers offer to do the job, the customer replies with a NIP-04-like encrypted job requested encrypted with the service provider's pubkey.
# Appendix 1: Examples # Appendix 1: Examples
## Transcript of a podcast from second `900` to `930`. ## Transcript of a podcast from second `900` to `930`.
### `kind:68001`: Job Request ### `kind:65002`: Speech-to-text job request
```json ```json
{ {
"id": "12345", "id": "12345",
"pubkey": "abcdef", "pubkey": "abcdef",
"content": "", "content": "",
"kind": 65002,
"tags": [ "tags": [
[ "j", "speech-to-text" ],
[ "i", "https://bitcoin.review/episode1.mp3", "url" ], [ "i", "https://bitcoin.review/episode1.mp3", "url" ],
[ "params", "range", "900", "930" ], [ "params", "range", "900", "930" ],
[ "bid", "5000", "9000" ], [ "output", "text/vtt" ],
[ "bid", "50000" ],
[ "output", "text/plain" ] [ "output", "text/plain" ]
] ]
} }
``` ```
### `kind:68003`: Job Feedback: request for (partial) payment ### `kind:65001`: Job Feedback: request for (partial) payment
* The SP is signaling here that it won't start processing until 100 sats are paid
```json ```json
{ {
"kind": 68003, "kind": 65000,
"content": "", "content": "",
"tags": [ "tags": [
["e", "12345"], ["e", "12345"],
["p", "abcdef"], ["p", "abcdef"],
["status", "payment-required"], ["status", "payment-required"],
["amount", "1000"] ["amount", "100000"]
] ]
} }
``` ```
* User zaps 1000 sats to event kind:68003. * User zaps 100 sats to the `kind:65000` job-feedback
### `kind:68002`: Job fulfillment + request for remaining payment ### `kind:65001`: Job result + request for remaining payment
```json ```json
{ {
"content": "blah blah blah", "content": "blah blah blah",
"tags": [ "tags": [
["e", "12345"], ["e", "12345"],
["p", "abcdef"], ["p", "abcdef"],
["amount", "6000"] ["amount", "400000"]
] ]
} }
``` ```
## Summarization of a podcast ## Summarization of a podcast
User publishes two job requests at the same time.
User publishes two job requests at the same time in the order they should be executed. ### `kind:65002`: Job Request #1: speech-to-text
### `kind:68001`: Job Request #1
```json ```json
{ {
"id": "12345", "id": "12345",
"pubkey": "abcdef", "pubkey": "abcdef",
"kinds" 65002,
"content": "I need a transcript of Bitcoin.review from second 900 to 930", "content": "I need a transcript of Bitcoin.review from second 900 to 930",
"tags": [ "tags": [
[ "j", "speech-to-text" ],
[ "params", "range", "900", "930" ],
[ "i", "https://bitcoin.review/episode1.mp3", "url" ], [ "i", "https://bitcoin.review/episode1.mp3", "url" ],
[ "bid", "5000", "9000" ] [ "output", "text/plain" ],
[ "params", "range", "900", "930" ],
[ "bid", "100000" ]
] ]
} }
``` ```
### `kind:68001`: Job Request #2 ### `kind:65003`: Job Request #2: summarization of job #1's result
```json ```json
{ {
"id": "12346", "id": "12346",
"pubkey": "abcdef", "pubkey": "abcdef",
"kinds": 65003,
"content": "", "content": "",
"tags": [ "tags": [
[ "j", "summarization" ],
[ "params", "length", "3 paragraphs" ],
[ "i", "12346", "job" ], [ "i", "12346", "job" ],
[ "bid", "300", "900" ] [ "output", "text/plain" ],
[ "params", "length", "3 paragraphs" ],
[ "bid", "10000" ]
] ]
} }
``` ```
## Translation of a note ## Translation of a note
### `kind:68001`: Job Request #1 ### `kind:65004`: Job Request #1: translation of an existing note
```json ```json
{ {
"id": "12346", "id": "12346",
"pubkey": "abcdef", "pubkey": "abcdef",
"content": "", "content": "",
"kinds": 65004,
"tags": [ "tags": [
[ "j", "translation" ],
[ "i", "<hexid>", "event", "wss://relay.nostr.com" ] [ "i", "<hexid>", "event", "wss://relay.nostr.com" ]
[ "params", "language", "es_AR" ], [ "params", "lang", "es_AR" ],
[ "bid", "100", "500" ] [ "bid", "5000" ]
] ]
} }
``` ```
### `kind:68003`: Job respomse ### `kind:65001`: Job respomse
```json ```json
{ {
"kind": 68003, "kind": 65001,
"content": "Che, que copado, boludo!", "content": "Che, que copado, boludo!",
"tags": [ "tags": [
["e", "12346"], ["e", "12346"],
["p", "abcdef"], ["p", "abcdef"],
["amount", "1000"] ["amount", "4000"]
] ]
} }
``` ```
## AI-image of the summarization of 2 podcasts ## AI-image of the summarization of 2 podcasts
### `kind:68001`: Job request #1 (transcribe podcast #1) ### `kind:65002`: Job request #1 (transcribe podcast #1)
```json ```json
{ {
"id": "123", "id": "123",
"kind" 65002,
"tags": [ "tags": [
[ "j", "speech-to-text" ],
[ "i", "https://example.com/episode1.mp3", "url" ], [ "i", "https://example.com/episode1.mp3", "url" ],
[ "bid", "100", "500" ] [ "bid", "100000" ]
] ]
} }
``` ```
### `kind:68001`: Job request #2 (transcribe podcast #2) ### `kind:65002`: Job request #2 (transcribe podcast #2)
```json ```json
{ {
"id": "124", "id": "124",
"kind" 65002,
"tags": [ "tags": [
[ "j", "speech-to-text" ],
[ "i", "https://example.com/episode2.mp3", "url" ], [ "i", "https://example.com/episode2.mp3", "url" ],
[ "bid", "100", "500" ] [ "bid", "100000" ]
] ]
} }
``` ```
### `kind:68001`: Job request #3 (summarize both podcasts into one podcast) ### `kind:65003`: Job request #3 (summarize both podcasts into one paragraph)
```json ```json
{ {
"id": "125", "id": "125",
"kind": 65003,
"tags": [ "tags": [
[ "j", "summarize" ],
[ "param", "length", "1 paragraph" ], [ "param", "length", "1 paragraph" ],
[ "i", "123", "job" ], [ "i", "123", "job" ],
[ "i", "124", "job" ], [ "i", "124", "job" ],
[ "bid", "100", "500" ] [ "bid", "100000" ]
] ]
} }
``` ```
@ -299,29 +320,45 @@ User publishes two job requests at the same time in the order they should be exe
This NIP defines some example job types, Customers SHOULD specify these types for maximum compatibility with Service Providers. Other job types MAY be added to this NIP after being observed in the wild. This NIP defines some example job types, Customers SHOULD specify these types for maximum compatibility with Service Providers. Other job types MAY be added to this NIP after being observed in the wild.
### `speech-to-text` ### speech-to-text: `kind:65002`
#### params #### params
| param | req? | description | param | req? | description
|--------------------------------|------|-------- |--------------------------------|------|--------
| `range` | opt | timestamp range (in seconds) of desired text to be transcribed | `range` | opt | timestamp range (in seconds) of desired text to be transcribed
| `alignment` | opt | word, segment, raw: word-level, segment-level or raw outputs | `alignment` | opt | word, segment, raw: word-level, segment-level or raw outputs
### `summarization` ### summarization: `kind:65003`
| param | req? | description | param | req? | description
|--------------------------------|------|-------- |--------------------------------|------|--------
| `length` | opt | desired length | `length` | opt | desired length
### `translation` -- Translate text to a specific language ### translation: `kind:65004`
#### params
| param | req? | description | param | req? | description
|--------------------------------|------|-------- |--------------------------------|------|--------
| `language` | req | requested language in BCP 47 format. | `lang` | req | desired language in BCP 47 format.
### image generation: `kind:65005`
* `input`
# Notes # Notes
* Should there be a possibility of getting the job result delivered encrypted? I don't like it but maybe it should be supported. * Job acceptance ambiguity, particularly for job-chaining circumstances is deliberate: service providers could wait until explicit job result acceptance / payment to start working on the next item on the chain, or they could start working as soon as they see a result of the previous job computed.
* Ambiguity on job acceptance, particularly for job-chaining circumstances is deliberately ambiguous: service providers could wait until explicit job result acceptance / payment to start working on the next item on the chain, or they could start working as soon as they see a result of the previous job computed.
That's up to each service provider to choose how to behave depending on the circumstances. This gives a higher level of flexibility to service providers (which sophisticated service providers would take anyway). That's up to each service provider to choose how to behave depending on the circumstances. This gives a higher level of flexibility to service providers (which sophisticated service providers would take anyway).
# Appendix 3: Service provider discoverability
Service Providers can use NIP-89 announcements to advertise their support for job kinds:
```json
{
"kind": 31990,
"pubkey": <pubkey>,
"tags": [
[ "k", 65002 ], // e.g. speech-to-text
[ "t", "bitcoin" ] // e.g. optionally advertises it specializes in bitcoin audio transcription that won't confuse "Drivechains" with "Ridechains"
]
}
```
Customers can use NIP-89 to see what service providers their follows use.