ahtree

Documentation

Index

• Constants
• Variables
• func EvalConsistency(cproof [][sha256.Size]byte, i, j uint64) ([sha256.Size]byte, [sha256.Size]byte)
• func EvalInclusion(iproof [][sha256.Size]byte, i, j uint64, iLeaf [sha256.Size]byte) [sha256.Size]byte
• func EvalLastInclusion(iproof [][sha256.Size]byte, i uint64, leaf [sha256.Size]byte) [sha256.Size]byte
• func VerifyConsistency(cproof [][sha256.Size]byte, i, j uint64, iRoot, jRoot [sha256.Size]byte) bool
• func VerifyInclusion(iproof [][sha256.Size]byte, i, j uint64, iLeaf, jRoot [sha256.Size]byte) bool
• func VerifyLastInclusion(iproof [][sha256.Size]byte, i uint64, leaf, root [sha256.Size]byte) bool
• type AHtree
  • func Open(path string, opts *Options) (*AHtree, error)
  • func OpenWith(pLog, dLog, cLog appendable.Appendable, opts *Options) (*AHtree, error)
  • func (t *AHtree) Append(d []byte) (n uint64, h [sha256.Size]byte, err error)
  • func (t *AHtree) Close() error
  • func (t *AHtree) ConsistencyProof(i, j uint64) (p [][sha256.Size]byte, err error)
  • func (t *AHtree) DataAt(n uint64) ([]byte, error)
  • func (t *AHtree) InclusionProof(i, j uint64) (p [][sha256.Size]byte, err error)
  • func (t *AHtree) ResetSize(newSize uint64) error
  • func (t *AHtree) Root() (n uint64, r [sha256.Size]byte, err error)
  • func (t *AHtree) RootAt(n uint64) (r [sha256.Size]byte, err error)
  • func (t *AHtree) Size() uint64
  • func (t *AHtree) Sync() error
• type AppFactoryFunc
• type Options
  • func DefaultOptions() *Options
  • func (opts *Options) Validate() error
  • func (opts *Options) WithAppFactory(appFactory AppFactoryFunc) *Options
  • func (opts *Options) WithAutoSync(autoSync bool) *Options
  • func (opts *Options) WithCompresionLevel(compressionLevel int) *Options
  • func (opts *Options) WithCompressionFormat(compressionFormat int) *Options
  • func (opts *Options) WithDataCacheSlots(cacheSlots int) *Options
  • func (opts *Options) WithDigestsCacheSlots(cacheSlots int) *Options
  • func (opts *Options) WithFileMode(fileMode os.FileMode) *Options
  • func (opts *Options) WithFileSize(fileSize int) *Options
  • func (opts *Options) WithReadBufferSize(size int) *Options
  • func (opts *Options) WithReadOnly(readOnly bool) *Options
  • func (opts *Options) WithRetryableSync(retryableSync bool) *Options
  • func (opts *Options) WithSyncThld(syncThld int) *Options
  • func (opts *Options) WithWriteBufferSize(size int) *Options

Constants

const DefaultCompressionFormat = appendable.DefaultCompressionFormat

const DefaultCompressionLevel = appendable.DefaultCompressionLevel

const DefaultDataCacheSlots = 1_000

const DefaultDigestsCacheSlots = 100_000

const DefaultFileMode = os.FileMode(0755)

const DefaultFileSize = multiapp.DefaultFileSize

const DefaultSyncThld = 100_000

const DefaultWriteBufferSize = 1 << 24 //16Mb

const LeafPrefix = byte(0)

const (
	MetaVersion = "VERSION"
)

const NodePrefix = byte(1)

const Version = 1

Variables

var ErrAlreadyClosed = errors.New("ahtree: already closed")

var ErrCannotResetToLargerSize = errors.New("ahtree: can not reset the tree to a larger size")

var ErrEmptyTree = errors.New("ahtree: empty tree")

var ErrIllegalArguments = errors.New("ahtree: illegal arguments")

var ErrInvalidOptions = fmt.Errorf("%w: invalid options", ErrIllegalArguments)

var ErrReadOnly = errors.New("ahtree: read-only mode")

var ErrUnexistentData = errors.New("ahtree: attempt to read unexistent data")

var ErrorCorruptedData = errors.New("ahtree: data log is corrupted")

