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

devnetvm

package

Go to main page

Versions in this module

v0

v0.9.3

Jul 19, 2022

v0.9.2

Jul 14, 2022

v0.9.1

Jun 22, 2022

v0.9.0

Jun 16, 2022

Changes in this version

+ const AddressLength

+ const AliasAddressDigestSize

+ const ColorLength

+ const DustThresholdAliasOutputIOTA

+ const MaxInputCount

+ const MaxOutputBalance

+ const MaxOutputCount

+ const MaxOutputPayloadSize

+ const MinInputCount

+ const MinOutputBalance

+ const MinOutputCount

+ const UTXOInputType

+ var ColorIOTA = Color

+ var ColorMint = Color

+ var ErrTransactionInvalid = errors.New("transaction invalid")

+ var InputTypeNames = [...]string

+ var TransactionType payload.Type

+ func AliasInitialStateValid(inputs Outputs, transaction *Transaction) bool

+ func IsAboveDustThreshold(m map[Color]uint64) bool

+ func IsExactDustMinimum(b *ColoredBalances) bool

+ func OutputFromBytes(data []byte) (output utxo.Output, err error)

+ func SafeAddUint64(a uint64, b uint64) (result uint64, valid bool)

+ func SafeSubUint64(a uint64, b uint64) (result uint64, valid bool)

+ func SetOutputID(essence *TransactionEssence, transactionID utxo.TransactionID)

+ func TransactionBalancesValid(inputs Outputs, outputs Outputs) (valid bool)

+ func UnlockBlocksValid(inputs Outputs, transaction *Transaction) (valid bool)

+ func UnlockBlocksValidWithError(inputs Outputs, transaction *Transaction) (bool, error)

+ type Address interface

+ Array func() [AddressLength]byte

+ Base58 func() string

+ Bytes func() []byte

+ Clone func() Address

+ Digest func() []byte

+ Equals func(other Address) bool

+ String func() string

+ Type func() AddressType

+ func AddressFromBase58EncodedString(base58String string) (address Address, err error)

+ func AddressFromBytes(bytes []byte) (address Address, consumedBytes int, err error)

+ func AddressFromSignature(sig Signature) (Address, error)

+ type AddressType byte

+ const AliasAddressType

+ const BLSAddressType

+ const ED25519AddressType

+ func (a AddressType) String() string

+ type AliasAddress struct

+ func AliasAddressFromBase58EncodedString(base58String string) (address *AliasAddress, err error)

+ func AliasAddressFromBytes(data []byte) (address *AliasAddress, consumedBytes int, err error)

+ func NewAliasAddress(data []byte) *AliasAddress

+ func (a *AliasAddress) Array() (array [AddressLength]byte)

+ func (a *AliasAddress) Base58() string

+ func (a *AliasAddress) Bytes() []byte

+ func (a *AliasAddress) Clone() Address

+ func (a *AliasAddress) Digest() []byte

+ func (a *AliasAddress) Equals(other Address) bool

+ func (a *AliasAddress) IsNil() bool

+ func (a *AliasAddress) String() string

+ func (a *AliasAddress) Type() AddressType

+ type AliasOutput struct

+ func NewAliasOutputMint(balances map[Color]uint64, stateAddr Address, immutableData ...[]byte) (*AliasOutput, error)

+ func (a *AliasOutput) Address() Address

+ func (a *AliasOutput) Balances() *ColoredBalances

+ func (a *AliasOutput) Bytes() ([]byte, error)

+ func (a *AliasOutput) Clone() Output

+ func (a *AliasOutput) Compare(other Output) int

+ func (a *AliasOutput) Decode(b []byte) (int, error)

+ func (a *AliasOutput) DelegationTimeLockedNow(nowis time.Time) bool

+ func (a *AliasOutput) DelegationTimelock() time.Time

+ func (a *AliasOutput) Encode() ([]byte, error)

+ func (a *AliasOutput) FromBytes(data []byte) error

+ func (a *AliasOutput) FromObjectStorage(key, data []byte) (err error)

+ func (a *AliasOutput) GetAliasAddress() *AliasAddress

+ func (a *AliasOutput) GetGovernanceMetadata() []byte

+ func (a *AliasOutput) GetGoverningAddress() Address

+ func (a *AliasOutput) GetImmutableData() []byte

+ func (a *AliasOutput) GetIsGovernanceUpdated() bool

+ func (a *AliasOutput) GetStateAddress() Address

+ func (a *AliasOutput) GetStateData() []byte

