@stellar/typescript-wallet-sdk 1.2.0 → 1.2.1

package/lib/index.d.ts

@@ -11,7 +11,7 @@ export { Anchor } from "./walletSdk/Anchor";
 export { Sep24 } from "./walletSdk/Anchor/Sep24";
 export { IssuedAssetId, NativeAssetId, FiatAssetId } from "./walletSdk/Asset";
 export { Sep10, WalletSigner, DefaultSigner } from "./walletSdk/Auth";
-export { PublicKeypair, SigningKeypair, AccountService, Stellar, TransactionBuilder, } from "./walletSdk/Horizon";
+export { PublicKeypair, SigningKeypair, AccountService, Stellar, TransactionBuilder, SponsoringBuilder, } from "./walletSdk/Horizon";
 export { Recovery } from "./walletSdk/Recovery";
 export { Watcher } from "./walletSdk/Watcher";
 /**

package/lib/walletSdk/Auth/WalletSigner.d.ts

@@ -1,7 +1,29 @@
 import { Transaction } from "stellar-sdk";
-import { SignWithClientAccountParams, SignWithDomainAccountParams } from "../Types";
+import { SignWithClientAccountParams, SignWithDomainAccountParams, HttpHeaders } from "../Types";
 export interface WalletSigner {
     signWithClientAccount({ transaction, accountKp, }: SignWithClientAccountParams): Transaction;
     signWithDomainAccount({ transactionXDR, networkPassphrase, accountKp, }: SignWithDomainAccountParams): Promise<Transaction>;
 }
 export declare const DefaultSigner: WalletSigner;
+/**
+ * Represents a Domain Signer used for signing Stellar transactions with a domain server.
+ *
+ * @class
+ * @implements {WalletSigner}
+ */
+export declare class DomainSigner implements WalletSigner {
+    private url;
+    private client;
+    private headers;
+    /**
+     * Create a new instance of the DomainSigner class.
+     *
+     * @constructor
+     * @param {string} url - The URL of the domain server.
+     * @param {HttpHeaders} headers - The HTTP headers for requests to the domain server.
+     * These headers can be used for authentication purposes.
+     */
+    constructor(url: string, headers: HttpHeaders);
+    signWithClientAccount({ transaction, accountKp, }: SignWithClientAccountParams): Transaction;
+    signWithDomainAccount({ transactionXDR, networkPassphrase, accountKp, }: SignWithDomainAccountParams): Promise<Transaction>;
+}

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

@@ -1,6 +1,7 @@
 import { Networks, Horizon } from "stellar-sdk";
