feat: support provider query parameter #242
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add support for provider query parameter
Description
This PR propagates provider from query parameters as described in https://github.com/vasco-santos/provider-hinted-uri/blob/main/EXPLORATION.md#-uri-design to be used as Hints by Helia's blockBrokers.
Regarding changes, it simply changes
parseUrlString
util function to verify if valid multiaddrs are in the query parameters and also returns them. They are then simply propagated to theoptions
parameter that makes its way to the plugins pipeline, where a broker session is created and is used.These feature is currently behind a feature flag while it is in experimental stage (
allowProviderParameter
)Notes & open questions
Currently does not embed proto in the multiaddrs (for instance
/retrieval/bitswap/retrieval/http
). We will as follow up discuss how to support something along these lines.@achingbrain while this is more experimental, opted to not add example in Readme. Should I add though?
Change checklist