Remove old-style covenants from SDK (#259)

- Remove all old-style covenant functionality and tests
- Add semver check with minimum supported cashc version

Author: mr-zwets

packages/cashc/package.json

@@ -53,12 +53,12 @@
     "@cashscript/utils": "^0.11.0-next.0",
     "antlr4": "^4.13.1-patch-1",
     "commander": "^7.1.0",
-    "semver": "^7.5.4"
+    "semver": "^7.6.3"
   },
   "devDependencies": {
     "@jest/globals": "^29.4.1",
     "@types/node": "^18.11.18",
-    "@types/semver": "^7.3.4",
+    "@types/semver": "^7.5.8",
     "cpy-cli": "^4.2.0",
     "eslint": "^8.54.0",
     "jest": "^29.4.1",

packages/cashscript/package.json

@@ -49,12 +49,14 @@
     "delay": "^5.0.0",
     "electrum-cash": "^2.0.10",
     "fast-deep-equal": "^3.1.3",
-    "pako": "^2.1.0"
+    "pako": "^2.1.0",
+    "semver": "^7.6.3"
   },
   "devDependencies": {
     "@jest/globals": "^29.4.1",
     "@psf/bch-js": "^6.8.0",
     "@types/pako": "^2.0.3",
+    "@types/semver": "^7.5.8",
     "eslint": "^8.54.0",
     "jest": "^29.4.1",
     "typescript": "^5.5.4"

packages/cashscript/src/Contract.ts

@@ -25,6 +25,7 @@ import {
 import SignatureTemplate from './SignatureTemplate.js';
 import { ElectrumNetworkProvider } from './network/index.js';
 import { ParamsToTuple, AbiToFunctionMap } from './types/type-inference.js';
+import semver from 'semver';
 
 export class Contract<
   TArtifact extends Artifact = Artifact,
@@ -62,11 +63,15 @@ export class Contract<
     this.provider = this.options?.provider ?? new ElectrumNetworkProvider();
     this.addressType = this.options?.addressType ?? 'p2sh32';
 
-    const expectedProperties = ['abi', 'bytecode', 'constructorInputs', 'contractName'];
+    const expectedProperties = ['abi', 'bytecode', 'constructorInputs', 'contractName', 'compiler'];
     if (!expectedProperties.every((property) => property in artifact)) {
       throw new Error('Invalid or incomplete artifact provided');
     }
 
+    if (!semver.satisfies(artifact.compiler.version, '>=0.7.0', { includePrerelease: true })) {
+      throw new Error(`Artifact compiled with unsupported compiler version: ${artifact.compiler.version}, required >=0.7.0`);
+    }
+
     if (artifact.constructorInputs.length !== constructorArgs.length) {
       throw new Error(`Incorrect number of arguments passed to ${artifact.contractName} constructor. Expected ${artifact.constructorInputs.length} arguments (${artifact.constructorInputs.map((input) => input.type)}) but got ${constructorArgs.length}`);
     }
@@ -156,28 +161,16 @@ export class Contract<
       const generateUnlockingBytecode = (
         { transaction, sourceOutputs, inputIndex }: GenerateUnlockingBytecodeOptions,
       ): Uint8Array => {
-        // TODO: Remove old-style covenant code for v1.0 release
-        let covenantHashType = -1;
         const completeArgs = encodedArgs.map((arg) => {
           if (!(arg instanceof SignatureTemplate)) return arg;
 
-          // First signature is used for sighash preimage (maybe not the best way)
-          if (covenantHashType < 0) covenantHashType = arg.getHashType();
-
+          // Generate transaction signature from SignatureTemplate
           const preimage = createSighashPreimage(transaction, sourceOutputs, inputIndex, bytecode, arg.getHashType());
           const sighash = hash256(preimage);
-
           return arg.generateSignature(sighash);
         });
 
-        const preimage = abiFunction.covenant
-          ? createSighashPreimage(transaction, sourceOutputs, inputIndex, bytecode, covenantHashType)
-          : undefined;
-
-        const unlockingBytecode = createInputScript(
-          this.redeemScript, completeArgs, selector, preimage,
-        );
-
+        const unlockingBytecode = createInputScript(this.redeemScript, completeArgs, selector);
         return unlockingBytecode;
       };
 

packages/cashscript/src/Transaction.ts

@@ -9,7 +9,6 @@ import {
   AbiFunction,
   encodeBip68,
   placeholder,
-  scriptToBytecode,
 } from '@cashscript/utils';
 import deepEqual from 'fast-deep-equal';
 import {
@@ -28,7 +27,6 @@ import {
   getInputSize,
   createOpReturnOutput,
   getTxSizeWithoutInputs,
-  getPreimageSize,
   validateOutput,
   utxoComparator,
   calculateDust,
@@ -61,7 +59,7 @@ export class Transaction {
     public abiFunction: AbiFunction,
     public encodedFunctionArgs: EncodedFunctionArgument[],
     private selector?: number,
-  ) {}
+  ) { }
 
   from(input: Utxo): this;
   from(inputs: Utxo[]): this;
@@ -175,10 +173,7 @@ export class Transaction {
     const tx = await this.build();
 
     // Debug the transaction locally before sending so any errors are caught early
-    // Libauth debugging does not work with old-style covenants
-    if (!this.abiFunction.covenant) {
-      await this.debug();
-    }
+    await this.debug();
 
     try {
       const txid = await this.contract.provider.sendRawTransaction(tx);
@@ -350,18 +345,11 @@ export class Transaction {
       return placeholder(73);
     });
 
-    // Create a placeholder preimage of the correct size
-    const placeholderPreimage = this.abiFunction.covenant
-      ? placeholder(getPreimageSize(scriptToBytecode(this.contract.redeemScript)))
-      : undefined;
-
-    // Create a placeholder input script for size calculation using the placeholder
-    // arguments and correctly sized placeholder preimage
+    // Create a placeholder input script for size calculation using the placeholder arguments
     const placeholderScript = createInputScript(
       this.contract.redeemScript,
       placeholderArgs,
       this.selector,
-      placeholderPreimage,
     );
 
     // Add one extra byte per input to over-estimate tx-in count

packages/cashscript/src/utils.ts

@@ -5,7 +5,7 @@ import {
   lockingBytecodeToCashAddress,
   binToHex,
   Transaction,
-  generateSigningSerializationBCH,
+  generateSigningSerializationBch,
   utf8ToBin,
   hexToBin,
   flattenBinArray,
@@ -125,12 +125,6 @@ export function getInputSize(inputScript: Uint8Array): number {
   return 32 + 4 + varIntSize + scriptSize + 4;
 }
 
-export function getPreimageSize(script: Uint8Array): number {
-  const scriptSize = script.byteLength;
-  const varIntSize = scriptSize > 252 ? 3 : 1;
-  return 4 + 32 + 32 + 36 + varIntSize + scriptSize + 8 + 4 + 32 + 4 + 4;
-}
-
 export function getTxSizeWithoutInputs(outputs: Output[]): number {
   // Transaction format:
   // Version (4 Bytes)
@@ -160,11 +154,9 @@ export function createInputScript(
   redeemScript: Script,
   encodedArgs: Uint8Array[],
   selector?: number,
-  preimage?: Uint8Array,
 ): Uint8Array {
-  // Create unlock script / redeemScriptSig (add potential preimage and selector)
+  // Create unlock script / redeemScriptSig (add potential selector)
   const unlockScript = [...encodedArgs].reverse();
-  if (preimage !== undefined) unlockScript.push(preimage);
   if (selector !== undefined) unlockScript.push(encodeInt(BigInt(selector)));
 
   // Create input script and compile it to bytecode
@@ -199,7 +191,7 @@ export function createSighashPreimage(
   const context = { inputIndex, sourceOutputs, transaction };
   const signingSerializationType = new Uint8Array([hashtype]);
 
-  const sighashPreimage = generateSigningSerializationBCH(context, { coveredBytecode, signingSerializationType });
+  const sighashPreimage = generateSigningSerializationBch(context, { coveredBytecode, signingSerializationType });
 
   return sighashPreimage;
 }

packages/cashscript/test/Contract.test.ts

@@ -15,6 +15,7 @@ import p2pkhArtifact from './fixture/p2pkh.json' with { type: 'json' };
 import twtArtifact from './fixture/transfer_with_timeout.json' with { type: 'json' };
 import hodlVaultArtifact from './fixture/hodl_vault.json' with { type: 'json' };
 import mecenasArtifact from './fixture/mecenas.json' with { type: 'json' };
+import deprecatedMecenasArtifact from './fixture/deprecated/mecenas-v0.6.0.json' with { type: 'json' };
 import boundedBytesArtifact from './fixture/bounded_bytes.json' with { type: 'json' };
 
 describe('Contract', () => {
@@ -31,6 +32,14 @@ describe('Contract', () => {
       expect(() => new Contract(p2pkhArtifact, [placeholder(21)], { provider })).toThrow();
     });
 
+    it('should fail with artifact compiled with unsupported compiler version', async () => {
+      const provider = new ElectrumNetworkProvider(Network.CHIPNET);
+      const constructorArgs = [placeholder(20), placeholder(20), 1000000n];
+
+      expect(() => new Contract(deprecatedMecenasArtifact, constructorArgs, { provider }))
+        .toThrow(/unsupported compiler version/);
+    });
+
     it('should fail with incomplete artifact', () => {
       const provider = new ElectrumNetworkProvider(Network.CHIPNET);