Merge pull request #949 from iov-one/922-swap-kind-helpers

Add atomic swap type guard helpers to BCP
iov-one · Apr 30, 2019 · 0d8e596 · 0d8e596
2 parents 8bc8d25 + 1481380
commit 0d8e596
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,8 @@
 ## 0.15.0
 
 - @iov/bcp: Add `isSwapTransaction` helper function.
+- @iov/bcp: Add `isOpenSwap`, `isClaimedSwap` and `isAbortedSwap` helper
+  functions.
 - @iov/ethereum: Add `createEtherSwapId` and `createErc20SwapId` static methods.
 - @iov/ethereum: Add `SwapIdPrefix` enum.
 - @iov/ethereum: Add `Erc20TokensMap` type.

diff --git a/packages/iov-bcp/src/atomicswaptypes.ts b/packages/iov-bcp/src/atomicswaptypes.ts
@@ -66,6 +66,18 @@ export interface AbortedSwap {
 
 export type AtomicSwap = OpenSwap | ClaimedSwap | AbortedSwap;
 
+export function isOpenSwap(swap: AtomicSwap): swap is OpenSwap {
+  return isSwapProcessStateOpen(swap.kind);
+}
+
+export function isClaimedSwap(swap: AtomicSwap): swap is ClaimedSwap {
+  return isSwapProcessStateClaimed(swap.kind);
+}
+
+export function isAbortedSwap(swap: AtomicSwap): swap is AbortedSwap {
+  return isSwapProcessStateAborted(swap.kind);
+}
+
 export interface AtomicSwapRecipientQuery {
   readonly recipient: Address;
 }

diff --git a/packages/iov-bcp/types/atomicswaptypes.d.ts b/packages/iov-bcp/types/atomicswaptypes.d.ts
@@ -46,6 +46,9 @@ export interface AbortedSwap {
     readonly data: SwapData;
 }
 export declare type AtomicSwap = OpenSwap | ClaimedSwap | AbortedSwap;
+export declare function isOpenSwap(swap: AtomicSwap): swap is OpenSwap;
+export declare function isClaimedSwap(swap: AtomicSwap): swap is ClaimedSwap;
+export declare function isAbortedSwap(swap: AtomicSwap): swap is AbortedSwap;
 export interface AtomicSwapRecipientQuery {
     readonly recipient: Address;
 }

diff --git a/packages/iov-core/src/integrationtests/atomicswapbnsbcp.spec.ts b/packages/iov-core/src/integrationtests/atomicswapbnsbcp.spec.ts
@@ -6,10 +6,10 @@ import {
   AtomicSwap,
   AtomicSwapConnection,
   AtomicSwapHelpers,
-  ClaimedSwap,
   createTimestampTimeout,
   isBlockInfoPending,
   isBlockInfoSucceeded,
+  isClaimedSwap,
   Preimage,
   PublicIdentity,
   SendTransaction,
@@ -207,11 +207,14 @@ class Actor {
     claim: AtomicSwap,
     unclaimedId: SwapId,
   ): Promise<Uint8Array | undefined> {
+    if (!isClaimedSwap(claim)) {
+      throw new Error("Expected swap to be claimed");
+    }
     const transaction = await this.bnsConnection.withDefaultFee<SwapClaimTransaction>({
       kind: "bcp/swap_claim",
       creator: this.bnsIdentity,
       swapId: unclaimedId,
-      preimage: (claim as ClaimedSwap).preimage, // public data now!
+      preimage: claim.preimage, // public data now!
     });
     return this.sendTransaction(transaction);
   }

diff --git a/packages/iov-core/src/integrationtests/atomicswapbnseth.spec.ts b/packages/iov-core/src/integrationtests/atomicswapbnseth.spec.ts
@@ -6,10 +6,10 @@ import {
   AtomicSwap,
   AtomicSwapConnection,
   AtomicSwapHelpers,
-  ClaimedSwap,
   createTimestampTimeout,
   isBlockInfoPending,
   isBlockInfoSucceeded,
+  isClaimedSwap,
   Preimage,
   PublicIdentity,
   SendTransaction,
@@ -236,11 +236,14 @@ class Actor {
     claim: AtomicSwap,
     unclaimedId: SwapId,
   ): Promise<Uint8Array | undefined> {
+    if (!isClaimedSwap(claim)) {
+      throw new Error("Expected swap to be claimed");
+    }
     const transaction = await this.bnsConnection.withDefaultFee<SwapClaimTransaction>({
       kind: "bcp/swap_claim",
       creator: this.bnsIdentity,
       swapId: unclaimedId,
-      preimage: (claim as ClaimedSwap).preimage, // public data now!
+      preimage: claim.preimage, // public data now!
     });
     return this.sendTransaction(transaction);
   }

diff --git a/packages/iov-ethereum/src/integrationtests/atomicswap.spec.ts b/packages/iov-ethereum/src/integrationtests/atomicswap.spec.ts
@@ -9,13 +9,14 @@ import {
   ClaimedSwap,
   isBlockInfoPending,
   isBlockInfoSucceeded,
+  isClaimedSwap,
+  isOpenSwap,
   OpenSwap,
   Preimage,
   PublicIdentity,
   PublicKeyBundle,
   SendTransaction,
   SwapClaimTransaction,
-  SwapIdBytes,
   SwapOfferTransaction,
   SwapProcessState,
   TokenTicker,
@@ -288,13 +289,17 @@ describe("Full atomic swap", () => {
     // find claim
     const bobSenderSwaps = await bob.getSenderSwaps();
     const aliceClaimed = bobSenderSwaps[bobSenderSwaps.length - 1];
-    expect(aliceClaimed.kind).toEqual(SwapProcessState.Claimed);
+    if (!isClaimedSwap(aliceClaimed)) {
+      throw new Error("Expected swap to be claimed");
+    }
 
     const bobReceiverSwaps2 = await bob.getReceiverSwaps();
     const aliceOffer2 = bobReceiverSwaps2[bobReceiverSwaps2.length - 1];
-    expect(aliceOffer2.kind).toEqual(SwapProcessState.Open);
+    if (!isOpenSwap(aliceOffer2)) {
+      throw new Error("Expected swap to be open");
+    }
 
-    await bob.claimFromRevealedPreimage(aliceOffer2 as OpenSwap, aliceClaimed as ClaimedSwap);
+    await bob.claimFromRevealedPreimage(aliceOffer2, aliceClaimed);
 
     // Bob used Alice's preimage to claim unlock his funds
     expect((await bob.getReceiverBalance()).sub(bobInitialReceiver).gtn(4900000000000000000)).toEqual(true);