From 0d7914b145e619b57112ae92ceaba8c484067bda Mon Sep 17 00:00:00 2001 From: Acea Spades Date: Sun, 25 Aug 2024 00:11:18 -0700 Subject: [PATCH] Update 15.md --- 15.md | 34 +++++++++++++++++++++++++++++++--- 1 file changed, 31 insertions(+), 3 deletions(-) diff --git a/15.md b/15.md index 2d62db86..4fc6ba80 100644 --- a/15.md +++ b/15.md @@ -10,6 +10,27 @@ Based on [Diagon-Alley](https://github.com/lnbits/Diagon-Alley). Implemented in [NostrMarket](https://github.com/lnbits/nostrmarket) and [Plebeian Market](https://github.com/PlebeianTech/plebeian-market). +## Kinds + +The following kinds are utilized by this NIP: + +| Kind | | Description | +| --------- | ------------------ | --------------------------------------------------------------------------------------------------------------- | +| `0` | `set_meta` | The merchant description (similar with any `nostr` public key). | +| `5` | `delete` | Delete a product or a stall. | +| `14` | `direct_message` | Communicate with the customer. The messages can be plain-text or JSON. | +| `1021` | `bid` | Customer places bid on auctioned product. | +| `1022` | `bid_success` | Merchant accepts customer's bid for auctioned product. | +| `30017` | `set_stall` | Create or update a stall. | +| `30018` | `set_product` | Create or update a product. | +| `30018` | `customize_market` | Save customizations for marketplace experience. | +| `30020` | `set_auction` | Create or update a product sold as an auction | +| `30030` | `request_payment` | Merchant requests payment for order from customer. | +| `30031` | `submit_order` | Customer submits order to merchant for product. | +| `30032` | `confirm_payment` | Merchant confirms payment is received for order. | +| `30033` | `confirm_shipment` | Merchant confirms order has been shipped. | + + ## Terms - `merchant` - seller of products with NOSTR key-pair @@ -20,6 +41,16 @@ Implemented in [NostrMarket](https://github.com/lnbits/nostrmarket) and [Plebeia ## Nostr Marketplace Clients +### Customer Events + +A customer can publish these events: +| Kind | | Description | +| --------- | ------------------ | --------------------------------------------------------------------------------------------------------------- | +| `14` | `direct_message` | Communicate with the merchant. The messages can be plain-text or JSON. | +| `1021` | `bid` | Customer places bid on auctioned product. | +| `30018` | `customize_market` | Save customizations for marketplace experience. | +| `30031` | `submit_order` | Customer submits order to merchant for product. | + ### Merchant admin Where the `merchant` creates, updates and deletes `stalls` and `products`, as well as where they manage sales, payments and communication with `customers`. @@ -38,14 +69,11 @@ A merchant can publish these events: | `0` | `set_meta` | The merchant description (similar with any `nostr` public key). | | `5` | `delete` | Delete a product or a stall. | | `14` | `direct_message` | Communicate with the customer. The messages can be plain-text or JSON. | -| `1021` | `bid` | Customer places bid on auctioned product. | | `1022` | `bid_success` | Merchant accepts customer's bid for auctioned product. | | `30017` | `set_stall` | Create or update a stall. | | `30018` | `set_product` | Create or update a product. | -| `30018` | `customize_market` | Save customizations for marketplace experience. | | `30020` | `set_auction` | Create or update a product sold as an auction | | `30030` | `request_payment` | Merchant requests payment for order from customer. | -| `30031` | `submit_order` | Customer submits order to merchant for product. | | `30032` | `confirm_payment` | Merchant confirms payment is received for order. | | `30033` | `confirm_shipment` | Merchant confirms order has been shipped. |