@stellar/stellar-sdk 12.3.0 → 13.0.0-rc.1

package/lib/horizon/horizon_axios_client.d.ts

@@ -1,4 +1,4 @@
-export declare const version: any;
+export declare const version: string;
 export interface ServerTime {
     serverTime: number;
     localTimeRecorded: number;
@@ -10,18 +10,25 @@ export interface ServerTime {
  * each entry will map the server domain to the last-known time and the local
  * time it was recorded, ex:
  *
- *     "horizon-testnet.stellar.org": {
- *       serverTime: 1552513039,
- *       localTimeRecorded: 1552513052
- *     }
+ * @example
+ * "horizon-testnet.stellar.org": {
+ *   serverTime: 1552513039,
+ *   localTimeRecorded: 1552513052
+ * }
+ *
+ * @constant {Record.<string, ServerTime>}
+ * @default {}
+ * @memberof module:Horizon
  */
 export declare const SERVER_TIME_MAP: Record<string, ServerTime>;
-export declare const AxiosClient: import("axios").AxiosInstance;
+export declare const AxiosClient: import("../http-client").HttpClient;
 export default AxiosClient;
 /**
  * Given a hostname, get the current time of that server (i.e., use the last-
  * recorded server time and offset it by the time since then.) If there IS no
  * recorded server time, or it's been 5 minutes since the last, return null.
+ * @memberof module:Horizon
+ *
  * @param {string} hostname Hostname of a Horizon server.
  * @returns {number} The UNIX timestamp (in seconds, not milliseconds)
  * representing the current time on that server, or `null` if we don't have

package/lib/horizon/horizon_axios_client.js

@@ -6,12 +6,13 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = exports.SERVER_TIME_MAP = exports.AxiosClient = void 0;
 exports.getCurrentServerTime = getCurrentServerTime;
 exports.version = void 0;
-var _axios = _interopRequireDefault(require("axios"));
 var _urijs = _interopRequireDefault(require("urijs"));
+var _httpClient = require("../http-client");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-var version = exports.version = require("../../package.json").version;
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+var version = exports.version = "13.0.0-rc.1";
 var SERVER_TIME_MAP = exports.SERVER_TIME_MAP = {};
-var AxiosClient = exports.AxiosClient = _axios.default.create({
+var AxiosClient = exports.AxiosClient = (0, _httpClient.create)({
   headers: {
     "X-Client-Name": "js-stellar-sdk",
     "X-Client-Version": version
@@ -22,7 +23,18 @@ function toSeconds(ms) {
 }
 AxiosClient.interceptors.response.use(function (response) {
   var hostname = (0, _urijs.default)(response.config.url).hostname();
-  var serverTime = toSeconds(Date.parse(response.headers.date));
+  var serverTime = 0;
+  if (response.headers instanceof Headers) {
+    var dateHeader = response.headers.get('date');
+    if (dateHeader) {
+      serverTime = toSeconds(Date.parse(dateHeader));
+    }
+  } else if (_typeof(response.headers) === 'object' && 'date' in response.headers) {
+    var headers = response.headers;
+    if (typeof headers.date === 'string') {
+      serverTime = toSeconds(Date.parse(headers.date));
+    }
+  }
   var localTimeRecorded = toSeconds(new Date().getTime());
   if (!Number.isNaN(serverTime)) {
     SERVER_TIME_MAP[hostname] = {

package/lib/horizon/index.d.ts

@@ -1,7 +1,8 @@
+/** @module Horizon */
 export * from "./horizon_api";
 export * from "./server_api";
 export * from "./account_response";
-export { Server } from "./server";
+export { HorizonServer as Server } from "./server";
 export { default as AxiosClient, SERVER_TIME_MAP, getCurrentServerTime } from "./horizon_axios_client";
 declare const _default: any;
 export default _default;

package/lib/horizon/index.js

@@ -25,7 +25,7 @@ Object.defineProperty(exports, "SERVER_TIME_MAP", {
 Object.defineProperty(exports, "Server", {
   enumerable: true,
   get: function get() {
-    return _server.Server;
+    return _server.HorizonServer;
   }
 });
 exports.default = void 0;

package/lib/horizon/ledger_call_builder.d.ts

@@ -2,12 +2,14 @@ import { CallBuilder } from "./call_builder";
 import { ServerApi } from "./server_api";
 /**
  * Creates a new {@link LedgerCallBuilder} pointed to server defined by serverUrl.
- * Do not create this object directly, use {@link Server#ledgers}.
  *
- * @see [All Ledgers](https://developers.stellar.org/api/resources/ledgers/list/)
- * @class
- * @class LedgerCallBuilder
+ * Do not create this object directly, use {@link Horizon.Server#ledgers}.
+ *
+ * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/resources/list-all-ledgers|All Ledgers}
+ *
  * @augments CallBuilder
+ * @private
+ * @class
  * @param {string} serverUrl Horizon server URL.
  */
 export declare class LedgerCallBuilder extends CallBuilder<ServerApi.CollectionPage<ServerApi.LedgerRecord>> {

package/lib/horizon/liquidity_pool_call_builder.d.ts

@@ -3,10 +3,11 @@ import { CallBuilder } from "./call_builder";
 import { ServerApi } from "./server_api";
 /**
  * Creates a new {@link LiquidityPoolCallBuilder} pointed to server defined by serverUrl.
- * Do not create this object directly, use {@link Server#liquidityPools}.
  *
- * @class LiquidityPoolCallBuilder
+ * Do not create this object directly, use {@link Horizon.Server#liquidityPools}.
+ *
  * @augments CallBuilder
+ * @private
  * @class
  * @param {string} serverUrl Horizon server URL.
  */

package/lib/horizon/offer_call_builder.d.ts

@@ -3,12 +3,14 @@ import { CallBuilder } from "./call_builder";
 import { ServerApi } from "./server_api";
 /**
  * Creates a new {@link OfferCallBuilder} pointed to server defined by serverUrl.
- * Do not create this object directly, use {@link Server#offers}.
  *
- * @see [Offers](https://developers.stellar.org/api/resources/offers/)
- * @class OfferCallBuilder
- * @class
+ * Do not create this object directly, use {@link Horizon.Server#offers}.
+ *
+ * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/resources/offers/|Offers}
+ *
  * @augments CallBuilder
+ * @private
+ * @class
  * @param {string} serverUrl Horizon server URL.
  */
 export declare class OfferCallBuilder extends CallBuilder<ServerApi.CollectionPage<ServerApi.OfferRecord>> {
@@ -16,7 +18,7 @@ export declare class OfferCallBuilder extends CallBuilder<ServerApi.CollectionPa
     /**
      * The offer details endpoint provides information on a single offer. The offer ID provided in the id
      * argument specifies which offer to load.
-     * @see [Offer Details](https://developers.stellar.org/api/resources/offers/single/)
+     * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/resources/offers/single/|Offer Details}
      * @param {string} offerId Offer ID
      * @returns {CallBuilder<ServerApi.OfferRecord>} CallBuilder<ServerApi.OfferRecord> OperationCallBuilder instance
      */
@@ -24,14 +26,14 @@ export declare class OfferCallBuilder extends CallBuilder<ServerApi.CollectionPa
     /**
      * Returns all offers where the given account is involved.
      *
-     * @see [Offers](https://developers.stellar.org/api/resources/accounts/offers/)
+     * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/resources/accounts/offers/|Offers}
      * @param {string} id For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
      * @returns {OfferCallBuilder} current OfferCallBuilder instance
      */
     forAccount(id: string): this;
     /**
      * Returns all offers buying an asset.
-     * @see [Offers](https://developers.stellar.org/api/resources/offers/list/)
+     * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/resources/offers/list/|Offers}
      * @see Asset
      * @param {Asset} asset For example: `new Asset('USD','GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD')`
      * @returns {OfferCallBuilder} current OfferCallBuilder instance
@@ -39,7 +41,7 @@ export declare class OfferCallBuilder extends CallBuilder<ServerApi.CollectionPa
     buying(asset: Asset): this;
     /**
      * Returns all offers selling an asset.
-     * @see [Offers](https://developers.stellar.org/api/resources/offers/list/)
+     * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/resources/offers/list/|Offers}
      * @see Asset
      * @param {Asset} asset For example: `new Asset('EUR','GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD')`
      * @returns {OfferCallBuilder} current OfferCallBuilder instance
@@ -47,7 +49,7 @@ export declare class OfferCallBuilder extends CallBuilder<ServerApi.CollectionPa
     selling(asset: Asset): this;
     /**
      * This endpoint filters offers where the given account is sponsoring the offer entry.
-     * @see [Offers](https://developers.stellar.org/api/resources/offers/list/)
+     * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/resources/get-all-offers|Offers}
      * @param {string} id For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
      * @returns {OfferCallBuilder} current OfferCallBuilder instance
      */
@@ -55,7 +57,7 @@ export declare class OfferCallBuilder extends CallBuilder<ServerApi.CollectionPa
     /**
      * This endpoint filters offers where the given account is the seller.
      *
-     * @see [Offers](https://developers.stellar.org/api/resources/offers/list/)
+     * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/resources/get-all-offers|Offers}
      * @param {string} seller For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
      * @returns {OfferCallBuilder} current OfferCallBuilder instance
      */

package/lib/horizon/operation_call_builder.d.ts

@@ -2,12 +2,14 @@ import { CallBuilder } from "./call_builder";
 import { ServerApi } from "./server_api";
 /**
  * Creates a new {@link OperationCallBuilder} pointed to server defined by serverUrl.
- * Do not create this object directly, use {@link Server#operations}.
  *
- * @see [All Operations](https://developers.stellar.org/api/resources/operations/)
- * @class OperationCallBuilder
- * @class
+ * Do not create this object directly, use {@link Horizon.Server#operations}.
+ *
+ * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/resources/operations|All Operations}
+ *
  * @augments CallBuilder
+ * @private
+ * @class
  * @param {string} serverUrl Horizon server URL.
  */
 export declare class OperationCallBuilder extends CallBuilder<ServerApi.CollectionPage<ServerApi.OperationRecord>> {
@@ -15,21 +17,21 @@ export declare class OperationCallBuilder extends CallBuilder<ServerApi.Collecti
     /**
      * The operation details endpoint provides information on a single operation. The operation ID provided in the id
      * argument specifies which operation to load.
-     * @see [Operation Details](https://developers.stellar.org/api/resources/operations/single/)
+     * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/resources/retrieve-an-operation|Operation Details}
      * @param {number} operationId Operation ID
      * @returns {CallBuilder} this OperationCallBuilder instance
      */
     operation(operationId: string): CallBuilder<ServerApi.OperationRecord>;
     /**
      * This endpoint represents all operations that were included in valid transactions that affected a particular account.
-     * @see [Operations for Account](https://developers.stellar.org/api/resources/accounts/operations/)
+     * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/resources/get-operations-by-account-id|Operations for Account}
      * @param {string} accountId For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
      * @returns {OperationCallBuilder} this OperationCallBuilder instance
      */
     forAccount(accountId: string): this;
     /**
      * This endpoint represents all operations that reference a given claimable_balance.
-     * @see [Operations for Claimable Balance](https://developers.stellar.org/api/resources/claimablebalances/operations/)
+     * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/resources/cb-retrieve-related-operations|Operations for Claimable Balance}
      * @param {string} claimableBalanceId Claimable Balance ID
      * @returns {OperationCallBuilder} this OperationCallBuilder instance
      */
@@ -37,14 +39,14 @@ export declare class OperationCallBuilder extends CallBuilder<ServerApi.Collecti
     /**
      * This endpoint returns all operations that occurred in a given ledger.
      *
-     * @see [Operations for Ledger](https://developers.stellar.org/api/resources/ledgers/operations/)
+     * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/resources/retrieve-a-ledgers-operations|Operations for Ledger}
      * @param {number|string} sequence Ledger sequence
      * @returns {OperationCallBuilder} this OperationCallBuilder instance
      */
     forLedger(sequence: number | string): this;
     /**
      * This endpoint represents all operations that are part of a given transaction.
-     * @see [Operations for Transaction](https://developers.stellar.org/api/resources/transactions/operations/)
+     * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/resources/retrieve-a-transactions-operations|Operations for Transaction}
      * @param {string} transactionId Transaction ID
      * @returns {OperationCallBuilder} this OperationCallBuilder instance
      */

package/lib/horizon/orderbook_call_builder.d.ts

@@ -4,8 +4,13 @@ import { ServerApi } from "./server_api";
 /**
  * Creates a new {@link OrderbookCallBuilder} pointed to server defined by serverUrl.
  *
- * Do not create this object directly, use {@link Server#orderbook}.
- * @see [Orderbook Details](https://developers.stellar.org/api/aggregations/order-books/)
+ * Do not create this object directly, use {@link Horizon.Server#orderbook}.
+ *
+ * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/aggregations/order-books|Orderbook Details}
+ *
+ * @augments CallBuilder
+ * @private
+ * @class
  * @param {string} serverUrl serverUrl Horizon server URL.
  * @param {Asset} selling Asset being sold
  * @param {Asset} buying Asset being bought

package/lib/horizon/path_call_builder.d.ts

@@ -16,9 +16,14 @@ import { ServerApi } from "./server_api";
  * payment paths from those source assets to the desired destination asset. The search's amount parameter will be
  * used to determine if there a given path can satisfy a payment of the desired amount.
  *
- * Do not create this object directly, use {@link Server#paths}.
- * @see [Find Payment Paths](https://developers.stellar.org/api/aggregations/paths/)
+ * Do not create this object directly, use {@link Horizon.Server#paths}.
+ *
+ * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/aggregations/paths|Find Payment Paths}
+ *
  * @augments CallBuilder
+ * @private
+ * @class
+ *
  * @param {string} serverUrl Horizon server URL.
  * @param {string} source The sender's account ID. Any returned path must use a source that the sender can hold.
  * @param {string} destination The destination account ID that any returned path should use.

package/lib/horizon/payment_call_builder.d.ts

@@ -3,31 +3,35 @@ import { ServerApi } from "./server_api";
 /**
  * Creates a new {@link PaymentCallBuilder} pointed to server defined by serverUrl.
  *
- * Do not create this object directly, use {@link Server#payments}.
- * @see [All Payments](https://developers.stellar.org/api/horizon/resources/list-all-payments/)
- * @class
+ * Do not create this object directly, use {@link Horizon.Server#payments}.
+ *
+ * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/horizon/resources/list-all-payments/|All Payments}
+ *
  * @augments CallBuilder
+ * @private
+ * @class
+ *
  * @param {string} serverUrl Horizon server URL.
  */
 export declare class PaymentCallBuilder extends CallBuilder<ServerApi.CollectionPage<ServerApi.PaymentOperationRecord | ServerApi.CreateAccountOperationRecord | ServerApi.AccountMergeOperationRecord | ServerApi.PathPaymentOperationRecord | ServerApi.PathPaymentStrictSendOperationRecord | ServerApi.InvokeHostFunctionOperationRecord>> {
     constructor(serverUrl: URI);
     /**
      * This endpoint responds with a collection of Payment operations where the given account was either the sender or receiver.
-     * @see [Payments for Account](https://developers.stellar.org/api/horizon/resources/get-payments-by-account-id)
+     * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/horizon/resources/get-payments-by-account-id|Payments for Account}
      * @param {string} accountId For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
      * @returns {PaymentCallBuilder} this PaymentCallBuilder instance
      */
     forAccount(accountId: string): this;
     /**
      * This endpoint represents all payment operations that are part of a valid transactions in a given ledger.
-     * @see [Payments for Ledger](https://developers.stellar.org/api/horizon/resources/retrieve-a-ledgers-payments)
+     * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/horizon/resources/retrieve-a-ledgers-payments|Payments for Ledger}
      * @param {number|string} sequence Ledger sequence
      * @returns {PaymentCallBuilder} this PaymentCallBuilder instance
      */
     forLedger(sequence: number | string): this;
     /**
      * This endpoint represents all payment operations that are part of a given transaction.
-     * @see [Payments for Transaction](https://developers.stellar.org/api/resources/transactions/payments/)
+     * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/resources/transactions/payments/|Payments for Transaction}
      * @param {string} transactionId Transaction ID
      * @returns {PaymentCallBuilder} this PaymentCallBuilder instance
      */

package/lib/horizon/server.d.ts

@@ -17,26 +17,31 @@ import { PaymentCallBuilder } from "./payment_call_builder";
 import { TradeAggregationCallBuilder } from "./trade_aggregation_call_builder";
 import { TradesCallBuilder } from "./trades_call_builder";
 import { TransactionCallBuilder } from "./transaction_call_builder";
+/**
+ * Default transaction submission timeout for Horizon requests, in milliseconds
+ * @constant {number}
+ * @default 60000
+ * @memberof module:Horizon.Server
+ */
 export declare const SUBMIT_TRANSACTION_TIMEOUT: number;
 /**
- * Server handles the network connection to a [Horizon](https://developers.stellar.org/api/introduction/)
+ * Server handles the network connection to a [Horizon](https://developers.stellar.org/docs/data/horizon)
  * instance and exposes an interface for requests to that instance.
  * @class
+ * @alias module:Horizon.Server
+ * @memberof module:Horizon
+ *
  * @param {string} serverURL Horizon Server URL (ex. `https://horizon-testnet.stellar.org`).
- * @param {object} [opts] Options object
- * @param {boolean} [opts.allowHttp] - Allow connecting to http servers, default: `false`. This must be set to false in production deployments! You can also use {@link Config} class to set this globally.
- * @param {string} [opts.appName] - Allow set custom header `X-App-Name`, default: `undefined`.
- * @param {string} [opts.appVersion] - Allow set custom header `X-App-Version`, default: `undefined`.
- * @param {string} [opts.authToken] - Allow set custom header `X-Auth-Token`, default: `undefined`.
+ * @param {module:Horizon.Server.Options} [opts] Options object
  */
-export declare class Server {
+export declare class HorizonServer {
     /**
-     * serverURL Horizon Server URL (ex. `https://horizon-testnet.stellar.org`).
+     * Horizon Server URL (ex. `https://horizon-testnet.stellar.org`)
      *
-     * TODO: Solve `URI(this.serverURL as any)`.
+     * @todo Solve `URI(this.serverURL as any)`.
      */
     readonly serverURL: URI;
-    constructor(serverURL: string, opts?: Server.Options);
+    constructor(serverURL: string, opts?: HorizonServer.Options);
     /**
      * Get timebounds for N seconds from now, when you're creating a transaction
      * with {@link TransactionBuilder}.
@@ -49,25 +54,23 @@ export declare class Server {
      * not when you build or submit the transaction! So give yourself enough time to get
      * the transaction built and signed before submitting.
      *
-     * Example:
-     *
-     * ```javascript
+     * @example
      * const transaction = new StellarSdk.TransactionBuilder(accountId, {
-     *  fee: await StellarSdk.Server.fetchBaseFee(),
-     *  timebounds: await StellarSdk.Server.fetchTimebounds(100)
+     *   fee: await StellarSdk.Server.fetchBaseFee(),
+     *   timebounds: await StellarSdk.Server.fetchTimebounds(100)
      * })
-     *  .addOperation(operation)
-     *  // normally we would need to call setTimeout here, but setting timebounds
-     *  // earlier does the trick!
-     *  .build();
-     * ```
+     *   .addOperation(operation)
+     *   // normally we would need to call setTimeout here, but setting timebounds
+     *   // earlier does the trick!
+     *   .build();
+     *
      * @param {number} seconds Number of seconds past the current time to wait.
      * @param {boolean} [_isRetry] True if this is a retry. Only set this internally!
      * This is to avoid a scenario where Horizon is horking up the wrong date.
-     * @returns {Promise<Server.Timebounds>} Promise that resolves a `timebounds` object
+     * @returns {Promise<Timebounds>} Promise that resolves a `timebounds` object
      * (with the shape `{ minTime: 0, maxTime: N }`) that you can set the `timebounds` option to.
      */
-    fetchTimebounds(seconds: number, _isRetry?: boolean): Promise<Server.Timebounds>;
+    fetchTimebounds(seconds: number, _isRetry?: boolean): Promise<HorizonServer.Timebounds>;
     /**
      * Fetch the base fee. Since this hits the server, if the server call fails,
      * you might get an error. You should be prepared to use a default value if
@@ -77,22 +80,34 @@ export declare class Server {
     fetchBaseFee(): Promise<number>;
     /**
      * Fetch the fee stats endpoint.
-     * @see [Fee Stats](https://developers.stellar.org/api/aggregations/fee-stats/)
+     * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/aggregations/fee-stats|Fee Stats}
      * @returns {Promise<HorizonApi.FeeStatsResponse>} Promise that resolves to the fee stats returned by Horizon.
      */
     feeStats(): Promise<HorizonApi.FeeStatsResponse>;
     /**
      * Submits a transaction to the network.
      *
-     * By default this function calls {@link Server#checkMemoRequired}, you can
+     * By default this function calls {@link Horizon.Server#checkMemoRequired}, you can
      * skip this check by setting the option `skipMemoRequiredCheck` to `true`.
      *
      * If you submit any number of `manageOffer` operations, this will add an
      * attribute to the response that will help you analyze what happened with
      * your offers.
      *
-     * Ex:
-     * ```javascript
+     * For example, you'll want to examine `offerResults` to add affordances like
+     * these to your app:
+     * - If `wasImmediatelyFilled` is true, then no offer was created. So if you
+     *   normally watch the `Server.offers` endpoint for offer updates, you
+     *   instead need to check `Server.trades` to find the result of this filled
+     *   offer.
+     * - If `wasImmediatelyDeleted` is true, then the offer you submitted was
+     *   deleted without reaching the orderbook or being matched (possibly because
+     *   your amounts were rounded down to zero). So treat the just-submitted
+     *   offer request as if it never happened.
+     * - If `wasPartiallyFilled` is true, you can tell the user that
+     *   `amountBought` or `amountSold` have already been transferred.
+     *
+     * @example
      * const res = {
      *   ...response,
      *   offerResults: [
@@ -160,22 +175,8 @@ export declare class Server {
      *     }
      *   ]
      * }
-     * ```
      *
-     * For example, you'll want to examine `offerResults` to add affordances like
-     * these to your app:
-     * * If `wasImmediatelyFilled` is true, then no offer was created. So if you
-     *   normally watch the `Server.offers` endpoint for offer updates, you
-     *   instead need to check `Server.trades` to find the result of this filled
-     *   offer.
-     * * If `wasImmediatelyDeleted` is true, then the offer you submitted was
-     *   deleted without reaching the orderbook or being matched (possibly because
-     *   your amounts were rounded down to zero). So treat the just-submitted
-     *   offer request as if it never happened.
-     * * If `wasPartiallyFilled` is true, you can tell the user that
-     *   `amountBought` or `amountSold` have already been transferred.
-     *
-     * @see [PostTransaction](https://developers.stellar.org/api/resources/transactions/post/)
+     * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/resources/submit-a-transaction|Submit a Transaction}
      * @param {Transaction|FeeBumpTransaction} transaction - The transaction to submit.
      * @param {object} [opts] Options object
      * @param {boolean} [opts.skipMemoRequiredCheck] - Allow skipping memo
@@ -184,17 +185,16 @@ export declare class Server {
      * @returns {Promise} Promise that resolves or rejects with response from
      * horizon.
      */
-    submitTransaction(transaction: Transaction | FeeBumpTransaction, opts?: Server.SubmitTransactionOptions): Promise<HorizonApi.SubmitTransactionResponse>;
+    submitTransaction(transaction: Transaction | FeeBumpTransaction, opts?: HorizonServer.SubmitTransactionOptions): Promise<HorizonApi.SubmitTransactionResponse>;
     /**
      * Submits an asynchronous transaction to the network. Unlike the synchronous version, which blocks
      * and waits for the transaction to be ingested in Horizon, this endpoint relays the response from
      * core directly back to the user.
      *
-     * By default, this function calls {@link Server#checkMemoRequired}, you can
+     * By default, this function calls {@link HorizonServer#checkMemoRequired}, you can
      * skip this check by setting the option `skipMemoRequiredCheck` to `true`.
      *
-     * @see [Submit
-     * Async Transaction](https://developers.stellar.org/docs/data/horizon/api-reference/resources/submit-async-transaction)
+     * @see [Submit-Async-Transaction](https://developers.stellar.org/docs/data/horizon/api-reference/resources/submit-async-transaction)
      * @param {Transaction|FeeBumpTransaction} transaction - The transaction to submit.
      * @param {object} [opts] Options object
      * @param {boolean} [opts.skipMemoRequiredCheck] - Allow skipping memo
@@ -203,7 +203,7 @@ export declare class Server {
      * @returns {Promise} Promise that resolves or rejects with response from
      * horizon.
      */
-    submitAsyncTransaction(transaction: Transaction | FeeBumpTransaction, opts?: Server.SubmitTransactionOptions): Promise<HorizonApi.SubmitAsyncTransactionResponse>;
+    submitAsyncTransaction(transaction: Transaction | FeeBumpTransaction, opts?: HorizonServer.SubmitTransactionOptions): Promise<HorizonApi.SubmitAsyncTransactionResponse>;
     /**
      * @returns {AccountCallBuilder} New {@link AccountCallBuilder} object configured by a current Horizon server configuration.
      */
@@ -223,15 +223,15 @@ export declare class Server {
     /**
      * People on the Stellar network can make offers to buy or sell assets. This endpoint represents all the offers on the DEX.
      *
-     * You can query all offers for account using the function `.accountId`:
+     * You can query all offers for account using the function `.accountId`.
      *
-     * ```
+     * @example
      * server.offers()
-     *  .forAccount(accountId).call()
-     *  .then(function(offers) {
-     *    console.log(offers);
-     *  });
-     * ```
+     *   .forAccount(accountId).call()
+     *   .then(function(offers) {
+     *     console.log(offers);
+     *   });
+     *
      * @returns {OfferCallBuilder} New {@link OfferCallBuilder} object
      */
     offers(): OfferCallBuilder;
@@ -354,7 +354,7 @@ export declare class Server {
      * Each account is checked sequentially instead of loading multiple accounts
      * at the same time from Horizon.
      *
-     * @see https://stellar.org/protocol/sep-29
+     * @see {@link https://stellar.org/protocol/sep-29|SEP-29: Account Memo Requirements}
      * @param {Transaction} transaction - The transaction to check.
      * @returns {Promise<void, Error>} - If any of the destination account
      * requires a memo, the promise will throw {@link AccountRequiresMemoError}.
@@ -362,7 +362,16 @@ export declare class Server {
      */
     checkMemoRequired(transaction: Transaction | FeeBumpTransaction): Promise<void>;
 }
-export declare namespace Server {
+/**
+ * Options for configuring connections to Horizon servers.
+ * @typedef {object} Options
+ * @memberof module:Horizon.Server
+ * @property {boolean} [allowHttp] Allow connecting to http servers, default: `false`. This must be set to false in production deployments! You can also use {@link Config} class to set this globally.
+ * @property {string} [appName] Allow set custom header `X-App-Name`, default: `undefined`.
+ * @property {string} [appVersion] Allow set custom header `X-App-Version`, default: `undefined`.
+ * @property {string} [authToken] Allow set custom header `X-Auth-Token`, default: `undefined`.
+ */
+export declare namespace HorizonServer {
     interface Options {
         allowHttp?: boolean;
         appName?: string;

package/lib/horizon/server.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.Server = exports.SUBMIT_TRANSACTION_TIMEOUT = void 0;
+exports.SUBMIT_TRANSACTION_TIMEOUT = exports.HorizonServer = void 0;
 var _bignumber = _interopRequireDefault(require("bignumber.js"));
 var _stellarBase = require("@stellar/stellar-base");
 var _urijs = _interopRequireDefault(require("urijs"));
@@ -49,10 +49,10 @@ var ACCOUNT_REQUIRES_MEMO = "MQ==";
 function getAmountInLumens(amt) {
   return new _bignumber.default(amt).div(STROOPS_IN_LUMEN).toString();
 }
-var Server = exports.Server = function () {
-  function Server(serverURL) {
+var HorizonServer = exports.HorizonServer = function () {
+  function HorizonServer(serverURL) {
     var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-    _classCallCheck(this, Server);
+    _classCallCheck(this, HorizonServer);
     this.serverURL = (0, _urijs.default)(serverURL);
     var allowHttp = typeof opts.allowHttp === "undefined" ? _config.Config.isAllowHttp() : opts.allowHttp;
     var customHeaders = {};
@@ -70,6 +70,7 @@ var Server = exports.Server = function () {
     }
     if (Object.keys(customHeaders).length > 0) {
       _horizon_axios_client.default.interceptors.request.use(function (config) {
+        config.headers = config.headers || {};
         config.headers = Object.assign(config.headers, customHeaders);
         return config;
       });
@@ -78,7 +79,7 @@ var Server = exports.Server = function () {
       throw new Error("Cannot connect to insecure horizon server");
     }
   }
-  return _createClass(Server, [{
+  return _createClass(HorizonServer, [{
     key: "fetchTimebounds",
     value: (function () {
       var _fetchTimebounds = _asyncToGenerator(_regeneratorRuntime().mark(function _callee(seconds) {

package/lib/horizon/server_api.d.ts

@@ -102,21 +102,6 @@ export declare namespace ServerApi {
         header_xdr: string;
         base_fee_in_stroops: number;
         base_reserve_in_stroops: number;
-        /**
-         * @deprecated  This will be removed in the next major version: the property
-         *     no longer exists on the Horizon API
-         */
-        transaction_count: number;
-        /**
-         * @deprecated  This will be removed in the next major version: the property
-         *     no longer exists on the Horizon API
-         */
-        base_fee: number;
-        /**
-         * @deprecated  This will be removed in the next major version: the property
-         *     no longer exists on the Horizon API
-         */
-        base_reserve: string;
         effects: CallCollectionFunction<EffectRecord>;
         operations: CallCollectionFunction<OperationRecord>;
         self: CallFunction<LedgerRecord>;

package/lib/horizon/strict_receive_path_call_builder.d.ts

@@ -20,9 +20,14 @@ import { ServerApi } from "./server_api";
  * If a list of assets is passed as the source, horizon will find any payment
  * paths from those source assets to the desired destination asset.
  *
- * Do not create this object directly, use {@link Server#strictReceivePaths}.
- * @see [Find Payment Paths](https://developers.stellar.org/api/aggregations/paths/)
+ * Do not create this object directly, use {@link Horizon.Server#strictReceivePaths}.
+ *
+ * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/aggregations/paths|Find Payment Paths}
+ *
  * @augments CallBuilder
+ * @private
+ * @class
+ *
  * @param {string} serverUrl Horizon server URL.
  * @param {string|Asset[]} source The sender's account ID or a list of Assets. Any returned path must use a source that the sender can hold.
  * @param {Asset} destinationAsset The destination asset.