Categorygithub.com/ipfs-shipyard/w3rc
modulepackage
0.0.0-20240322071808-de8e8a8f202d
Repository: https://github.com/ipfs-shipyard/w3rc.git
Documentation: pkg.go.dev

# README

A Web3 Retrieval Client

An experimental retrieval client for web3 content.

This client attempts to delegate the content routing problem, using a delegated content routing interface like the one provided by storetheindex. It then will attempt to provide as simple as possible retrieval of discovered content, focusing on simplicity over optimality.

License

Licensed under either of

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

NewSession creates a Session with given configuration.
WithDataTransfer runs the session using an existing data transfer manager.
WithDS sets the datastore to use for the session.
WithHost sets a libp2p host for the client to use.
WithIndexer sets a URL of the indexer to use.

# Constants

These are valid status codes.
These are valid status codes.
These are valid status codes.

# Structs

A ProgressResult is an individual update from a call to `GetStream` The result will either have a status of `Error` and an Error set, or will have a node and path set.

# Interfaces

A Session is able to fetch content addressed data.

# Type aliases

An Option allows opening a Session with configured options.
Status is a code of the type of an individual Progress Result.