Use CRC-enabled OASIS API package, streamline re-exports

nimiq · Jun 14, 2024 · cd6428e · cd6428e
1 parent 1359ef4
commit cd6428e
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 28 deletions.
diff --git a/package.json b/package.json
@@ -27,7 +27,7 @@
   "dependencies": {
     "@nimiq/core-web": "^1.5.8",
     "@nimiq/electrum-client": "https://github.com/nimiq/electrum-client#build",
-    "@nimiq/oasis-api": "^1.0.1",
+    "@nimiq/oasis-api": "https://github.com/nimiq/oasis-api-js#9d63fac0ab1364e4e1494334ee2d74f3d6f96b35",
     "ethers": "^5.7.2",
     "promise.prototype.finally": "^3.1.3"
   },

diff --git a/src/FiatAssetAdapter.ts b/src/FiatAssetAdapter.ts
@@ -1,13 +1,14 @@
-import { Htlc as OasisHtlc, HtlcStatus, SettlementInstruction, SettlementStatus } from '@nimiq/oasis-api';
+import { Htlc, HtlcStatus, SettlementInstruction, SettlementStatus, SettlementTokens } from '@nimiq/oasis-api';
 import type { AssetAdapter, FiatSwapAsset } from './IAssetAdapter';
 
-export type HtlcDetails = OasisHtlc;
-
-export type SettleHtlcTokens = { authorization: string, smsApi: string };
+export {
+    Htlc as OasisHtlcDetails,
+    SettlementTokens as OasisSettlementTokens,
+};
 
 export interface OasisClient {
-    getHtlc(id: string): Promise<HtlcDetails>;
-    settleHtlc(id: string, secret: string, settlementJWS: string, tokens?: Partial<SettleHtlcTokens>): Promise<HtlcDetails>;
+    getHtlc(id: string): Promise<Htlc>;
+    settleHtlc(id: string, secret: string, settlementJWS: string, tokens?: Partial<SettlementTokens>): Promise<Htlc>;
 }
 
 export class FiatAssetAdapter implements AssetAdapter<FiatSwapAsset> {
@@ -18,9 +19,9 @@ export class FiatAssetAdapter implements AssetAdapter<FiatSwapAsset> {
 
     private async findTransaction(
         id: string,
-        test: (htlc: HtlcDetails) => boolean,
-    ): Promise<HtlcDetails> {
-        const check = async (): Promise<HtlcDetails | null> => {
+        test: (htlc: Htlc) => boolean,
+    ): Promise<Htlc> {
+        const check = async (): Promise<Htlc | null> => {
             try {
                 const htlc = await this.client.getHtlc(id);
                 if (test(htlc)) return htlc;
@@ -66,8 +67,8 @@ export class FiatAssetAdapter implements AssetAdapter<FiatSwapAsset> {
         value: number,
         data?: string,
         confirmations?: number,
-        onUpdate?: (htlc: HtlcDetails) => any,
-    ): Promise<HtlcDetails> {
+        onUpdate?: (htlc: Htlc) => any,
+    ): Promise<Htlc> {
         return this.findTransaction(
             id,
             (htlc) => {
@@ -83,15 +84,15 @@ export class FiatAssetAdapter implements AssetAdapter<FiatSwapAsset> {
     }
 
     // eslint-disable-next-line class-methods-use-this
-    public async fundHtlc(): Promise<HtlcDetails> {
+    public async fundHtlc(): Promise<Htlc> {
         throw new Error('Method "fundHtlc" not available for EUR/CRC HTLCs');
     }
 
-    public async awaitHtlcSettlement(id: string): Promise<OasisHtlc<HtlcStatus.SETTLED>> {
+    public async awaitHtlcSettlement(id: string): Promise<Htlc<HtlcStatus.SETTLED>> {
         return this.findTransaction(
             id,
             (htlc) => typeof htlc.preimage.value === 'string',
-        ) as Promise<OasisHtlc<HtlcStatus.SETTLED>>;
+        ) as Promise<Htlc<HtlcStatus.SETTLED>>;
     }
 
     public async awaitSwapSecret(id: string): Promise<string> {
@@ -103,16 +104,16 @@ export class FiatAssetAdapter implements AssetAdapter<FiatSwapAsset> {
         settlementJWS: string,
         secret: string,
         hash: string,
-        tokens?: Partial<SettleHtlcTokens>,
-    ): Promise<HtlcDetails> {
+        tokens?: Partial<SettlementTokens>,
+    ): Promise<Htlc> {
         if (this.stopped) throw new Error('FiatAssetAdapter called while stopped');
 
         const jwsBody = settlementJWS.split('.')[1];
         // JWS is encoded as Base64Url
         const jsonBody = atob(jwsBody.replace(/_/g, '/').replace(/-/g, '+'));
         const payload = JSON.parse(jsonBody) as SettlementInstruction;
 
-        let htlc: HtlcDetails;
+        let htlc: Htlc;
         try {
             htlc = await this.client.settleHtlc(payload.contractId, secret, settlementJWS, tokens);
         } catch (error) {
@@ -127,7 +128,7 @@ export class FiatAssetAdapter implements AssetAdapter<FiatSwapAsset> {
         return htlc;
     }
 
-    public async awaitSettlementConfirmation(id: string, onUpdate?: (tx: HtlcDetails) => any): Promise<HtlcDetails> {
+    public async awaitSettlementConfirmation(id: string, onUpdate?: (tx: Htlc) => any): Promise<Htlc> {
         return this.findTransaction(id, (htlc) => {
             if (htlc.status !== HtlcStatus.SETTLED) return false;
 

diff --git a/src/IAssetAdapter.ts b/src/IAssetAdapter.ts
@@ -11,9 +11,9 @@ import type {
     Web3Client,
 } from './UsdcAssetAdapter';
 import type {
-    HtlcDetails,
+    OasisHtlcDetails,
     OasisClient,
-    SettleHtlcTokens,
+    OasisSettlementTokens,
 } from './FiatAssetAdapter';
 
 export enum SwapAsset {
@@ -31,7 +31,7 @@ export type Transaction<TAsset extends SwapAsset> =
     TAsset extends SwapAsset.NIM ? NimiqTransactionDetails
     : TAsset extends SwapAsset.BTC ? BitcoinTransactionDetails
     : TAsset extends SwapAsset.USDC | SwapAsset.USDC_MATIC ? UsdcTransactionDetails
-    : TAsset extends FiatSwapAsset ? HtlcDetails
+    : TAsset extends FiatSwapAsset ? OasisHtlcDetails
     : never;
 
 export type Client<TAsset extends SwapAsset> =
@@ -66,7 +66,7 @@ export interface AssetAdapter<TAsset extends SwapAsset> {
         serializedTx: string,
         secret: string,
         hash: string,
-        tokens?: Partial<SettleHtlcTokens>
+        tokens?: Partial<OasisSettlementTokens>
     ): Promise<Transaction<TAsset>>;
 
     awaitSettlementConfirmation(

diff --git a/src/SwapHandler.ts b/src/SwapHandler.ts
@@ -4,7 +4,7 @@ import { NimiqAssetAdapter } from './NimiqAssetAdapter';
 import { BitcoinAssetAdapter } from './BitcoinAssetAdapter';
 import { UsdcAssetAdapter } from './UsdcAssetAdapter';
 import { FiatAssetAdapter } from './FiatAssetAdapter';
-import type { SettleHtlcTokens } from './FiatAssetAdapter';
+import type { OasisSettlementTokens } from './FiatAssetAdapter';
 
 // Re-export to centralize exports
 export { SwapAsset, Client, Transaction };
@@ -113,7 +113,7 @@ export class SwapHandler<FromAsset extends SwapAsset, ToAsset extends SwapAsset>
     public async settleIncoming(
         serializedTx: string,
         secret: string,
-        tokens?: Partial<SettleHtlcTokens>,
+        tokens?: Partial<OasisSettlementTokens>,
     ): Promise<Transaction<ToAsset>> {
         return this.toAssetAdapter.settleHtlc(
             serializedTx,

diff --git a/yarn.lock b/yarn.lock
@@ -355,10 +355,9 @@
   dependencies:
     bitcoinjs-lib "^5.1.10"
 
-"@nimiq/oasis-api@^1.0.1":
+"@nimiq/oasis-api@https://github.com/nimiq/oasis-api-js#9d63fac0ab1364e4e1494334ee2d74f3d6f96b35":
   version "1.1.1"
-  resolved "https://registry.yarnpkg.com/@nimiq/oasis-api/-/oasis-api-1.1.1.tgz#d1aa3d0f9afabf9116205809a0fc72d2e392bafa"
-  integrity sha512-jXNO7nvE0mzAyDCrucByv5AcyDWZjyqb9810YctysxqUtOxNG27hPkhomL+WW6nrnTVgvriJo3yaTFPTfLphKw==
+  resolved "https://github.com/nimiq/oasis-api-js#9d63fac0ab1364e4e1494334ee2d74f3d6f96b35"
 
 "@types/[email protected]":
   version "10.12.18"