cashscript 0.13.0-next.4 → 0.13.0-next.6

package/dist/TransactionBuilder.d.ts

@@ -1,5 +1,5 @@
-import { Transaction as LibauthTransaction, WalletTemplate } from '@bitauth/libauth';
-import { Unlocker, Output, TransactionDetails, UnlockableUtxo, Utxo, InputOptions, VmResourceUsage } from './interfaces.js';
+import { WalletTemplate } from '@bitauth/libauth';
+import { Unlocker, Output, TransactionDetails, UnlockableUtxo, Utxo, InputOptions, VmResourceUsage, BchChangeOutputOptions } from './interfaces.js';
 import { NetworkProvider } from './network/index.js';
 import { DebugResults } from './debugging.js';
 import { WcTransactionOptions } from './walletconnect-utils.js';
@@ -23,10 +23,12 @@ export declare class TransactionBuilder {
     addOutput(output: Output): this;
     addOutputs(outputs: Output[]): this;
     addOpReturnOutput(chunks: string[]): this;
+    addBchChangeOutputIfNeeded(changeOutputOptions: BchChangeOutputOptions): this;
+    getTransactionSize(): bigint;
     setLocktime(locktime: number): this;
     private checkMaxFee;
     private checkFungibleTokenBurn;
-    buildLibauthTransaction(): LibauthTransaction;
+    private buildLibauthTransaction;
     build(): string;
     debug(): DebugResults;
     getVmResourceUsage(verbose?: boolean): Array<VmResourceUsage>;

package/dist/TransactionBuilder.js

@@ -1,6 +1,6 @@
 import { binToHex, decodeTransaction, decodeTransactionUnsafe, encodeTransaction, hexToBin, } from '@bitauth/libauth';
 import { isUnlockableUtxo, isStandardUnlockableUtxo, isContractUnlocker, } from './interfaces.js';
-import { cashScriptOutputToLibauthOutput, createOpReturnOutput, delay, generateLibauthSourceOutputs, validateInput, validateOutput, } from './utils.js';
+import { calculateDust, cashScriptOutputToLibauthOutput, createOpReturnOutput, delay, generateLibauthSourceOutputs, getOutputSize, validateInput, validateOutput, } from './utils.js';
 import { FailedTransactionError } from './Errors.js';
 import { debugLibauthTemplate, getLibauthTemplate, getBitauthUri } from './libauth-template/LibauthTemplate.js';
 import { getWcContractInfo } from './walletconnect-utils.js';
@@ -46,6 +46,35 @@ export class TransactionBuilder {
         this.outputs.push(createOpReturnOutput(chunks));
         return this;
     }
+    addBchChangeOutputIfNeeded(changeOutputOptions) {
+        const totalBchInputAmount = this.inputs.reduce((total, input) => total + input.satoshis, 0n);
+        const totalBchOutputAmount = this.outputs.reduce((total, output) => total + output.amount, 0n);
+        const tentativeSurplus = totalBchInputAmount - totalBchOutputAmount;
+        const tentativeTransactionSize = this.getTransactionSize();
+        const tentativeFee = BigInt(Math.ceil(changeOutputOptions.feeRate * Number(tentativeTransactionSize)));
+        const tentativeChangeAmount = tentativeSurplus - tentativeFee;
+        if (tentativeChangeAmount < 0n) {
+            throw new Error(`Transaction does not have enough funds to cover the transaction fee rate of ${changeOutputOptions.feeRate} even without adding a change output. Current surplus: ${tentativeSurplus}, current fee: ${tentativeFee}, current change amount: ${tentativeChangeAmount}`);
+        }
+        const changeOutputSize = getOutputSize({
+            to: changeOutputOptions.to,
+            amount: tentativeSurplus,
+        });
+        const transactionSize = tentativeTransactionSize + BigInt(changeOutputSize);
+        const calculatedFee = BigInt(Math.ceil(changeOutputOptions.feeRate * Number(transactionSize)));
+        const changeAmount = tentativeSurplus - calculatedFee;
+        const changeOutput = { to: changeOutputOptions.to, amount: changeAmount };
+        const changeOutputDust = calculateDust(changeOutput);
+        if (changeAmount < changeOutputDust) {
+            return this;
+        }
+        this.outputs.push(changeOutput);
+        return this;
+    }
+    getTransactionSize() {
+        const transaction = this.buildLibauthTransaction(true);
+        return BigInt(encodeTransaction(transaction).byteLength);
+    }
     setLocktime(locktime) {
         this.locktime = locktime;
         return this;
@@ -87,8 +116,10 @@ export class TransactionBuilder {
             }
         }
     }