+ func (a *AliasOutput) GetStateIndex() uint32

+ func (a *AliasOutput) ID() utxo.OutputID

+ func (a *AliasOutput) Input() Input

+ func (a *AliasOutput) IsDelegated() bool

+ func (a *AliasOutput) IsOrigin() bool

+ func (a *AliasOutput) IsSelfGoverned() bool

+ func (a *AliasOutput) NewAliasOutputNext(governanceUpdate ...bool) *AliasOutput

+ func (a *AliasOutput) ObjectStorageKey() []byte

+ func (a *AliasOutput) ObjectStorageValue() []byte

+ func (a *AliasOutput) SetAliasAddress(addr *AliasAddress)

+ func (a *AliasOutput) SetBalances(balances map[Color]uint64) error

+ func (a *AliasOutput) SetDelegationTimelock(timelock time.Time) error

+ func (a *AliasOutput) SetGovernanceMetadata(data []byte) error

+ func (a *AliasOutput) SetGoverningAddress(addr Address)

+ func (a *AliasOutput) SetID(outputID utxo.OutputID)

+ func (a *AliasOutput) SetImmutableData(data []byte) error

+ func (a *AliasOutput) SetIsDelegated(isDelegated bool)

+ func (a *AliasOutput) SetIsGovernanceUpdated(i bool)

+ func (a *AliasOutput) SetIsOrigin(isOrigin bool)

+ func (a *AliasOutput) SetStateAddress(addr Address) error

+ func (a *AliasOutput) SetStateData(data []byte) error

+ func (a *AliasOutput) SetStateIndex(index uint32)

+ func (a *AliasOutput) String() string

+ func (a *AliasOutput) Type() OutputType

+ func (a *AliasOutput) UnlockValid(tx *Transaction, unlockBlock UnlockBlock, inputs []Output) (bool, error)

+ func (a *AliasOutput) UpdateMintingColor() Output

+ func (a *AliasOutput) WithDelegation() *AliasOutput

+ func (a *AliasOutput) WithDelegationAndTimelock(lockUntil time.Time) *AliasOutput

+ type AliasUnlockBlock struct

+ func NewAliasUnlockBlock(chainInputIndex uint16) *AliasUnlockBlock

+ func (r *AliasUnlockBlock) AliasInputIndex() uint16

+ func (r *AliasUnlockBlock) Type() UnlockBlockType

+ type BLSAddress struct

+ func BLSAddressFromBytes(bytes []byte) (address *BLSAddress, consumedBytes int, err error)

+ func NewBLSAddress(publicKey []byte) *BLSAddress

+ func (b *BLSAddress) Array() (array [AddressLength]byte)

+ func (b *BLSAddress) Base58() string

+ func (b *BLSAddress) Bytes() []byte

+ func (b *BLSAddress) Clone() Address

+ func (b *BLSAddress) Digest() []byte

+ func (b *BLSAddress) Equals(other Address) bool

+ func (b *BLSAddress) String() string

+ func (b *BLSAddress) Type() AddressType

+ type BLSSignature struct

+ Signature bls.SignatureWithPublicKey

+ func BLSSignatureFromBytes(bytes []byte) (signature *BLSSignature, consumedBytes int, err error)

+ func NewBLSSignature(signature bls.SignatureWithPublicKey) *BLSSignature

+ func (b *BLSSignature) AddressSignatureValid(address Address, data []byte) bool

+ func (b *BLSSignature) Base58() string

+ func (b *BLSSignature) Bytes() []byte

+ func (b *BLSSignature) SignatureValid(data []byte) bool

+ func (b *BLSSignature) String() string

+ func (b *BLSSignature) Type() SignatureType

+ type Color [ColorLength]byte

+ func ColorFromBase58EncodedString(base58String string) (color Color, err error)

+ func ColorFromBytes(data []byte) (color Color, consumedBytes int, err error)

+ func (c Color) Base58() string

+ func (c Color) Bytes() []byte

+ func (c Color) Compare(otherColor Color) int

+ func (c Color) String() string

+ type ColoredBalances struct

+ func ColoredBalancesFromBytes(bytes []byte) (coloredBalances *ColoredBalances, consumedBytes int, err error)

+ func NewColoredBalances(balances map[Color]uint64) (coloredBalances *ColoredBalances)

+ func (c *ColoredBalances) Bytes() []byte

+ func (c *ColoredBalances) Clone() *ColoredBalances

+ func (c *ColoredBalances) ForEach(consumer func(color Color, balance uint64) bool)

