@meshsdk/transaction 1.8.14 → 1.9.0-beta-39

package/dist/index.d.cts

@@ -1,4 +1,13 @@
-import { Protocol, MintItem, TxIn, Withdrawal, Vote, PubKeyTxIn, RefTxIn, MeshTxBuilderBody, Asset, BuilderData, LanguageVersion, Voter, VotingProcedure, PoolParams, Anchor, DRep, Metadatum, UTxO, UtxoSelectionStrategy, Network, Redeemer, Action, IFetcher, ISubmitter, IEvaluator, IMeshTxSerializer, ScriptSource, SimpleScriptSourceInfo, NativeScript, IInitiator, Recipient, Token, PlutusScript, Budget, Data, Mint } from '@meshsdk/common';
+import { UTxO, TxOutput, Action, Protocol, MintItem, TxIn, Withdrawal, Vote, PubKeyTxIn, RefTxIn, MeshTxBuilderBody, Asset, BuilderData, LanguageVersion, Voter, VotingProcedure, PoolParams, Anchor, DRep, Metadatum, Network, Redeemer, IFetcher, ISubmitter, IEvaluator, IMeshTxSerializer, ScriptSource, SimpleScriptSourceInfo, Certificate, MintParam, Output, NativeScript as NativeScript$1, IInitiator, Recipient, Token, PlutusScript, Budget, Data, Mint } from '@meshsdk/common';
+import { NativeScript } from '@meshsdk/core-cst';
+
+interface TransactionPrototype {
+    newInputs: Set<UTxO>;
+    newOutputs: Set<TxOutput>;
+    change: Array<TxOutput>;
+    fee: bigint;
+    redeemers?: Array<Omit<Action, 'data'>>;
+}
 
 declare class MeshTxBuilderCore {
     txEvaluationMultiplier: number;
@@ -461,11 +470,8 @@ declare class MeshTxBuilderCore {
     /**
      * Selects utxos to fill output value and puts them into inputs
      * @param extraInputs The inputs already placed into the object will remain, these extra inputs will be used to fill the remaining  value needed
-     * @param strategy The strategy to be used in utxo selection
-     * @param threshold Extra value needed to be selected for, usually for paying fees and min UTxO value of change output (default to 5000000)
-     * @param includeTxFees Whether to include transaction fees in the threshold (default to true)
      */
-    selectUtxosFrom: (extraInputs: UTxO[], strategy?: UtxoSelectionStrategy, threshold?: string, includeTxFees?: boolean) => this;
+    selectUtxosFrom: (extraInputs: UTxO[]) => this;
     /**
      * Set the protocol parameters to be used for the transaction other than the default one
      * @param params (Part of) the protocol parameters to be used for the transaction
@@ -484,6 +490,18 @@ declare class MeshTxBuilderCore {
      * @returns The MeshTxBuilder instance
      */
     setNetwork: (network: Network | number[][]) => this;
+    /**
+     * Add a transaction that is used as input, but not yet reflected on the global blockchain
+     * @param txHex The transaction hex of chained transaction
+     * @returns The MeshTxBuilderCore instance
+     */
+    chainTx(txHex: string): this;
+    /**
+     * Add a transaction input to provide information for offline evaluation
+     * @param input The input to be added
+     * @returns The MeshTxBuilderCore instance
+     */
+    inputForEvaluation(input: UTxO): this;
     protected queueAllLastItem: () => void;
     private queueInput;
     private queueMint;
@@ -494,11 +512,13 @@ declare class MeshTxBuilderCore {
         mem: number;
         steps: number;
     }) => Redeemer;
-    protected updateRedeemer: (meshTxBuilderBody: MeshTxBuilderBody, txEvaluation: Omit<Action, "data">[]) => void;
+    protected updateRedeemer: (meshTxBuilderBody: MeshTxBuilderBody, txEvaluation: Omit<Action, "data">[], doNotUseMultiplier?: boolean) => void;
     addUtxosFromSelection: () => void;
     removeDuplicateInputs: () => void;
+    removeDuplicateRefInputs: () => void;
     emptyTxBuilderBody: () => () => MeshTxBuilderBody;
     reset: () => void;
+    protected _cloneCore<T extends MeshTxBuilderCore>(createInstance: () => T): T;
 }
 
 /**
@@ -523,24 +543,39 @@ declare class MeshTxBuilder extends MeshTxBuilderCore {
     submitter?: ISubmitter;
     evaluator?: IEvaluator;
     txHex: string;
+    verbose: boolean;
     protected queriedTxHashes: Set<string>;
     protected queriedUTxOs: {
         [x: string]: UTxO[];
     };
     protected utxosWithRefScripts: UTxO[];
     constructor({ serializer, fetcher, submitter, evaluator, params, isHydra, verbose, }?: MeshTxBuilderOptions);
+    serializeMockTx: () => string;
+    /**
+     * It builds the transaction query the blockchain for missing information
+     * @param customizedTx The optional customized transaction body
+     * @returns The transaction in hex, unbalanced
+     */
+    completeUnbalanced: (customizedTx?: MeshTxBuilderBody) => string;
+    completeSync: (customizedTx?: MeshTxBuilderBody) => string;
     /**
      * It builds the transaction and query the blockchain for missing information
      * @param customizedTx The optional customized transaction body
      * @returns The signed transaction in hex ready to submit / signed by client
      */
     complete: (customizedTx?: Partial<MeshTxBuilderBody>) => Promise<string>;
