@stellar/typescript-wallet-sdk 1.2.0 → 1.3.0

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 { AccountKeypair, PublicKeypair, SigningKeypair, AccountService, Stellar, CommonTransactionBuilder, TransactionBuilder, SponsoringBuilder, } from "./walletSdk/Horizon";
 export { Recovery } from "./walletSdk/Recovery";
 export { Watcher } from "./walletSdk/Watcher";
 /**

package/lib/walletSdk/Anchor/Sep24.d.ts

@@ -6,42 +6,85 @@ type Sep24Params = {
     anchor: Anchor;
     httpClient: AxiosInstance;
 };
+/**
+ * Interactive flow for deposit and withdrawal using SEP-24.
+ * @see {@link https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md}
+ * Do not create this object directly, use the Anchor class.
+ * @class
+ */
 export declare class Sep24 {
     private anchor;
     private httpClient;
+    /**
+     * Creates a new instance of the Sep24 class.
+     * @constructor
+     * @param {Sep24Params} params - Parameters to initialize the Sep24 instance.
+     */
     constructor(params: Sep24Params);
+    /**
+     * Initiates a deposit request.
+     * @param {Sep24PostParams} params - The SEP-24 Post params.
+     * @param {string} params.assetCode - The asset to deposit.
+     * @param {AuthToken} params.authToken - Authentication token for the request.
+     * @param {string} [params.lang] - The language for the request (defaults to the Anchor's language).
+     * @param {ExtraFields} [params.extraFields] - Additional fields for the request.
+     * @param {Memo} [params.destinationMemo] - Memo information for the destination account.
+     * @param {string} [params.destinationAccount] - The destination account for the deposit.
+     * @returns {Promise<Sep24PostResponse>} The Sep24 response.
+     * @throws {AssetNotSupportedError} If the asset is not supported for deposit.
+     */
     deposit({ assetCode, authToken, lang, extraFields, destinationMemo, destinationAccount, }: Sep24PostParams): Promise<Sep24PostResponse>;
+    /**
+     * Initiates a withdrawal request.
+     * @param {Sep24PostParams} params - The SEP-24 Post params.
+     * @param {string} params.assetCode - The asset to withdraw.
+     * @param {AuthToken} params.authToken - Authentication token for the request.
+     * @param {string} [params.lang] - The language for the request (defaults to the Anchor's language).
+     * @param {ExtraFields} [params.extraFields] - Additional fields for the request.
+     * @param {string} [params.withdrawalAccount] - The withdrawal account.
+     * @returns {Promise<Sep24PostResponse>} The Sep24 response.
+     * @throws {AssetNotSupportedError} If the asset is not supported for withdrawal.
+     */
     withdraw({ assetCode, authToken, lang, extraFields, withdrawalAccount, }: Sep24PostParams): Promise<Sep24PostResponse>;
     private flow;
+    /**
+     * Retrieves information about the Anchor.
+     * @returns {Promise<AnchorServiceInfo>} An object containing information about the Anchor.
+     * @throws {ServerRequestFailedError} If the server request to fetch information fails.
+     */
     getServicesInfo(): Promise<AnchorServiceInfo>;
+    /**
+     * Creates a new instance of the Watcher class, to watch sep24 transactions.
+     * @returns {Watcher} A new Watcher instance.
+     */
     watcher(): Watcher;
     /**
-     * Get single transaction's current status and details. One of the [id], [stellarTransactionId],
-     * [externalTransactionId] must be provided.
-     *
-     * @param authToken auth token of the account authenticated with the anchor
-     * @param id transaction ID
-     * @param stellarTransactionId stellar transaction ID
-     * @param externalTransactionId external transaction ID
-     * @return transaction object
-     * @throws [MissingTransactionIdError] if none of the id params is provided
-     * @throws [InvalidTransactionResponseError] if Anchor returns an invalid transaction
-     * @throws [ServerRequestFailedError] if server request fails
+     * Get single transaction's current status and details from the anchor.
+     * @param {GetTransactionParams} params - The Get Transactions params.
+     * @param {AuthToken} params.authToken - The authentication token for the account authenticated with the anchor.
+     * @param {string} [params.id] - The transaction ID.
+     * @param {string} [params.stellarTransactionId] - The Stellar transaction ID.
+     * @param {string} [params.externalTransactionId] - The external transaction ID.
+     * @param {string} [params.lang] - The language setting.
+     * @returns {Promise<AnchorTransaction>} The transaction object.
+     * @throws {MissingTransactionIdError} If none of the ID parameters is provided.
+     * @throws {InvalidTransactionResponseError} If the anchor returns an invalid transaction response.
+     * @throws {ServerRequestFailedError} If the server request fails.
      */
     getTransactionBy({ authToken, id, stellarTransactionId, externalTransactionId, lang, }: GetTransactionParams): Promise<AnchorTransaction>;
     /**
      * Get account's transactions specified by asset and other params.
-     *
-     * @param authToken auth token of the account authenticated with the anchor
-     * @param assetCode target asset to query for
-     * @param noOlderThan response should contain transactions starting on or after this date & time
-     * @param limit response should contain at most 'limit' transactions
-     * @param kind kind of transaction that is desired. E.g.: 'deposit', 'withdrawal'
-     * @param pagingId response should contain transactions starting prior to this ID (exclusive)
-     * @param lang desired language (localization), it can also accept locale in the format 'en-US'
-     * @return list of transactions as requested by the client, sorted in time-descending order
-     * @throws [InvalidTransactionsResponseError] if Anchor returns an invalid response
-     * @throws [ServerRequestFailedError] if server request fails
+     * @param {GetTransactionParams} params - The Get Transactions params.
+     * @param {AuthToken} params.authToken - The authentication token for the account authenticated with the anchor.
+     * @param {string} params.assetCode - The target asset to query for.
+     * @param {string} [params.noOlderThan] - The response should contain transactions starting on or after this date & time.
+     * @param {string} [params.limit] - The response should contain at most 'limit' transactions.
+     * @param {string} [params.kind] - The kind of transaction that is desired. E.g.: 'deposit', 'withdrawal'.
+     * @param {string} [params.pagingId] - The response should contain transactions starting prior to this ID (exclusive).
+     * @param {string} [params.lang] - The desired language (localization), it can also accept locale in the format 'en-US'.
+     * @returns {Promise<AnchorTransaction[]>} A list of transactions as requested by the client, sorted in time-descending order.
+     * @throws {InvalidTransactionsResponseError} Anchor returns an invalid response.
+     * @throws {ServerRequestFailedError} If server request fails.
      */
     getTransactionsForAsset({ authToken, assetCode, noOlderThan, limit, kind, pagingId, lang, }: GetTransactionsParams): Promise<AnchorTransaction[]>;
 }

