Final changes before 0.12 release

rkalis · rkalis · commit dfa7ea1cfe1c · 2025-10-02T11:59:46.000+02:00
- Rename bitauthUri to getBitauthUri and update docs for it
- Move around some utils
- Add getVmResourceUsage to release notes and docs
- Update docs for MockNetworkProvider default changes
- Update libauth version in examples/
diff --git a/examples/package.json b/examples/package.json
@@ -11,7 +11,7 @@
     "lint": "eslint . --ext .ts --ignore-path ../.eslintignore"
   },
   "dependencies": {
-    "@bitauth/libauth": "^3.1.0-next.2",
+    "@bitauth/libauth": "^3.1.0-next.8",
     "@types/node": "^22.17.0",
     "cashc": "^0.12.0",
     "cashscript": "^0.12.0",
diff --git a/examples/testing-suite/artifacts/example.json b/examples/testing-suite/artifacts/example.json
@@ -41,7 +41,7 @@
   },
   "compiler": {
     "name": "cashc",
-    "version": "0.11.3"
+    "version": "0.12.0"
   },
-  "updatedAt": "2025-08-05T08:32:16.100Z"
+  "updatedAt": "2025-10-02T09:56:11.510Z"
 }
diff --git a/examples/testing-suite/package.json b/examples/testing-suite/package.json
@@ -25,7 +25,7 @@
     "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' jest"
   },
   "dependencies": {
-    "@bitauth/libauth": "^3.1.0-next.2",
+    "@bitauth/libauth": "^3.1.0-next.8",
     "cashc": "^0.12.0",
     "cashscript": "^0.12.0",
     "url-join": "^5.0.0"
diff --git a/packages/cashscript/src/TransactionBuilder.ts b/packages/cashscript/src/TransactionBuilder.ts
@@ -247,8 +247,7 @@ export class TransactionBuilder {
     return vmResourceUsage;
   }
 
-  // TODO: rename to getBitauthUri()
-  bitauthUri(): string {
+  getBitauthUri(): string {
     console.warn('WARNING: it is unsafe to use this Bitauth URI when using real private keys as they are included in the transaction template');
     return getBitauthUri(this.getLibauthTemplate());
   }
@@ -273,7 +272,7 @@ export class TransactionBuilder {
       return raw ? await this.getTxDetails(txid, raw) : await this.getTxDetails(txid);
     } catch (e: any) {
       const reason = e.error ?? e.message;
-      throw new FailedTransactionError(reason, this.bitauthUri());
+      throw new FailedTransactionError(reason, this.getBitauthUri());
     }
   }
 
diff --git a/packages/cashscript/src/libauth-template/LibauthTemplate.ts b/packages/cashscript/src/libauth-template/LibauthTemplate.ts
@@ -31,11 +31,11 @@ import {
   VmTarget,
 } from '../interfaces.js';
 import SignatureTemplate from '../SignatureTemplate.js';
-import { addressToLockScript, extendedStringify, getSignatureAndPubkeyFromP2PKHInput, zip } from '../utils.js';
+import { addressToLockScript, extendedStringify, zip } from '../utils.js';
 import { TransactionBuilder } from '../TransactionBuilder.js';
 import { deflate } from 'pako';
 import MockNetworkProvider from '../network/MockNetworkProvider.js';
-import { addHexPrefixExceptEmpty, formatBytecodeForDebugging, formatParametersForDebugging, getLockScriptName, getUnlockScriptName, lockingBytecodeIsSetToSlot, serialiseTokenDetails } from './utils.js';
+import { addHexPrefixExceptEmpty, formatBytecodeForDebugging, formatParametersForDebugging, getLockScriptName, getSignatureAndPubkeyFromP2PKHInput, getUnlockScriptName, lockingBytecodeIsSetToSlot, serialiseTokenDetails } from './utils.js';
 
 // TODO: Add / improve descriptions throughout the template generation
 
diff --git a/packages/cashscript/src/libauth-template/utils.ts b/packages/cashscript/src/libauth-template/utils.ts
@@ -1,6 +1,6 @@
 import { AbiFunction, AbiInput, Artifact, bytecodeToScript, formatBitAuthScript } from '@cashscript/utils';
 import { HashType, LibauthTokenDetails, SignatureAlgorithm, TokenDetails } from '../interfaces.js';
-import { hexToBin, binToHex, isHex, decodeCashAddress, type WalletTemplateScenarioBytecode } from '@bitauth/libauth';
+import { hexToBin, binToHex, isHex, decodeCashAddress, type WalletTemplateScenarioBytecode, Input, assertSuccess, decodeAuthenticationInstructions, AuthenticationInstructionPush } from '@bitauth/libauth';
 import { EncodedFunctionArgument } from '../Argument.js';
 import { zip } from '../utils.js';
 import SignatureTemplate from '../SignatureTemplate.js';
@@ -112,3 +112,15 @@ interface LibauthTemplateTokenDetails {
 export const lockingBytecodeIsSetToSlot = (lockingBytecode?: WalletTemplateScenarioBytecode | ['slot']): boolean => {
   return Array.isArray(lockingBytecode) && lockingBytecode.length === 1 && lockingBytecode[0] === 'slot';
 };
+
+export const getSignatureAndPubkeyFromP2PKHInput = (
+  libauthInput: Input,
+): { signature: Uint8Array; publicKey: Uint8Array } => {
+  const inputData = (assertSuccess(
+    decodeAuthenticationInstructions(libauthInput.unlockingBytecode))
+  ) as AuthenticationInstructionPush[];
+  const signature = inputData[0].data;
+  const publicKey = inputData[1].data;
+
+  return { signature, publicKey };
+};
diff --git a/packages/cashscript/src/utils.ts b/packages/cashscript/src/utils.ts
@@ -14,11 +14,6 @@ import {
   bigIntToCompactUint,
   NonFungibleTokenCapability,
   bigIntToVmNumber,
-  assertSuccess,
-  AuthenticationInstructionPush,
-  AuthenticationInstructions,
-  decodeAuthenticationInstructions,
-  Input,
 } from '@bitauth/libauth';
 import {
   encodeInt,
@@ -373,15 +368,3 @@ export const isFungibleTokenUtxo = (utxo: Utxo): boolean => (
 export const isNonTokenUtxo = (utxo: Utxo): boolean => utxo.token === undefined;
 
 export const delay = (ms: number): Promise<void> => new Promise((resolve) => setTimeout(resolve, ms));
-
-export const getSignatureAndPubkeyFromP2PKHInput = (
-  libauthInput: Input,
-): { signature: Uint8Array; publicKey: Uint8Array } => {
-  const inputData = (assertSuccess(
-    decodeAuthenticationInstructions(libauthInput.unlockingBytecode)) as AuthenticationInstructions
-  ) as AuthenticationInstructionPush[];
-  const signature = inputData[0].data;
-  const publicKey = inputData[1].data;
-
-  return { signature, publicKey };
-};
diff --git a/packages/cashscript/test/debugging-old-artifacts.test.ts b/packages/cashscript/test/debugging-old-artifacts.test.ts
@@ -35,7 +35,7 @@ describe('Debugging tests - old artifacts', () => {
       .addInput(contractUtxo, contractTestLogs.unlock.spend(alicePub, new SignatureTemplate(alicePriv)))
       .addOutput({ to: contractTestLogs.address, amount: 10000n });
 
-    console.warn(transaction.bitauthUri());
+    console.warn(transaction.getBitauthUri());
 
     expect(() => transaction.debug()).not.toThrow();
   });
@@ -50,7 +50,7 @@ describe('Debugging tests - old artifacts', () => {
       .addInput(contractUtxo, contractTestLogs.unlock.spend(alicePub, new SignatureTemplate(bobPriv)))
       .addOutput({ to: contractTestLogs.address, amount: 10000n });
 
-    console.warn(transaction.bitauthUri());
+    console.warn(transaction.getBitauthUri());
 
     expect(() => transaction.debug()).toThrow();
   });
diff --git a/packages/cashscript/test/e2e/MultiContract.test.ts b/packages/cashscript/test/e2e/MultiContract.test.ts
@@ -87,7 +87,7 @@ describe('Multi Contract', () => {
         .addInput(bobAddressUtxos[0], bobSignatureTemplate.unlockP2PKH())
         .addOutput({ to, amount });
 
-      console.log(transaction.bitauthUri());
+      console.log(transaction.getBitauthUri());
 
       const txPromise = transaction.send();
 
@@ -173,7 +173,7 @@ describe('Multi Contract', () => {
         .addInput(bobAddressUtxos[0], bobSignatureTemplate.unlockP2PKH())
         .addOutput({ to, amount });
 
-      console.log(transaction.bitauthUri());
+      console.log(transaction.getBitauthUri());
 
       const txPromise = transaction.send();
 
diff --git a/packages/cashscript/test/libauth-template/LibauthTemplate.test.ts b/packages/cashscript/test/libauth-template/LibauthTemplate.test.ts
@@ -5,7 +5,7 @@ describe('Libauth Template generation tests (single-contract)', () => {
     it(`should generate a valid libauth template for ${fixture.name}`, () => {
       const generatedTemplate = fixture.transaction.getLibauthTemplate();
       // console.warn(JSON.stringify(generatedTemplate, null, 2));
-      // console.warn(fixture.transaction.bitauthUri());
+      // console.warn(fixture.transaction.getBitauthUri());
       expect(generatedTemplate).toEqual(fixture.template);
     });
   });
diff --git a/packages/cashscript/test/libauth-template/LibauthTemplateMultiContract.test.ts b/packages/cashscript/test/libauth-template/LibauthTemplateMultiContract.test.ts
@@ -6,7 +6,7 @@ describe('Libauth Template generation tests (multi-contract)', () => {
       const builder = await fixture.transaction;
       const generatedTemplate = builder.getLibauthTemplate();
       // console.warn(JSON.stringify(generatedTemplate, null, 2));
-      // console.warn(builder.bitauthUri());
+      // console.warn(builder.getBitauthUri());
       expect(generatedTemplate).toEqual(fixture.template);
     });
   });
diff --git a/packages/cashscript/test/multi-contract-debugging.test.ts b/packages/cashscript/test/multi-contract-debugging.test.ts
@@ -143,7 +143,7 @@ describe('Multi-Contract-Debugging tests', () => {
         .addInput(bobAddressUtxos[0], bobSignatureTemplate.unlockP2PKH())
         .addOutput({ to, amount });
 
-      console.warn(transaction.bitauthUri());
+      console.warn(transaction.getBitauthUri());
 
       await expect(transaction).toFailRequireWith('P2PKH.cash:4 Require statement failed at input 0 in contract P2PKH.cash at line 4.');
     });
@@ -169,7 +169,7 @@ describe('Multi-Contract-Debugging tests', () => {
         .addInput(bobAddressUtxos[0], bobSignatureTemplate.unlockP2PKH())
         .addOutput({ to, amount });
 
-      console.warn(transaction.bitauthUri());
+      console.warn(transaction.getBitauthUri());
 
       await expect(transaction).toFailRequireWith('BigInt.cash:4 Require statement failed at input 1 in contract BigInt.cash at line 4.');
     });
@@ -197,7 +197,7 @@ describe('Multi-Contract-Debugging tests', () => {
         .addInput(bobAddressUtxos[0], bobSignatureTemplate.unlockP2PKH())
         .addOutput({ to, amount });
 
-      console.warn(transaction.bitauthUri());
+      console.warn(transaction.getBitauthUri());
 
       await expect(transaction).toFailRequireWith('P2PKH.cash:5 Require statement failed at input 0 in contract P2PKH.cash at line 5');
     });
@@ -225,7 +225,7 @@ describe('Multi-Contract-Debugging tests', () => {
         .addInput(bobAddressUtxos[0], bobSignatureTemplate.unlockP2PKH())
         .addOutput({ to, amount });
 
-      console.warn(transaction.bitauthUri());
+      console.warn(transaction.getBitauthUri());
 
       await expect(transaction).toFailRequireWith('BigInt.cash');
     });
diff --git a/website/docs/guides/debugging.md b/website/docs/guides/debugging.md
@@ -42,10 +42,10 @@ To help with debugging you can add `console.log` statements to your CashScript c
 
 Whenever a transaction fails, there will be a link in the console to open your smart contract transaction in the BitAuth IDE. This will allow you to inspect the transaction in detail, and see exactly why the transaction failed. In the BitAuth IDE you will see the raw BCH Script mapping to each line in your CashScript contract. Find the failing line and investigate the failing OpCode. You can break up the failing line, one opcode at a time, to see how the stack evolves and ends with your `require` failure.
 
-It's also possible to export the transaction for step-by-step debugging in the BitAuth IDE without failure. To do so, you can call the `bitauthUri()` function on the transaction. This will return a URI that can be opened in the BitAuth IDE.
+It's also possible to export the transaction for step-by-step debugging in the BitAuth IDE without failure. To do so, you can call the `getBitauthUri()` function on the transaction. This will return a URI that can be opened in the BitAuth IDE.
 
 ```ts
-const uri = await transactionBuilder.bitauthUri();
+const uri = await transactionBuilder.getBitauthUri();
 ```
 
 :::caution
@@ -75,7 +75,7 @@ OP_3 OP_ROLL OP_SWAP OP_CHECKSIGVERIFY /*         require(checkSig(senderSig, se
 OP_SWAP OP_CHECKLOCKTIMEVERIFY         /*         require(tx.time >= timeout);                                         */
 OP_2DROP OP_1                          /*     }                                                                        */
 OP_ENDIF                               /* }                                                                            */
-          
+
 ```
 
 [BitauthIDE]: https://ide.bitauth.com/import-template/eJzFWAtv2zYQ_isCN2BJ4drUW8raAK3jNkbSJEvcFUMdGBR1stXakidRWYIg--07SrIk23LgDhlGBKEiHu-7x3fUMY_k55TPYMHIEZkJsUyPer3Qh64XCpaJWZfHi558gEiEnIkwjl4LWCznTMDrO9ot9na_pXFEOsSHlCfhUkqhuuFiGScCfCVI4oXCWTorVlEwYgtAiT6-u8nfKR8hgoRJ6RPwsuk0jKbKqATCDWm2LJSRo6_kff90olHNnFCT3HbIHSRpjkg7RJopQkjJ0SMZJSxKA0i-hGI2ChcQZ2ISRstM0MmSJWiBwI1ScN3sfhyJhHGh8ARyhxUWoQ9ZxPM_GlsrP1qQlIMcSvmJHkrzc_2pNL7NqnnMv6NU25JYNzyLclnpNUtC5s0LV1OIfEhuwum2O-N6cUxq65U4qH0akxJmTGqnap0dIh6W8tUZPJCnTrmyG2oTR8zCVOFlWDcBau1f2HwO4oQJJkES4OEyxHy24VSLe0LVynaglf63YVWh2QtppWgHzirkmE8f7rfhymqoMpOLKSJW4B54lpdCCbShqRUPR4N77RXRTjAUXrI0hZ2U3dgGd2yeyVK93YxEWyHgaq_XZF1beY2jNxUF5TkTxUkyScNpxESWQBfdnOBeVJ1O5HMm7uP0WEG9KDOOxhE-bYQxjKqEofL1AOY7w0gob5U36vFYnmZFKNL2-i5q9qm9aFchlDMeZKMiM0stnenas6fGVoRaZDBavDqi4igVScZFnKxHroxs0yt671KfUh2de1PVQy6wzLzv8FDIUN0JTNM0HN8OdF91dA6e5wDYNtWtAMAzqBMYzKQ6DTzDsWzVtkzX81zDCMDEZX5cJW5buaY6vqFalmq5mouPGlcD29JBM3QwPNPjuh84oOIyZcw1dU-1mQVUc6lmaWbg0uMys96DAB77MI6U_UbvlbJM2HTBGh8i5W_aVdUu_XVPHc3xqvcj0C86fgy64koLlQ7K5BTp6qxyVbGjk3On5NKh8vgvvMZcXcOfWZhArfaXVKnqWJ5tCyb4bB-vL68muoK_rob9MzlT-evi86fBb5_fncvn4YcGdFX9ovT8AFFrK_BYkS7tMUpoQyJcX56fF_NITv3TQf_sZvhxw2s5ksLtA-yQ-HcEO2gid2o7Dg-f4V8JfTG8UramwfnNYDvgT_t4tK_Xe4r-vwzPp5pmq--OnCW7PMk8hlnw80au4PpOCjZptsq12qTZ74Pr4Yc_GtA1zcqikiyrvlx7UmwX9M2Xd1dNnpXoz9Gsgu6UVjxLsDXoNbTzy_7ZaPhpUDvcDHgTWtx382Afv63Oiv2P1BJaO7m-vCqCvXP8FwyXdXRxUpwbzwyEfjHYFfSeoi9fXKRoCyHCK0S8b2NYdXgoXjYwg_JV26dFaW3_1pvddxG2tQzveKCU2mUZ_TUDWZOyvS4_00XvW3SHsiftSk2ywUVTVo1AfQtCxS_RaZC1Kwh5ic6INO4ZZNWOke1LAVFlY8mzJEHs97KJPIVwOsNd2vprGWtypNqGhViaa3QIfr7zhC6T8A4zc1b-2bgfEstwLddjhqepaJvuO6pl2hq1uUZdz0HjTUvXLIeCYXsAGmO2a_HA9j3K8YfbJL9V5N9UxotMPpI8yfKy8EhkUx5j3zAsnEGjVm9G9Z5TbMLQFgBuBa5lqrYWcNc3HGrqAQ-Au6aqqtRmjgm6r_nUU33VBWmyjUmjlu5z3fAC2S_jIQQRh4ts4cnkGxgH17LzaBQdPHbg7yuWfCXpPBbk9gkvKnJR5CHUTIqjsHTlx9ZWYlvMVQ1HM1Xug61xmfvA9wPbMTBArmcyZpgOhs-2ASzHYTLjkthww0ScIqMxWdRFpKfmvy00WY1xlnC4fA5-ZXmbSsNxnm4xL_8AUE0PwQ==
diff --git a/website/docs/releases/migration-notes.md b/website/docs/releases/migration-notes.md
@@ -24,7 +24,7 @@ const provider = new ElectrumNetworkProvider('mainnet');
 const contract = new Contract(artifact, constructorArgs, { provider });
 ```
 
-#### Transaction Builder Max Fee
+#### Transaction Builder
 Before, the `setMaxFee()` method was used to set the maximum fee for the transaction. This was replaced with the `maximumFeeSatoshis` option in the constructor. Additionally, the `maximumFeeSatsPerByte` option was added.
 
 ```ts
@@ -35,6 +35,8 @@ const builder = new TransactionBuilder({ provider }).setMaxFee(1000n);
 const builder = new TransactionBuilder({ provider, maximumFeeSatoshis: 1000n });
 ```
 
+Addtionally, `transactionBuilder.bitauthUri()` was renamed to `transactionBuilder.getBitauthUri()` for consistency.
+
 #### MockNetworkProvider
 
 Before, the `updateUtxoSet` option was `false` by default for the `MockNetworkProvider`. This is now `true` by default to better match real-world network behaviour.
diff --git a/website/docs/releases/release-notes.md b/website/docs/releases/release-notes.md
@@ -4,7 +4,8 @@ title: Release Notes
 
 ## v0.12.0
 
-#### CashScript SDK`TransactionBuilderOptions` on the constructor.
+#### CashScript SDK
+- :sparkles: Add `getVmResourceUsage` method to `TransactionBuilder`.
 - :sparkles: Add `maximumFeeSatsPerByte` and `allowImplicitFungibleTokenBurn` options to `TransactionBuilder` constructor.
 - :sparkles: Add a configurable `vmTarget` option to `MockNetworkProvider`.
 - :sparkles: Add support for ECDSA signatures in contract unlockers for `sig` and `datasig` parameters.
@@ -14,6 +15,7 @@ title: Release Notes
 - :boom: **BREAKING**: Set `updateUtxoSet` to `true` by default for `MockNetworkProvider`.
 - :boom: **BREAKING**: No longer seed the MockNetworkProvider with any test UTXOs.
 - :boom: **BREAKING**: Replace `setMaxFee()` method on `TransactionBuilder` with
+- :boom: **BREAKING**: Rename `bitauthUri()` method on `TransactionBuilder` to `getBitauthUri()` for consistency.
 - :hammer_and_wrench: Improve libauth template generation.
 - :bug: Fix bug where `SignatureTemplate` would not accept private key hex strings as a signer.
 
@@ -63,6 +65,8 @@ This update adds CashScript support for the new BCH 2025 network upgrade. To rea
 
 This release also contains several breaking changes, please refer to the [migration notes](/docs/releases/migration-notes) for more information.
 
+Thanks [kiok](https://x.com/cypherpunk_bch) for the significant contributions!
+
 #### cashc compiler
 - :bug: Fix bug where source code in `--format ts` artifacts used incorrect quotation marks.
 - :hammer_and_wrench: Remove warning for opcount and update warning for byte size to match new limits.
diff --git a/website/docs/sdk/other-network-providers.md b/website/docs/sdk/other-network-providers.md
@@ -14,7 +14,7 @@ The `MockNetworkProvider` is a special network provider that allows you to evalu
 The `MockNetworkProvider` has extra methods to enable this local emulation such as `.addUtxo()` and `.setBlockHeight()`.
 You can read more about the `MockNetworkProvider` and automated tests on the [testing setup](/docs/sdk/testing-setup) page.
 
-The `updateUtxoSet` option is used to determine whether the UTXO set should be updated after a transaction is sent. If `updateUtxoSet` is `true`, the UTXO set will be updated to reflect the new state of the mock network. If `updateUtxoSet` is `false` (default), the UTXO set will not be updated.
+The `updateUtxoSet` option is used to determine whether the UTXO set should be updated after a transaction is sent. If `updateUtxoSet` is `true` (default), the UTXO set will be updated to reflect the new state of the mock network. If `updateUtxoSet` is `false`, the UTXO set will not be updated.
 
 #### Example
 ```ts
diff --git a/website/docs/sdk/transaction-builder.md b/website/docs/sdk/transaction-builder.md
@@ -243,12 +243,12 @@ transactionBuilder.debug(): DebugResult
 
 If you want to debug a transaction locally instead of sending it to the network, you can call the `debug()` function on the transaction. This will return intermediate values and the final result of the transaction. It will also show any logged values and `require` error messages.
 
-### bitauthUri()
+### getBitauthUri()
 ```ts
-transactionBuilder.bitauthUri(): string
+transactionBuilder.getBitauthUri(): string
 ```
 
-If you prefer a lower-level debugging experience, you can call the `bitauthUri()` function on the transaction. This will return a URI that can be opened in the BitAuth IDE. This URI is also displayed in the console whenever a transaction fails.
+If you prefer a lower-level debugging experience, you can call the `getBitauthUri()` function on the transaction. This will return a URI that can be opened in the BitAuth IDE. This URI is also displayed in the console whenever a transaction fails.
 You can read more about debugging transactions on the [debugging page](/docs/guides/debugging).
 
 :::caution
diff --git a/website/docs/sdk/transactions.md b/website/docs/sdk/transactions.md
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -247,8 +247,7 @@ export class TransactionBuilder {`
`247`	`247`	`return vmResourceUsage;`
`248`	`248`	`}`
`249`	`249`
`250`		`- // TODO: rename to getBitauthUri()`
`251`		`- bitauthUri(): string {`
	`250`	`+ getBitauthUri(): string {`
`252`	`251`	`console.warn('WARNING: it is unsafe to use this Bitauth URI when using real private keys as they are included in the transaction template');`
`253`	`252`	`return getBitauthUri(this.getLibauthTemplate());`
`254`	`253`	`}`
`@@ -273,7 +272,7 @@ export class TransactionBuilder {`
`273`	`272`	`return raw ? await this.getTxDetails(txid, raw) : await this.getTxDetails(txid);`
`274`	`273`	`} catch (e: any) {`
`275`	`274`	`const reason = e.error ?? e.message;`
`276`		`- throw new FailedTransactionError(reason, this.bitauthUri());`
	`275`	`+ throw new FailedTransactionError(reason, this.getBitauthUri());`
`277`	`276`	`}`
`278`	`277`	`}`
`279`	`278`