@stellar/typescript-wallet-sdk 1.1.3 → 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.1.3",
+  "version": "1.2.1",
   "engines": {
     "node": ">=18"
   },
@@ -29,6 +29,7 @@
     "stream-browserify": "^3.0.0",
     "ts-jest": "^29.0.5",
     "ts-loader": "^9.4.2",
+    "ts-node": "^10.9.1",
     "tslib": "^2.5.0",
     "typescript": "^5.0.4",
     "webpack": "^5.83.1",
@@ -47,10 +48,11 @@
     "utility-types": "^3.10.0"
   },
   "scripts": {
-    "prepare": "yarn build",
+    "prepare": "husky install",
     "test": "jest --watchAll",
     "build:web": "webpack --config webpack.config.js",
     "build:node": "webpack --env NODE=true --config webpack.config.js",
-    "build": "run-p build:web build:node"
+    "build": "run-p build:web build:node",
+    "example:sep24": "ts-node examples/sep24/sep24.ts"
   }
 }

package/src/index.ts

@@ -23,6 +23,7 @@ export {
   AccountService,
   Stellar,
   TransactionBuilder,
+  SponsoringBuilder,
 } from "./walletSdk/Horizon";
 export { Recovery } from "./walletSdk/Recovery";
 export { Watcher } from "./walletSdk/Watcher";

package/src/walletSdk/Anchor/Sep24.ts