package/lib/walletSdk/Anchor/Sep38.d.ts

@@ -0,0 +1,56 @@
+import { Sep38Info, Sep38Params, Sep38PricesParams, Sep38PriceParams, Sep38PricesResponse, Sep38PriceResponse, Sep38PostQuoteParams, Sep38PostQuoteResponse } from "../Types";
+/**
+ * Quote service using SEP-38. It can be used for getting price quotes from an anchor
+ * for exchanging assets.
+ * @see {@link https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md}
+ * Do not create this object directly, use the Anchor class.
+ * @class
+ */
+export declare class Sep38 {
+    private anchor;
+    private httpClient;
+    private authToken;
+    private headers;
+    private sep38Info;
+    /**
+     * Creates a new instance of the Sep38 class.
+     * @constructor
+     * @param {Sep38Params} params - Parameters to initialize the Sep38 instance.
+     */
+    constructor(params: Sep38Params);
+    /**
+     * Get SEP-38 anchor information.
+     * If `shouldRefresh` is set to `true`, it fetches fresh values; otherwise, it returns cached values if available.
+     * @param {boolean} [shouldRefresh=false] - Flag to force a refresh of TOML values.
+     * @returns {Promise<Sep38Info>} - SEP-38 information about the anchor.
+     */
+    info(shouldRefresh?: boolean): Promise<Sep38Info>;
+    /**
+     * Get indicative prices of off-chain assets in exchange for a Stellar asset, or vice versa,
+     * from an anchor using Sep-38.
+     * @param {Sep38PricesParams} params - The parameters for the GET prices request.
+     * if the anchor does not require it.
+     * @returns {Promise<Sep38PricesResponse>} - SEP-38 /prices response.
+     */
+    prices(params: Sep38PricesParams): Promise<Sep38PricesResponse>;
+    /**
+     * Get an indicative price for an an asset pair from and anchor using SEP-38.
+     * @param {Sep38PriceParams} params - The parameters for the GET price request.
+     * if the anchor does not require it.
+     * @throws {Sep38PriceOnlyOneAmountError} Must give only sellAmount or buyAmount, and not both.
+     * @returns {Promise<Sep38PriceResponse>} - SEP-38 /price response.
+     */
+    price(params: Sep38PriceParams): Promise<Sep38PriceResponse>;
+    /**
+     * Request a firm quote from the anchor.
+     * @param {Sep38PostQuoteParams} params - The parameters for the quote request.
+     * @returns {Promise<Sep38PostQuoteResponse>} - SEP-38 quote response.
+     */
+    requestQuote(params: Sep38PostQuoteParams): Promise<Sep38PostQuoteResponse>;
+    /**
+     * Get a previously-provided quote from the anchor.
+     * @param {string} quoteId - The id of the quote to fetch.
+     * @returns {Promise<Sep38PostQuoteResponse>} - SEP-38 quote response.
+     */
+    getQuote(quoteId: string): Promise<Sep38PostQuoteResponse>;
+}

