Rename SwapAsset.USDT to SwapAsset.USDT_MATIC

Add doc comments to SwapAsset
nimiq · Nov 1, 2024 · 908984b · 908984b
1 parent 2482141
commit 908984b
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 7 deletions.
diff --git a/src/Erc20AssetAdapter.ts b/src/Erc20AssetAdapter.ts
@@ -66,7 +66,7 @@ export interface Web3Client {
     endBlock?: number;
 }
 
-export class Erc20AssetAdapter implements AssetAdapter<SwapAsset.USDC | SwapAsset.USDC_MATIC | SwapAsset.USDT> {
+export class Erc20AssetAdapter implements AssetAdapter<SwapAsset.USDC | SwapAsset.USDC_MATIC | SwapAsset.USDT_MATIC> {
     private cancelCallback: ((reason: Error) => void) | null = null;
     private stopped = false;
 

diff --git a/src/IAssetAdapter.ts b/src/IAssetAdapter.ts
@@ -6,21 +6,30 @@ import { NimiqClient, TransactionDetails as NimiqTransactionDetails } from './Ni
 export enum SwapAsset {
     NIM = 'NIM',
     BTC = 'BTC',
+    /**
+     * Legacy bridged USDC.e on Polygon.
+     */
     USDC = 'USDC',
+    /**
+     * Native USDC on Polygon.
+     */
     USDC_MATIC = 'USDC_MATIC',
-    USDT = 'USDT', // Alternatively USDT_MATIC
+    /**
+     * Bridged USDT on Polygon.
+     */
+    USDT_MATIC = 'USDT_MATIC',
     EUR = 'EUR',
 }
 
 export type Transaction<TAsset extends SwapAsset> = TAsset extends SwapAsset.NIM ? NimiqTransactionDetails
     : TAsset extends SwapAsset.BTC ? BitcoinTransactionDetails
-    : TAsset extends SwapAsset.USDC | SwapAsset.USDC_MATIC | SwapAsset.USDT ? Erc20TransactionDetails
+    : TAsset extends SwapAsset.USDC | SwapAsset.USDC_MATIC | SwapAsset.USDT_MATIC ? Erc20TransactionDetails
     : TAsset extends SwapAsset.EUR ? EuroHtlcDetails
     : never;
 
 export type Client<TAsset extends SwapAsset> = TAsset extends SwapAsset.NIM ? NimiqClient
     : TAsset extends SwapAsset.BTC ? BitcoinClient
-    : TAsset extends SwapAsset.USDC | SwapAsset.USDC_MATIC | SwapAsset.USDT ? Web3Client
+    : TAsset extends SwapAsset.USDC | SwapAsset.USDC_MATIC | SwapAsset.USDT_MATIC ? Web3Client
     : TAsset extends SwapAsset.EUR ? OasisClient
     : never;
 

diff --git a/src/SwapHandler.ts b/src/SwapHandler.ts
@@ -13,7 +13,7 @@ export type Contract<TAsset extends SwapAsset> = {
         address: string,
         data: TAsset extends SwapAsset.NIM ? string : never,
         script: TAsset extends SwapAsset.BTC ? string : never,
-        contract: TAsset extends SwapAsset.USDC | SwapAsset.USDC_MATIC | SwapAsset.USDT ? string : never,
+        contract: TAsset extends SwapAsset.USDC | SwapAsset.USDC_MATIC | SwapAsset.USDT_MATIC ? string : never,
     },
 };
 
@@ -47,9 +47,9 @@ export class SwapHandler<FromAsset extends SwapAsset, ToAsset extends SwapAsset>
                 return new BitcoinAssetAdapter(client as Client<SwapAsset.BTC>) as AssetAdapter<SwapAsset>;
             case SwapAsset.USDC:
             case SwapAsset.USDC_MATIC:
-            case SwapAsset.USDT:
+            case SwapAsset.USDT_MATIC:
                 return new Erc20AssetAdapter(
-                    client as Client<SwapAsset.USDC | SwapAsset.USDC_MATIC | SwapAsset.USDT>,
+                    client as Client<SwapAsset.USDC | SwapAsset.USDC_MATIC | SwapAsset.USDT_MATIC>,
                 ) as AssetAdapter<
                     SwapAsset
                 >;