api

package

Go to main page

Versions in this module

v0

v0.2.0

Apr 29, 2026

Changes in this version

+ const BitmapSize

+ const CertificationDataTag

+ const CertificationRequestTag

+ const InclusionProofTag

+ const InclusionProofV2HashAlgorithm

+ const PredicateTag

+ const SiblingSize

+ const StateTreeKeyLengthBits

+ const StateTreeKeyLengthBytes

+ var ErrCertBitmapMismatch = errors.New("inclusion cert: sibling count does not match bitmap popcount")

+ var ErrCertChildRootMismatch = errors.New("inclusion cert: parent fragment shard leaf value does not match child root")

+ var ErrCertDepthOrder = errors.New("inclusion cert: parent cert depths must be shallower than child cert depths")

+ var ErrCertDepthOverlap = errors.New("inclusion cert: parent and child cert overlap in depth")

+ var ErrCertKeyLength = errors.New("inclusion cert: invalid key length")

+ var ErrCertMisalignedSibs = errors.New("inclusion cert: sibling bytes not aligned to 32")

+ var ErrCertMissingChild = errors.New("inclusion cert: missing child cert")

+ var ErrCertMissingParent = errors.New("inclusion cert: missing parent fragment")

+ var ErrCertRootLength = errors.New("inclusion cert: invalid root length")

+ var ErrCertRootMismatch = errors.New("inclusion cert: root mismatch")

+ var ErrCertSiblingUnderflow = errors.New("inclusion cert: sibling underflow during verification")

+ var ErrCertTruncated = errors.New("inclusion cert: truncated")

+ var ErrCertUnknownAlgo = errors.New("inclusion cert: unknown hash algorithm")

+ var ErrExclusionNotImpl = errors.New("exclusion cert: verification not yet implemented")

+ func FixedBytesToPath(key []byte, keyLengthBits int) (*big.Int, error)

+ func MatchesShardPrefix(keyBytes []byte, shardBitmask int) (bool, error)

+ func MatchesShardPrefixFromHex(keyHex string, shardBitmask int) (bool, error)

+ func PathToFixedBytes(path *big.Int, keyLengthBits int) ([]byte, error)

type Block

+ ParentBlockNumber uint64

+ ParentFragment *ParentInclusionFragment

type CertificationData

+ Version types.Version

+ func (c *CertificationData) GetVersion() types.Version

+ func (c *CertificationData) MarshalCBOR() ([]byte, error)

+ func (c *CertificationData) UnmarshalCBOR(data []byte) error

type CertificationRequest

+ Version types.Version

+ func (c *CertificationRequest) GetVersion() types.Version

+ func (c *CertificationRequest) MarshalCBOR() ([]byte, error)

+ func (c *CertificationRequest) UnmarshalCBOR(data []byte) error

+ type ExclusionCert struct

+ Bitmap [BitmapSize]byte

+ HL [SiblingSize]byte

+ KL [SiblingSize]byte

+ Siblings [][SiblingSize]byte

+ func (c *ExclusionCert) MarshalBinary() ([]byte, error)

+ func (c *ExclusionCert) UnmarshalBinary(data []byte) error

+ func (c *ExclusionCert) Verify(queryKey, expectedRoot []byte, algo HashAlgorithm) error

type GetShardProofResponse

+ BlockNumber uint64

+ ParentFragment *ParentInclusionFragment

type ImprintV2

+ func (r ImprintV2) GetTreeKey() ([]byte, error)

+ type InclusionCert struct

+ Bitmap [BitmapSize]byte

+ Siblings [][SiblingSize]byte

+ func ComposeInclusionCert(parentFragment *ParentInclusionFragment, child *InclusionCert, ...) (*InclusionCert, error)

+ func (c *InclusionCert) MarshalBinary() ([]byte, error)

+ func (c *InclusionCert) UnmarshalBinary(data []byte) error

+ func (c *InclusionCert) Verify(key, value, expectedRoot []byte, algo HashAlgorithm) error

type InclusionProofV2

+ CertificateBytes HexBytes

+ Version types.Version

+ func (p *InclusionProofV2) GetVersion() types.Version

