Clean up TODOs / comments before release

Author: rkalis

packages/cashc/src/compiler.ts

@@ -41,14 +41,13 @@ export function compileString(code: string): Artifact {
   if (scriptToAsm(optimisedBytecodeOld) !== scriptToAsm(optimisationResult.script)) {
     console.error(scriptToAsm(optimisedBytecodeOld));
     console.error(scriptToAsm(optimisationResult.script));
-    throw new Error('New bytecode optimisation is not backwards compatible');
+    throw new Error('New bytecode optimisation is not backwards compatible, please report this issue to the CashScript team');
   }
 
   // Attach debug information
   const debug = {
     bytecode: binToHex(scriptToBytecode(optimisationResult.script)),
     sourceMap: generateSourceMap(optimisationResult.locationData),
-    // sourceMap: traversal.sourceMap,
     logs: optimisationResult.logs,
     requires: optimisationResult.requires,
   };

packages/cashscript/src/LibauthTemplate.ts

@@ -321,21 +321,6 @@ export const generateTemplateScenarioTransactionOutputLockingBytecode = (
   return binToHex(addressToLockScript(csOutput.to));
 };
 
-/**
- * Generates source outputs for a BitAuth template scenario
- *
- * @param csTransaction - The CashScript transaction to generate source outputs for
- * @returns An array of BitAuth template scenario outputs with locking scripts and values
- *
- * For each input in the transaction:
- * - Generates appropriate locking bytecode (P2PKH or contract)
- * - Includes the input value in satoshis
- * - Includes any token details if present
- *
- * The slotIndex tracks which input is the contract input vs P2PKH inputs
- * to properly generate the locking scripts.
- */
-// TODO: This looks like it needs some refactor to work with the new stuff
 const generateTemplateScenarioSourceOutputs = (
   csTransaction: Transaction,
 ): Array<WalletTemplateScenarioOutput<true>> => {

packages/cashscript/src/Transaction.ts

@@ -187,7 +187,7 @@ export class Transaction {
 
   // method to debug the transaction with libauth VM, throws upon evaluation error
   async debug(): Promise<DebugResults> {
-    if (!semver.satisfies(this.contract.artifact.compiler.version, '>=0.11.0-next.4', { includePrerelease: true })) {
+    if (!semver.satisfies(this.contract.artifact.compiler.version, '>=0.11.0')) {
       console.warn('For the best debugging experience, please recompile your contract with cashc version 0.11.0 or newer.');
     }
 

packages/cashscript/src/TransactionBuilder.ts

@@ -170,7 +170,7 @@ export class TransactionBuilder {
       .map((input) => 'contract' in input.unlocker ? input.unlocker.contract.artifact.compiler.version : null)
       .filter((version) => version !== null);
 
-    if (!contractVersions.every((version) => semver.satisfies(version, '>=0.11.0-next.4', { includePrerelease: true }))) {
+    if (!contractVersions.every((version) => semver.satisfies(version, '>=0.11.0'))) {
       console.warn('For the best debugging experience, please recompile your contract with cashc version 0.11.0 or newer.');
     }
 
@@ -186,7 +186,6 @@ export class TransactionBuilder {
     return getLibauthTemplates(this);
   }
 
-  // TODO: see if we can merge with Transaction.ts
   async send(): Promise<TransactionDetails>;
   async send(raw: true): Promise<string>;
   async send(raw?: true): Promise<TransactionDetails | string> {
@@ -207,7 +206,6 @@ export class TransactionBuilder {
     }
   }
 
-  // TODO: see if we can merge with Transaction.ts
   private async getTxDetails(txid: string): Promise<TransactionDetails>;
   private async getTxDetails(txid: string, raw: true): Promise<string>;
   private async getTxDetails(txid: string, raw?: true): Promise<TransactionDetails | string> {

packages/cashscript/src/debugging.ts

@@ -258,7 +258,10 @@ const calculateCleanupSize = (instructions: Array<AuthenticationInstruction | un
   // OP_NIP (or OP_DROP/OP_2DROP in optimised bytecode) is used for cleanup at the end of a function,
   // OP_ENDIF and OP_ELSE are the end of branches. We need to remove all of these to get to the actual last
   // executed instruction of a function
-  // TODO: What about OP_1??
+  // Note that in the case where we re-add OP_1 because we cannot optimise the final explicit VERIFY into an implicit one
+  // (like when dealing with if-statements, or with CHECKLOCKTIMEVERIFY), it is impossible to run into an implicit final
+  // verify failure. That is why OP_1 does not need to be included in the cleanup opcodes.
+  // TODO: Perhaps we also do not need to add OP_DROP/OP_2DROP either, because they only occur together with OP_1
   const cleanupOpcodes = [Op.OP_ENDIF, Op.OP_NIP, Op.OP_ELSE, Op.OP_DROP, Op.OP_2DROP];
 
   let cleanupSize = 0;

website/docs/basics/getting-started.md

@@ -31,7 +31,7 @@ To write CashScript smart contracts locally you use a code editor. For the best
 
 :::note prerequisites
 - Basic familiarity with the command line
-- Node.js installed (v20 or newer)
+- Node.js installed (v22 or newer)
 - A code editor (VS Code recommended)
 :::
 

website/docs/releases/release-notes.md

@@ -2,7 +2,7 @@
 title: Release Notes
 ---
 
-## v0.11.0-next.4
+## v0.11.0
 
 This update adds CashScript support for the new BCH 2025 network upgrade. To read more about the upgrade, see [this blog post](https://blog.bitjson.com/2025-chips/).