io.neow3j.devpack.contracts

Class Nep17Token

java.lang.Object

io.neow3j.devpack.ContractInterface

io.neow3j.devpack.contracts.Nep17Token

Direct Known Subclasses:

GasToken, NeoToken

public abstract class Nep17Token
extends ContractInterface

Base class for NEP-17 contracts. Extend this class in combination with the ContractHash annotation to create an "interface" to a NEP-17 token contract on the Neo blockchain. Examples are the NeoToken and GasToken contracts.

Constructor Summary

Constructors

Constructor and Description
Nep17Token()

Method Summary

Modifier and Type	Method and Description
static int	balanceOf(byte[] scriptHash) Gets the token balance of the given account.
static int	decimals() Gets the number of decimals of this token.
static java.lang.String	symbol() Gets the symbol of this token.
static int	totalSupply() Gets the total supply of this token.
static boolean	transfer(byte[] from, byte[] to, int amount, java.lang.Object data) Transfers the token amount from the from account to the to account.

Methods inherited from class io.neow3j.devpack.ContractInterface

getHash

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Nep17Token

public Nep17Token()

Method Detail

symbol

public static java.lang.String symbol()

Gets the symbol of this token.

Returns:

the symbol.

decimals

public static int decimals()

Gets the number of decimals of this token.

Returns:

the number of decimals.

totalSupply

public static int totalSupply()

Gets the total supply of this token.

Returns:

the total supply.

balanceOf

public static int balanceOf(byte[] scriptHash)

Gets the token balance of the given account.

Parameters:

scriptHash - The script hash of the account to get the balance for.

Returns:

the account's balance.

transfer

public static boolean transfer(byte[] from,
                               byte[] to,
                               int amount,
                               java.lang.Object data)

Transfers the token amount from the from account to the to account. The data is passed along with the call. For example, if the to account is a contract it is provided as an argument to the contract's onPayment method.

Parameters:

from - The hash of the payment originator.

to - The hash of the receiver.

amount - The token amount to transfer.

data - The data to pass along with the transfer.

Returns:

True, if the transfer was successful. False, otherwise.