+ func (p *InclusionProofV2) MarshalCBOR() ([]byte, error)

+ func (p *InclusionProofV2) UCInputRecordHashRaw() ([]byte, error)

+ func (p *InclusionProofV2) UnmarshalCBOR(data []byte) error

+ type ParentInclusionFragment struct

+ CertificateBytes HexBytes

+ ShardLeafValue HexBytes

+ func (f *ParentInclusionFragment) Verify(shardID ShardID, keyLength int, expectedLeafValue, expectedRoot []byte, ...) error

type Predicate

+ func (p *Predicate) UnmarshalCBOR(data []byte) error

+ func (p Predicate) MarshalCBOR() ([]byte, error)

type RootShardInclusionProof

+ BlockNumber uint64

+ ParentFragment *ParentInclusionFragment

type Sharding

+ BFTShardID string

+ type VerifierContext struct

+ ExpectedShardID types.ShardID

+ PartitionID types.PartitionID

+ ShardConfHash []byte

+ TrustBase types.RootTrustBase

v0.1.0

Mar 26, 2026

Changes in this version

+ const HealthStatusDegraded

+ const HealthStatusOk

+ const HealthStatusUnhealthy

+ const ShardRootStatusInternalError

+ const ShardRootStatusInvalidRootHash

+ const ShardRootStatusInvalidShardID

+ const ShardRootStatusNotLeader

+ const ShardRootStatusNotReady

+ const ShardRootStatusSuccess

+ func BigintEncode(value *big.Int) []byte

+ func CborArray(n int) []byte

+ func CborBytes(n int) []byte

+ func CborNull() []byte

+ func ValidateRequestID(requestID RequestID, publicKey []byte, stateHashBytes []byte) (bool, error)

+ func ValidateStateID(stateID StateID, sourceStateHash SourceStateHash, ownerPredicate Predicate) (bool, error)

+ type AggregatorRecord struct

+ AggregateRequestCount uint64

+ BlockNumber *BigInt

+ CertificationData CertificationData

+ CreatedAt *Timestamp

+ FinalizedAt *Timestamp

+ LeafIndex *BigInt

+ StateID StateID

+ type AggregatorRecordV1 struct

+ AggregateRequestCount uint64

+ Authenticator Authenticator

+ BlockNumber *BigInt

+ CreatedAt *Timestamp

+ FinalizedAt *Timestamp

+ LeafIndex *BigInt

+ RequestID RequestID

+ TransactionHash TransactionHash

+ func NewAggregatorRecordV1(commitment *Commitment, blockNumber, leafIndex *BigInt) *AggregatorRecordV1

+ type Authenticator struct

+ Algorithm string

+ PublicKey HexBytes

+ Signature HexBytes

+ StateHash SourceStateHash

+ type BigInt struct

+ func NewBigInt(x *big.Int) *BigInt

+ func NewBigIntFromString(s string) (*BigInt, error)

+ func NewBigIntFromUint64(n uint64) *BigInt

+ func (b *BigInt) MarshalJSON() ([]byte, error)

+ func (b *BigInt) String() string

+ func (b *BigInt) UnmarshalJSON(data []byte) error

+ type Block struct

+ ChainID string

+ CreatedAt *Timestamp

+ ForkID string

+ Index *BigInt

+ NoDeletionProofHash HexBytes

+ ParentMerkleTreePath *MerkleTreePath

+ PreviousBlockHash HexBytes

+ RootHash HexBytes

+ ShardID ShardID

+ UnicityCertificate HexBytes

+ Version string

+ type CertificationData struct

+ OwnerPredicate Predicate

+ SourceStateHash SourceStateHash

+ TransactionHash TransactionHash

+ Witness HexBytes

+ func (c CertificationData) CreateStateID() (StateID, error)

+ func (c CertificationData) Hash() ([]byte, error)

+ func (c CertificationData) SigDataHash() (*DataHash, error)

+ type CertificationRequest struct

+ AggregateRequestCount uint64

+ CertificationData CertificationData

+ StateID StateID

+ func (c *CertificationRequest) MarshalJSON() ([]byte, error)