+ func (c *ColoredBalances) Get(color Color) (uint64, bool)

+ func (c *ColoredBalances) Map() (balances map[Color]uint64)

+ func (c *ColoredBalances) Size() int

+ func (c *ColoredBalances) String() string

+ type ED25519Address struct

+ func ED25519AddressFromBytes(bytes []byte) (address *ED25519Address, consumedBytes int, err error)

+ func NewED25519Address(publicKey ed25519.PublicKey) *ED25519Address

+ func (e *ED25519Address) Array() (array [AddressLength]byte)

+ func (e *ED25519Address) Base58() string

+ func (e *ED25519Address) Bytes() []byte

+ func (e *ED25519Address) Clone() Address

+ func (e *ED25519Address) Digest() []byte

+ func (e *ED25519Address) Equals(other Address) bool

+ func (e *ED25519Address) String() string

+ func (e *ED25519Address) Type() AddressType

+ type ED25519Signature struct

+ PublicKey ed25519.PublicKey

+ Signature ed25519.Signature

+ func ED25519SignatureFromBytes(bytes []byte) (signature *ED25519Signature, consumedBytes int, err error)

+ func NewED25519Signature(publicKey ed25519.PublicKey, signature ed25519.Signature) *ED25519Signature

+ func (e *ED25519Signature) AddressSignatureValid(address Address, data []byte) bool

+ func (e *ED25519Signature) Base58() string

+ func (e *ED25519Signature) Bytes() []byte

+ func (e *ED25519Signature) SignatureValid(data []byte) bool

+ func (e *ED25519Signature) String() string

+ func (e *ED25519Signature) Type() SignatureType

+ type ExtendedLockedOutput struct

+ func NewExtendedLockedOutput(balances map[Color]uint64, address Address) *ExtendedLockedOutput

+ func (o *ExtendedLockedOutput) Address() Address

+ func (o *ExtendedLockedOutput) Balances() *ColoredBalances

+ func (o *ExtendedLockedOutput) Bytes() ([]byte, error)

+ func (o *ExtendedLockedOutput) Clone() Output

+ func (o *ExtendedLockedOutput) Compare(other Output) int

+ func (o *ExtendedLockedOutput) Decode(b []byte) (int, error)

+ func (o *ExtendedLockedOutput) Encode() ([]byte, error)

+ func (o *ExtendedLockedOutput) FallbackAddress() (addy Address)

+ func (o *ExtendedLockedOutput) FallbackOptions() (Address, time.Time)

+ func (o *ExtendedLockedOutput) FromBytes(data []byte) error

+ func (o *ExtendedLockedOutput) FromObjectStorage(key, value []byte) (err error)

+ func (o *ExtendedLockedOutput) GetPayload() []byte

+ func (o *ExtendedLockedOutput) ID() utxo.OutputID

+ func (o *ExtendedLockedOutput) Input() Input

+ func (o *ExtendedLockedOutput) ObjectStorageKey() []byte

+ func (o *ExtendedLockedOutput) ObjectStorageValue() []byte

+ func (o *ExtendedLockedOutput) SetID(outputID utxo.OutputID)

+ func (o *ExtendedLockedOutput) SetPayload(data []byte) error

+ func (o *ExtendedLockedOutput) String() string

+ func (o *ExtendedLockedOutput) TimeLock() time.Time

+ func (o *ExtendedLockedOutput) TimeLockedNow(nowis time.Time) bool

+ func (o *ExtendedLockedOutput) Type() OutputType

+ func (o *ExtendedLockedOutput) UnlockAddressNow(nowis time.Time) Address

+ func (o *ExtendedLockedOutput) UnlockValid(tx *Transaction, unlockBlock UnlockBlock, inputs []Output) (unlockValid bool, err error)

+ func (o *ExtendedLockedOutput) UpdateMintingColor() Output

+ func (o *ExtendedLockedOutput) WithFallbackOptions(addr Address, deadline time.Time) *ExtendedLockedOutput

+ func (o *ExtendedLockedOutput) WithTimeLock(timelock time.Time) *ExtendedLockedOutput

+ type Input interface

+ Base58 func() string

+ Bytes func() ([]byte, error)

+ Compare func(other Input) int

+ String func() string

+ Type func() InputType

+ type InputType uint8

+ func (i InputType) String() string

+ type Inputs []Input

+ func NewInputs(optionalInputs ...Input) (inputs Inputs)

+ func (i Inputs) Clone() (clonedInputs Inputs)