-import { AnchorTransaction, FLOW_TYPE } from "../Types";
+import { AnchorTransaction, FLOW_TYPE, AxiosErrorData } from "../Types";
 export declare class ServerRequestFailedError extends Error {
+    data: AxiosErrorData;
     constructor(e: Error);
 }
 export declare class AssetNotSupportedError extends Error {
@@ -54,6 +55,9 @@ export declare class WithdrawalTxNotPendingUserTransferStartError extends Error
 export declare class WithdrawalTxMissingMemoError extends Error {
     constructor();
 }
+export declare class PathPayOnlyOneAmountError extends Error {
+    constructor();
+}
 export declare class WithdrawalTxMemoError extends Error {
     constructor();
 }

package/lib/walletSdk/Horizon/Transaction/CommonTransactionBuilder.d.ts

@@ -0,0 +1,18 @@
+import { xdr } from "stellar-sdk";
+import { IssuedAssetId } from "../../Asset";
+import { AccountKeypair } from "../Account";
+export declare abstract class CommonTransactionBuilder<T> {
+    protected sourceAddress: string;
+    protected operations: Array<xdr.Operation>;
+    constructor(sourceAddress: string, operations: Array<xdr.Operation>);
+    addAssetSupport(asset: IssuedAssetId, trustLimit?: string): T;
+    removeAssetSupport(asset: IssuedAssetId): T;
+    addAccountSigner(signerAddress: AccountKeypair, signerWeight: number): T;
+    removeAccountSigner(signerAddress: AccountKeypair): T;
+    lockAccountMasterKey(): T;
+    setThreshold({ low, medium, high, }: {
+        low?: number;
+        medium?: number;
+        high?: number;
+    }): T;
+}

package/lib/walletSdk/Horizon/Transaction/SponsoringBuilder.d.ts

@@ -0,0 +1,10 @@
+import { xdr } from "stellar-sdk";
+import { CommonTransactionBuilder } from "./CommonTransactionBuilder";
+import { AccountKeypair } from "../Account";
+export declare class SponsoringBuilder extends CommonTransactionBuilder<SponsoringBuilder> {
+    private sponsorAccount;
+    constructor(sponsoredAddress: string, sponsorAccount: AccountKeypair, operations: Array<xdr.Operation>, buildingFunction: (SponsoringBuilder: any) => SponsoringBuilder);
+    createAccount(newAccount: AccountKeypair, startingBalance?: number): SponsoringBuilder;
+    startSponsoring(): void;
+    stopSponsoring(): void;
+}

package/lib/walletSdk/Horizon/Transaction/TransactionBuilder.d.ts

@@ -1,20 +1,53 @@
 import { Account as StellarAccount, Transaction, Server, Memo, xdr } from "stellar-sdk";
 import { Config } from "walletSdk";
 import { AccountKeypair } from "../Account";
-import { IssuedAssetId, StellarAssetId } from "../../Asset";
-import { WithdrawTransaction } from "../../Types";
-export declare class TransactionBuilder {
-    private network;
-    private operations;
+import { StellarAssetId } from "../../Asset";
+import { WithdrawTransaction, PathPayParams } from "../../Types";
+import { CommonTransactionBuilder } from "./CommonTransactionBuilder";
+import { SponsoringBuilder } from "./SponsoringBuilder";
+export declare class TransactionBuilder extends CommonTransactionBuilder<TransactionBuilder> {
+    private cfg;
     private builder;
-    sourceAccount: string;
     constructor(cfg: Config, sourceAccount: StellarAccount, baseFee?: number, memo?: Memo, timebounds?: Server.Timebounds);
+    sponsoring(sponsorAccount: AccountKeypair, buildingFunction: (SponsoringBuilder: any) => SponsoringBuilder, sponsoredAccount?: AccountKeypair): TransactionBuilder;
     createAccount(newAccount: AccountKeypair, startingBalance?: number): TransactionBuilder;
     transfer(destinationAddress: string, assetId: StellarAssetId, amount: string): TransactionBuilder;
+    /**
+     * Creates and adds a path payment operation to the transaction builder.
+     *
+     * @param {string} destinationAddress - The destination Stellar address to which the payment is sent.
+     * @param {StellarAssetId} sendAsset - The asset to be sent.
+     * @param {StellarAssetId} destAsset - The asset the destination will receive.
+     * @param {string} [sendAmount] - The amount to be sent. Must specify either sendAmount or destAmount,
+     * but not both.
+     * @param {string} [destAmount] - The amount to be received by the destination. Must specify either sendAmount or destAmount,
+     * but not both.
+     * @param {string} [destMin] - The minimum amount of the destination asset to be receive. This is a
+     * protective measure, it allows you to specify a lower bound for an acceptable conversion. Only used
+     * if using sendAmount.
+     * (optional, default is ".0000001").
+     * @param {string} [sendMax] - The maximum amount of the destination asset to be sent. This is a
+     * protective measure, it allows you to specify an upper bound for an acceptable conversion. Only used
+     * if using destAmount.
+     * (optional, default is int64 max).
+     *
+     * @returns {TransactionBuilder} - Returns the current TransactionBuilder instance for method chaining.
+     */
+    pathPay({ destinationAddress, sendAsset, destAsset, sendAmount, destAmount, destMin, sendMax, }: PathPayParams): TransactionBuilder;
+    /**
+     * Swap assets using the Stellar network. This swaps using the
+     * pathPaymentStrictReceive 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.
+     * @param {string} [destMin] - (Optional) The minimum amount of the destination asset to be received.
+     *
+     * @returns {TransactionBuilder} Returns the current instance of the TransactionBuilder for method chaining.
+     */
+    swap(fromAsset: StellarAssetId, toAsset: StellarAssetId, amount: string, destMin?: string): TransactionBuilder;
     addOperation(op: xdr.Operation): TransactionBuilder;
     setMemo(memo: Memo): TransactionBuilder;
-    addAssetSupport(asset: IssuedAssetId, trustLimit?: string): TransactionBuilder;
-    removeAssetSupport(asset: IssuedAssetId): TransactionBuilder;
-    build(): Transaction;
     transferWithdrawalTransaction(transaction: WithdrawTransaction, assetId: StellarAssetId): TransactionBuilder;
+    build(): Transaction;
 }

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

@@ -2,3 +2,4 @@ export { PublicKeypair, SigningKeypair } from "./Account";
 export { AccountService } from "./AccountService";
 export { Stellar } from "./Stellar";
 export { TransactionBuilder } from "./Transaction/TransactionBuilder";
+export { SponsoringBuilder } from "./Transaction/SponsoringBuilder";

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

@@ -33,3 +33,6 @@ export type SignWithDomainAccountParams = {
     networkPassphrase: NetworkPassphrase;
     accountKp: AccountKeypair;
 };
+export type HttpHeaders = {
+    [key: string]: string;
+};

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

@@ -1,13 +1,14 @@
 import { Memo, Server, Transaction } from "stellar-sdk";
 import { AccountKeypair } from "../Horizon/Account";
 import { TransactionBuilder } from "../Horizon/Transaction/TransactionBuilder";
+import { StellarAssetId } from "../Asset";
 export declare enum NETWORK_URLS {
     PUBLIC = "https://horizon.stellar.org",
     TESTNET = "https://horizon-testnet.stellar.org"
 }
 export type TransactionParams = {
     sourceAddress: AccountKeypair;
-    baseFee: number;
+    baseFee?: number;
     memo?: Memo;
     timebounds?: Server.Timebounds | number;
 };
@@ -32,3 +33,12 @@ export declare enum HORIZON_ORDER {
     ASC = "asc",
     DESC = "desc"
 }
+export type PathPayParams = {
+    destinationAddress: string;
+    sendAsset: StellarAssetId;
+    destAsset: StellarAssetId;
+    sendAmount?: string;
+    destAmount?: string;
+    destMin?: string;
+    sendMax?: string;
+};

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

@@ -1,3 +1,4 @@
+import { RawAxiosRequestHeaders } from "axios";
 import { Server, Networks } from "stellar-sdk";
 import { ApplicationConfiguration, StellarConfiguration } from "walletSdk";
 export type WalletParams = {
@@ -22,6 +23,12 @@ export type StellarConfigurationParams = {
     baseFee?: number;
     defaultTimeout?: number;
 };
+export type AxiosErrorData = {
+    status?: number;
+    statusText?: string;
+    responseData?: any;
+    headers?: RawAxiosRequestHeaders;
+};
 export * from "./anchor";
 export * from "./auth";
 export * from "./horizon";

package/lib/walletSdk/Utils/extractAxiosErrorData.d.ts

@@ -0,0 +1,2 @@
+import { AxiosErrorData } from "../Types";
+export declare const extractAxiosErrorData: (error: Error) => AxiosErrorData;

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

@@ -1,3 +1,4 @@
 export * from "./camelToSnakeCase";
 export * from "./toml";
 export * from "./url";
+export * from "./extractAxiosErrorData";

package/lib/walletSdk/index.d.ts

@@ -34,5 +34,6 @@ export declare const DefaultClient: AxiosInstance;
 export declare class ApplicationConfiguration {
     defaultSigner: WalletSigner;
     defaultClient: AxiosInstance;
-    constructor(defaultSigner?: WalletSigner, defaultClient?: AxiosInstance);
+    defaultClientDomain?: string;
+    constructor(defaultSigner?: WalletSigner, defaultClient?: AxiosInstance, defaultClientDomain?: string);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stellar/typescript-wallet-sdk",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "engines": {
     "node": ">=18"
   },

package/src/walletSdk/Exceptions/index.ts

@@ -1,9 +1,23 @@
 import { Networks, Horizon } from "stellar-sdk";
-import { AnchorTransaction, FLOW_TYPE } from "../Types";
+import axios from "axios";
+import { AnchorTransaction, FLOW_TYPE, AxiosErrorData } from "../Types";
+import { extractAxiosErrorData } from "../Utils";
 
 export class ServerRequestFailedError extends Error {
+  data: AxiosErrorData;
+
   constructor(e: Error) {
-    super(`Server request failed with error: ${e}`);
+    if (axios.isAxiosError(e)) {
+      const errorData = extractAxiosErrorData(e);
+      const message =
+        errorData.responseData && Object.keys(errorData.responseData).length > 0
+          ? JSON.stringify(errorData.responseData)
+          : errorData.statusText;
+      super(`Server request failed with error: ${errorData.status} ${message}`);
+      this.data = errorData;
+    } else {
+      super(`Server request failed with error: ${e}`);
+    }
     Object.setPrototypeOf(this, ServerRequestFailedError.prototype);
   }
 }

package/src/walletSdk/Horizon/Stellar.ts

@@ -19,6 +19,7 @@ import {
   TransactionSubmitFailedError,
   TransactionSubmitWithFeeIncreaseFailedError,
   SignerRequiredError,
+  ServerRequestFailedError,
 } from "../Exceptions";
 import { getResultCode } from "../Utils/getResultCode";
 import { SigningKeypair } from "./Account";

package/src/walletSdk/Types/index.ts

@@ -1,4 +1,4 @@
-import { AxiosRequestConfig } from "axios";
+import { RawAxiosRequestHeaders } from "axios";
 import { Server, Networks } from "stellar-sdk";
 import { ApplicationConfiguration, StellarConfiguration } from "walletSdk";
 
@@ -30,6 +30,13 @@ export type StellarConfigurationParams = {
   defaultTimeout?: number;
 };
 
+export type AxiosErrorData = {
+  status?: number;
+  statusText?: string;
+  responseData?: any;
+  headers?: RawAxiosRequestHeaders;
+};
+
 // Export all other types from walletSdk/Types.ts
 export * from "./anchor";
 export * from "./auth";

package/src/walletSdk/Utils/extractAxiosErrorData.ts

@@ -0,0 +1,28 @@
+import axios from "axios";
+import { AxiosErrorData } from "../Types";
+
+// Based on https://axios-http.com/docs/handling_errors
+
+export const extractAxiosErrorData = (error: Error): AxiosErrorData => {
+  if (!axios.isAxiosError(error)) {
+    return { responseData: JSON.stringify(error) };
+  }
+  if (error.response) {
+    return {
+      status: error.response.status,
+      statusText: error.response.statusText,
+      responseData: error.response.data,
+      headers: error.response.headers,
+    };
+  } else if (error.request) {
+    // The request was made but no response was received
+    return {
+      statusText: `No response received from request: ${JSON.stringify(
+        error.request,
+      )}`,
+    };
+  } else {
+    // Something happened in setting up the request that triggered an Error
+    return { statusText: `Failed request with error: ${error.message}` };
+  }
+};

package/src/walletSdk/Utils/index.ts

@@ -1,3 +1,4 @@
 export * from "./camelToSnakeCase";
 export * from "./toml";
 export * from "./url";
+export * from "./extractAxiosErrorData";

package/test/wallet.test.ts

@@ -195,6 +195,25 @@ describe("Anchor", () => {
     expect(resp.id).toBeTruthy();
   });
 
+  it("should throw ServerRequestFailedError", async () => {
+    const assetCode = "SRT";
+    let didError = false;
+    try {
+      const resp = await anchor.sep24().withdraw({
+        withdrawalAccount: accountKp.publicKey,
+        assetCode,
+        authToken: "bad auth token",
+      });
+    } catch (e) {
+      didError = true;
+      expect(e.data.status).toBe(403);
+      expect(e.data.statusText).toBe("Forbidden");
+      expect(e.data.responseData.error).toBeTruthy();
+      expect(e.data.headers).toBeTruthy();
+    }
+    expect(didError).toBe(true);
+  });
+
   it("should fetch new transaction by id", async () => {
     const assetCode = "SRT";