@@ -43,7 +43,9 @@ export class Sep24 {
 
   async deposit({
     assetCode,
+
     authToken,
+
     lang,
     extraFields,
     destinationMemo,

package/src/walletSdk/Auth/WalletSigner.ts

@@ -1,8 +1,17 @@
-import { Transaction } from "stellar-sdk";
+import {
+  Transaction,
+  TransactionBuilder as StellarTransactionBuilder,
+  FeeBumpTransaction,
+} from "stellar-sdk";
+import { AxiosInstance } from "axios";
+
 import {
   SignWithClientAccountParams,
   SignWithDomainAccountParams,
+  HttpHeaders,
 } from "../Types";
+import { AccountKeypair } from "../Horizon/Account";
+import { DefaultClient } from "../";
 
 export interface WalletSigner {
   signWithClientAccount({
@@ -28,3 +37,57 @@ export const DefaultSigner: WalletSigner = {
     );
   },
 };
+
+/**
+ * Represents a Domain Signer used for signing Stellar transactions with a domain server.
+ *
+ * @class
+ * @implements {WalletSigner}
+ */
+export class DomainSigner implements WalletSigner {
+  private url: string;
+  private client: AxiosInstance;
+  private headers: HttpHeaders;
+
+  /**
+   * 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) {
+    this.url = url;
+    this.client = DefaultClient;
+    this.headers = headers;
+  }
+
+  signWithClientAccount({
+    transaction,
+    accountKp,
+  }: SignWithClientAccountParams): Transaction {
+    transaction.sign(accountKp.keypair);
+    return transaction;
+  }
+
+  async signWithDomainAccount({
+    transactionXDR,
+    networkPassphrase,
+    accountKp,
+  }: SignWithDomainAccountParams): Promise<Transaction> {
+    const response = await this.client.post(
+      this.url,
+      {
+        transactionXDR,
+        networkPassphrase,
+      },
+      { headers: this.headers },
+    );
+
+    return StellarTransactionBuilder.fromXDR(
+      response.data.transaction,
+      networkPassphrase,
+    ) as Transaction;
+  }
+}

package/src/walletSdk/Auth/index.ts

@@ -55,7 +55,7 @@ export class Sep10 {
     const challengeResponse = await this.challenge({
       accountKp,
       memoId,
-      clientDomain,
+      clientDomain: clientDomain || this.cfg.app.defaultClientDomain,
     });
     const signedTransaction = await this.sign({
       accountKp,

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);
   }
 }
@@ -147,6 +161,12 @@ export class WithdrawalTxMissingMemoError extends Error {
   }
 }
 
+export class PathPayOnlyOneAmountError extends Error {
+  constructor() {
+    super("Must give sendAmount or destAmount value, but not both");
+    Object.setPrototypeOf(this, PathPayOnlyOneAmountError.prototype);
+  }
+}
 export class WithdrawalTxMemoError extends Error {
   constructor() {
     super(`Error parsing withdrawal transaction memo`);

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/Horizon/Transaction/CommonTransactionBuilder.ts

@@ -0,0 +1,75 @@
+import StellarSdk, { xdr } from "stellar-sdk";
+import { IssuedAssetId } from "../../Asset";
+import { AccountKeypair } from "../Account";
+
+export abstract class CommonTransactionBuilder<T> {
+  protected sourceAddress: string;
+  protected operations: Array<xdr.Operation>;
+
+  constructor(sourceAddress: string, operations: Array<xdr.Operation>) {
+    this.sourceAddress = sourceAddress;
+    this.operations = operations;
+  }
+
+  addAssetSupport(asset: IssuedAssetId, trustLimit?: string): T {
+    this.operations.push(
+      StellarSdk.Operation.changeTrust({
+        asset: asset.toAsset(),
+        limit: trustLimit,
+        source: this.sourceAddress,
+      }),
+    );
+    return this as any as T;
+  }
+
+  removeAssetSupport(asset: IssuedAssetId): T {
+    return this.addAssetSupport(asset, "0");
+  }
+
+  addAccountSigner(signerAddress: AccountKeypair, signerWeight: number): T {
+    this.operations.push(
+      StellarSdk.Operation.setOptions({
+        source: this.sourceAddress,
+        signer: {
+          ed25519PublicKey: signerAddress.publicKey,
+          weight: signerWeight,
+        },
+      }),
+    );
+    return this as any as T;
+  }
+
+  removeAccountSigner(signerAddress: AccountKeypair): T {
+    return this.addAccountSigner(signerAddress, 0);
+  }
+
+  lockAccountMasterKey(): T {
+    this.operations.push(
+      StellarSdk.Operation.setOptions({
+        source: this.sourceAddress,
+        masterWeight: 0,
+      }),
+    );
+    return this as any as T;
+  }
+
+  setThreshold({
+    low,
+    medium,
+    high,
+  }: {
+    low?: number;
+    medium?: number;
+    high?: number;
+  }): T {
+    this.operations.push(
+      StellarSdk.Operation.setOptions({
+        source: this.sourceAddress,
+        lowThreshold: low,
+        medThreshold: medium,
+        highThreshold: high,
+      }),
+    );
+    return this as any as T;
+  }
+}

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

@@ -0,0 +1,58 @@
+import StellarSdk, {
+  TransactionBuilder as StellarTransactionBuilder,
+  Transaction,
+  xdr,
+} from "stellar-sdk";
+import { IssuedAssetId } from "../../Asset";
+
+import { CommonTransactionBuilder } from "./CommonTransactionBuilder";
+import { AccountKeypair } from "../Account";
+
+export class SponsoringBuilder extends CommonTransactionBuilder<SponsoringBuilder> {
+  private sponsorAccount: AccountKeypair;
+
+  constructor(
+    sponsoredAddress: string,
+    sponsorAccount: AccountKeypair,
+    operations: Array<xdr.Operation>,
+    buildingFunction: (SponsoringBuilder) => SponsoringBuilder,
+  ) {
+    super(sponsoredAddress, operations);
+    this.sponsorAccount = sponsorAccount;
+
+    this.startSponsoring();
+    buildingFunction(this);
+    this.stopSponsoring();
+  }
+
+  createAccount(
+    newAccount: AccountKeypair,
+    startingBalance: number = 0,
+  ): SponsoringBuilder {
+    this.operations.push(
+      StellarSdk.Operation.createAccount({
+        destination: newAccount.publicKey,
+        startingBalance: startingBalance.toString(),
+        source: this.sponsorAccount.publicKey,
+      }),
+    );
+    return this;
+  }
+
+  startSponsoring() {
+    this.operations.push(
+      StellarSdk.Operation.beginSponsoringFutureReserves({
+        sponsoredId: this.sourceAddress,
+        source: this.sponsorAccount.publicKey,
+      }),
+    );
+  }
+
+  stopSponsoring() {
+    this.operations.push(
+      StellarSdk.Operation.endSponsoringFutureReserves({
+        source: this.sourceAddress,
+      }),
+    );
+  }
+}