v0.13

.cspell.json

@@ -103,6 +103,8 @@
         "locktimes",
         "lokad",
         "lshift",
+        "LSHIFTNUM",
+        "LSHIFTBIN",
         "mecenas",
         "meep",
         "minimaldata",
@@ -154,6 +156,8 @@
         "ripemd",
         "rosco",
         "rshift",
+        "RSHIFTBIN",
+        "RSHIFTNUM",
         "sablier",
         "satoshis",
         "sats",
@@ -221,6 +225,7 @@
         "cherian",
         "CSCriptNum",
         "docu",
+        "fflate",
         "fundme",
         "getblockcount",
         "getrawtransaction",

examples/announcement.cash

@@ -1,4 +1,4 @@
-pragma cashscript ^0.12.0;
+pragma cashscript ^0.13.0;
 
 /* This is a contract showcasing covenants outside of regular transactional use.
  * It enforces the contract to make an "announcement" on Memo.cash, and send the

examples/announcement.ts

@@ -1,19 +1,26 @@
-import { Contract, ElectrumNetworkProvider, Output, TransactionBuilder } from 'cashscript';
+import { Contract, Output, randomUtxo, TransactionBuilder } from 'cashscript';
 import { compileFile } from 'cashc';
 import { stringify } from '@bitauth/libauth';
 import { URL } from 'url';
+import { MockNetworkProvider } from 'cashscript/dist';
 
 // Compile the Announcement contract to an artifact object
 const artifact = compileFile(new URL('announcement.cash', import.meta.url));
 
 // Initialise a network provider for network operations on MAINNET
 const addressType = 'p2sh20';
-const provider = new ElectrumNetworkProvider();
+
+// Once you're ready to send transactions on a real network (like chipnet or mainnet), use the ElectrumNetworkProvider
+// const provider = new ElectrumNetworkProvider();
+const provider = new MockNetworkProvider();
 
 // Instantiate a new contract using the compiled artifact and network provider
 // AND providing the constructor parameters (none)
 const contract = new Contract(artifact, [], { provider, addressType });
 
+// Add a mock UTXO to the mock network provider
+provider.addUtxo(contract.address, randomUtxo());
+
 // Get contract balance & output address + balance
 console.log('contract address:', contract.address);
 const contractUtxos = await contract.getUtxos();

examples/hodl_vault.cash

@@ -1,4 +1,4 @@
-pragma cashscript ^0.12.0;
+pragma cashscript ^0.13.0;
 
 // This contract forces HODLing until a certain price target has been reached
 // A minimum block is provided to ensure that oracle price entries from before this block are disregarded
@@ -11,7 +11,7 @@ contract HodlVault(
     int minBlock,
     int priceTarget
 ) {
-    function spend(sig ownerSig, datasig oracleSig, bytes oracleMessage) {
+    function spend(sig ownerSig, datasig oracleSig, bytes8 oracleMessage) {
         // message: { blockHeight, price }
         bytes4 blockHeightBin, bytes4 priceBin = oracleMessage.split(4);
         int blockHeight = int(blockHeightBin);

examples/hodl_vault.ts

@@ -1,5 +1,5 @@
 import { stringify } from '@bitauth/libauth';
-import { Contract, SignatureTemplate, ElectrumNetworkProvider, TransactionBuilder, Output } from 'cashscript';
+import { Contract, SignatureTemplate, TransactionBuilder, Output, MockNetworkProvider, randomUtxo } from 'cashscript';
 import { compileFile } from 'cashc';
 import { URL } from 'url';
 
@@ -14,14 +14,18 @@ import {
 // Compile the HodlVault contract to an artifact object
 const artifact = compileFile(new URL('hodl_vault.cash', import.meta.url));
 
-// Initialise a network provider for network operations on CHIPNET
-const provider = new ElectrumNetworkProvider('chipnet');
+// Once you're ready to send transactions on a real network (like chipnet or mainnet), use the ElectrumNetworkProvider
+// const provider = new ElectrumNetworkProvider();
+const provider = new MockNetworkProvider();
 
 // Instantiate a new contract using the compiled artifact and network provider
 // AND providing the constructor parameters
 const parameters = [alicePub, oraclePub, 100000n, 30000n];
 const contract = new Contract(artifact, parameters, { provider });
 
+// Add a mock UTXO to the mock network provider
+provider.addUtxo(contract.address, randomUtxo());
+
 // Get contract balance & output address + balance
 console.log('contract address:', contract.address);
 const contractUtxos = await contract.getUtxos();

examples/mecenas.cash

@@ -1,4 +1,4 @@
-pragma cashscript ^0.12.0;
+pragma cashscript ^0.13.0;
 
 /* This is an unofficial CashScript port of Licho's Mecenas contract. It is
  * not compatible with Licho's EC plugin, but rather meant as a demonstration

examples/mecenas.ts

@@ -1,5 +1,5 @@
 import { stringify } from '@bitauth/libauth';
-import { Contract, ElectrumNetworkProvider, Output, TransactionBuilder } from 'cashscript';
+import { Contract, MockNetworkProvider, Output, randomUtxo, TransactionBuilder } from 'cashscript';
 import { compileFile } from 'cashc';
 import { URL } from 'url';
 
@@ -9,15 +9,19 @@ import { aliceAddress, alicePkh, bobPkh } from './common.js';
 // Compile the Mecenas contract to an artifact object
 const artifact = compileFile(new URL('mecenas.cash', import.meta.url));
 
-// Initialise a network provider for network operations on CHIPNET
-const provider = new ElectrumNetworkProvider('chipnet');
+// Once you're ready to send transactions on a real network (like chipnet or mainnet), use the ElectrumNetworkProvider
+// const provider = new ElectrumNetworkProvider();
+const provider = new MockNetworkProvider();
 
 // Instantiate a new contract using the compiled artifact and network provider
 // AND providing the constructor parameters:
 // (recipient: alicePkh, funder: bobPkh, pledge: 10000)
 const pledgeAmount = 10_000n;
 const contract = new Contract(artifact, [alicePkh, bobPkh, pledgeAmount], { provider });
 
+// Add a mock UTXO to the mock network provider
+provider.addUtxo(contract.address, randomUtxo());
+
 // Get contract balance & output address + balance
 console.log('contract address:', contract.address);
 const contractUtxos = await contract.getUtxos();

examples/mecenas_locktime.cash

@@ -1,4 +1,4 @@
-pragma cashscript ^0.12.0;
+pragma cashscript ^0.13.0;
 
 // This is an experimental contract for a more "streaming" Mecenas experience
 // Completely untested, just a concept

examples/p2pkh.cash

@@ -1,4 +1,4 @@
-pragma cashscript ^0.12.0;
+pragma cashscript ^0.13.0;
 
 contract P2PKH(bytes20 pkh) {
     // Require pk to match stored pkh and signature to match

examples/p2pkh.js

@@ -1,6 +1,6 @@
 import { URL } from 'url';
 import { compileFile } from 'cashc';
-import { ElectrumNetworkProvider, Contract, SignatureTemplate, TransactionBuilder } from 'cashscript';
+import { Contract, SignatureTemplate, TransactionBuilder, MockNetworkProvider, randomUtxo } from 'cashscript';
 import { stringify } from '@bitauth/libauth';
 
 // Import Alice's keys from common.ts
@@ -9,13 +9,17 @@ import { alicePkh, alicePriv, aliceAddress, alicePub } from './common.js';
 // Compile the P2PKH contract to an artifact object
 const artifact = compileFile(new URL('p2pkh.cash', import.meta.url));
 
-// Initialise a network provider for network operations on CHIPNET
-const provider = new ElectrumNetworkProvider('chipnet');
+// Once you're ready to send transactions on a real network (like chipnet or mainnet), use the ElectrumNetworkProvider
+// const provider = new ElectrumNetworkProvider();
+const provider = new MockNetworkProvider();
 
 // Instantiate a new contract using the compiled artifact and network provider
 // AND providing the constructor parameters (pkh: alicePkh)
 const contract = new Contract(artifact, [alicePkh], { provider });
 
+// Add a mock UTXO to the mock network provider
+provider.addUtxo(contract.address, randomUtxo());
+
 // Get contract balance & output address + balance
 console.log('contract address:', contract.address);
 const contractUtxos = await contract.getUtxos();
@@ -52,4 +56,4 @@ if (changeAmount > 1000n) transactionBuilder.addOutput(changeOutput);
 
 const tx = await transactionBuilder.send();
 
-console.log('transaction details:', stringify(tx));
+console.log('transaction details:', stringify(tx));

examples/p2pkh.ts

@@ -1,6 +1,6 @@
 import { stringify } from '@bitauth/libauth';
 import { compileFile } from 'cashc';
-import { ElectrumNetworkProvider, SignatureTemplate, Contract, TransactionBuilder, Output } from 'cashscript';
+import { SignatureTemplate, Contract, TransactionBuilder, Output, MockNetworkProvider, randomUtxo } from 'cashscript';
 import { URL } from 'url';
 
 // Import Alice's keys from common.ts
@@ -9,13 +9,17 @@ import { alicePkh, alicePriv, aliceAddress, alicePub } from './common.js';
 // Compile the P2PKH contract to an artifact object
 const artifact = compileFile(new URL('p2pkh.cash', import.meta.url));
 
-// Initialise a network provider for network operations on CHIPNET
-const provider = new ElectrumNetworkProvider('chipnet');
+// Once you're ready to send transactions on a real network (like chipnet or mainnet), use the ElectrumNetworkProvider
+// const provider = new ElectrumNetworkProvider();
+const provider = new MockNetworkProvider();
 
 // Instantiate a new contract using the compiled artifact and network provider
 // AND providing the constructor parameters (pkh: alicePkh)
 const contract = new Contract(artifact, [alicePkh], { provider });
 
+// Add a mock UTXO to the mock network provider
+provider.addUtxo(contract.address, randomUtxo());
+
 // Get contract balance & output address + balance
 console.log('contract address:', contract.address);
 const contractUtxos = await contract.getUtxos();

examples/package.json

@@ -1,7 +1,7 @@
 {
   "name": "cashscript-examples",
   "private": true,
-  "version": "0.12.1",
+  "version": "0.13.0-next.2",
   "description": "Usage examples of the CashScript SDK",
   "main": "p2pkh.js",
   "type": "module",
@@ -13,8 +13,8 @@
   "dependencies": {
     "@bitauth/libauth": "^3.1.0-next.8",
     "@types/node": "^22.17.0",
-    "cashc": "^0.12.1",
-    "cashscript": "^0.12.1",
+    "cashc": "^0.13.0-next.2",
+    "cashscript": "^0.13.0-next.2",
     "eslint": "^8.56.0",
     "typescript": "^5.9.2"
   }

examples/testing-suite/.gitignore

@@ -0,0 +1,2 @@
+**/dist/
+**/node_modules/

