3
0
mirror of https://github.com/Qortal/AT.git synced 2025-02-14 11:15:51 +00:00
AT/Java/tests/common/TestAPI.java
catbref 454d4bed35 OpCode refactoring, versioned constants, refactored tests
API is now an abstract class instead of an Interface. This is to
allow protected methods that give access to package-scoped methods
and variables inside MachineState.

MachineState now supports a different set of constants based on AT
version.

MachineState's methods and variables have had their scopes tightened
up and getters/setters added where appropriate.

MachineState.parseHeader() inlined into the constructor that calls it
so it can set public final variables.

Some reordering and additional comments in MachineState.

OpCode enum entries refactored so that:
a) variables provided via MachineState "state" are not explicitly
passed as well

b) args to each opcode are pre-fetched from the codeByteBuffer before
calling and only need to be cast before use. this comes almost
"for free" thanks to OpCodeParam.fetch

Calling functions from OpCode now cleaner as there's no write-access
to programCounter, only changing codeByteBuffer's position.

Also in OpCode, state.getProgramCounter() now provides a consistent
before-opcode position for branches, jumps, etc.

Lots of repeated code refactored out of unit tests into ExecutableTest
class. ExecutableTest also provides helper methods for examining
post-execution data values, stack positions and entries.
2018-10-05 15:56:32 +01:00

204 lines
5.7 KiB
Java

package common;
import org.ciyam.at.API;
import org.ciyam.at.ExecutionException;
import org.ciyam.at.FunctionData;
import org.ciyam.at.IllegalFunctionCodeException;
import org.ciyam.at.MachineState;
import org.ciyam.at.Timestamp;
public class TestAPI extends API {
private static final int BLOCK_PERIOD = 10 * 60; // average period between blocks in seconds
private int currentBlockHeight;
public TestAPI() {
this.currentBlockHeight = 10;
}
public void bumpCurrentBlockHeight() {
++this.currentBlockHeight;
}
@Override
public int getCurrentBlockHeight() {
return this.currentBlockHeight;
}
@Override
public int getATCreationBlockHeight(MachineState state) {
return 5;
}
@Override
public void putPreviousBlockHashInA(MachineState state) {
this.setA1(state, 9L);
this.setA2(state, 9L);
this.setA3(state, 9L);
this.setA4(state, 9L);
}
@Override
public void putTransactionAfterTimestampInA(Timestamp timestamp, MachineState state) {
// Cycle through transactions: 1 -> 2 -> 3 -> 0 -> 1 ...
this.setA1(state, (timestamp.transactionSequence + 1) % 4);
this.setA2(state, state.getA1());
this.setA3(state, state.getA1());
this.setA4(state, state.getA1());
}
@Override
public long getTypeFromTransactionInA(MachineState state) {
return 0L;
}
@Override
public long getAmountFromTransactionInA(MachineState state) {
return 123L;
}
@Override
public long getTimestampFromTransactionInA(MachineState state) {
return 1536227162000L;
}
@Override
public long generateRandomUsingTransactionInA(MachineState state) {
if (state.getSteps() != 0) {
// First call
System.out.println("generateRandomUsingTransactionInA: first call - sleeping");
// first-call initialization would go here
this.setIsSleeping(state, true);
return 0L; // not used
} else {
// Second call
System.out.println("generateRandomUsingTransactionInA: second call - returning random");
// HASH(A and new block hash)
return (state.getA1() ^ 9L) << 3 ^ (state.getA2() ^ 9L) << 12 ^ (state.getA3() ^ 9L) << 5 ^ (state.getA4() ^ 9L);
}
}
@Override
public void putMessageFromTransactionInAIntoB(MachineState state) {
this.setB1(state, state.getA4());
this.setB2(state, state.getA3());
this.setB3(state, state.getA2());
this.setB4(state, state.getA1());
}
@Override
public void putAddressFromTransactionInAIntoB(MachineState state) {
// Dummy address
this.setB1(state, 0xaaaaaaaaaaaaaaaaL);
this.setB2(state, 0xaaaaaaaaaaaaaaaaL);
this.setB3(state, 0xaaaaaaaaaaaaaaaaL);
this.setB4(state, 0xaaaaaaaaaaaaaaaaL);
}
@Override
public void putCreatorAddressIntoB(MachineState state) {
// Dummy creator
this.setB1(state, 0xccccccccccccccccL);
this.setB2(state, 0xccccccccccccccccL);
this.setB3(state, 0xccccccccccccccccL);
this.setB4(state, 0xccccccccccccccccL);
}
@Override
public long getCurrentBalance(MachineState state) {
return 12345L;
}
@Override
public long getPreviousBalance(MachineState state) {
return 10000L;
}
@Override
public void payAmountToB(long value1, MachineState state) {
}
@Override
public void payCurrentBalanceToB(MachineState state) {
}
@Override
public void payPreviousBalanceToB(MachineState state) {
}
@Override
public void messageAToB(MachineState state) {
}
@Override
public long addMinutesToTimestamp(Timestamp timestamp, long minutes, MachineState state) {
timestamp.blockHeight = ((int) minutes * 60) / BLOCK_PERIOD;
return timestamp.longValue();
}
@Override
public void onFatalError(MachineState state, ExecutionException e) {
System.out.println("Fatal error: " + e.getMessage());
System.out.println("No error address set - refunding to creator and finishing");
}
@Override
public void platformSpecificPreExecuteCheck(short functionCodeValue, int paramCount, boolean returnValueExpected) throws IllegalFunctionCodeException {
Integer requiredParamCount;
Boolean returnsValue;
switch (functionCodeValue) {
case 0x0501:
// take one arg, no return value
requiredParamCount = 1;
returnsValue = false;
break;
case 0x0502:
// take no arg, return a value
requiredParamCount = 0;
returnsValue = true;
break;
default:
// Unrecognised platform-specific function code
throw new IllegalFunctionCodeException("Unrecognised platform-specific function code 0x" + String.format("%04x", functionCodeValue));
}
if (requiredParamCount == null || returnsValue == null)
throw new IllegalFunctionCodeException("Error during platform-specific function pre-execute check");
if (paramCount != requiredParamCount)
throw new IllegalFunctionCodeException("Passed paramCount (" + paramCount + ") does not match platform-specific function code 0x"
+ String.format("%04x", functionCodeValue) + " required paramCount (" + requiredParamCount + ")");
if (returnValueExpected != returnsValue)
throw new IllegalFunctionCodeException("Passed returnValueExpected (" + returnValueExpected + ") does not match platform-specific function code 0x"
+ String.format("%04x", functionCodeValue) + " return signature (" + returnsValue + ")");
}
@Override
public void platformSpecificPostCheckExecute(short functionCodeValue, FunctionData functionData, MachineState state) throws ExecutionException {
switch (functionCodeValue) {
case 0x0501:
System.out.println("Platform-specific function 0x0501 called with 0x" + String.format("%016x", functionData.value1));
break;
case 0x0502:
System.out.println("Platform-specific function 0x0502 called!");
functionData.returnValue = 0x0502L;
break;
default:
// Unrecognised platform-specific function code
throw new IllegalFunctionCodeException("Unrecognised platform-specific function code 0x" + String.format("%04x", functionCodeValue));
}
}
}