Compare commits

...

16 Commits

Author SHA1 Message Date
fiatjaf
7b79ab040a nip22: what is an I-tag 2025-02-07 10:56:24 -03:00
Nostr.Band
f1dee4a050 Make description_hash verification optional (#1705) 2025-02-07 12:53:30 +01:00
P. Reis
e286001789 NIP-61: nitpicks (#1754) 2025-02-07 00:28:23 +09:00
Vitor Pamplona
63d1e89f53 Revert "Revert "NIP-01: Adds the author information to e tags (#1749)""
This reverts commit f2e89b130d.
2025-02-05 13:29:07 -03:00
Vitor Pamplona
f2e89b130d Revert "NIP-01: Adds the author information to e tags (#1749)"
This reverts commit 3bbfbb26aa.
2025-02-05 13:25:01 -03:00
Vitor Pamplona
3bbfbb26aa NIP-01: Adds the author information to e tags (#1749) 2025-02-05 13:10:48 -03:00
P. Reis
a0cd05f013 NIP-61: get rid of 'a' tag (#1742) 2025-02-04 22:35:15 -03:00
Mohammed Alotaibi
4e564ba4d9 Fix NIPs refs (#1740) 2025-02-04 21:50:20 +09:00
Asai Toshiya
a70e49e21c update Cashu Wallet Event kind. 2025-02-04 20:55:41 +09:00
Ethan Tuttle
2bc53c12a2 Update 61.md (#1739) 2025-02-04 19:53:04 +09:00
fiatjaf_
5a857e8bf8 nip60/61 updates and simplifications (#1730)
Co-authored-by: Tiago Balas <eskema23@gmail.com>
2025-02-03 22:36:27 -03:00
Ethan Tuttle
93568e3971 Update 60.md (#1738) 2025-02-04 08:27:25 +09:00
Asai Toshiya
8577545faa nip60: fix links. 2025-02-03 23:00:33 +09:00
Terry Yiu
c88d925613 Update kind 10013 description in README (#1736) 2025-02-02 19:38:15 -08:00
Asai Toshiya
e09f6dad27 add NIP-71 change. 2025-02-01 00:59:52 +09:00
fiatjaf_
6a4b125ad7 nip71: make video events regular (#1704) 2025-01-30 23:21:37 -03:00
15 changed files with 118 additions and 155 deletions

2
01.md
View File

@@ -75,7 +75,7 @@ The first element of the tag array is referred to as the tag _name_ or _key_ and
This NIP defines 3 standard tags that can be used across all event kinds with the same meaning. They are as follows: This NIP defines 3 standard tags that can be used across all event kinds with the same meaning. They are as follows:
- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>]` - The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>, <32-bytes lowercase hex of the author's pubkey, optional>]`
- The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, <recommended relay URL, optional>]` - The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, <recommended relay URL, optional>]`
- The `a` tag, used to refer to an addressable or replaceable event - The `a` tag, used to refer to an addressable or replaceable event
- for an addressable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]` - for an addressable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]`

3
22.md
View File

@@ -6,7 +6,7 @@ Comment
`draft` `optional` `draft` `optional`
A comment is a threading note always scoped to a root event or an `I`-tag. A comment is a threading note always scoped to a root event or an [`I`-tag](73.md).
It uses `kind:1111` with plaintext `.content` (no HTML, Markdown, or other formatting). It uses `kind:1111` with plaintext `.content` (no HTML, Markdown, or other formatting).
@@ -198,4 +198,3 @@ A reply to a podcast comment:
// other fields // other fields
} }
``` ```

2
31.md
View File

@@ -12,4 +12,4 @@ The intent is that social clients, used to display only `kind:1` notes, can stil
These clients that only know `kind:1` are not expected to ask relays for events of different kinds, but users could still reference these weird events on their notes, and without proper context these could be nonsensical notes. Having the fallback text makes that situation much better -- even if only for making the user aware that they should try to view that custom event elsewhere. These clients that only know `kind:1` are not expected to ask relays for events of different kinds, but users could still reference these weird events on their notes, and without proper context these could be nonsensical notes. Having the fallback text makes that situation much better -- even if only for making the user aware that they should try to view that custom event elsewhere.
`kind:1`-centric clients can make interacting with these event kinds more functional by supporting [NIP-89](https://github.com/nostr-protocol/nips/blob/master/89.md). `kind:1`-centric clients can make interacting with these event kinds more functional by supporting [NIP-89](89.md).

2
47.md
View File

@@ -82,7 +82,7 @@ If the command was successful, the `error` field must be null.
The notification event SHOULD contain one `p` tag, the public key of the **user**. The notification event SHOULD contain one `p` tag, the public key of the **user**.
The content of notifications is encrypted with [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md), and is a JSON-RPCish object with a semi-fixed structure: The content of notifications is encrypted with [NIP04](04.md), and is a JSON-RPCish object with a semi-fixed structure:
```jsonc ```jsonc
{ {

2
51.md
View File

@@ -50,7 +50,7 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti
| Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) | | Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) |
| Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | | Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) |
| Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | | Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) |
| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:34235 videos) | | Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:21 videos) |
| Kind mute sets | 30007 | mute pubkeys by kinds<br>`"d"` tag MUST be the kind string | `"p"` (pubkeys) | | Kind mute sets | 30007 | mute pubkeys by kinds<br>`"d"` tag MUST be the kind string | `"p"` (pubkeys) |
| Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | | Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) |
| Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) |

2
57.md
View File

@@ -132,7 +132,7 @@ The following should be true of the `zap receipt` event:
- `tags` MUST include the `p` tag (zap recipient) AND optional `e` tag from the `zap request` AND optional `a` tag from the `zap request` AND optional `P` tag from the pubkey of the zap request (zap sender). - `tags` MUST include the `p` tag (zap recipient) AND optional `e` tag from the `zap request` AND optional `a` tag from the `zap request` AND optional `P` tag from the pubkey of the zap request (zap sender).
- The `zap receipt` MUST have a `bolt11` tag containing the description hash bolt11 invoice. - The `zap receipt` MUST have a `bolt11` tag containing the description hash bolt11 invoice.
- The `zap receipt` MUST contain a `description` tag which is the JSON-encoded zap request. - The `zap receipt` MUST contain a `description` tag which is the JSON-encoded zap request.
- `SHA256(description)` MUST match the description hash in the bolt11 invoice. - `SHA256(description)` SHOULD match the description hash in the bolt11 invoice.
- The `zap receipt` MAY contain a `preimage` tag to match against the payment hash of the bolt11 invoice. This isn't really a payment proof, there is no real way to prove that the invoice is real or has been paid. You are trusting the author of the `zap receipt` for the legitimacy of the payment. - The `zap receipt` MAY contain a `preimage` tag to match against the payment hash of the bolt11 invoice. This isn't really a payment proof, there is no real way to prove that the invoice is real or has been paid. You are trusting the author of the `zap receipt` for the legitimacy of the payment.
The `zap receipt` is not a proof of payment, all it proves is that some nostr user fetched an invoice. The existence of the `zap receipt` implies the invoice as paid, but it could be a lie given a rogue implementation. The `zap receipt` is not a proof of payment, all it proves is that some nostr user fetched an invoice. The existence of the `zap receipt` implies the invoice as paid, but it could be a lie given a rogue implementation.

104
60.md
View File

@@ -1,5 +1,9 @@
# NIP-60 NIP-60
## Cashu Wallet ======
Cashu Wallets
-------------
`draft` `optional` `draft` `optional`
This NIP defines the operations of a cashu-based wallet. This NIP defines the operations of a cashu-based wallet.
@@ -13,48 +17,28 @@ The purpose of this NIP is:
This NIP doesn't deal with users' *receiving* money from someone else, it's just to keep state of the user's wallet. This NIP doesn't deal with users' *receiving* money from someone else, it's just to keep state of the user's wallet.
# High-level flow # High-level flow
1. A user has a `kind:37375` event that represents a wallet. 1. A user has a `kind:17375` event that represents a wallet.
2. A user has `kind:7375` events that represent the unspent proofs of the wallet. -- The proofs are encrypted with the user's private key. 2. A user has `kind:7375` events that represent the unspent proofs of the wallet. -- The proofs are encrypted with the user's private key.
3. A user has `kind:7376` events that represent the spending history of the wallet -- This history is for informational purposes only and is completely optional. 3. A user has `kind:7376` events that represent the spending history of the wallet -- This history is for informational purposes only and is completely optional.
## Wallet Event ## Wallet Event
```jsonc ```jsonc
{ {
"kind": 37375, "kind": 17375,
"content": nip44_encrypt([ "content": nip44_encrypt([
[ "balance", "100", "sat" ], [ "privkey", "hexkey" ],
[ "privkey", "hexkey" ] // explained in NIP-61
]),
"tags": [
[ "d", "my-wallet" ],
[ "mint", "https://mint1" ], [ "mint", "https://mint1" ],
[ "mint", "https://mint2" ], [ "mint", "https://mint2" ]
[ "mint", "https://mint3" ], ]),
[ "name", "my shitposting wallet" ], "tags": []
[ "unit", "sat" ],
[ "description", "a wallet for my day-to-day shitposting" ],
[ "relay", "wss://relay1" ],
[ "relay", "wss://relay2" ],
]
} }
``` ```
The wallet event is an addressable event `kind:37375`. The wallet event is an replaceable event `kind:17375`.
Tags: Tags:
* `d` - wallet ID.
* `mint` - Mint(s) this wallet uses -- there MUST be one or more mint tags. * `mint` - Mint(s) this wallet uses -- there MUST be one or more mint tags.
* `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]]. * `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.
* `unit` - Base unit of the wallet (e.g. "sat", "usd", etc).
* `name` - Optional human-readable name for the wallet.
* `description` - Optional human-readable description of the wallet.
* `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.
* `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.
Any tag, other than the `d` tag, can be [[NIP-44]] encrypted into the `.content` field.
### Deleting a wallet event
Due 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.
## Token Event ## Token Event
Token events are used to record unspent proofs. Token events are used to record unspent proofs.
@@ -67,6 +51,7 @@ There can be multiple `kind:7375` events for the same mint, and multiple proofs
"content": nip44_encrypt({ "content": nip44_encrypt({
"mint": "https://stablenut.umint.cash", "mint": "https://stablenut.umint.cash",
"proofs": [ "proofs": [
// one or more proofs in the default cashu format
{ {
"id": "005c2502034d4f12", "id": "005c2502034d4f12",
"amount": 1, "amount": 1,
@@ -74,23 +59,21 @@ There can be multiple `kind:7375` events for the same mint, and multiple proofs
"C": "0241d98a8197ef238a192d47edf191a9de78b657308937b4f7dd0aa53beae72c46" "C": "0241d98a8197ef238a192d47edf191a9de78b657308937b4f7dd0aa53beae72c46"
} }
], ],
// tokens that were destroyed in the creation of this token // tokens that were destroyed in the creation of this token (helps on wallet state transitions)
"del": [ "token-id-1" ] "del": [ "token-event-id-1", "token-event-id-2" ]
}), }),
"tags": [ "tags": []
[ "a", "37375:<pubkey>:my-wallet" ]
]
} }
``` ```
* `a` an optional tag linking the token to a specific wallet. * `.content` is a [NIP-44](44.md) encrypted payload:
* `.content` is a [[NIP-44]] encrypted payload:
* `mint`: The mint the proofs belong to. * `mint`: The mint the proofs belong to.
* `proofs`: unecoded proofs * `proofs`: unecoded proofs
* `del`: token-ids that were destroyed by the creation of this token. This assists with state transitions. * `del`: token-ids that were destroyed by the creation of this token. This assists with state transitions.
### Spending proofs When 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).
When 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.
The `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.
## Spending History Event ## Spending History Event
Clients SHOULD publish `kind:7376` events to create a transaction history when their balance changes. Clients SHOULD publish `kind:7376` events to create a transaction history when their balance changes.
@@ -100,37 +83,35 @@ Clients SHOULD publish `kind:7376` events to create a transaction history when t
"kind": 7376, "kind": 7376,
"content": nip44_encrypt([ "content": nip44_encrypt([
[ "direction", "in" ], // in = received, out = sent [ "direction", "in" ], // in = received, out = sent
[ "amount", "1", "sat" ], [ "amount", "1" ],
[ "e", "<event-id-of-created-token>", "<relay-hint>", "created" ], [ "e", "<event-id-of-created-token>", "", "created" ]
]), ]),
"tags": [ "tags": [
[ "a", "37375:<pubkey>:my-wallet" ], [ "e", "<event-id-of-created-token>", "", "redeemed" ]
] ]
} }
``` ```
* `direction` - The direction of the transaction; `in` for received funds, `out` for sent funds. * `direction` - The direction of the transaction; `in` for received funds, `out` for sent funds.
* `a` - The wallet the transaction is related to.
Clients MUST add `e` tags to create references of destroyed and created token events along with the marker of the meaning of the tag: Clients MUST add `e` tags to create references of destroyed and created token events along with the marker of the meaning of the tag:
* `created` - A new token event was created. * `created` - A new token event was created.
* `destroyed` - A token event was destroyed. * `destroyed` - A token event was destroyed.
* `redeemed` - A [[NIP-61]] nutzap was redeemed. * `redeemed` - A [NIP-61](61.md) nutzap was redeemed.
All tags can be [[NIP-44]] encrypted. Clients SHOULD leave `e` tags with a `redeemed` marker unencrypted. All tags can be [NIP-44](44.md) encrypted. Clients SHOULD leave `e` tags with a `redeemed` marker unencrypted.
Multiple `e` tags can be added to a `kind:7376` event. Multiple `e` tags can be added, and should be encrypted, except for tags with the `redeemed` marker.
# Flow # Flow
A 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. A 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.
## Fetch wallet and token list ## Fetch wallet and token list
From those relays, the client should fetch wallet and token events. From those relays, the client should fetch wallet and token events.
`"kinds": [37375, 7375], "authors": ["<my-pubkey>"]` `"kinds": [17375, 7375], "authors": ["<my-pubkey>"]`
## Fetch proofs ## Fetch proofs
While 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.
## Spending token ## Spending token
If Alice spends 4 sats from this token event If Alice spends 4 sats from this token event
@@ -147,9 +128,7 @@ If Alice spends 4 sats from this token event
{ "id": "4", "amount": 8 }, { "id": "4", "amount": 8 },
] ]
}), }),
"tags": [ "tags": []
[ "a", "37375:<pubkey>:my-wallet" ]
]
} }
``` ```
@@ -168,9 +147,7 @@ Her client:
], ],
"del": [ "event-id-1" ] "del": [ "event-id-1" ]
}), }),
"tags": [ "tags": []
[ "a", "37375:<pubkey>:my-wallet" ]
]
} }
``` ```
* MUST delete event `event-id-1` * MUST delete event `event-id-1`
@@ -181,20 +158,18 @@ Her client:
"kind": 7376, "kind": 7376,
"content": nip44_encrypt([ "content": nip44_encrypt([
[ "direction", "out" ], [ "direction", "out" ],
[ "amount", "4", "sats" ], [ "amount", "4" ],
[ "e", "<event-id-1>", "<relay-hint>", "destroyed" ], [ "e", "<event-id-1>", "", "destroyed" ],
[ "e", "<event-id-2>", "<relay-hint>", "created" ], [ "e", "<event-id-2>", "", "created" ],
]), ]),
"tags": [ "tags": []
[ "a", "37375:<pubkey>:my-wallet" ],
]
} }
``` ```
## Redeeming a quote (optional) ## Redeeming a quote (optional)
When 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. When 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 in-flight).
Application developers are encouraged to use local state when possible and only publish this event when it makes sense in the context of their application. However, application developers SHOULD use local state when possible and only publish this event when it makes sense in the context of their application.
```jsonc ```jsonc
{ {
@@ -202,8 +177,7 @@ Application developers are encouraged to use local state when possible and only
"content": nip44_encrypt("quote-id"), "content": nip44_encrypt("quote-id"),
"tags": [ "tags": [
[ "expiration", "<expiration-timestamp>" ], [ "expiration", "<expiration-timestamp>" ],
[ "mint", "<mint-url>" ], [ "mint", "<mint-url>" ]
[ "a", "37375:<pubkey>:my-wallet" ]
] ]
} }
``` ```

97
61.md
View File

@@ -1,14 +1,19 @@
# NIP-61: NIP-61
## Nut Zaps ======
A Nut Zap is a P2PK cashu token where the payment itself is the receipt. Nutzaps
-------
`draft` `optional`
A Nutzap is a P2PK Cashu token in which the payment itself is the receipt.
# High-level flow # High-level flow
Alice wants to nutzap 1 sat to Bob because of an event `event-id-1` she liked. Alice wants to nutzap 1 sat to Bob because of an event `event-id-1` she liked.
## Alice nutzaps Bob ## Alice nutzaps Bob
1. Alice fetches event `kind:10019` from Bob to see the mints Bob trusts. 1. Alice fetches event `kind:10019` from Bob to see the mints Bob trusts.
2. 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`. 2. 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`.
3. She publishes a `kind:9321` event to the relays Bob indicated with the proofs she minted. 3. She publishes a `kind:9321` event to the relays Bob indicated with the proofs she minted.
## Bob receives the nutzap ## 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.
} }
``` ```
`kind:10019` is an event that is useful for others to know how to send money to the user. * `kind:10019` is an event that is useful for others to know how to send money to the user.
* `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.
* `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. * `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.
* `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. * `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_.
* `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.
## Nutzap event ## Nutzap event
Event `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. Event `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.
Clients MUST prefix the pubkey they p2pk-lock with `"02"` (for nostr<>cashu pubkey compatibility). Clients MUST prefix the public key they P2PK-lock with `"02"` (for nostr<>cashu compatibility).
```jsonc ```jsonc
{ {
@@ -46,48 +50,41 @@ Clients MUST prefix the pubkey they p2pk-lock with `"02"` (for nostr<>cashu pubk
content: "Thanks for this great idea.", content: "Thanks for this great idea.",
pubkey: "sender-pubkey", pubkey: "sender-pubkey",
tags: [ tags: [
[ "amount", "1" ],
[ "unit", "sat" ],
[ "proof", "{\"amount\":1,\"C\":\"02277c66191736eb72fce9d975d08e3191f8f96afb73ab1eec37e4465683066d3f\",\"id\":\"000a93d6f8a1d2c4\",\"secret\":\"[\\\"P2PK\\\",{\\\"nonce\\\":\\\"b00bdd0467b0090a25bdf2d2f0d45ac4e355c482c1418350f273a04fedaaee83\\\",\\\"data\\\":\\\"02eaee8939e3565e48cc62967e2fde9d8e2a4b3ec0081f29eceff5c64ef10ac1ed\\\"}]\"}" ], [ "proof", "{\"amount\":1,\"C\":\"02277c66191736eb72fce9d975d08e3191f8f96afb73ab1eec37e4465683066d3f\",\"id\":\"000a93d6f8a1d2c4\",\"secret\":\"[\\\"P2PK\\\",{\\\"nonce\\\":\\\"b00bdd0467b0090a25bdf2d2f0d45ac4e355c482c1418350f273a04fedaaee83\\\",\\\"data\\\":\\\"02eaee8939e3565e48cc62967e2fde9d8e2a4b3ec0081f29eceff5c64ef10ac1ed\\\"}]\"}" ],
[ "u", "https://stablenut.umint.cash", ], [ "u", "https://stablenut.umint.cash" ],
[ "e", "<zapped-event-id>", "<relay-hint>" ], [ "e", "<zapped-event-id>", "<relay-hint>" ],
[ "p", "e9fbced3a42dcf551486650cc752ab354347dd413b307484e4fd1818ab53f991" ], // recipient of nut zap [ "p", "e9fbced3a42dcf551486650cc752ab354347dd413b307484e4fd1818ab53f991" ], // recipient of nutzap
] ]
} }
``` ```
* `.content` is an optional comment for the nutzap * `.content` is an optional comment for the nutzap
* `amount` is a shorthand for the combined amount of all outputs. -- Clients SHOULD validate that the sum of the amounts in the outputs matches. * `.tags`:
* `unit` is the base unit of the amount. * `proof` is one or more proofs P2PK-locked to the public key the recipient specified in their `kind:10019` event and including a DLEQ proof.
* `proof` is one ore more proofs p2pk-locked to the pubkey the recipient specified in their `kind:10019` event. * `u` is the mint the URL of the mint EXACTLY as specified by the recipient's `kind:10019`.
* `u` is the mint the URL of the mint EXACTLY as specified by the recipient's `kind:10019`. * `p` is the Nostr identity public key of nutzap recipient.
* `e` zero or one event that is being nutzapped. * `e` is the event that is being nutzapped, if any.
* `p` exactly one pubkey, specifying the recipient of the nutzap.
WIP: Clients SHOULD embed a DLEQ proof in the nutzap event to make it possible to verify nutzaps without talking to the mint.
# Sending a nutzap # Sending a nutzap
* The sender fetches the recipient's `kind:10019`. * The sender fetches the recipient's `kind:10019`.
* The sender mints/swaps ecash on one of the recipient's listed mints. * The sender mints/swaps ecash on one of the recipient's listed mints.
* The sender p2pk locks to the recipient's specified pubkey in their `kind:10019` * The sender P2PK-locks to the recipient's specified public key in their `kind:10019`
# Receiving nutzaps # Receiving nutzaps
Clients should REQ for nut zaps: Clients should REQ for nutzaps:
* Filtering with `#u` for mints they expect to receive ecash from. * Filtering with `#u` for mints they expect to receive ecash from.
* this is to prevent even interacting with mints the user hasn't explicitly signaled. * this is to prevent even interacting with mints the user hasn't explicitly signaled.
* Filtering with `since` of the most recent `kind:7376` event the same user has created. * Filtering with `since` of the most recent `kind:7376` event the same user has created.
* 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. * 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.
Clients MIGHT choose to use some kind of filtering (e.g. WoT) to ignore spam. `{ "kinds": [9321], "#p": ["my-pubkey"], "#u": ["<mint-1>", "<mint-2>"], "since": <latest-created_at-of-kind-7376> }`.
`{ "kinds": [9321], "#p": "my-pubkey", "#u": [ "<mint-1>", "<mint-2>"], "since": <latest-created_at-of-kind-7376> }`. Upon 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.
Upon 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.
## Updating nutzap-redemption history ## Updating nutzap-redemption history
When 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. When 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.
Multiple `kind:9321` events can be tagged in the same `kind:7376` event. Multiple `kind:9321` events can be tagged in the same `kind:7376` event.
@@ -96,37 +93,29 @@ Multiple `kind:9321` events can be tagged in the same `kind:7376` event.
"kind": 7376, "kind": 7376,
"content": nip44_encrypt([ "content": nip44_encrypt([
[ "direction", "in" ], // in = received, out = sent [ "direction", "in" ], // in = received, out = sent
[ "amount", "1", "sat" ], [ "amount", "1" ],
[ "e", "<7375-event-id>", "relay-hint", "created" ] // new token event that was created [ "e", "<7375-event-id>", "<relay-hint>", "created" ] // new token event that was created
]), ]),
"tags": [ "tags": [
[ "a", "37375:<pubkey>:my-wallet" ], // an optional wallet tag [ "e", "<9321-event-id>", "<relay-hint>", "redeemed" ], // nutzap event that has been redeemed
[ "e", "<9321-event-id>", "relay-hint", "redeemed" ], // nutzap event that has been redeemed [ "p", "<sender-pubkey>" ] // pubkey of the author of the 9321 event (nutzap sender)
[ "p", "sender-pubkey" ] // pubkey of the author of the 9321 event (nutzap sender)
] ]
} }
``` ```
Events that redeem a nutzap SHOULD be published to the sender's [[NIP-65]] relays. Events that redeem a nutzap SHOULD be published to the sender's [NIP-65](65.md) "read" relays.
## Verifying a Cashu Zap ## Verifying a Cashu Zap
* Clients SHOULD check that the receiving user has issued a `kind:10019` tagging the mint where the cashu has been minted. When listing or counting zaps received by any given event, observer clients SHOULD:
* Clients SHOULD check that the token is locked to the pubkey the user has listed in their `kind:10019`.
* check that the receiving user has issued a `kind:10019` tagging the mint where the cashu has been minted.
* check that the token is locked to the pubkey the user has listed in their `kind:10019`.
* look at the `u` tag and check that the token is issued in one of the mints listed in the `kind:10019`.
* locally verify the DLEQ proof of the tokens being sent.
All 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.
## Final Considerations ## Final Considerations
1. 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.
1. 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
2. Clients SHOULD normalize and deduplicate mint URLs as described in NIP-65. 2. Clients SHOULD normalize and deduplicate mint URLs as described in NIP-65.
3. 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.
3. 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.
## Appendix 1: Alternative P2PK pubkey
Clients 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.
For this scenarios clients can:
* add a `pubkey` tag to the `kind:10019` (indicating which pubkey senders should P2PK to)
* store the private key in the `kind:37375` event in the nip44-encrypted `content` field.
This is to avoid depending on NIP-07/46 adaptations to sign cashu payloads.

