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.

Sign up for GitHub

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

Jump to bottom

URI encoding #171

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

URI encoding #171

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
41 changes: 31 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,19 @@

> Composable and future-proof network addresses

- [Introduction](#introduction)
- [Use cases](#use-cases)
- [Encapsulation based on context](#encapsulation-based-on-context)
- [Specification](#specification)
- [Encoding](#encoding)
- [Decoding](#decoding)
- [Protocols](#protocols)
- [Implementations](#implementations)
- [Contribute](#contribute)
- [License](#license)
- [multiaddr](#multiaddr)
- [Introduction](#introduction)
- [Interpreting multiaddrs](#interpreting-multiaddrs)
- [Use cases](#use-cases)
- [Encapsulation based on context](#encapsulation-based-on-context)
- [Specification](#specification)
- [Encoding](#encoding)
- [Decoding](#decoding)
- [URI](#uri)
- [Protocols](#protocols)
- [Implementations](#implementations)
- [Contribute](#contribute)
- [License](#license)


## Introduction
Expand Down Expand Up @@ -140,6 +143,24 @@ TODO: specify the encoding (byte-array to string) procedure

TODO: specify the decoding (string to byte-array) procedure

### URI

It may be helpful in some contexts to reference a URI string. Especially in HTTP.

Multiaddrs can be turned into a [URI](https://datatracker.ietf.org/doc/html/rfc3986) with the following rules:
1. Convert the multiaddr into its human-readable string form.
2. prepend `multiaddr:` to the string. This is the scheme.
3. Ensure each component in the multiaddr conforms to path segment definition in [RFC 3986 Section 3.3](https://datatracker.ietf.org/doc/html/rfc3986#section-3.3).
1. Generally each component already conforms to this, but some multibase encodings do not conform (e.g. base256emoji). It is the caller's responsibility to make sure the generated multiaddr is a valid URI.

Examples:

```
/ip4/127.0.0.1/tcp/4001 => multiaddr:/ip4/127.0.0.1/tcp/4001
/ip4/127.0.0.1/tcp/4001/http => multiaddr:/ip4/127.0.0.1/tcp/4001/http
/ip4/127.0.0.1/tcp/4001/http/http-path/foo%2fbar => multiaddr:/ip4/127.0.0.1/tcp/4001/http/http-path/foo%2fbar
/ip6/::1/udp/4001/quic-v1/webtransport/certhash/uEiDP-eDbJAglAkW2jXNA3U7X4yA6PsDDlnK14GtWBZp-Hw/certhash/uEiAZKNFk76X2gYJqJyHXb0Sw6Tb2cIHvUXnyDTOLA_X8DA => multiaddr:/ip6/::1/udp/4001/quic-v1/webtransport/certhash/uEiDP-eDbJAglAkW2jXNA3U7X4yA6PsDDlnK14GtWBZp-Hw/certhash/uEiAZKNFk76X2gYJqJyHXb0Sw6Tb2cIHvUXnyDTOLA_X8DA
```

## Protocols

Expand Down