+    selectUtxos: () => Promise<TransactionPrototype>;
+    updateByTxPrototype: (selectionSkeleton: TransactionPrototype, final?: boolean) => Promise<void>;
+    getUtxosForSelection: () => Promise<UTxO[]>;
+    sortTxParts: () => void;
+    evaluateRedeemers: () => Promise<void>;
+    protected getRedeemerCosts: () => Omit<Action, "data">[];
     /**
      * It builds the transaction without dependencies
      * @param customizedTx The optional customized transaction body
-     * @returns The signed transaction in hex ready to submit / signed by client
+     * @returns The transaction in hex, unbalanced
      */
-    completeSync: (customizedTx?: MeshTxBuilderBody) => string;
+    completeUnbalancedSync: (customizedTx?: MeshTxBuilderBody) => string;
     /**
      * Complete the signing process
      * @returns The signed transaction in hex
@@ -557,7 +592,7 @@ declare class MeshTxBuilder extends MeshTxBuilderCore {
      * @param txHash The TxIn object that contains the txHash and txIndex, while missing amount and address information
      */
     protected getUTxOInfo: (txHash: string) => Promise<void>;
-    protected queryAllTxInfo: (incompleteTxIns: TxIn[], incompleteMints: MintItem[]) => Promise<void[]>;
+    protected queryAllTxInfo: (incompleteTxIns: TxIn[], incompleteScriptSources: ScriptSource[], incompleteSimpleScriptSources: SimpleScriptSourceInfo[]) => Promise<void[]>;
     protected completeTxInformation: (input: TxIn) => void;
     protected completeInputInfo: (input: TxIn) => void;
     protected completeScriptInfo: (scriptSource: ScriptSource) => void;
