Categoryberty.tech/go-ipfs-log
modulepackage
1.10.2
Repository: https://github.com/berty/go-ipfs-log.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
15
Dependents
18
Files
1.2k SLOC

# README


go-ipfs-log

🤝 Go version of append-only log CRDT on IPFS.

Code Factor Go Report Card GitHub version GoDoc

berty.tech • GitHub

An append-only log on IPFS.

ipfs-log was originally created for orbit-db - a distributed peer-to-peer database on IPFS. This library intends to provide a fully compatible port of the JavaScript version in Go.

The majority of this code was vastly derived from the JavaScript's ipfs-log library.

Usage

See the example package on GoDoc

Licensing

go-ipfs-log is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

# Packages

Package accesscontroller defines a default access controller for IPFS Log, it won't actually check anything.
No description provided by the author
Package entry defines the Entry structure for IPFS Log and its associated methods.
Package errmsg defines error messages used by the Go version of IPFS Log.
Package identityprovider defines a default identity provider for IPFS Log and OrbitDB.
No description provided by the author
No description provided by the author
Package keystore defines a local key manager for OrbitDB and IPFS Log.
No description provided by the author

# Functions

NewFromEntry Creates a IPFSLog from an Entry Creating a log from an entry will retrieve entries from IPFS, thus causing side effects.
NewFromEntryHash Creates a IPFSLog from a hash of an Entry Creating a log from a hash will retrieve entries from IPFS, thus causing side effects.
NewFromJSON Creates a IPFSLog from a JSON Snapshot Creating a log from a JSON Snapshot will retrieve entries from IPFS, thus causing side effects.
NewFromMultihash Creates a IPFSLog from a hash Creating a log from a hash will retrieve entries from IPFS, thus causing side effects.
NewLog Creates creates a new IPFSLog for a given identity Each IPFSLog gets a unique ID, which can be passed in the options as ID.

# Structs

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

# Type aliases

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