transaction

package
v0.4.3-testnet Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 8, 2025 License: MIT Imports: 20 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	TraceOptionNone = iota
	TraceOptionAll
	TraceOptionFailedConstraints
)

Variables

View Source 
var MainTxValidationOptions = []TxValidationOption{
	ScanSequencerData(),
	CheckSender(),
	CheckNumElements(),
	CheckTimePace(),
	CheckEndorsements(),
	CheckUniqueness(),
	ScanOutputs(),
	CheckSizeOfOutputCommitment(),
}

MainTxValidationOptions is all except Base, time bounds and input context validation

View Source 
var Path = lazybytes.Path

Functions

func EssenceBytesFromTransactionDataTree 

func EssenceBytesFromTransactionDataTree(txTree *lazybytes.Tree) []byte

func IDAndTimestampFromTransactionBytes 

func IDAndTimestampFromTransactionBytes(txBytes []byte) (ledger.TransactionID, ledger.Time, error)

func IDFromTransactionBytes 

func IDFromTransactionBytes(txBytes []byte) (ledger.TransactionID, error)

func OutputWithIDFromTransactionBytes 

func OutputWithIDFromTransactionBytes(txBytes []byte, idx byte) (*ledger.OutputWithID, error)

func OutputsWithIDFromTransactionBytes 

func OutputsWithIDFromTransactionBytes(txBytes []byte) ([]*ledger.OutputWithID, error)

func ParseBytesToString 

func ParseBytesToString(txBytes []byte, fetchOutput func(oid *ledger.OutputID) ([]byte, bool)) string

func PathToString 

func PathToString(path []byte) string

func PickOutputFromListFunc 

func PickOutputFromListFunc(lst []*ledger.OutputWithID) func(oid *ledger.OutputID) ([]byte, bool)

func SaveTransactionAsFile 

func SaveTransactionAsFile(txBytes []byte, fname ...string) error

func StringFromTxBytes 

func StringFromTxBytes(txBytes []byte, inputLoaderByIndex func(byte) (*ledger.Output, error)) string

func UnlockDataToString 

func UnlockDataToString(data []byte) string

Types

type SequencerTransactionData 

type SequencerTransactionData struct {
	SequencerOutputData  *ledger.SequencerOutputData
	StemOutputData       *ledger.StemLock // nil if does not contain stem output
	SequencerID          ledger.ChainID   // adjusted for chain origin
	SequencerOutputIndex byte
	StemOutputIndex      byte // 0xff if not a branch transaction
}

SequencerTransactionData represents sequencer and stem data on the transaction

func (*SequencerTransactionData) Short 

func (m *SequencerTransactionData) Short() string

type Transaction 

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

Transaction provides access to the tree of transferable transaction

func FromBytes 

func FromBytes(txBytes []byte, opt ...TxValidationOption) (*Transaction, error)

func FromBytesMainChecksWithOpt 

func FromBytesMainChecksWithOpt(txBytes []byte, additional ...TxValidationOption) (*Transaction, error)

func (*Transaction) Bytes 

func (tx *Transaction) Bytes() []byte

func (*Transaction) ConsumedOutputAt 

func (tx *Transaction) ConsumedOutputAt(idx byte, fetchOutput func(id *ledger.OutputID) ([]byte, bool)) (*ledger.OutputDataWithID, error)

func (*Transaction) EndorsementAt 

func (tx *Transaction) EndorsementAt(idx byte) ledger.TransactionID

func (*Transaction) EndorsementsVeryShort 

func (tx *Transaction) EndorsementsVeryShort() string

func (*Transaction) EssenceBytes 

func (tx *Transaction) EssenceBytes() []byte

func (*Transaction) FindChainOutput 

func (tx *Transaction) FindChainOutput(chainID ledger.ChainID) *ledger.OutputWithID

func (*Transaction) FindStemProducedOutput 

func (tx *Transaction) FindStemProducedOutput() *ledger.OutputWithID

func (*Transaction) ForEachEndorsement 

func (tx *Transaction) ForEachEndorsement(fun func(idx byte, txid *ledger.TransactionID) bool)

func (*Transaction) ForEachInput 

func (tx *Transaction) ForEachInput(fun func(i byte, oid *ledger.OutputID) bool)

func (*Transaction) ForEachOutputData 

func (tx *Transaction) ForEachOutputData(fun func(idx byte, oData []byte) bool)

