types

Documentation

Index

• Constants
• Variables
• type Amount
• type HexEncodable
  • func (h HexEncodable) MarshalJSON() ([]byte, error)
  • func (h *HexEncodable) UnmarshalJSON(data []byte) error
• type ID
  • func NewID(digest []byte) ID
  • func NewIDFromData(data []byte) ID
  • func NewIDFromString(id string) (ID, error)
  • func (id ID) Bytes() []byte
  • func (id ID) Clone() ID
  • func (id ID) Compare(target ID) int
  • func (id *ID) MarshalJSON() ([]byte, error)
  • func (id *ID) SetBytes(data []byte)
  • func (id ID) String() string
  • func (id *ID) UnmarshalJSON(data []byte) error
• type Nullifier
  • func CalculateNullifier(commitmentIndex uint64, salt [32]byte, scriptCommitment []byte, ...) (Nullifier, error)
  • func NewNullifier(b []byte) Nullifier
  • func NewNullifierFromString(n string) (Nullifier, error)
  • func (n Nullifier) Bytes() []byte
  • func (n *Nullifier) MarshalJSON() ([]byte, error)
  • func (n *Nullifier) SetBytes(data []byte)
  • func (n Nullifier) String() string
  • func (n *Nullifier) UnmarshalJSON(data []byte) error
• type Serializable
• type SpendNote
  • func (s *SpendNote) Commitment() (ID, error)
  • func (s *SpendNote) Deserialize(ser []byte) error
  • func (s *SpendNote) Serialize() []byte
• type UnlockingScript
  • func (u *UnlockingScript) Hash() ID
  • func (u *UnlockingScript) Serialize() []byte

Constants

const (
	CommitmentLen = 32
	ScriptHashLen = 32
	AmountLen     = 8
	AssetIDLen    = 32
	StateLen      = 128
	SaltLen       = 32
)

const NullifierSize = hash.HashSize

Variables

var ErrIDStrSize = fmt.Errorf("max ID string length is %v bytes", hash.HashSize*2)

var IlliumCoinID = NewID(bytes.Repeat([]byte{0x00}, 32))

Types

type Amount

type Amount uint64

Amount represents the base illium monetary unit (to be named later). The total number of coins issued is not expected to overflow an uint64 for 250 years from genesis.

type HexEncodable

type HexEncodable []byte

func (HexEncodable) MarshalJSON

func (h HexEncodable) MarshalJSON() ([]byte, error)

func (*HexEncodable) UnmarshalJSON

func (h *HexEncodable) UnmarshalJSON(data []byte) error

type ID

type ID [hash.HashSize]byte

func NewID

func NewID(digest []byte) ID

func NewIDFromData

func NewIDFromData(data []byte) ID

func NewIDFromString

func NewIDFromString(id string) (ID, error)

func (ID) Bytes

func (id ID) Bytes() []byte

func (ID) Clone

func (id ID) Clone() ID

func (ID) Compare

func (id ID) Compare(target ID) int

Compare returns 1 if hash > target, -1 if hash < target and 0 if hash == target.

func (*ID) MarshalJSON

func (id *ID) MarshalJSON() ([]byte, error)

func (*ID) SetBytes

func (id *ID) SetBytes(data []byte)

func (ID) String

func (id ID) String() string

func (*ID) UnmarshalJSON

func (id *ID) UnmarshalJSON(data []byte) error

type Nullifier

type Nullifier [hash.HashSize]byte

func CalculateNullifier

func CalculateNullifier(commitmentIndex uint64, salt [32]byte, scriptCommitment []byte, scriptParams ...[]byte) (Nullifier, error)

CalculateNullifier calculates and returns the nullifier for the given inputs.

func NewNullifier

func NewNullifier(b []byte) Nullifier

func NewNullifierFromString

func NewNullifierFromString(n string) (Nullifier, error)

func (Nullifier) Bytes

func (n Nullifier) Bytes() []byte

func (*Nullifier) MarshalJSON

func (n *Nullifier) MarshalJSON() ([]byte, error)

func (*Nullifier) SetBytes

func (n *Nullifier) SetBytes(data []byte)

func (Nullifier) String

func (n Nullifier) String() string

func (*Nullifier) UnmarshalJSON

func (n *Nullifier) UnmarshalJSON(data []byte) error

type Serializable

type Serializable interface {
	Serialize() ([]byte, error)
	Deserialize(data []byte) error
	MarshalJSON() ([]byte, error)
	UnmarshalJSON(data []byte) error
}

type SpendNote

type SpendNote struct {
	ScriptHash []byte
	Amount     Amount
	AssetID    ID
	State      [StateLen]byte
	Salt       [SaltLen]byte
}

SpendNote holds all the data that makes up an output commitment.

func (*SpendNote) Commitment

func (s *SpendNote) Commitment() (ID, error)

Commitment serializes and hashes the data in the note and returns the hash.

func (*SpendNote) Deserialize

func (s *SpendNote) Deserialize(ser []byte) error

func (*SpendNote) Serialize

func (s *SpendNote) Serialize() []byte

type UnlockingScript

type UnlockingScript struct {
	ScriptCommitment []byte
	ScriptParams     [][]byte
}

func (*UnlockingScript) Hash

func (u *UnlockingScript) Hash() ID

func (*UnlockingScript) Serialize

func (u *UnlockingScript) Serialize() []byte