10 Commits
4 changed files with 250 additions and 172 deletions
+21 -13
View File
@@ -28,9 +28,9 @@ contract Push3IntAdapter {
view view
returns (uint256) returns (uint256)
{ {
// CodeTag.SUBLIST is typically enum = 3, but // CodeTag.SUBLIST is typically enum = 4, but
// let's fetch it via // let's fetch it via
// (uint8)Push3Interpreter.CodeTag.SUBLIST // (uint8)Push3Interpreter.CodeTag.SUBLIST
// or we can directly pass 3 if we know the numeric value. // or we can directly pass 3 if we know the numeric value.
// We'll do: // We'll do:
@@ -69,9 +69,12 @@ contract Push3IntAdapter {
int256[] memory initIntStack = new int256[](1); int256[] memory initIntStack = new int256[](1);
initIntStack[0] = in1; initIntStack[0] = in1;
// No bool stack
bool[] memory initBoolStack = new bool[](0);
// 4) Run // 4) Run
(, , int256[] memory finalIntStack) = (, , int256[] memory finalIntStack,) =
interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack); interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack, initBoolStack);
// 5) Return top of final int stack // 5) Return top of final int stack
require(finalIntStack.length > 0, "No integer output produced"); require(finalIntStack.length > 0, "No integer output produced");
@@ -96,11 +99,13 @@ contract Push3IntAdapter {
initIntStack[0] = in1; initIntStack[0] = in1;
initIntStack[1] = in2; initIntStack[1] = in2;
(, , int256[] memory finalIntStack) = bool[] memory initBoolStack = new bool[](0);
interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack);
(, , int256[] memory finalIntStack,) =
interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack, initBoolStack);
require(finalIntStack.length > 0, "No integer output"); require(finalIntStack.length > 0, "No integer output");
out1 = finalIntStack[finalIntStack.length - 1]; out1 = finalIntStack[finalIntStack.length - 1];
} }
@@ -121,8 +126,10 @@ contract Push3IntAdapter {
int256[] memory initIntStack = new int256[](1); int256[] memory initIntStack = new int256[](1);
initIntStack[0] = in1; initIntStack[0] = in1;
(, , int256[] memory finalIntStack) = bool[] memory initBoolStack = new bool[](0);
interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack);
(, , int256[] memory finalIntStack,) =
interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack, initBoolStack);
require(finalIntStack.length >= 2, "Not enough outputs"); require(finalIntStack.length >= 2, "Not enough outputs");
out1 = finalIntStack[finalIntStack.length - 1]; out1 = finalIntStack[finalIntStack.length - 1];
@@ -130,7 +137,7 @@ contract Push3IntAdapter {
} }
/** /**
* @notice Zero int input, returns entire final int stack * @notice Zero int input, returns entire final int stack
*/ */
function run0InNOut(bytes calldata code) function run0InNOut(bytes calldata code)
external external
@@ -143,9 +150,10 @@ contract Push3IntAdapter {
uint256[] memory initCodeStack = new uint256[](0); uint256[] memory initCodeStack = new uint256[](0);
int256[] memory initIntStack = new int256[](0); int256[] memory initIntStack = new int256[](0);
bool[] memory initBoolStack = new bool[](0);
(, , int256[] memory finalIntStack) = (, , int256[] memory finalIntStack,) =
interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack); interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack, initBoolStack);
return finalIntStack; return finalIntStack;
} }
+152 -100
View File
@@ -9,10 +9,14 @@ import "forge-std/console.sol";
* a token-based bytecode approach. * a token-based bytecode approach.
*/ */
contract Push3Interpreter { contract Push3Interpreter {
// ReadUint`numBits` out of the code range.
error ReadUintOutOfRange(uint256 numBits);
// ----------------------------------------------------- // -----------------------------------------------------
// 0. CONSTANTS // 0. CONSTANTS
// ----------------------------------------------------- // -----------------------------------------------------
uint8 internal constant OPCODE_BOOL_OFFSET = 0x6; uint8 internal constant OPCODE_INTEGER_OFFSET = 0x05;
uint8 internal constant OPCODE_BOOL_OFFSET = 0x0a;
uint8 internal constant OPCODE_LAST = OPCODE_BOOL_OFFSET + 0x10;
// ----------------------------------------------------- // -----------------------------------------------------
// 1. ENUMS // 1. ENUMS
@@ -21,18 +25,22 @@ contract Push3Interpreter {
NO_TAG, // 0 NO_TAG, // 0
INSTRUCTION, // 1 INSTRUCTION, // 1
INT_LITERAL, // 2 INT_LITERAL, // 2
SUBLIST, // 3 BOOL_LITERAL, // 3
BOOL_LITERAL // 4 SUBLIST // 4
} }
enum OpCode { enum OpCode {
NOOP, // 0 NOOP, // 0
INTEGER_PLUS, // 1 NOOP_1, // 1 - empty for INSTRUCTION
INTEGER_MINUS, // 2 NOOP_2, // 2 - empty for INT_LITERAL
INTEGER_MULT, // 3 NOOP_3, // 3 - empty for BOOL_LITERAL
INTEGER_DUP, // 4 NOOP_4, // 4 - empty for SUBLIST
INTEGER_POP, // 5 INTEGER_PLUS, // 5 - OPCODE_INTEGER_OFFSET
BOOL_DUP, // OPCODE_BOOL_OFFSET + 0 INTEGER_MINUS, // OPCODE_INTEGER_OFFSET + 1
INTEGER_MULT, // OPCODE_INTEGER_OFFSET + 2
INTEGER_DUP, // OPCODE_INTEGER_OFFSET + 3
INTEGER_POP, // OPCODE_INTEGER_OFFSET + 4
BOOL_DUP, // 10 - OPCODE_BOOL_OFFSET
BOOL_POP, // OPCODE_BOOL_OFFSET + 1 BOOL_POP, // OPCODE_BOOL_OFFSET + 1
BOOL_SWAP, // OPCODE_BOOL_OFFSET + 2 BOOL_SWAP, // OPCODE_BOOL_OFFSET + 2
BOOL_FLUSH, // OPCODE_BOOL_OFFSET + 3 BOOL_FLUSH, // OPCODE_BOOL_OFFSET + 3
@@ -127,47 +135,62 @@ contract Push3Interpreter {
// 3. HELPER READS // 3. HELPER READS
// ----------------------------------------------------- // -----------------------------------------------------
/**
* @dev Read `x` bytes from `code` at `start` as uint.
*/
function readUint(bytes calldata code, uint32 start, uint256 numBytes) internal pure returns (uint256 word) {
uint256 numBits = numBytes * 8;
if (start + numBytes > code.length) revert ReadUintOutOfRange(numBits);
assembly {
let buf := mload(0x40) // free memory
// copy exactly x bytes from code into buf
calldatacopy(buf, add(code.offset, start), numBytes)
word := mload(buf)
}
word >>= 256 - numBits;
}
/** /**
* @dev Read 4 bytes from `code` at `start` as uint32. * @dev Read 4 bytes from `code` at `start` as uint32.
*/ */
function readUint32(bytes calldata code, uint32 start) internal pure returns (uint32 val) { function readUint32(bytes calldata code, uint32 start) internal pure returns (uint32 val) {
require(start + 4 <= code.length, "readUint32 out of range"); val = uint32(readUint(code, start, 4));
uint256 word;
assembly {
let buf := mload(0x40) // free memory
// copy exactly 4 bytes from code into buf
calldatacopy(buf, add(code.offset, start), 4)
word := mload(buf)
}
val = uint32(word >> 224);
} }
/** /**
* @dev Read 2 bytes from `code` at `start` as uint16. * @dev Read 2 bytes from `code` at `start` as uint16.
*/ */
function readUint16(bytes calldata code, uint32 start) internal pure returns (uint16 val) { function readUint16(bytes calldata code, uint32 start) internal pure returns (uint16 val) {
require(start + 2 <= code.length, "readUint16 out of range"); val = uint16(readUint(code, start, 2));
uint256 word; }
assembly {
let buf := mload(0x40) /**
calldatacopy(buf, add(code.offset, start), 2) * @dev Read 1 byte from `code` at `start` as uint8.
word := mload(buf) */
val := and(word, 0xffff) function readUint8(bytes calldata code, uint32 start) internal pure returns (uint8 val) {
} val = uint8(readUint(code, start, 1));
// Not sure this is correct }
val = uint16(word >> 240);
/**
* @dev Read 1 byte from `code` at `start` as bool.
*/
function readBool(bytes calldata code, uint32 start) internal pure returns (bool val) {
val = readUint(code, start, 1) & 1 == 1;
} }
// ----------------------------------------------------- // -----------------------------------------------------
// 4. SUBLIST PARSING // 4. SUBLIST PARSING
// ----------------------------------------------------- // -----------------------------------------------------
/** /**
* Token format: * Token format is combination of ordered CodeTag and OpCode:
* 0x00 => NOOP * 0x00 => NOOP/NO_TAG
* 0x01 => INTEGER_PLUS * 0x01 => INSTRUCTION => read next 1 byte => OpCode
* 0x02 => INT_LITERAL => read next 4 bytes => int32 * 0x02 => INT_LITERAL => read next 4 bytes => int32
* 0x03 => SUBLIST => read next 2 bytes => subLen => parse that * 0x03 => BOOL_LITERAL => read next 1 byte => bool
* 0x04 => INTEGER_MINUS * 0x04 => SUBLIST => read next 2 bytes => subLen => parse that
* 0x05 => INTEGER_PLUS
* 0x06 => INTEGER_MINUS
* ... opcode list with type offsets
*/ */
function parseSublist(bytes calldata code, uint32 off, uint32 len) function parseSublist(bytes calldata code, uint32 off, uint32 len)
internal internal
@@ -193,9 +216,15 @@ contract Push3Interpreter {
count++; count++;
} }
else if (tokenType == 0x01) { else if (tokenType == 0x01) {
// INTEGER_PLUS // INSTRUCTION
temp[count] = makeInstruction(OpCode.INTEGER_PLUS); if (cur + 1 <= endPos && (cur + 1) <= code.length) {
count++; uint8 opcode = readUint8(code,cur);
if (opcode < OPCODE_INTEGER_OFFSET || opcode > OPCODE_LAST) opcode = uint8(0); // NOOP
temp[count] = makeInstruction(OpCode(opcode));
count++;
} else {
break;
}
} }
else if (tokenType == 0x02) { else if (tokenType == 0x02) {
// INT_LITERAL => 4 bytes // INT_LITERAL => 4 bytes
@@ -210,6 +239,17 @@ contract Push3Interpreter {
} }
} }
else if (tokenType == 0x03) { else if (tokenType == 0x03) {
// BOOL_LITERAL
if (cur + 1 <= endPos && (cur + 1) <= code.length) {
bool val = readBool(code, cur);
cur += 1;
temp[count] = makeBoolLiteral(val);
count++;
} else {
break;
}
}
else if (tokenType == 0x04) {
// SUBLIST => read 2 bytes => length // SUBLIST => read 2 bytes => length
if (cur + 2 <= endPos && (cur + 2) <= code.length) { if (cur + 2 <= endPos && (cur + 2) <= code.length) {
uint16 subLen = readUint16(code, cur); uint16 subLen = readUint16(code, cur);
@@ -227,22 +267,9 @@ contract Push3Interpreter {
break; break;
} }
} }
else if (tokenType == 0x04) { else if (tokenType <= OPCODE_LAST) {
// INTEGER_PLUS // OPCODE
temp[count] = makeInstruction(OpCode.INTEGER_MINUS); temp[count] = makeInstruction(OpCode(tokenType));
count++;
}
else if (tokenType == 0x05) {
// INTEGER_PLUS
temp[count] = makeInstruction(OpCode.INTEGER_MULT);
count++;
}
else if (tokenType == 0x06) {
temp[count] = makeInstruction(OpCode.INTEGER_DUP);
count++;
}
else if (tokenType == 0x07) {
temp[count] = makeInstruction(OpCode.INTEGER_POP);
count++; count++;
} }
else { else {
@@ -262,17 +289,19 @@ contract Push3Interpreter {
// 5. MAIN INTERPRETER // 5. MAIN INTERPRETER
// ----------------------------------------------------- // -----------------------------------------------------
function runInterpreter( function runInterpreter(
bytes calldata code, bytes calldata code, // non-empty - genetic agent (DNA)
uint256[] calldata initCodeStack, uint256[] calldata initCodeStack, // empty
uint256[] calldata initExecStack, uint256[] calldata initExecStack, // descriptors
int256[] calldata initIntStack int256[] calldata initIntStack, // 32bit word
bool[] calldata initBoolStack // bool array
) )
external external
pure pure
returns ( returns (
uint256[] memory finalCodeStack, uint256[] memory finalCodeStack,
uint256[] memory finalExecStack, uint256[] memory finalExecStack,
int256[] memory finalIntStack int256[] memory finalIntStack,
bool[] memory finalBoolStack
) )
{ {
// A) CODE STACK // A) CODE STACK
@@ -296,6 +325,13 @@ contract Push3Interpreter {
intStack[k] = initIntStack[k]; intStack[k] = initIntStack[k];
} }
// D) BOOL STACK
bool[] memory boolStack = new bool[](initBoolStack.length + 256);
uint256 boolTop = initBoolStack.length;
for (uint256 k = 0; k < initBoolStack.length; k++) {
boolStack[k] = initBoolStack[k];
}
// D) MAIN LOOP // D) MAIN LOOP
while (execTop > 0) { while (execTop > 0) {
uint256 topDesc = execStack[execTop - 1]; uint256 topDesc = execStack[execTop - 1];
@@ -305,50 +341,56 @@ contract Push3Interpreter {
if (tag == CodeTag.INSTRUCTION) { if (tag == CodeTag.INSTRUCTION) {
OpCode op = getOpCode(topDesc); OpCode op = getOpCode(topDesc);
if (op == OpCode.NOOP) { if (uint8(op) < OPCODE_INTEGER_OFFSET) {
// do nothing // NOOP, do nothing
} }
else if (op == OpCode.INTEGER_PLUS) { else if (uint8(op) < OPCODE_BOOL_OFFSET) {
// pop top 2 => sum // INTEGER OPCODES
if (intTop >= 2) { if (op == OpCode.INTEGER_PLUS) {
int256 a = intStack[intTop - 1]; // pop top 2 => sum
int256 b = intStack[intTop - 2]; if (intTop >= 2) {
intTop -= 2; int256 a = intStack[intTop - 1];
intStack[intTop] = b + a; int256 b = intStack[intTop - 2];
intTop++; intTop -= 2;
intStack[intTop] = b + a;
intTop++;
}
}
else if (op == OpCode.INTEGER_MINUS) {
// pop top 2 => minus
if (intTop >= 2) {
int256 a = intStack[intTop - 1];
int256 b = intStack[intTop - 2];
intTop -= 2;
intStack[intTop] = b - a;
intTop++;
}
}
else if (op == OpCode.INTEGER_MULT) {
// pop top 2 => minus
if (intTop >= 2) {
int256 a = intStack[intTop - 1];
int256 b = intStack[intTop - 2];
intTop -= 2;
intStack[intTop] = b * a;
intTop++;
}
}
else if (op == OpCode.INTEGER_DUP) {
if (intTop >= 1) {
int256 a = intStack[intTop - 1];
intStack[intTop] = a;
intTop++;
}
}
else if (op == OpCode.INTEGER_POP) {
if (intTop >= 1) {
intTop -= 1;
}
} }
} }
else if (op == OpCode.INTEGER_MINUS) { else if (uint8(op) <= OPCODE_LAST) {
// pop top 2 => minus // BOOL OPCODES
if (intTop >= 2) {
int256 a = intStack[intTop - 1];
int256 b = intStack[intTop - 2];
intTop -= 2;
intStack[intTop] = b - a;
intTop++;
}
}
else if (op == OpCode.INTEGER_MULT) {
// pop top 2 => minus
if (intTop >= 2) {
int256 a = intStack[intTop - 1];
int256 b = intStack[intTop - 2];
intTop -= 2;
intStack[intTop] = b * a;
intTop++;
}
}
else if (op == OpCode.INTEGER_DUP) {
if (intTop >= 1) {
int256 a = intStack[intTop - 1];
intStack[intTop] = a;
intTop++;
}
}
else if (op == OpCode.INTEGER_POP) {
if (intTop >= 1) {
intTop -= 1;
}
} }
} }
else if (tag == CodeTag.INT_LITERAL) { else if (tag == CodeTag.INT_LITERAL) {
@@ -356,6 +398,11 @@ contract Push3Interpreter {
intStack[intTop] = int256(val); intStack[intTop] = int256(val);
intTop++; intTop++;
} }
else if (tag == CodeTag.BOOL_LITERAL) {
bool val = extractBool(topDesc);
boolStack[boolTop] = val;
boolTop++;
}
else if (tag == CodeTag.SUBLIST) { else if (tag == CodeTag.SUBLIST) {
// parse sublist => push in reverse // parse sublist => push in reverse
uint32 off = getOffset(topDesc); uint32 off = getOffset(topDesc);
@@ -363,8 +410,8 @@ contract Push3Interpreter {
if (off + len <= code.length) { if (off + len <= code.length) {
uint256[] memory parsed = parseSublist(code, off, len); uint256[] memory parsed = parseSublist(code, off, len);
for (uint256 p = 0; p < parsed.length; p++) { for (uint256 p = 0; p < parsed.length; p++) { // index 0 1 2
execStack[execTop] = parsed[parsed.length - 1 - p]; execStack[execTop] = parsed[parsed.length - 1 - p]; // [0x01, 0x20, 0x0a]
execTop++; execTop++;
} }
} }
@@ -389,5 +436,10 @@ contract Push3Interpreter {
for (uint256 i = 0; i < intTop; i++) { for (uint256 i = 0; i < intTop; i++) {
finalIntStack[i] = intStack[i]; finalIntStack[i] = intStack[i];
} }
finalBoolStack = new bool[](boolTop);
for (uint256 i = 0; i < boolTop; i++) {
finalBoolStack[i] = boolStack[i];
}
} }
} }
+11 -11
View File
@@ -23,12 +23,12 @@ contract Push3IntAdapterTest is Test {
} }
/** /**
* @notice Test run1In1Out with a minimal code array. * @notice Test run1In1Out with a minimal code array.
* For example, we might do a program that just leaves its input unchanged * For example, we might do a program that just leaves its input unchanged
* (like a NOOP). * (like a NOOP).
*/ */
function test_run1In1Out_noop() public view { function test_run1In1Out_noop() public view {
bytes memory code = hex"03000100"; bytes memory code = hex"04000100";
int256 inputVal = 123; int256 inputVal = 123;
int256 result = adapter.run1In1Out(code, inputVal); int256 result = adapter.run1In1Out(code, inputVal);
@@ -41,21 +41,21 @@ contract Push3IntAdapterTest is Test {
* @notice Test run2In1Out. We'll push 5, 7, do an op that leaves 12. * @notice Test run2In1Out. We'll push 5, 7, do an op that leaves 12.
*/ */
function test_run2In1Out_plus() public view { function test_run2In1Out_plus() public view {
bytes memory code = hex"03000101"; bytes memory code = hex"04000105";
int256 in1 = 5; int256 in1 = 5;
int256 in2 = 7; int256 in2 = 7;
int256 result = adapter.run2In1Out(code, in1, in2); int256 result = adapter.run2In1Out(code, in1, in2);
assertEq(result, 12, "Expected 5 + 7 = 12"); assertEq(result, 12, "Expected 5 + 7 = 12");
} }
/** /**
* @notice Test run1In2Out. Push a constant to a stack with 1. * @notice Test run1In2Out. Push a constant to a stack with 1.
* For now, we do a placeholder code. * For now, we do a placeholder code.
*/ */
function test_run1In2Out() public view { function test_run1In2Out() public view {
bytes memory code = hex"0300050200000003"; bytes memory code = hex"0400050200000003";
int256 inVal = 42; int256 inVal = 42;
(int256 top, int256 secondTop) = adapter.run1In2Out(code, inVal); (int256 top, int256 secondTop) = adapter.run1In2Out(code, inVal);
@@ -65,12 +65,12 @@ contract Push3IntAdapterTest is Test {
} }
/** /**
* @notice Test run0InNOut. * @notice Test run0InNOut.
* We'll feed a code that pushes some constants, and see the final stack. * We'll feed a code that pushes some constants, and see the final stack.
*/ */
function test_run0InNOut() public view { function test_run0InNOut() public view {
bytes memory code = hex"03000A02000000030200000005"; bytes memory code = hex"04000A02000000030200000005";
int256[] memory stackResult = adapter.run0InNOut(code); int256[] memory stackResult = adapter.run0InNOut(code);
+66 -48
View File
@@ -23,30 +23,30 @@ contract Push3InterpreterTest is Test {
* 3) Calls INTEGER_PLUS * 3) Calls INTEGER_PLUS
* *
* We'll store everything in a single SUBLIST: * We'll store everything in a single SUBLIST:
* 0x03 => SUBLIST * 0x04 => SUBLIST
* 0x00 0x0B => subLen=11 * 0x00 0x0B => subLen=11
* Then the next 11 bytes are: * Then the next 11 bytes are:
* 0x02 + (00 00 00 0A) => INT_LITERAL(10) * 0x02 + (00 00 00 0A) => INT_LITERAL(10)
* 0x02 + (00 00 00 20) => INT_LITERAL(32) * 0x02 + (00 00 00 20) => INT_LITERAL(32)
* 0x01 => INTEGER_PLUS * 0x05 => INTEGER_PLUS
* *
* So total = 1 + 2 + (1+4 + 1+4 + 1) = 14 bytes * So total = 1 + 2 + (1+4 + 1+4 + 1) = 14 bytes
* => 0x03 00 0B 02 00 00 00 0A 02 00 00 00 20 01 * => 0x04 00 0B 02 00 00 00 0A 02 00 00 00 20 05
*/ */
function test_LiteralsAndPlus() public view { function test_LiteralsAndPlus() public view {
// The final code array (14 bytes): // The final code array (14 bytes):
// [0] = 0x03 // [0] = 0x04
// [1..2] = 0x000B // [1..2] = 0x000B
// [3] = 0x02 // [3] = 0x02
// [4..7] = 0x0000000A => 10 // [4..7] = 0x0000000A => 10
// [8] = 0x02 // [8] = 0x02
// [9..12] = 0x00000020 => 32 // [9..12] = 0x00000020 => 32
// [13] = 0x01 => plus // [13] = 0x05 => plus
bytes memory code = hex"03000B020000000A020000002001"; bytes memory code = hex"04000B020000000A020000002005";
// Or fully concatenated: // Or fully concatenated:
// 0x03 00 0B 02 00 00 00 0A 02 00 00 00 20 01 // 0x04 00 0B 02 00 00 00 0A 02 00 00 00 20 05
// We'll parse offset=0, length=14 // We'll parse offset=0, length=14
uint256 sublistDesc = interpreter.makeDescriptor( uint256 sublistDesc = interpreter.makeDescriptor(
@@ -61,13 +61,15 @@ contract Push3InterpreterTest is Test {
initExecStack[0] = sublistDesc; initExecStack[0] = sublistDesc;
int256[] memory initIntStack = new int256[](0); int256[] memory initIntStack = new int256[](0);
bool[] memory initBoolStack = new bool[](0);
// Run it // Run it
( (
, ,
, ,
int256[] memory finalIntStack int256[] memory finalIntStack
) = interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack); ,
) = interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack, initBoolStack);
// Should produce finalIntStack = [42] // Should produce finalIntStack = [42]
assertEq(finalIntStack.length, 1, "finalIntStack should have length 1"); assertEq(finalIntStack.length, 1, "finalIntStack should have length 1");
@@ -78,25 +80,25 @@ contract Push3InterpreterTest is Test {
* @notice Test pushing literal 10, literal 3, then INTEGER_MINUS => (10 - 3) = 7 * @notice Test pushing literal 10, literal 3, then INTEGER_MINUS => (10 - 3) = 7
* *
* The plan: * The plan:
* 0x03 => SUBLIST token * 0x04 => SUBLIST token
* 0x00 0x0B => subLen=11 * 0x00 0x0B => subLen=11
* *
* Then 11 bytes: * Then 11 bytes:
* 0x02 + (00 00 00 0A) => INT_LITERAL(10) * 0x02 + (00 00 00 0A) => INT_LITERAL(10)
* 0x02 + (00 00 00 03) => INT_LITERAL(3) * 0x02 + (00 00 00 03) => INT_LITERAL(3)
* 0x04 => INTEGER_MINUS (assuming 0x04 is assigned to minus) * 0x06 => INTEGER_MINUS (assuming 0x06 is assigned to minus)
*/ */
function test_Minus() public view { function test_Minus() public view {
// We'll produce 14 total bytes, same structure as the plus example // We'll produce 14 total bytes, same structure as the plus example
// Format: [0x03, 0x000B, 0x02(10), 0x03(3), 0x04 => minus] // Format: [0x04, 0x000B, 0x02(10), 0x03(3), 0x06 => minus]
bytes memory code = hex"03000B020000000A020000000304"; bytes memory code = hex"04000B020000000A020000000306";
// Breaking it down: // Breaking it down:
// 0x03 => SUBLIST // 0x04 => SUBLIST
// 0x00 0x0B => length=11 // 0x00 0x0B => length=11
// 0x02 0000000A => INT_LITERAL(10) // 0x02 0000000A => INT_LITERAL(10)
// 0x02 00000003 => INT_LITERAL(3) // 0x02 00000003 => INT_LITERAL(3)
// 0x04 => INTEGER_MINUS // 0x06 => INTEGER_MINUS
// We'll parse offset=0, length=14 // We'll parse offset=0, length=14
uint256 sublistDesc = interpreter.makeDescriptor( uint256 sublistDesc = interpreter.makeDescriptor(
@@ -111,13 +113,15 @@ contract Push3InterpreterTest is Test {
initExecStack[0] = sublistDesc; initExecStack[0] = sublistDesc;
int256[] memory initIntStack = new int256[](0); int256[] memory initIntStack = new int256[](0);
bool[] memory initBoolStack = new bool[](0);
// Run // Run
( (
, ,
, ,
int256[] memory finalIntStack int256[] memory finalIntStack
) = interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack); ,
) = interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack, initBoolStack);
// Check final result => should be [7] // Check final result => should be [7]
assertEq(finalIntStack.length, 1, "finalIntStack should have length 1"); assertEq(finalIntStack.length, 1, "finalIntStack should have length 1");
@@ -128,25 +132,25 @@ contract Push3InterpreterTest is Test {
* @notice Test pushing literal 10, literal 3, then INTEGER_MULT => (10 * 3) = 30 * @notice Test pushing literal 10, literal 3, then INTEGER_MULT => (10 * 3) = 30
* *
* The plan: * The plan:
* 0x03 => SUBLIST token * 0x04 => SUBLIST token
* 0x00 0x0B => subLen=11 * 0x00 0x0B => subLen=11
* *
* Then 11 bytes: * Then 11 bytes:
* 0x02 + (00 00 00 0A) => INT_LITERAL(10) * 0x02 + (00 00 00 0A) => INT_LITERAL(10)
* 0x02 + (00 00 00 03) => INT_LITERAL(3) * 0x02 + (00 00 00 03) => INT_LITERAL(3)
* 0x05 => INTEGER_MULT * 0x07 => INTEGER_MULT
*/ */
function test_Mult() public view { function test_Mult() public view {
// We'll produce 14 total bytes, same structure as the plus example // We'll produce 14 total bytes, same structure as the plus example
// Format: [0x03, 0x000B, 0x02(10), 0x03(3), 0x05 => mul] // Format: [0x04, 0x000B, 0x02(10), 0x02(3), 0x07 => mul]
bytes memory code = hex"03000B020000000A020000000305"; bytes memory code = hex"04000B020000000A020000000307";
// Breaking it down: // Breaking it down:
// 0x03 => SUBLIST // 0x04 => SUBLIST
// 0x00 0x0B => length=11 // 0x00 0x0B => length=11
// 0x02 0000000A => INT_LITERAL(10) // 0x02 0000000A => INT_LITERAL(10)
// 0x02 00000003 => INT_LITERAL(3) // 0x02 00000003 => INT_LITERAL(3)
// 0x05 => INTEGER_MUL // 0x07 => INTEGER_MUL
// We'll parse offset=0, length=14 // We'll parse offset=0, length=14
uint256 sublistDesc = interpreter.makeDescriptor( uint256 sublistDesc = interpreter.makeDescriptor(
@@ -161,13 +165,15 @@ contract Push3InterpreterTest is Test {
initExecStack[0] = sublistDesc; initExecStack[0] = sublistDesc;
int256[] memory initIntStack = new int256[](0); int256[] memory initIntStack = new int256[](0);
bool[] memory initBoolStack = new bool[](0);
// Run // Run
( (
, ,
, ,
int256[] memory finalIntStack int256[] memory finalIntStack
) = interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack); ,
) = interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack, initBoolStack);
// Check final result => should be [30] // Check final result => should be [30]
assertEq(finalIntStack.length, 1, "finalIntStack should have length 1"); assertEq(finalIntStack.length, 1, "finalIntStack should have length 1");
@@ -176,12 +182,12 @@ contract Push3InterpreterTest is Test {
function test_Dup() public view { function test_Dup() public view {
bytes memory code = hex"030006020000000A06"; bytes memory code = hex"040006020000000A08";
uint256 sublistDesc = interpreter.makeDescriptor( uint256 sublistDesc = interpreter.makeDescriptor(
Push3Interpreter.CodeTag.SUBLIST, Push3Interpreter.CodeTag.SUBLIST,
0, 0,
9, 9,
0 0
); );
@@ -190,13 +196,15 @@ contract Push3InterpreterTest is Test {
initExecStack[0] = sublistDesc; initExecStack[0] = sublistDesc;
int256[] memory initIntStack = new int256[](0); int256[] memory initIntStack = new int256[](0);
bool[] memory initBoolStack = new bool[](0);
// Run // Run
( (
, ,
, ,
int256[] memory finalIntStack int256[] memory finalIntStack
) = interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack); ,
) = interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack, initBoolStack);
assertEq(finalIntStack.length, 2, "finalIntStack should have length 1"); assertEq(finalIntStack.length, 2, "finalIntStack should have length 1");
assertEq(finalIntStack[0], finalIntStack[1], "The top 2 values on the stack should be equal."); assertEq(finalIntStack[0], finalIntStack[1], "The top 2 values on the stack should be equal.");
@@ -204,12 +212,12 @@ contract Push3InterpreterTest is Test {
function test_Pop() public view { function test_Pop() public view {
bytes memory code = hex"030006020000000A07"; bytes memory code = hex"040006020000000A09";
uint256 sublistDesc = interpreter.makeDescriptor( uint256 sublistDesc = interpreter.makeDescriptor(
Push3Interpreter.CodeTag.SUBLIST, Push3Interpreter.CodeTag.SUBLIST,
0, 0,
9, 9,
0 0
); );
@@ -218,33 +226,35 @@ contract Push3InterpreterTest is Test {
initExecStack[0] = sublistDesc; initExecStack[0] = sublistDesc;
int256[] memory initIntStack = new int256[](0); int256[] memory initIntStack = new int256[](0);
bool[] memory initBoolStack = new bool[](0);
// Run // Run
( (
, ,
, ,
int256[] memory finalIntStack int256[] memory finalIntStack
) = interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack); ,
) = interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack, initBoolStack);
assertEq(finalIntStack.length, 0, "finalIntStack should be empty"); assertEq(finalIntStack.length, 0, "finalIntStack should be empty");
} }
/** /**
* @notice Test with an unknown token (0xF0). * @notice Test with an unknown token (0xF0).
* We expect the parser to treat it as "unknown => NOOP" * We expect the parser to treat it as "unknown => NOOP"
* and produce a NOOP instruction descriptor. * and produce a NOOP instruction descriptor.
* We'll confirm finalIntStack remains empty (or unchanged). * We'll confirm finalIntStack remains empty (or unchanged).
*/ */
function test_UnknownToken() public view { function test_UnknownToken() public view {
// We'll create a 5-byte code: // We'll create a 5-byte code:
// 0x03 => SUBLIST // 0x04 => SUBLIST
// 0x00 0x01 => length=1 // 0x00 0x01 => length=1
// 0xF0 => unknown token // 0xF0 => unknown token
bytes memory code = hex"030001F0"; bytes memory code = hex"040001F0";
// We'll parse offset=0, length=4 // We'll parse offset=0, length=4
uint256 sublistDesc = interpreter.makeDescriptor( uint256 sublistDesc = interpreter.makeDescriptor(
Push3Interpreter.CodeTag.SUBLIST, Push3Interpreter.CodeTag.SUBLIST,
0, // offset 0, // offset
4, // length 4, // length
0 0
@@ -255,12 +265,14 @@ contract Push3InterpreterTest is Test {
uint256[] memory initExecStack = new uint256[](1); uint256[] memory initExecStack = new uint256[](1);
initExecStack[0] = sublistDesc; initExecStack[0] = sublistDesc;
int256[] memory initIntStack = new int256[](0); int256[] memory initIntStack = new int256[](0);
bool[] memory initBoolStack = new bool[](0);
( (
, ,
, ,
int256[] memory finalIntStack int256[] memory finalIntStack
) = interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack); ,
) = interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack, initBoolStack);
// finalIntStack should remain empty => no literal was pushed // finalIntStack should remain empty => no literal was pushed
assertEq(finalIntStack.length, 0, "Expected finalIntStack to remain empty with unknown token => NOOP"); assertEq(finalIntStack.length, 0, "Expected finalIntStack to remain empty with unknown token => NOOP");
@@ -268,18 +280,18 @@ contract Push3InterpreterTest is Test {
/** /**
* @notice Test a partial literal: we claim to have 4 bytes, but the code array ends early. * @notice Test a partial literal: we claim to have 4 bytes, but the code array ends early.
* This should trigger the `else { break; }` branch in parseSublist * This should trigger the `else { break; }` branch in parseSublist
* when trying to read 4 bytes for the INT_LITERAL. * when trying to read 4 bytes for the INT_LITERAL.
*/ */
function test_OutOfRangeLiteral() public view { function test_OutOfRangeLiteral() public view {
// 0x03 => SUBLIST // 0x04 => SUBLIST
// 0x00 0x04 => length=4 // 0x00 0x04 => length=4
// 0x02 => INT_LITERAL token // 0x02 => INT_LITERAL token
// Then we have only 1 byte left instead of 4 => insufficient // Then we have only 1 byte left instead of 4 => insufficient
// //
// total = 1 + 2 + 1 + 1 = 5 bytes // total = 1 + 2 + 1 + 1 = 5 bytes
// The parser tries to read 4 bytes after seeing 0x04, fails, hits break. // The parser tries to read 4 bytes after seeing 0x04, fails, hits break.
bytes memory code = hex"03000402FF"; bytes memory code = hex"04000402FF";
// parse offset=0, length=5 // parse offset=0, length=5
uint256 sublistDesc = interpreter.makeDescriptor( uint256 sublistDesc = interpreter.makeDescriptor(
@@ -293,12 +305,14 @@ contract Push3InterpreterTest is Test {
uint256[] memory initExecStack = new uint256[](1); uint256[] memory initExecStack = new uint256[](1);
initExecStack[0] = sublistDesc; initExecStack[0] = sublistDesc;
int256[] memory initIntStack = new int256[](0); int256[] memory initIntStack = new int256[](0);
bool[] memory initBoolStack = new bool[](0);
( (
, ,
, ,
int256[] memory finalIntStack int256[] memory finalIntStack
) = interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack); ,
) = interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack, initBoolStack);
// Because the parse breaks early, we expect finalIntStack is empty or unchanged // Because the parse breaks early, we expect finalIntStack is empty or unchanged
assertEq(finalIntStack.length, 0, "Expected parse to break on out-of-range literal => no ints pushed"); assertEq(finalIntStack.length, 0, "Expected parse to break on out-of-range literal => no ints pushed");
@@ -310,12 +324,12 @@ contract Push3InterpreterTest is Test {
* In the main loop, it sees intTop < 2 => it does nothing. * In the main loop, it sees intTop < 2 => it does nothing.
*/ */
function test_NotEnoughIntArgs() public view { function test_NotEnoughIntArgs() public view {
bytes memory code = hex"030006020000000305"; bytes memory code = hex"040006020000000307";
// Breaking it down: // Breaking it down:
// 0x03 => SUBLIST // 0x04 => SUBLIST
// 0x00 0x06 => length=6 // 0x00 0x06 => length=6
// 0x02 00000003 => INT_LITERAL(3) // 0x02 00000003 => INT_LITERAL(3)
// 0x05 => INTEGER_MUL // 0x07 => INTEGER_MUL
uint256 sublistDesc = interpreter.makeDescriptor( uint256 sublistDesc = interpreter.makeDescriptor(
Push3Interpreter.CodeTag.SUBLIST, Push3Interpreter.CodeTag.SUBLIST,
@@ -329,14 +343,16 @@ contract Push3InterpreterTest is Test {
uint256[] memory initExecStack = new uint256[](1); uint256[] memory initExecStack = new uint256[](1);
initExecStack[0] = sublistDesc; initExecStack[0] = sublistDesc;
int256[] memory initIntStack = new int256[](0); int256[] memory initIntStack = new int256[](0);
bool[] memory initBoolStack = new bool[](0);
( (
, ,
, ,
int256[] memory finalIntStack int256[] memory finalIntStack
) = interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack); ,
) = interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack, initBoolStack);
// We expect finalIntStack => [5], // We expect finalIntStack => [5],
// because the PLUS instruction sees only 1 int => does nothing => 5 remains // because the PLUS instruction sees only 1 int => does nothing => 5 remains
assertEq(finalIntStack.length, 1, "Should have 1 int left"); assertEq(finalIntStack.length, 1, "Should have 1 int left");
assertEq(finalIntStack[0], 3, "Expected stack top=3 after insufficient-args plus"); assertEq(finalIntStack[0], 3, "Expected stack top=3 after insufficient-args plus");
@@ -344,12 +360,12 @@ contract Push3InterpreterTest is Test {
/** /**
* @notice Test sublist length overflow: * @notice Test sublist length overflow:
* subLen claims bigger than the code array. Should trigger else { break; } * subLen claims bigger than the code array. Should trigger else { break; }
* in the sublist parsing for that sublist. * in the sublist parsing for that sublist.
*/ */
function test_SublistLengthOverflow() public view { function test_SublistLengthOverflow() public view {
bytes memory code = hex"050010FFFFFF"; bytes memory code = hex"050010FFFFFF";
uint256 sublistDesc = interpreter.makeDescriptor( uint256 sublistDesc = interpreter.makeDescriptor(
Push3Interpreter.CodeTag.SUBLIST, Push3Interpreter.CodeTag.SUBLIST,
@@ -363,12 +379,14 @@ contract Push3InterpreterTest is Test {
uint256[] memory initExecStack = new uint256[](1); uint256[] memory initExecStack = new uint256[](1);
initExecStack[0] = sublistDesc; initExecStack[0] = sublistDesc;
int256[] memory initIntStack = new int256[](0); int256[] memory initIntStack = new int256[](0);
bool[] memory initBoolStack = new bool[](0);
( (
, ,
, ,
int256[] memory finalIntStack int256[] memory finalIntStack
) = interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack); ,
) = interpreter.runInterpreter(code, initCodeStack, initExecStack, initIntStack, initBoolStack);
// Expect no items pushed => finalIntStack empty // Expect no items pushed => finalIntStack empty
assertEq(finalIntStack.length, 0, "Expected empty stack if sublist length is out of range => parse break"); assertEq(finalIntStack.length, 0, "Expected empty stack if sublist length is out of range => parse break");