Merge pull request #56 from kehiy/report-07

bud-09: blob report.

README.md

@@ -15,22 +15,32 @@ Blobs are packs of binary data addressed by their sha256 hash
 Blossom Servers expose a few endpoints for managing blobs
 
 - `GET /<sha256>` (optional file `.ext`) [BUD-01](./buds/01.md#get-sha256---get-blob)
+
 - `HEAD /<sha256>` (optional file `.ext`) [BUD-01](./buds/01.md#head-sha256---has-blob)
+
 - `PUT /upload` [BUD-02](./buds/02.md#put-upload---upload-blob)
   - `Authentication`: Signed [nostr event](./buds/02.md#upload-authorization-required)
   - Return a blob descriptor
+
 - `HEAD /upload` [BUD-06](./buds/06.md#head-upload---upload-requirements)
+
 - `GET /list/<pubkey>` [BUD-02](./buds/02.md#get-listpubkey---list-blobs)
   - Returns an array of blob descriptors
   - `Authentication` _(optional)_: Signed [nostr event](./buds/02.md#list-authorization-optional)
+
 - `DELETE /<sha256>` [BUD-02](./buds/02.md#delete-sha256---delete-blob)
   - `Authentication`: Signed [nostr event](./buds/02.md#delete-authorization-required)
+
 - `PUT /mirror` [BUD-04](./buds/04.md#put-mirror---mirror-blob)
   - `Authentication`: Signed [nostr event](./buds/02.md#upload-authorization-required)
+
 - `HEAD /media` [BUD-05](./buds/05.md#head-media)
+
 - `PUT /media` [BUD-05](./buds/05.md#put-media)
   - `Authentication`: Signed [nostr event](./buds/05.md#upload-authorization)
 
+- `PUT /report` [BUD-09](./buds/09.md)
+
 ## Protocol specification (BUDs)
 
 BUDs stand for **Blossom Upgrade Documents**.
@@ -46,6 +56,7 @@ See the [BUDs](./buds) folder and specifically [BUD-01](./buds/01.md) and [BUD-0
 - [BUD-05: Media optimization](./buds/05.md)
 - [BUD-06: Upload requirements](./buds/06.md)
 - [BUD-08: Nostr File Metadata Tags](./buds/08.md)
+- [BUD-09: Blob Report](./buds/09.md)
 
 ## Event kinds
 

buds/09.md

@@ -0,0 +1,41 @@
+# BUD-09
+
+## Blob Report
+
+`draft` `optional`
+
+This bud defines a new endpoint for clients and users to report blobs to servers.
+
+
+### PUT /report - reporting a blob
+
+The request body MUST be a signed [NIP-56](https://github.com/nostr-protocol/nips/blob/master/56.md) report event with one or more `x` tags containing the hashes of the blobs being reported.
+
+Example:
+
+```jsonc
+{
+  "kind": 1984,
+  "tags": [
+    ["x", "<blob-sha256>", "<type-based-on-nip-56>"],
+    ["x", "<another-blob-sha256>", "<type-based-on-nip-56>"]
+  ],
+  "content": "<human readable report details>",
+  // other fields...
+}
+```
+
+The clients can include `e` or `p` tags to point to the event or the profile that contains this media if they want to make this report event useful for relays as well.
+
+Server MUST respond to a report request with a success code or a code in the 4xx/5xx range if there was any error.
+
+### Client behavior
+
+The clients can show a blob report button on posts or in blob details. Or its RECOMMENDED to merge this with normal nostr report and send it to both relays and blossom server. other clients can receive it from relays and hide or blur reported blob from trusted friends.
+
+### Server behavior
+
+The servers MAY keep the reports somewhere for operators to check and take action on them. they MAY use a list of trusted people or moderators to directly take action on blob without operator request. 
+
+Servers MAY consider removed blobs sha256 as blocked to prevent rewrite.
+Servers SHOULD advertise a route or landing page to provide their rules and term of service which affects the report process.