Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

types

package

Go to main page

Versions in this module

v1

v1.0.0

Nov 28, 2024

Changes in this version

+ const BlockTag

+ const ConsensusParamsTag

+ const GenesisPartitionRecordTag

+ const GenesisRootRecordTag

+ const GenesisTime

+ const InputRecordTag

+ const NetworkIdentifierLength

+ const PartitionDescriptionRecordTag

+ const PartitionIdentifierLength

+ const PartitionNodeTag

+ const RootGenesisTag

+ const RootPartitionBlockDataTag

+ const RootPartitionRoundInfoTag

+ const RootTrustBaseTag

+ const TransactionOrderTag

+ const TransactionRecordTag

+ const TxProofTag

+ const UnicityCertificateTag

+ const UnicitySealTag

+ const UnicityTreeCertificateTag

+ const UnitStateProofTag

+ var Cbor = cborHandler

+ var ErrBlockHashIsNil = errors.New("block hash is nil")

+ var ErrBlockIsNil = errors.New("block is nil")

+ var ErrHashIsNil = errors.New("hash is nil")

+ var ErrInputRecordIsNil = errors.New("input record is nil")

+ var ErrInvalidPartitionRound = errors.New("partition round is 0")

+ var ErrInvalidRootRound = errors.New("invalid root round number")

+ var ErrInvalidTimestamp = errors.New("invalid timestamp")

+ var ErrLastUCIsNil = errors.New("last UC is nil")

+ var ErrOutOfGas = errors.New("out of gas")

+ var ErrPreviousHashIsNil = errors.New("previous hash is nil")

+ var ErrRootValidatorInfoMissing = errors.New("root node info is missing")

+ var ErrServerMetadataIsNil = errors.New("server metadata is nil")

+ var ErrSignerIsNil = errors.New("signer is nil")

+ var ErrSummaryValueIsNil = errors.New("summary value is nil")

+ var ErrSystemDescriptionIsNil = errors.New("system description record is nil")

+ var ErrTransactionOrderIsNil = errors.New("transaction order is nil")

+ var ErrTransactionRecordIsNil = errors.New("transaction record is nil")

+ var ErrTxRecordProofIsNil = errors.New("transaction record proof is nil")

+ var ErrUCIsNil = errors.New("new UC is nil")

+ var ErrUnicityCertificateIsNil = errors.New("unicity certificate is nil")

+ var ErrUnicitySealHashIsNil = errors.New("hash is nil")

+ var ErrUnicitySealIsNil = errors.New("unicity seal is nil")

+ var ErrUnicitySealSignatureIsNil = errors.New("no signatures")

+ var ErrUnicityTreeCertificateIsNil = errors.New("unicity tree certificate is nil")

+ func AssertEqualIR(a, b *InputRecord) error

+ func BlockHash(algorithm crypto.Hash, h *Header, txs []*TransactionRecord, stateHash []byte, ...) ([]byte, error)

+ func CheckNonEquivocatingCertificates(prevUC, newUC *UnicityCertificate) error

+ func EnsureVersion(data Versioned, actual, expected ABVersion) error

+ func EqualIR(a, b *InputRecord) (bool, error)

+ func ErrInvalidVersion(s Versioned) error

+ func HashCBOR(data any, hashAlgorithm crypto.Hash) ([]byte, error)

+ func NewTimestamp() uint64

+ func VerifyTxProof(txRecordProof *TxRecordProof, tb RootTrustBase, hashAlgorithm crypto.Hash) error

+ func VerifyUnitStateProof(u *UnitStateProof, algorithm crypto.Hash, unitData *StateUnitData, ...) error

+ type ABTag = uint64

+ type ABVersion = uint32

+ type AuthProofSigData struct

+ StateUnlock []byte

+ Version ABVersion

+ type Block struct

+ Header *Header

+ Transactions []*TransactionRecord

+ UnicityCertificate TaggedCBOR

+ func (b *Block) CalculateBlockHash(algorithm crypto.Hash) (*InputRecord, error)

