🤖 Merge PR DefinitelyTyped#73008 [invity-api]: add trade signatures by @adderpositive

Author: adderpositive

types/invity-api/index.d.ts

@@ -285,6 +285,8 @@ export interface ExchangeTrade {
     receive?: CryptoId | undefined; // litecoin
 
     receiveStringAmount?: string | undefined; // "0.01"
+    /** User`s crypto address where tx should be refunded */
+    refundAddress?: string;
     fromAddress?: string | undefined; // user's address from which the tx is sent - used in DEX
     receiveAddress?: string | undefined; // user's address for receive tx
     rate?: number | undefined; // 100
@@ -337,6 +339,11 @@ export interface ExchangeTrade {
     tradeForm?: FormResponse;
 }
 
+export interface ExchangeTradeSigned extends ExchangeTrade {
+    /** SLIP24: Nonce for payment request signature */
+    tradeSignature: string;
+}
+
 export interface ExtendedExchangeTrade extends ExchangeTrade {
     requestTradeErrorType?: "QUOTE_TIMEOUT" | "UNKNOWN" | undefined;
     newQuote?: ExchangeTrade | undefined; // A renewed quote, in case of a timeout
@@ -536,6 +543,11 @@ export interface SellFiatTrade {
     partnerData2?: string | undefined; // arbitrary data specific for the partner
 }
 
+export interface SellFiatTradeSigned extends SellFiatTrade {
+    /** SLIP24: Signature of the trade */
+    tradeSignature: string;
+}
+
 export interface SellVoucherTradeQuoteRequest {
     cryptoCurrency?: CryptoId | undefined; // bitcoin
     language?: string | undefined; // en
@@ -589,3 +601,29 @@ export interface WatchSellTradeResponse {
     destinationPaymentExtraId?: string | undefined; // Extra ID for payments to exchange for networks that require it (destinationTag)
     cryptoStringAmount?: string; // Crypto amount to send in case of change on provider's side (Banxa)
 }
+
+export interface PaymentRequestOutput {
+    address: string;
+    amount: string;
+}
+
+export interface CreateTradeSignatureRequestSell {
+    type: "sell";
+    /** ID of the trade - `paymentId` for sell */
+    id: string;
+    nonce: string;
+    outputs: PaymentRequestOutput[];
+    memoText: string;
+}
+
+export interface CreateTradeSignatureRequestExchange {
+    type: "exchange";
+    /** ID of the trade - `orderId` for exchange */
+    id: string;
+    nonce: string;
+    outputs: PaymentRequestOutput[];
+}
+
+export type CreateTradeSignatureRequest =
+    | CreateTradeSignatureRequestSell
+    | CreateTradeSignatureRequestExchange;

types/invity-api/invity-api-tests.ts

@@ -1,11 +1,15 @@
 import {
     BuyProviderInfo,
     BuyTrade,
+    CreateTradeSignatureRequestExchange,
+    CreateTradeSignatureRequestSell,
     CryptoId,
     ExchangeProviderInfo,
     ExchangeTrade,
+    ExchangeTradeSigned,
     InfoResponse,
     SellFiatTrade,
+    SellFiatTradeSigned,
     SellProviderInfo,
     WatchSellTradeResponse,
 } from "invity-api";
@@ -18,6 +22,7 @@ const bt: BuyTrade = {
 const et: ExchangeTrade = {
     send: "bitcoin" as CryptoId,
     receive: "ethereum" as CryptoId,
+    refundAddress: "refundAddress",
     quoteId: "123",
     signData: {
         type: "eip712-typed-data",
@@ -26,6 +31,11 @@ const et: ExchangeTrade = {
     status: "SIGN_DATA",
 };
 
+const ets: ExchangeTradeSigned = {
+    ...et,
+    tradeSignature: "signature",
+};
+
 const sft: SellFiatTrade = {
     paymentMethodName: "Test",
     destinationPaymentExtraIdDescription: {
@@ -36,6 +46,11 @@ const sft: SellFiatTrade = {
     },
 };
 
+const sfts: SellFiatTradeSigned = {
+    ...sft,
+    tradeSignature: "signature",
+};
+
 const wstr: WatchSellTradeResponse = {
     cryptoStringAmount: "",
 };
@@ -109,3 +124,28 @@ const sellProviderInfo: SellProviderInfo = {
     isRefundAddressRequired: false,
     lockSendAmount: false,
 };
+
+const sellSignatureRequest: CreateTradeSignatureRequestSell = {
+    type: "sell",
+    id: "123",
+    nonce: "nonce",
+    outputs: [
+        {
+            address: "address",
+            amount: "1000",
+        },
+    ],
+    memoText: "memo",
+};
+
+const exchangeSignatureRequest: CreateTradeSignatureRequestExchange = {
+    type: "exchange",
+    id: "123",
+    nonce: "nonce",
+    outputs: [
+        {
+            address: "address",
+            amount: "1000",
+        },
+    ],
+};