Skip to content

docs: update message examples to protocol version 2 #51

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.

Sign up for GitHub

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

Merged
grunch merged 3 commits into from
Jul 29, 2026
Merged

docs: update message examples to protocol version 2 #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
24b1515
docs: update message examples to protocol version 2
grunch Jul 28, 2026
dc3fdee
docs: migrate v2 examples to NIP-44 direct transport
grunch Jul 29, 2026
2eaa0f3
docs: address review nits — request tuples, wording fixes
grunch Jul 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions src/add_bond_invoice.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Mostro sends a single `add-bond-invoice` message to the non-slashed counterparty
[
{
"order": {
"version": 1,
"version": 2,
"id": "<Order Id>",
"action": "add-bond-invoice",
"payload": {
Expand All @@ -35,6 +35,7 @@ Mostro sends a single `add-bond-invoice` message to the non-slashed counterparty
}
}
},
null,
null
]
```
Expand All @@ -58,13 +59,13 @@ deadline = slashed_at + bond_payout_claim_window_days * 86_400

## Counterparty → Mostro (reply)

The counterparty replies with a Gift wrap Nostr event whose rumor content carries the bolt11 inside the standard `payment_request` array. The invoice carries its own amount, so the array has two elements (per [Payment Request Array Structure](./overview.md#payment-request-array-structure)):
The counterparty replies with a NIP-44 direct message (kind `14`) whose decrypted content carries the bolt11 inside the standard `payment_request` array. The invoice carries its own amount, so the array has two elements (per [Payment Request Array Structure](./overview.md#payment-request-array-structure)):

```json
[
{
"order": {
"version": 1,
"version": 2,
"id": "<Order Id>",
"action": "add-bond-invoice",
"payload": {
Expand All @@ -75,7 +76,8 @@ The counterparty replies with a Gift wrap Nostr event whose rumor content carrie
}
}
},
"<index N signature of the sha256 hash of the serialized first element of content>"
"<index N signature of the sha256 hash of the serialized first element of content>",
["<index 0 pubkey (identity key)>", "<index 0 identity proof signature>"]
]
```

Expand Down Expand Up @@ -111,7 +113,7 @@ Sent by Mostro to the counterparty immediately after successfully receiving and
[
{
"order": {
"version": 1,
"version": 2,
"id": "<Order Id>",
"action": "bond-invoice-accepted",
"payload": {
Expand All @@ -127,6 +129,7 @@ Sent by Mostro to the counterparty immediately after successfully receiving and
}
}
},
null,
null
]
```
Expand All @@ -141,7 +144,7 @@ Sent by Mostro to the counterparty when the Lightning payment to their invoice h
[
{
"order": {
"version": 1,
"version": 2,
"id": "<Order Id>",
"action": "bond-payout-completed",
"payload": {
Expand All @@ -157,6 +160,7 @@ Sent by Mostro to the counterparty when the Lightning payment to their invoice h
}
}
},
null,
null
]
```
Expand Down
9 changes: 6 additions & 3 deletions src/admin_add_solver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,14 @@ The default remains `read-write` for backward compatibility.
[
{
"order": {
"version": 1,
"version": 2,
"action": "admin-add-solver",
"payload": {
"text_message": "npub1qqq884wtp2jn96lqhqlnarl4kk3rmvrc9z2nmrvqujx3m4l2ea5qd5d0fq"
}
}
},
null,
null
]
```
Expand All @@ -49,13 +50,14 @@ The default remains `read-write` for backward compatibility.
[
{
"order": {
"version": 1,
"version": 2,
"action": "admin-add-solver",
"payload": {
"text_message": "npub1qqq884wtp2jn96lqhqlnarl4kk3rmvrc9z2nmrvqujx3m4l2ea5qd5d0fq:read"
}
}
},
null,
null
]
```
Expand All @@ -68,11 +70,12 @@ Mostro sends this message to the admin:
[
{
"order": {
"version": 1,
"version": 2,
"action": "admin-add-solver",
"payload": null
}
},
null,
null
]
```
9 changes: 6 additions & 3 deletions src/admin_cancel_order.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ An admin can cancel an order, most of the time this is done when admin is solvin
[
{
"order": {
"version": 1,
"version": 2,
"id": "<Order Id>",
"action": "admin-cancel",
"payload": null
}
},
null,
null
]
```
Expand All @@ -24,7 +25,7 @@ When solving a dispute, the admin can optionally slash one or both parties' bond
[
{
"order": {
"version": 1,
"version": 2,
"id": "<Order Id>",
"action": "admin-cancel",
"payload": {
Expand All @@ -35,6 +36,7 @@ When solving a dispute, the admin can optionally slash one or both parties' bond
}
}
},
null,
null
]
```
Expand All @@ -61,12 +63,13 @@ Mostro will send this message to the both parties buyer/seller and to the admin:
[
{
"order": {
"version": 1,
"version": 2,
"id": "<Order Id>",
"action": "admin-canceled",
"payload": null
}
},
null,
null
]
```
Expand Down
9 changes: 6 additions & 3 deletions src/admin_settle_order.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ An admin can settle an order, most of the time this is done when admin is solvin
[
{
"order": {
"version": 1,
"version": 2,
"id": "<Order Id>",
"action": "admin-settle",
"payload": null
}
},
null,
null
]
```
Expand All @@ -24,7 +25,7 @@ When solving a dispute, the admin can optionally slash one or both parties' bond
[
{
"order": {
"version": 1,
"version": 2,
"id": "<Order Id>",
"action": "admin-settle",
"payload": {
Expand All @@ -35,6 +36,7 @@ When solving a dispute, the admin can optionally slash one or both parties' bond
}
}
},
null,
null
]
```
Expand All @@ -61,12 +63,13 @@ Mostro will send this message to the both parties buyer/seller and to the admin:
[
{
"order": {
"version": 1,
"version": 2,
"id": "<Order Id>",
"action": "admin-settled",
"payload": null
}
},
null,
null
]
```
Expand Down
3 changes: 2 additions & 1 deletion src/bond_slashed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The `bond-slashed` action is a notification Mostro sends to a bonded party when
[
{
"order": {
"version": 1,
"version": 2,
"id": "<Order Id>",
"action": "bond-slashed",
"payload": {
Expand All @@ -34,6 +34,7 @@ The `bond-slashed` action is a notification Mostro sends to a bonded party when
}
}
},
null,
null
]
```
Expand Down
29 changes: 18 additions & 11 deletions src/cancel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,37 @@
# Cancel Order

A user can cancel an order created by himself and with status `pending` sending action `cancel`, the rumor's content of the message will look like this:
A user can cancel an order created by himself and with status `pending` sending action `cancel`, the decrypted content of the message will look like this:

```json
[
{
"order": {
"version": 1,
"version": 2,
"id": "<Order Id>",
"action": "cancel",
"payload": null
}
},
"<index N signature of the sha256 hash of the serialized first element of content>"
"<index N signature of the sha256 hash of the serialized first element of content>",
["<index 0 pubkey (identity key)>", "<index 0 identity proof signature>"]
]
```

## Mostro response
## Mostro's response

Mostro will send a message with action `cancel` confirming the order was canceled, here an example of rumor's content of the message:
Mostro will send a message with action `cancel` confirming the order was canceled, here an example of decrypted content of the message:

```json
[
{
"order": {
"version": 1,
"version": 2,
"id": "<Order Id>",
"action": "canceled",
"payload": null
}
},
null,
null
]
```
Expand Down Expand Up @@ -97,12 +99,13 @@ A user can cancel an `active` order, but will need the counterparty to agree, le
[
{
"order": {
"version": 1,
"version": 2,
"id": "<Order Id>",
"action": "cancel",
"payload": null
}
},
null,
null
]
```
Expand All @@ -113,12 +116,13 @@ Mostro will send this message to the seller:
[
{
"order": {
"version": 1,
"version": 2,
"id": "<Order Id>",
"action": "cooperative-cancel-initiated-by-you",
"payload": null
}
},
null,
null
]
```
Expand All @@ -129,12 +133,13 @@ And this message to the buyer:
[
{
"order": {
"version": 1,
"version": 2,
"id": "<Order Id>",
"action": "cooperative-cancel-initiated-by-peer",
"payload": null
}
},
null,
null
]
```
Expand All @@ -145,12 +150,13 @@ The buyer can accept the cooperative cancellation sending this message:
[
{
"order": {
"version": 1,
"version": 2,
"id": "<Order Id>",
"action": "cancel",
"payload": null
}
},
null,
null
]
```
Expand All @@ -161,12 +167,13 @@ And Mostro will send this message to both parties:
[
{
"order": {
"version": 1,
"version": 2,
"id": "<Order Id>",
"action": "cooperative-cancel-accepted",
"payload": null
}
},
null,
null
]
```
Expand Down
Loading