+ func (i Inputs) String() string

+ func (i Inputs) Strings() (result []string)

+ type Output interface

+ Address func() Address

+ Balances func() *ColoredBalances

+ Bytes func() (serialized []byte, err error)

+ Clone func() Output

+ Compare func(other Output) int

+ ID func() utxo.OutputID

+ Input func() Input

+ SetID func(outputID utxo.OutputID)

+ String func() string

+ Type func() OutputType

+ UnlockValid func(tx *Transaction, unlockBlock UnlockBlock, inputs []Output) (bool, error)

+ UpdateMintingColor func() Output

+ type OutputType uint8

+ const AliasOutputType

+ const ExtendedLockedOutputType

+ const SigLockedColoredOutputType

+ const SigLockedSingleOutputType

+ func OutputTypeFromString(ot string) (OutputType, error)

+ func (o OutputType) String() string

+ type Outputs []Output

+ func NewOutputs(optionalOutputs ...Output) (outputs Outputs)

+ func OutputsFromUTXOOutputs(utxoOutputs *utxo.Outputs) (outputs Outputs)

+ func (o Outputs) ByID() (outputsByID OutputsByID)

+ func (o Outputs) Clone() (clonedOutputs Outputs)

+ func (o Outputs) Filter(condition func(output Output) bool) (filteredOutputs Outputs)

+ func (o Outputs) Inputs() Inputs

+ func (o Outputs) String() string

+ func (o Outputs) Strings() (result []string)

+ func (o Outputs) UTXOOutputs() (utxoOutputs []utxo.Output)

+ type OutputsByID map[utxo.OutputID]Output

+ func NewOutputsByID(optionalOutputs ...Output) (outputsByID OutputsByID)

+ func (o OutputsByID) Clone() (clonedOutputs OutputsByID)

+ func (o OutputsByID) Inputs() Inputs

+ func (o OutputsByID) Outputs() Outputs

+ func (o OutputsByID) String() string

+ type ReferenceUnlockBlock struct

+ func NewReferenceUnlockBlock(referencedIndex uint16) *ReferenceUnlockBlock

+ func ReferenceUnlockBlockFromBytes(bytes []byte) (unlockBlock *ReferenceUnlockBlock, consumedBytes int, err error)

+ func (r *ReferenceUnlockBlock) ReferencedIndex() uint16

+ func (r *ReferenceUnlockBlock) Type() UnlockBlockType

+ type SigLockedColoredOutput struct

+ func NewSigLockedColoredOutput(balances *ColoredBalances, address Address) *SigLockedColoredOutput

+ func (s *SigLockedColoredOutput) Address() Address

+ func (s *SigLockedColoredOutput) Balances() *ColoredBalances

+ func (s *SigLockedColoredOutput) Bytes() (bytes []byte, err error)

+ func (s *SigLockedColoredOutput) Clone() Output

+ func (s *SigLockedColoredOutput) Compare(other Output) int

+ func (s *SigLockedColoredOutput) FromBytes(bytes []byte) (err error)

+ func (s *SigLockedColoredOutput) FromObjectStorage(key, data []byte) (err error)

+ func (s *SigLockedColoredOutput) Input() Input

+ func (s *SigLockedColoredOutput) ObjectStorageValue() (value []byte)

+ func (s *SigLockedColoredOutput) Type() OutputType

+ func (s *SigLockedColoredOutput) UnlockValid(tx *Transaction, unlockBlock UnlockBlock, inputs []Output) (unlockValid bool, err error)

+ func (s *SigLockedColoredOutput) UpdateMintingColor() (updatedOutput Output)

+ type SigLockedSingleOutput struct

+ func NewSigLockedSingleOutput(balance uint64, address Address) *SigLockedSingleOutput

+ func (s *SigLockedSingleOutput) Address() Address

+ func (s *SigLockedSingleOutput) Balances() *ColoredBalances

+ func (s *SigLockedSingleOutput) Clone() Output

+ func (s *SigLockedSingleOutput) Compare(other Output) int

+ func (s *SigLockedSingleOutput) Input() Input

+ func (s *SigLockedSingleOutput) Type() OutputType

+ func (s *SigLockedSingleOutput) UnlockValid(tx *Transaction, unlockBlock UnlockBlock, inputs []Output) (unlockValid bool, err error)

+ func (s *SigLockedSingleOutput) UpdateMintingColor() Output

+ type Signature interface

+ AddressSignatureValid func(address Address, data []byte) bool

+ Base58 func() string

