cashscript 0.10.0 → 0.10.2

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/LibauthTemplate.js

@@ -38,7 +38,7 @@ export const buildTemplate = async ({ transaction, transactionHex = undefined, /
             },
         };
         // add extra unlocking and locking script for P2PKH inputs spent alongside our contract
-        // this is needed for correct cross-referrences in the template
+        // this is needed for correct cross-references in the template
         template.scripts[unlockScriptName] = {
             name: unlockScriptName,
             script: `<${signatureString}>\n<${placeholderKeyName}.public_key>`,
@@ -175,7 +175,7 @@ const generateTemplateScenarioTransaction = (contract, libauthTransaction, csTra
             outpointIndex: input.outpointIndex,
             outpointTransactionHash: binToHex(input.outpointTransactionHash),
             sequenceNumber: input.sequenceNumber,
-            unlockingBytecode: generateTemplateScenarioBytecode(csInput, `p2pkh_placeholder_unlock_${index}`, index === slotIndex),
+            unlockingBytecode: generateTemplateScenarioBytecode(csInput, `p2pkh_placeholder_unlock_${index}`, `placeholder_key_${index}`, index === slotIndex),
         };
     });
     const locktime = libauthTransaction.locktime;
@@ -201,21 +201,21 @@ const generateTemplateScenarioSourceOutputs = (csTransaction) => {
     const slotIndex = csTransaction.inputs.findIndex((input) => !isUtxoP2PKH(input));
     return csTransaction.inputs.map((input, index) => {
         return {
-            lockingBytecode: generateTemplateScenarioBytecode(input, `p2pkh_placeholder_lock_${index}`, index === slotIndex),
+            lockingBytecode: generateTemplateScenarioBytecode(input, `p2pkh_placeholder_lock_${index}`, `placeholder_key_${index}`, index === slotIndex),
             valueSatoshis: Number(input.satoshis),
             token: serialiseTokenDetails(input.token),
         };
     });
 };
 // Used for generating the locking / unlocking bytecode for source outputs and inputs
-const generateTemplateScenarioBytecode = (input, p2pkhScriptName, insertSlot) => {
+const generateTemplateScenarioBytecode = (input, p2pkhScriptName, placeholderKeyName, insertSlot) => {
     if (isUtxoP2PKH(input)) {
         return {
             script: p2pkhScriptName,
             overrides: {
                 keys: {
                     privateKeys: {
-                        placeholder_key: binToHex(input.template.privateKey),
+                        [placeholderKeyName]: binToHex(input.template.privateKey),
                     },
                 },
             },

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) {
@@ -191,7 +190,7 @@ export class Transaction {
             // Compare nfts in- and outputs, check if inputs have nfts corresponding to outputs
             // Keep list of nfts in inputs without matching output
             // First check immutable nfts, then mutable & minting nfts together
-            // This is so an immutible input gets matched first and is removed from the list of unused nfts
+            // This is so an immutable input gets matched first and is removed from the list of unused nfts
             let unusedNfts = listNftsInputs;
             for (const nftInput of listNftsInputs) {
                 if (nftInput.capability === 'none') {
@@ -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/TransactionBuilder.js

@@ -17,7 +17,7 @@ export class TransactionBuilder {
     addInputs(utxos, unlocker, options) {
         if ((!unlocker && utxos.some((utxo) => !isUnlockableUtxo(utxo)))
             || (unlocker && utxos.some((utxo) => isUnlockableUtxo(utxo)))) {
-            throw new Error('Either all UTXOs must have an individual unlocker speciifed, or no UTXOs must have an individual unlocker specified and a shared unlocker must be provided');
+            throw new Error('Either all UTXOs must have an individual unlocker specified, or no UTXOs must have an individual unlocker specified and a shared unlocker must be provided');
         }
         if (!unlocker) {
             this.inputs = this.inputs.concat(utxos);

package/dist/interfaces.d.ts

@@ -80,6 +80,7 @@ export declare const Network: {
     TESTNET3: "testnet3";
     TESTNET4: "testnet4";
     CHIPNET: "chipnet";
+    MOCKNET: "mocknet";
     REGTEST: "regtest";
 };
 export type Network = (typeof Network)[keyof typeof Network];

package/dist/interfaces.js

@@ -25,6 +25,7 @@ export const Network = {
     TESTNET3: literal('testnet3'),
     TESTNET4: literal('testnet4'),
     CHIPNET: literal('chipnet'),
+    MOCKNET: literal('mocknet'),
     REGTEST: literal('regtest'),
 };
 //# sourceMappingURL=interfaces.js.map

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/dist/network/MockNetworkProvider.js

@@ -10,7 +10,7 @@ export default class MockNetworkProvider {
     constructor() {
         this.utxoMap = {};
         this.transactionMap = {};
-        this.network = Network.CHIPNET;
+        this.network = Network.MOCKNET;
         for (let i = 0; i < 3; i += 1) {
             this.addUtxo(aliceAddress, randomUtxo());
             this.addUtxo(bobAddress, randomUtxo());

package/dist/utils.js

@@ -197,6 +197,7 @@ export function getNetworkPrefix(network) {
         case Network.TESTNET4:
         case Network.TESTNET3:
         case Network.CHIPNET:
+        case Network.MOCKNET:
             return 'bchtest';
         case Network.REGTEST:
             return 'bchreg';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cashscript",
-  "version": "0.10.0",
+  "version": "0.10.2",
   "description": "Easily write and interact with Bitcoin Cash contracts",
   "keywords": [
     "bitcoin cash",
@@ -44,9 +44,8 @@
   },
   "dependencies": {
     "@bitauth/libauth": "^3.0.0",
-    "@cashscript/utils": "^0.10.0",
-    "bip68": "^1.0.4",
-    "bitcoin-rpc-promise-retry": "^1.3.0",
+    "@cashscript/utils": "^0.10.2",
+    "@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": "cd3031b60dc4ca2d2351608dfd838a50bcc7bbb9"
+  "gitHead": "a7c4f652462ddfccd54fc929f06cb16022769df9"
 }