plugin

Documentation

Overview

Package plugin is an interface package for ledger addons.

Index

• Variables
• type Ledger
• type Mapper
• type Plugin
• type TxInfo
  • func (ti TxInfo) String() string
• type TxType
  • func (t TxType) String() string

Variables

var (
	TxDID     = TxInfo{TxType: TxTypeDID}
	TxSchema  = TxInfo{TxType: TxTypeSchema}
	TxCredDef = TxInfo{TxType: TxTypeCredDef}

	ErrNotExist = errors.New("Ledger element doesn't exist")
)

Types

type Ledger

type Ledger interface {
	Plugin
	Mapper
}

Ledger is a plugin interface used to offer implementations of addon ledgers. See pool package for more information.

type Mapper

type Mapper interface {
	Write(tx TxInfo, ID, data string) error

	// Read follows ErrNotExist semantics
	Read(tx TxInfo, ID string) (string, string, error)
}

Mapper is an property getter/setter interface for addon ledger implementations.

type Plugin

type Plugin interface {
	Open(name ...string) bool
	Close()
}

Plugin is a plugin interface for addon ledger implementations.

type TxInfo

type TxInfo struct {
	TxType

	Wallet       int
	SubmitterDID string
	VerKey       string
	Alias        string
	Role         string

	Update bool
}

func (TxInfo) String

func (ti TxInfo) String() string

type TxType

type TxType int

const (
	TxTypeDID TxType = iota
	TxTypeSchema
	TxTypeCredDef
)

func (TxType) String

func (t TxType) String() string