@bitgo/wasm-utxo 1.11.0 → 1.13.0

package/dist/cjs/js/fixedScriptWallet/BitGoPsbt.d.ts

@@ -27,6 +27,7 @@ export type ParsedOutput = {
     script: Uint8Array;
     value: bigint;
     scriptId: ScriptId | null;
+    paygo: boolean;
 };
 export type ParsedTransaction = {
     inputs: ParsedInput[];
@@ -54,9 +55,10 @@ export declare class BitGoPsbt {
      * Parse transaction with wallet keys to identify wallet inputs/outputs
      * @param walletKeys - The wallet keys to use for identification
      * @param replayProtection - Scripts that are allowed as inputs without wallet validation
+     * @param payGoPubkeys - Optional public keys for PayGo attestation verification
      * @returns Parsed transaction information
      */
-    parseTransactionWithWalletKeys(walletKeys: WalletKeysArg, replayProtection: ReplayProtectionArg): ParsedTransaction;
+    parseTransactionWithWalletKeys(walletKeys: WalletKeysArg, replayProtection: ReplayProtectionArg, payGoPubkeys?: ECPairArg[]): ParsedTransaction;
     /**
      * Parse outputs with wallet keys to identify which outputs belong to a wallet
      * with the given wallet keys.
@@ -65,10 +67,23 @@ export declare class BitGoPsbt {
      * wallet than the inputs.
      *
      * @param walletKeys - The wallet keys to use for identification
+     * @param payGoPubkeys - Optional public keys for PayGo attestation verification
      * @returns Array of parsed outputs
      * @note This method does NOT validate wallet inputs. It only parses outputs.
      */
-    parseOutputsWithWalletKeys(walletKeys: WalletKeysArg): ParsedOutput[];
+    parseOutputsWithWalletKeys(walletKeys: WalletKeysArg, payGoPubkeys?: ECPairArg[]): ParsedOutput[];
+    /**
+     * Add a PayGo attestation to a PSBT output
+     *
+     * This adds a cryptographic proof that the output address was authorized by a signing authority.
+     * The attestation is stored in PSBT proprietary key-values and can be verified later.
+     *
+     * @param outputIndex - The index of the output to add the attestation to
+     * @param entropy - 64 bytes of entropy (must be exactly 64 bytes)
+     * @param signature - ECDSA signature bytes (typically 65 bytes in recoverable format)
+     * @throws Error if output index is out of bounds or entropy is not 64 bytes
+     */
+    addPayGoAttestation(outputIndex: number, entropy: Uint8Array, signature: Uint8Array): void;
     /**
      * Verify if a valid signature exists for a given key at the specified input index.
      *

package/dist/cjs/js/fixedScriptWallet/BitGoPsbt.js

@@ -32,12 +32,14 @@ class BitGoPsbt {
      * Parse transaction with wallet keys to identify wallet inputs/outputs
      * @param walletKeys - The wallet keys to use for identification
      * @param replayProtection - Scripts that are allowed as inputs without wallet validation
+     * @param payGoPubkeys - Optional public keys for PayGo attestation verification
      * @returns Parsed transaction information
      */
-    parseTransactionWithWalletKeys(walletKeys, replayProtection) {
+    parseTransactionWithWalletKeys(walletKeys, replayProtection, payGoPubkeys) {
         const keys = RootWalletKeys_js_1.RootWalletKeys.from(walletKeys);
         const rp = ReplayProtection_js_1.ReplayProtection.from(replayProtection, this.wasm.network());
-        return this.wasm.parse_transaction_with_wallet_keys(keys.wasm, rp.wasm);
+        const pubkeys = payGoPubkeys?.map((arg) => ecpair_js_1.ECPair.from(arg).wasm);
+        return this.wasm.parse_transaction_with_wallet_keys(keys.wasm, rp.wasm, pubkeys);
     }
     /**
      * Parse outputs with wallet keys to identify which outputs belong to a wallet
@@ -47,12 +49,28 @@ class BitGoPsbt {
      * wallet than the inputs.
      *
      * @param walletKeys - The wallet keys to use for identification
+     * @param payGoPubkeys - Optional public keys for PayGo attestation verification
      * @returns Array of parsed outputs
      * @note This method does NOT validate wallet inputs. It only parses outputs.
      */
-    parseOutputsWithWalletKeys(walletKeys) {
+    parseOutputsWithWalletKeys(walletKeys, payGoPubkeys) {
         const keys = RootWalletKeys_js_1.RootWalletKeys.from(walletKeys);
-        return this.wasm.parse_outputs_with_wallet_keys(keys.wasm);
+        const pubkeys = payGoPubkeys?.map((arg) => ecpair_js_1.ECPair.from(arg).wasm);
+        return this.wasm.parse_outputs_with_wallet_keys(keys.wasm, pubkeys);
+    }
+    /**
+     * Add a PayGo attestation to a PSBT output
+     *
+     * This adds a cryptographic proof that the output address was authorized by a signing authority.
+     * The attestation is stored in PSBT proprietary key-values and can be verified later.
+     *
+     * @param outputIndex - The index of the output to add the attestation to
+     * @param entropy - 64 bytes of entropy (must be exactly 64 bytes)
+     * @param signature - ECDSA signature bytes (typically 65 bytes in recoverable format)
+     * @throws Error if output index is out of bounds or entropy is not 64 bytes
+     */
+    addPayGoAttestation(outputIndex, entropy, signature) {
+        this.wasm.add_paygo_attestation(outputIndex, entropy, signature);
     }
     /**
      * Verify if a valid signature exists for a given key at the specified input index.

package/dist/cjs/js/wasm/wasm_utxo.d.ts

@@ -1,5 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
+
 export class AddressNamespace {
   private constructor();
   free(): void;
@@ -7,6 +8,7 @@ export class AddressNamespace {
   static to_output_script_with_coin(address: string, coin: string): Uint8Array;
   static from_output_script_with_coin(script: Uint8Array, coin: string, format?: string | null): string;
 }
+
 export class BitGoPsbt {
   private constructor();
   free(): void;
@@ -81,6 +83,19 @@ export class BitGoPsbt {
    * - `Err(WasmUtxoError)` if any input failed to finalize
    */
   finalize_all_inputs(): void;
+  /**
+   * Add a PayGo attestation to a PSBT output
+   *
+   * # Arguments
+   * - `output_index`: The index of the output to add the attestation to
+   * - `entropy`: 64 bytes of entropy
+   * - `signature`: ECDSA signature bytes
+   *
+   * # Returns
+   * - `Ok(())` if the attestation was successfully added
+   * - `Err(WasmUtxoError)` if the output index is out of bounds or entropy is invalid
+   */
+  add_paygo_attestation(output_index: number, entropy: Uint8Array, signature: Uint8Array): void;
   /**
    * Combine/merge data from another PSBT into this one
    *
@@ -171,11 +186,11 @@ export class BitGoPsbt {
    *
    * Note: This method does NOT validate wallet inputs. It only parses outputs.
    */
-  parse_outputs_with_wallet_keys(wallet_keys: WasmRootWalletKeys): any;
+  parse_outputs_with_wallet_keys(wallet_keys: WasmRootWalletKeys, paygo_pubkeys?: WasmECPair[] | null): any;
   /**
    * Parse transaction with wallet keys to identify wallet inputs/outputs
    */
-  parse_transaction_with_wallet_keys(wallet_keys: WasmRootWalletKeys, replay_protection: WasmReplayProtection): any;
+  parse_transaction_with_wallet_keys(wallet_keys: WasmRootWalletKeys, replay_protection: WasmReplayProtection, paygo_pubkeys?: WasmECPair[] | null): any;
   /**
    * Verify if a replay protection input has a valid signature
    *
@@ -206,6 +221,7 @@ export class BitGoPsbt {
    */
   serialize(): Uint8Array;
 }
+
 export class FixedScriptWalletNamespace {
   private constructor();
   free(): void;
@@ -213,6 +229,7 @@ export class FixedScriptWalletNamespace {
   static output_script(keys: WasmRootWalletKeys, chain: number, index: number, network: any): Uint8Array;
   static address(keys: WasmRootWalletKeys, chain: number, index: number, network: any, address_format?: string | null): string;
 }
+
 export class UtxolibCompatNamespace {
   private constructor();
   free(): void;
@@ -236,10 +253,7 @@ export class UtxolibCompatNamespace {
    */
   static from_output_script(script: Uint8Array, network: any, format?: string | null): string;
 }
-/**
- * WASM wrapper for BIP32 extended keys (Xpub/Xpriv)
- * Implements the BIP32Interface TypeScript interface
- */
+
 export class WasmBIP32 {
   private constructor();
   free(): void;
@@ -332,9 +346,7 @@ export class WasmBIP32 {
    */
   readonly index: number;
 }
-/**
- * WASM wrapper for elliptic curve key pairs (always uses compressed keys)
- */
+
 export class WasmECPair {
   private constructor();
   free(): void;
@@ -380,9 +392,7 @@ export class WasmECPair {
    */
   readonly private_key: Uint8Array | undefined;
 }
-/**
- * WASM wrapper for ReplayProtection
- */
+
 export class WasmReplayProtection {
   private constructor();
   free(): void;
@@ -400,10 +410,7 @@ export class WasmReplayProtection {
    */
   static from_output_scripts(output_scripts: Uint8Array[]): WasmReplayProtection;
 }
-/**
- * WASM wrapper for RootWalletKeys
- * Represents a set of three extended public keys with their derivation prefixes
- */
+
 export class WasmRootWalletKeys {
   free(): void;
   [Symbol.dispose](): void;
@@ -442,6 +449,7 @@ export class WasmRootWalletKeys {
    */
   bitgo_key(): WasmBIP32;
 }
+
 export class WrapDescriptor {
   private constructor();
   free(): void;
@@ -456,6 +464,7 @@ export class WrapDescriptor {
   descType(): any;
   toString(): string;
 }
+
 export class WrapMiniscript {
   private constructor();
   free(): void;
@@ -465,6 +474,7 @@ export class WrapMiniscript {
   encode(): Uint8Array;
   toString(): string;
 }
+
 export class WrapPsbt {
   private constructor();
   free(): void;