examples/testing-suite/README.md

@@ -0,0 +1,25 @@
+# CashScript Testing Suite
+
+This is an example project to demonstrate how to write and compile CashScript contracts and test them using the CashScript SDK and Vitest.
+
+## Writing a CashScript contract
+
+We have included two simple example contracts in the `contracts/` directory that can be used as a starting point to write your own contracts. The contracts demonstrate logs, require statements and transaction signatures.
+
+## Compiling the contracts
+
+We have included a task to compile the contracts in the `tasks/` directory called `compile.ts`. This task will compile all the contracts in the `contracts/` directory and save the artifacts in the `artifacts/` directory. This includes both the JSON and TypeScript artifacts. It is recommended to use the TypeScript artifacts for proper type-safety.
+
+You can run the task with `yarn compile`.
+
+## Running the tests
+
+We have included test files in the `test/` directory, which test the expected functionality of the contracts. For key management, we have included a utility file in the `utils/` directory which exports testing keys for Alice and Bob.
+
+You can run the tests with `yarn test`.
+
+## Next steps
+
+Once you're getting comfortable writing, compiling and testing CashScript contracts, you can copy the `testing-suite` directory into your own project to use as a starting point. From there you can start writing more complex contracts and integrate them into full applications.
+
+We recommend checking out the [CashScript SDK documentation](https://cashscript.org/docs/sdk/) for more information on how to use the CashScript SDK, and the specific section on the [testing setup](https://cashscript.org/docs/sdk/testing-setup) for more information on how to test your contracts.

examples/testing-suite/artifacts/example.artifact.ts

@@ -13,10 +13,10 @@ export default {
     },
   ],
   bytecode: 'OP_1 OP_NUMEQUAL',
