feat: support changeAddress on btc (#492)

Author: qperrot

.changeset/purple-lamps-rhyme.md

@@ -0,0 +1,5 @@
+---
+"@ledgerhq/wallet-api-core": minor
+---
+
+Support changeAddress on bitcoin

packages/core/src/families/bitcoin/serializer.ts

@@ -7,13 +7,15 @@ export function serializeBitcoinTransaction({
   recipient,
   feePerByte,
   opReturnData,
+  changeAddress,
 }: BitcoinTransaction): RawBitcoinTransaction {
   return {
     family,
     amount: amount.toString(),
     recipient,
     feePerByte: feePerByte?.toString(),
     opReturnDataHex: opReturnData?.toString("hex"),
+    changeAddress,
   };
 }
 
@@ -23,6 +25,7 @@ export function deserializeBitcoinTransaction({
   recipient,
   feePerByte,
   opReturnDataHex,
+  changeAddress,
 }: RawBitcoinTransaction): BitcoinTransaction {
   return {
     family,
@@ -32,5 +35,6 @@ export function deserializeBitcoinTransaction({
     opReturnData: opReturnDataHex
       ? Buffer.from(opReturnDataHex, "hex")
       : undefined,
+    changeAddress,
   };
 }

packages/core/src/families/bitcoin/types.ts

@@ -7,6 +7,7 @@ export type BitcoinTransaction = TransactionCommon & {
   readonly family: RawBitcoinTransaction["family"];
   feePerByte?: BigNumber;
   opReturnData?: Buffer;
+  changeAddress?: string;
 };
 
 export type RawBitcoinTransaction = z.infer<typeof schemaRawBitcoinTransaction>;

packages/core/src/families/bitcoin/validation.ts

@@ -5,4 +5,5 @@ export const schemaRawBitcoinTransaction = schemaTransactionCommon.extend({
   family: z.literal(schemaFamilies.enum.bitcoin),
   feePerByte: z.string().optional(),
   opReturnDataHex: z.string().max(160).optional(),
+  changeAddress: z.string().optional(),
 });

packages/core/tests/serializers.spec.ts

@@ -231,6 +231,41 @@ describe("serializers.ts", () => {
           feePerByte: undefined,
         });
       });
+
+      it("should succeed to serialize a bitcoin transaction with changeAddress", () => {
+        const transaction: BitcoinTransaction = {
+          amount: new BigNumber(100),
+          recipient: "recipient",
+          family,
+          changeAddress: "changeAddress",
+        };
+        const serializedTransaction = serializeTransaction(transaction);
+
+        expect(serializedTransaction).toEqual({
+          family,
+          amount: "100",
+          recipient: "recipient",
+          feePerByte: undefined,
+          changeAddress: "changeAddress",
+        });
+      });
+
+      it("should succeed to serialize a bitcoin transaction without changeAddress", () => {
+        const transaction: BitcoinTransaction = {
+          amount: new BigNumber(100),
+          recipient: "recipient",
+          family,
+        };
+        const serializedTransaction = serializeTransaction(transaction);
+
+        expect(serializedTransaction).toEqual({
+          family,
+          amount: "100",
+          recipient: "recipient",
+          feePerByte: undefined,
+          changeAddress: undefined,
+        });
+      });
     });
 
     describe("kaspa", () => {
@@ -1114,6 +1149,43 @@ describe("serializers.ts", () => {
           feePerByte: undefined,
         });
       });
+
+      it("should succeed to deserialize a bitcoin transaction with changeAddress", () => {
+        const serializedTransaction: RawBitcoinTransaction = {
+          family,
+          amount: "0",
+          recipient: "recipient",
+          changeAddress: "changeAddress",
+        };
+
+        const transaction = deserializeTransaction(serializedTransaction);
+
+        expect(transaction).toEqual({
+          family,
+          amount: new BigNumber(0),
+          recipient: "recipient",
+          feePerByte: undefined,
+          changeAddress: "changeAddress",
+        });
+      });
+
+      it("should succeed to deserialize a bitcoin transaction without changeAddress", () => {
+        const serializedTransaction: RawBitcoinTransaction = {
+          family,
+          amount: "0",
+          recipient: "recipient",
+        };
+
+        const transaction = deserializeTransaction(serializedTransaction);
+
+        expect(transaction).toEqual({
+          family,
+          amount: new BigNumber(0),
+          recipient: "recipient",
+          feePerByte: undefined,
+          changeAddress: undefined,
+        });
+      });
     });
 
     describe("kaspa", () => {