package/lib/walletSdk/Anchor/Sep6.d.ts

@@ -0,0 +1,127 @@
+import { Sep6Info, Sep6Params, Sep6DepositParams, Sep6WithdrawParams, Sep6DepositResponse, Sep6WithdrawResponse, Sep6ExchangeParams, Sep6Transaction, GetTransactionParams, GetTransactionsParams, AuthToken } from "../Types";
+import { Watcher } from "../Watcher";
+/**
+ * Flow for creating deposits and withdrawals with an anchor using SEP-6.
+ * For an interactive flow use Sep24 instead.
+ * @see {@link https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0006.md}
+ * Do not create this object directly, use the Anchor class.
+ * @class
+ */
+export declare class Sep6 {
+    private anchor;
+    private httpClient;
+    private anchorInfo;
+    /**
+     * Creates a new instance of the Sep6 class.
+     * @constructor
+     * @param {Sep6Params} params - Parameters to initialize the Sep6 instance.
+     */
+    constructor(params: Sep6Params);
+    /**
+     * Get SEP-6 anchor information.
+     * If `shouldRefresh` is set to `true`, it fetches fresh values; otherwise, it returns cached values if available.
+     * @param {boolean} [shouldRefresh=false] - Flag to force a refresh of TOML values.
+     * @returns {Promise<Sep6Info>} - SEP-6 information about the anchor.
+     */
+    info(shouldRefresh?: boolean): Promise<Sep6Info>;
+    /**
+     * Deposits funds using the SEP-6 protocol. Next steps by
+     * the anchor are given in the response.
+     *
+     * @param {object} options - The options for the deposit.
+     * @param {AuthToken} options.authToken - The authentication token.
+     * @param {Sep6DepositParams} options.params - The parameters for the deposit request.
+     *
+     * @returns {Promise<Sep6DepositResponse>} Sep6 deposit response, containing next steps if needed
+     * to complete the deposit.
+     *
+     * @throws {Error} If an unexpected error occurs during the deposit operation.
+     */
+    deposit({ authToken, params, }: {
+        authToken: AuthToken;
+        params: Sep6DepositParams;
+    }): Promise<Sep6DepositResponse>;
+    /**
+     * Initiates a withdrawal using SEP-6.
+     *
+     * @param {object} options - The options for the withdrawal operation.
+     * @param {AuthToken} options.authToken - The authentication token.
+     * @param {Sep6WithdrawParams} options.params - The parameters for the withdrawal request.
+     *
+     * @returns {Promise<Sep6WithdrawResponse>} Sep6 withdraw response.
+     */
+    withdraw({ authToken, params, }: {
+        authToken: AuthToken;
+        params: Sep6WithdrawParams;
+    }): Promise<Sep6WithdrawResponse>;
+    /**
+     * Similar to the SEP-6 deposit function, but for non-equivalent assets
+     * that require an exchange.
+     *
+     * @param {object} options - The options for the deposit exchange.
+     * @param {AuthToken} options.authToken - The authentication token.
+     * @param {Sep6ExchangeParams} options.params - The parameters for the deposit request.
+     *
+     * @returns {Promise<Sep6DepositResponse>} Sep6 deposit response, containing next steps if needed
+     * to complete the deposit.
+     *
+     * @throws {Error} If an unexpected error occurs during the deposit operation.
+     */
+    depositExchange({ authToken, params, }: {
+        authToken: AuthToken;
+        params: Sep6ExchangeParams;
+    }): Promise<Sep6DepositResponse>;
+    /**
+     * Similar to the SEP-6 withdraw function, but for non-equivalent assets
+     * that require an exchange.
+     *
+     * @param {object} options - The options for the deposit exchange.
+     * @param {AuthToken} options.authToken - The authentication token.
+     * @param {Sep6ExchangeParams} options.params - The parameters for the deposit request.
+     *
+     * @returns {Promise<Sep6WithdrawResponse>} Sep6 withdraw response, containing next steps if needed
+     * to complete the withdrawal.
+     *
+     * @throws {Error} If an unexpected error occurs during the deposit operation.
+     */
+    withdrawExchange({ authToken, params, }: {
+        authToken: AuthToken;
+        params: Sep6ExchangeParams;
+    }): Promise<Sep6WithdrawResponse>;
+    private flow;
+    /**
+     * Creates a new instance of the Watcher class, to watch sep6 transactions.
+     * @returns {Watcher} A new Watcher instance.
+     */
+    watcher(): Watcher;
+    /**
+     * Get account's sep6 transactions specified by asset and other params.
+     * @param {GetTransactionsParams} params - The Get Transactions params.
+     * @param {AuthToken} params.authToken - The authentication token for the account authenticated with the anchor.
+     * @param {string} params.assetCode - The target asset to query for.
+     * @param {string} [params.noOlderThan] - The response should contain transactions starting on or after this date & time.
+     * @param {string} [params.limit] - The response should contain at most 'limit' transactions.
+     * @param {string} [params.kind] - The kind of transaction that is desired. E.g.: 'deposit', 'withdrawal', 'depo
+     * -exchange', 'withdrawal-exchange'.
+     * @param {string} [params.pagingId] - The response should contain transactions starting prior to this ID (exclusive).
+     * @param {string} [params.lang] - The desired language (localization), it can also accept locale in the format 'en-US'.
+     * @returns {Promise<Sep6Transaction[]>} A list of transactions as requested by the client, sorted in time-descending order.
+     * @throws {InvalidTransactionsResponseError} Anchor returns an invalid response.
+     * @throws {ServerRequestFailedError} If server request fails.
+     */
+    getTransactionsForAsset({ authToken, assetCode, noOlderThan, limit, kind, pagingId, lang, }: GetTransactionsParams): Promise<Sep6Transaction[]>;
+    /**
+     * Get single sep6 transaction's current status and details from the anchor.
+     * @param {GetTransactionParams} params - The Get Transactions params.
+     * @param {AuthToken} params.authToken - The authentication token for the account authenticated with the anchor.
+     * @param {string} [params.id] - The transaction ID.
+     * @param {string} [params.stellarTransactionId] - The Stellar transaction ID.
+     * @param {string} [params.externalTransactionId] - The external transaction ID.
+     * @param {string} [params.lang] - The language setting.
+     * @returns {Promise<Sep6Transaction>} The transaction object.
+     * @throws {MissingTransactionIdError} If none of the ID parameters is provided.
+     * @throws {InvalidTransactionResponseError} If the anchor returns an invalid transaction response.
+     * @throws {ServerRequestFailedError} If the server request fails.
+     */
+    getTransactionBy({ authToken, id, stellarTransactionId, externalTransactionId, lang, }: GetTransactionParams): Promise<Sep6Transaction>;
+}

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