-  source: 'contract Example() {\n  function test(int value) {\n    console.log(value, \'test\');\n    require(value == 1, \'Wrong value passed\');\n  }\n}\n',
+  source: 'contract Example() {\n  function test(int value) {\n    console.log(value, "test");\n    require(value == 1, "Wrong value passed");\n  }\n}\n',
   debug: {
-    bytecode: '007a519c',
-    sourceMap: '4:12:4:17;;:21::22;:12:::1',
+    bytecode: '519c',
+    sourceMap: '4:21:4:22;:4::46:1',
     logs: [
       {
         ip: 0,
@@ -33,15 +33,15 @@ export default {
     ],
     requires: [
       {
-        ip: 4,
+        ip: 2,
         line: 4,
         message: 'Wrong value passed',
       },
     ],
   },
   compiler: {
     name: 'cashc',
-    version: '0.11.0',
+    version: '0.13.0-next.2',
   },
-  updatedAt: '2025-04-11T09:08:09.750Z',
+  updatedAt: '2026-01-13T10:40:29.996Z',
 } as const;

examples/testing-suite/artifacts/example.json

@@ -41,7 +41,7 @@
   },
   "compiler": {
     "name": "cashc",
-    "version": "0.12.0"
+    "version": "0.13.0-next.2"
   },