func (*Transaction) ForEachProducedOutput 

func (tx *Transaction) ForEachProducedOutput(fun func(idx byte, o *ledger.Output, oid *ledger.OutputID) bool)

ForEachProducedOutput traverses all produced outputs Inside callback function the correct outputID must be obtained with OutputID(idx byte) ledger.OutputID because stem output ID has special form

func (*Transaction) Hash 

func (tx *Transaction) Hash() ledger.TransactionIDShort

func (*Transaction) HashInputsAndEndorsements 

func (tx *Transaction) HashInputsAndEndorsements() [32]byte

HashInputsAndEndorsements blake2b of concatenated input IDs and endorsements independent on any other tz data but inputs

func (*Transaction) ID 

func (tx *Transaction) ID() ledger.TransactionID

func (*Transaction) IDRef 

func (tx *Transaction) IDRef() *ledger.TransactionID

func (*Transaction) IDShortString 

func (tx *Transaction) IDShortString() string

func (*Transaction) IDString 

func (tx *Transaction) IDString() string

func (*Transaction) IDStringHex 

func (tx *Transaction) IDStringHex() string

func (*Transaction) IDVeryShortString 

func (tx *Transaction) IDVeryShortString() string

func (*Transaction) InflationAmount 

func (tx *Transaction) InflationAmount() uint64

func (*Transaction) InputAt 

func (tx *Transaction) InputAt(idx byte) (ret ledger.OutputID, err error)

func (*Transaction) InputAtShort 

func (tx *Transaction) InputAtShort(idx byte) string

func (*Transaction) InputAtString 

func (tx *Transaction) InputAtString(idx byte) string

func (*Transaction) InputLoaderByIndex 

func (tx *Transaction) InputLoaderByIndex(fetchOutput func(oid *ledger.OutputID) ([]byte, bool)) func(byte) (*ledger.Output, error)

func (*Transaction) InputLoaderFromState 

func (tx *Transaction) InputLoaderFromState(rdr multistate.StateReader) func(idx byte) (*ledger.Output, error)

func (*Transaction) Inputs 

func (tx *Transaction) Inputs() []ledger.OutputID

func (*Transaction) IsBranchTransaction 

func (tx *Transaction) IsBranchTransaction() bool

func (*Transaction) IsSequencerMilestone 

func (tx *Transaction) IsSequencerMilestone() bool

func (*Transaction) Lines 

func (tx *Transaction) Lines(inputLoaderByIndex func(i byte) (*ledger.Output, error), prefix ...string) *lines.Lines

func (*Transaction) LinesShort 

func (tx *Transaction) LinesShort(prefix ...string) *lines.Lines

func (*Transaction) MustInputAt 

func (tx *Transaction) MustInputAt(idx byte) ledger.OutputID

func (*Transaction) MustOutputDataAt 

func (tx *Transaction) MustOutputDataAt(idx byte) []byte

func (*Transaction) MustOutputIndexOfTheInput 

func (tx *Transaction) MustOutputIndexOfTheInput(inputIdx byte) byte

func (*Transaction) MustProducedOutputAt 

func (tx *Transaction) MustProducedOutputAt(idx byte) *ledger.Output

func (*Transaction) MustProducedOutputWithIDAt 

func (tx *Transaction) MustProducedOutputWithIDAt(idx byte) *ledger.OutputWithID

func (*Transaction) MustUnlockDataAt 

func (tx *Transaction) MustUnlockDataAt(idx byte) []byte

func (*Transaction) NumEndorsements 

func (tx *Transaction) NumEndorsements() int

func (*Transaction) NumInputs 

func (tx *Transaction) NumInputs() int

func (*Transaction) NumProducedOutputs 

func (tx *Transaction) NumProducedOutputs() int

func (*Transaction) OutputID 

func (tx *Transaction) OutputID(idx byte) ledger.OutputID

func (*Transaction) PredecessorTransactionIDs 

func (tx *Transaction) PredecessorTransactionIDs() set.Set[ledger.TransactionID]

func (*Transaction) ProducedOutputAt 

func (tx *Transaction) ProducedOutputAt(idx byte) (*ledger.Output, error)

func (*Transaction) ProducedOutputWithIDAt 

func (tx *Transaction) ProducedOutputWithIDAt(idx byte) (*ledger.OutputWithID, error)

func (*Transaction) ProducedOutputs 

func (tx *Transaction) ProducedOutputs() []*ledger.OutputWithID

