-
Notifications
You must be signed in to change notification settings - Fork 5
docs: Add dispute chat documentation #23
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
AndreaDiazCorreia
wants to merge
2
commits into
MostroP2P:main
Choose a base branch
from
AndreaDiazCorreia:feat/dispute-chat-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| # Dispute Chat | ||
|
|
||
| Once an admin takes a dispute, both the admin and the involved parties (buyer and seller) can communicate through an encrypted chat using Gift Wrap messages (NIP-59). | ||
|
|
||
| ## Sending a message | ||
|
|
||
| Users and admins send messages using action `send-dm`. The message content is wrapped in a Gift Wrap event (kind 1059) to ensure privacy and encryption. | ||
|
|
||
| ### User sending a message | ||
|
|
||
| Here is an example of a user sending a message to the admin: | ||
|
|
||
| ```json | ||
| [ | ||
| { | ||
| "dm": { | ||
| "version": 1, | ||
| "action": "send-dm", | ||
| "payload": { | ||
| "text_message": "Hello, I need help with this order" | ||
| } | ||
| } | ||
| }, | ||
| null | ||
| ] | ||
| ``` | ||
|
|
||
| ### Admin sending a message | ||
|
|
||
| Admins use the same format to send messages to users: | ||
|
|
||
| ```json | ||
| [ | ||
| { | ||
| "dm": { | ||
| "version": 1, | ||
| "action": "send-dm", | ||
| "payload": { | ||
| "text_message": "I'm reviewing the evidence, please wait" | ||
| } | ||
| } | ||
| }, | ||
| null | ||
| ] | ||
| ``` | ||
|
|
||
| ## Receiving messages | ||
|
|
||
| Clients must subscribe to kind 1059 events with a `p` tag matching their pubkey. The Gift Wrap protocol (NIP-59) ensures that only the intended recipient can decrypt and read the messages, while preserving the sender's identity through the SEAL layer | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.