var ErrorCorruptedDigests = errors.New("ahtree: hash log is corrupted")

var ErrorPathIsNotADirectory = errors.New("ahtree: path is not a directory")

Functions

func EvalConsistency

func EvalConsistency(cproof [][sha256.Size]byte, i, j uint64) ([sha256.Size]byte, [sha256.Size]byte)

func EvalInclusion

func EvalInclusion(iproof [][sha256.Size]byte, i, j uint64, iLeaf [sha256.Size]byte) [sha256.Size]byte

func EvalLastInclusion

func EvalLastInclusion(iproof [][sha256.Size]byte, i uint64, leaf [sha256.Size]byte) [sha256.Size]byte

func VerifyConsistency

func VerifyConsistency(cproof [][sha256.Size]byte, i, j uint64, iRoot, jRoot [sha256.Size]byte) bool

func VerifyInclusion

func VerifyInclusion(iproof [][sha256.Size]byte, i, j uint64, iLeaf, jRoot [sha256.Size]byte) bool

func VerifyLastInclusion

func VerifyLastInclusion(iproof [][sha256.Size]byte, i uint64, leaf, root [sha256.Size]byte) bool

Types

type AHtree

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

AHtree stands for Appendable Hash Tree

func Open

func Open(path string, opts *Options) (*AHtree, error)

func OpenWith

func OpenWith(pLog, dLog, cLog appendable.Appendable, opts *Options) (*AHtree, error)

func (*AHtree) Append

func (t *AHtree) Append(d []byte) (n uint64, h [sha256.Size]byte, err error)

func (*AHtree) Close

func (t *AHtree) Close() error

func (*AHtree) ConsistencyProof

func (t *AHtree) ConsistencyProof(i, j uint64) (p [][sha256.Size]byte, err error)

func (*AHtree) DataAt

func (t *AHtree) DataAt(n uint64) ([]byte, error)

func (*AHtree) InclusionProof

func (t *AHtree) InclusionProof(i, j uint64) (p [][sha256.Size]byte, err error)

func (*AHtree) ResetSize

func (t *AHtree) ResetSize(newSize uint64) error

func (*AHtree) Root

func (t *AHtree) Root() (n uint64, r [sha256.Size]byte, err error)

func (*AHtree) RootAt

func (t *AHtree) RootAt(n uint64) (r [sha256.Size]byte, err error)

func (*AHtree) Size

func (t *AHtree) Size() uint64

func (*AHtree) Sync

func (t *AHtree) Sync() error

type AppFactoryFunc

type AppFactoryFunc func(
	rootPath string,
	subPath string,
	opts *multiapp.Options,
) (appendable.Appendable, error)

type Options

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

func DefaultOptions

func DefaultOptions() *Options

func (*Options) Validate

func (opts *Options) Validate() error

func (*Options) WithAppFactory

func (opts *Options) WithAppFactory(appFactory AppFactoryFunc) *Options

func (*Options) WithAutoSync

func (opts *Options) WithAutoSync(autoSync bool) *Options

func (*Options) WithCompresionLevel

func (opts *Options) WithCompresionLevel(compressionLevel int) *Options

func (*Options) WithCompressionFormat

func (opts *Options) WithCompressionFormat(compressionFormat int) *Options

func (*Options) WithDataCacheSlots

func (opts *Options) WithDataCacheSlots(cacheSlots int) *Options

func (*Options) WithDigestsCacheSlots

func (opts *Options) WithDigestsCacheSlots(cacheSlots int) *Options

func (*Options) WithFileMode

func (opts *Options) WithFileMode(fileMode os.FileMode) *Options

func (*Options) WithFileSize

func (opts *Options) WithFileSize(fileSize int) *Options

func (*Options) WithReadBufferSize

func (opts *Options) WithReadBufferSize(size int) *Options

func (*Options) WithReadOnly

func (opts *Options) WithReadOnly(readOnly bool) *Options

func (*Options) WithRetryableSync

func (opts *Options) WithRetryableSync(retryableSync bool) *Options

func (*Options) WithSyncThld

func (opts *Options) WithSyncThld(syncThld int) *Options

func (*Options) WithWriteBufferSize

func (opts *Options) WithWriteBufferSize(size int) *Options