io.neow3j.devpack.neo

Class Runtime

java.lang.Object

io.neow3j.devpack.neo.Runtime

public class Runtime
extends java.lang.Object

Provides a set of general methods for usage in smart contracts.

Constructor Summary

Constructors

Constructor and Description
Runtime()

Method Summary

Modifier and Type	Method and Description
static boolean	checkWitness(byte[] scriptHashOrPubkey) Verifies whether the container (e.g.
static long	getGasLeft() Gets the amount of GAS left in the current invocation of the contract.
static int	getInvocationCounter() Gets the call number of the current contract.
static Notification[]	getNotifications(byte[] hash) Gets current invocation notifications matching the given sender script hash.
static java.lang.String	getPlatform() Gets information of the platform on which the smart contract is currently executed.
static long	getTime() Gets the timestamp of the current block.
static byte	getTrigger() Gets the TriggerType with which the the smart contract has been triggered.
static void	log(java.lang.String message) Issues a log message, notifying the client that invoked the contract.
static void	notify(java.lang.Object... state) Issues a notification, notifying the client that invoked the contract.

Methods inherited from class java.lang.Object

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

Constructor Detail

Runtime

public Runtime()

Method Detail

getTrigger

public static byte getTrigger()

Gets the TriggerType with which the the smart contract has been triggered.

Returns:

the TriggerType.

getPlatform

public static java.lang.String getPlatform()

Gets information of the platform on which the smart contract is currently executed.

Returns:

the platform information.

getTime

public static long getTime()

Gets the timestamp of the current block.

Returns:

the timestamp

getInvocationCounter

public static int getInvocationCounter()

Gets the call number of the current contract.

Returns:

the call number.

getGasLeft

public static long getGasLeft()

Gets the amount of GAS left in the current invocation of the contract.

Returns:

the amount in fractions of GAS.

getNotifications

public static Notification[] getNotifications(byte[] hash)

Gets current invocation notifications matching the given sender script hash. The script hash must be 20 bytes long. If it is all zeros, it refers to all existing notifications.

Parameters:

hash - The sender script hash to get the notifications for.

Returns:

an array of all notifications matching the given script hash.

checkWitness

public static boolean checkWitness(byte[] scriptHashOrPubkey)

Verifies whether the container (e.g. the transactions) calling the contract is signed by the given script hash or public key (e.g. an account).

Parameters:

scriptHashOrPubkey - The script hash or public key to check.

Returns:

true if the given script hash is the signer of the transaction. False, otherwise.

notify

public static void notify(java.lang.Object... state)

Issues a notification, notifying the client that invoked the contract.

The given state can be a list of any types, e.g. `notify("Notification reason", Blockchain .getHeight()`. The client developer needs to know what types to expect when reading the notification.

Parameters:

state - The state to send with the notification.

log

public static void log(java.lang.String message)

Issues a log message, notifying the client that invoked the contract.

This is similar to notify(Object...) but restricted to a string message.

Parameters:

message - The message to log.