io.neow3j.devpack.contracts

Class NeoToken

java.lang.Object

io.neow3j.devpack.ContractInterface

io.neow3j.devpack.contracts.Nep17Token

io.neow3j.devpack.contracts.NeoToken

public class NeoToken
extends Nep17Token

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NeoToken.Candidate Represents a validator candidate.

Constructor Summary

Constructors

Constructor and Description
NeoToken()

Method Summary

Modifier and Type	Method and Description
static NeoToken.Candidate[]	getCandidates() Gets the registered candidates.
static java.lang.String[]	getCommittee() Gets the public keys of the current committee members.
static int	getGasPerBlock() Gets the amount of GAS that is minted per newly generated block.
static java.lang.String[]	getNextBlockValidators() Gets the public keys of the validators that will validate the upcoming block.
static boolean	registerCandidate(byte[] publicKey) Registers the given public key as a validator candidate.
static boolean	setGasPerBlock(int gasPerBlock) Sets the amount of GAS that should be minted per newly generated block.
static int	unclaimedGas(byte[] scriptHash, int blockHeight) Gets the amount of unclaimed GAS for the given account up the the given block number.
static boolean	unregisterCandidate(byte[] publicKey) Unregisters the given public key from the list of validator candidates.
static boolean	vote(byte[] scriptHash, byte[] candidatePubKey) Casts a vote for the candidate with the given public key.

Methods inherited from class io.neow3j.devpack.contracts.Nep17Token

balanceOf, decimals, symbol, totalSupply, transfer

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

NeoToken

public NeoToken()

Method Detail

unclaimedGas

public static int unclaimedGas(byte[] scriptHash,
                               int blockHeight)

Gets the amount of unclaimed GAS for the given account up the the given block number.

Parameters:

scriptHash - The script hash of the account to get the unclaimed GAS amount for.

blockHeight - The block height up to which the GAS amount will be fetched.

Returns:

the amount of unclaimed GAS.

registerCandidate

public static boolean registerCandidate(byte[] publicKey)

Registers the given public key as a validator candidate.

Parameters:

publicKey - The public key of the candidate.

Returns:

true, if registering was successful. False, otherwise.

unregisterCandidate

public static boolean unregisterCandidate(byte[] publicKey)

Unregisters the given public key from the list of validator candidates.

Parameters:

publicKey - The public key of the candidate.

Returns:

true, if deregistering was successful. False, otherwise.

vote

public static boolean vote(byte[] scriptHash,
                           byte[] candidatePubKey)

Casts a vote for the candidate with the given public key.

Note, that a witness (signature) of the account corresponding to the public key has to be available for this to work.

Parameters:

scriptHash - The script hash of the account that is used to cast the vote.

candidatePubKey - The public key of the candidate to vote for.

Returns:

true, if voting was successful. False, otherwise.

getCandidates

public static NeoToken.Candidate[] getCandidates()

Gets the registered candidates.

Returns:

the list of registered candidates.

getCommittee

public static java.lang.String[] getCommittee()

Gets the public keys of the current committee members.

Returns:

the committee members' public keys as strings.

getNextBlockValidators

public static java.lang.String[] getNextBlockValidators()

Gets the public keys of the validators that will validate the upcoming block.

Returns:

the next validators' public keys as strings.

getGasPerBlock

public static int getGasPerBlock()

Gets the amount of GAS that is minted per newly generated block.

Returns:

the amount of minted GAS per block.

setGasPerBlock

public static boolean setGasPerBlock(int gasPerBlock)

Sets the amount of GAS that should be minted per newly generated block.

Parameters:

gasPerBlock - The desired amount of GAS per block.

Returns:

true, if setting the amount was successful. False, otherwise.