add more advanced nip89 default parameters to NIP90

This commit is contained in:
dbth 2024-11-22 11:51:34 +01:00 committed by GitHub
parent 397d149ff3
commit f07d71456f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

27
90.md
View File

@ -219,8 +219,18 @@ Service Providers MAY use NIP-89 announcements to advertise their support for jo
\"name\": \"Translating DVM\",
\"picture\": \"https://domain.com/profile.jpg\",
\"lud16\": \"zap@address.com\",
\"encryptionSupported\": true,
\"about\": \"I'm a DVM specialized in translating Bitcoin content.\"
\"supportsEncryption\": true,
\"acceptsNutZaps\": true,
\"personalized\": true,
\"amount\": \"flexible\",
\"nip90Params\"": {
\"mode\": {
\"required\": False,
\"values\": ["best", "classic", "fast", "negative"],
\"description\": "Method to do the translation"
},
}
}",
"tags": [
["k", "5005"], // e.g. translation
@ -230,4 +240,19 @@ Service Providers MAY use NIP-89 announcements to advertise their support for jo
}
```
Params:
name: Name of the DVM
picture: Link to a NIP89 preview picture of the DVM
lud16: The DVM's lud16
about: A description of what the DVM does
supportsEncryption: true or false, depending on whether DVM accepts encrypted requests. default: false
acceptsNutZaps: true or false, depending on whether the DVM accepts Nutzaps. default: false
amount: free, flexible, $amountinsats, signal whether the dvm is free, has a flexible price or name the fix amount of sats it will ask for. default: none/unknown
subscription: true or false, signal whether the DVM requires a subscription. default: false
personalized: true or false, signal whether the result is personalized or not (e.g. for feeds). default: false
action: "follow", "unfollow", "mute" "unmute". Signal to a client that it can perform an action with the results, e.g. for a user list. default: none
nip90Params: a list of parameters that change the processing of the DVM, for example a method, model or other specifig input parameters. default: {}
Everything besides name, picture, about and lud16 is optional and clients should assume default params, if not defined otherwise.
Customers can use NIP-89 to see what service providers their follows use.