spice

Documentation

Index

• Constants
• Variables
• func Transfer(amount Melange, from, to *Melange) error
• type Melange
  • func Decode(buf []byte) (Melange, error)
  • func FromFloat(n float64) Melange
  • func New(currency, supplementaryCurrency uint64) Melange
  • func (m Melange) Clone() Melange
  • func (m *Melange) Drain(amount Melange, sink *Melange) error
  • func (m *Melange) Empty() bool
  • func (s *Melange) Encode() ([]byte, error)
  • func (m Melange) String() string
  • func (m *Melange) Supply(amount Melange) error

Constants

const (
	Currency = iota
	SupplementaryCurrency
)

const (
	MaxAmountPerSupplementaryCurrency = 1000000000000000000
)

Variables

var (
	ErrValueOverflow      = errors.New("value overflow")
	ErrNoSufficientFounds = errors.New("no sufficient founds to process transaction")
)

Functions

func Transfer

func Transfer(amount Melange, from, to *Melange) error

Transfer transfers given amount from one Melange asset to the other if possible or returns error otherwise.

Types

type Melange

type Melange struct {
	Currency              uint64 `yaml:"currency"               msgpack:"currency"`
	SupplementaryCurrency uint64 `yaml:"supplementary_currency" msgpack:"supplementary_currency"`
}

Melange is an asset that is digitally transferable between two wallets.

func Decode

func Decode(buf []byte) (Melange, error)

func FromFloat

func FromFloat(n float64) Melange

From float crates a new spice Melange from floating point number. Note this will give a precision up to nine decimal places.

func New

func New(currency, supplementaryCurrency uint64) Melange

New creates a new spice Melange from given currency and supplementary currency values.

func (Melange) Clone

func (m Melange) Clone() Melange

func (*Melange) Drain

func (m *Melange) Drain(amount Melange, sink *Melange) error

Drain drains amount from the function pointer receiver to the sink.

func (*Melange) Empty

func (m *Melange) Empty() bool

Empty verifies if is spice empty.

func (*Melange) Encode

func (s *Melange) Encode() ([]byte, error)

func (Melange) String

func (m Melange) String() string

String returns string representation of spice Melange.

func (*Melange) Supply

func (m *Melange) Supply(amount Melange) error

Supply supplies spice of the given amount from the source to the entity.