upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/61.md
diff options
context:
space:
mode:
authorfiatjaf_ <fiatjaf@gmail.com>2025-02-03 22:36:27 -0300
committerGitHub <noreply@github.com>2025-02-03 22:36:27 -0300
commit5a857e8bf8b88e14a98b1fcff4932034091c9b5c (patch)
tree0ccfa9eef2148d560ae1096078dbc491401c43e5 /61.md
parent93568e39717cd61ff855dc24e4f0ee30a6051f6c (diff)
nip60/61 updates and simplifications (#1730)
Co-authored-by: Tiago Balas <eskema23@gmail.com>
Diffstat (limited to '61.md')
-rw-r--r--61.md88
1 files changed, 39 insertions, 49 deletions
diff --git a/61.md b/61.md
index 8246203..fdcc2b6 100644
--- a/61.md
+++ b/61.md
@@ -1,14 +1,19 @@
1# NIP-61: 1NIP-61
2## Nut Zaps 2======
3 3
4A Nut Zap is a P2PK cashu token where the payment itself is the receipt. 4Nutzaps
5-------
6
7`draft` `optional`
8
9A Nutzap is a P2PK Cashu token in which the payment itself is the receipt.
5 10
6# High-level flow 11# High-level flow
7Alice wants to nutzap 1 sat to Bob because of an event `event-id-1` she liked. 12Alice wants to nutzap 1 sat to Bob because of an event `event-id-1` she liked.
8 13
9## Alice nutzaps Bob 14## Alice nutzaps Bob
101. Alice fetches event `kind:10019` from Bob to see the mints Bob trusts. 151. Alice fetches event `kind:10019` from Bob to see the mints Bob trusts.
112. She mints a token at that mint (or swaps some tokens she already had in that mint) p2pk-locked to the pubkey Bob has listed in his `kind:10019`. 162. She mints a token at that mint (or swaps some tokens she already had in that mint) P2PK-locked to the pubkey Bob has listed in his `kind:10019`.
123. She publishes a `kind:9321` event to the relays Bob indicated with the proofs she minted. 173. She publishes a `kind:9321` event to the relays Bob indicated with the proofs she minted.
13 18
14## Bob receives the nutzap 19## Bob receives the nutzap
@@ -29,16 +34,15 @@ Alice wants to nutzap 1 sat to Bob because of an event `event-id-1` she liked.
29} 34}
30``` 35```
31 36
32`kind:10019` is an event that is useful for others to know how to send money to the user. 37* `kind:10019` is an event that is useful for others to know how to send money to the user.
33 38* `relay`: relays where the user will be reading token events from. If a user wants to send money to the user, they should write to these relays.
34* `relay` - Relays where the user will be reading token events from. If a user wants to send money to the user, they should write to these relays. 39* `mint`: mints the user is explicitly agreeing to use to receive funds on. Clients SHOULD not send money on mints not listed here or risk burning their money. Additional markers can be used to list the supported base units of the mint.
35* `mint` - Mints the user is explicitly agreeing to use to receive funds on. Clients SHOULD not send money on mints not listed here or risk burning their money. Additional markers can be used to list the supported base units of the mint. 40* `pubkey`: Public key that MUST be used to P2PK-lock receiving nutzaps -- implementations MUST NOT use the target user's main Nostr public key. This public key corresponds to the `privkey` field encrypted in a user's [nip-60](60.md) _wallet event_.
36* `pubkey` - Pubkey that SHOULD be used to P2PK-lock receiving nutzaps. If not present, clients SHOULD use the pubkey of the recipient. This is explained in Appendix 1.
37 41
38## Nutzap event 42## Nutzap event
39Event `kind:9321` is a nutzap event published by the sender, p-tagging the recipient. The outputs are P2PK-locked to the pubkey the recipient indicated in their `kind:10019` event or to the recipient pubkey if the `kind:10019` event doesn't have a explicit pubkey. 43Event `kind:9321` is a nutzap event published by the sender, p-tagging the recipient. The outputs are P2PK-locked to the public key the recipient indicated in their `kind:10019` event.
40 44
41Clients MUST prefix the pubkey they p2pk-lock with `"02"` (for nostr<>cashu pubkey compatibility). 45Clients MUST prefix the public key they P2PK-lock with `"02"` (for nostr<>cashu compatibility).
42 46
43```jsonc 47```jsonc
44{ 48{
@@ -46,48 +50,41 @@ Clients MUST prefix the pubkey they p2pk-lock with `"02"` (for nostr<>cashu pubk
46 content: "Thanks for this great idea.", 50 content: "Thanks for this great idea.",
47 pubkey: "sender-pubkey", 51 pubkey: "sender-pubkey",
48 tags: [ 52 tags: [
49 [ "amount", "1" ],
50 [ "unit", "sat" ],
51 [ "proof", "{\"amount\":1,\"C\":\"02277c66191736eb72fce9d975d08e3191f8f96afb73ab1eec37e4465683066d3f\",\"id\":\"000a93d6f8a1d2c4\",\"secret\":\"[\\\"P2PK\\\",{\\\"nonce\\\":\\\"b00bdd0467b0090a25bdf2d2f0d45ac4e355c482c1418350f273a04fedaaee83\\\",\\\"data\\\":\\\"02eaee8939e3565e48cc62967e2fde9d8e2a4b3ec0081f29eceff5c64ef10ac1ed\\\"}]\"}" ], 53 [ "proof", "{\"amount\":1,\"C\":\"02277c66191736eb72fce9d975d08e3191f8f96afb73ab1eec37e4465683066d3f\",\"id\":\"000a93d6f8a1d2c4\",\"secret\":\"[\\\"P2PK\\\",{\\\"nonce\\\":\\\"b00bdd0467b0090a25bdf2d2f0d45ac4e355c482c1418350f273a04fedaaee83\\\",\\\"data\\\":\\\"02eaee8939e3565e48cc62967e2fde9d8e2a4b3ec0081f29eceff5c64ef10ac1ed\\\"}]\"}" ],
52 [ "u", "https://stablenut.umint.cash", ], 54 [ "u", "https://stablenut.umint.cash" ],
53 [ "e", "<zapped-event-id>", "<relay-hint>" ], 55 [ "e", "<zapped-event-id>", "<relay-hint>" ],
54 [ "p", "e9fbced3a42dcf551486650cc752ab354347dd413b307484e4fd1818ab53f991" ], // recipient of nut zap 56 [ "p", "e9fbced3a42dcf551486650cc752ab354347dd413b307484e4fd1818ab53f991" ], // recipient of nutzap
55 ] 57 ]
56} 58}
57``` 59```
58 60
59* `.content` is an optional comment for the nutzap 61* `.content` is an optional comment for the nutzap
60* `amount` is a shorthand for the combined amount of all outputs. -- Clients SHOULD validate that the sum of the amounts in the outputs matches. 62* `.tags`:
61* `unit` is the base unit of the amount. 63 * `proof` is one ore more proofs P2PK-locked to the public key the recipient specified in their `kind:10019` event and including a DLEQ proof.
62* `proof` is one ore more proofs p2pk-locked to the pubkey the recipient specified in their `kind:10019` event. 64 * `u` is the mint the URL of the mint EXACTLY as specified by the recipient's `kind:10019`.
63* `u` is the mint the URL of the mint EXACTLY as specified by the recipient's `kind:10019`. 65 * `p` is the Nostr identity public key of nutzap recipient.
64* `e` zero or one event that is being nutzapped. 66 * `e` is the event that is being nutzapped, if any.
65* `p` exactly one pubkey, specifying the recipient of the nutzap.
66
67WIP: Clients SHOULD embed a DLEQ proof in the nutzap event to make it possible to verify nutzaps without talking to the mint.
68 67
69# Sending a nutzap 68# Sending a nutzap
70 69
71* The sender fetches the recipient's `kind:10019`. 70* The sender fetches the recipient's `kind:10019`.
72* The sender mints/swaps ecash on one of the recipient's listed mints. 71* The sender mints/swaps ecash on one of the recipient's listed mints.
73* The sender p2pk locks to the recipient's specified pubkey in their `kind:10019` 72* The sender P2PK-locks to the recipient's specified public key in their `kind:10019`
74 73
75# Receiving nutzaps 74# Receiving nutzaps
76 75
77Clients should REQ for nut zaps: 76Clients should REQ for nutzaps:
78* Filtering with `#u` for mints they expect to receive ecash from. 77* Filtering with `#u` for mints they expect to receive ecash from.
79 * this is to prevent even interacting with mints the user hasn't explicitly signaled. 78 * this is to prevent even interacting with mints the user hasn't explicitly signaled.
80* Filtering with `since` of the most recent `kind:7376` event the same user has created. 79* Filtering with `since` of the most recent `kind:7376` event the same user has created.
81 * this can be used as a marker of the nut zaps that have already been swaped by the user -- clients might choose to use other kinds of markers, including internal state -- this is just a guidance of one possible approach. 80 * this can be used as a marker of the nutzaps that have already been swaped by the user -- clients might choose to use other kinds of markers, including internal state -- this is just a guidance of one possible approach.
82
83Clients MIGHT choose to use some kind of filtering (e.g. WoT) to ignore spam.
84 81
85`{ "kinds": [9321], "#p": "my-pubkey", "#u": [ "<mint-1>", "<mint-2>"], "since": <latest-created_at-of-kind-7376> }`. 82`{ "kinds": [9321], "#p": ["my-pubkey"], "#u": ["<mint-1>", "<mint-2>"], "since": <latest-created_at-of-kind-7376> }`.
86 83
87Upon receiving a new nut zap, the client should swap the tokens into a wallet the user controls, either a [[NIP-60]] wallet, their own LN wallet or anything else. 84Upon receiving a new nutzap, the client should swap the tokens into a wallet the user controls, either a [NIP-60](60.md) wallet, their own LN wallet or anything else.
88 85
89## Updating nutzap-redemption history 86## Updating nutzap-redemption history
90When claiming a token the client SHOULD create a `kind:7376` event and `e` tag the original nut zap event. This is to record that this token has already been claimed (and shouldn't be attempted again) and as signaling to the recipient that the ecash has been redeemed. 87When claiming a token the client SHOULD create a `kind:7376` event and `e` tag the original nutzap event. This is to record that this token has already been claimed (and shouldn't be attempted again) and as signaling to the recipient that the ecash has been redeemed.
91 88
92Multiple `kind:9321` events can be tagged in the same `kind:7376` event. 89Multiple `kind:9321` events can be tagged in the same `kind:7376` event.
93 90
@@ -96,7 +93,7 @@ Multiple `kind:9321` events can be tagged in the same `kind:7376` event.
96 "kind": 7376, 93 "kind": 7376,
97 "content": nip44_encrypt([ 94 "content": nip44_encrypt([
98 [ "direction", "in" ], // in = received, out = sent 95 [ "direction", "in" ], // in = received, out = sent
99 [ "amount", "1", "sat" ], 96 [ "amount", "1" ],
100 [ "e", "<7375-event-id>", "relay-hint", "created" ] // new token event that was created 97 [ "e", "<7375-event-id>", "relay-hint", "created" ] // new token event that was created
101 ]), 98 ]),
102 "tags": [ 99 "tags": [
@@ -107,26 +104,19 @@ Multiple `kind:9321` events can be tagged in the same `kind:7376` event.
107} 104}
108``` 105```
109 106
110Events that redeem a nutzap SHOULD be published to the sender's [[NIP-65]] relays. 107Events that redeem a nutzap SHOULD be published to the sender's [NIP-65](65.md) "read" relays.
111 108
112## Verifying a Cashu Zap 109## Verifying a Cashu Zap
113* Clients SHOULD check that the receiving user has issued a `kind:10019` tagging the mint where the cashu has been minted. 110When listing or counting zaps received by any given event, observer clients SHOULD:
114* Clients SHOULD check that the token is locked to the pubkey the user has listed in their `kind:10019`.
115 111
116## Final Considerations 112* check that the receiving user has issued a `kind:10019` tagging the mint where the cashu has been minted.
113* check that the token is locked to the pubkey the user has listed in their `kind:10019`.
114* look at the `u` tag and check that the token is issued in one of the mints listed in the `kind:10019`.
115* locally verify the DLEQ proof of the tokens being sent.
117 116
1181. Clients SHOULD guide their users to use NUT-11 (P2PK) compatible-mints in their `kind:10019` event to avoid receiving nut zaps anyone can spend 117All these checks can be done offline (as long as the observer has the receiver mints' keyset and their `kind:10019` event), so the process should be reasonably fast.
119 118
119## Final Considerations
1201. Clients SHOULD guide their users to use NUT-11 (P2PK) and NUT-12 (DLEQ proofs) compatible-mints in their `kind:10019` event to avoid receiving nutzaps anyone can spend.
1202. Clients SHOULD normalize and deduplicate mint URLs as described in NIP-65. 1212. Clients SHOULD normalize and deduplicate mint URLs as described in NIP-65.
121 1223. A nutzap event MUST include proofs in one of the mints the recipient has listed in their `kind:10019` and published to the NIP-65 relays of the recipient, failure to do so may result in the recipient donating the tokens to the mint since the recipient might never see the event.
1223. A nut zap MUST be sent to a mint the recipient has listed in their `kind:10019` event or to the NIP-65 relays of the recipient, failure to do so may result in the recipient donating the tokens to the mint since the recipient might never see the event.
123
124## Appendix 1: Alternative P2PK pubkey
125Clients might not have access to the user's private key (i.e. NIP-07, NIP-46 signing) and, as such, the private key to sign cashu spends might not be available, which would make spending the P2PK incoming nutzaps impossible.
126
127For this scenarios clients can:
128
129* add a `pubkey` tag to the `kind:10019` (indicating which pubkey senders should P2PK to)
130* store the private key in the `kind:37375` event in the nip44-encrypted `content` field.
131
132This is to avoid depending on NIP-07/46 adaptations to sign cashu payloads.