nostr/nips
1
0
Fork 0
mirror of https://github.com/nostr-protocol/nips.git synced 2024-11-14 07:49:07 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update 15.md

Browse Source
This commit is contained in:
Acea Spades 2024-08-25 00:11:18 -07:00 committed by GitHub
parent 6c16f8e2c9
commit 0d7914b145
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 31 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
15.md
View File

@ -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). 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 ## Terms
- `merchant` - seller of products with NOSTR key-pair - `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 ## 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 ### Merchant admin
Where the `merchant` creates, updates and deletes `stalls` and `products`, as well as where they manage sales, payments and communication with `customers`. 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). | | `0` | `set_meta` | The merchant description (similar with any `nostr` public key). |
| `5` | `delete` | Delete a product or a stall. | | `5` | `delete` | Delete a product or a stall. |
| `14` | `direct_message` | Communicate with the customer. The messages can be plain-text or JSON. | | `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. | | `1022` | `bid_success` | Merchant accepts customer's bid for auctioned product. |
| `30017` | `set_stall` | Create or update a stall. | | `30017` | `set_stall` | Create or update a stall. |
| `30018` | `set_product` | Create or update a product. | | `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 | | `30020` | `set_auction` | Create or update a product sold as an auction |
| `30030` | `request_payment` | Merchant requests payment for order from customer. | | `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. | | `30032` | `confirm_payment` | Merchant confirms payment is received for order. |
| `30033` | `confirm_shipment` | Merchant confirms order has been shipped. | | `30033` | `confirm_shipment` | Merchant confirms order has been shipped. |