@scure/btc-signer 2.2.0 → 2.4.0

package/transaction.d.ts

@@ -74,6 +74,8 @@ export declare const def: <T>(value: T | undefined, def: T) => T;
  * ```
  */
 export declare function cloneDeep<T>(obj: T): T;
+/** PSBT unknown/proprietary-field handling policy. */
+export type Unknowns = psbt.Unknowns;
 /** Transaction construction and parsing options. */
 export interface TxOpts {
     /** Transaction version to place into new transactions and imported PSBTs. */
@@ -98,17 +100,36 @@ export interface TxOpts {
     allowUnknowInput?: boolean;
     /** Allow signing and finalizing inputs with unknown script shapes. */
     allowUnknownInputs?: boolean;
-    /** Skip redeem-script and witness-script consistency checks. */
+    /** Skip redeem/witness-script and Taproot commitment consistency checks. */
     disableScriptCheck?: boolean;
     /** Match the odd empty-output encoding used by `bip174js`. */
     bip174jsCompat?: boolean;
     /** Permit legacy inputs that only provide witness UTXO data. */
     allowLegacyWitnessUtxo?: boolean;
+    /**
+     * Before signing, require every input to provide a full previous transaction whose txid and
+     * selected output match the input. Use this for untrusted or multi-party PSBTs to prevent forged
+     * witness-UTXO amounts from hiding an excessive transaction fee.
+     */
+    strictPrevoutValidation?: boolean;
     /** Grind ECDSA signatures until they use a low-R encoding. */
     lowR?: boolean;
     /** UNSAFE: additional custom payment-script codecs and finalizers. */
     customScripts?: CustomScript[];
-    /** Preserve unknown PSBT key/value pairs instead of stripping them. */
+    /** Unknown PSBT field policy. Defaults to `strip`. */
+    unknown?: Unknowns;
+    /** Proprietary PSBT field policy. Defaults to the resolved {@link unknown} policy. */
+    proprietary?: Unknowns;
+    /**
+     * Treat an absent PSBTv2 transaction-modifiable field as allowing input/output changes. Older
+     * scure versions emitted PSBTv2 without this field, so this opts out of strict BIP370 behavior
+     * when upgrading and editing their PSBTs.
+     */
+    allowMissingTxModifiable?: boolean;
+    /**
+     * Deprecated alias for {@link unknown}: true selects `ignore`, false selects `strip`.
+     * @deprecated Use `unknown`.
+     */
     allowUnknown?: boolean;
 }
 /**
@@ -200,9 +221,12 @@ export declare function getPrevOut(input: TArg<psbt.TransactionInput>): P.Unwrap
  * @param i - input update to normalize
  * @param cur - existing input value to merge with
  * @param allowedFields - fields that may still change on signed inputs
- * @param disableScriptCheck - whether to skip redeem/witness script sanity checks
- * @param allowUnknown - whether to keep unknown PSBT fields
+ * @param disableScriptCheck - whether to skip wrapper and Taproot commitment sanity checks
+ * @param unknown - handling policy for unknown PSBT fields
+ * @param proprietary - handling policy for proprietary PSBT fields
  * @returns Normalized PSBT input.
+ * @throws If the update conflicts with the existing input or its signatures. {@link Error}
+ * @throws If a numeric input field is outside its wire or protocol range. {@link RangeError}
  * @example
  * Accept hex txids from callers in the same display-order form used by `Transaction.id`, then
  * normalize them into the repo's internal `TransactionInput` shape.
@@ -216,7 +240,7 @@ export declare function getPrevOut(input: TArg<psbt.TransactionInput>): P.Unwrap
  * });
  * ```
  */
-export declare function normalizeInput(i: TArg<psbt.TransactionInputUpdate>, cur?: TArg<PSBTInputs>, allowedFields?: TArg<readonly (keyof PSBTInputs)[]>, disableScriptCheck?: boolean, allowUnknown?: boolean): TRet<PSBTInputs>;
+export declare function normalizeInput(i: TArg<psbt.TransactionInputUpdate>, cur?: TArg<PSBTInputs>, allowedFields?: TArg<readonly (keyof PSBTInputs)[]>, disableScriptCheck?: boolean, unknown?: Unknowns | boolean, proprietary?: Unknowns | boolean): TRet<PSBTInputs>;
 /**
  * Determines how an input should be signed and finalized.
  * Wrapper consistency is expected to be validated earlier by {@link normalizeInput}
@@ -305,13 +329,21 @@ export declare class Transaction {
     private outputs;
     readonly opts: ReturnType<typeof validateOpts>;
     constructor(opts?: TxOpts);
+    private isPSBTv2;
+    private requireTxModifiable;
+    private txModifiablePolicy;
+    private modifiable;
+    private get txModifiable();
     static fromRaw(raw: Bytes, opts?: TxOpts): Transaction;
     static fromPSBT(psbt_: Bytes, opts?: TxOpts): Transaction;
     toPSBT(PSBTVersion?: number | undefined): Uint8Array;
     get lockTime(): number;
     get version(): number;
     private inputStatus;
+    private cleanFinalInput;
     private inputSighash;
+    private signatures;
+    private signedInputKeys;
     private signStatus;
     get isFinal(): boolean;
     get hasWitnesses(): boolean;
@@ -323,6 +355,7 @@ export declare class Transaction {
     get hash(): string;
     get id(): string;
     private checkInputIdx;
+    private validatePrevoutsForSigning;
     getInput(idx: number): psbt.TransactionInput;
     get inputsLength(): number;
     addInput(input: TArg<psbt.TransactionInputUpdate>, _ignoreSignStatus?: boolean): number;
@@ -350,6 +383,7 @@ export declare class Transaction {
 /**
  * Merges multiple PSBT blobs into one.
  * @param psbts - PSBT byte arrays to combine
+ * @param opts - Transaction parsing, combination, and serialization options. See {@link TxOpts}.
  * @returns Combined PSBT bytes.
  * @throws If the PSBT list is empty or the partial transactions cannot be combined. {@link Error}
  * @example
@@ -360,7 +394,7 @@ export declare class Transaction {
  * PSBTCombine([psbt, psbt]);
  * ```
  */
-export declare function PSBTCombine(psbts: TArg<Bytes[]>): TRet<Bytes>;
+export declare function PSBTCombine(psbts: TArg<Bytes[]>, opts?: TArg<TxOpts>): TRet<Bytes>;
 /**
  * Parses a BIP32 path string into child indices.
  * @param path - derivation path such as `m/0'/1`
@@ -374,4 +408,3 @@ export declare function PSBTCombine(psbts: TArg<Bytes[]>): TRet<Bytes>;
  */
 export declare function bip32Path(path: string): number[];
 export {};
-//# sourceMappingURL=transaction.d.ts.map