-  "updatedAt": "2025-12-09T10:19:09.338Z"
+  "updatedAt": "2026-01-13T10:40:29.996Z"
 }

examples/testing-suite/artifacts/transfer_with_timeout.artifact.ts

@@ -0,0 +1,63 @@
+export default {
+  contractName: 'TransferWithTimeout',
+  constructorInputs: [
+    {
+      name: 'sender',
+      type: 'pubkey',
+    },
+    {
+      name: 'recipient',
+      type: 'pubkey',
+    },
+    {
+      name: 'timeout',
+      type: 'int',
+    },
+  ],
+  abi: [
+    {
+      name: 'transfer',
+      inputs: [
+        {
+          name: 'recipientSig',
+          type: 'sig',
+        },
+      ],
+    },
+    {
+      name: 'timeout',
+      inputs: [
+        {
+          name: 'senderSig',
+          type: 'sig',
+        },
+      ],
+    },
+  ],
+  bytecode: 'OP_3 OP_PICK OP_0 OP_NUMEQUAL OP_IF OP_4 OP_ROLL OP_ROT OP_CHECKSIG OP_NIP OP_NIP OP_NIP OP_ELSE OP_3 OP_ROLL OP_1 OP_NUMEQUALVERIFY OP_3 OP_ROLL OP_SWAP OP_CHECKSIGVERIFY OP_SWAP OP_CHECKLOCKTIMEVERIFY OP_2DROP OP_1 OP_ENDIF',
+  source: 'pragma cashscript ^0.13.0;\n\ncontract TransferWithTimeout(\n    pubkey sender,\n    pubkey recipient,\n    int timeout\n) {\n    // Require recipient\'s signature to match\n    function transfer(sig recipientSig) {\n        require(checkSig(recipientSig, recipient));\n    }\n\n    // Require timeout time to be reached and sender\'s signature to match\n    function timeout(sig senderSig) {\n        require(checkSig(senderSig, sender));\n        require(tx.time >= timeout);\n    }\n}\n',
+  debug: {
+    bytecode: '5379009c63547a7bac77777767537a519d537a7cad7cb16d5168',
+    sourceMap: '9:4:11:5;;;;;10:25:10:37;;:39::48;:8::51:1;9:4:11:5;;;;14::17::0;;;;15:25:15:34;;:36::42;:8::45:1;16:27:16:34:0;:8::36:1;14:4:17:5;;3:0:18:1',
+    logs: [],
+    requires: [
+      {
+        ip: 12,
+        line: 10,
+      },
+      {
+        ip: 23,
+        line: 15,
+      },
+      {
+        ip: 25,
+        line: 16,
+      },
+    ],
+  },
+  compiler: {
+    name: 'cashc',
+    version: '0.13.0-next.2',
+  },
+  updatedAt: '2026-01-13T10:40:30.007Z',
+} as const;