@@ -1,24 +1,114 @@
 import { AxiosInstance } from "axios";
 import { Config } from "walletSdk";
 import { Sep10 } from "../Auth";
+import { Sep12 } from "../Customer";
+import { Sep6 } from "./Sep6";
 import { Sep24 } from "./Sep24";
-import { AnchorServiceInfo, TomlInfo } from "../Types";
+import { Sep38 } from "./Sep38";
+import { AnchorServiceInfo, TomlInfo, AuthToken } from "../Types";
 type AnchorParams = {
     cfg: Config;
     homeDomain: string;
     httpClient: AxiosInstance;
     language: string;
 };
+export type Transfer = Sep6;
+export type Auth = Sep10;
+export type Customer = Sep12;
+export type Interactive = Sep24;
+export type Quote = Sep38;
+/**
+ * Build on/off ramps with anchors.
+ * Do not create this object directly, use the Wallet class.
+ * @class
+ */
 export declare class Anchor {
     language: string;
     private cfg;
     private homeDomain;
     private httpClient;
     private toml;
+    /**
+     * Creates a new Anchor instance.
+     * @constructor
+     * @param {AnchorParams} params - The parameters to initialize the Anchor.
+     */
     constructor(params: AnchorParams);
+    /**
+     * Get anchor information from a TOML file.
+     * If `shouldRefresh` is set to `true`, it fetches fresh TOML values; otherwise, it returns cached values if available.
+     * @param {boolean} [shouldRefresh=false] - Flag to force a refresh of TOML values.
+     * @returns {Promise<TomlInfo>} - TOML information about the anchor.
+     */
     sep1(shouldRefresh?: boolean): Promise<TomlInfo>;
+    /**
+     * Retrieves and returns TOML information using the `sep1` method.
+     * @param {boolean} [shouldRefresh=false] - Flag to force a refresh of TOML values.
+     * @returns {Promise<TomlInfo>} - TOML information.
+     */
+    getInfo(shouldRefresh?: boolean): Promise<TomlInfo>;
+    /**
+     * Creates new transfer flow for given anchor. It can be used for withdrawal or deposit.
+     * @returns {Sep6} - flow service.
+     */
+    sep6(): Sep6;
+    /**
+     * Creates new transfer flow using the `sep6` method.
+     * @returns {Transfer} - transfer flow service.
+     */
+    transfer(): Transfer;
+    /**
+     * Create new auth object to authenticate account with the anchor using SEP-10.
+     * @returns {Promise<Sep10>} - The SEP-10 authentication manager.
+     */
     sep10(): Promise<Sep10>;
+    /**
+     * Create new auth object to authenticate with using the `sep10` method.
+     * @returns {Promise<Auth>} - The SEP-10 authentication manager.
+     */
+    auth(): Promise<Auth>;
+    /**
+     * Create new customer object to handle customer records with the anchor using SEP-12.
+     * @param {AuthToken} authToken - The authentication token.
+     * @returns {Promise<Sep12>} - A Sep12 customer instance.
+     * @throws {KYCServerNotFoundError} - If the KYC server information is not available.
+     */
+    sep12(authToken: AuthToken): Promise<Sep12>;
+    /**
+     * Create new customer object to handle customer records using the `sep12` method.
+     * @param {AuthToken} authToken - The authentication token.
+     * @returns {Promise<Customer>} - A Customer instance.
+     */
+    customer(authToken: AuthToken): Promise<Customer>;
+    /**
+     * Creates new interactive flow for given anchor. It can be used for withdrawal or deposit.
+     * @returns {Sep24} - interactive flow service.
+     */
     sep24(): Sep24;
+    /**
+     * Creates new interactive flow using the `sep24` method.
+     * @returns {Interactive} - interactive flow service
+     */
+    interactive(): Interactive;
+    /**
+     * Creates a new quote service. It can be used for getting price quotes from an anchor
+     * for exchanging assets.
+     * @param {AuthToken} [authToken] - The authentication token.
+     * @returns {Sep38} - quote service.
+     */
+    sep38(authToken?: AuthToken): Sep38;
+    /**
+     * Creates a new quote service using the `sep38` method.
+     * @param {AuthToken} [authToken] - The authentication token.
+     * @returns {Quote} - quote service.
+     */
+    quote(authToken?: AuthToken): Quote;
+    /**
+     * Get information about an Anchor.
+     * @param {string} [lang=this.language] - The language in which to retrieve information.
+     * @returns {Promise<AnchorServiceInfo>} An object containing information about the Anchor.
+     * @throws {ServerRequestFailedError} If the http request fails.
+     */
     getServicesInfo(lang?: string): Promise<AnchorServiceInfo>;
 }
 export {};

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

