@stellar/typescript-wallet-sdk 1.7.0 → 1.8.0-beta.1731096658096

package/src/walletSdk/Horizon/Transaction/TransactionBuilder.ts

@@ -15,6 +15,7 @@ import {
   WithdrawalTxMissingMemoError,
   WithdrawalTxNotPendingUserTransferStartError,
   WithdrawalTxMemoError,
+  WithdrawalTxMissingDestinationError,
 } from "../../Exceptions";
 import { StellarAssetId } from "../../Asset";
 import {
@@ -193,7 +194,7 @@ export class TransactionBuilder extends CommonTransactionBuilder<TransactionBuil
 
   /**
    * Swap assets using the Stellar network. This swaps using the
-   * pathPaymentStrictReceive operation.
+   * pathPaymentStrictSend operation.
    * @param {StellarAssetId} fromAsset - The source asset to be sent.
    * @param {StellarAssetId} toAsset - The destination asset to receive.
    * @param {string} amount - The amount of the source asset to be sent.
@@ -241,6 +242,7 @@ export class TransactionBuilder extends CommonTransactionBuilder<TransactionBuil
    * @param {WithdrawTransaction} transaction - The withdrawal transaction.
    * @param {StellarAssetId} assetId - The asset ID to transfer.
    * @throws {WithdrawalTxNotPendingUserTransferStartError} If the withdrawal transaction status is not pending_user_transfer_start.
+   * @throws {WithdrawalTxMissingDestinationError} If the withdrawal transaction is missing withdraw_anchor_account field.
    * @throws {WithdrawalTxMissingMemoError} If the withdrawal transaction is missing a memo.
    * @throws {WithdrawalTxMemoError} If there is an issue with the withdrawal transaction memo.
    * @returns {TransactionBuilder} The TransactionBuilder instance.
@@ -255,6 +257,11 @@ export class TransactionBuilder extends CommonTransactionBuilder<TransactionBuil
       );
     }
 
+    // We can't send a payment if we don't know the destination address
+    if (!transaction.withdraw_anchor_account) {
+      throw new WithdrawalTxMissingDestinationError();
+    }
+
     if (!(transaction.withdraw_memo_type && transaction.withdraw_memo)) {
       throw new WithdrawalTxMissingMemoError();
     }

package/src/walletSdk/Types/anchor.ts

@@ -2,25 +2,20 @@ import { MemoType } from "@stellar/stellar-sdk";
 import { Optional } from "utility-types";
 
 import { AuthToken } from "./auth";
-
-export interface AnchorServiceInfo {
-  deposit: AssetInfoMap;
-  withdraw: AssetInfoMap;
-  fee: { enabled: boolean };
-  features: { account_creation: boolean; claimable_balances: boolean };
-}
-
-export interface AssetInfoMap {
-  [asset_code: string]: AnchorServiceAsset;
-}
-
-export interface AnchorServiceAsset {
-  enabled: boolean;
-  min_amount: number;
-  max_amount: number;
-  fee_fixed: number;
-  fee_percent: number;
-}
+import { Sep24AssetInfo, Sep24AssetInfoMap, Sep24Info } from "./sep24";
+
+/**
+ * @deprecated Please use Sep24Info interface instead.
+ */
+export type AnchorServiceInfo = Sep24Info;
+/**
+ * @deprecated Please use Sep24AssetInfoMap interface instead.
+ */
+export type AssetInfoMap = Sep24AssetInfoMap;
+/**
+ * @deprecated Please use Sep24AssetInfo interface instead.
+ */
+export type AnchorServiceAsset = Sep24AssetInfo;
 
 export interface BaseTransaction {
   id: string;
@@ -60,7 +55,7 @@ export interface WithdrawTransaction extends ProcessingAnchorTransaction {
   to?: string;
   withdraw_memo?: string;
   withdraw_memo_type: MemoType;
-  withdraw_anchor_account: string;
+  withdraw_anchor_account?: string;
 }
 
 export type Sep6Transaction = DepositTransaction &

package/src/walletSdk/Types/sep12.ts

@@ -2,6 +2,10 @@ export type CustomerInfoMap = {
   [key: string]: string;
 };
 
+export type CustomerBinaryInfoMap = {
+  [key: string]: Buffer;
+};
+
 export enum Sep12Status {
   ACCEPTED = "ACCEPTED",
   PROCESSING = "PROCESSING",
@@ -38,6 +42,7 @@ export type GetCustomerParams = {
   type?: string;
   memo?: string;
   lang?: string;
+  transactionId?: string;
 };
 
 export type GetCustomerResponse = {
@@ -50,10 +55,11 @@ export type GetCustomerResponse = {
 
 export type AddCustomerParams = {
   sep9Info?: CustomerInfoMap;
-  sep9BinaryInfo?: CustomerInfoMap;
+  sep9BinaryInfo?: CustomerBinaryInfoMap;
   id?: string;
   memo?: string;
   type?: string;
+  transactionId?: string;
 };
 
 export type AddCustomerResponse = {

package/src/walletSdk/Types/sep24.ts

@@ -2,6 +2,25 @@ import { Memo } from "@stellar/stellar-sdk";
 
 import { AuthToken } from "./auth";
 
+export interface Sep24Info {
+  deposit: Sep24AssetInfoMap;
+  withdraw: Sep24AssetInfoMap;
+  fee: { enabled: boolean };
+  features: { account_creation: boolean; claimable_balances: boolean };
+}
+
+export interface Sep24AssetInfoMap {
+  [asset_code: string]: Sep24AssetInfo;
+}
+
+export interface Sep24AssetInfo {
+  enabled: boolean;
+  min_amount: number;
+  max_amount: number;
+  fee_fixed: number;
+  fee_percent: number;
+}
+
 export enum FLOW_TYPE {
   DEPOSIT = "deposit",
   WITHDRAW = "withdraw",

package/test/customer.test.ts

@@ -1,9 +1,9 @@
-import { Wallet } from "../src";
+import { Sep12, SigningKeypair, Wallet } from "../src";
 import axios from "axios";
 import { getRandomString } from "./utils";
 
-let wallet;
-let accountKp;
+let wallet: Wallet;
+let accountKp: SigningKeypair;
 
 describe("Customer", () => {
   beforeAll(async () => {
@@ -22,31 +22,36 @@ describe("Customer", () => {
     const auth = await anchor.sep10();
     const authToken = await auth.authenticate({ accountKp });
 
-    const sep12 = await anchor.sep12(authToken);
+    const sep12: Sep12 = await anchor.sep12(authToken);
     const customerType = "sep31-receiver";
     const customerEmail = `${getRandomString(6)}@gmail.com`;
 
     // Add
-    let resp = await sep12.add({
+    const addResp = await sep12.add({
       sep9Info: {
         first_name: "john",
         last_name: "smith",
         email_address: customerEmail,
         type: customerType,
       },
+      transactionId: "abcd1234",
     });
-    expect(resp.id).toBeTruthy();
-    const { id } = resp;
+    expect(addResp.id).toBeTruthy();
+    const { id } = addResp;
 
     // Get
-    resp = await sep12.getCustomer({ id, type: customerType });
-    expect(Object.keys(resp).sort()).toEqual(
+    const getResp = await sep12.getCustomer({
+      id,
+      type: customerType,
+      transactionId: "abcd1234",
+    });
+    expect(Object.keys(getResp).sort()).toEqual(
       ["id", "provided_fields", "fields", "status"].sort(),
     );
-    expect(Object.keys(resp?.provided_fields).sort()).toEqual(
+    expect(Object.keys(getResp?.provided_fields).sort()).toEqual(
       ["first_name", "last_name", "email_address"].sort(),
     );
-    expect(Object.keys(resp?.fields).sort()).toEqual(
+    expect(Object.keys(getResp?.fields).sort()).toEqual(
       [
         "bank_account_number",
         "bank_number",
@@ -56,7 +61,7 @@ describe("Customer", () => {
     );
 
     // Update
-    resp = await sep12.update({
+    const updateResp = await sep12.update({
       sep9Info: {
         first_name: "j",
         last_name: "s",
@@ -69,12 +74,17 @@ describe("Customer", () => {
         photo_id_back: Buffer.from("test-back-image"),
       },
       id,
+      transactionId: "abcd1234",
     });
-    expect(resp.id).toBeTruthy();
+    expect(updateResp.id).toBeTruthy();
 
     // Get again, check that the provided fields updated
-    resp = await sep12.getCustomer({ id, type: customerType });
-    expect(Object.keys(resp.fields).length).toBe(0);
+    const getResp2 = await sep12.getCustomer({
+      id,
+      type: customerType,
+      transactionId: "abcd1234",
+    });
+    expect(Object.keys(getResp2.fields).length).toBe(0);
 
     // Delete
     await sep12.delete();

package/test/stellar.test.ts

@@ -13,6 +13,11 @@ import {
   Assets,
 } from "../src/walletSdk/Asset";
 import { TransactionStatus, WithdrawTransaction } from "../src/walletSdk/Types";
+import {
+  WithdrawalTxMissingDestinationError,
+  WithdrawalTxMissingMemoError,
+  WithdrawalTxNotPendingUserTransferStartError,
+} from "../src/walletSdk/Exceptions";
 
 let wal: Wallet;
 let stellar: Stellar;
@@ -31,6 +36,7 @@ describe("Stellar", () => {
       await stellar.fundTestnetAccount(kp.publicKey);
     }
   }, 10000);
+
   it("should create and submit a transaction", async () => {
     const now = Math.floor(Date.now() / 1000) - 5;
 
@@ -190,34 +196,127 @@ describe("Stellar", () => {
     const tx = stellar.decodeTransaction(txnXdr);
     kp.sign(tx);
   });
-  it("should transfer withdrawal transaction", async () => {
-    const memoExamples = [
-      {
-        type: "text",
-        value: "example text",
-      },
-      {
-        type: "id",
-        value: "12345",
-      },
-      {
-        type: "hash",
-        value: "AAAAAAAAAAAAAAAAAAAAAMAP+8deo0TViBD09TfOBY0=",
-      },
-      {
-        type: "hash",
-        value: "MV9b23bQeMQ7isAGTkoBZGErH853yGk0W/yUx1iU7dM=",
-      },
-    ];
 
-    for (const memoExample of memoExamples) {
+  it("should return recommended fee", async () => {
+    const fee = await stellar.getRecommendedFee();
+    expect(fee).toBeTruthy();
+  });
+
+  describe("TransactionBuilder/transferWithdrawalTransaction", () => {
+    it("should transfer withdrawal transaction", async () => {
+      const memoExamples = [
+        {
+          type: "text",
+          value: "example text",
+        },
+        {
+          type: "id",
+          value: "12345",
+        },
+        {
+          type: "hash",
+          value: "AAAAAAAAAAAAAAAAAAAAAMAP+8deo0TViBD09TfOBY0=",
+        },
+        {
+          type: "hash",
+          value: "MV9b23bQeMQ7isAGTkoBZGErH853yGk0W/yUx1iU7dM=",
+        },
+      ];
+
+      for (const memoExample of memoExamples) {
+        const walletTransaction = {
+          id: "db15d166-5a5e-4d5c-ba5d-271c32cd8cf0",
+          kind: "withdrawal",
+          status: TransactionStatus.pending_user_transfer_start,
+          amount_in: "50.55",
+          withdraw_memo_type: memoExample.type,
+          withdraw_memo: memoExample.value,
+          withdraw_anchor_account:
+            "GCSGSR6KQQ5BP2FXVPWRL6SWPUSFWLVONLIBJZUKTVQB5FYJFVL6XOXE",
+        } as WithdrawTransaction;
+
+        const asset = new IssuedAssetId(
+          "USDC",
+          "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
+        );
+
+        const txBuilder = await stellar.transaction({
+          sourceAddress: kp,
+          baseFee: 100,
+        });
+
+        const txn = txBuilder
+          .transferWithdrawalTransaction(walletTransaction, asset)
+          .build();
+        expect(txn).toBeTruthy();
+      }
+    }, 20000);
+
+    it("should throw if tx not in pending_user_transfer_start status", async () => {
+      const walletTransaction = {
+        id: "db15d166-5a5e-4d5c-ba5d-271c32cd8cf0",
+        kind: "withdrawal",
+        status: TransactionStatus.pending_anchor,
+        amount_in: "50.55",
+        withdraw_memo_type: "text",
+        withdraw_memo: "example text",
+        withdraw_anchor_account:
+          "GCSGSR6KQQ5BP2FXVPWRL6SWPUSFWLVONLIBJZUKTVQB5FYJFVL6XOXE",
+      } as WithdrawTransaction;
+
+      const asset = new IssuedAssetId(
+        "USDC",
+        "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
+      );
+
+      const txBuilder = await stellar.transaction({
+        sourceAddress: kp,
+        baseFee: 100,
+      });
+
+      expect(() => {
+        txBuilder
+          .transferWithdrawalTransaction(walletTransaction, asset)
+          .build();
+      }).toThrowError(WithdrawalTxNotPendingUserTransferStartError);
+    }, 5000);
+
+    it("should throw if tx is missing withdraw_anchor_account", async () => {
+      const walletTransaction = {
+        id: "db15d166-5a5e-4d5c-ba5d-271c32cd8cf0",
+        kind: "withdrawal",
+        status: TransactionStatus.pending_user_transfer_start,
+        amount_in: "50.55",
+        withdraw_memo_type: "text",
+        withdraw_memo: "example text",
+        withdraw_anchor_account: null,
+      } as WithdrawTransaction;
+
+      const asset = new IssuedAssetId(
+        "USDC",
+        "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
+      );
+
+      const txBuilder = await stellar.transaction({
+        sourceAddress: kp,
+        baseFee: 100,
+      });
+
+      expect(() => {
+        txBuilder
+          .transferWithdrawalTransaction(walletTransaction, asset)
+          .build();
+      }).toThrowError(WithdrawalTxMissingDestinationError);
+    }, 5000);
+
+    it("should throw if tx is missing withdraw_memo_type", async () => {
       const walletTransaction = {
         id: "db15d166-5a5e-4d5c-ba5d-271c32cd8cf0",
         kind: "withdrawal",
         status: TransactionStatus.pending_user_transfer_start,
         amount_in: "50.55",
-        withdraw_memo_type: memoExample.type,
-        withdraw_memo: memoExample.value,
+        withdraw_memo_type: null,
+        withdraw_memo: "example text",
         withdraw_anchor_account:
           "GCSGSR6KQQ5BP2FXVPWRL6SWPUSFWLVONLIBJZUKTVQB5FYJFVL6XOXE",
       } as WithdrawTransaction;
@@ -232,16 +331,41 @@ describe("Stellar", () => {
         baseFee: 100,
       });
 
-      const txn = txBuilder
-        .transferWithdrawalTransaction(walletTransaction, asset)
-        .build();
-      expect(txn).toBeTruthy();
-    }
-  }, 20000);
+      expect(() => {
+        txBuilder
+          .transferWithdrawalTransaction(walletTransaction, asset)
+          .build();
+      }).toThrowError(WithdrawalTxMissingMemoError);
+    }, 5000);
 
-  it("should return recommended fee", async () => {
-    const fee = await stellar.getRecommendedFee();
-    expect(fee).toBeTruthy();
+    it("should throw if tx is missing withdraw_memo", async () => {
+      const walletTransaction = {
+        id: "db15d166-5a5e-4d5c-ba5d-271c32cd8cf0",
+        kind: "withdrawal",
+        status: TransactionStatus.pending_user_transfer_start,
+        amount_in: "50.55",
+        withdraw_memo_type: "text",
+        withdraw_memo: null,
+        withdraw_anchor_account:
+          "GCSGSR6KQQ5BP2FXVPWRL6SWPUSFWLVONLIBJZUKTVQB5FYJFVL6XOXE",
+      } as WithdrawTransaction;
+
+      const asset = new IssuedAssetId(
+        "USDC",
+        "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
+      );
+
+      const txBuilder = await stellar.transaction({
+        sourceAddress: kp,
+        baseFee: 100,
+      });
+
+      expect(() => {
+        txBuilder
+          .transferWithdrawalTransaction(walletTransaction, asset)
+          .build();
+      }).toThrowError(WithdrawalTxMissingMemoError);
+    }, 5000);
   });
 });
 

package/test/wallet.test.ts

@@ -156,7 +156,7 @@ describe("Anchor", () => {
     expect(signedByClient).toBe(true);
     expect(signedByDomain).toBe(true);
   });
-  it("should get anchor services info", async () => {
+  it("(deprecated) should get anchor services info", async () => {
     let serviceInfo = await anchor.sep24().getServicesInfo();
     expect(serviceInfo.deposit).toBeTruthy();
     expect(serviceInfo.withdraw).toBeTruthy();
@@ -167,6 +167,23 @@ describe("Anchor", () => {
     expect(serviceInfo.withdraw).toBeTruthy();
   });
 
+  it("should get anchor Sep-24 info", async () => {
+    const sep24Info = await anchor.sep24().info();
+    expect(sep24Info.deposit).toBeTruthy();
+    expect(sep24Info.withdraw).toBeTruthy();
+  });
+
+  it("should get anchor Sep-6 info", async () => {
+    const sep6Info = await anchor.sep6().info();
+    expect(sep6Info["deposit-exchange"]).toBeTruthy();
+    expect(sep6Info["withdraw-exchange"]).toBeTruthy();
+  });
+
+  it("should get anchor Sep-38 info", async () => {
+    const sep38Info = await anchor.sep38().info();
+    expect(sep38Info.assets).toBeTruthy();
+  });
+
   it("should give interactive deposit url", async () => {
     const assetCode = "SRT";
     const resp = await anchor.sep24().deposit({