func (*Transaction) ProducedOutputsToString 

func (tx *Transaction) ProducedOutputsToString() string

func (*Transaction) ProducedOutputsWithTargetLock 

func (tx *Transaction) ProducedOutputsWithTargetLock(lock ledger.Lock) []*ledger.OutputWithID

func (*Transaction) SenderAddress 

func (tx *Transaction) SenderAddress() ledger.AddressED25519

func (*Transaction) SequencerAndStemInputData 

func (tx *Transaction) SequencerAndStemInputData() (seqInputIdx *byte, stemInputIdx *byte, seqID *ledger.ChainID)

func (*Transaction) SequencerAndStemOutputIndices 

func (tx *Transaction) SequencerAndStemOutputIndices() (byte, byte)

SequencerAndStemOutputIndices return seq output index and stem output index

func (*Transaction) SequencerChainPredecessor 

func (tx *Transaction) SequencerChainPredecessor() (*ledger.OutputID, byte)

SequencerChainPredecessor returns chain predecessor output ID If it is chain origin, it returns nil. Otherwise, it may or may not be a sequencer ID It also returns index of the inout

func (*Transaction) SequencerOutput 

func (tx *Transaction) SequencerOutput() *ledger.OutputWithID

func (*Transaction) SequencerTransactionData 

func (tx *Transaction) SequencerTransactionData() *SequencerTransactionData

SequencerTransactionData returns nil it is not a sequencer milestone

func (*Transaction) SignatureBytes 

func (tx *Transaction) SignatureBytes() []byte

func (*Transaction) Slot 

func (tx *Transaction) Slot() ledger.Slot

func (*Transaction) StateMutations 

func (tx *Transaction) StateMutations() *multistate.Mutations

func (*Transaction) StemOutput 

func (tx *Transaction) StemOutput() *ledger.OutputWithID

func (*Transaction) StemOutputData 

func (tx *Transaction) StemOutputData() *ledger.StemLock

func (*Transaction) String 

func (tx *Transaction) String() string

func (*Transaction) Timestamp 

func (tx *Transaction) Timestamp() ledger.Time

func (*Transaction) TimestampTime 

func (tx *Transaction) TimestampTime() time.Time

func (*Transaction) ToString 

func (tx *Transaction) ToString(fetchOutput func(oid *ledger.OutputID) ([]byte, bool)) string

func (*Transaction) ToStringWithInputLoaderByIndex 

func (tx *Transaction) ToStringWithInputLoaderByIndex(fetchOutput func(i byte) (*ledger.Output, error)) string

func (*Transaction) TotalAmount 

func (tx *Transaction) TotalAmount() uint64

func (*Transaction) Validate 

func (tx *Transaction) Validate(opt ...TxValidationOption) error

type TxContext 

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

TxContext is a data structure, which contains transferable transaction, consumed outputs and constraint library

func TxContextFromState 

func TxContextFromState(tx *Transaction, rdr multistate.SugaredStateReader) (*TxContext, error)

func TxContextFromTransaction 

func TxContextFromTransaction(tx *Transaction, inputLoaderByIndex func(i byte) (*ledger.Output, error), traceOption ...int) (*TxContext, error)

func TxContextFromTransferableBytes 

func TxContextFromTransferableBytes(txBytes []byte, fetchInput func(oid *ledger.OutputID) ([]byte, bool), traceOption ...int) (*TxContext, error)

TxContextFromTransferableBytes constructs lazybytes.Tree from transaction bytes and consumed outputs

func (*TxContext) ConsumedOutput 

func (ctx *TxContext) ConsumedOutput(idx byte) (*ledger.Output, error)

func (*TxContext) ConsumedOutputData 

func (ctx *TxContext) ConsumedOutputData(idx byte) []byte

func (*TxContext) ConsumedOutputHash 

func (ctx *TxContext) ConsumedOutputHash() [32]byte

func (*TxContext) ForEachConsumedOutput 

func (ctx *TxContext) ForEachConsumedOutput(fun func(idx byte, oid *ledger.OutputID, out *ledger.Output) bool)

func (*TxContext) ForEachEndorsement 

func (ctx *TxContext) ForEachEndorsement(fun func(idx byte, txid *ledger.TransactionID) bool)

func (*TxContext) ForEachInputID 

func (ctx *TxContext) ForEachInputID(fun func(idx byte, oid *ledger.OutputID) bool)

