Documentation GitHub npm

Source

lib/horizon/trades_call_builder.js

  1. "use strict";
  3. Object.defineProperty(exports, "__esModule", {
  4.   value: true
  5. });
  6. exports.TradesCallBuilder = void 0;
  7. var _call_builder = require("./call_builder");
  8. /**
  9.  * Creates a new {@link TradesCallBuilder} pointed to server defined by serverUrl.
  10.  *
  11.  * Do not create this object directly, use {@link Horizon.Server#trades}.
  12.  *
  13.  * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/resources/trades|Trades}
  14.  *
  15.  * @augments CallBuilder
  16.  * @private
  17.  * @class
  18.  *
  19.  * @param {string} serverUrl serverUrl Horizon server URL.
  20.  */
  21. class TradesCallBuilder extends _call_builder.CallBuilder {
  22.   constructor(serverUrl) {
  23.     super(serverUrl, "trades");
  24.     this.url.segment("trades");
  25.   }
  27.   /**
  28.    * Filter trades for a specific asset pair (orderbook)
  29.    * @param {Asset} base asset
  30.    * @param {Asset} counter asset
  31.    * @returns {TradesCallBuilder} current TradesCallBuilder instance
  32.    */
  33.   forAssetPair(base, counter) {
  34.     if (!base.isNative()) {
  35.       this.url.setQuery("base_asset_type", base.getAssetType());
  36.       this.url.setQuery("base_asset_code", base.getCode());
  37.       this.url.setQuery("base_asset_issuer", base.getIssuer());
  38.     } else {
  39.       this.url.setQuery("base_asset_type", "native");
  40.     }
  41.     if (!counter.isNative()) {
  42.       this.url.setQuery("counter_asset_type", counter.getAssetType());
  43.       this.url.setQuery("counter_asset_code", counter.getCode());
  44.       this.url.setQuery("counter_asset_issuer", counter.getIssuer());
  45.     } else {
  46.       this.url.setQuery("counter_asset_type", "native");
  47.     }
  48.     return this;
  49.   }
  51.   /**
  52.    * Filter trades for a specific offer
  53.    * @param {string} offerId ID of the offer
  54.    * @returns {TradesCallBuilder} current TradesCallBuilder instance
  55.    */
  56.   forOffer(offerId) {
  57.     this.url.setQuery("offer_id", offerId);
  58.     return this;
  59.   }
  61.   /**
  62.    * Filter trades by a specific type.
  63.    * @param {ServerApi.TradeType} tradeType the trade type to filter by.
  64.    * @returns {TradesCallBuilder} current TradesCallBuilder instance.
  65.    */
  66.   forType(tradeType) {
  67.     this.url.setQuery("trade_type", tradeType);
  68.     return this;
  69.   }
  71.   /**
  72.    * Filter trades for a specific account
  73.    * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/resources/get-trades-by-account-id|Trades for Account}
  74.    * @param {string} accountId For example: `GBYTR4MC5JAX4ALGUBJD7EIKZVM7CUGWKXIUJMRSMK573XH2O7VAK3SR`
  75.    * @returns {TradesCallBuilder} current TradesCallBuilder instance
  76.    */
  77.   forAccount(accountId) {
  78.     return this.forEndpoint("accounts", accountId);
  79.   }
  81.   /**
  82.    * Filter trades for a specific liquidity pool
  83.    * @see {@link https://developers.stellar.org/docs/data/horizon/api-reference/resources/retrieve-related-trades|Trades for Liquidity Pool}
  84.    * @param {string} liquidityPoolId For example: `3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4`
  85.    * @returns {TradesCallBuilder} current TradesCallBuilder instance
  86.    */
  87.   forLiquidityPool(liquidityPoolId) {
  88.     return this.forEndpoint("liquidity_pools", liquidityPoolId);
  89.   }
  90. }
  91. exports.TradesCallBuilder = TradesCallBuilder;