cashc 0.13.0-next.8 → 0.13.0

package/README.md

@@ -36,7 +36,7 @@ Options:
   -c, --opcount                                Display the number of opcodes in the compiled bytecode.
   -s, --size                                   Display the size in bytes of the compiled bytecode.
   -S, --skip-enforce-function-parameter-types  Do not enforce function parameter types.
-  -f, --format <format>                        Specify the format of the output. (choices: "json", "ts", default:
-                                               "json")
+  -L, --skip-enforce-locktime-guard            Do not inject a tx.time guard when tx.locktime is used.
+  -f, --format <format>                        Specify the format of the output. (choices: "json", "ts", default: "json")
   -?, --help                                   Display help
 ```

package/dist/artifact/Artifact.js

@@ -18,6 +18,7 @@ export function generateArtifact(ast, script, source, debug, compilerOptions, fi
         abi,
         bytecode,
         source,
+        fingerprint,
         debug,
         compiler: {
             name: 'cashc',
@@ -25,7 +26,6 @@ export function generateArtifact(ast, script, source, debug, compilerOptions, fi
             options: compilerOptions,
         },
         updatedAt: new Date().toISOString(),
-        fingerprint,
     };
 }
 // strip verbose debug info from artifact for production use

package/dist/ast/AST.d.ts

@@ -86,6 +86,7 @@ export declare class TimeOpNode extends NonControlStatementNode {
     timeOp: TimeOp;
     expression: ExpressionNode;
     message?: string | undefined;
+    isGuard: boolean;
     constructor(timeOp: TimeOp, expression: ExpressionNode, message?: string | undefined);
     accept<T>(visitor: AstVisitor<T>): T;
 }

package/dist/ast/AST.js

@@ -91,6 +91,8 @@ export class TimeOpNode extends NonControlStatementNode {
         this.timeOp = timeOp;
         this.expression = expression;
         this.message = message;
+        // True for the compiler-injected `tx.locktime` guard (no user source); see InjectLocktimeGuardTraversal.
+        this.isGuard = false;
     }
     accept(visitor) {
         return visitor.visitTimeOp(this);

package/dist/ast/AstBuilder.d.ts

@@ -1,6 +1,6 @@
 import { ParseTree, ParseTreeVisitor } from 'antlr4';
 import { Node, SourceFileNode, ContractNode, ParameterNode, VariableDefinitionNode, FunctionDefinitionNode, AssignNode, IdentifierNode, BranchNode, CastNode, FunctionCallNode, UnaryOpNode, BinaryOpNode, BoolLiteralNode, IntLiteralNode, HexLiteralNode, StringLiteralNode, ExpressionNode, StatementNode, LiteralNode, BlockNode, TimeOpNode, ArrayNode, TupleIndexOpNode, RequireNode, InstantiationNode, TupleAssignmentNode, NullaryOpNode, ConsoleStatementNode, ConsoleParameterNode, SliceNode, DoWhileNode, WhileNode, ForNode } from './AST.js';
-import type { ContractDefinitionContext, FunctionDefinitionContext, VariableDefinitionContext, TupleAssignmentContext, ParameterContext, AssignStatementContext, IfStatementContext, FunctionCallContext, CastContext, LiteralContext, SourceFileContext, BlockContext, TimeOpStatementContext, ArrayContext, ParenthesisedContext, FunctionCallExpressionContext, UnaryOpContext, BinaryOpContext, IdentifierContext, LiteralExpressionContext, TupleIndexOpContext, RequireStatementContext, PragmaDirectiveContext, InstantiationContext, NullaryOpContext, UnaryIntrospectionOpContext, ConsoleStatementContext, ConsoleParameterContext, StatementContext, NonControlStatementContext, ControlStatementContext, RequireMessageContext, SliceContext, DoWhileStatementContext, LoopStatementContext, WhileStatementContext, ForStatementContext, ForInitContext } from '../grammar/CashScriptParser.js';
+import type { ContractDefinitionContext, FunctionDefinitionContext, VariableDefinitionContext, TupleAssignmentContext, ParameterContext, AssignStatementContext, IfStatementContext, FunctionCallContext, CastContext, LiteralContext, SourceFileContext, BlockContext, TimeOpStatementContext, ArrayContext, ParenthesisedContext, FunctionCallExpressionContext, UnaryOpContext, BinaryOpContext, IdentifierContext, LiteralExpressionContext, TupleIndexOpContext, RequireStatementContext, PragmaDirectiveContext, InstantiationContext, NullaryOpContext, UnaryIntrospectionOpContext, ConsoleStatementContext, ConsoleParameterContext, StatementContext, NonControlStatementContext, ControlStatementContext, RequireMessageContext, SliceContext, DoWhileStatementContext, LoopStatementContext, WhileStatementContext, ForStatementContext, ForInitContext, FunctionBodyContext } from '../grammar/CashScriptParser.js';
 import CashScriptVisitor from '../grammar/CashScriptVisitor.js';
 export default class AstBuilder extends ParseTreeVisitor<Node> implements CashScriptVisitor<Node> {
     private tree;
@@ -11,6 +11,7 @@ export default class AstBuilder extends ParseTreeVisitor<Node> implements CashSc
     processPragma(ctx: PragmaDirectiveContext): void;
     visitContractDefinition(ctx: ContractDefinitionContext): ContractNode;
     visitFunctionDefinition(ctx: FunctionDefinitionContext): FunctionDefinitionNode;
+    visitFunctionBody(ctx: FunctionBodyContext): BlockNode;
     visitParameter(ctx: ParameterContext): ParameterNode;
     visitStatement(ctx: StatementContext): StatementNode;
     visitNonControlStatement(ctx: NonControlStatementContext): StatementNode;

package/dist/ast/AstBuilder.js

@@ -54,12 +54,16 @@ export default class AstBuilder extends ParseTreeVisitor {
     visitFunctionDefinition(ctx) {
         const name = ctx.Identifier().getText();
         const parameters = ctx.parameterList().parameter_list().map((p) => this.visit(p));
+        const body = this.visit(ctx.functionBody());
+        const functionDefinition = new FunctionDefinitionNode(name, parameters, body);
+        functionDefinition.location = Location.fromCtx(ctx);
+        return functionDefinition;
+    }
+    visitFunctionBody(ctx) {
         const statements = ctx.statement_list().map((s) => this.visit(s));
         const block = new BlockNode(statements);
         block.location = Location.fromCtx(ctx);
-        const functionDefinition = new FunctionDefinitionNode(name, parameters, block);
-        functionDefinition.location = Location.fromCtx(ctx);
-        return functionDefinition;
+        return block;
     }
     visitParameter(ctx) {
         const type = parseType(ctx.typeName().getText());

package/dist/generation/GenerateTargetTraversal.js

@@ -163,25 +163,31 @@ export default class GenerateTargetTraversalWithLocation extends AstTraversal {
     enforceFunctionParameterType(node) {
         if (!this.shouldEnforceFunctionParameterType(node))
             return;
+        const tagStartIndex = this.output.length;
         const stackIndex = this.getStackIndex(node.name);
+        // We take the parameter from the stack and roll it to the top
         this.emit(encodeInt(BigInt(stackIndex)), { location: node.location, positionHint: PositionHint.START });
+        this.emit(Op.OP_ROLL, { location: node.location, positionHint: PositionHint.START });
+        // We remove the original stack value and push the new value to the top of the stack
+        this.removeFromStack(stackIndex);
+        this.pushToStack(node.name);
+        // For booleans, we force-convert it to a boolean using OP_0NOTEQUAL
         if (node.type === PrimitiveType.BOOL) {
-            // For booleans, we take it from the stack and force-convert it to a boolean using OP_0NOTEQUAL
-            this.emit(Op.OP_ROLL, { location: node.location, positionHint: PositionHint.START });
             this.emit(Op.OP_0NOTEQUAL, { location: node.location, positionHint: PositionHint.START });
-            // We remove the original stack value and push the new boolean value to the top of the stack
-            this.removeFromStack(stackIndex);
-            this.pushToStack(node.name);
         }
+        // For bounded bytes, we *check* that it is the correct size using OP_SIZE and OP_EQUALVERIFY
         if (node.type instanceof BytesType && node.type.bound !== undefined) {
-            // For bounded bytes, we copy it from the stack and *check* that it is the correct size
-            this.emit(Op.OP_PICK, { location: node.location, positionHint: PositionHint.START });
             this.emit(Op.OP_SIZE, { location: node.location, positionHint: PositionHint.START });
             this.emit(encodeInt(BigInt(node.type.bound)), { location: node.location, positionHint: PositionHint.START });
             this.emit(Op.OP_EQUALVERIFY, { location: node.location, positionHint: PositionHint.START });
-            this.emit(Op.OP_DROP, { location: node.location, positionHint: PositionHint.START });
-            // We don't perform any stack operations, because these ops leave the original stack unchanged
         }
+        // These checks are compiler-injected (no user source); tag them so the debug reconstruction
+        // gives them their own annotation line positioned by bytecode order.
+        this.sourceTags.push({
+            startIndex: tagStartIndex,
+            endIndex: this.output.length - 1,
+            kind: SourceTagKind.PARAMETER_VALIDATION,
+        });
     }
     shouldEnforceFunctionParameterType(node) {
         if (node.type === PrimitiveType.BOOL)
@@ -237,7 +243,7 @@ export default class GenerateTargetTraversalWithLocation extends AstTraversal {
         }
     }
     visitTimeOp(node) {
-        // const countBefore = this.output.length;
+        const tagStartIndex = this.output.length;
         node.expression = this.visit(node.expression);
         this.emit(compileTimeOp(node.timeOp), { location: node.location, positionHint: PositionHint.END });
         this.requires.push({
@@ -247,6 +253,15 @@ export default class GenerateTargetTraversalWithLocation extends AstTraversal {
             line: node.location.start.line,
             message: node.message,
         });
+        // The auto-injected tx.locktime guard is emitted after the parameter prologue but has no
+        // user source; tag it so the debug reconstruction positions it by bytecode order.
+        if (node.isGuard) {
+            this.sourceTags.push({
+                startIndex: tagStartIndex,
+                endIndex: this.output.length - 1,
+                kind: SourceTagKind.LOCKTIME_GUARD,
+            });
+        }
         this.popFromStack();
         return node;
     }

package/dist/grammar/CashScriptParser.d.ts

@@ -91,35 +91,36 @@ export default class CashScriptParser extends Parser {
     static readonly RULE_versionOperator = 5;
     static readonly RULE_contractDefinition = 6;
     static readonly RULE_functionDefinition = 7;
-    static readonly RULE_parameterList = 8;
-    static readonly RULE_parameter = 9;
-    static readonly RULE_block = 10;
-    static readonly RULE_statement = 11;
-    static readonly RULE_nonControlStatement = 12;
-    static readonly RULE_controlStatement = 13;
-    static readonly RULE_variableDefinition = 14;
-    static readonly RULE_tupleAssignment = 15;
-    static readonly RULE_assignStatement = 16;
-    static readonly RULE_timeOpStatement = 17;
-    static readonly RULE_requireStatement = 18;
-    static readonly RULE_consoleStatement = 19;
-    static readonly RULE_ifStatement = 20;
-    static readonly RULE_loopStatement = 21;
-    static readonly RULE_doWhileStatement = 22;
-    static readonly RULE_whileStatement = 23;
-    static readonly RULE_forStatement = 24;
-    static readonly RULE_forInit = 25;
-    static readonly RULE_requireMessage = 26;
-    static readonly RULE_consoleParameter = 27;
-    static readonly RULE_consoleParameterList = 28;
-    static readonly RULE_functionCall = 29;
-    static readonly RULE_expressionList = 30;
-    static readonly RULE_expression = 31;
-    static readonly RULE_modifier = 32;
-    static readonly RULE_literal = 33;
-    static readonly RULE_numberLiteral = 34;
-    static readonly RULE_typeName = 35;
-    static readonly RULE_typeCast = 36;
+    static readonly RULE_functionBody = 8;
+    static readonly RULE_parameterList = 9;
+    static readonly RULE_parameter = 10;
+    static readonly RULE_block = 11;
+    static readonly RULE_statement = 12;
+    static readonly RULE_nonControlStatement = 13;
+    static readonly RULE_controlStatement = 14;
+    static readonly RULE_variableDefinition = 15;
+    static readonly RULE_tupleAssignment = 16;
+    static readonly RULE_assignStatement = 17;
+    static readonly RULE_timeOpStatement = 18;
+    static readonly RULE_requireStatement = 19;
+    static readonly RULE_consoleStatement = 20;
+    static readonly RULE_ifStatement = 21;
+    static readonly RULE_loopStatement = 22;
+    static readonly RULE_doWhileStatement = 23;
+    static readonly RULE_whileStatement = 24;
+    static readonly RULE_forStatement = 25;
+    static readonly RULE_forInit = 26;
+    static readonly RULE_requireMessage = 27;
+    static readonly RULE_consoleParameter = 28;
+    static readonly RULE_consoleParameterList = 29;
+    static readonly RULE_functionCall = 30;
+    static readonly RULE_expressionList = 31;
+    static readonly RULE_expression = 32;
+    static readonly RULE_modifier = 33;
+    static readonly RULE_literal = 34;
+    static readonly RULE_numberLiteral = 35;
+    static readonly RULE_typeName = 36;
+    static readonly RULE_typeCast = 37;
     static readonly literalNames: (string | null)[];
     static readonly symbolicNames: (string | null)[];
     static readonly ruleNames: string[];
@@ -138,6 +139,7 @@ export default class CashScriptParser extends Parser {
     versionOperator(): VersionOperatorContext;
     contractDefinition(): ContractDefinitionContext;
     functionDefinition(): FunctionDefinitionContext;
+    functionBody(): FunctionBodyContext;
     parameterList(): ParameterListContext;
     parameter(): ParameterContext;
     block(): BlockContext;
@@ -228,6 +230,12 @@ export declare class FunctionDefinitionContext extends ParserRuleContext {
     constructor(parser?: CashScriptParser, parent?: ParserRuleContext, invokingState?: number);
     Identifier(): TerminalNode;
     parameterList(): ParameterListContext;
+    functionBody(): FunctionBodyContext;
+    get ruleIndex(): number;
+    accept<Result>(visitor: CashScriptVisitor<Result>): Result;
+}
+export declare class FunctionBodyContext extends ParserRuleContext {
+    constructor(parser?: CashScriptParser, parent?: ParserRuleContext, invokingState?: number);
     statement_list(): StatementContext[];
     statement(i: number): StatementContext;
     get ruleIndex(): number;