Add bitshift, arithmetic shift, and invert operators

Author: rkalis

packages/cashc/src/Errors.ts

@@ -273,6 +273,15 @@ export class IndexOutOfBoundsError extends CashScriptError {
   }
 }
 
+export class BitshiftBitcountNegativeError extends CashScriptError {
+  constructor(
+    node: BinaryOpNode,
+    bitcount: number,
+  ) {
+    super(node, `Bitshift bitcount cannot be negative: ${bitcount}`);
+  }
+}
+
 export class VersionError extends Error {
   constructor(
     actual: string,

packages/cashc/src/ast/Operator.ts

@@ -10,6 +10,7 @@ export enum NullaryOperator {
 export enum UnaryOperator {
   NOT = '!',
   NEGATE = '-',
+  INVERT = '~',
   SIZE = '.length',
   REVERSE = '.reverse()',
   INPUT_VALUE = 'tx.inputs[i].value',
@@ -34,15 +35,17 @@ export enum BinaryOperator {
   MOD = '%',
   PLUS = '+',
   MINUS = '-',
+  SHIFT_LEFT = '<<',
+  SHIFT_RIGHT = '>>',
   LT = '<',
+  BIT_AND = '&',
+  BIT_XOR = '^',
+  BIT_OR = '|',
   LE = '<=',
   GT = '>',
   GE = '>=',
   EQ = '==',
   NE = '!=',
-  BIT_AND = '&',
-  BIT_XOR = '^',
-  BIT_OR = '|',
   AND = '&&',
   OR = '||',
   SPLIT = '.split',

packages/cashc/src/generation/GenerateTargetTraversal.ts

@@ -7,7 +7,6 @@ import {
   Op,
   OpOrData,
   PrimitiveType,
-  resultingType,
   Script,
   scriptToAsm,
   generateSourceMap,
@@ -60,6 +59,7 @@ import {
   compileTimeOp,
   compileUnaryOp,
 } from './utils.js';
+import { resultingTypeForBinaryOp } from '../utils.js';
 
 export default class GenerateTargetTraversalWithLocation extends AstTraversal {
   private locationData: FullLocationData = []; // detailed location data needed for sourcemap creation
@@ -582,7 +582,7 @@ export default class GenerateTargetTraversalWithLocation extends AstTraversal {
   visitBinaryOp(node: BinaryOpNode): Node {
     node.left = this.visit(node.left);
     node.right = this.visit(node.right);
-    const isNumeric = resultingType(node.left.type, node.right.type) === PrimitiveType.INT;
+    const isNumeric = resultingTypeForBinaryOp(node.operator, node.left.type!, node.right.type!) === PrimitiveType.INT;
     this.emit(compileBinaryOp(node.operator, isNumeric), { location: node.location, positionHint: PositionHint.END });
     this.popFromStack(2);
     this.pushToStack('(value)');

packages/cashc/src/generation/utils.ts

@@ -56,6 +56,11 @@ export function compileBinaryOp(op: BinaryOperator, numeric: boolean = false): S
     [BinaryOperator.MOD]: [Op.OP_MOD],
     [BinaryOperator.PLUS]: [Op.OP_CAT],
     [BinaryOperator.MINUS]: [Op.OP_SUB],
+    [BinaryOperator.SHIFT_LEFT]: [Op.OP_LSHIFTBIN],
+    [BinaryOperator.SHIFT_RIGHT]: [Op.OP_RSHIFTBIN],
+    [BinaryOperator.BIT_AND]: [Op.OP_AND],
+    [BinaryOperator.BIT_OR]: [Op.OP_OR],
+    [BinaryOperator.BIT_XOR]: [Op.OP_XOR],
     [BinaryOperator.LT]: [Op.OP_LESSTHAN],
     [BinaryOperator.LE]: [Op.OP_LESSTHANOREQUAL],
     [BinaryOperator.GT]: [Op.OP_GREATERTHAN],
@@ -64,16 +69,15 @@ export function compileBinaryOp(op: BinaryOperator, numeric: boolean = false): S
     [BinaryOperator.NE]: [Op.OP_EQUAL, Op.OP_NOT],
     [BinaryOperator.AND]: [Op.OP_BOOLAND],
     [BinaryOperator.OR]: [Op.OP_BOOLOR],
-    [BinaryOperator.BIT_AND]: [Op.OP_AND],
-    [BinaryOperator.BIT_OR]: [Op.OP_OR],
-    [BinaryOperator.BIT_XOR]: [Op.OP_XOR],
     [BinaryOperator.SPLIT]: [Op.OP_SPLIT],
   };
 
   if (numeric) {
     mapping[BinaryOperator.PLUS] = [Op.OP_ADD];
     mapping[BinaryOperator.EQ] = [Op.OP_NUMEQUAL];
     mapping[BinaryOperator.NE] = [Op.OP_NUMNOTEQUAL];
+    mapping[BinaryOperator.SHIFT_LEFT] = [Op.OP_LSHIFTNUM];
+    mapping[BinaryOperator.SHIFT_RIGHT] = [Op.OP_RSHIFTNUM];
   }
 
   return mapping[op];
@@ -83,6 +87,7 @@ export function compileUnaryOp(op: UnaryOperator): Op[] {
   const mapping = {
     [UnaryOperator.NOT]: [Op.OP_NOT],
     [UnaryOperator.NEGATE]: [Op.OP_NEGATE],
+    [UnaryOperator.INVERT]: [Op.OP_INVERT],
     [UnaryOperator.SIZE]: [Op.OP_SIZE, Op.OP_NIP],
     [UnaryOperator.REVERSE]: [Op.OP_REVERSEBYTES],
     [UnaryOperator.INPUT_VALUE]: [Op.OP_UTXOVALUE],

packages/cashc/src/grammar/CashScript.g4

@@ -124,10 +124,10 @@ expression
     | expression op=('.reverse()' | '.length') # UnaryOp
     | left=expression op='.split' '(' right=expression ')' # BinaryOp
     | element=expression '.slice' '(' start=expression ',' end=expression ')' # Slice
-    | op=('!' | '-') expression # UnaryOp
+    | op=('!' | '-' | '~') expression # UnaryOp
     | left=expression op=('*' | '/' | '%') right=expression # BinaryOp
     | left=expression op=('+' | '-') right=expression # BinaryOp
-    // | expression ('>>' | '<<') expression --- OP_LSHIFT & RSHIFT are disabled in BCH Script
+    | left=expression op=('>>' | '<<') right=expression # BinaryOp
     | left=expression op=('<' | '<=' | '>' | '>=') right=expression # BinaryOp
     | left=expression op=('==' | '!=') right=expression # BinaryOp
     | left=expression op='&' right=expression # BinaryOp

packages/cashc/src/grammar/CashScript.interp

@@ -58,23 +58,25 @@ T__56=57
 T__57=58
 T__58=59
 T__59=60
-VersionLiteral=61
-BooleanLiteral=62
-NumberUnit=63
-NumberLiteral=64
-NumberPart=65
-ExponentPart=66
-Bytes=67
-Bound=68
-StringLiteral=69
-DateLiteral=70
-HexLiteral=71
-TxVar=72
-NullaryOp=73
-Identifier=74
-WHITESPACE=75
-COMMENT=76
-LINE_COMMENT=77
+T__60=61
+T__61=62
+VersionLiteral=63
+BooleanLiteral=64
+NumberUnit=65
+NumberLiteral=66
+NumberPart=67
+ExponentPart=68
+Bytes=69
+Bound=70
+StringLiteral=71
+DateLiteral=72
+HexLiteral=73
+TxVar=74
+NullaryOp=75
+Identifier=76
+WHITESPACE=77
+COMMENT=78
+LINE_COMMENT=79
 'pragma'=1
 ';'=2
 'cashscript'=3
@@ -122,16 +124,18 @@ LINE_COMMENT=77
 '/'=45
 '%'=46
 '+'=47
-'=='=48
-'!='=49
-'&'=50
-'|'=51
-'&&'=52
-'||'=53
-'constant'=54
-'int'=55
-'bool'=56
-'string'=57
-'pubkey'=58
-'sig'=59
-'datasig'=60
+'>>'=48
+'<<'=49
+'=='=50
+'!='=51
+'&'=52
+'|'=53
+'&&'=54
+'||'=55
+'constant'=56
+'int'=57
+'bool'=58
+'string'=59
+'pubkey'=60
+'sig'=61
+'datasig'=62

packages/cashc/src/grammar/CashScript.tokens

@@ -58,23 +58,25 @@ T__56=57
 T__57=58
 T__58=59
 T__59=60
-VersionLiteral=61
-BooleanLiteral=62
-NumberUnit=63
-NumberLiteral=64
-NumberPart=65
-ExponentPart=66
-Bytes=67
-Bound=68
-StringLiteral=69
-DateLiteral=70
-HexLiteral=71
-TxVar=72
-NullaryOp=73
-Identifier=74
-WHITESPACE=75
-COMMENT=76
-LINE_COMMENT=77
+T__60=61
+T__61=62
+VersionLiteral=63
+BooleanLiteral=64
+NumberUnit=65
+NumberLiteral=66
+NumberPart=67
+ExponentPart=68
+Bytes=69
+Bound=70
+StringLiteral=71
+DateLiteral=72
+HexLiteral=73
+TxVar=74
+NullaryOp=75
+Identifier=76
+WHITESPACE=77
+COMMENT=78
+LINE_COMMENT=79
 'pragma'=1
 ';'=2
 'cashscript'=3
@@ -122,16 +124,18 @@ LINE_COMMENT=77
 '/'=45
 '%'=46
 '+'=47
-'=='=48
-'!='=49
-'&'=50
-'|'=51
-'&&'=52
-'||'=53
-'constant'=54
-'int'=55
-'bool'=56
-'string'=57
-'pubkey'=58
-'sig'=59
-'datasig'=60
+'>>'=48
+'<<'=49
+'=='=50
+'!='=51
+'&'=52
+'|'=53
+'&&'=54
+'||'=55
+'constant'=56
+'int'=57
+'bool'=58
+'string'=59
+'pubkey'=60
+'sig'=61
+'datasig'=62