+ func (b *Block) GetBlockFees() (uint64, error)

+ func (b *Block) GetProposerID() string

+ func (b *Block) GetRoundNumber() (uint64, error)

+ func (b *Block) HeaderHash(algorithm crypto.Hash) ([]byte, error)

+ func (b *Block) InputRecord() (*InputRecord, error)

+ func (b *Block) IsValid(algorithm crypto.Hash, systemDescriptionHash []byte) error

+ func (b *Block) PartitionID() PartitionID

+ func (b *Block) Size() (bs uint64, _ error)

+ type ClientMetadata struct

+ FeeCreditRecordID []byte

+ MaxTransactionFee uint64

+ ReferenceNumber []byte

+ Timeout uint64

+ func (c *ClientMetadata) GetFeeCreditRecordID() []byte

+ func (c *ClientMetadata) GetMaxFee() uint64

+ func (c *ClientMetadata) GetReferenceNumber() []byte

+ func (c *ClientMetadata) GetTimeout() uint64

+ type FeeCreditBill struct

+ OwnerPredicate PredicateBytes

+ UnitID UnitID

+ type FeeProofSigData struct

+ AuthProof RawCBOR

+ StateUnlock []byte

+ Version ABVersion

+ type GenericChainItem struct

+ Hash []byte

+ Left bool

+ type Header struct

+ PartitionID PartitionID

+ PreviousBlockHash hex.Bytes

+ ProposerID string

+ ShardID ShardID

+ Version ABVersion

+ func (h *Header) GetVersion() ABVersion

+ func (h *Header) Hash(algorithm crypto.Hash) ([]byte, error)

+ func (h *Header) IsValid() error

+ func (h *Header) MarshalCBOR() ([]byte, error)

+ func (h *Header) UnmarshalCBOR(data []byte) error

+ type InputRecord struct

+ BlockHash hex.Bytes

+ Epoch uint64

+ Hash hex.Bytes

+ PreviousHash hex.Bytes

+ RoundNumber uint64

+ SumOfEarnedFees uint64

+ SummaryValue hex.Bytes

+ Timestamp uint64

+ Version ABVersion

+ func (x *InputRecord) AddToHasher(hasher abhash.Hasher)

+ func (x *InputRecord) Bytes() ([]byte, error)

+ func (x *InputRecord) GetVersion() ABVersion

+ func (x *InputRecord) IsValid() error

+ func (x *InputRecord) MarshalCBOR() ([]byte, error)

+ func (x *InputRecord) NewRepeatIR() *InputRecord

+ func (x *InputRecord) String() string

+ func (x *InputRecord) UnmarshalCBOR(data []byte) error

+ type NetworkID uint16

+ const NetworkLocal

+ const NetworkMainNet

+ const NetworkTestNet

+ func (nid NetworkID) Bytes() []byte

+ type NodeInfo struct

+ NodeID string

+ PublicKey hex.Bytes

+ Stake uint64

+ func NewNodeInfo(nodeID string, stake uint64, verifier abcrypto.Verifier) *NodeInfo

+ func (n *NodeInfo) Bytes() []byte

+ type Option func(c *trustBaseConf)

+ func WithQuorumThreshold(threshold uint64) Option

+ type PartitionDescriptionRecord struct

+ FeeCreditBill *FeeCreditBill

+ NetworkIdentifier NetworkID

+ PartitionIdentifier PartitionID

+ Shards ShardingScheme

+ SummaryTrustBase hex.Bytes

+ SystemDescriptor *SystemTypeDescriptor

+ T2Timeout time.Duration

+ TypeIdLen uint32

+ UnitIdLen uint32

+ Version ABVersion

+ func (pdr *PartitionDescriptionRecord) GetNetworkIdentifier() NetworkID

+ func (pdr *PartitionDescriptionRecord) GetPartitionIdentifier() PartitionID

+ func (pdr *PartitionDescriptionRecord) GetVersion() ABVersion

+ func (pdr *PartitionDescriptionRecord) Hash(hashAlgorithm crypto.Hash) ([]byte, error)

