mirror of
https://github.com/nostr-protocol/nips.git
synced 2024-11-14 07:49:07 -05:00
a736e629be
as noticed by @bezysoftware at https://github.com/nostr-protocol/nips/pull/1437#issuecomment-2380626514.
I don't know how so many of these instances were left from the original PR at following ca3c52e3e7.
86 lines
2.2 KiB
Markdown
86 lines
2.2 KiB
Markdown
NIP-75
|
|
======
|
|
|
|
Zap Goals
|
|
---------
|
|
|
|
`draft` `optional`
|
|
|
|
This NIP defines an event for creating fundraising goals. Users can contribute funds towards the goal by zapping the goal event.
|
|
|
|
## Nostr Event
|
|
|
|
A `kind:9041` event is used.
|
|
|
|
The `.content` contains a human-readable description of the goal.
|
|
|
|
The following tags are defined as REQUIRED.
|
|
|
|
- `amount` - target amount in milisats.
|
|
- `relays` - a list of relays the zaps to this goal will be sent to and tallied from.
|
|
|
|
Example event:
|
|
|
|
```jsonc
|
|
{
|
|
"kind": 9041,
|
|
"tags": [
|
|
["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", /*...*/],
|
|
["amount", "210000"],
|
|
],
|
|
"content": "Nostrasia travel expenses",
|
|
// other fields...
|
|
}
|
|
```
|
|
|
|
The following tags are OPTIONAL.
|
|
|
|
- `closed_at` - timestamp for determining which zaps are included in the tally. Zap receipts published after the `closed_at` timestamp SHOULD NOT count towards the goal progress.
|
|
- `image` - an image for the goal
|
|
- `summary` - a brief description
|
|
|
|
```jsonc
|
|
{
|
|
"kind": 9041,
|
|
"tags": [
|
|
["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", /*...*/],
|
|
["amount", "210000"],
|
|
["closed_at", "<unix timestamp in seconds>"],
|
|
["image", "<image URL>"],
|
|
["summary", "<description of the goal>"],
|
|
],
|
|
"content": "Nostrasia travel expenses",
|
|
// other fields...
|
|
}
|
|
```
|
|
|
|
The goal MAY include an `r` or `a` tag linking to a URL or addressable event.
|
|
|
|
The goal MAY include multiple beneficiary pubkeys by specifying [`zap` tags](57.md#appendix-g-zap-tag-on-other-events).
|
|
|
|
Addressable events can link to a goal by using a `goal` tag specifying the event id and an optional relay hint.
|
|
|
|
```jsonc
|
|
{
|
|
"kind": 3xxxx,
|
|
"tags": [
|
|
["goal", "<event id>", "<Relay URL (optional)>"],
|
|
// rest of tags...
|
|
],
|
|
// other fields...
|
|
}
|
|
```
|
|
|
|
## Client behavior
|
|
|
|
Clients MAY display funding goals on user profiles.
|
|
|
|
When zapping a goal event, clients MUST include the relays in the `relays` tag of the goal event in the zap request `relays` tag.
|
|
|
|
When zapping an addressable event with a `goal` tag, clients SHOULD tag the goal event id in the `e` tag of the zap request.
|
|
|
|
## Use cases
|
|
|
|
- Fundraising clients
|
|
- Adding funding goals to events such as long form posts, badges or live streams
|