func (*TxContext) ForEachProducedOutput 

func (ctx *TxContext) ForEachProducedOutput(fun func(idx byte, out *ledger.Output, oid *ledger.OutputID) bool)

func (*TxContext) ForEachProducedOutputData 

func (ctx *TxContext) ForEachProducedOutputData(fun func(idx byte, oData []byte) bool)

func (*TxContext) InputCommitment 

func (ctx *TxContext) InputCommitment() []byte

func (*TxContext) InputID 

func (ctx *TxContext) InputID(idx byte) ledger.OutputID

func (*TxContext) Lines 

func (ctx *TxContext) Lines(prefix ...string) *lines.Lines

func (*TxContext) MustTimestampData 

func (ctx *TxContext) MustTimestampData() ([]byte, ledger.Time)

func (*TxContext) NumEndorsements 

func (ctx *TxContext) NumEndorsements() int

func (*TxContext) NumInputs 

func (ctx *TxContext) NumInputs() int

func (*TxContext) NumProducedOutputs 

func (ctx *TxContext) NumProducedOutputs() int

func (*TxContext) OutputID 

func (ctx *TxContext) OutputID(idx byte) ledger.OutputID

func (*TxContext) ProducedOutput 

func (ctx *TxContext) ProducedOutput(idx byte) (*ledger.OutputWithID, error)

func (*TxContext) ProducedOutputData 

func (ctx *TxContext) ProducedOutputData(idx byte) []byte

func (*TxContext) SequencerAndStemOutputIndices 

func (ctx *TxContext) SequencerAndStemOutputIndices() (byte, byte)

func (*TxContext) Signature 

func (ctx *TxContext) Signature() []byte

func (*TxContext) String 

func (ctx *TxContext) String() string

func (*TxContext) TotalAmountStored 

func (ctx *TxContext) TotalAmountStored() uint64

func (*TxContext) TotalInflation 

func (ctx *TxContext) TotalInflation() uint64

func (*TxContext) TransactionBytes 

func (ctx *TxContext) TransactionBytes() []byte

func (*TxContext) TransactionID 

func (ctx *TxContext) TransactionID() *ledger.TransactionID

func (*TxContext) UnlockDataAt 

func (ctx *TxContext) UnlockDataAt(idx byte) []byte

func (*TxContext) UnlockParams 

func (ctx *TxContext) UnlockParams(consumedOutputIdx, constraintIdx byte) []byte

func (*TxContext) Validate 

func (ctx *TxContext) Validate() error

func (*TxContext) ValidateWithReportOnConsumedOutputs 

func (ctx *TxContext) ValidateWithReportOnConsumedOutputs() ([]byte, error)

ValidateWithReportOnConsumedOutputs validates the transaction and returns indices of failing consumed outputs, if any This for the convenience of automated VMs and sequencers

type TxValidationOption 

type TxValidationOption func(tx *Transaction) error

Transaction provides access to the tree of transferable transaction

func BaseValidation 

func BaseValidation() TxValidationOption

BaseValidation is a checking of being able to extract ID. If not, bytes are not identifiable as a transaction

func CheckEndorsements 

func CheckEndorsements() TxValidationOption

CheckEndorsements endorsed transactions must be sequencer transaction from the current slot

func CheckNumElements 

func CheckNumElements() TxValidationOption

func CheckSender 

func CheckSender() TxValidationOption

CheckSender returns a signature validator. It also sets the sender field

func CheckSizeOfOutputCommitment 

func CheckSizeOfOutputCommitment() TxValidationOption

func CheckTimePace 

func CheckTimePace() TxValidationOption

CheckTimePace consumed outputs must satisfy time pace constraint

func CheckTimestampLowerBound 

func CheckTimestampLowerBound(lowerBound time.Time) TxValidationOption

func CheckTimestampUpperBound 

func CheckTimestampUpperBound(upperBound time.Time) TxValidationOption

func CheckUniqueness 

func CheckUniqueness() TxValidationOption

func ScanOutputs 

func ScanOutputs() TxValidationOption

ScanOutputs validation option scans all inputs, enforces existence of mandatory constrains, computes total of outputs and total inflation

func ScanSequencerData 

func ScanSequencerData() TxValidationOption

func ValidateOptionWithFullContext 

func ValidateOptionWithFullContext(inputLoaderByIndex func(i byte) (*ledger.Output, error)) TxValidationOption

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.