store

Documentation

Index

• Variables
• func GenerateIdentityFromSeed(seed []byte) (config.Identity, error)
• type Config
  • func NewDefaultConfig() Config
  • func (c Config) GetSwarmKeySeed(log *logging.Logger, chainID string) string
• type IpfsNode
  • func (i IpfsNode) IpfsAddress() (ma.Multiaddr, error)
• type LevelDbBackedIndex
  • func NewIndex(dataDir string) (*LevelDbBackedIndex, error)
  • func (l LevelDbBackedIndex) Add(indexEntry SegmentIndexEntry) error
  • func (l LevelDbBackedIndex) Close() error
  • func (l LevelDbBackedIndex) Get(height int64) (SegmentIndexEntry, error)
  • func (l LevelDbBackedIndex) GetHighestBlockHeightEntry() (SegmentIndexEntry, error)
  • func (l LevelDbBackedIndex) ListAllEntriesOldestFirst() ([]SegmentIndexEntry, error)
  • func (l LevelDbBackedIndex) Remove(indexEntry SegmentIndexEntry) error
• type PeerConnection
• type SegmentIndexEntry
  • func (i SegmentIndexEntry) GetHistorySegmentId() string
  • func (i SegmentIndexEntry) GetPreviousHistorySegmentId() string
• type SegmentMetaData
  • func (m SegmentMetaData) GetFromHeight() int64
  • func (m SegmentMetaData) GetToHeight() int64
• type Store
  • func New(ctx context.Context, log *logging.Logger, chainID string, cfg Config, ...) (*Store, error)
  • func (p *Store) AddSnapshotData(ctx context.Context, historySnapshot snapshot.History, ...) (err error)
  • func (p *Store) ConnectedToPeer(peerIDStr string) (bool, error)
  • func (p *Store) CopyHistorySegmentToFile(ctx context.Context, historySegmentID string, targetFile string) error
  • func (p *Store) CopySnapshotDataIntoDir(ctx context.Context, toHeight int64, targetDir string) (currentStateSnapshot snapshot.CurrentState, historySnapshot snapshot.History, ...)
  • func (p *Store) FetchHistorySegment(ctx context.Context, historySegmentID string) (SegmentIndexEntry, error)
  • func (p *Store) GetConnectedPeers() []PeerConnection
  • func (p *Store) GetHighestBlockHeightEntry() (SegmentIndexEntry, error)
  • func (p *Store) GetLocalNode() (IpfsNode, error)
  • func (p *Store) GetPeerID() string
  • func (p *Store) GetSwarmKey() string
  • func (p *Store) GetSwarmKeySeed() string
  • func (p *Store) ListAllIndexEntriesOldestFirst() ([]SegmentIndexEntry, error)
  • func (p *Store) ResetIndex() error
  • func (p *Store) Stop()

Variables

var ErrIndexEntryNotFound = errors.New("index entry not found")

var ErrSegmentNotFound = errors.New("segment not found")

Functions

func GenerateIdentityFromSeed

func GenerateIdentityFromSeed(seed []byte) (config.Identity, error)

Types

type Config

type Config struct {
	// Mandatory Setting, must be set
	PeerID  string `long:"peer-id" description:"the ipfs peer id of this node"`
	PrivKey string `long:"priv-key" description:"the ipfs priv key of this node"`

	// Optional Settings
	BootstrapPeers []string `` /* 145-byte string literal not displayed */
	SwarmPort      int      `long:"swarm-port" description:"ipfs swarm port"`

	// Without this there would be no way to isolate an environment if needed and process a given chains data (e.g. for dev)
	SwarmKeyOverride string `long:"swarm-key-override" description:"optional swarm key override, the default behaviour is to use the datanode's chain id'"`

	HistoryRetentionBlockSpan int64 `` /* 138-byte string literal not displayed */
}

func NewDefaultConfig

func NewDefaultConfig() Config

func (Config) GetSwarmKeySeed

func (c Config) GetSwarmKeySeed(log *logging.Logger, chainID string) string

type IpfsNode

type IpfsNode struct {
	IpfsId peer.ID
	Addr   ma.Multiaddr
}

func (IpfsNode) IpfsAddress