+ func (c *CertificationRequest) UnmarshalJSON(data []byte) error

+ type CertificationResponse struct

+ Status string

+ type Commitment struct

+ AggregateRequestCount uint64

+ Authenticator Authenticator

+ CreatedAt *Timestamp

+ ProcessedAt *Timestamp

+ RequestID RequestID

+ TransactionHash TransactionHash

+ func NewCommitment(requestID RequestID, transactionHash TransactionHash, ...) *Commitment

+ func NewCommitmentWithAggregate(requestID RequestID, transactionHash TransactionHash, ...) *Commitment

+ func (c *Commitment) CreateLeafValue() ([]byte, error)

+ type DataHash struct

+ Algorithm HashAlgorithm

+ RawHash []byte

+ func CertDataHash(ownerPredicate Predicate, sourceStateHash, transactionHash, signature []byte) (*DataHash, error)

+ func NewDataHash(algorithm HashAlgorithm, hash []byte) *DataHash

+ func SigDataHash(sourceStateHash []byte, transactionHash []byte) *DataHash

+ func StateIDDataHash(ownerPredicate Predicate, sourceStateHash []byte) (*DataHash, error)

+ func (h *DataHash) GetImprint() []byte

+ func (h *DataHash) ToHex() string

+ type DataHasher struct

+ func NewDataHasher(algorithm HashAlgorithm) *DataHasher

+ func (h *DataHasher) AddCborBytes(data []byte) *DataHasher

+ func (h *DataHasher) AddCborNull() *DataHasher

+ func (h *DataHasher) AddData(data []byte) *DataHasher

+ func (h *DataHasher) GetAlgorithm() HashAlgorithm

+ func (h *DataHasher) GetHash() *DataHash

+ func (h *DataHasher) Reset() *DataHasher

+ func (h *DataHasher) SumRaw(dst []byte) []byte

+ type GetBlockCommitmentsRequest struct

+ BlockNumber *BigInt

+ type GetBlockCommitmentsResponse struct

+ Commitments []*AggregatorRecordV1

+ type GetBlockHeightResponse struct

+ BlockNumber *BigInt

+ type GetBlockRecords struct

+ BlockNumber *BigInt

+ type GetBlockRecordsResponse struct

+ AggregatorRecords []*AggregatorRecord

+ type GetBlockRequest struct

+ BlockNumber interface{}

+ type GetBlockResponse struct

+ Block *Block

+ TotalCommitments uint64

+ type GetInclusionProofRequestV1 struct

+ RequestID RequestID

+ type GetInclusionProofRequestV2 struct

+ StateID StateID

+ type GetInclusionProofResponseV1 struct

+ InclusionProof *InclusionProofV1

+ type GetInclusionProofResponseV2 struct

+ BlockNumber uint64

+ InclusionProof *InclusionProofV2

+ func (c *GetInclusionProofResponseV2) MarshalJSON() ([]byte, error)

+ func (c *GetInclusionProofResponseV2) UnmarshalJSON(data []byte) error

+ type GetNoDeletionProofResponse struct

+ NoDeletionProof *NoDeletionProof

+ type GetShardProofRequest struct

+ ShardID ShardID

+ type GetShardProofResponse struct

+ MerkleTreePath *MerkleTreePath

+ UnicityCertificate HexBytes

+ type HashAlgorithm int

+ const SHA256

+ const SHA3_256

+ type HealthStatus struct

+ Details map[string]string

+ Role string

+ ServerID string

+ Sharding Sharding

+ Status string

+ func NewHealthStatus(role, serverID string) *HealthStatus

+ func (h *HealthStatus) AddDetail(key, value string)

+ type HexBytes []byte

+ func NewHexBytes(data []byte) HexBytes

+ func NewHexBytesFromString(s string) (HexBytes, error)

+ func (h *HexBytes) UnmarshalJSON(data []byte) error

+ func (h HexBytes) MarshalJSON() ([]byte, error)

+ func (h HexBytes) String() string

+ type ImprintV2 HexBytes

+ func NewImprintV2(s string) (ImprintV2, error)

+ func (r *ImprintV2) UnmarshalCBOR(cborBytes []byte) error