+ func (pdr *PartitionDescriptionRecord) IsValid() error

+ func (pdr *PartitionDescriptionRecord) IsValidShard(id ShardID) error

+ func (pdr *PartitionDescriptionRecord) MarshalCBOR() ([]byte, error)

+ func (pdr *PartitionDescriptionRecord) UnitIdValidator(sid ShardID) func(unitID UnitID) error

+ func (pdr *PartitionDescriptionRecord) UnmarshalCBOR(data []byte) error

+ type PartitionID uint32

+ func BytesToPartitionID(b []byte) (PartitionID, error)

+ func (sid PartitionID) Bytes() []byte

+ func (sid PartitionID) String() string

+ type Payload struct

+ Attributes RawCBOR

+ ClientMetadata *ClientMetadata

+ NetworkID NetworkID

+ PartitionID PartitionID

+ StateLock *StateLock

+ Type uint16

+ UnitID UnitID

+ type PredicateBytes = hex.Bytes

+ type RawCBOR []byte

+ func (r *RawCBOR) UnmarshalCBOR(data []byte) error

+ func (r *RawCBOR) UnmarshalText(src []byte) error

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

+ func (r RawCBOR) MarshalText() ([]byte, error)

+ type RootTrustBase interface

+ GetMaxFaultyNodes func() uint64

+ GetQuorumThreshold func() uint64

+ VerifyQuorumSignatures func(data []byte, signatures map[string]hex.Bytes) (error, []error)

+ VerifySignature func(data []byte, sig []byte, nodeID string) (uint64, error)

+ type RootTrustBaseV1 struct

+ ChangeRecordHash hex.Bytes

+ Epoch uint64

+ EpochStartRound uint64

+ PreviousEntryHash hex.Bytes

+ QuorumThreshold uint64

+ RootNodes map[string]*NodeInfo

+ Signatures map[string]hex.Bytes

+ StateHash hex.Bytes

+ Version ABVersion

+ func NewTrustBaseFromFile(trustBaseFile string) (*RootTrustBaseV1, error)

+ func NewTrustBaseGenesis(nodes []*NodeInfo, unicityTreeRootHash []byte, opts ...Option) (*RootTrustBaseV1, error)

+ func (r *RootTrustBaseV1) GetMaxFaultyNodes() uint64

+ func (r *RootTrustBaseV1) GetQuorumThreshold() uint64

+ func (r *RootTrustBaseV1) GetVerifiers() (map[string]abcrypto.Verifier, error)

+ func (r *RootTrustBaseV1) GetVersion() ABVersion

+ func (r *RootTrustBaseV1) Hash(hashAlgo crypto.Hash) ([]byte, error)

+ func (r *RootTrustBaseV1) MarshalCBOR() ([]byte, error)

+ func (r *RootTrustBaseV1) Sign(nodeID string, signer abcrypto.Signer) error

+ func (r *RootTrustBaseV1) UnmarshalCBOR(data []byte) error

+ func (r *RootTrustBaseV1) VerifyQuorumSignatures(data []byte, signatures map[string]hex.Bytes) (error, []error)

+ func (r *RootTrustBaseV1) VerifySignature(data []byte, sig []byte, nodeID string) (uint64, error)

+ func (r RootTrustBaseV1) SigBytes() ([]byte, error)

+ type ServerMetadata struct

+ ActualFee uint64

+ ProcessingDetails RawCBOR

+ SuccessIndicator TxStatus

+ TargetUnits []UnitID

+ func (sm *ServerMetadata) ErrDetail() error

+ func (sm *ServerMetadata) GetActualFee() uint64

+ func (sm *ServerMetadata) GetTargetUnits() []UnitID

+ func (sm *ServerMetadata) SetError(e error)

+ func (sm *ServerMetadata) TxStatus() TxStatus

+ func (sm *ServerMetadata) UnmarshalDetails(v any) error

+ type ShardID struct

+ func (id *ShardID) UnmarshalCBOR(data []byte) (err error)

+ func (id *ShardID) UnmarshalText(src []byte) error