@@ -566,16 +601,65 @@ declare class MeshTxBuilder extends MeshTxBuilderCore {
     protected isInputInfoComplete: (txIn: TxIn) => boolean;
     protected isMintComplete: (mint: MintItem) => boolean;
     protected isRefScriptInfoComplete: (scriptSource: ScriptSource) => boolean;
+    protected isSimpleRefScriptInfoComplete: (simpleScriptSource: SimpleScriptSourceInfo) => boolean;
+    protected completeSerialization: (customizedTx?: Partial<MeshTxBuilderBody>) => Promise<string>;
+    protected completeTxParts: () => Promise<void>;
+    protected collectAllRequiredSignatures: () => {
+        keyHashes: Set<string>;
+        byronAddresses: Set<string>;
+    };
+    protected getInputsRequiredSignatures(): {
+        paymentCreds: Set<string>;
+        byronAddresses: Set<string>;
+    };
+    protected getWithdrawalRequiredSignatures(): Set<string>;
+    protected getCertificatesRequiredSignatures(): Set<string>;
+    protected getVoteRequiredSignatures(): Set<string>;
+    protected getMintRequiredSignatures: () => Set<string>;
+    protected getTotalWithdrawal: () => bigint;
+    protected getTotalDeposit: () => bigint;
+    protected getTotalRefund: () => bigint;
+    protected getTotalMint: () => Asset[];
+    protected getNativeScriptPubKeys: (nativeScript: NativeScript) => Set<string>;
+    protected getVoteNativeScript: (cert: Vote) => NativeScript | undefined;
+    protected getCertificateNativeScript: (cert: Certificate) => NativeScript | undefined;
+    protected getMintNativeScript: (mint: MintParam) => NativeScript | undefined;
+    protected getWithdrawalNativeScript: (withdrawal: Withdrawal) => NativeScript | undefined;
+    protected getInputNativeScript(txIn: TxIn): NativeScript | undefined;
+    protected getInlinedNativeScript: (txHash: string, index: number) => NativeScript | undefined;
+    protected makeTxId: (txHash: string, index: number) => string;
+    protected getTotalReferenceInputsSize: () => bigint;
+    protected getAllReferenceInputsSizes: () => Map<string, bigint>;
+    protected getBodyReferenceInputsSizes: () => [string, bigint][];
+    protected getInputsReferenceInputsSizes: () => [string, bigint][];
+    protected getMintsReferenceInputsSizes: () => [string, bigint][];
+    protected getWithdrawalsReferenceInputsSizes: () => [string, bigint][];
+    protected getVotesReferenceInputsSizes: () => [string, bigint][];
+    protected getCertificatesReferenceInputsSizes: () => [string, bigint][];
+    getTotalExecutionUnits: () => {
+        memUnits: bigint;
+        stepUnits: bigint;
+    };
+    getSerializedSize: () => number;
+    calculateFee: () => bigint;
+    calculateFeeForSerializedTx: (txSize: number) => bigint;
+    calculateRefScriptFee: () => bigint;
+    calculateRedeemersFee: () => bigint;
+    calculateMinLovelaceForOutput: (output: Output) => bigint;
+    protected clone(): MeshTxBuilder;
 }
 
 declare class ForgeScript {
     static withOneSignature(address: string): string;
-    static fromNativeScript(script: NativeScript): string;
+    static fromNativeScript(script: NativeScript$1): string;
 }
 
 interface TransactionOptions extends MeshTxBuilderOptions {
     initiator: IInitiator;
 }