-    buildLibauthTransaction() {
-        this.checkFungibleTokenBurn();
+    buildLibauthTransaction(skipChecks = false) {
+        if (!skipChecks) {
+            this.checkFungibleTokenBurn();
+        }
         const inputs = this.inputs.map((utxo) => ({
             outpointIndex: utxo.vout,
             outpointTransactionHash: hexToBin(utxo.txid),
@@ -108,7 +139,9 @@ export class TransactionBuilder {
         inputScripts.forEach((script, i) => {
             transaction.inputs[i].unlockingBytecode = script;
         });
-        this.checkMaxFee(transaction);
+        if (!skipChecks) {
+            this.checkMaxFee(transaction);
+        }
         return transaction;
     }
     build() {
@@ -163,7 +196,8 @@ export class TransactionBuilder {
         return getBitauthUri(this.getLibauthTemplate());
     }
     getLibauthTemplate() {
-        return getLibauthTemplate(this);
+        const libauthTransaction = this.buildLibauthTransaction();
+        return getLibauthTemplate(this, libauthTransaction);
     }
     async send(raw) {
         const tx = this.build();

package/dist/index.d.ts

@@ -9,3 +9,4 @@ export * from './Errors.js';
 export { type NetworkProvider, BitcoinRpcNetworkProvider, ElectrumNetworkProvider, FullStackNetworkProvider, MockNetworkProvider, } from './network/index.js';
 export { randomUtxo, randomToken, randomNFT } from './utils.js';
 export * from './walletconnect-utils.js';
+export { gatherBchUtxos, gatherFungibleTokenUtxos, type GatherUtxosResult } from './transaction-utils.js';

package/dist/index.js

@@ -8,4 +8,5 @@ export * from './Errors.js';
 export { BitcoinRpcNetworkProvider, ElectrumNetworkProvider, FullStackNetworkProvider, MockNetworkProvider, } from './network/index.js';
 export { randomUtxo, randomToken, randomNFT } from './utils.js';
 export * from './walletconnect-utils.js';
+export { gatherBchUtxos, gatherFungibleTokenUtxos } from './transaction-utils.js';
 //# sourceMappingURL=index.js.map

package/dist/interfaces.d.ts

@@ -58,6 +58,10 @@ export interface Output {
     amount: bigint;
     token?: TokenDetails;
 }
+export interface BchChangeOutputOptions {
+    to: string | Uint8Array;
+    feeRate: number;
+}
 export interface TokenDetails {
     amount: bigint;
     category: string;

package/dist/libauth-template/LibauthTemplate.d.ts

@@ -1,6 +1,6 @@
-import { WalletTemplate } from '@bitauth/libauth';
+import { TransactionBch, WalletTemplate } from '@bitauth/libauth';
 import { DebugResults } from '../debugging.js';
 import { TransactionBuilder } from '../TransactionBuilder.js';
-export declare const getLibauthTemplate: (transactionBuilder: TransactionBuilder) => WalletTemplate;
+export declare const getLibauthTemplate: (transactionBuilder: TransactionBuilder, libauthTransaction: TransactionBch) => WalletTemplate;
 export declare const debugLibauthTemplate: (template: WalletTemplate, transaction: TransactionBuilder) => DebugResults;
 export declare const getBitauthUri: (template: WalletTemplate) => string;

package/dist/libauth-template/LibauthTemplate.js

@@ -8,11 +8,10 @@ import { zlibSync } from 'fflate';
 import MockNetworkProvider from '../network/MockNetworkProvider.js';
 import { addHexPrefixExceptEmpty, DEFAULT_VM_TARGET, formatBytecodeForDebugging, formatParametersForDebugging, getLockScriptName, getSignatureAndPubkeyFromP2PKHInput, getUnlockScriptName, serialiseTokenDetails } from './utils.js';
 // TODO: Add / improve descriptions throughout the template generation
-export const getLibauthTemplate = (transactionBuilder) => {
+export const getLibauthTemplate = (transactionBuilder, libauthTransaction) => {
     if (transactionBuilder.inputs.some((input) => !isStandardUnlockableUtxo(input))) {
         throw new Error('Cannot use debugging functionality with a transaction that contains custom unlockers');
     }
-    const libauthTransaction = transactionBuilder.buildLibauthTransaction();
     const vmTarget = transactionBuilder.provider instanceof MockNetworkProvider
         ? transactionBuilder.provider.vmTarget
         : DEFAULT_VM_TARGET;

package/dist/libauth-template/utils.js

@@ -64,7 +64,7 @@ export const formatBytecodeForDebugging = (artifact) => {
             .map((asmElement) => (isHex(asmElement) ? `<0x${asmElement}>` : asmElement))
             .join('\n');
     }
-    return formatBitAuthScript(bytecodeToScript(hexToBin(artifact.debug.bytecode)), artifact.debug.sourceMap, artifact.source);
+    return formatBitAuthScript(bytecodeToScript(hexToBin(artifact.debug.bytecode)), artifact.debug.sourceMap, artifact.source, artifact.debug.sourceTags);
 };
 export const serialiseTokenDetails = (token) => {
     if (!token)

package/dist/network/MockNetworkProvider.d.ts

@@ -1,14 +1,14 @@
 import { Utxo, Network, VmTarget } from '../interfaces.js';
 import NetworkProvider from './NetworkProvider.js';
 export interface MockNetworkProviderOptions {
-    updateUtxoSet: boolean;
+    updateUtxoSet?: boolean;
     vmTarget?: VmTarget;
 }
 export default class MockNetworkProvider implements NetworkProvider {
     private utxoSet;
     private transactionMap;
+    private blockHeight;
     network: Network;
-    blockHeight: number;
     options: MockNetworkProviderOptions;
     vmTarget: VmTarget;
     constructor(options?: Partial<MockNetworkProviderOptions>);

package/dist/network/MockNetworkProvider.js

@@ -8,8 +8,8 @@ export default class MockNetworkProvider {
         // we use lockingBytecode hex as the key for utxoMap to make cash addresses and token addresses interchangeable
         this.utxoSet = [];
         this.transactionMap = {};
-        this.network = Network.MOCKNET;
         this.blockHeight = 133700;
+        this.network = Network.MOCKNET;
         this.options = { updateUtxoSet: true, ...options };
         this.vmTarget = this.options.vmTarget ?? DEFAULT_VM_TARGET;
     }

package/dist/transaction-utils.d.ts

@@ -0,0 +1,7 @@
+import { Utxo } from './interfaces.js';
+export interface GatherUtxosResult {
+    utxos: Utxo[];
+    totalAmount: bigint;
+}
+export declare function gatherBchUtxos(utxos: Utxo[], amount: bigint): GatherUtxosResult;
+export declare function gatherFungibleTokenUtxos(utxos: Utxo[], tokenCategory: string, amount: bigint): GatherUtxosResult;

package/dist/transaction-utils.js

@@ -0,0 +1,36 @@
+import { isFungibleTokenUtxo, isNonTokenUtxo } from './utils.js';
+export function gatherBchUtxos(utxos, amount) {
+    const sortedBchUtxos = utxos
+        .filter(isNonTokenUtxo)
+        .toSorted((a, b) => Number(b.satoshis - a.satoshis));
+    const targetUtxos = [];
+    let total = 0n;
+    for (const utxo of sortedBchUtxos) {
+        if (total >= amount)
+            break;
+        total += utxo.satoshis;
+        targetUtxos.push(utxo);
+    }
+    if (total < amount) {
+        throw new Error('Not enough funds to cover the required amount');
+    }
+    return { utxos: targetUtxos, totalAmount: total };
+}
+export function gatherFungibleTokenUtxos(utxos, tokenCategory, amount) {
+    const sortedTokenUtxos = utxos
+        .filter((utxo) => isFungibleTokenUtxo(utxo) && utxo.token.category === tokenCategory)
+        .toSorted((a, b) => Number(b.token.amount - a.token.amount));
+    const targetUtxos = [];
+    let total = 0n;
+    for (const utxo of sortedTokenUtxos) {
+        if (total >= amount)
+            break;
+        total += utxo.token.amount;
+        targetUtxos.push(utxo);
+    }
+    if (total < amount) {
+        throw new Error('Not enough fungible tokens to cover the required amount');
+    }
+    return { utxos: targetUtxos, totalAmount: total };
+}
+//# sourceMappingURL=transaction-utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cashscript",
-  "version": "0.13.0-next.4",
+  "version": "0.13.0-next.6",
   "description": "Easily write and interact with Bitcoin Cash contracts",
   "keywords": [
     "bitcoin cash",
@@ -42,7 +42,7 @@
   },
   "dependencies": {
     "@bitauth/libauth": "^3.1.0-next.8",
-    "@cashscript/utils": "^0.13.0-next.4",
+    "@cashscript/utils": "^0.13.0-next.6",
     "@electrum-cash/network": "^4.1.3",
     "@mr-zwets/bchn-api-wrapper": "^1.0.1",
     "fflate": "^0.8.2",
@@ -56,5 +56,5 @@
     "typescript": "^5.9.2",
     "vitest": "^4.0.15"
   },
-  "gitHead": "a9b4062bda82a2d80adf1bf21b846a62d7592e5b"
+  "gitHead": "c204d0ccadc16bbce1206cf00c0960c254ce3af0"
 }