merklize

Jan 4, 2024

Changes in this version

type Merklizer

+ func MerklizerFromBytes(in []byte, opts ...MerklizeOption) (*Merklizer, error)

+ func (mz *Merklizer) MarshalBinary() ([]byte, error)

+ func (mz *Merklizer) UnmarshalBinary(in []byte) error

type RDFEntry

+ func (e *RDFEntry) MarshalBinary() ([]byte, error)

+ func (e *RDFEntry) UnmarshalBinary(in []byte) error

Aug 21, 2023

Changes in this version

+ var ErrIncorrectType = errors.New("incorrect type")

+ var ErrorContextTypeIsEmpty = errors.New("ctxType is empty")

+ var ErrorEntryNotFound = errors.New("entry not found")

+ var ErrorFieldIsEmpty = errors.New("fieldPath is empty")

+ var ErrorUnsupportedType = errors.New("unsupported type")

+ func AddEntriesToMerkleTree(ctx context.Context, mt mtAppender, entries []RDFEntry) error

+ func HashValue(datatype string, value any) (*big.Int, error)

+ func HashValueWithHasher(h Hasher, datatype string, value any) (*big.Int, error)

+ func SetDocumentLoader(docLoader ld.DocumentLoader)

+ func SetHasher(h Hasher)

+ func TypeFromContext(ctxBytes []byte, path string) (string, error)

+ func TypeIDFromContext(ctxBytes []byte, typeName string) (string, error)

+ type Hasher interface

+ Hash func(inpBI []*big.Int) (*big.Int, error)

+ HashBytes func(msg []byte) (*big.Int, error)

+ Prime func() *big.Int

+ type MerkleTree interface

+ Add func(context.Context, *big.Int, *big.Int) error

+ GenerateProof func(context.Context, *big.Int) (*merkletree.Proof, error)

+ Root func() *merkletree.Hash

+ func MerkleTreeSQLAdapter(mt *merkletree.MerkleTree) MerkleTree

+ type MerklizeOption func(m *Merklizer)

+ func WithDocumentLoader(documentLoader ld.DocumentLoader) MerklizeOption

+ func WithHasher(h Hasher) MerklizeOption

+ func WithIPFSClient(ipfsCli *shell.Shell) MerklizeOption

+ func WithIPFSGateway(ipfsGW string) MerklizeOption

+ func WithMerkleTree(mt MerkleTree) MerklizeOption

+ func WithSafeMode(safeMode bool) MerklizeOption

+ type Merklizer struct

+ func MerklizeJSONLD(ctx context.Context, in io.Reader, opts ...MerklizeOption) (*Merklizer, error)

+ func (m *Merklizer) Entry(path Path) (RDFEntry, error)

+ func (m *Merklizer) Hasher() Hasher

+ func (m *Merklizer) JSONLDType(path Path) (string, error)

+ func (m *Merklizer) MkValue(val any) (Value, error)

+ func (m *Merklizer) Options() Options

+ func (m *Merklizer) Proof(ctx context.Context, path Path) (*merkletree.Proof, Value, error)

+ func (m *Merklizer) RawValue(path Path) (any, error)

+ func (m *Merklizer) ResolveDocPath(path string) (Path, error)

+ func (m *Merklizer) Root() *merkletree.Hash

+ type Options struct

+ DocumentLoader ld.DocumentLoader

+ Hasher Hasher

+ func (o Options) FieldPathFromContext(ctxBytes []byte, ctxType, fieldPath string) (Path, error)

+ func (o Options) JSONLDOptions() *ld.JsonLdOptions

+ func (o Options) NewPath(parts ...interface{}) (Path, error)

+ func (o Options) NewPathFromDocument(docBytes []byte, path string) (Path, error)

+ func (o Options) NewRDFEntry(key Path, value interface{}) (RDFEntry, error)

+ func (o Options) PathFromContext(ctxBytes []byte, path string) (Path, error)

+ func (o Options) TypeFromContext(ctxBytes []byte, path string) (string, error)

+ func (o Options) TypeIDFromContext(ctxBytes []byte, typeName string) (string, error)

+ type Path struct

+ func NewFieldPathFromContext(ctxBytes []byte, ctxType, fieldPath string) (Path, error)

+ func NewPath(parts ...interface{}) (Path, error)

+ func NewPathFromContext(ctxBytes []byte, path string) (Path, error)

+ func NewPathFromDocument(docBytes []byte, path string) (Path, error)

+ func (p *Path) Append(parts ...interface{}) error

+ func (p *Path) MtEntry() (*big.Int, error)

+ func (p *Path) Parts() []interface{}

+ func (p *Path) Prepend(parts ...interface{}) error

+ type PoseidonHasher struct

+ func (p PoseidonHasher) Hash(inpBI []*big.Int) (*big.Int, error)

+ func (p PoseidonHasher) HashBytes(msg []byte) (*big.Int, error)

+ func (p PoseidonHasher) Prime() *big.Int

+ type RDFEntry struct

+ func EntriesFromRDF(ds *ld.RDFDataset) ([]RDFEntry, error)

+ func EntriesFromRDFWithHasher(ds *ld.RDFDataset, hasher Hasher) ([]RDFEntry, error)

+ func NewRDFEntry(key Path, value any) (RDFEntry, error)

+ func (e RDFEntry) KeyMtEntry() (*big.Int, error)

+ func (e RDFEntry) KeyValueMtEntries() (keyMtEntry *big.Int, valueMtEntry *big.Int, err error)

+ func (e RDFEntry) ValueMtEntry() (*big.Int, error)

+ type Value interface

+ AsBigInt func() (*big.Int, error)

+ AsBool func() (bool, error)

+ AsInt64 func() (int64, error)

+ AsString func() (string, error)

+ AsTime func() (time.Time, error)

+ IsBigInt func() bool

+ IsBool func() bool

+ IsInt64 func() bool

+ IsString func() bool

+ IsTime func() bool

+ MtEntry func() (*big.Int, error)

+ func NewValue(hasher Hasher, val any) (Value, error)