https://github.com/riccardobl/nostriot-test-and-draft
https://github.com/riccardobl/nostriot-test-and-draft
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/riccardobl/nostriot-test-and-draft
- Owner: riccardobl
- Created: 2024-09-20T12:47:00.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-09-24T12:50:30.000Z (8 months ago)
- Last Synced: 2025-03-18T23:22:59.331Z (2 months ago)
- Language: TypeScript
- Size: 28.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
draft, poorly written, and incomplete
# Device discoverability
Devices periodically send a group encrypted kind 0 event tagged with h:groupId.
Structure:
(TODO)
```
{
kind: 0,
content: JSON.stringify({
// device specs
// see ./discovery.ts for definition
}),
tags: [
["h", groupId],
["client", "nostriot"]
]
}
```
other devices and apps can discover devices by subscribing to `{kinds:[0], #h:[groupId]}` nb. events that fail the decryption should be discarded as invalid.
When a device is discovered, its public key should be stored locally for future communication using nip-90 job requests, or to fetch its status using (?)(TBD).
# Remote setup and installation
Devices, that support remote setup, come with a static nostriot+admin:// url that changes only when the device is manually reset (ie. by pressing the reset button, reflashing the firmware, etc).
The url has this format:
```
nostriot+admin://@?relay=relay-url&metadata=&template=
```
(can have multiple relay params)
Remote setup can be initialized by sending a setup-event (TBD) to the relay urls, targeting the device-pubkey and signed with the admin-privkey.
As security measure, the device can lock itself after the first setup, until it is manually reset.
# Group joining
A device can be configured to join a group by providing one or more group urls during the setup phase.
A group url is constructed as follows:
```
nostriot://@?relay=relay-url&metadata=
```
(can have multiple relay params)
# Group Encryption
In *nostriot*, events can be encrypted for a group of users and devices using the same algorithm as **NIP-04**, but with a pre-shared private key, referred to as the *group secret*.
When encrypting *nostriot* events for a group, the `content` field is encrypted using the group secret, and a `nostriot/encrypted` tag is added to the event.
If **NIP-04** is applied together with group encryption, encryption and decryption must be handled as follows:
- **Encryption:** `nip04(nostriot_encrypt(content))`
- **Decryption:** `nostriot_decrypt(nip04(content))`
Job results and feedbacks should use group encryption only if the request itself was group encrypted.
Device statuses should always use group encryption unless the device is set to be public.