+/**
+ * Deprecated - Use `MeshTxBuilder` instead
+ */
 declare class Transaction {
     txBuilder: MeshTxBuilder;
     initiator: IInitiator;
@@ -587,7 +671,8 @@ declare class Transaction {
     static readMetadata(cborTx: string): string;
     static writeMetadata(cborTx: string, cborTxMetadata: string): string;
     /**
-     * Adds an output to the transaction.
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
      *
      * @param recipient The recipient of the output.
      * @param assets The assets to send. Provide string for lovelace and Asset[] for tokens and/or lovelace.
@@ -596,7 +681,9 @@ declare class Transaction {
      */
     sendAssets(recipient: Recipient, assets: Asset[] | string): Transaction;
     /**
-     * Suggest deprecated - Adds a transaction output to the transaction.
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
+     *
      * Use sendAssets instead:
      * ```ts
      * this.sendAssets(recipient, lovelace);
@@ -611,7 +698,9 @@ declare class Transaction {
      */
     sendLovelace(recipient: Recipient, lovelace: string): Transaction;
     /**
-     * Suggest deprecated - Adds stable coins transaction output to the transaction.
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
+     *
      * Please use sendAssets with helper function to obtain token unit instead:
      * ```ts
      * const assets = [{ unit: SUPPORTED_TOKENS.GIMBAL, quantity: "100" }]
@@ -628,8 +717,8 @@ declare class Transaction {
      */
     sendToken(recipient: Recipient, ticker: Token, amount: string): Transaction;
     /**
-     * Adds an output to the transaction.
-     * Suggest deprecated - use sendAssets instead:
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
      *
      * ```ts
      * const assets = value.output.amount;
@@ -643,26 +732,35 @@ declare class Transaction {
      */
     sendValue(recipient: Recipient, value: UTxO): Transaction;
     /**
-     * Sets the inputs for the transaction.
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
      *
      * @param {UTxO[]} inputs The inputs to set.
      * @returns {Transaction} The transaction.
      */
     setTxInputs(inputs: UTxO[]): Transaction;
     /**
-     * Sets the reference inputs for the transaction.
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
      *
      * @param {UTxO[]} inputs The reference inputs to set.
      * @returns {Transaction} The transaction.
      */
     setTxRefInputs(inputs: UTxO[]): Transaction;
     /**
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
+     *
      * Sets the native script for the transaction.
      * @param {NativeScript} script The native script to spend from.
      * @param {UTxO} utxo The UTxO attached to the script.
      * @returns {Transaction} The Transaction object.
      */
-    setNativeScriptInput(script: NativeScript, utxo: UTxO): Transaction;
+    setNativeScriptInput(script: NativeScript$1, utxo: UTxO): Transaction;
+    /**
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
+     */
     redeemValue(options: {
         value: UTxO;
         script: PlutusScript | UTxO;
@@ -671,13 +769,24 @@ declare class Transaction {
         };
         datum?: Data | UTxO;
     }): Transaction;
+    /**
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
+     */
     mintAsset(forgeScript: string | PlutusScript | UTxO, mint: Mint, redeemer?: Pick<Action, "data"> & {
         budget?: Budget;
     }): Transaction;
+    /**
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
+     */
     burnAsset(forgeScript: string | PlutusScript | UTxO, asset: Asset, redeemer?: Pick<Action, "data"> & {
         budget?: Budget;
     }): Transaction;
     /**
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
+     *
      * Sets the change address for the transaction.
      *
      * @param {string} changeAddress The change address.
@@ -685,6 +794,9 @@ declare class Transaction {
      */
     setChangeAddress(changeAddress: string): Transaction;
     /**
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
+     *
      * Sets the collateral for the transaction.
      *
      * @param {UTxO[]} collateral - Set the UTxO for collateral.
@@ -692,12 +804,18 @@ declare class Transaction {
      */
     setCollateral(collateral: UTxO[]): Transaction;
     /**
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
+     *
      * Sets the network to use, this is mainly to know the cost models to be used to calculate script integrity hash
      * @param network The specific network this transaction is being built for ("testnet" | "preview" | "preprod" | "mainnet")
      * @returns The Transaction object.
      */
     setNetwork: (network: Network) => this;
     /**
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
+     *
      * Sets the required signers for the transaction.
      *
      * @param {string[]} addresses The addresses of the required signers.
@@ -705,7 +823,10 @@ declare class Transaction {
      */
     setRequiredSigners(addresses: string[]): Transaction;
     /**
-     * Set the time to live for the transaction.
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
+     *
+     *  Set the time to live for the transaction.
      *
      * @param {string} slot The slot number to expire the transaction at.
      * @returns {Transaction} The Transaction object.
@@ -713,7 +834,10 @@ declare class Transaction {
      */
     setTimeToExpire(slot: string): Transaction;
     /**
-     * Sets the start slot for the transaction.
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
+     *
+     *  Sets the start slot for the transaction.
      *
      * @param {string} slot The start slot for the transaction.
      * @returns {Transaction} The Transaction object.
@@ -721,7 +845,10 @@ declare class Transaction {
      */
     setTimeToStart(slot: string): Transaction;
     /**
-     * Add a JSON metadata entry to the transaction.
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
+     *
+     *  Add a JSON metadata entry to the transaction.
      *
      * @param {number} label The label to use for the metadata entry.
      * @param {unknown} metadata The value to use for the metadata entry.
@@ -729,13 +856,37 @@ declare class Transaction {
      * @see {@link https://meshjs.dev/apis/transaction#setMetadata}
      */
     setMetadata(label: number, metadata: Metadatum | object): Transaction;
+    /**
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
+     */
     withdrawRewards(rewardAddress: string, lovelace: string): Transaction;
+    /**
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
+     */
     delegateStake(rewardAddress: string, poolId: string): Transaction;
+    /**
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
+     */
     deregisterStake(rewardAddress: string): Transaction;
+    /**
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
+     */
     registerStake(rewardAddress: string): Transaction;
+    /**
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
+     */
     registerPool(params: PoolParams): Transaction;
+    /**
+     * [Deprecated] - `Transaction` class is on planning for V2.
+     * Use `MeshTxBuilder` instead for tx-building for now.
+     */
     retirePool(poolId: string, epochNo: number): Transaction;
-    build(): Promise<string>;
+    build(balanced?: Boolean): Promise<string>;
     protected mintPlutusScript(script: PlutusScript): MeshTxBuilder;
     protected spendingPlutusScript(script: PlutusScript): MeshTxBuilder;
     private addCollateralIfNeeded;