@@ -1,3 +1,4 @@
+import { Asset as StellarAsset } from "stellar-sdk";
 declare class AssetId {
     id: string;
     scheme: string;
@@ -8,12 +9,13 @@ export declare class StellarAssetId extends AssetId {
     code: string;
     issuer: string;
     scheme: string;
-    toAsset(): any;
+    toAsset(): StellarAsset;
 }
 export declare class IssuedAssetId extends StellarAssetId {
     constructor(code: string, issuer: string);
     toString(): string;
 }
+export type XLM = NativeAssetId;
 export declare class NativeAssetId extends StellarAssetId {
     id: string;
     code: string;
@@ -24,4 +26,12 @@ export declare class FiatAssetId extends AssetId {
     constructor(code: string);
     toString(): string;
 }
+export declare const Assets: {
+    Main: {
+        USDC: IssuedAssetId;
+    };
+    Test: {
+        USDC: IssuedAssetId;
+    };
+};
 export {};

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

@@ -1,7 +1,47 @@
 import { Transaction } from "stellar-sdk";
-import { SignWithClientAccountParams, SignWithDomainAccountParams } from "../Types";
+import { SignWithClientAccountParams, SignWithDomainAccountParams, HttpHeaders } from "../Types";
+/**
+ * A Wallet Signer for signing Stellar transactions.
+ */
 export interface WalletSigner {
+    /**
+     * Sign a transaction with a client keypair.
+     * @param {Transaction} params.transaction - The transaction to sign.
+     * @param {AccountKeypair} params.accountKp - The keypair to sign with.
+     * @returns {Transaction} The signed transaction.
+     */
     signWithClientAccount({ transaction, accountKp, }: SignWithClientAccountParams): Transaction;
+    /**
+     * Sign a transaction using the domain account's keypair. This method is async in the
+     * case of signing with a different server.
+     * @param {XdrEncodedTransaction} params.transactionXDR - The XDR representation of the transaction to sign.
+     * @param {NetworkPassphrase} params.networkPassphrase - The network passphrase for the Stellar network.
+     * @param {AccountKeypair} params.accountKp - The keypair of the domain account.
+     * @returns {Promise<Transaction>} The signed transaction.
+     */
     signWithDomainAccount({ transactionXDR, networkPassphrase, accountKp, }: SignWithDomainAccountParams): Promise<Transaction>;
 }
+/**
+ * A Default signer used if no signer is given.
+ */
 export declare const DefaultSigner: WalletSigner;
+/**
+ * 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/Auth/index.d.ts

@@ -8,12 +8,33 @@ type Sep10Params = {
     homeDomain: string;
     httpClient: AxiosInstance;
 };
+/**
+ * Sep-10 used for authentication to an external server.
+ * @see {@link https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md}
+ * Do not create this object directly, use the Anchor class.
+ * @class
+ */
 export declare class Sep10 {
     private cfg;
     private webAuthEndpoint;
     private homeDomain;
     private httpClient;
+    /**
+     * Creates a new instance of the Sep10 class.
+     *
+     * @constructor
+     * @param {Sep10Params} params - Parameters to initialize the Sep10 instance.
+     */
     constructor(params: Sep10Params);
+    /**
+     * Initiates the authentication process using SEP-10.
+     * @param {AuthenticateParams} params - The Authentication params.
+     * @param {AccountKeypair} params.accountKp - Keypair for the Stellar account being authenticated.
+     * @param {WalletSigner} [params.walletSigner] - Signer for signing transactions (defaults to the configuration default signer).
+     * @param {string} [params.memoId] - Memo ID to distinguish the account.
+     * @param {string} [params.clientDomain] - Domain hosting stellar.toml file containing `SIGNING_KEY`.
+     * @returns {Promise<AuthToken>} The authentication token.
+     */
     authenticate({ accountKp, walletSigner, memoId, clientDomain, }: AuthenticateParams): Promise<AuthToken>;
     private challenge;
     private sign;

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

@@ -0,0 +1,70 @@
+import { AxiosInstance } from "axios";
+import { GetCustomerParams, GetCustomerResponse, AddCustomerResponse, AddCustomerParams, AuthToken } from "../Types";
+/**
+ * KYC management with Sep-12.
+ * @see {@link https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md}
+ * Do not create this object directly, use the Anchor class.
+ * @class
+ */
+export declare class Sep12 {
+    private authToken;
+    private baseUrl;
+    private httpClient;
+    private headers;
+    /**
+     * Creates a new instance of the Sep12 class.
+     * @constructor
+     * @param {AuthToken} authToken - The authentication token for authenticating with the server.
+     * @param {string} baseUrl - The KYC url.
+     * @param {AxiosInstance} httpClient - An Axios instance for making HTTP requests.
+     */
+    constructor(authToken: AuthToken, baseUrl: string, httpClient: AxiosInstance);
+    /**
+     * Retrieve customer information. All arguments are optional, but at least one
+     * must be given. For more information:
+     * @see {@link https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#request}
+     * @param {object} params - The parameters for retrieving customer information.
+     * @param {string} [params.id] - The id of the customer .
+     * @param {string} [params.type] - The type of action the customer is being KYCd for.
+     * @see {@link https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification}
+     * @param {string} [params.memo] - A memo associated with the customer.
+     * @param {string} [params.lang] - The desired language. Defaults to "en".
+     * @returns {Promise<GetCustomerResponse>} The customer information.
+     * @throws {CustomerNotFoundError} If the customer is not found.
+     */
+    getCustomer(params: GetCustomerParams): Promise<GetCustomerResponse>;
+    /**
+     * Add a new customer. Customer info is given in sep9Info param. If it
+     * is binary type (eg. Buffer of an image) include it in sep9BinaryInfo.
+     * @param {AddCustomerParams} params - The parameters for adding a customer.
+     * @param {CustomerInfoMap} [params.sep9Info] - Customer information. What fields you should
+     * give is indicated by the anchor.
+     * @param {CustomerInfoMap} [params.sep9BinaryInfo] - Customer information that is in binary
+     * format (eg. Buffer of an image).
+     * @param {string} [params.type] - The type of the customer.
+     * @param {string} [params.memo] - A memo associated with the customer.
+     * @returns {Promise<AddCustomerResponse>} Add customer response.
+     */
+    add({ sep9Info, sep9BinaryInfo, type, memo, }: AddCustomerParams): Promise<AddCustomerResponse>;
+    /**
+     * Updates an existing customer. Customer info is given in sep9Info param. If it
+     * is binary type (eg. Buffer of an image) include it in sep9BinaryInfo.
+     * @param {AddCustomerParams} params - The parameters for adding a customer.
+     * @param {CustomerInfoMap} [params.sep9Info] - Customer information. What fields you should
+     * give is indicated by the anchor.
+     * @param {CustomerInfoMap} [params.sep9BinaryInfo] - Customer information that is in binary
+     * format (eg. Buffer of an image).
+     * @param {string} [params.id] - The id of the customer.
+     * @param {string} [params.type] - The type of the customer.
+     * @param {string} [params.memo] - A memo associated with the customer.
+     * @returns {Promise<AddCustomerResponse>} Add customer response.
+     * @throws {Sep9InfoRequiredError} If no SEP-9 info is given.
+     */
+    update({ sep9Info, sep9BinaryInfo, id, type, memo, }: AddCustomerParams): Promise<AddCustomerResponse>;
+    /**
+     * Deletes a customer.
+     * @param {string} accountAddress - The account address of the customer to delete.
+     * @param {string} [memo] - An optional memo for customer identification.
+     */
+    delete(accountAddress?: string, memo?: string): Promise<void>;
+}