Feat/thorswap swap btc (#85)

* feat(thorswap-swap-btc): add thorswap swap support * feat(thorswap-swap): add eth evm calldata * feat(thorswap-swap): fix test * feat(thorswap-swap): remove merge error
LedgerHQ · Oct 2, 2024 · f7a67f3 · f7a67f3
1 parent e2639cb
commit f7a67f3
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 8 deletions.
diff --git a/lib/src/api.ts b/lib/src/api.ts
@@ -49,6 +49,7 @@ export type SwapPayloadResponse = {
  payinAddress: string;
  swapId: string;
  payinExtraId?: string;
+ extraTransactionParameters?: string,
 };
 
 export async function retrieveSwapPayload(
@@ -139,6 +140,7 @@ type SwapBackendResponse = {
  binaryPayload: string;
  signature: string;
  payinExtraId?: string;
+ extraTransactionParameters?: string;
 };
 
 function parseSwapBackendInfo(response: SwapBackendResponse): {
@@ -147,13 +149,15 @@ function parseSwapBackendInfo(response: SwapBackendResponse): {
  payinAddress: string;
  swapId: string;
  payinExtraId?: string;
+ extraTransactionParameters?: string;
 } {
  return {
  binaryPayload: response.binaryPayload,
  signature: response.signature,
  payinAddress: response.payinAddress,
  swapId: response.swapId,
  payinExtraId: response.payinExtraId,
+ extraTransactionParameters: response.extraTransactionParameters,
  };
 }
 

diff --git a/lib/src/sdk.test.ts b/lib/src/sdk.test.ts
@@ -18,7 +18,7 @@ import {
 } from "./api";
 import { ExchangeSDK, FeeStrategy } from "./sdk";
 import { getCustomModule } from "./wallet-api";
-import { CompleteExchangeError, PayinExtraIdError } from "./error";
+import { CompleteExchangeError, PayinExtraIdError, SignatureStepError } from "./error";
 
 jest.mock("./api");
 
@@ -197,23 +197,23 @@ describe("swap", () => {
  };
 
  mockCompleteSwap.mockRejectedValueOnce(
- new CompleteExchangeError("SIGN_COIN_TRANSACTION", "error message")
+ new SignatureStepError(new CompleteExchangeError("SIGN_COIN_TRANSACTION", "error message"))
  );
 
  // WHEN
- await expect(sdk.swap(swapData)).rejects.toThrowError();
+ await expect(sdk.swap(swapData)).rejects.toThrow(SignatureStepError);
 
  // THEN
  expect(cancelSwap as jest.Mock).toHaveBeenCalledWith({
  provider: "provider-id",
  swapId: "swap-id",
- statusCode: "CompleteExchangeError",
+ statusCode: "SignatureStepError",
  errorMessage: "error message",
  sourceCurrencyId: "currency-id-1",
  targetCurrencyId: "currency-id-2",
  hardwareWalletType: "nanoX",
  swapType: "fixed",
- swapStep: "SIGN_COIN_TRANSACTION",
+ swapStep: "UNKNOWN_STEP",
  });
  });
 });

diff --git a/lib/src/sdk.ts b/lib/src/sdk.ts
@@ -207,7 +207,7 @@ export class ExchangeSDK {
 
  // Step 2: Ask for payload creation
  const payloadRequest = getSwapPayload ?? retrieveSwapPayload;
- const { binaryPayload, signature, payinAddress, swapId, payinExtraId } =
+ const { binaryPayload, signature, payinAddress, swapId, payinExtraId, extraTransactionParameters } =
  await payloadRequest({
  provider: this.providerId,
  deviceTransactionId,
@@ -231,6 +231,7 @@ export class ExchangeSDK {
  currency: fromCurrency,
  customFeeConfig,
  payinExtraId,
+ extraTransactionParameters,
  })
  .catch(async (error) => {
  await this.cancelSwapOnError(
@@ -246,7 +247,6 @@ export class ExchangeSDK {
  this.handleError(error);
  throw error;
  });
-
  const tx = await this.exchangeModule
  .completeSwap({
  provider: this.providerId,

diff --git a/lib/src/wallet-api.ts b/lib/src/wallet-api.ts
@@ -29,6 +29,7 @@ type TransactionWithCustomFee = TransactionCommon & {
  [key: string]: BigNumber;
  };
  payinExtraId?: string;
+ extraTransactionParameters?: string;
 };
 
 // Define a specific type for the strategy functions, assuming they might need parameters
@@ -40,7 +41,7 @@ const transactionStrategy: {
  [K in Transaction["family"]]: TransactionStrategyFunction;
 } = {
  algorand: defaultTransaction,
- bitcoin: defaultTransaction,
+ bitcoin: bitcoinTransaction,
  cardano: modeSendTransaction,
  celo: defaultTransaction,
  cosmos: defaultTransaction,
@@ -72,6 +73,7 @@ export type CreateTransactionArg = {
  [key: string]: BigNumber;
  };
  payinExtraId?: string;
+ extraTransactionParameters?: string;
 };
 
 export type WalletApiDecorator = {
@@ -124,6 +126,7 @@ async function createTransaction({
  currency,
  customFeeConfig,
  payinExtraId,
+ extraTransactionParameters,
  }: CreateTransactionArg): Promise<Transaction> {
  let family: Transaction["family"];
  if (currency.type === "TokenCurrency") {
@@ -152,6 +155,7 @@ async function createTransaction({
  recipient,
  customFeeConfig,
  payinExtraId,
+ extraTransactionParameters,
  });
  }
 
@@ -231,11 +235,46 @@ export function withoutGasLimitTransaction({
  amount,
  recipient,
  customFeeConfig,
+ extraTransactionParameters,
 }: TransactionWithCustomFee): Transaction {
  delete customFeeConfig.gasLimit;
+ if (extraTransactionParameters) {
+ return {
+ family,
+ amount,
+ recipient,
+ ...customFeeConfig,
+ data: Buffer.from(extraTransactionParameters, "hex"),
+ } as Transaction;
+ }
  return defaultTransaction({ family, amount, recipient, customFeeConfig });
 }
 
+export function bitcoinTransaction({
+ family,
+ amount,
+ recipient,
+ customFeeConfig,
+ extraTransactionParameters
+}: TransactionWithCustomFee): Transaction {
+ if (extraTransactionParameters)
+ {
+ return {
+ family,
+ amount,
+ recipient,
+ ...customFeeConfig,
+ opReturnData: Buffer.from(extraTransactionParameters, "utf-8"),
+ } as Transaction;
+ }
+ return {
+ family,
+ amount,
+ recipient,
+ ...customFeeConfig,
+ } as Transaction;
+}
+
 export function solanaTransaction({
  family,
  amount,