Categorygithub.com/ipld/go-trustless-utils
modulepackage
0.4.1
Repository: https://github.com/ipld/go-trustless-utils.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
12
Dependents
15
Files
190 SLOC

# README

go-trustless-utils

Go(lang) utilities for the IPFS Trustless Gateway HTTP protocol

API

https://pkg.go.dev/github.com/ipld/go-trustless-utils

Examples

For example use see:

  • Lassie - an IPFS retrieval client that supports the Trustless Gateway protocol for retrieval and also as a server when running in daemon mode.
  • Frisbii - a minimal IPLD data provider (server) for the IPFS network using the Trustless Gateway protocol.

License

Apache-2.0/MIT © Protocol Labs

# Packages

Package trustlesshttp provides a set of simple utilities and constants useful for clients and servers implementing the IPFS Trustless Gateway protocol.
Package testutil is a fork of some components of github.com/ipfs/go-graphsync/testutil in order to avoid networking dependencies imposed by Graphsync.
Package traversal provides utilities that operate above the github.com/ipld/go-ipld-prime/traversal system to perform the kinds of traversals required by the IPFS Trustless Gateway protocol, which requires only limited subset of the full go-ipld-prime traversal system.

# Functions

ParseByteRange parses a string form of a ByteRange into a ByteRange.
ParseDagScope parses a string form of a DagScope into a DagScope.
PathEscape both cleans an IPLD path and URL escapes it so that it can be used in a URL path.

# Constants

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

# Structs

ByteRange is used to represent the "entity-bytes" parameter of the IPFS Trustless Gateway protocol.
Request describes the parameters of an IPFS Trustless Gateway request.

# Type aliases

DagScope is used to represent the "dag-scope" parameter of the IPFS Trustless Gateway protocol.