io.neow3j.test

Interface TestBlockchain

All Known Implementing Classes:

NeoExpressTestContainer

public interface TestBlockchain

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TestBlockchain.GenesisAccount

Method Summary

Modifier and Type	Method and Description
java.lang.String	createAccount() Creates a new account.
java.lang.String	enableOracle() Enables the oracle service.
java.lang.String	execCommand(java.lang.String... commandParts) Executes the given command.
java.lang.String	fastForward(int n) Fast-forwards the blockchain state by n blocks.
java.lang.String	fastForward(int seconds, int n) Mints n blocks with the last block being seconds in the future.
java.lang.String	getAccount(java.lang.String address) Gets the private key corresponding to the given address.
TestBlockchain.GenesisAccount	getGenesisAccount() Gets the genesis account this blockchain is based on.
java.lang.String	getNodeUrl()
java.lang.String	halt() Halts the blockchain, i.e., stops block production.
java.lang.String	resume() Resumes the blockchain if it was stopped before.
void	start() Starts the blockchain, i.e., the process that includes the blockchain.
void	stop() Stops the blockchain, i.e., the process that includes the blockchain.
TestBlockchain	withBatchFile(java.lang.String batchFile) Adds the given batch file to the blockchain.
TestBlockchain	withCheckpoint(java.lang.String checkpointFile) Adds the given checkpoint file to the blockchain.
TestBlockchain	withConfigFile(java.lang.String configFile) Adds the given config file to the blockchain.
TestBlockchain	withSecondsPerBlock(int secondsPerBlock) Sets the given block time to be used by the blockchain.

Method Detail

withSecondsPerBlock

TestBlockchain withSecondsPerBlock(int secondsPerBlock)

Sets the given block time to be used by the blockchain.

Parameters:

secondsPerBlock - the block time.

Returns:

this.

withBatchFile

TestBlockchain withBatchFile(java.lang.String batchFile)

Adds the given batch file to the blockchain. A batch file specifies commands (e.g., token transfers or other contract invocations) that set up the blockchain state for tests.

The batch file must be located in the resources directory.

Parameters:

batchFile - the batch file name.

Returns:

this.

withCheckpoint

TestBlockchain withCheckpoint(java.lang.String checkpointFile)

Adds the given checkpoint file to the blockchain. A checkpoint specifies a pre-generated blockchain state that is used to set up the blockchain to that state before tests.

The checkpoint file must be located in the resources directory.

If both a batch and a checkpoint file are added, the checkpoint is first applied.

Parameters:

checkpointFile - the checkpoint file name.

Returns:

this.

withConfigFile

TestBlockchain withConfigFile(java.lang.String configFile)

Adds the given config file to the blockchain. It will be used to configure the blockchain instance.

The file must be located in the resources directory.

Parameters:

configFile - the config file name.

Returns:

this.

getNodeUrl

java.lang.String getNodeUrl()

Returns:

the URL of the test blockchain node.

resume

java.lang.String resume()
                 throws java.lang.Exception

Resumes the blockchain if it was stopped before.

Returns:

the message emitted by the chain on startup or null if no message is emitted.

Throws:

java.lang.Exception - if an error occurred when trying to resume the blockchain.

halt

java.lang.String halt()
               throws java.lang.Exception

Halts the blockchain, i.e., stops block production.

Returns:

the message emitted by the chain on stopping or null if no message is emitted.

Throws:

java.lang.Exception - if an error occurred when trying to halt the blockchain.

createAccount

java.lang.String createAccount()
                        throws java.lang.Exception

Creates a new account.

Returns:

the new account's address.

Throws:

java.lang.Exception - if an error occurred when trying to create an account.

enableOracle

java.lang.String enableOracle()
                       throws java.lang.Exception

Enables the oracle service.

Returns:

the hash of the oracle designate transaction.

Throws:

java.lang.Exception - if an error occurred when trying to enable the oracle service.

fastForward

java.lang.String fastForward(int n)
                      throws java.lang.Exception

Fast-forwards the blockchain state by n blocks. I.e., mints n empty blocks.

Parameters:

n - the number of blocks to mint.

Returns:

the message emitted on minting the blocks or null if no message is emitted.

Throws:

java.lang.Exception - if an error occurred when trying to fast-forward the blockchain.

fastForward

java.lang.String fastForward(int seconds,
                             int n)
                      throws java.lang.Exception

Mints n blocks with the last block being seconds in the future.

Parameters:

seconds - the time delta in seconds from now.

n - the number of blocks to mint.

Returns:

the message emitted on minting the blocks.

Throws:

java.lang.Exception - if an error occurred when minting the blocks.

execCommand

java.lang.String execCommand(java.lang.String... commandParts)
                      throws java.lang.Exception

Executes the given command.

Parameters:

commandParts - the command separated into its parts.

Returns:

the message emitted on executing the command or null if no message is emitted.

Throws:

java.lang.Exception - if an error occurred when trying to execute the command on the blockchain.

start

void start()

Starts the blockchain, i.e., the process that includes the blockchain.

stop

void stop()

Stops the blockchain, i.e., the process that includes the blockchain.

getGenesisAccount

TestBlockchain.GenesisAccount getGenesisAccount()
                                         throws java.lang.Exception

Gets the genesis account this blockchain is based on.

This is for test blockchains that provide control over the genesis account. The genesis account owns all NEO and GAS tokens starting from the first block.

Returns:

the genesis account.

Throws:

java.lang.Exception - if an error occurred when trying to fetch the genesis account.

getAccount

java.lang.String getAccount(java.lang.String address)
                     throws java.lang.Exception

Gets the private key corresponding to the given address.

This is not meant to be used for multi-sig accounts.

Parameters:

address - the account's address.

Returns:

the private key as a hexadecimal string.

Throws:

java.lang.Exception - if an error occurred when trying to fetch the account.