-
Notifications
You must be signed in to change notification settings - Fork 231
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Marcin Rataj <[email protected]>
- Loading branch information
Showing
2 changed files
with
101 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
--- | ||
title: "IPIP-0417: Delegated Peer Routing HTTP API" | ||
date: 2023-05-29 | ||
ipip: proposal | ||
editors: | ||
- name: Henrique Dias | ||
github: hacdias | ||
url: https://hacdias.com/ | ||
affiliation: | ||
name: Protocol Labs | ||
url: https://protocol.ai/ | ||
relatedIssues: | ||
- https://github.com/ipfs/specs/pull/410 | ||
- https://github.com/ipfs/kubo/pull/9877 | ||
order: 417 | ||
tags: ['ipips'] | ||
--- | ||
|
||
## Summary | ||
|
||
This IPIP specifies `/routing/v1/peers/{peer-id}` HTTP API to offload peer routing onto another server. | ||
|
||
## Motivation | ||
|
||
The motivation of this IPIP extends the one of :cite[ipip-0337] and :cite[ipip-0379], | ||
which introduced delegated content routing and delegated naming, respectively. Now, | ||
we expand upon those basis to introduce peer routing, reducing the barrier for interaction | ||
across different systems. | ||
|
||
## Detailed design | ||
|
||
Add `/routing/v1/peers/{peer-id}` to the existing :cite[http-routing-v1] specification, | ||
as well as the new Peer schema. | ||
|
||
## Design rationale | ||
|
||
In line with the remaining Routing V1 API, this IPIP introduces a new HTTP GET | ||
endpoint that is used to retrieve peer records for a certain peer. | ||
|
||
### User benefit | ||
|
||
The user benefit brought by this PR is similar to the one in :cite[ipip-0379], | ||
but instead of offloading the naming process, we offload the peer discovery and | ||
routing. | ||
|
||
### Compatibility | ||
|
||
See the "Compatibility" section of :cite[ipip-0337]. | ||
|
||
### Security | ||
|
||
TODO | ||
|
||
### Alternatives | ||
|
||
TODO | ||
|
||
### Copyright | ||
|
||
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters