chore: code format
This commit is contained in:
Vlad Stan
parent
d66184c077
commit
ffb0177003
5 changed files with 623 additions and 642 deletions
49
README.md
49
README.md
|
|
@ -1,7 +1,9 @@
|
|||
# Nostr Relay
|
||||
|
||||
### One click and spin up your own Nostr relay. Share with the world, or use privately.
|
||||
|
||||
**Configure**:
|
||||
|
||||
- Free Plan: with limitted storage (limit can be changed)
|
||||
- Paid Plan: `pay to join` and `pay for storage`
|
||||
- Storage Limit (can buy more)
|
||||
|
|
@ -11,57 +13,61 @@
|
|||
- Optional Auth for `Events` and `Filters`
|
||||
|
||||
## Supported NIPs
|
||||
- [x] **NIP-01**: Basic protocol flow
|
||||
- [x] **NIP-02**: Contact List and Petnames
|
||||
|
||||
- [x] **NIP-01**: Basic protocol flow
|
||||
- [x] **NIP-02**: Contact List and Petnames
|
||||
- `kind: 3`: delete past contact lists as soon as the relay receives a new one
|
||||
- [x] **NIP-04**: Encrypted Direct Message
|
||||
- [x] **NIP-04**: Encrypted Direct Message
|
||||
- if `AUTH` enabled: send only to the intended target
|
||||
- [x] **NIP-09**: Event Deletion
|
||||
- [x] **NIP-11**: Relay Information Document
|
||||
- >**Note**: the endpoint is NOT on the root level of the domain. It also includes a path (eg https://lnbits.link/nostrrelay/)
|
||||
- [ ] **NIP-12**: Generic Tag Queries
|
||||
- [x] **NIP-09**: Event Deletion
|
||||
- [x] **NIP-11**: Relay Information Document
|
||||
- > **Note**: the endpoint is NOT on the root level of the domain. It also includes a path (eg https://lnbits.link/nostrrelay/)
|
||||
- [ ] **NIP-12**: Generic Tag Queries
|
||||
- todo
|
||||
- [x] **NIP-15**: End of Stored Events Notice
|
||||
- [x] **NIP-16**: Event Treatment
|
||||
- [x] **NIP-15**: End of Stored Events Notice
|
||||
- [x] **NIP-16**: Event Treatment
|
||||
- [x] Regular Events
|
||||
- [x] Replaceable Events
|
||||
- [x] Ephemeral Events
|
||||
- [x] **NIP-20**: Command Results
|
||||
- [x] **NIP-20**: Command Results
|
||||
- todo: use correct prefixes
|
||||
- [x] **NIP-22**: Event created_at Limits
|
||||
- [ ] **NIP-26**: Delegated Event Signing
|
||||
- [x] **NIP-22**: Event created_at Limits
|
||||
- [ ] **NIP-26**: Delegated Event Signing
|
||||
- not planned
|
||||
- [x] **NIP-28** Public Chat
|
||||
- [x] **NIP-28** Public Chat
|
||||
- `kind: 41`: handled similar to `kind 0` metadata events
|
||||
- [ ] **NIP-33**: Parameterized Replaceable Events
|
||||
- [ ] **NIP-33**: Parameterized Replaceable Events
|
||||
- todo
|
||||
- [ ] **NIP-40**: Expiration Timestamp
|
||||
- [ ] **NIP-40**: Expiration Timestamp
|
||||
- todo
|
||||
- [x] **NIP-42**: Authentication of clients to relays
|
||||
- [x] **NIP-42**: Authentication of clients to relays
|
||||
- todo: use correct prefix
|
||||
- [ ] **NIP-50**: Search Capability
|
||||
- [ ] **NIP-50**: Search Capability
|
||||
- todo
|
||||
|
||||
|
||||
## Create Relay
|
||||
|
||||
Creating a new relay is straightforward. Just click `New Relay` then enter the Relay Info.
|
||||
|
||||
> **Note**: admin users can select a relay id. Regular users will be assigned a generated relay id.
|
||||
The relay can be activated/deactivated.
|
||||
> The relay can be activated/deactivated.
|
||||
|
||||
- **New Relay Dialog**
|
||||
- 
|
||||
|
||||
## Configure Relay
|
||||
|
||||
Find your Relay in the list and click the expand button (`+`) to configure it.
|
||||
|
||||
### Relay Info
|
||||
|
||||
This tab contains data according to `NIP-11` (Relay Information Document).
|
||||
|
||||
> **Note**: the `domain` is added automatically and shoud be corrected manually if needed. This value is used for `NIP-42` (Authentication of clients to relays)
|
||||
|
||||
- **Relay Info Tab**
|
||||
- 
|
||||
|
||||
|
||||
### Payment
|
||||
|
||||
By default the relay is free to access, but it can be configured to ask for payments.
|
||||
|
|
@ -78,7 +84,6 @@ Here the entry and storage fees can be paid.
|
|||
- **Relay Public Page**
|
||||
- 
|
||||
|
||||
|
||||
### Config
|
||||
|
||||
Configure `NIP-22` (_Event `created_at` Limits_), `NIP-42` (_Authentication of clients to relays_) and other Relay parameters.
|
||||
|
|
@ -90,7 +95,6 @@ Some configurations are not standard (`NIPs`) but they help control what clients
|
|||
- **Config Tab**
|
||||
- 
|
||||
|
||||
|
||||
### Accounts
|
||||
|
||||
Allows the Relay operator to `Block` or `Allow` certain accounts.
|
||||
|
|
@ -105,6 +109,7 @@ When an account is `blocked` it does not matter if it `paid to join` or if it i
|
|||
## Development
|
||||
|
||||
Create Symbolic Link:
|
||||
|
||||
```
|
||||
ln -s /Users/my-user/git-repos/nostr-relay-extension/ /Users/my-user/git-repos/lnbits/lnbits/extensions/nostrrelay
|
||||
```
|
||||
|
|
|
|||
|
|
@ -82,12 +82,7 @@
|
|||
"REQ",
|
||||
"notifications:0b29ecc73ba400e5b4bd1e4cb0d8f524e9958345",
|
||||
{
|
||||
"kinds": [
|
||||
1,
|
||||
7,
|
||||
6,
|
||||
4
|
||||
],
|
||||
"kinds": [1, 7, 6, 4],
|
||||
"#p": [
|
||||
"0b29ecc73ba400e5b4bd1e4cb0d8f524e9958345749197ca21c8da38d0622816"
|
||||
],
|
||||
|
|
@ -127,11 +122,7 @@
|
|||
"e",
|
||||
"05741bda9079cdf66f3be977a4d31287366470d1337b1aeb09506da4fbf7cd85"
|
||||
],
|
||||
[
|
||||
"e",
|
||||
"mock-id",
|
||||
""
|
||||
],
|
||||
["e", "mock-id", ""],
|
||||
[
|
||||
"e",
|
||||
"bb34749ffd3eb0e393e54cc90b61a7dd5f34108d4931467861d20281c0b7daea"
|
||||
|
|
@ -153,9 +144,7 @@
|
|||
"REQ",
|
||||
"contact",
|
||||
{
|
||||
"kinds": [
|
||||
3
|
||||
],
|
||||
"kinds": [3],
|
||||
"authors": [
|
||||
"d685447c43c7c18dbbea61923cf0b63e1ab46bed69b153a48279a95c40bd414a"
|
||||
]
|
||||
|
|
@ -185,9 +174,7 @@
|
|||
"REQ",
|
||||
"profile",
|
||||
{
|
||||
"kinds": [
|
||||
0
|
||||
],
|
||||
"kinds": [0],
|
||||
"authors": [
|
||||
"0b29ecc73ba400e5b4bd1e4cb0d8f524e9958345749197ca21c8da38d0622816"
|
||||
]
|
||||
|
|
@ -197,9 +184,7 @@
|
|||
"REQ",
|
||||
"sub0",
|
||||
{
|
||||
"kinds": [
|
||||
1
|
||||
],
|
||||
"kinds": [1],
|
||||
"authors": [
|
||||
"0b29ecc73ba400e5b4bd1e4cb0d8f524e9958345749197ca21c8da38d0622816"
|
||||
],
|
||||
|
|
@ -308,9 +293,7 @@
|
|||
"REQ",
|
||||
"notifications:d685447c43c7c18dbbea61923cf0b63e1ab46bed",
|
||||
{
|
||||
"kinds": [
|
||||
4
|
||||
],
|
||||
"kinds": [4],
|
||||
"#p": [
|
||||
"d685447c43c7c18dbbea61923cf0b63e1ab46bed69b153a48279a95c40bd414a"
|
||||
],
|
||||
|
|
@ -321,9 +304,7 @@
|
|||
"REQ",
|
||||
"notifications:delete",
|
||||
{
|
||||
"kinds": [
|
||||
5
|
||||
],
|
||||
"kinds": [5],
|
||||
"authors": [
|
||||
"0b29ecc73ba400e5b4bd1e4cb0d8f524e9958345749197ca21c8da38d0622816"
|
||||
],
|
||||
|
|
|
|||
|
|
@ -175,12 +175,7 @@
|
|||
"name": "kind 30,000, replaceable events, 'd' tag",
|
||||
"data": {
|
||||
"kind": 30000,
|
||||
"tags": [
|
||||
[
|
||||
"d",
|
||||
"chats/null/lastOpened"
|
||||
]
|
||||
],
|
||||
"tags": [["d", "chats/null/lastOpened"]],
|
||||
"content": "1675242945",
|
||||
"created_at": 1675242945,
|
||||
"pubkey": "a24496bca5dd73300f4e5d5d346c73132b7354c597fcbb6509891747b4689211",
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue