@stellar/typescript-wallet-sdk 1.1.0 → 1.1.2

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@stellar/typescript-wallet-sdk",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "engines": {
     "node": ">=18"
   },
+  "browser": "./lib/bundle_browser.js",
   "main": "./lib/bundle.js",
   "types": "./lib/index.d.ts",
   "license": "Apache-2.0",
@@ -21,6 +22,7 @@
     "eslint": "^8.33.0",
     "husky": "^8.0.0",
     "jest": "^29.4.1",
+    "npm-run-all": "^4.1.5",
     "prettier": "^2.0.5",
     "pretty-quick": "^2.0.1",
     "sinon": "^15.1.0",
@@ -47,6 +49,8 @@
   "scripts": {
     "prepare": "yarn build",
     "test": "jest --watchAll",
-    "build": "webpack --config webpack.config.js"
+    "build:web": "webpack --config webpack.config.js",
+    "build:node": "webpack --env NODE=true --config webpack.config.js",
+    "build": "run-p build:web build:node"
   }
 }

package/src/walletSdk/Watcher/index.ts

@@ -1,5 +1,3 @@
-import isEqual from "lodash/isEqual";
-
 import { Anchor } from "../Anchor";
 import {
   AnchorTransaction,
@@ -151,9 +149,9 @@ export class Watcher {
               return isInProgress;
             }
 
-            // if we've had the transaction before, only report updates
+            // if we've had the transaction before, only report updates if status changed
             if (registeredTransaction) {
-              return !isEqual(registeredTransaction, transaction);
+              return registeredTransaction.status !== transaction.status;
             }
 
             // if it's NOT a registered transaction, and it's not the first
@@ -296,12 +294,13 @@ export class Watcher {
         const registeredTransaction =
           this._transactionsRegistry[assetCode][transaction.id];
 
-        // if we've had the transaction before, only report if there is a change
+        // if we've had the transaction before, only report if there is a status change
+        let isChanged = true;
         if (
           registeredTransaction &&
-          isEqual(registeredTransaction, transaction)
+          registeredTransaction.status === transaction.status
         ) {
-          return;
+          isChanged = false;
         }
 
         this._transactionsRegistry[assetCode][transaction.id] = transaction;
@@ -320,7 +319,9 @@ export class Watcher {
               isRetry: true,
             });
           }, timeout);
-          onMessage(transaction);
+          if (isChanged) {
+            onMessage(transaction);
+          }
         } else if (
           [
             TransactionStatus.completed,

package/test/wallet.test.ts

@@ -64,6 +64,13 @@ describe("SEP-24 flow", () => {
 let anchor: Anchor;
 let accountKp: SigningKeypair;
 let authToken: string;
+const makeTransaction = (eta: number, txStatus: TransactionStatus) => ({
+  kind: "deposit",
+  id: "TEST",
+  status: txStatus,
+  status_eta: eta,
+  message: "some message",
+});
 describe("Anchor", () => {
   beforeAll(() => {
     const Wal = Wallet.TestNet();
@@ -809,6 +816,56 @@ describe("Anchor", () => {
       expect(onMessage.callCount).toBe(3);
       expect(onError.callCount).toBe(0);
 
+      // stops watching
+      stop();
+    });
+    it("should only report transactions with changed status", async () => {
+      const txn1 = makeTransaction(0, TransactionStatus.incomplete);
+      const txn2 = makeTransaction(0, TransactionStatus.incomplete);
+      txn2.message = "message changing";
+      const txn3 = makeTransaction(0, TransactionStatus.pending_anchor);
+
+      const onMessage = sinon.spy((m) => {
+        expect(m.message).toBe("some message");
+        expect(onMessage.callCount).toBeLessThan(3);
+      });
+
+      const onError = sinon.spy((e) => {
+        expect(e).toBeUndefined();
+      });
+
+      // mock default transactions response
+      jest
+        .spyOn(Sep24.prototype, "getTransactionsForAsset")
+        .mockResolvedValueOnce([txn1])
+        .mockResolvedValueOnce([txn2])
+        .mockResolvedValueOnce([txn3]);
+
+      // start watching
+      const watcher = anchor.sep24().watcher();
+      const { stop } = watcher.watchAllTransactions({
+        authToken,
+        assetCode: "SRT",
+        lang: "en-US",
+        onMessage,
+        onError,
+        timeout: 1,
+      });
+
+      // nothing should run at first (async api call in progress)
+      expect(onMessage.callCount).toBe(0);
+      expect(onError.callCount).toBe(0);
+
+      clock.next();
+      await sleep(1);
+      clock.next();
+      await sleep(1);
+      clock.next();
+      await sleep(1);
+
+      expect(onMessage.callCount).toBe(2);
+      expect(onError.callCount).toBe(0);
+
       // stops watching
       stop();
     });
@@ -818,13 +875,6 @@ describe("Anchor", () => {
     let clock: sinon.SinonFakeTimers;
     let watcher: Watcher;
 
-    const makeTransaction = (eta: number, txStatus: TransactionStatus) => ({
-      kind: "deposit",
-      id: "TEST",
-      status: txStatus,
-      status_eta: eta,
-    });
-
     beforeEach(async () => {
       clock = sinon.useFakeTimers(0);
       watcher = anchor.sep24().watcher();
@@ -1120,7 +1170,7 @@ describe("Anchor", () => {
     });
 
     test("Several pending transactions, one completed, no more after that", async () => {
-      const onMessage = sinon.spy(() => {
+      const onMessage = sinon.spy((m) => {
         expect(onMessage.callCount).toBeLessThanOrEqual(8);
       });
 
@@ -1142,27 +1192,31 @@ describe("Anchor", () => {
         .mockResolvedValueOnce(
           makeTransaction(2, TransactionStatus.pending_anchor),
         )
+        // should not be logged to onMessage
         .mockResolvedValueOnce(
-          makeTransaction(3, TransactionStatus.pending_external),
+          makeTransaction(3, TransactionStatus.pending_anchor),
         )
         .mockResolvedValueOnce(
-          makeTransaction(4, TransactionStatus.pending_stellar),
+          makeTransaction(4, TransactionStatus.pending_external),
         )
         .mockResolvedValueOnce(
-          makeTransaction(5, TransactionStatus.pending_trust),
+          makeTransaction(5, TransactionStatus.pending_stellar),
+        )
+        .mockResolvedValueOnce(
+          makeTransaction(6, TransactionStatus.pending_trust),
         )
         .mockResolvedValueOnce(
-          makeTransaction(6, TransactionStatus.pending_user_transfer_start),
+          makeTransaction(7, TransactionStatus.pending_user_transfer_start),
         )
         .mockResolvedValueOnce(
-          makeTransaction(7, TransactionStatus.pending_user_transfer_complete),
+          makeTransaction(8, TransactionStatus.pending_user_transfer_complete),
         )
-        .mockResolvedValueOnce(makeTransaction(8, TransactionStatus.completed))
+        .mockResolvedValueOnce(makeTransaction(9, TransactionStatus.completed))
         .mockResolvedValueOnce(
-          makeTransaction(9, TransactionStatus.pending_anchor),
+          makeTransaction(10, TransactionStatus.pending_anchor),
         )
         .mockResolvedValueOnce(
-          makeTransaction(10, TransactionStatus.pending_external),
+          makeTransaction(11, TransactionStatus.pending_external),
         );
 
       // start watching
@@ -1206,6 +1260,9 @@ describe("Anchor", () => {
       clock.next();
       await sleep(1);
 
+      clock.next();
+      await sleep(1);
+
       // 1 incomplete + 7 pending transactions
       expect(onMessage.callCount).toBe(8);
       expect(onSuccess.callCount).toBe(0);
@@ -1686,6 +1743,64 @@ describe("Anchor", () => {
       expect(onSuccess.callCount).toBe(0);
       expect(onError.callCount).toBe(1);
     });
+
+    it("should only report transactions with changed status", async () => {
+      const txn1 = makeTransaction(0, TransactionStatus.incomplete);
+      const txn2 = makeTransaction(0, TransactionStatus.incomplete);
+      txn2.message = "message changing";
+      const txn3 = makeTransaction(0, TransactionStatus.pending_anchor);
+
+      const onMessage = sinon.spy((m) => {
+        expect(m.message).toBe("some message");
+        expect(onMessage.callCount).toBeLessThan(3);
+      });
+
+      const onSuccess = sinon.spy(() => {
+        expect(onSuccess.callCount).toBe(0);
+      });
+
+      const onError = sinon.spy((e) => {
+        expect(e).toBeUndefined();
+      });
+
+      // mock default transactions response
+      jest
+        .spyOn(Sep24.prototype, "getTransactionBy")
+        .mockResolvedValueOnce(txn1)
+        .mockResolvedValueOnce(txn2)
+        .mockResolvedValueOnce(txn3);
+
+      // start watching
+      const watcher = anchor.sep24().watcher();
+      const { stop } = watcher.watchOneTransaction({
+        authToken,
+        assetCode: "SRT",
+        id: "TEST",
+        lang: "en-US",
+        onMessage,
+        onSuccess,
+        onError,
+        timeout: 1,
+      });
+
+      // nothing should run at first (async api call in progress)
+      expect(onMessage.callCount).toBe(0);
+      expect(onError.callCount).toBe(0);
+
+      clock.next();
+      await sleep(1);
+      clock.next();
+      await sleep(1);
+      clock.next();
+      await sleep(1);
+
+      expect(onMessage.callCount).toBe(2);
+      expect(onError.callCount).toBe(0);
+      expect(onSuccess.callCount).toBe(0);
+
+      // stops watching
+      stop();
+    });
   });
 });
 

package/webpack.config.js

@@ -1,6 +1,6 @@
 const path = require("path");
 
-module.exports = {
+module.exports = (env = { NODE: false }) => ({
   mode: "development",
   entry: "./src/index.ts",
   devtool: "source-map",
@@ -25,10 +25,11 @@ module.exports = {
     },
   },
   output: {
-    library: "MyLibrary",
+    library: "WalletSDK",
     libraryTarget: "umd",
     globalObject: "this",
-    filename: "bundle.js",
+    filename: `bundle${!env.NODE ? "_browser" : ""}.js`,
     path: path.resolve(__dirname, "lib"),
   },
-};
+  target: env.NODE ? "node" : "web",
+});

package/lib/walletSdk/Watcher/Types.d.ts

@@ -1,65 +0,0 @@
-export declare enum TransactionStatus {
-    /**
-     * There is not yet enough information for this transaction to be initiated. Perhaps the user has
-     * not yet entered necessary info in an interactive flow
-     */
-    incomplete = "incomplete",
-    /**
-     * The user has not yet initiated their transfer to the anchor. This is the next necessary step in
-     * any deposit or withdrawal flow after transitioning from `incomplete`
-     */
-    pending_user_transfer_start = "pending_user_transfer_start",
-    /**
-     * The Stellar payment has been successfully received by the anchor and the off-chain funds are
-     * available for the customer to pick up. Only used for withdrawal transactions.
-     */
-    pending_user_transfer_complete = "pending_user_transfer_complete",
-    /**
-     * Pending External deposit/withdrawal has been submitted to external network, but is not yet
-     * confirmed. This is the status when waiting on Bitcoin or other external crypto network to
-     * complete a transaction, or when waiting on a bank transfer.
-     */
-    pending_external = "pending_external",
-    /**
-     * Deposit/withdrawal is being processed internally by anchor. This can also be used when the
-     * anchor must verify KYC information prior to deposit/withdrawal.
-     */
-    pending_anchor = "pending_anchor",
-    /**
-     * Deposit/withdrawal operation has been submitted to Stellar network, but is not yet confirmed.
-     */
-    pending_stellar = "pending_stellar",
-    /** The user must add a trustline for the asset for the deposit to complete. */
-    pending_trust = "pending_trust",
-    /**
-     * The user must take additional action before the deposit / withdrawal can complete, for example
-     * an email or 2fa confirmation of a withdrawal.
-     */
-    pending_user = "pending_user",
-    /** Deposit/withdrawal fully completed */
-    completed = "completed",
-    /** The deposit/withdrawal is fully refunded */
-    refunded = "refunded",
-    /**
-     * Funds were never received by the anchor and the transaction is considered abandoned by the
-     * user. Anchors are responsible for determining when transactions are considered expired.
-     */
-    expired = "expired",
-    /**
-     * Could not complete deposit because no satisfactory asset/XLM market was available to create the
-     * account
-     */
-    no_market = "no_market",
-    /** Deposit/withdrawal size less than min_amount. */
-    too_small = "too_small",
-    /** Deposit/withdrawal size exceeded max_amount. */
-    too_large = "too_large",
-    /** Catch-all for any error not enumerated above. */
-    error = "error"
-}
-export type WatcherRefreshFunction = () => void;
-export type WatcherStopFunction = () => void;
-export interface WatcherResponse {
-    refresh: WatcherRefreshFunction;
-    stop: WatcherStopFunction;
-}

package/lib/walletSdk/exception/index.d.ts

@@ -1,21 +0,0 @@
-export declare class ServerRequestFailedError extends Error {
-    constructor(e: any);
-}
-export declare class AssetNotSupportedError extends Error {
-    constructor(type: any, assetCode: any);
-}
-export declare class InvalidMemoError extends Error {
-    constructor();
-}
-export declare class ClientDomainWithMemoError extends Error {
-    constructor();
-}
-export declare class MissingTransactionIdError extends Error {
-    constructor();
-}
-export declare class InvalidTransactionResponseError extends Error {
-    constructor(transactionResponse: any);
-}
-export declare class InvalidTransactionsResponseError extends Error {
-    constructor(transactionsResponse: any);
-}

package/lib/walletSdk/horizon/constants.d.ts

@@ -1,4 +0,0 @@
-export declare enum NETWORK_URLS {
-    PUBLIC = "https://horizon.stellar.org",
-    TESTNET = "https://horizon-testnet.stellar.org"
-}

package/lib/walletSdk/interactive/index.d.ts

@@ -1,27 +0,0 @@
-type ExtraFields = {
-    [api_key: string]: string;
-};
-type InteractiveParams = {
-    accountAddress: string;
-    assetCode: string;
-    authToken: string;
-    lang?: string;
-    extraFields?: ExtraFields;
-    fundsAccountAddress?: string;
-};
-export declare enum FLOW_TYPE {
-    DEPOSIT = "deposit",
-    WITHDRAW = "withdraw"
-}
-export declare class Interactive {
-    private homeDomain;
-    private anchor;
-    private httpClient;
-    constructor(homeDomain: any, anchor: any, httpClient: any);
-    deposit(params: InteractiveParams): Promise<any>;
-    withdraw(params: InteractiveParams): Promise<any>;
-    flow(params: InteractiveParams & {
-        type: FLOW_TYPE;
-    }): Promise<any>;
-}
-export {};

package/lib/walletSdk/recovery/Recovery.d.ts

@@ -1,3 +0,0 @@
-export declare class Recovery {
-    constructor(cfg: any, stellar: any, client: any, servers: any);
-}

package/lib/walletSdk/toml/index.d.ts

@@ -1,78 +0,0 @@
-export type TomlInfo = {
-    version: string;
-    networkPassphrase: string;
-    federationServer: string;
-    authServer: string;
-    transferServer: string;
-    transferServerSep24: string;
-    kycServer: string;
-    webAuthEndpoint: string;
-    signingKey: string;
-    horizonUrl: string;
-    accounts: Array<string>;
-    uriRequestSigningKey: string;
-    directPaymentServer: string;
-    anchorQuoteServer: string;
-    documentation: {
-        orgName: string;
-        orgDba: string;
-        orgUrl: string;
-        orgLogo: string;
-        orgDescription: string;
-        orgPhysicalAddress: string;
-        orgPhysicalAddressAttestation: string;
-        orgPhoneNumber: string;
-        orgPhoneNumberAttestation: string;
-        orgKeybase: string;
-        orgTwitter: string;
-        orgGithub: string;
-        orgOfficialEmail: string;
-        orgSupportEmail: string;
-        orgLicensingAuthority: string;
-        orgLicenseType: string;
-        orgLicenseNumber: string;
-    };
-    principals: Array<{
-        name: string;
-        email: string;
-        keybase: string;
-        telegram: string;
-        twitter: string;
-        github: string;
-        idPhotoHash: string;
-        verificationPhotoHash: string;
-    }>;
-    currencies: Array<{
-        code: string;
-        codeTemplate: string;
-        issuer: string;
-        status: string;
-        displayDecimals: string;
-        name: string;
-        desc: string;
-        conditions: string;
-        image: string;
-        fixedNumber: string;
-        maxNumber: string;
-        isUnlimited: boolean;
-        isAssetAnchored: boolean;
-        anchorAssetType: string;
-        anchorAsset: string;
-        attestationOfReserve: string;
-        redemptionInstructions: string;
-        collateralAddresses: Array<string>;
-        collateralAddressMessages: Array<string>;
-        collateralAddressSignatures: Array<string>;
-        regulated: string;
-        approvalServer: string;
-        approvalCriteria: string;
-    }>;
-    validators: Array<{
-        alias: string;
-        displayName: string;
-        publicKey: string;
-        host: string;
-        history: string;
-    }>;
-};
-export declare const parseToml: (toml: any) => TomlInfo;

package/lib/walletSdk/util/camelToSnakeCase.d.ts

@@ -1,2 +0,0 @@
-export declare const camelToSnakeCaseKey: (key: string) => string;
-export declare const camelToSnakeCaseObject: (obj: any) => {};

package/lib/walletSdk/util/url.d.ts

@@ -1 +0,0 @@
-export declare const getUrlDomain: (url: any) => any;