@stellar-broker/client 0.7.0 → 0.8.0

package/src/index.d.ts

@@ -1,277 +1,294 @@
-import {Asset, TransactionI} from "@stellar/stellar-sdk";
-
-/**
- * Client for StellarBroker service
- */
-export class StellarBrokerClient {
-    /**
-     * @param {ClientInitializationParams} params
-     */
-    constructor(params: ClientInitializationParams);
-
-    /**
-     * Trader account public key
-     * @type {string}
-     */
-    readonly trader: string;
-    /**
-     * Stellar network passphrase
-     * @type {string}
-     */
-    readonly network: string;
-    /**
-     * @type {ClientSessionStatus}
-     */
-    readonly status: ClientSessionStatus;
-
-    /**
-     * Connect to the StellarBroker server
-     * @return {Promise<StellarBrokerClient>}
-     */
-    connect(): Promise<StellarBrokerClient>;
-
-    /**
-     * Request swap quote
-     * @param {QuoteParams} params - Quote parameters
-     */
-    quote(params: QuoteParams): void;
-
-    /**
-     * Stop quotation/trading
-     */
-    stop(): void;
-
-    /**
-     * Confirm current quote and start trading
-     * @param {string} [account] - Trader account address (overrides value provided in the constructor)
-     * @param {ClientAuthorizationParams} [authorization] - Authorization params (overrides value provided in the constructor)
-     */
-    confirmQuote(account?: string, authorization?: ClientAuthorizationParams): void;
-
-    /**
-     * Add event listener
-     * @param {StellarBrokerClientEvent} type
-     * @param {function} callback
-     */
-    on(type: StellarBrokerClientEvent, callback: Function): void;
-
-    /**
-     * Add event listener that will be executed once
-     * @param {StellarBrokerClientEvent} type
-     * @param {function} callback
-     */
-    once(type: StellarBrokerClientEvent, callback: Function): void;
-
-    /**
-     * Remove event listener
-     * @param {StellarBrokerClientEvent} type
-     * @param {function} callback
-     */
-    off(type: StellarBrokerClientEvent, callback: Function): void;
-
-    /**
-     * Close underlying connection and finalize the client
-     */
-    close(): void;
-}
-
-/**
- * Request single swap quote estimate without trading
- */
-export function estimateSwap(params: QuoteParams): Promise<QuoteResult>;
-
-/**
- * Quote request parameters provided by the client
- */
-export interface QuoteParams {
-    /**
-     * Asset to sell
-     */
-    sellingAsset: string
-    /**
-     * Asset to buy
-     */
-    buyingAsset: string
-    /**
-     * Amount of selling asset
-     */
-    sellingAmount?: string
-    /**
-     * Swap slippage tolerance (0.02 by default - 2%)
-     */
-    slippageTolerance?: number
-}
-
-export interface ClientInitializationParams {
-    /**
-     * Partner key
-     */
-    partnerKey?: string;
-    /**
-     * Trader account address
-     */
-    account?: string;
-    /**
-     * Authorization method, either account secret key or an authorization callback
-     */
-    authorization?: ClientAuthorizationParams;
-}
-
-/**
- * Current client session status
- */
-export type ClientSessionStatus = "disconnected" | "ready" | "quote" | "trade";
-
-/**
- * Event type generated by the client
- */
-export type StellarBrokerClientEvent = "quote" | "progress" | "paused" | "finished" | "error";
-
-/**
- * Result status code returned by the server
- */
-export type QuoteResultStatus = "unfeasible" | "rejected" | "success";
-
-/**
- * Quote received from the server
- */
-export interface QuoteResult {
-    /**
-     * Quote timestamp
-     */
-    readonly ts: Date,
-    /**
-     * Quote status code
-     */
-    readonly status: QuoteResultStatus;
-    /**
-     * Asset to sell
-     */
-    readonly sellingAsset: string;
-    /**
-     * Asset to buy
-     */
-    readonly buyingAsset: string;
-    /**
-     * Swap slippage tolerance
-     */
-    readonly slippageTolerance: number;
-    /**
-     * Amount of the selling asset
-     */
-    readonly sellingAmount: string;
-    /**
-     * Estimated amount of buyingAsset to receive
-     */
-    readonly estimatedBuyingAmount?: string;
-    /**
-     * Equivalent direct path_payment trade estimate
-     */
-    readonly directTrade?: QuoteDirectTradeResult;
-    /**
-     * Difference between quoted price and estimated direct trade
-     */
-    readonly profit: string;
-    /**
-     * Error details from the server (for failed quotes)
-     */
-    readonly error?: string;
-}
-
-/**
- * Emulated single `path_payment` trades result corresponding to the quote
- */
-export interface QuoteDirectTradeResult {
-    /**
-     * Estimated amount to sell
-     */
-    selling: string;
-    /**
-     * Estimated amount to buy
-     */
-    buying: string;
-    /**
-     * Conversion path
-     */
-    path: string[];
-}
-
-export class StellarBrokerError extends Error {
-    /**
-     * Numeric error code
-     * @type {number}
-     * @readonly
-     */
-    readonly code: number;
-}
-
-/**
- * Async authorization callback for transactions and simulated auth entries
- */
-export type ClientAuthorizationCallback = (txOrAuthEntry: TransactionI | Buffer) => Promise<TransactionI | Buffer>;
-
-/**
- * Authorization method, either account secret key or an authorization callback
- */
-export type ClientAuthorizationParams = string | ClientAuthorizationCallback;
-
-/**
- * Trader mediator account wrapper
- */
-export class Mediator {
-    /**
-     * Create a trader mediator account instance for a given source account
-     * @param source - Source account
-     * @param sellingAsset - Asset to sell
-     * @param buyingAsset - Asset to buy
-     * @param sellingAmount - Amount to sell
-     * @param authorization - Authorization callback or secret key
-     * @param [reserveFeeAmount] - Amount reserved to cover tx fees (all unused funds will be refunded)
-     */
-    constructor(source: string, sellingAsset: string | Asset, buyingAsset: string | Asset, sellingAmount: string, authorization: ClientAuthorizationParams, reserveFeeAmount?: number)
-
-    readonly source: string;
-
-    readonly sellingAsset: Asset;
-
-    readonly buyingAsset: Asset;
-
-    readonly sellingAmount: bigint;
-
-    readonly mediatorAddress: string;
-
-    /**
-     * Check if there are any non-disposed mediators that belong to lost swap sessions
-     */
-    get hasObsoleteMediators(): boolean;
-
-    /**
-     * Check if there are any non-disposed mediators that belong to lost swap sessions
-     * @param source - Initiator account that created a mediator
-     * @param [storagePrefix] - Local storage key prefix
-     */
-    static hasObsoleteMediators(source: string, storagePrefix?: string): boolean
-
-    /**
-     * Retrieve funds from mediator accounts that belong to lost swap sessions
-     */
-    disposeObsoleteMediators(): Promise<void>;
-
-    /**
-     * Retrieve funds from mediator accounts that belong to lost swap sessions
-     * @param source - Initiator account that created a mediator
-     * @param authorization - Authorization callback or secret key
-     * @param [storagePrefix] - Local storage key prefix
-     */
-    static disposeObsoleteMediators(source: string, authorization: ClientAuthorizationParams, storagePrefix?: string): Promise<void>;
-
-    /**
-     * Create mediator account and deposit tokens to sell
-     */
-    init(): Promise<string>;
-
-    /**
-     * Dispose mediator account
-     */
-    dispose(address?: string): Promise<void>;
-}
+import {Asset, TransactionI} from "@stellar/stellar-sdk";
+
+/**
+ * Client for StellarBroker service
+ */
+export class StellarBrokerClient {
+    /**
+     * @param {ClientInitializationParams} params
+     */
+    constructor(params: ClientInitializationParams);
+
+    /**
+     * Trader account public key
+     * @type {string}
+     */
+    readonly trader: string;
+    /**
+     * Stellar network passphrase
+     * @type {string}
+     */
+    readonly network: string;
+    /**
+     * @type {ClientSessionStatus}
+     */
+    readonly status: ClientSessionStatus;
+
+    /**
+     * Connect to the StellarBroker server
+     * @return {Promise<StellarBrokerClient>}
+     */
+    connect(): Promise<StellarBrokerClient>;
+
+    /**
+     * Request swap quote
+     * @param {QuoteParams} params - Quote parameters
+     */
+    quote(params: QuoteParams): void;
+
+    /**
+     * Stop quotation/trading
+     */
+    stop(): void;
+
+    /**
+     * Confirm current quote and start trading
+     * @param {string} [account] - Trader account address (overrides value provided in the constructor)
+     * @param {ClientAuthorizationParams} [authorization] - Authorization params (overrides value provided in the constructor)
+     */
+    confirmQuote(account?: string, authorization?: ClientAuthorizationParams): void;
+
+    /**
+     * Add event listener
+     * @param {StellarBrokerClientEvent} type
+     * @param {function} callback
+     */
+    on(type: StellarBrokerClientEvent, callback: Function): void;
+
+    /**
+     * Add event listener that will be executed once
+     * @param {StellarBrokerClientEvent} type
+     * @param {function} callback
+     */
+    once(type: StellarBrokerClientEvent, callback: Function): void;
+
+    /**
+     * Remove event listener
+     * @param {StellarBrokerClientEvent} type
+     * @param {function} callback
+     */
+    off(type: StellarBrokerClientEvent, callback: Function): void;
+
+    /**
+     * Close underlying connection and finalize the client
+     */
+    close(): void;
+}
+
+/**
+ * Request single swap quote estimate without trading
+ */
+export function estimateSwap(params: QuoteParams): Promise<QuoteResult>;
+
+/**
+ * Quote request parameters provided by the client
+ */
+export interface QuoteParams {
+    /**
+     * Asset to sell
+     */
+    sellingAsset: string
+    /**
+     * Asset to buy
+     */
+    buyingAsset: string
+    /**
+     * Amount of selling asset
+     */
+    sellingAmount?: string
+    /**
+     * Swap slippage tolerance (0.02 by default - 2%)
+     */
+    slippageTolerance?: number
+}
+
+export interface ClientInitializationParams {
+    /**
+     * Partner key
+     */
+    partnerKey?: string;
+    /**
+     * Trader account address
+     */
+    account?: string;
+    /**
+     * Authorization method, either account secret key or an authorization callback
+     */
+    authorization?: ClientAuthorizationParams;
+    /**
+     * Stellar network passphrase (pubnet by default)
+     */
+    network?: string;
+    /**
+     * StellarBroker server origin (https://api.stellar.broker by default)
+     */
+    origin?: string;
+}
+
+/**
+ * Current client session status
+ */
+export type ClientSessionStatus = "disconnected" | "ready" | "quote" | "trade";
+
+/**
+ * Event type generated by the client
+ */
+export type StellarBrokerClientEvent = "quote" | "progress" | "paused" | "finished" | "error";
+
+/**
+ * Result status code returned by the server
+ */
+export type QuoteResultStatus = "unfeasible" | "rejected" | "success";
+
+/**
+ * Quote received from the server
+ */
+export interface QuoteResult {
+    /**
+     * Quote timestamp
+     */
+    readonly ts: Date,
+    /**
+     * Quote status code
+     */
+    readonly status: QuoteResultStatus;
+    /**
+     * Asset to sell
+     */
+    readonly sellingAsset: string;
+    /**
+     * Asset to buy
+     */
+    readonly buyingAsset: string;
+    /**
+     * Swap slippage tolerance
+     */
+    readonly slippageTolerance: number;
+    /**
+     * Amount of the selling asset
+     */
+    readonly sellingAmount: string;
+    /**
+     * Estimated amount of buyingAsset to receive
+     */
+    readonly estimatedBuyingAmount?: string;
+    /**
+     * Equivalent direct path_payment trade estimate
+     */
+    readonly directTrade?: QuoteDirectTradeResult;
+    /**
+     * Difference between quoted price and estimated direct trade
+     */
+    readonly profit: string;
+    /**
+     * Error details from the server (for failed quotes)
+     */
+    readonly error?: string;
+}
+
+/**
+ * Emulated single `path_payment` trades result corresponding to the quote
+ */
+export interface QuoteDirectTradeResult {
+    /**
+     * Estimated amount to sell
+     */
+    selling: string;
+    /**
+     * Estimated amount to buy
+     */
+    buying: string;
+    /**
+     * Conversion path
+     */
+    path: string[];
+}
+
+export class StellarBrokerError extends Error {
+    /**
+     * Numeric error code
+     * @type {number}
+     * @readonly
+     */
+    readonly code: number;
+}
+
+/**
+ * Async authorization callback for transactions and simulated auth entries
+ */
+export type ClientAuthorizationCallback = (txOrAuthEntry: TransactionI | Uint8Array) => Promise<TransactionI | Uint8Array>;
+
+/**
+ * Authorization method, either account secret key or an authorization callback
+ */
+export type ClientAuthorizationParams = string | ClientAuthorizationCallback;
+
+/**
+ * Trader mediator account wrapper
+ */
+export class Mediator {
+    /**
+     * Create a trader mediator account instance for a given source account
+     * @param source - Source account
+     * @param sellingAsset - Asset to sell
+     * @param buyingAsset - Asset to buy
+     * @param sellingAmount - Amount to sell
+     * @param authorization - Authorization callback or secret key
+     * @param [reserveFeeAmount] - Amount reserved to cover tx fees (all unused funds will be refunded)
+     */
+    constructor(source: string, sellingAsset: string | Asset, buyingAsset: string | Asset, sellingAmount: string, authorization: ClientAuthorizationParams, reserveFeeAmount?: number)
+
+    /**
+     * Stellar network passphrase used by mediator accounts (pubnet by default)
+     */
+    static network: string;
+    /**
+     * Horizon server used by mediator accounts (https://horizon.stellar.org by default)
+     */
+    static horizonUrl: string;
+
+    readonly source: string;
+
+    readonly sellingAsset: Asset;
+
+    readonly buyingAsset: Asset;
+
+    readonly sellingAmount: bigint;
+
+    readonly mediatorAddress: string;
+
+    /**
+     * Check if there are any non-disposed mediators that belong to lost swap sessions
+     */
+    get hasObsoleteMediators(): boolean;
+
+    /**
+     * Check if there are any non-disposed mediators that belong to lost swap sessions
+     * @param source - Initiator account that created a mediator
+     * @param [storagePrefix] - Local storage key prefix
+     */
+    static hasObsoleteMediators(source: string, storagePrefix?: string): boolean
+
+    /**
+     * Retrieve funds from mediator accounts that belong to lost swap sessions
+     */
+    disposeObsoleteMediators(): Promise<void>;
+
+    /**
+     * Retrieve funds from mediator accounts that belong to lost swap sessions
+     * @param source - Initiator account that created a mediator
+     * @param authorization - Authorization callback or secret key
+     * @param [storagePrefix] - Local storage key prefix
+     */
+    static disposeObsoleteMediators(source: string, authorization: ClientAuthorizationParams, storagePrefix?: string): Promise<void>;
+
+    /**
+     * Create mediator account and deposit tokens to sell
+     */
+    init(): Promise<string>;
+
+    /**
+     * Dispose mediator account
+     */
+    dispose(address?: string): Promise<void>;
+}