+ func (id ShardID) AddToHasher(h abhash.Hasher)

+ func (id ShardID) Bytes() []byte

+ func (id ShardID) Comparator() func([]byte) bool

+ func (id ShardID) Equal(v ShardID) bool

+ func (id ShardID) Key() string

+ func (id ShardID) Length() uint

+ func (id ShardID) MarshalCBOR() ([]byte, error)

+ func (id ShardID) MarshalText() ([]byte, error)

+ func (id ShardID) Split() (ShardID, ShardID)

+ func (id ShardID) String() (s string)

+ type ShardTree map[string][]byte

+ func CreateShardTree(scheme ShardingScheme, states []ShardTreeInput, algo crypto.Hash) (ShardTree, error)

+ func (tree ShardTree) Certificate(shardID ShardID) (ShardTreeCertificate, error)

+ func (tree ShardTree) RootHash() []byte

+ type ShardTreeCertificate struct

+ Shard ShardID

+ SiblingHashes [][]byte

+ func (cert ShardTreeCertificate) ComputeCertificateHash(IR *InputRecord, TRHash []byte, algo crypto.Hash) ([]byte, error)

+ func (cert ShardTreeCertificate) IsValid() error

+ type ShardTreeInput struct

+ IR *InputRecord

+ Shard ShardID

+ TRHash []byte

+ type ShardingScheme []ShardID

+ func (sh ShardingScheme) All() iter.Seq[ShardID]

+ func (sh ShardingScheme) IsValid() error

+ type SignatureMap = map[string]hex.Bytes

+ type StateLock struct

+ ExecutionPredicate []byte

+ RollbackPredicate []byte

+ func (s StateLock) IsValid() error

+ type StateLockProofSigData struct

+ Version ABVersion

+ type StateTreeCert struct

+ LeftSummaryHash hex.Bytes

+ LeftSummaryValue uint64

+ Path []*StateTreePathItem

+ RightSummaryHash hex.Bytes

+ RightSummaryValue uint64

+ type StateTreePathItem struct

+ LogsHash hex.Bytes

+ SiblingSummaryHash hex.Bytes

+ SiblingSummaryValue uint64

+ UnitID UnitID

+ Value uint64

+ type StateUnitData struct

+ Data RawCBOR

+ func (sd *StateUnitData) Hash(hashAlgo crypto.Hash) ([]byte, error)

+ func (sd *StateUnitData) UnmarshalData(v any) error

+ type SystemTypeDescriptor struct

+ func (std *SystemTypeDescriptor) AddToHasher(h abhash.Hasher)

+ type TaggedCBOR = RawCBOR

+ type TransactionOrder struct

+ AuthProof RawCBOR

+ FeeProof []byte

+ StateUnlock []byte

+ Version ABVersion

+ func (t *TransactionOrder) AuthProofSigBytes() ([]byte, error)

+ func (t *TransactionOrder) FeeCreditRecordID() []byte

+ func (t *TransactionOrder) FeeProofSigBytes() ([]byte, error)

+ func (t *TransactionOrder) GetNetworkID() NetworkID

+ func (t *TransactionOrder) GetPartitionID() PartitionID

+ func (t *TransactionOrder) GetUnitID() UnitID

+ func (t *TransactionOrder) GetVersion() ABVersion

+ func (t *TransactionOrder) HasStateLock() bool

+ func (t *TransactionOrder) Hash(algorithm crypto.Hash) ([]byte, error)

+ func (t *TransactionOrder) MarshalCBOR() ([]byte, error)

+ func (t *TransactionOrder) MaxFee() uint64

+ func (t *TransactionOrder) ReferenceNumber() []byte

+ func (t *TransactionOrder) SetAttributes(attr any) error

+ func (t *TransactionOrder) SetAuthProof(authProof any) error

+ func (t *TransactionOrder) StateLockProofSigBytes() ([]byte, error)

+ func (t *TransactionOrder) Timeout() uint64

+ func (t *TransactionOrder) UnmarshalAttributes(v any) error

