cashscript 0.10.1 → 0.11.0-next.0

package/README.md

@@ -31,7 +31,7 @@ Using the CashScript SDK, you can import contract artifact files, create new ins
 ```ts
 ...
   // Import the P2PKH artifact
-  import P2PKH from './p2pkh-artifact.json' assert { type: 'json' };
+  import P2PKH from './p2pkh-artifact.json' with { type: 'json' };
 
   // Instantiate a network provider for CashScript's network operations
   const provider = new ElectrumNetworkProvider('mainnet');

package/dist/Transaction.js

@@ -1,9 +1,8 @@
-import bip68 from 'bip68';
 import { hexToBin, decodeTransaction, } from '@bitauth/libauth';
 import delay from 'delay';
-import { placeholder, scriptToBytecode, } from '@cashscript/utils';
+import { encodeBip68, placeholder, scriptToBytecode, } from '@cashscript/utils';
 import deepEqual from 'fast-deep-equal';
-import { isUtxoP2PKH, } from './interfaces.js';
+import { isUtxoP2PKH, SignatureAlgorithm, } from './interfaces.js';
 import { createInputScript, getInputSize, createOpReturnOutput, getTxSizeWithoutInputs, getPreimageSize, validateOutput, utxoComparator, calculateDust, getOutputSize, utxoTokenComparator, } from './utils.js';
 import SignatureTemplate from './SignatureTemplate.js';
 import { P2PKH_INPUT_SIZE } from './constants.js';
@@ -57,7 +56,7 @@ export class Transaction {
         return this;
     }
     withAge(age) {
-        this.sequence = bip68.encode({ blocks: age });
+        this.sequence = encodeBip68({ blocks: age });
         return this;
     }
     withTime(time) {
@@ -248,8 +247,18 @@ export class Transaction {
                 }
             }
         }
-        // Replace all SignatureTemplate with 65-length placeholder Uint8Arrays
-        const placeholderArgs = this.encodedFunctionArgs.map((arg) => (arg instanceof SignatureTemplate ? placeholder(65) : arg));
+        // Replace all SignatureTemplate with placeholder Uint8Arrays
+        const placeholderArgs = this.encodedFunctionArgs.map((arg) => {
+            if (!(arg instanceof SignatureTemplate))
+                return arg;
+            // Schnorr signatures are *always* 65 bytes: 64 for signature + 1 byte for hashtype.
+            if (arg.getSignatureAlgorithm() === SignatureAlgorithm.SCHNORR)
+                return placeholder(65);
+            // ECDSA signatures are at least 71 bytes: 64 bytes for signature + 1 byte for hashtype + 6 bytes for encoding
+            // overhead. But it may have up to 2 extra bytes for padding, so we overestimate by 2 bytes.
+            // (see https://transactionfee.info/charts/bitcoin-script-ecdsa-length/)
+            return placeholder(73);
+        });
         // Create a placeholder preimage of the correct size
         const placeholderPreimage = this.abiFunction.covenant
             ? placeholder(getPreimageSize(scriptToBytecode(this.contract.redeemScript)))

package/dist/debugging.js

@@ -1,4 +1,4 @@
-import { AuthenticationErrorCommon, binToHex, createCompiler, createVirtualMachineBCH2023, encodeAuthenticationInstruction, walletTemplateToCompilerConfiguration } from '@bitauth/libauth';
+import { AuthenticationErrorCommon, binToHex, createCompiler, createVirtualMachineBch2025, encodeAuthenticationInstruction, walletTemplateToCompilerConfiguration } from '@bitauth/libauth';
 import { Op, PrimitiveType, bytecodeToAsm, decodeBool, decodeInt, decodeString } from '@cashscript/utils';
 import { findLastIndex, toRegExp } from './utils.js';
 import { FailedRequireError, FailedTransactionError, FailedTransactionEvaluationError } from './Errors.js';
@@ -39,7 +39,7 @@ export const debugTemplate = (template, artifact) => {
         // preceding OP_CHECKSIG opcode. The error message is registered in the next instruction, so we need to increment
         // the instruction pointer to get the correct error message from the require messages in the artifact.
         // Note that we do NOT use this adjusted IP when passing the failing IP into the FailedRequireError
-        const isNullFail = lastExecutedDebugStep.error === AuthenticationErrorCommon.nonNullSignatureFailure;
+        const isNullFail = lastExecutedDebugStep.error.includes(AuthenticationErrorCommon.nonNullSignatureFailure);
         const requireStatementIp = failingIp + (isNullFail ? 1 : 0);
         const requireStatement = (artifact.debug?.requires ?? [])
             .find((statement) => statement.ip === requireStatementIp);
@@ -74,7 +74,7 @@ export const debugTemplate = (template, artifact) => {
 // internal util. instantiates the virtual machine and compiles the template into a program
 const createProgram = (template) => {
     const configuration = walletTemplateToCompilerConfiguration(template);
-    const vm = createVirtualMachineBCH2023();
+    const vm = createVirtualMachineBch2025();
     const compiler = createCompiler(configuration);
     const scenarioGeneration = compiler.generateScenario({
         debug: true,
@@ -121,8 +121,9 @@ const failedFinalVerify = (evaluationResult) => {
     // If any of the following errors occurred, then the final verify failed - any other messages
     // indicate other kinds of failures
     return toRegExp([
-        AuthenticationErrorCommon.requiresCleanStack,
-        AuthenticationErrorCommon.nonEmptyControlStack,
+        // TODO: Ask Jason to put these back into an enum and replace with the enum value
+        'The CashAssembly internal evaluation completed with an unexpected number of items on the stack (must be exactly 1).', // AuthenticationErrorCommon.requiresCleanStack,
+        'The CashAssembly internal evaluation completed with a non-empty control stack.', // AuthenticationErrorCommon.nonEmptyControlStack,
         AuthenticationErrorCommon.unsuccessfulEvaluation,
     ]).test(evaluationResult);
 };

package/dist/network/BitcoinRpcNetworkProvider.d.ts

@@ -1,40 +1,16 @@
 import { Utxo, Network } from '../interfaces.js';
 import NetworkProvider from './NetworkProvider.js';
+import { BchnRpcClient } from '@mr-zwets/bchn-api-wrapper';
 export default class BitcoinRpcNetworkProvider implements NetworkProvider {
     network: Network;
     private rpcClient;
-    constructor(network: Network, url: string, opts?: object);
+    constructor(network: Network, url: string, opts: {
+        rpcUser: string;
+        rpcPassword: string;
+    });
     getUtxos(address: string): Promise<Utxo[]>;
     getBlockHeight(): Promise<number>;
     getRawTransaction(txid: string): Promise<string>;
     sendRawTransaction(txHex: string): Promise<string>;
-    getClient(): IRpcClientRetry;
+    getClient(): BchnRpcClient;
 }
-interface ListUnspentItem {
-    txid: string;
-    vout: number;
-    address: string;
-    label: string;
-    scriptPubKey: string;
-    amount: number;
-    confirmations: number;
-    redeemScript: string;
-    spendable: boolean;
-    solvable: boolean;
-    safe: boolean;
-}
-interface IRpcClientRetry {
-    constructor(url: string, opts?: object): void;
-    listUnspent(minConf?: number, maxConf?: number, addresses?: string[], includeUnsafe?: boolean, queryOptions?: object): Promise<ListUnspentItem[]>;
-    getBlockCount(): Promise<number>;
-    getRawTransaction(txid: string, verbose?: boolean, blockHash?: string): Promise<string>;
-    sendRawTransaction(hexString: string, allowHighFees?: boolean): Promise<string>;
-    generate(nBlocks: number, maxTries?: number): Promise<string[]>;
-    generateToAddress(nBlocks: number, address: string, maxTries?: number): Promise<string[]>;
-    getNewAddress(label?: string): Promise<string>;
-    dumpPrivKey(address: string): Promise<string>;
-    getBalance(dummy?: string, minConf?: number, includeWatchOnly?: boolean): Promise<number>;
-    getBlock(blockHash: string, verbosity?: number): Promise<string>;
-    importAddress(address: string, label?: string, rescan?: boolean, p2sh?: boolean): Promise<void>;
-}
-export {};

package/dist/network/BitcoinRpcNetworkProvider.js

@@ -1,11 +1,11 @@
-import RpcClientRetry from 'bitcoin-rpc-promise-retry';
+import { BchnRpcClient, } from '@mr-zwets/bchn-api-wrapper';
 export default class BitcoinRpcNetworkProvider {
     constructor(network, url, opts) {
         this.network = network;
-        this.rpcClient = new RpcClientRetry(url, opts);
+        this.rpcClient = new BchnRpcClient({ url, ...opts });
     }
     async getUtxos(address) {
-        const result = await this.rpcClient.listUnspent(0, 9999999, [address]);
+        const result = await this.rpcClient.request('listunspent', 0, 9999999, [address]);
         const utxos = result.map((utxo) => ({
             txid: utxo.txid,
             vout: utxo.vout,
@@ -14,13 +14,13 @@ export default class BitcoinRpcNetworkProvider {
         return utxos;
     }
     async getBlockHeight() {
-        return this.rpcClient.getBlockCount();
+        return this.rpcClient.request('getblockcount');
     }
     async getRawTransaction(txid) {
-        return this.rpcClient.getRawTransaction(txid);
+        return this.rpcClient.request('getrawtransaction', txid, 0);
     }
     async sendRawTransaction(txHex) {
-        return this.rpcClient.sendRawTransaction(txHex);
+        return this.rpcClient.request('sendrawtransaction', txHex);
     }
     getClient() {
         return this.rpcClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cashscript",
-  "version": "0.10.1",
+  "version": "0.11.0-next.0",
   "description": "Easily write and interact with Bitcoin Cash contracts",
   "keywords": [
     "bitcoin cash",
@@ -43,10 +43,9 @@
     "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' jest"
   },
   "dependencies": {
-    "@bitauth/libauth": "^3.0.0",
-    "@cashscript/utils": "^0.10.1",
-    "bip68": "^1.0.4",
-    "bitcoin-rpc-promise-retry": "^1.3.0",
+    "@bitauth/libauth": "^3.1.0-next.2",
+    "@cashscript/utils": "^0.11.0-next.0",
+    "@mr-zwets/bchn-api-wrapper": "^1.0.1",
     "delay": "^5.0.0",
     "electrum-cash": "^2.0.10",
     "fast-deep-equal": "^3.1.3",
@@ -54,12 +53,11 @@
   },
   "devDependencies": {
     "@jest/globals": "^29.4.1",
-    "@psf/bch-js": "^4.15.0",
+    "@psf/bch-js": "^6.8.0",
     "@types/pako": "^2.0.3",
-    "bip39": "^3.0.4",
     "eslint": "^8.54.0",
     "jest": "^29.4.1",
     "typescript": "^5.5.4"
   },
-  "gitHead": "0dd95d5b05a438ac1884bdb2252aec6a4c77e5b2"
+  "gitHead": "18df35aa3276e64fa64e92386106374d1d35b28d"
 }