2
64.md
View File

@@ -44,7 +44,7 @@ Clients SHOULD publish PGN notes in ["export format"][pgn_export_format] ("stric
Clients SHOULD check whether the formatting is valid and all moves comply with chess rules. Clients SHOULD check whether the formatting is valid and all moves comply with chess rules.
Clients MAY include additional tags (e.g. like [`"alt"`](https://github.com/nostr-protocol/nips/blob/master/31.md)) in order to represent the note to users of non-supporting clients. Clients MAY include additional tags (e.g. like [`"alt"`](31.md)) in order to represent the note to users of non-supporting clients.
## Relay Behavior ## Relay Behavior

2
68.md
View File

@@ -89,4 +89,4 @@ Only the following media types are accepted:
- `image/png`: Portable Network Graphics (PNG) - `image/png`: Portable Network Graphics (PNG)
- `image/webp`: Web Picture format (WEBP) - `image/webp`: Web Picture format (WEBP)
Picture events might be used with [NIP-71](71.md)'s kind `34236` to display short vertical videos in the same feed. Picture events might be used with [NIP-71](71.md)'s kind `22` to display short vertical videos in the same feed.

4
69.md
View File

@@ -12,7 +12,7 @@ This NIP defines a simple standard for peer-to-peer order events, which enables
## The event ## The event
Events are [addressable events](https://github.com/nostr-protocol/nips/blob/master/01.md#kinds) and use `38383` as event kind, a p2p event look like this: Events are [addressable events](01.md#kinds) and use `38383` as event kind, a p2p event look like this:
```json ```json
{ {
@@ -65,7 +65,7 @@ Events are [addressable events](https://github.com/nostr-protocol/nips/blob/mast
- `name` [Name]: The name of the maker. - `name` [Name]: The name of the maker.
- `g` [Geohash]: The geohash of the operation, it can be useful in a face to face trade. - `g` [Geohash]: The geohash of the operation, it can be useful in a face to face trade.
- `bond` [Bond]: The bond amount, the bond is a security deposit that both parties must pay. - `bond` [Bond]: The bond amount, the bond is a security deposit that both parties must pay.
- `expiration` < Expiration\>: The expiration date of the order ([NIP-40](https://github.com/nostr-protocol/nips/blob/master/40.md)). - `expiration` < Expiration\>: The expiration date of the order ([NIP-40](40.md)).
- `y` < Platform >: The platform that created the order. - `y` < Platform >: The platform that created the order.
- `z` < Document >: `order`. - `z` < Document >: `order`.

22
71.md
View File

@@ -6,17 +6,19 @@ Video Events
`draft` `optional` `draft` `optional`
This specification defines video events representing a dedicated post of externally hosted content. These video events are _addressable_ and delete-requestable per [NIP-09](09.md). This specification defines _video_ events representing a dedicated post of externally hosted content.
Unlike a `kind 1` event with a video attached, Video Events are meant to contain all additional metadata concerning the subject media and to be surfaced in video-specific clients rather than general micro-blogging clients. The thought is for events of this kind to be referenced in a Netflix, YouTube, or TikTok like nostr client where the video itself is at the center of the experience. Unlike a `kind:1` event with a video attached, video events are meant to contain all additional metadata concerning the subject media and to be surfaced in video-specific clients rather than general micro-blogging clients. The thought is for events of this kind to be referenced in a Netflix, YouTube, or TikTok like nostr client where the video itself is at the center of the experience.
## Video Events ## Video Events
There are two types of video events represented by different kinds: horizontal and vertical video events. This is meant to allow clients to cater to each as the viewing experience for horizontal (landscape) videos is often different than that of vertical (portrait) videos (Stories, Reels, Shorts, etc). There are two types of video events represented by different kinds: _normal_ and _short_ video events. This is meant to allow clients to cater to each as the viewing experience for longer, mostly horizontal (landscape) videos is often different than that of short-form, mostly vertical (portrait), videos ("stories", "reels", "shorts" etc).
Nothing except cavaliership and common sense prevents a _short_ video from being long, or a _normal_ video from being vertical, and that may or may not be justified, it's mostly a stylistic qualitative difference, not a question of actual raw size.
#### Format #### Format
The format uses an _addressable event_ kind `34235` for horizontal videos and `34236` for vertical videos. The format uses a _regular event_ kind `21` for _normal_ videos and `22` for _short_ videos.
The `.content` of these events is a summary or description on the video content. The `.content` of these events is a summary or description on the video content.
@@ -86,16 +88,14 @@ Additionally `service nip96` may be included to allow clients to search the auth
"id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
"pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
"created_at": <Unix timestamp in seconds>, "created_at": <Unix timestamp in seconds>,
"kind": 34235 | 34236, "kind": 21 | 22,
"content": "<summary / description of video>", "content": "<summary / description of video>",
"tags": [ "tags": [
["d", "<UUID>"],
["title", "<title of video>"], ["title", "<title of video>"],
["published_at", "<unix timestamp>"], ["published_at", "<unix timestamp>"],
["alt", <description>], ["alt", <description>],
// Video Data // video Data
["imeta", ["imeta",
"dim 1920x1080", "dim 1920x1080",
"url https://myvideo.com/1080/12345.mp4", "url https://myvideo.com/1080/12345.mp4",
@@ -113,15 +113,15 @@ Additionally `service nip96` may be included to allow clients to search the auth
["content-warning", "<reason>"], ["content-warning", "<reason>"],
["segment", <start>, <end>, "<title>", "<thumbnail URL>"], ["segment", <start>, <end>, "<title>", "<thumbnail URL>"],
// Participants // participants
["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"],
["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"],
// Hashtags // hashtags
["t", "<tag>"], ["t", "<tag>"],
["t", "<tag>"], ["t", "<tag>"],
// Reference links // reference links
["r", "<url>"], ["r", "<url>"],
["r", "<url>"] ["r", "<url>"]
] ]

2
90.md
View File

@@ -70,7 +70,7 @@ All tags are optional.
## Encrypted Params ## Encrypted Params
If the user wants to keep the input parameters a secret, they can encrypt the `i` and `param` tags with the service provider's 'p' tag and add it to the content field. Add a tag `encrypted` as tags. Encryption for private tags will use [NIP-04 - Encrypted Direct Message encryption](https://github.com/nostr-protocol/nips/blob/master/04.md), using the user's private and service provider's public key for the shared secret If the user wants to keep the input parameters a secret, they can encrypt the `i` and `param` tags with the service provider's 'p' tag and add it to the content field. Add a tag `encrypted` as tags. Encryption for private tags will use [NIP-04 - Encrypted Direct Message encryption](04.md), using the user's private and service provider's public key for the shared secret
```json ```json
[ [

View File

@@ -5,6 +5,7 @@ reverse chronological order.
| Date | Commit | NIP | Change | | Date | Commit | NIP | Change |
| ----------- | --------- | -------- | ------ | | ----------- | --------- | -------- | ------ |
| 2025-01-31 | [6a4b125a](https://github.com/nostr-protocol/nips/commit/6a4b125a) | [71](71.md) | video events were changed to regular |
| 2024-12-05 | [6d16019e](https://github.com/nostr-protocol/nips/commit/6d16019e) | [46](46.md) | message encryption was changed to NIP-44 | | 2024-12-05 | [6d16019e](https://github.com/nostr-protocol/nips/commit/6d16019e) | [46](46.md) | message encryption was changed to NIP-44 |
| 2024-11-12 | [2838e3bd](https://github.com/nostr-protocol/nips/commit/2838e3bd) | [29](29.md) | `kind: 12` and `kind: 10` were removed (use `kind: 1111` instead) | | 2024-11-12 | [2838e3bd](https://github.com/nostr-protocol/nips/commit/2838e3bd) | [29](29.md) | `kind: 12` and `kind: 10` were removed (use `kind: 1111` instead) |
| 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [46](46.md) | NIP-05 login was removed | | 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [46](46.md) | NIP-05 login was removed |

View File

@@ -122,6 +122,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
| `16` | Generic Repost | [18](18.md) | | `16` | Generic Repost | [18](18.md) |
| `17` | Reaction to a website | [25](25.md) | | `17` | Reaction to a website | [25](25.md) |
| `20` | Picture | [68](68.md) | | `20` | Picture | [68](68.md) |
| `21` | Video Event | [71](71.md) |
| `22` | Short-form Portrait Video Event | [71](71.md) |
| `40` | Channel Creation | [28](28.md) | | `40` | Channel Creation | [28](28.md) |
| `41` | Channel Metadata | [28](28.md) | | `41` | Channel Metadata | [28](28.md) |
| `42` | Channel Message | [28](28.md) | | `42` | Channel Message | [28](28.md) |
@@ -173,7 +175,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
| `10006` | Blocked relays list | [51](51.md) | | `10006` | Blocked relays list | [51](51.md) |
| `10007` | Search relays list | [51](51.md) | | `10007` | Search relays list | [51](51.md) |
| `10009` | User groups | [51](51.md), [29](29.md) | | `10009` | User groups | [51](51.md), [29](29.md) |
| `10013` | Draft relays | [37](37.md) | | `10013` | Private event relay list | [37](37.md) |
| `10015` | Interests list | [51](51.md) | | `10015` | Interests list | [51](51.md) |
| `10019` | Nutzap Mint Recommendation | [61](61.md) | | `10019` | Nutzap Mint Recommendation | [61](61.md) |
| `10030` | User emoji list | [51](51.md) | | `10030` | User emoji list | [51](51.md) |
@@ -181,6 +183,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
| `10063` | User server list | [Blossom][blossom] | | `10063` | User server list | [Blossom][blossom] |
| `10096` | File storage server list | [96](96.md) | | `10096` | File storage server list | [96](96.md) |
| `13194` | Wallet Info | [47](47.md) | | `13194` | Wallet Info | [47](47.md) |
| `17375` | Cashu Wallet Event | [60](60.md) |
| `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | | `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] |
| `22242` | Client Authentication | [42](42.md) | | `22242` | Client Authentication | [42](42.md) |
| `23194` | Wallet Request | [47](47.md) | | `23194` | Wallet Request | [47](47.md) |
@@ -227,12 +230,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
| `31924` | Calendar | [52](52.md) | | `31924` | Calendar | [52](52.md) |
| `31925` | Calendar Event RSVP | [52](52.md) | | `31925` | Calendar Event RSVP | [52](52.md) |
| `31989` | Handler recommendation | [89](89.md) | | `31989` | Handler recommendation | [89](89.md) |
| `31990` | Handler information | [89](89.md) | | `31990` | Handler information | [89](89.md) | |
| `32267` | Software Application | | | `32267` | Software Application | | |
| `34235` | Video Event | [71](71.md) |
| `34236` | Short-form Portrait Video Event | [71](71.md) |
| `34550` | Community Definition | [72](72.md) | | `34550` | Community Definition | [72](72.md) |
| `37375` | Cashu Wallet Event | [60](60.md) |
| `38383` | Peer-to-peer Order events | [69](69.md) | | `38383` | Peer-to-peer Order events | [69](69.md) |
| `39000-9` | Group metadata events | [29](29.md) | | `39000-9` | Group metadata events | [29](29.md) |