+ Bytes func() []byte

+ SignatureValid func(data []byte) bool

+ String func() string

+ Type func() SignatureType

+ func SignatureFromBase58EncodedString(base58String string) (signature Signature, err error)

+ func SignatureFromBytes(data []byte) (signature Signature, consumedBytes int, err error)

+ type SignatureType uint8

+ const BLSSignatureType

+ const ED25519SignatureType

+ func (s SignatureType) String() string

+ type SignatureUnlockBlock struct

+ func NewSignatureUnlockBlock(signature Signature) *SignatureUnlockBlock

+ func (s *SignatureUnlockBlock) AddressSignatureValid(address Address, signedData []byte) bool

+ func (s *SignatureUnlockBlock) Signature() Signature

+ func (s *SignatureUnlockBlock) Type() UnlockBlockType

+ type Transaction struct

+ func NewTransaction(essence *TransactionEssence, unlockBlocks UnlockBlocks) (transaction *Transaction)

+ func (t *Transaction) Essence() *TransactionEssence

+ func (t *Transaction) FromBytes(data []byte) error

+ func (t *Transaction) FromObjectStorage(key, value []byte) error

+ func (t *Transaction) ID() utxo.TransactionID

+ func (t *Transaction) Inputs() (inputs []utxo.Input)

+ func (t *Transaction) Type() payload.Type

+ func (t *Transaction) UnlockBlocks() UnlockBlocks

+ type TransactionEssence struct

+ func NewTransactionEssence(version TransactionEssenceVersion, timestamp time.Time, ...) *TransactionEssence

+ func TransactionEssenceFromBytes(data []byte) (transactionEssence *TransactionEssence, consumedBytes int, err error)

+ func (t *TransactionEssence) AccessPledgeID() identity.ID

+ func (t *TransactionEssence) ConsensusPledgeID() identity.ID

+ func (t *TransactionEssence) Inputs() Inputs

+ func (t *TransactionEssence) Outputs() Outputs

+ func (t *TransactionEssence) Payload() payload.Payload

+ func (t *TransactionEssence) SetPayload(p payload.Payload)

+ func (t *TransactionEssence) Timestamp() time.Time

+ func (t *TransactionEssence) Version() TransactionEssenceVersion

+ type TransactionEssenceVersion uint8

+ func (t TransactionEssenceVersion) Bytes() []byte

+ func (t TransactionEssenceVersion) Compare(other TransactionEssenceVersion) int

+ func (t TransactionEssenceVersion) String() string

+ type TransactionIDs map[utxo.TransactionID]types.Empty

+ func (t TransactionIDs) Base58s() (transactionIDs []string)

+ func (t TransactionIDs) Clone() (transactionIDs TransactionIDs)

+ func (t TransactionIDs) String() (result string)

+ type UTXOInput struct

+ func NewUTXOInput(referencedOutputID utxo.OutputID) *UTXOInput

+ func (u *UTXOInput) Base58() string

+ func (u *UTXOInput) Compare(other Input) int

+ func (u *UTXOInput) ReferencedOutputID() utxo.OutputID

+ func (u *UTXOInput) Type() InputType

+ type UnlockBlock interface

+ Bytes func() ([]byte, error)

+ String func() string

+ Type func() UnlockBlockType

+ type UnlockBlockType uint8

+ const AliasUnlockBlockType

+ const ReferenceUnlockBlockType

+ const SignatureUnlockBlockType

+ func (a UnlockBlockType) String() string

+ type UnlockBlocks []UnlockBlock

+ func UnlockBlocksFromBytes(bytes []byte) (unlockBlocks UnlockBlocks, consumedBytes int, err error)

+ func (u UnlockBlocks) Bytes() []byte

+ func (u UnlockBlocks) String() string

+ type UnlockGraph struct

+ Edges map[uint16]uint16

+ Vertices []uint16

+ func NewUnlockGraph(blocks UnlockBlocks) (*UnlockGraph, error)

+ func (g *UnlockGraph) IsCycleDetected() bool

+ type VM struct

+ func (d *VM) ExecuteTransaction(transaction utxo.Transaction, inputs *utxo.Outputs, _ ...uint64) (outputs []utxo.Output, err error)

+ func (d *VM) ParseOutput(outputBytes []byte) (output utxo.Output, err error)

+ func (d *VM) ParseTransaction(transactionBytes []byte) (transaction utxo.Transaction, err error)

+ func (d *VM) ResolveInput(input utxo.Input) (outputID utxo.OutputID)