+ func (t *TransactionOrder) UnmarshalAuthProof(v any) error

+ func (t *TransactionOrder) UnmarshalCBOR(data []byte) error

+ type TransactionOrderCBOR = TaggedCBOR

+ type TransactionRecord struct

+ ServerMetadata *ServerMetadata

+ TransactionOrder TransactionOrderCBOR

+ Version ABVersion

+ func (t *TransactionRecord) Bytes() ([]byte, error)

+ func (t *TransactionRecord) GetActualFee() uint64

+ func (t *TransactionRecord) GetTransactionOrderV1() (*TransactionOrder, error)

+ func (t *TransactionRecord) GetVersion() ABVersion

+ func (t *TransactionRecord) Hash(algorithm crypto.Hash) ([]byte, error)

+ func (t *TransactionRecord) IsSuccessful() bool

+ func (t *TransactionRecord) IsValid() error

+ func (t *TransactionRecord) MarshalCBOR() ([]byte, error)

+ func (t *TransactionRecord) TargetUnits() []UnitID

+ func (t *TransactionRecord) TxStatus() TxStatus

+ func (t *TransactionRecord) UnmarshalCBOR(data []byte) error

+ func (t *TransactionRecord) UnmarshalProcessingDetails(v any) error

+ type TxProof struct

+ BlockHeaderHash []byte

+ Chain []*GenericChainItem

+ UnicityCertificate TaggedCBOR

+ Version ABVersion

+ func (p *TxProof) GetVersion() ABVersion

+ func (p *TxProof) IsValid() error

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

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

+ type TxRecordProof struct

+ TxProof *TxProof

+ TxRecord *TransactionRecord

+ func NewTxRecordProof(block *Block, txIndex int, algorithm crypto.Hash) (*TxRecordProof, error)

+ func (t *TxRecordProof) ActualFee() uint64

+ func (t *TxRecordProof) GetTransactionOrderV1() (*TransactionOrder, error)

+ func (t *TxRecordProof) IsValid() error

+ func (t *TxRecordProof) TxStatus() TxStatus

+ type TxStatus uint64

+ const TxErrOutOfGas

+ const TxStatusFailed

+ const TxStatusSuccessful

+ type UnicityCertificate struct

+ InputRecord *InputRecord

+ ShardTreeCertificate ShardTreeCertificate

+ TRHash hex.Bytes

+ UnicitySeal *UnicitySeal

+ UnicityTreeCertificate *UnicityTreeCertificate

+ Version ABVersion

+ func (x *UnicityCertificate) GetFeeSum() uint64

+ func (x *UnicityCertificate) GetPreviousStateHash() []byte

+ func (x *UnicityCertificate) GetRootRoundNumber() uint64

+ func (x *UnicityCertificate) GetRoundNumber() uint64

+ func (x *UnicityCertificate) GetStateHash() []byte

+ func (x *UnicityCertificate) GetSummaryValue() []byte

+ func (x *UnicityCertificate) GetVersion() ABVersion

+ func (x *UnicityCertificate) Hash(hash crypto.Hash) ([]byte, error)

+ func (x *UnicityCertificate) IsDuplicate(prevUC *UnicityCertificate) bool

+ func (x *UnicityCertificate) IsRepeat(prevUC *UnicityCertificate) (bool, error)

+ func (x *UnicityCertificate) IsSuccessor(prevUC *UnicityCertificate) bool

+ func (x *UnicityCertificate) IsValid(algorithm crypto.Hash, partitionID PartitionID, systemDescriptionHash []byte) error

+ func (x *UnicityCertificate) MarshalCBOR() ([]byte, error)

+ func (x *UnicityCertificate) UnmarshalCBOR(data []byte) error

+ func (x *UnicityCertificate) Verify(tb RootTrustBase, algorithm crypto.Hash, partitionID PartitionID, ...) error

+ type UnicityCertificateValidator interface

+ Validate func(uc *UnicityCertificate) error

+ type UnicitySeal struct

+ Hash hex.Bytes

+ PreviousHash hex.Bytes