+ func (r *ImprintV2) UnmarshalJSON(data []byte) error

+ func (r ImprintV2) Algorithm() []byte

+ func (r ImprintV2) Bytes() []byte

+ func (r ImprintV2) DataBytes() []byte

+ func (r ImprintV2) GetPath() (*big.Int, error)

+ func (r ImprintV2) Imprint() []byte

+ func (r ImprintV2) IsV1() bool

+ func (r ImprintV2) MarshalCBOR() ([]byte, error)

+ func (r ImprintV2) MarshalJSON() ([]byte, error)

+ func (r ImprintV2) String() string

+ type InclusionProofV1 struct

+ Authenticator *Authenticator

+ MerkleTreePath *MerkleTreePath

+ TransactionHash *TransactionHash

+ UnicityCertificate HexBytes

+ func (p *InclusionProofV1) Verify(v1 *Commitment) error

+ type InclusionProofV2 struct

+ CertificationData *CertificationData

+ MerkleTreePath *MerkleTreePath

+ UnicityCertificate types.RawCBOR

+ func (p *InclusionProofV2) Verify(v2 *CertificationRequest) error

+ type MerkleTreePath struct

+ Root string

+ Steps []MerkleTreeStep

+ func (m *MerkleTreePath) UnmarshalCBOR(data []byte) error

+ func (m *MerkleTreePath) Verify(stateID *big.Int) (*PathVerificationResult, error)

+ func (m MerkleTreePath) MarshalCBOR() ([]byte, error)

+ type MerkleTreeStep struct

+ Data *string

+ Path string

+ type NoDeletionProof struct

+ CreatedAt *Timestamp

+ Proof HexBytes

+ func NewNoDeletionProof(proof HexBytes) *NoDeletionProof

+ type PathVerificationResult struct

+ PathIncluded bool

+ PathValid bool

+ Result bool

+ type Predicate struct

+ Code []byte

+ Engine uint

+ Params []byte

+ func NewPayToPublicKeyPredicate(publicKey []byte) Predicate

+ type ReceiptRequestV1 struct

+ Method string

+ RequestID RequestID

+ Service string

+ StateHash SourceStateHash

+ TransactionHash TransactionHash

+ type ReceiptV1 struct

+ Algorithm string

+ PublicKey HexBytes

+ Request ReceiptRequestV1

+ Signature HexBytes

+ func NewReceiptV1(commitment *Commitment, algorithm string, publicKey, signature HexBytes) *ReceiptV1

+ type RequestID = ImprintV2

+ func CreateRequestID(publicKey []byte, stateHash ImprintV2) (RequestID, error)

+ func CreateRequestIDFromBytes(publicKey []byte, stateHashBytes []byte) (RequestID, error)

+ type RootShardInclusionProof struct

+ MerkleTreePath *MerkleTreePath

+ UnicityCertificate HexBytes

+ func (r *RootShardInclusionProof) IsValid(shardRootHash string) bool

+ type ShardID = int

+ type Sharding struct

+ Mode string

+ ShardID int

+ ShardIDLen int

+ type SourceStateHash = ImprintV2

+ type StateID = ImprintV2

+ func CreateStateID(ownerPredicate Predicate, sourceStateHash SourceStateHash) (StateID, error)

+ func RequireNewImprintV2(s string) StateID

+ type SubmitCommitmentRequest struct

+ AggregateRequestCount uint64

+ Authenticator Authenticator

+ Receipt *bool

+ RequestID RequestID

+ TransactionHash TransactionHash

+ type SubmitCommitmentResponse struct

+ Receipt *ReceiptV1

+ Status string

+ type SubmitShardRootRequest struct

+ RootHash HexBytes

+ ShardID ShardID

+ type SubmitShardRootResponse struct

+ Status string

+ type Timestamp struct

+ func NewTimestamp(t time.Time) *Timestamp

+ func Now() *Timestamp

+ func (t *Timestamp) MarshalJSON() ([]byte, error)

+ func (t *Timestamp) UnmarshalJSON(data []byte) error

+ type TransactionHash = ImprintV2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL