Go to file
2025-10-06 09:11:22 -07:00
.cursor/rules it's alive 2025-10-05 13:43:13 -07:00
bin cli 2025-10-05 21:17:54 -07:00
examples lib exports 2025-10-06 09:11:22 -07:00
src lib exports 2025-10-06 09:11:22 -07:00
tests no kwargs 2025-10-05 22:34:07 -07:00
.gitignore it's alive 2025-10-05 13:43:13 -07:00
bun.lock it's alive 2025-10-05 13:43:13 -07:00
CLAUDE.md claude 2025-10-05 22:05:45 -07:00
GUIDE.md bit more 2025-10-05 22:40:22 -07:00
package.json it's alive 2025-10-05 13:43:13 -07:00
README.md no kwargs 2025-10-05 22:34:07 -07:00
SPEC.md test examples 2025-10-05 22:24:43 -07:00
tsconfig.json lib exports 2025-10-06 09:11:22 -07:00

🪸 ReefVM

It's where Shrimp live.

Quickstart

bun install
bun test

Features

  • Stack operations (PUSH, POP, DUP)
  • Arithmetic operations (ADD, SUB, MUL, DIV, MOD)
  • Comparison operations (EQ, NEQ, LT, GT, LTE, GTE)
  • Logical operations (NOT, AND/OR patterns with short-circuiting)
  • Variable operations (LOAD, STORE)
  • Control flow with relative jumps (JUMP, JUMP_IF_FALSE, JUMP_IF_TRUE, BREAK, CONTINUE)
  • Array operations (MAKE_ARRAY, ARRAY_GET, ARRAY_SET, ARRAY_PUSH, ARRAY_LEN)
  • Dictionary operations (MAKE_DICT, DICT_GET, DICT_SET, DICT_HAS)
  • Function operations (MAKE_FUNCTION, CALL, TAIL_CALL, RETURN) with parameter binding
  • Variadic functions with positional rest parameters (...rest)
  • Named arguments (named) that collect unmatched named args into a dict (@named)
  • Mixed positional and named arguments with proper priority binding
  • Tail call optimization with unbounded recursion (10,000+ iterations without stack overflow)
  • Exception handling (PUSH_TRY, PUSH_FINALLY, POP_TRY, THROW) with nested try/finally blocks and call stack unwinding
  • Native function interop (CALL_NATIVE) with sync and async functions

Design Decisions

  • Relative jumps: All JUMP instructions use PC-relative offsets instead of absolute addresses, making bytecode position-independent
  • Truthiness: Only null and false are falsy (unlike JavaScript where 0, "", etc. are also falsy)
  • Short-circuiting via compiler: No AND/OR opcodes—compilers use JUMP patterns for proper short-circuit evaluation
  • Variadic parameters: Functions can collect remaining positional arguments into an array using ...rest syntax
  • Named parameters: Functions can collect unmatched named arguments into a dict using @named syntax
  • Argument binding priority: Named args bind to regular params first, with unmatched ones going to @named