@meshsdk/transaction 1.6.2 → 1.6.3

package/dist/index.d.cts

@@ -221,18 +221,17 @@ declare class MeshTxBuilderCore {
     withdrawalPlutusScriptV3: () => this;
     /**
      * Withdraw stake rewards in the MeshTxBuilder instance
-     * @param stakeAddress The address corresponding to the stake key
+     * @param rewardAddress The bech32 reward address (i.e. start with `stake_xxxxx`)
      * @param coin The amount of lovelaces in the withdrawal
      * @returns The MeshTxBuilder instance
      */
-    withdrawal: (stakeAddress: string, coin: string) => this;
+    withdrawal: (rewardAddress: string, coin: string) => this;
     /**
      * Add a withdrawal script to the MeshTxBuilder instance
      * @param scriptCbor The script in CBOR format
-     * @param version The language version
      * @returns The MeshTxBuilder instance
      */
-    withdrawalScript: (scriptCbor: string, version: LanguageVersion) => this;
+    withdrawalScript: (scriptCbor: string) => this;
     /**
      * Add a withdrawal reference to the MeshTxBuilder instance
      * @param txHash The transaction hash of reference UTxO
@@ -241,7 +240,7 @@ declare class MeshTxBuilderCore {
      * @param scriptSize The script size of the withdrawal script
      * @returns The MeshTxBuilder instance
      */
-    withdrawalTxInReference: (txHash: string, txIndex: number, withdrawalScriptHash?: string, scriptSize?: string) => void;
+    withdrawalTxInReference: (txHash: string, txIndex: number, withdrawalScriptHash?: string, scriptSize?: string) => this;
     /**
      * Set the transaction withdrawal redeemer value in the MeshTxBuilder instance
      * @param redeemer The redeemer in Mesh Data type, JSON in raw constructor like format, or CBOR hex string
@@ -261,24 +260,24 @@ declare class MeshTxBuilderCore {
     registerPoolCertificate: (poolParams: PoolParams) => this;
     /**
      * Creates a stake registration certificate, and adds it to the transaction
-     * @param stakeKeyHash The keyHash of the stake key
+     * @param rewardAddress The bech32 reward address (i.e. start with `stake_xxxxx`)
      * @returns The MeshTxBuilder instance
      */
-    registerStakeCertificate: (stakeKeyHash: string) => this;
+    registerStakeCertificate: (rewardAddress: string) => this;
     /**
      * Creates a stake delegation certificate, and adds it to the transaction
      * This will delegate stake from the corresponding stake address to the pool
-     * @param stakeKeyHash The keyHash of the stake key
+     * @param rewardAddress The bech32 reward address (i.e. start with `stake_xxxxx`)
      * @param poolId poolId can be in either bech32 or hex form
      * @returns The MeshTxBuilder instance
      */
-    delegateStakeCertificate: (stakeKeyHash: string, poolId: string) => this;
+    delegateStakeCertificate: (rewardAddress: string, poolId: string) => this;
     /**
      * Creates a stake deregister certificate, and adds it to the transaction
-     * @param stakeKeyHash The keyHash of the stake key
+     * @param rewardAddress The bech32 reward address (i.e. start with `stake_xxxxx`)
      * @returns The MeshTxBuilder instance
      */
-    deregisterStakeCertificate: (stakeKeyHash: string) => this;
+    deregisterStakeCertificate: (rewardAddress: string) => this;
     /**
      * Creates a pool retire certificate, and adds it to the transaction
      * @param poolId poolId can be in either bech32 or hex form
@@ -286,6 +285,25 @@ declare class MeshTxBuilderCore {
      * @returns The MeshTxBuilder instance
      */
     retirePoolCertificate: (poolId: string, epoch: number) => this;
+    /**
+     * Adds a script witness to the certificate
+     * @param scriptCbor The CborHex of the script
+     * @param version Optional - The plutus version of the script, null version implies Native Script
+     */
+    certificateScript: (scriptCbor: string, version?: LanguageVersion) => this;
+    /**
+     * Adds a script witness to the certificate
+     * @param txHash The transaction hash of the reference UTxO
+     * @param txIndex The transaction index of the reference UTxO
+     * @param spendingScriptHash The script hash of the spending script
+     * @param version Optional - The plutus version of the script, null version implies Native Script
+     * @param scriptSize The size of the plutus script referenced
+     */
+    certificateTxInReference: (txHash: string, txIndex: number, spendingScriptHash: string, version?: LanguageVersion, scriptSize?: string) => this;
+    certificateRedeemerValue: (redeemer: BuilderData["content"], type?: BuilderData["type"], exUnits?: {
+        mem: number;
+        steps: number;
+    }) => this;
     /**
      * Configure the address to accept change UTxO
      * @param addr The address to accept change UTxO
@@ -346,6 +364,13 @@ declare class MeshTxBuilderCore {
     reset: () => void;
 }
 
+/**
+ * Convert UTxO to TxIn parameters in array for MeshTxBuilder
+ * @param utxo UTxO
+ * @returns [txHash, outputIndex, amount, address]
+ */
+declare const utxoToTxIn: (utxo: UTxO) => [string, number, Asset[], string];
+
 interface MeshTxBuilderOptions {
     fetcher?: IFetcher;
     submitter?: ISubmitter;
@@ -562,4 +587,4 @@ declare class Transaction {
     private addChangeAddress;
 }
 
-export { ForgeScript, MeshTxBuilder, type MeshTxBuilderOptions, Transaction, type TransactionOptions };
+export { ForgeScript, MeshTxBuilder, type MeshTxBuilderOptions, Transaction, type TransactionOptions, utxoToTxIn };

package/dist/index.d.ts

@@ -221,18 +221,17 @@ declare class MeshTxBuilderCore {
     withdrawalPlutusScriptV3: () => this;
     /**
      * Withdraw stake rewards in the MeshTxBuilder instance
-     * @param stakeAddress The address corresponding to the stake key
+     * @param rewardAddress The bech32 reward address (i.e. start with `stake_xxxxx`)
      * @param coin The amount of lovelaces in the withdrawal
      * @returns The MeshTxBuilder instance
      */
-    withdrawal: (stakeAddress: string, coin: string) => this;
+    withdrawal: (rewardAddress: string, coin: string) => this;
     /**
      * Add a withdrawal script to the MeshTxBuilder instance
      * @param scriptCbor The script in CBOR format
-     * @param version The language version
      * @returns The MeshTxBuilder instance
      */
-    withdrawalScript: (scriptCbor: string, version: LanguageVersion) => this;
+    withdrawalScript: (scriptCbor: string) => this;
     /**
      * Add a withdrawal reference to the MeshTxBuilder instance
      * @param txHash The transaction hash of reference UTxO
@@ -241,7 +240,7 @@ declare class MeshTxBuilderCore {
      * @param scriptSize The script size of the withdrawal script
      * @returns The MeshTxBuilder instance
      */
-    withdrawalTxInReference: (txHash: string, txIndex: number, withdrawalScriptHash?: string, scriptSize?: string) => void;
+    withdrawalTxInReference: (txHash: string, txIndex: number, withdrawalScriptHash?: string, scriptSize?: string) => this;
     /**
      * Set the transaction withdrawal redeemer value in the MeshTxBuilder instance
      * @param redeemer The redeemer in Mesh Data type, JSON in raw constructor like format, or CBOR hex string
@@ -261,24 +260,24 @@ declare class MeshTxBuilderCore {
     registerPoolCertificate: (poolParams: PoolParams) => this;
     /**
      * Creates a stake registration certificate, and adds it to the transaction
-     * @param stakeKeyHash The keyHash of the stake key
+     * @param rewardAddress The bech32 reward address (i.e. start with `stake_xxxxx`)
      * @returns The MeshTxBuilder instance
      */
-    registerStakeCertificate: (stakeKeyHash: string) => this;
+    registerStakeCertificate: (rewardAddress: string) => this;
     /**
      * Creates a stake delegation certificate, and adds it to the transaction
      * This will delegate stake from the corresponding stake address to the pool
-     * @param stakeKeyHash The keyHash of the stake key
+     * @param rewardAddress The bech32 reward address (i.e. start with `stake_xxxxx`)
      * @param poolId poolId can be in either bech32 or hex form
      * @returns The MeshTxBuilder instance
      */
-    delegateStakeCertificate: (stakeKeyHash: string, poolId: string) => this;
+    delegateStakeCertificate: (rewardAddress: string, poolId: string) => this;
     /**
      * Creates a stake deregister certificate, and adds it to the transaction
-     * @param stakeKeyHash The keyHash of the stake key
+     * @param rewardAddress The bech32 reward address (i.e. start with `stake_xxxxx`)
      * @returns The MeshTxBuilder instance
      */
-    deregisterStakeCertificate: (stakeKeyHash: string) => this;
+    deregisterStakeCertificate: (rewardAddress: string) => this;
     /**
      * Creates a pool retire certificate, and adds it to the transaction
      * @param poolId poolId can be in either bech32 or hex form
@@ -286,6 +285,25 @@ declare class MeshTxBuilderCore {
      * @returns The MeshTxBuilder instance
      */
     retirePoolCertificate: (poolId: string, epoch: number) => this;
+    /**
+     * Adds a script witness to the certificate
+     * @param scriptCbor The CborHex of the script
+     * @param version Optional - The plutus version of the script, null version implies Native Script
+     */
+    certificateScript: (scriptCbor: string, version?: LanguageVersion) => this;
+    /**
+     * Adds a script witness to the certificate
+     * @param txHash The transaction hash of the reference UTxO
+     * @param txIndex The transaction index of the reference UTxO
+     * @param spendingScriptHash The script hash of the spending script
+     * @param version Optional - The plutus version of the script, null version implies Native Script
+     * @param scriptSize The size of the plutus script referenced
+     */
+    certificateTxInReference: (txHash: string, txIndex: number, spendingScriptHash: string, version?: LanguageVersion, scriptSize?: string) => this;
+    certificateRedeemerValue: (redeemer: BuilderData["content"], type?: BuilderData["type"], exUnits?: {
+        mem: number;
+        steps: number;
+    }) => this;
     /**
      * Configure the address to accept change UTxO
      * @param addr The address to accept change UTxO
@@ -346,6 +364,13 @@ declare class MeshTxBuilderCore {
     reset: () => void;
 }
 
+/**
+ * Convert UTxO to TxIn parameters in array for MeshTxBuilder
+ * @param utxo UTxO
+ * @returns [txHash, outputIndex, amount, address]
+ */
+declare const utxoToTxIn: (utxo: UTxO) => [string, number, Asset[], string];
+
 interface MeshTxBuilderOptions {
     fetcher?: IFetcher;
     submitter?: ISubmitter;
@@ -562,4 +587,4 @@ declare class Transaction {
     private addChangeAddress;
 }
 
-export { ForgeScript, MeshTxBuilder, type MeshTxBuilderOptions, Transaction, type TransactionOptions };
+export { ForgeScript, MeshTxBuilder, type MeshTxBuilderOptions, Transaction, type TransactionOptions, utxoToTxIn };