Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NIP-37 - Transport method announcement #1585

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions 37.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
NIP-37
======

Transport methods announcement
-----------------------------------

`draft` `optional`

This NIP describes how digital services can announce how clients can reach them, it describes which network is used and depending on the network what other data is needed to reach it.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean by "digital service"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any service/server really. Some examples would be Cashu Mints, Relays, Epoxy Proxies, IOT devices...


## Specification

A replacable event of kind `11111`, containing one or more of the following tag(s):

```json
["<network>", "<address>", "<protocol>"]
```
- `<network>` describes which network is used.
- `<address>` describes where to address the service.
- `<protocol>` describes which protocol/schema should be used

## Example

```json
{
"kind": 11111,
"tags": [
["clearnet", "some.domain.com", "wss"],
["tor", "somehash.onion", "ws"],
["i2p", "somehash.b32.i2p/", "ws"],
["ipv4", "157.240.212.35", "http"],
["ipv6", "2001:db8:3333:4444:CCCC:DDDD:EEEE:FFFF", "http"]
]
}
```