nep17

Documentation

Index

• func IsUsableAddress(addr []byte) bool
• type Token
  • func (t Token) BalanceOf(ctx storage.Context, holder []byte) int
  • func (t Token) CanTransfer(ctx storage.Context, from []byte, to []byte, amount int) int
  • func (t Token) GetSupply(ctx storage.Context) int
  • func (t Token) Mint(ctx storage.Context, to interop.Hash160) bool
  • func (t Token) Transfer(ctx storage.Context, from, to interop.Hash160, amount int, data interface{}) bool

Functions

func IsUsableAddress

func IsUsableAddress(addr []byte) bool

IsUsableAddress checks if the sender is either the correct NEO address or SC address

Types

type Token

type Token struct {
	// Token name
	Name string
	// Ticker symbol
	Symbol string
	// Amount of decimals
	Decimals int
	// Token owner address
	Owner []byte
	// Total tokens * multiplier
	TotalSupply int
	// Storage key for circulation value
	CirculationKey string
}

Token holds all token info

func (Token) BalanceOf

func (t Token) BalanceOf(ctx storage.Context, holder []byte) int

BalanceOf gets the token balance of a specific address

func (Token) CanTransfer

func (t Token) CanTransfer(ctx storage.Context, from []byte, to []byte, amount int) int

CanTransfer returns the amount it can transfer

func (Token) GetSupply

func (t Token) GetSupply(ctx storage.Context) int

GetSupply gets the token totalSupply value from VM storage

func (Token) Mint

func (t Token) Mint(ctx storage.Context, to interop.Hash160) bool

Mint initial supply of tokens

func (Token) Transfer

func (t Token) Transfer(ctx storage.Context, from, to interop.Hash160, amount int, data interface{}) bool

Transfer token from one user to another