func (i IpfsNode) IpfsAddress() (ma.Multiaddr, error)

type LevelDbBackedIndex

type LevelDbBackedIndex struct {
	// contains filtered or unexported fields
}

func NewIndex

func NewIndex(dataDir string) (*LevelDbBackedIndex, error)

func (LevelDbBackedIndex) Add

func (l LevelDbBackedIndex) Add(indexEntry SegmentIndexEntry) error

func (LevelDbBackedIndex) Close

func (l LevelDbBackedIndex) Close() error

func (LevelDbBackedIndex) Get

func (l LevelDbBackedIndex) Get(height int64) (SegmentIndexEntry, error)

func (LevelDbBackedIndex) GetHighestBlockHeightEntry

func (l LevelDbBackedIndex) GetHighestBlockHeightEntry() (SegmentIndexEntry, error)

func (LevelDbBackedIndex) ListAllEntriesOldestFirst

func (l LevelDbBackedIndex) ListAllEntriesOldestFirst() ([]SegmentIndexEntry, error)

func (LevelDbBackedIndex) Remove

func (l LevelDbBackedIndex) Remove(indexEntry SegmentIndexEntry) error

type PeerConnection

type PeerConnection struct {
	Local  IpfsNode
	Remote IpfsNode
}

type SegmentIndexEntry

type SegmentIndexEntry struct {
	SegmentMetaData
	HistorySegmentID string
}

func (SegmentIndexEntry) GetHistorySegmentId

func (i SegmentIndexEntry) GetHistorySegmentId() string

func (SegmentIndexEntry) GetPreviousHistorySegmentId

func (i SegmentIndexEntry) GetPreviousHistorySegmentId() string

type SegmentMetaData

type SegmentMetaData struct {
	HeightFrom               int64
	HeightTo                 int64
	ChainID                  string
	PreviousHistorySegmentID string
}

func (SegmentMetaData) GetFromHeight

func (m SegmentMetaData) GetFromHeight() int64

func (SegmentMetaData) GetToHeight

func (m SegmentMetaData) GetToHeight() int64

type Store

type Store struct {
	// contains filtered or unexported fields
}

func New

func New(ctx context.Context, log *logging.Logger, chainID string, cfg Config, networkHistoryHome string,
	wipeOnStartup bool, maxMemoryPercent uint8,
) (*Store, error)

func (*Store) AddSnapshotData

func (p *Store) AddSnapshotData(ctx context.Context, historySnapshot snapshot.History, currentState snapshot.CurrentState,
	sourceDir string,
) (err error)

func (*Store) ConnectedToPeer

func (p *Store) ConnectedToPeer(peerIDStr string) (bool, error)

func (*Store) CopyHistorySegmentToFile

func (p *Store) CopyHistorySegmentToFile(ctx context.Context, historySegmentID string, targetFile string) error

func (*Store) CopySnapshotDataIntoDir

func (p *Store) CopySnapshotDataIntoDir(ctx context.Context, toHeight int64, targetDir string) (currentStateSnapshot snapshot.CurrentState,
	historySnapshot snapshot.History, err error,
)

func (*Store) FetchHistorySegment

func (p *Store) FetchHistorySegment(ctx context.Context, historySegmentID string) (SegmentIndexEntry, error)

func (*Store) GetConnectedPeers

func (p *Store) GetConnectedPeers() []PeerConnection

func (*Store) GetHighestBlockHeightEntry

func (p *Store) GetHighestBlockHeightEntry() (SegmentIndexEntry, error)

func (*Store) GetLocalNode

func (p *Store) GetLocalNode() (IpfsNode, error)

func (*Store) GetPeerID

func (p *Store) GetPeerID() string

func (*Store) GetSwarmKey

func (p *Store) GetSwarmKey() string

func (*Store) GetSwarmKeySeed

func (p *Store) GetSwarmKeySeed() string

func (*Store) ListAllIndexEntriesOldestFirst

func (p *Store) ListAllIndexEntriesOldestFirst() ([]SegmentIndexEntry, error)

func (*Store) ResetIndex

func (p *Store) ResetIndex() error

func (*Store) Stop

func (p *Store) Stop()