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

Clarify scope #35

Closed
BigLep opened this issue Sep 7, 2023 · 3 comments
Closed

Clarify scope #35

BigLep opened this issue Sep 7, 2023 · 3 comments

Comments

@BigLep
Copy link

BigLep commented Sep 7, 2023

Things that I think we should make clearer in the README:

  1. Link to the "/routing/v1" API that we're implementing
  2. How it relates to https://github.com/libp2p/js-http-v1-content-routing
  3. What /routing/v1 IPIPs it supports (e.g., IPIP-417 (Delegated Peer lookups), IPIP-379 (Delegated IPNS lookups))
@BigLep
Copy link
Author

BigLep commented Oct 26, 2023

@achingbrain : before we move on from delegated routing work for the time being, I'd like to finish this.

For example, I think showing how someone actually uses this with their Helia instance (i.e., they need to use https://github.com/libp2p/js-http-v1-content-routing ) is important. I also want to make it clear that if there are expansions to https://specs.ipfs.tech/routing/http-routing-v1/ that in order for it to be useful for Helia client users, code changes are need in this repo and https://github.com/libp2p/js-http-v1-content-routing

@SgtPooki
Copy link
Member

SgtPooki commented Dec 6, 2023

@BigLep @achingbrain IIUC, instructions for using this are now at

* ```typescript
* import { createDelegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client'
* import { createLibp2p } from 'libp2p'
* import { peerIdFromString } from '@libp2p/peer-id'
*
* const client = createDelegatedRoutingV1HttpApiClient('https://example.org')
* const libp2p = await createLibp2p({
* // other config here
* services: {
* delegatedRouting: client
* }
* })
*
* // later this will use the configured HTTP gateway
* await libp2p.peerRouting.findPeer(peerIdFromString('QmFoo'))
* ```
which is copied automatically to the README

I don't believe we need libp2p/js-http-v1-content-routing anymore since #44 was merged.

However, i think there are still some things that need addressed, because i'm having to patch this package in helia-http-gateway: ipfs/helia-http-gateway@ce971eb

@achingbrain
Copy link
Member

Closing as I think all items here are complete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants