orbitdb

README

go-orbit-db

🤝 Go version of orbit-db.

berty.tech • GitHub

A P2P Database on IPFS.

orbit-db is a distributed peer-to-peer database on IPFS. This project 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 orbit-db project.

Usage

See GoDoc.

Install

Constraints:

• go-orbit-db currently only works with go1.16 and later
• You need to use the canonical import: github.com/stateless-minds/go-orbit-db instead of github.com/berty/go-orbit-db
• If you have 410 gone errors, make sure that you use a reliable $GOPROXY or disable it completely

Example:

$ go version
go version go1.17.3 darwin/amd64
$ go get github.com/stateless-minds/go-orbit-db
[...]
$

Licensing

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

Documentation

Overview

orbitdb implements the OrbitDB interface

Index

• Constants
• Variables
• func NewOrbitDB(ctx context.Context, ipfs coreiface.CoreAPI, options *NewOrbitDBOptions) (iface.OrbitDB, error)
• type CreateDBOptions
• type CreateDocumentDBOptions
• type DetermineAddressOptions
• type DocumentStore
• type EventExchangeHeads
  • func NewEventExchangeHeads(p peer.ID, msg *iface.MessageExchangeHeads) EventExchangeHeads
• type EventLogStore
• type IndexConstructor
• type KeyValueStore
• type NewOrbitDBOptions
• type OnWritePrototype
• type OrbitDB
• type Store
• type StoreConstructor
• type StoreIndex
• type StreamOptions

Constants

const CBORReadDefaultTimeout = time.Second * 30

Variables

var AtlasManifestEnvelope = atlas.BuildEntry(utils.ManifestEnvelope{}).
	StructMap().
	AddField("Manifest", atlas.StructMapEntry{SerialName: "manifest"}).
	AddField("SkipManifest", atlas.StructMapEntry{SerialName: "skip_manifest"}).
	AddField("Address", atlas.StructMapEntry{SerialName: "address"}).
	AddField("ManifestType", atlas.StructMapEntry{SerialName: "manifest/type"}).
	AddField("Type", atlas.StructMapEntry{SerialName: "type"}).
	AddField("Name", atlas.StructMapEntry{SerialName: "name"}).
	AddField("AccessController", atlas.StructMapEntry{SerialName: "access_controller"}).
	Complete()

Functions

func NewOrbitDB

func NewOrbitDB(ctx context.Context, ipfs coreiface.CoreAPI, options *NewOrbitDBOptions) (iface.OrbitDB, error)

NewOrbitDB Creates a new OrbitDB instance with default access controllers and store types

Types

type CreateDBOptions

type CreateDBOptions = iface.CreateDBOptions

CreateDBOptions An alias of the type defined in the iface package

type CreateDocumentDBOptions

type CreateDocumentDBOptions = iface.CreateDocumentDBOptions

CreateDocumentDBOptions An alias of the type defined in the iface package

type DetermineAddressOptions

type DetermineAddressOptions = iface.DetermineAddressOptions

DetermineAddressOptions An alias of the type defined in the iface package

type DocumentStore

type DocumentStore = iface.DocumentStore

DocumentStore An alias of the type defined in the iface package

type EventExchangeHeads

type EventExchangeHeads struct {
	Peer    peer.ID
	Message *iface.MessageExchangeHeads
}

func NewEventExchangeHeads

func NewEventExchangeHeads(p peer.ID, msg *iface.MessageExchangeHeads) EventExchangeHeads

type EventLogStore

type EventLogStore = iface.EventLogStore

EventLogStore An alias of the type defined in the iface package

type IndexConstructor

type IndexConstructor = iface.IndexConstructor

IndexConstructor An alias of the type defined in the iface package

type KeyValueStore

type KeyValueStore = iface.KeyValueStore

KeyValueStore An alias of the type defined in the iface package

type NewOrbitDBOptions

type NewOrbitDBOptions struct {
	ID                   *string
	PeerID               peer.ID
	Directory            *string
	Keystore             keystore.Interface
	Cache                cache.Interface
	Identity             *idp.Identity
	CloseKeystore        func() error
	Logger               *zap.Logger
	Tracer               trace.Tracer
	DirectChannelFactory iface.DirectChannelFactory
	PubSub               iface.PubSubInterface
	MessageMarshaler     iface.MessageMarshaler
	EventBus             event.Bus
}

NewOrbitDBOptions Options for a new OrbitDB instance

type OnWritePrototype

type OnWritePrototype = iface.OnWritePrototype

OnWritePrototype An alias of the type defined in the iface package

type OrbitDB

type OrbitDB = iface.OrbitDB

OrbitDB An alias of the type defined in the iface package

type Store

type Store = iface.Store

Store An alias of the type defined in the iface package

type StoreConstructor

type StoreConstructor = iface.StoreConstructor

StoreConstructor An alias of the type defined in the iface package

type StoreIndex

type StoreIndex = iface.StoreIndex

StoreIndex An alias of the type defined in the iface package

type StreamOptions

type StreamOptions = iface.StreamOptions

StreamOptions An alias of the type defined in the iface package