+ RootChainRoundNumber uint64

+ Signatures SignatureMap

+ Timestamp uint64

+ Version ABVersion

+ func (x *UnicitySeal) AddToHasher(hasher abhash.Hasher)

+ func (x *UnicitySeal) GetVersion() ABVersion

+ func (x *UnicitySeal) IsValid() error

+ func (x *UnicitySeal) MarshalCBOR() ([]byte, error)

+ func (x *UnicitySeal) Sign(id string, signer crypto.Signer) error

+ func (x *UnicitySeal) UnmarshalCBOR(b []byte) error

+ func (x *UnicitySeal) Verify(tb RootTrustBase) error

+ func (x UnicitySeal) SigBytes() ([]byte, error)

+ type UnicityTree struct

+ func NewUnicityTree(hashAlgorithm crypto.Hash, data []*UnicityTreeData) (*UnicityTree, error)

+ func (u *UnicityTree) Certificate(partition PartitionID) (*UnicityTreeCertificate, error)

+ func (u *UnicityTree) RootHash() []byte

+ type UnicityTreeCertificate struct

+ HashSteps []*imt.PathItem

+ PDRHash hex.Bytes

+ Partition PartitionID

+ Version ABVersion

+ func (utc *UnicityTreeCertificate) AddToHasher(hasher abhash.Hasher)

+ func (utc *UnicityTreeCertificate) EvalAuthPath(shardTreeRoot []byte, hashAlgorithm crypto.Hash) ([]byte, error)

+ func (utc *UnicityTreeCertificate) GetVersion() ABVersion

+ func (utc *UnicityTreeCertificate) IsValid(partition PartitionID, systemDescriptionHash []byte) error

+ func (utc *UnicityTreeCertificate) MarshalCBOR() ([]byte, error)

+ func (utc *UnicityTreeCertificate) UnmarshalCBOR(data []byte) error

+ type UnicityTreeData struct

+ PDRHash []byte

+ Partition PartitionID

+ ShardTreeRoot []byte

+ func (t *UnicityTreeData) AddToHasher(hasher abhash.Hasher)

+ func (t *UnicityTreeData) Key() []byte

+ type UnitData interface

+ Copy func() UnitData

+ Owner func() []byte

+ SummaryValueInput func() uint64

+ Write func(hasher abhash.Hasher)

+ type UnitDataAndProof struct

+ Proof *UnitStateProof

+ UnitData *StateUnitData

+ func (up *UnitDataAndProof) UnmarshalUnitData(v any) error

+ type UnitID []byte

+ func NewUnitID(unitIDLength int, shardPart []byte, unitPart []byte, typePart []byte) UnitID

+ func (uid *UnitID) UnmarshalText(src []byte) error

+ func (uid UnitID) Compare(key UnitID) int

+ func (uid UnitID) Eq(id UnitID) bool

+ func (uid UnitID) HasType(typePart []byte) bool

+ func (uid UnitID) MarshalText() ([]byte, error)

+ func (uid UnitID) String() string

+ type UnitStateProof struct

+ StateTreeCert *StateTreeCert

+ UnicityCertificate TaggedCBOR

+ UnitID UnitID

+ UnitLedgerHash hex.Bytes

+ UnitTreeCert *UnitTreeCert

+ UnitValue uint64

+ Version ABVersion

+ func (u *UnitStateProof) CalculateStateTreeOutput(algorithm crypto.Hash) ([]byte, uint64, error)

+ func (u *UnitStateProof) GetVersion() ABVersion

+ func (u *UnitStateProof) MarshalCBOR() ([]byte, error)

+ func (u *UnitStateProof) UnmarshalCBOR(data []byte) error

+ type UnitTreeCert struct

+ Path []*mt.PathItem

+ TransactionRecordHash hex.Bytes

+ UnitDataHash hex.Bytes

+ type Versioned interface

+ GetVersion func() ABVersion

v1.0.0-rc2

Dec 11, 2024

v1.0.0-rc1

Nov 28, 2024

v0

v0.5.0-rc1

Oct 15, 2024