Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement OP_WITHIN opcode #28

Closed
wants to merge 10 commits into from
Closed
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/compiler.cairo
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ pub impl CompilerTraitImpl of CompilerTrait {
opcodes.insert('OP_0', Opcode::OP_0);
opcodes.insert('OP_1', Opcode::OP_1);
opcodes.insert('OP_ADD', Opcode::OP_ADD);
opcodes.insert('OP_GREATERTHAN', Opcode::OP_GREATERTHAN);
opcodes.insert('OP_WITHIN', Opcode::OP_WITHIN);
Compiler { opcodes }
}

Expand Down
43 changes: 42 additions & 1 deletion src/opcodes/opcodes.cairo
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ pub mod Opcode {
pub const OP_0: u8 = 0;
pub const OP_1: u8 = 81;
pub const OP_ADD: u8 = 147;
pub const OP_GREATERTHAN: u8 = 160;
pub const OP_WITHIN: u8 = 165;

use shinigami::engine::Engine;
use shinigami::stack::ScriptStackTrait;
Expand Down Expand Up @@ -155,7 +157,25 @@ pub mod Opcode {
145 => not_implemented(ref engine),
146 => not_implemented(ref engine),
147 => opcode_add(ref engine),
_ => not_implemented(ref engine)
148 => not_implemented(ref engine),
149 => not_implemented(ref engine),
150 => not_implemented(ref engine),
151 => not_implemented(ref engine),
152 => not_implemented(ref engine),
153 => not_implemented(ref engine),
154 => not_implemented(ref engine),
155 => not_implemented(ref engine),
156 => not_implemented(ref engine),
157 => not_implemented(ref engine),
158 => not_implemented(ref engine),
159 => not_implemented(ref engine),
160 => opcode_greaterthan(ref engine),
161 => not_implemented(ref engine),
162 => not_implemented(ref engine),
163 => not_implemented(ref engine),
164 => not_implemented(ref engine),
165 => opcode_within(ref engine),
_ => not_implemented(ref engine),
}
}

Expand All @@ -174,6 +194,27 @@ pub mod Opcode {
engine.dstack.push_int(a + b);
}

fn opcode_greaterthan(ref engine: Engine) {
let a = engine.dstack.pop_int();
let b = engine.dstack.pop_int();
engine.dstack.push_int(if a > b {
0
} else {
1
});
}

fn opcode_within(ref engine: Engine) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please refer to this implementation to see the proper ordering of variables on the stack : https://github.com/btcsuite/btcd/blob/b161cd6a199b4e35acec66afc5aad221f05fe1e3/txscript/opcode.go#L1844

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Working on this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, opcode_within is number 165 in the order, please could you tell me what you mean? I have pushed an update where I renamed and reordered the variables though

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we have to make sure the values poped off the stack are in the same order as the bitcoin spec, so here max_value should be popped first, then min_value, then selected_value

Copy link
Contributor Author

@supreme2580 supreme2580 Jul 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

Hi @b-j-roberts I have rearranged the variables based on the order max before min before value

let a = engine.dstack.pop_int();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be prefered to make the variable naming here more explicit, like min_value, max_value, ...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will rename the variables now

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi I just pushed an update to rename the variables to be more explicit

let b = engine.dstack.pop_int();
let c = engine.dstack.pop_int();
engine.dstack.push_int(if a >= b && a < c {
0
} else {
1
});
}

fn not_implemented(ref engine: Engine) {
panic!("Opcode not implemented");
}
Expand Down
37 changes: 37 additions & 0 deletions src/opcodes/tests/test_opcodes.cairo
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,40 @@ fn test_op_add() {
let expected_stack = array!["\0\0\0\0\0\0\0\x02"];
assert_eq!(dstack, expected_stack.span(), "Stack is not equal to expected");
}

#[test]
fn test_op_greaterthan() {
let program = "OP_1 OP_0 OP_GREATERTHAN";
let mut compiler = CompilerTraitImpl::new();
let bytecode = compiler.compile(program);
let mut engine = EngineTraitImpl::new(bytecode);
let _ = engine.step();
let _ = engine.step();
let res = engine.step();
assert!(res, "Execution of run failed");

let dstack = engine.get_dstack();
assert_eq!(dstack.len(), 1, "Stack length is not 1");

let expected_stack = array!["\0\0\0\0\0\0\0\x01"];
assert_eq!(dstack, expected_stack.span(), "Stack is not equal to expected");
}

#[test]
fn test_op_within() {
let program = "OP_1 OP_0 OP_1 OP_WITHIN";
let mut compiler = CompilerTraitImpl::new();
let bytecode = compiler.compile(program);
let mut engine = EngineTraitImpl::new(bytecode);
let _ = engine.step();
let _ = engine.step();
let _ = engine.step();
let res = engine.step();
assert!(res, "Execution of run failed");

let dstack = engine.get_dstack();
assert_eq!(dstack.len(), 1, "Stack length is not 1");

let expected_stack = array!["\0\0\0\0\0\0\0\x01"];
assert_eq!(dstack, expected_stack.span(), "Stack is not equal to expected");
}