upleb.uk

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

summaryrefslogtreecommitdiff
path: root/60.md
diff options
context:
space:
mode:
authorfiatjaf <fiatjaf@gmail.com>2025-01-31 00:01:15 -0300
committerfiatjaf <fiatjaf@gmail.com>2025-01-31 00:01:15 -0300
commit1fe24a6149006649a471f2245ad8f66f87595498 (patch)
treef7810a741774574c854ea6229a13dcf906cd3ae8 /60.md
parent6a4b125ad771ac9da4a1347a1ed41185e30ad0cf (diff)
nip60/61 updates.
Diffstat (limited to '60.md')
-rw-r--r--60.md51
1 files changed, 28 insertions, 23 deletions
diff --git a/60.md b/60.md
index 8117412..23b56ac 100644
--- a/60.md
+++ b/60.md
@@ -1,5 +1,9 @@
1# NIP-60 1NIP-60
2## Cashu Wallet 2======
3
4Cashu Wallets
5-------------
6
3`draft` `optional` 7`draft` `optional`
4 8
5This NIP defines the operations of a cashu-based wallet. 9This NIP defines the operations of a cashu-based wallet.
@@ -22,19 +26,18 @@ This NIP doesn't deal with users' *receiving* money from someone else, it's just
22{ 26{
23 "kind": 37375, 27 "kind": 37375,
24 "content": nip44_encrypt([ 28 "content": nip44_encrypt([
25 [ "balance", "100", "sat" ], 29 [ "privkey", "hexkey" ],
26 [ "privkey", "hexkey" ] // explained in NIP-61 30 [ "name", "my shitposting wallet" ],
31 [ "description", "a wallet for my day-to-day shitposting" ],
32 [ "mint", "https://mint1" ]
33 // optionally "mint" and "unit" could go here
27 ]), 34 ]),
28 "tags": [ 35 "tags": [
29 [ "d", "my-wallet" ], 36 [ "d", "my-wallet" ],
30 [ "mint", "https://mint1" ],
31 [ "mint", "https://mint2" ], 37 [ "mint", "https://mint2" ],
32 [ "mint", "https://mint3" ], 38 [ "mint", "https://mint3" ],
33 [ "name", "my shitposting wallet" ], 39 [ "unit", "sat" ]
34 [ "unit", "sat" ], 40 // optionally "name" and "description" could go here
35 [ "description", "a wallet for my day-to-day shitposting" ],
36 [ "relay", "wss://relay1" ],
37 [ "relay", "wss://relay2" ],
38 ] 41 ]
39} 42}
40``` 43```
@@ -44,14 +47,13 @@ The wallet event is an addressable event `kind:37375`.
44Tags: 47Tags:
45* `d` - wallet ID. 48* `d` - wallet ID.
46* `mint` - Mint(s) this wallet uses -- there MUST be one or more mint tags. 49* `mint` - Mint(s) this wallet uses -- there MUST be one or more mint tags.
47* `relay` - Relays where the wallet and related events can be found. -- one ore more relays SHOULD be specified. If missing, clients should follow [[NIP-65]].
48* `unit` - Base unit of the wallet (e.g. "sat", "usd", etc). 50* `unit` - Base unit of the wallet (e.g. "sat", "usd", etc).
49* `name` - Optional human-readable name for the wallet. 51* `name` - Optional human-readable name for the wallet.
50* `description` - Optional human-readable description of the wallet. 52* `description` - Optional human-readable description of the wallet.
51* `balance` - Optional best-effort balance of the wallet that can serve as a placeholder while an accurate balance is computed from fetching all unspent proofs. 53* `balance` - Optional best-effort balance of the wallet that can serve as a placeholder while an accurate balance is computed from fetching all unspent proofs.
52* `privkey` - Private key used to unlock P2PK ecash. MUST be stored encrypted in the `.content` field. **This is a different private key exclusively used for the wallet, not associated in any way to the user's nostr private key** -- This is only used when receiving funds from others, described in NIP-61. 54* `privkey` - Private key used to unlock P2PK ecash. MUST be stored encrypted in the `.content` field. **This is a different private key exclusively used for the wallet, not associated in any way to the user's Nostr private key** -- This is only used for receiving [NIP-61](61.md) nutzaps.
53 55
54Any tag, other than the `d` tag, can be [[NIP-44]] encrypted into the `.content` field. 56The client or user MAY decide to put some tags either inside the encrypted `.content` or under the public `.tags`, `name` and `description`, for example. However, `d` MUST always be a public tag, and `mint` and `unit` must be public if the user intends to receive [NIP-61](61.md) nutzaps.
55 57
56### Deleting a wallet event 58### Deleting a wallet event
57Due to addressable event being hard to delete, if a user wants to delete a wallet, they should empty the event and keep just the `d` identifier and add a `deleted` tag. 59Due to addressable event being hard to delete, if a user wants to delete a wallet, they should empty the event and keep just the `d` identifier and add a `deleted` tag.
@@ -67,6 +69,7 @@ There can be multiple `kind:7375` events for the same mint, and multiple proofs
67 "content": nip44_encrypt({ 69 "content": nip44_encrypt({
68 "mint": "https://stablenut.umint.cash", 70 "mint": "https://stablenut.umint.cash",
69 "proofs": [ 71 "proofs": [
72 // one or more proofs in the default cashu format
70 { 73 {
71 "id": "005c2502034d4f12", 74 "id": "005c2502034d4f12",
72 "amount": 1, 75 "amount": 1,
@@ -74,8 +77,8 @@ There can be multiple `kind:7375` events for the same mint, and multiple proofs
74 "C": "0241d98a8197ef238a192d47edf191a9de78b657308937b4f7dd0aa53beae72c46" 77 "C": "0241d98a8197ef238a192d47edf191a9de78b657308937b4f7dd0aa53beae72c46"
75 } 78 }
76 ], 79 ],
77 // tokens that were destroyed in the creation of this token 80 // tokens that were destroyed in the creation of this token (helps on wallet state transitions)
78 "del": [ "token-id-1" ] 81 "del": [ "token-event-id-1", "token-event-id-2" ]
79 }), 82 }),
80 "tags": [ 83 "tags": [
81 [ "a", "37375:<pubkey>:my-wallet" ] 84 [ "a", "37375:<pubkey>:my-wallet" ]
@@ -84,13 +87,15 @@ There can be multiple `kind:7375` events for the same mint, and multiple proofs
84``` 87```
85 88
86 * `a` an optional tag linking the token to a specific wallet. 89 * `a` an optional tag linking the token to a specific wallet.
87 * `.content` is a [[NIP-44]] encrypted payload: 90 * `.content` is a [NIP-44](44.md) encrypted payload:
88 * `mint`: The mint the proofs belong to. 91 * `mint`: The mint the proofs belong to.
89 * `proofs`: unecoded proofs 92 * `proofs`: unecoded proofs
90 * `del`: token-ids that were destroyed by the creation of this token. This assists with state transitions. 93 * `del`: token-ids that were destroyed by the creation of this token. This assists with state transitions.
91 94
92### Spending proofs 95### Spending proofs
93When one or more proofs of a token are spent, the token event should be [[NIP-09]]-deleted and, if some proofs are unspent from the same token event, a new token event should be created rolling over the unspent proofs and adding any change outputs to the new token event. 96When one or more proofs of a token are spent, the token event should be [NIP-09](09.md)-deleted and, if some proofs are unspent from the same token event, a new token event should be created rolling over the unspent proofs and adding any change outputs to the new token event (the change output should include a `del` field).
97
98The `kind:5` _delete event_ created in the [NIP-09](09.md) process MUST have a tag `["k", "7375"]` to allow easy filtering by clients interested in state transitions.
94 99
95## Spending History Event 100## Spending History Event
96Clients SHOULD publish `kind:7376` events to create a transaction history when their balance changes. 101Clients SHOULD publish `kind:7376` events to create a transaction history when their balance changes.
@@ -115,14 +120,14 @@ Clients SHOULD publish `kind:7376` events to create a transaction history when t
115Clients MUST add `e` tags to create references of destroyed and created token events along with the marker of the meaning of the tag: 120Clients MUST add `e` tags to create references of destroyed and created token events along with the marker of the meaning of the tag:
116* `created` - A new token event was created. 121* `created` - A new token event was created.
117* `destroyed` - A token event was destroyed. 122* `destroyed` - A token event was destroyed.
118* `redeemed` - A [[NIP-61]] nutzap was redeemed. 123* `redeemed` - A [NIP-61](61.md) nutzap was redeemed.
119 124
120All tags can be [[NIP-44]] encrypted. Clients SHOULD leave `e` tags with a `redeemed` marker unencrypted. 125like on Wallet events, clients or users may choose to encrypt all tags except for `a` tags and `e` tags with a `redeemed` marker unencrypted.
121 126
122Multiple `e` tags can be added to a `kind:7376` event. 127Multiple `e` tags can be added to a `kind:7376` event.
123 128
124# Flow 129# Flow
125A client that wants to check for user's wallets information starts by fetching `kind:10019` events from the user's relays, if no event is found, it should fall back to using the user's [[NIP-65]] relays. 130A client that wants to check for user's wallets information starts by fetching `kind:10019` events from the user's relays, if no event is found, it should fall back to using the user's [NIP-65](65.md) relays.
126 131
127## Fetch wallet and token list 132## Fetch wallet and token list
128From those relays, the client should fetch wallet and token events. 133From those relays, the client should fetch wallet and token events.
@@ -130,7 +135,7 @@ From those relays, the client should fetch wallet and token events.
130`"kinds": [37375, 7375], "authors": ["<my-pubkey>"]` 135`"kinds": [37375, 7375], "authors": ["<my-pubkey>"]`
131 136
132## Fetch proofs 137## Fetch proofs
133While the client is fetching (and perhaps validating) proofs it can use the optional `balance` tag of the wallet event to display a estimate of the balance of the wallet. 138While the client is fetching (and perhaps validating) proofs it can use the optional `balance` tag of the _wallet event_ to display a estimate of the balance of the wallet.
134 139
135## Spending token 140## Spending token
136If Alice spends 4 sats from this token event 141If Alice spends 4 sats from this token event
@@ -192,9 +197,9 @@ Her client:
192``` 197```
193 198
194## Redeeming a quote (optional) 199## Redeeming a quote (optional)
195When creating a quote at a mint, an event can be used to keep the state of the quote ID, which will be used to check when the quote has been paid. These events should be created with an expiration tag [[NIP-40]] matching the expiration of the bolt11 received from the mint; this signals to relays when they can safely discard these events. 200When creating a quote at a mint, an event can be used to keep the state of the quote ID, which will be used to check when the quote has been paid. These events should be created with an expiration tag [NIP-40](40.md) of 2 weeks (which is around the maximum amount of time a Lightning payment may be pending).
196 201
197Application developers are encouraged to use local state when possible and only publish this event when it makes sense in the context of their application. 202However, application developers SHOULD use local state when possible and only publish this event when it makes sense in the context of their application.
198 203
199```jsonc 204```jsonc
200{ 205{