nostr/nips
1
0
Fork 0
mirror of https://github.com/nostr-protocol/nips.git synced 2024-12-23 00:45:53 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

formatting fixes

Browse Source
This commit is contained in:
Erik Brakke 2024-08-14 07:25:38 -06:00 committed by GitHub
parent da8fb5663f
commit d6c5772a9d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 28 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
113.md
View File

@ -16,10 +16,10 @@ Activities MUST include a `t` tag with an activity type (defined in Appendix A).
### Activity File ### Activity File
Activities MAY include an `r` tag, which will include a URL to the location where an activity file can be found. Activities MAY include an `r` tag, which will include a URL to the location where an activity file can be found.
### Metadata ### Metadata
`t` - The activity type `t` - The activity type
`r` - location of activity file (OPTIONAL) `r` - location of activity file (OPTIONAL)
`title` - The title of the activity `title` - The title of the activity
`recorded_at` - The unix timestamp (in seconds) when the activity was recorded `recorded_at` - The unix timestamp (in seconds) when the activity was recorded
`encrypted` - An indication that this event is encrypted (OPTIONAL) `encrypted` - An indication that this event is encrypted (OPTIONAL)
```json ```json
@ -27,14 +27,14 @@ Activities MAY include an `r` tag, which will include a URL to the location wher
"kind": 30100, "kind": 30100,
"content": "<description-of-activity>", "content": "<description-of-activity>",
"tags": [ "tags": [
['title', 'Title of Activity'], ["title", "Title of Activity"],
['t', '<activity-type-from-nip>'] ["t", "<activity-type-from-nip>"]
['d', 'UUID generated by client'], ["d", "UUID generated by client"],
['r', 'url to download activity file'], ["r", "url to download activity file"],
['published_at', '<unix-timestamp>'], ["published_at", "<unix-timestamp>"],
['updated_at', '<unix-timestamp>'], ["updated_at", "<unix-timestamp>"],
['recorded_at', '<unix-timestamp>'] ["recorded_at", "<unix-timestamp>"]
['encrypted'] // Optional, activity file is encrypted ["encrypted"] // Optional, activity file is encrypted
], ],
} }
``` ```
@ -45,11 +45,11 @@ Users will likely want a summary of a specific event (e.g. milage, time, pace, e
This NIP does not attempt to describe all the different summaries that users could want, as this list will be ever evolving. Rather this event type should facilitate clients to retrieve relevant summaries for a user. This NIP does not attempt to describe all the different summaries that users could want, as this list will be ever evolving. Rather this event type should facilitate clients to retrieve relevant summaries for a user.
#### Summary Metadata #### Summary Metadata
`r` - An ID that this summary pertains to. It could be an activity ID or a user pubkey `r` - An ID that this summary pertains to. It could be an activity ID or a user pubkey
`t` - A summary MUST include a type which clients can specifically look for. These types must be lowercase with no spaces. e.g. `sports-lib-summary` `t` - A summary MUST include a type which clients can specifically look for. These types must be lowercase with no spaces. e.g. `sports-lib-summary`
`g` - Optional geohash of a summary `g` - Optional geohash of a summary
`encrypted` - Optional, if summary is encrypted. `encrypted` - Optional, if summary is encrypted.
`content` - stringified payload of the summary - the structure of which is defined by the type. `content` - stringified payload of the summary - the structure of which is defined by the type.
`unit` - Optional, defines the unit types that are present in a summary. Either `imperial | metric`. `unit` - Optional, defines the unit types that are present in a summary. Either `imperial | metric`.
```json ```json
@ -57,14 +57,14 @@ This NIP does not attempt to describe all the different summaries that users cou
kind: 30101, kind: 30101,
content: "JSON.stringify(summary)", content: "JSON.stringify(summary)",
tags: [ tags: [
['d', 'UUID generated by client'], ["d", "UUID generated by client"],
['r', '<UUID-of-activity>'], ["r", "<UUID-of-activity>"],
['t', 'general-summary'], ["t", "general-summary"],
['g', 'OPTIONAL geohash'], ["g", "OPTIONAL geohash"],
['unit', 'OPTIONAL imperial | metric'], ["unit", "OPTIONAL imperial | metric"],
['published_at', '<unix-timestamp>'], ["published_at", "<unix-timestamp>"],
['updated_at', '<unix-timestamp>'] ["updated_at", "<unix-timestamp>"]
['encrypted'] // Optional, summary content is encrypted ["encrypted"] // Optional, summary content is encrypted
], ],
} }
``` ```
@ -90,6 +90,7 @@ Examples:
If a user wishes to encrypt a summary or activity, they should use the [NIP-44](NIP-44.md) encryption schema to encrypt the content being uploaded. i.e. if an activity is `encrypted` and it includes a link to an activity file to download, that activity file is encrypted via NIP-44. If a user wishes to encrypt a summary or activity, they should use the [NIP-44](NIP-44.md) encryption schema to encrypt the content being uploaded. i.e. if an activity is `encrypted` and it includes a link to an activity file to download, that activity file is encrypted via NIP-44.
## Appendix A - Activity Types ## Appendix A - Activity Types
```
run run
trail-run trail-run
hike hike
@ -136,4 +137,5 @@ weight-training
windsurf windsurf
wheelchair wheelchair
workout workout
yoga yoga
```