node

package

v0.0.0-...-7d4678c Latest Latest Go to latest Published: Sep 10, 2019 License: Apache-2.0 Imports: 35 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

gitlab.com/remmer.wilts/mobile

Documentation ¶

Index ¶

Variables
func BaseBlockstoreCtor(cacheOpts blockstore.CacheOpts, nilRepo bool, hashOnRead bool) ...
func BlockService(lc fx.Lifecycle, bs blockstore.Blockstore, rem exchange.Interface) blockservice.BlockService
func Dag(bs blockservice.BlockService) format.DAGService
func Datastore(repo repo.Repo) datastore.Datastore
func GcBlockstoreCtor(bb BaseBlocks) (gclocker blockstore.GCLocker, gcbs blockstore.GCBlockstore, ...)
func IPFS(ctx context.Context, bcfg *BuildCfg) fx.Option
func Identity(cfg *config.Config) fx.Option
func LibP2P(bcfg *BuildCfg, cfg *config.Config) fx.Option
func Networked(bcfg *BuildCfg, cfg *config.Config) fx.Option
func Offline(cfg *config.Config) fx.Option
func Online(bcfg *BuildCfg, cfg *config.Config) fx.Option
func OnlineExchange(provide bool) interface{}
func PeerID(id peer.ID) func() peer.ID
func PrivateKey(sk crypto.PrivKey) func(id peer.ID) (crypto.PrivKey, error)
func RecordValidator(ps peerstore.Peerstore) record.Validator
func RepoConfig(repo repo.Repo) (*config.Config, error)
func Storage(bcfg *BuildCfg, cfg *config.Config) fx.Option
type BaseBlocks
type BuildCfg

Constants ¶

This section is empty.

Variables ¶

View Source

var BaseLibP2P = fx.Options(
	fx.Provide(libp2p.ConnectionManager),
	fx.Provide(libp2p.DefaultTransports),

	fx.Provide(libp2p.Host),

	fx.Provide(libp2p.DiscoveryHandler),
)

View Source

var Core = fx.Options(
	fx.Provide(BlockService),
	fx.Provide(Dag),
	fx.Provide(resolver.NewBasicResolver),
)

Core groups basic IPFS services

View Source

var IPNS = fx.Options(
	fx.Provide(RecordValidator),
)

IPNS groups namesys related units

Functions ¶

func BaseBlockstoreCtor ¶

func BaseBlockstoreCtor(cacheOpts blockstore.CacheOpts, nilRepo bool, hashOnRead bool) func(mctx helpers.MetricsCtx, repo repo.Repo, lc fx.Lifecycle) (bs BaseBlocks, err error)

BaseBlockstoreCtor creates cached blockstore backed by the provided datastore

func BlockService ¶

func BlockService(lc fx.Lifecycle, bs blockstore.Blockstore, rem exchange.Interface) blockservice.BlockService

BlockService creates new blockservice which provides an interface to fetch content-addressable blocks

func Dag ¶

func Dag(bs blockservice.BlockService) format.DAGService

Dag creates new DAGService

func Datastore ¶

func Datastore(repo repo.Repo) datastore.Datastore

Datastore provides the datastore

func GcBlockstoreCtor ¶

func GcBlockstoreCtor(bb BaseBlocks) (gclocker blockstore.GCLocker, gcbs blockstore.GCBlockstore, bs blockstore.Blockstore)

GcBlockstoreCtor wraps the base blockstore with GC and Filestore layers

func IPFS ¶

func IPFS(ctx context.Context, bcfg *BuildCfg) fx.Option

IPFS builds a group of fx Options based on the passed BuildCfg

func Identity ¶

func Identity(cfg *config.Config) fx.Option

Identity groups units providing cryptographic identity

func LibP2P ¶

func LibP2P(bcfg *BuildCfg, cfg *config.Config) fx.Option

func Networked ¶

func Networked(bcfg *BuildCfg, cfg *config.Config) fx.Option

func Offline ¶

func Offline(cfg *config.Config) fx.Option

Offline groups offline alternatives to Online units

func Online ¶

func Online(bcfg *BuildCfg, cfg *config.Config) fx.Option

Online groups online-only units

func OnlineExchange ¶

func OnlineExchange(provide bool) interface{}

OnlineExchange creates new LibP2P backed block exchange (BitSwap)

func PeerID ¶

func PeerID(id peer.ID) func() peer.ID

func PrivateKey ¶

func PrivateKey(sk crypto.PrivKey) func(id peer.ID) (crypto.PrivKey, error)

PrivateKey loads the private key from config

func RecordValidator ¶

func RecordValidator(ps peerstore.Peerstore) record.Validator

RecordValidator provides namesys compatible routing record validator

func RepoConfig ¶

func RepoConfig(repo repo.Repo) (*config.Config, error)

RepoConfig loads configuration from the repo

func Storage ¶

func Storage(bcfg *BuildCfg, cfg *config.Config) fx.Option

Storage groups units which setup datastore based persistence and blockstore layers

Types ¶

type BaseBlocks ¶

type BaseBlocks blockstore.Blockstore

BaseBlocks is the lower level blockstore without GC or Filestore layers

type BuildCfg ¶

type BuildCfg struct {
	// If online is set, the node will have networking enabled
	Online bool

	// ExtraOpts is a map of extra options used to configure the ipfs nodes creation
	ExtraOpts map[string]bool

	// If permanent then node should run more expensive processes
	// that will improve performance in long run
	Permanent bool

	Routing libp2p.RoutingOption
	Host    libp2p.HostOption
	Repo    repo.Repo
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
helpers
libp2p

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL