@digitalworld/digital-world-sdk 16.0.0

package/lib/esm/gateway/trade_aggregation_call_builder.d.ts

@@ -0,0 +1,46 @@
+import { Asset } from "../base/index.js";
+import { CallBuilder } from "./call_builder.js";
+import { GatewayApi } from "./gateway_api.js";
+import { ServerApi } from "./server_api.js";
+import type { HttpClient } from "../http-client/index.js";
+/**
+ * Trade Aggregations facilitate efficient gathering of historical trade data.
+ *
+ * Do not create this object directly, use {@link Gateway.Server.tradeAggregation}.
+ *
+ * @param serverUrl - serverUrl Gateway server URL.
+ * @param base - base asset
+ * @param counter - counter asset
+ * @param start_time - lower time boundary represented as millis since epoch
+ * @param end_time - upper time boundary represented as millis since epoch
+ * @param resolution - segment duration as millis since epoch. *Supported values are 1 minute (60000), 5 minutes (300000), 15 minutes (900000), 1 hour (3600000), 1 day (86400000) and 1 week (604800000).
+ * @param offset - segments can be offset using this parameter. Expressed in milliseconds. *Can only be used if the resolution is greater than 1 hour. Value must be in whole hours, less than the provided resolution, and less than 24 hours.
+ */
+export declare class TradeAggregationCallBuilder extends CallBuilder<ServerApi.CollectionPage<TradeAggregationRecord>> {
+    constructor(serverUrl: URL, httpClient: HttpClient, base: Asset, counter: Asset, start_time: number, end_time: number, resolution: number, offset: number);
+    /**
+     * @hidden
+     * @param resolution - Trade data resolution in milliseconds
+     * @returns true if the resolution is allowed
+     */
+    private isValidResolution;
+    /**
+     * @hidden
+     * @param offset - Time offset in milliseconds
+     * @param resolution - Trade data resolution in milliseconds
+     * @returns true if the offset is valid
+     */
+    private isValidOffset;
+}
+interface TradeAggregationRecord extends GatewayApi.BaseResponse {
+    timestamp: number | string;
+    trade_count: number | string;
+    base_volume: string;
+    counter_volume: string;
+    avg: string;
+    high: string;
+    low: string;
+    open: string;
+    close: string;
+}
+export {};

package/lib/esm/gateway/trade_aggregation_call_builder.js

@@ -0,0 +1,70 @@
+import { CallBuilder } from './call_builder.js';
+import { BadRequestError } from '../errors/bad_request.js';
+
+const allowedResolutions = [
+  6e4,
+  3e5,
+  9e5,
+  36e5,
+  864e5,
+  6048e5
+];
+class TradeAggregationCallBuilder extends CallBuilder {
+  constructor(serverUrl, httpClient, base, counter, start_time, end_time, resolution, offset) {
+    super(serverUrl, httpClient);
+    this.setPath("trade_aggregations");
+    const baseIssuer = base.getIssuer();
+    if (!base.isNative() && baseIssuer !== void 0) {
+      this.url.searchParams.set("base_asset_type", base.getAssetType());
+      this.url.searchParams.set("base_asset_code", base.getCode());
+      this.url.searchParams.set("base_asset_issuer", baseIssuer);
+    } else {
+      this.url.searchParams.set("base_asset_type", "native");
+    }
+    const counterIssuer = counter.getIssuer();
+    if (!counter.isNative() && counterIssuer !== void 0) {
+      this.url.searchParams.set("counter_asset_type", counter.getAssetType());
+      this.url.searchParams.set("counter_asset_code", counter.getCode());
+      this.url.searchParams.set("counter_asset_issuer", counterIssuer);
+    } else {
+      this.url.searchParams.set("counter_asset_type", "native");
+    }
+    if (typeof start_time !== "number" || typeof end_time !== "number") {
+      throw new BadRequestError("Invalid time bounds", [start_time, end_time]);
+    } else {
+      this.url.searchParams.set("start_time", start_time.toString());
+      this.url.searchParams.set("end_time", end_time.toString());
+    }
+    if (!this.isValidResolution(resolution)) {
+      throw new BadRequestError("Invalid resolution", resolution);
+    } else {
+      this.url.searchParams.set("resolution", resolution.toString());
+    }
+    if (!this.isValidOffset(offset, resolution)) {
+      throw new BadRequestError("Invalid offset", offset);
+    } else {
+      this.url.searchParams.set("offset", offset.toString());
+    }
+  }
+  /**
+   * @hidden
+   * @param resolution - Trade data resolution in milliseconds
+   * @returns true if the resolution is allowed
+   */
+  isValidResolution(resolution) {
+    return allowedResolutions.some((allowed) => allowed === resolution);
+  }
+  /**
+   * @hidden
+   * @param offset - Time offset in milliseconds
+   * @param resolution - Trade data resolution in milliseconds
+   * @returns true if the offset is valid
+   */
+  isValidOffset(offset, resolution) {
+    const hour = 36e5;
+    return !(offset > resolution || offset >= 24 * hour || offset % hour !== 0);
+  }
+}
+
+export { TradeAggregationCallBuilder };
+//# sourceMappingURL=trade_aggregation_call_builder.js.map

package/lib/esm/gateway/trade_aggregation_call_builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trade_aggregation_call_builder.js","sources":["../../../src/gateway/trade_aggregation_call_builder.ts"],"sourcesContent":["/* tslint:disable: variable-name */\nimport { Asset } from \"../base/index.js\";\nimport { CallBuilder } from \"./call_builder.js\";\nimport { BadRequestError } from \"../errors/index.js\";\nimport { GatewayApi } from \"./gateway_api.js\";\nimport { ServerApi } from \"./server_api.js\";\nimport type { HttpClient } from \"../http-client/index.js\";\n\nconst allowedResolutions = [\n  60000, 300000, 900000, 3600000, 86400000, 604800000,\n];\n\n/**\n * Trade Aggregations facilitate efficient gathering of historical trade data.\n *\n * Do not create this object directly, use {@link Gateway.Server.tradeAggregation}.\n *\n * @param serverUrl - serverUrl Gateway server URL.\n * @param base - base asset\n * @param counter - counter asset\n * @param start_time - lower time boundary represented as millis since epoch\n * @param end_time - upper time boundary represented as millis since epoch\n * @param resolution - segment duration as millis since epoch. *Supported values are 1 minute (60000), 5 minutes (300000), 15 minutes (900000), 1 hour (3600000), 1 day (86400000) and 1 week (604800000).\n * @param offset - segments can be offset using this parameter. Expressed in milliseconds. *Can only be used if the resolution is greater than 1 hour. Value must be in whole hours, less than the provided resolution, and less than 24 hours.\n */\nexport class TradeAggregationCallBuilder extends CallBuilder<\n  ServerApi.CollectionPage<TradeAggregationRecord>\n> {\n  constructor(\n    serverUrl: URL,\n    httpClient: HttpClient,\n    base: Asset,\n    counter: Asset,\n    start_time: number,\n    end_time: number,\n    resolution: number,\n    offset: number,\n  ) {\n    super(serverUrl, httpClient);\n    this.setPath(\"trade_aggregations\");\n    const baseIssuer = base.getIssuer();\n    if (!base.isNative() && baseIssuer !== undefined) {\n      this.url.searchParams.set(\"base_asset_type\", base.getAssetType());\n      this.url.searchParams.set(\"base_asset_code\", base.getCode());\n      this.url.searchParams.set(\"base_asset_issuer\", baseIssuer);\n    } else {\n      this.url.searchParams.set(\"base_asset_type\", \"native\");\n    }\n    const counterIssuer = counter.getIssuer();\n    if (!counter.isNative() && counterIssuer !== undefined) {\n      this.url.searchParams.set(\"counter_asset_type\", counter.getAssetType());\n      this.url.searchParams.set(\"counter_asset_code\", counter.getCode());\n      this.url.searchParams.set(\"counter_asset_issuer\", counterIssuer);\n    } else {\n      this.url.searchParams.set(\"counter_asset_type\", \"native\");\n    }\n    if (typeof start_time !== \"number\" || typeof end_time !== \"number\") {\n      throw new BadRequestError(\"Invalid time bounds\", [start_time, end_time]);\n    } else {\n      this.url.searchParams.set(\"start_time\", start_time.toString());\n      this.url.searchParams.set(\"end_time\", end_time.toString());\n    }\n    if (!this.isValidResolution(resolution)) {\n      throw new BadRequestError(\"Invalid resolution\", resolution);\n    } else {\n      this.url.searchParams.set(\"resolution\", resolution.toString());\n    }\n    if (!this.isValidOffset(offset, resolution)) {\n      throw new BadRequestError(\"Invalid offset\", offset);\n    } else {\n      this.url.searchParams.set(\"offset\", offset.toString());\n    }\n  }\n\n  /**\n   * @hidden\n   * @param resolution - Trade data resolution in milliseconds\n   * @returns true if the resolution is allowed\n   */\n  private isValidResolution(resolution: number): boolean {\n    return allowedResolutions.some((allowed) => allowed === resolution);\n  }\n\n  /**\n   * @hidden\n   * @param offset - Time offset in milliseconds\n   * @param resolution - Trade data resolution in milliseconds\n   * @returns true if the offset is valid\n   */\n  private isValidOffset(offset: number, resolution: number): boolean {\n    const hour = 3600000;\n    return !(offset > resolution || offset >= 24 * hour || offset % hour !== 0);\n  }\n}\n\ninterface TradeAggregationRecord extends GatewayApi.BaseResponse {\n  timestamp: number | string;\n  trade_count: number | string;\n  base_volume: string;\n  counter_volume: string;\n  avg: string;\n  high: string;\n  low: string;\n  open: string;\n  close: string;\n}\n"],"names":[],"mappings":";;;AAQA,MAAM,kBAAA,GAAqB;AAAA,EACzB,GAAA;AAAA,EAAO,GAAA;AAAA,EAAQ,GAAA;AAAA,EAAQ,IAAA;AAAA,EAAS,KAAA;AAAA,EAAU;AAC5C,CAAA;AAeO,MAAM,oCAAoC,WAAA,CAE/C;AAAA,EACA,WAAA,CACE,WACA,UAAA,EACA,IAAA,EACA,SACA,UAAA,EACA,QAAA,EACA,YACA,MAAA,EACA;AACA,IAAA,KAAA,CAAM,WAAW,UAAU,CAAA;AAC3B,IAAA,IAAA,CAAK,QAAQ,oBAAoB,CAAA;AACjC,IAAA,MAAM,UAAA,GAAa,KAAK,SAAA,EAAU;AAClC,IAAA,IAAI,CAAC,IAAA,CAAK,QAAA,EAAS,IAAK,eAAe,MAAA,EAAW;AAChD,MAAA,IAAA,CAAK,IAAI,YAAA,CAAa,GAAA,CAAI,iBAAA,EAAmB,IAAA,CAAK,cAAc,CAAA;AAChE,MAAA,IAAA,CAAK,IAAI,YAAA,CAAa,GAAA,CAAI,iBAAA,EAAmB,IAAA,CAAK,SAAS,CAAA;AAC3D,MAAA,IAAA,CAAK,GAAA,CAAI,YAAA,CAAa,GAAA,CAAI,mBAAA,EAAqB,UAAU,CAAA;AAAA,IAC3D,CAAA,MAAO;AACL,MAAA,IAAA,CAAK,GAAA,CAAI,YAAA,CAAa,GAAA,CAAI,iBAAA,EAAmB,QAAQ,CAAA;AAAA,IACvD;AACA,IAAA,MAAM,aAAA,GAAgB,QAAQ,SAAA,EAAU;AACxC,IAAA,IAAI,CAAC,OAAA,CAAQ,QAAA,EAAS,IAAK,kBAAkB,MAAA,EAAW;AACtD,MAAA,IAAA,CAAK,IAAI,YAAA,CAAa,GAAA,CAAI,oBAAA,EAAsB,OAAA,CAAQ,cAAc,CAAA;AACtE,MAAA,IAAA,CAAK,IAAI,YAAA,CAAa,GAAA,CAAI,oBAAA,EAAsB,OAAA,CAAQ,SAAS,CAAA;AACjE,MAAA,IAAA,CAAK,GAAA,CAAI,YAAA,CAAa,GAAA,CAAI,sBAAA,EAAwB,aAAa,CAAA;AAAA,IACjE,CAAA,MAAO;AACL,MAAA,IAAA,CAAK,GAAA,CAAI,YAAA,CAAa,GAAA,CAAI,oBAAA,EAAsB,QAAQ,CAAA;AAAA,IAC1D;AACA,IAAA,IAAI,OAAO,UAAA,KAAe,QAAA,IAAY,OAAO,aAAa,QAAA,EAAU;AAClE,MAAA,MAAM,IAAI,eAAA,CAAgB,qBAAA,EAAuB,CAAC,UAAA,EAAY,QAAQ,CAAC,CAAA;AAAA,IACzE,CAAA,MAAO;AACL,MAAA,IAAA,CAAK,IAAI,YAAA,CAAa,GAAA,CAAI,YAAA,EAAc,UAAA,CAAW,UAAU,CAAA;AAC7D,MAAA,IAAA,CAAK,IAAI,YAAA,CAAa,GAAA,CAAI,UAAA,EAAY,QAAA,CAAS,UAAU,CAAA;AAAA,IAC3D;AACA,IAAA,IAAI,CAAC,IAAA,CAAK,iBAAA,CAAkB,UAAU,CAAA,EAAG;AACvC,MAAA,MAAM,IAAI,eAAA,CAAgB,oBAAA,EAAsB,UAAU,CAAA;AAAA,IAC5D,CAAA,MAAO;AACL,MAAA,IAAA,CAAK,IAAI,YAAA,CAAa,GAAA,CAAI,YAAA,EAAc,UAAA,CAAW,UAAU,CAAA;AAAA,IAC/D;AACA,IAAA,IAAI,CAAC,IAAA,CAAK,aAAA,CAAc,MAAA,EAAQ,UAAU,CAAA,EAAG;AAC3C,MAAA,MAAM,IAAI,eAAA,CAAgB,gBAAA,EAAkB,MAAM,CAAA;AAAA,IACpD,CAAA,MAAO;AACL,MAAA,IAAA,CAAK,IAAI,YAAA,CAAa,GAAA,CAAI,QAAA,EAAU,MAAA,CAAO,UAAU,CAAA;AAAA,IACvD;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,kBAAkB,UAAA,EAA6B;AACrD,IAAA,OAAO,kBAAA,CAAmB,IAAA,CAAK,CAAC,OAAA,KAAY,YAAY,UAAU,CAAA;AAAA,EACpE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQQ,aAAA,CAAc,QAAgB,UAAA,EAA6B;AACjE,IAAA,MAAM,IAAA,GAAO,IAAA;AACb,IAAA,OAAO,EAAE,MAAA,GAAS,UAAA,IAAc,UAAU,EAAA,GAAK,IAAA,IAAQ,SAAS,IAAA,KAAS,CAAA,CAAA;AAAA,EAC3E;AACF;;;;"}

package/lib/esm/gateway/trades_call_builder.d.ts

@@ -0,0 +1,49 @@
+import { Asset } from "../base/index.js";
+import { CallBuilder } from "./call_builder.js";
+import { ServerApi } from "./server_api.js";
+import type { HttpClient } from "../http-client/index.js";
+/**
+ * Creates a new {@link TradesCallBuilder} pointed to server defined by serverUrl.
+ *
+ * Do not create this object directly, use {@link Gateway.Server.trades}.
+ *
+ * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/trades | Trades}
+ *
+ * @param serverUrl - serverUrl Gateway server URL.
+ */
+export declare class TradesCallBuilder extends CallBuilder<ServerApi.CollectionPage<ServerApi.TradeRecord>> {
+    constructor(serverUrl: URL, httpClient: HttpClient);
+    /**
+     * Filter trades for a specific asset pair (orderbook)
+     * @param base - asset
+     * @param counter - asset
+     * @returns current TradesCallBuilder instance
+     */
+    forAssetPair(base: Asset, counter: Asset): this;
+    /**
+     * Filter trades for a specific offer
+     * @param offerId - ID of the offer
+     * @returns current TradesCallBuilder instance
+     */
+    forOffer(offerId: string): this;
+    /**
+     * Filter trades by a specific type.
+     * @param tradeType - the trade type to filter by.
+     * @returns current TradesCallBuilder instance.
+     */
+    forType(tradeType: ServerApi.TradeType): this;
+    /**
+     * Filter trades for a specific account
+     * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/get-trades-by-account-id | Trades for Account}
+     * @param accountId - For example: `GBYTR4MC5JAX4ALGUBJD7EIKZVM7CUGWKXIUJMRSMK573XH2O7VAK3SR`
+     * @returns current TradesCallBuilder instance
+     */
+    forAccount(accountId: string): this;
+    /**
+     * Filter trades for a specific liquidity pool
+     * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-related-trades | Trades for Liquidity Pool}
+     * @param liquidityPoolId - For example: `3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4`
+     * @returns current TradesCallBuilder instance
+     */
+    forLiquidityPool(liquidityPoolId: string): this;
+}

package/lib/esm/gateway/trades_call_builder.js

@@ -0,0 +1,72 @@
+import { CallBuilder } from './call_builder.js';
+
+class TradesCallBuilder extends CallBuilder {
+  constructor(serverUrl, httpClient) {
+    super(serverUrl, httpClient, "trades");
+    this.setPath("trades");
+  }
+  /**
+   * Filter trades for a specific asset pair (orderbook)
+   * @param base - asset
+   * @param counter - asset
+   * @returns current TradesCallBuilder instance
+   */
+  forAssetPair(base, counter) {
+    const baseIssuer = base.getIssuer();
+    if (!base.isNative() && baseIssuer !== void 0) {
+      this.url.searchParams.set("base_asset_type", base.getAssetType());
+      this.url.searchParams.set("base_asset_code", base.getCode());
+      this.url.searchParams.set("base_asset_issuer", baseIssuer);
+    } else {
+      this.url.searchParams.set("base_asset_type", "native");
+    }
+    const counterIssuer = counter.getIssuer();
+    if (!counter.isNative() && counterIssuer !== void 0) {
+      this.url.searchParams.set("counter_asset_type", counter.getAssetType());
+      this.url.searchParams.set("counter_asset_code", counter.getCode());
+      this.url.searchParams.set("counter_asset_issuer", counterIssuer);
+    } else {
+      this.url.searchParams.set("counter_asset_type", "native");
+    }
+    return this;
+  }
+  /**
+   * Filter trades for a specific offer
+   * @param offerId - ID of the offer
+   * @returns current TradesCallBuilder instance
+   */
+  forOffer(offerId) {
+    this.url.searchParams.set("offer_id", offerId);
+    return this;
+  }
+  /**
+   * Filter trades by a specific type.
+   * @param tradeType - the trade type to filter by.
+   * @returns current TradesCallBuilder instance.
+   */
+  forType(tradeType) {
+    this.url.searchParams.set("trade_type", tradeType);
+    return this;
+  }
+  /**
+   * Filter trades for a specific account
+   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/get-trades-by-account-id | Trades for Account}
+   * @param accountId - For example: `GBYTR4MC5JAX4ALGUBJD7EIKZVM7CUGWKXIUJMRSMK573XH2O7VAK3SR`
+   * @returns current TradesCallBuilder instance
+   */
+  forAccount(accountId) {
+    return this.forEndpoint("accounts", accountId);
+  }
+  /**
+   * Filter trades for a specific liquidity pool
+   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-related-trades | Trades for Liquidity Pool}
+   * @param liquidityPoolId - For example: `3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4`
+   * @returns current TradesCallBuilder instance
+   */
+  forLiquidityPool(liquidityPoolId) {
+    return this.forEndpoint("liquidity_pools", liquidityPoolId);
+  }
+}
+
+export { TradesCallBuilder };
+//# sourceMappingURL=trades_call_builder.js.map

package/lib/esm/gateway/trades_call_builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trades_call_builder.js","sources":["../../../src/gateway/trades_call_builder.ts"],"sourcesContent":["import { Asset } from \"../base/index.js\";\nimport { CallBuilder } from \"./call_builder.js\";\nimport { ServerApi } from \"./server_api.js\";\nimport type { HttpClient } from \"../http-client/index.js\";\n\n/**\n * Creates a new {@link TradesCallBuilder} pointed to server defined by serverUrl.\n *\n * Do not create this object directly, use {@link Gateway.Server.trades}.\n *\n * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/trades | Trades}\n *\n * @param serverUrl - serverUrl Gateway server URL.\n */\nexport class TradesCallBuilder extends CallBuilder<\n  ServerApi.CollectionPage<ServerApi.TradeRecord>\n> {\n  constructor(serverUrl: URL, httpClient: HttpClient) {\n    super(serverUrl, httpClient, \"trades\");\n    this.setPath(\"trades\");\n  }\n\n  /**\n   * Filter trades for a specific asset pair (orderbook)\n   * @param base - asset\n   * @param counter - asset\n   * @returns current TradesCallBuilder instance\n   */\n  public forAssetPair(base: Asset, counter: Asset): this {\n    const baseIssuer = base.getIssuer();\n    if (!base.isNative() && baseIssuer !== undefined) {\n      this.url.searchParams.set(\"base_asset_type\", base.getAssetType());\n      this.url.searchParams.set(\"base_asset_code\", base.getCode());\n      this.url.searchParams.set(\"base_asset_issuer\", baseIssuer);\n    } else {\n      this.url.searchParams.set(\"base_asset_type\", \"native\");\n    }\n    const counterIssuer = counter.getIssuer();\n    if (!counter.isNative() && counterIssuer !== undefined) {\n      this.url.searchParams.set(\"counter_asset_type\", counter.getAssetType());\n      this.url.searchParams.set(\"counter_asset_code\", counter.getCode());\n      this.url.searchParams.set(\"counter_asset_issuer\", counterIssuer);\n    } else {\n      this.url.searchParams.set(\"counter_asset_type\", \"native\");\n    }\n    return this;\n  }\n\n  /**\n   * Filter trades for a specific offer\n   * @param offerId - ID of the offer\n   * @returns current TradesCallBuilder instance\n   */\n  public forOffer(offerId: string): this {\n    this.url.searchParams.set(\"offer_id\", offerId);\n    return this;\n  }\n\n  /**\n   * Filter trades by a specific type.\n   * @param tradeType - the trade type to filter by.\n   * @returns current TradesCallBuilder instance.\n   */\n  public forType(tradeType: ServerApi.TradeType): this {\n    this.url.searchParams.set(\"trade_type\", tradeType);\n    return this;\n  }\n\n  /**\n   * Filter trades for a specific account\n   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/get-trades-by-account-id | Trades for Account}\n   * @param accountId - For example: `GBYTR4MC5JAX4ALGUBJD7EIKZVM7CUGWKXIUJMRSMK573XH2O7VAK3SR`\n   * @returns current TradesCallBuilder instance\n   */\n  public forAccount(accountId: string): this {\n    return this.forEndpoint(\"accounts\", accountId);\n  }\n\n  /**\n   * Filter trades for a specific liquidity pool\n   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-related-trades | Trades for Liquidity Pool}\n   * @param liquidityPoolId - For example: `3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4`\n   * @returns current TradesCallBuilder instance\n   */\n  public forLiquidityPool(liquidityPoolId: string): this {\n    return this.forEndpoint(\"liquidity_pools\", liquidityPoolId);\n  }\n}\n"],"names":[],"mappings":";;AAcO,MAAM,0BAA0B,WAAA,CAErC;AAAA,EACA,WAAA,CAAY,WAAgB,UAAA,EAAwB;AAClD,IAAA,KAAA,CAAM,SAAA,EAAW,YAAY,QAAQ,CAAA;AACrC,IAAA,IAAA,CAAK,QAAQ,QAAQ,CAAA;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,YAAA,CAAa,MAAa,OAAA,EAAsB;AACrD,IAAA,MAAM,UAAA,GAAa,KAAK,SAAA,EAAU;AAClC,IAAA,IAAI,CAAC,IAAA,CAAK,QAAA,EAAS,IAAK,eAAe,MAAA,EAAW;AAChD,MAAA,IAAA,CAAK,IAAI,YAAA,CAAa,GAAA,CAAI,iBAAA,EAAmB,IAAA,CAAK,cAAc,CAAA;AAChE,MAAA,IAAA,CAAK,IAAI,YAAA,CAAa,GAAA,CAAI,iBAAA,EAAmB,IAAA,CAAK,SAAS,CAAA;AAC3D,MAAA,IAAA,CAAK,GAAA,CAAI,YAAA,CAAa,GAAA,CAAI,mBAAA,EAAqB,UAAU,CAAA;AAAA,IAC3D,CAAA,MAAO;AACL,MAAA,IAAA,CAAK,GAAA,CAAI,YAAA,CAAa,GAAA,CAAI,iBAAA,EAAmB,QAAQ,CAAA;AAAA,IACvD;AACA,IAAA,MAAM,aAAA,GAAgB,QAAQ,SAAA,EAAU;AACxC,IAAA,IAAI,CAAC,OAAA,CAAQ,QAAA,EAAS,IAAK,kBAAkB,MAAA,EAAW;AACtD,MAAA,IAAA,CAAK,IAAI,YAAA,CAAa,GAAA,CAAI,oBAAA,EAAsB,OAAA,CAAQ,cAAc,CAAA;AACtE,MAAA,IAAA,CAAK,IAAI,YAAA,CAAa,GAAA,CAAI,oBAAA,EAAsB,OAAA,CAAQ,SAAS,CAAA;AACjE,MAAA,IAAA,CAAK,GAAA,CAAI,YAAA,CAAa,GAAA,CAAI,sBAAA,EAAwB,aAAa,CAAA;AAAA,IACjE,CAAA,MAAO;AACL,MAAA,IAAA,CAAK,GAAA,CAAI,YAAA,CAAa,GAAA,CAAI,oBAAA,EAAsB,QAAQ,CAAA;AAAA,IAC1D;AACA,IAAA,OAAO,IAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,SAAS,OAAA,EAAuB;AACrC,IAAA,IAAA,CAAK,GAAA,CAAI,YAAA,CAAa,GAAA,CAAI,UAAA,EAAY,OAAO,CAAA;AAC7C,IAAA,OAAO,IAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,QAAQ,SAAA,EAAsC;AACnD,IAAA,IAAA,CAAK,GAAA,CAAI,YAAA,CAAa,GAAA,CAAI,YAAA,EAAc,SAAS,CAAA;AACjD,IAAA,OAAO,IAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,WAAW,SAAA,EAAyB;AACzC,IAAA,OAAO,IAAA,CAAK,WAAA,CAAY,UAAA,EAAY,SAAS,CAAA;AAAA,EAC/C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,iBAAiB,eAAA,EAA+B;AACrD,IAAA,OAAO,IAAA,CAAK,WAAA,CAAY,iBAAA,EAAmB,eAAe,CAAA;AAAA,EAC5D;AACF;;;;"}

package/lib/esm/gateway/transaction_call_builder.d.ts

@@ -0,0 +1,57 @@
+import { CallBuilder } from "./call_builder.js";
+import { ServerApi } from "./server_api.js";
+import type { HttpClient } from "../http-client/index.js";
+/**
+ * Creates a new {@link TransactionCallBuilder} pointed to server defined by serverUrl.
+ *
+ * Do not create this object directly, use {@link Gateway.Server.transactions}.
+ *
+ * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/list-all-transactions | All Transactions}
+ *
+ * @param serverUrl - Gateway server URL.
+ */
+export declare class TransactionCallBuilder extends CallBuilder<ServerApi.CollectionPage<ServerApi.TransactionRecord>> {
+    constructor(serverUrl: URL, httpClient: HttpClient);
+    /**
+     * The transaction details endpoint provides information on a single transaction. The transaction hash provided in the hash argument specifies which transaction to load.
+     * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-a-transaction | Transaction Details}
+     * @param transactionId - Transaction ID
+     * @returns a CallBuilder instance
+     */
+    transaction(transactionId: string): CallBuilder<ServerApi.TransactionRecord>;
+    /**
+     * This endpoint represents all transactions that affected a given account.
+     * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/get-transactions-by-account-id | Transactions for Account}
+     * @param accountId - For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
+     * @returns current TransactionCallBuilder instance
+     */
+    forAccount(accountId: string): this;
+    /**
+     * This endpoint represents all transactions that reference a given claimable_balance.
+     * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/cb-retrieve-related-transactions | Transactions for Claimable Balance}
+     * @param claimableBalanceId - Claimable Balance ID
+     * @returns this TransactionCallBuilder instance
+     */
+    forClaimableBalance(claimableBalanceId: string): this;
+    /**
+     * This endpoint represents all transactions in a given ledger.
+     * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-a-ledgers-transactions | Transactions for Ledger}
+     * @param sequence - Ledger sequence
+     * @returns current TransactionCallBuilder instance
+     */
+    forLedger(sequence: number | string): this;
+    /**
+     * This endpoint represents all transactions involving a particular liquidity pool.
+     *
+     * @param poolId - liquidity pool ID
+     * @returns this TransactionCallBuilder instance
+     */
+    forLiquidityPool(poolId: string): this;
+    /**
+     * Adds a parameter defining whether to include failed transactions. By default only successful transactions are
+     * returned.
+     * @param value - Set to `true` to include failed transactions.
+     * @returns current TransactionCallBuilder instance
+     */
+    includeFailed(value: boolean): this;
+}

package/lib/esm/gateway/transaction_call_builder.js

@@ -0,0 +1,71 @@
+import { CallBuilder } from './call_builder.js';
+
+class TransactionCallBuilder extends CallBuilder {
+  constructor(serverUrl, httpClient) {
+    super(serverUrl, httpClient, "transactions");
+    this.setPath("transactions");
+  }
+  /**
+   * The transaction details endpoint provides information on a single transaction. The transaction hash provided in the hash argument specifies which transaction to load.
+   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-a-transaction | Transaction Details}
+   * @param transactionId - Transaction ID
+   * @returns a CallBuilder instance
+   */
+  transaction(transactionId) {
+    const builder = new CallBuilder(
+      new URL(this.url),
+      this.httpClient
+    );
+    builder.filter.push([transactionId]);
+    return builder;
+  }
+  /**
+   * This endpoint represents all transactions that affected a given account.
+   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/get-transactions-by-account-id | Transactions for Account}
+   * @param accountId - For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
+   * @returns current TransactionCallBuilder instance
+   */
+  forAccount(accountId) {
+    return this.forEndpoint("accounts", accountId);
+  }
+  /**
+   * This endpoint represents all transactions that reference a given claimable_balance.
+   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/cb-retrieve-related-transactions | Transactions for Claimable Balance}
+   * @param claimableBalanceId - Claimable Balance ID
+   * @returns this TransactionCallBuilder instance
+   */
+  forClaimableBalance(claimableBalanceId) {
+    return this.forEndpoint("claimable_balances", claimableBalanceId);
+  }
+  /**
+   * This endpoint represents all transactions in a given ledger.
+   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-a-ledgers-transactions | Transactions for Ledger}
+   * @param sequence - Ledger sequence
+   * @returns current TransactionCallBuilder instance
+   */
+  forLedger(sequence) {
+    return this.forEndpoint("ledgers", sequence.toString());
+  }
+  /**
+   * This endpoint represents all transactions involving a particular liquidity pool.
+   *
+   * @param poolId - liquidity pool ID
+   * @returns this TransactionCallBuilder instance
+   */
+  forLiquidityPool(poolId) {
+    return this.forEndpoint("liquidity_pools", poolId);
+  }
+  /**
+   * Adds a parameter defining whether to include failed transactions. By default only successful transactions are
+   * returned.
+   * @param value - Set to `true` to include failed transactions.
+   * @returns current TransactionCallBuilder instance
+   */
+  includeFailed(value) {
+    this.url.searchParams.set("include_failed", value.toString());
+    return this;
+  }
+}
+
+export { TransactionCallBuilder };
+//# sourceMappingURL=transaction_call_builder.js.map

package/lib/esm/gateway/transaction_call_builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction_call_builder.js","sources":["../../../src/gateway/transaction_call_builder.ts"],"sourcesContent":["import { CallBuilder } from \"./call_builder.js\";\nimport { ServerApi } from \"./server_api.js\";\nimport type { HttpClient } from \"../http-client/index.js\";\n\n/**\n * Creates a new {@link TransactionCallBuilder} pointed to server defined by serverUrl.\n *\n * Do not create this object directly, use {@link Gateway.Server.transactions}.\n *\n * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/list-all-transactions | All Transactions}\n *\n * @param serverUrl - Gateway server URL.\n */\nexport class TransactionCallBuilder extends CallBuilder<\n  ServerApi.CollectionPage<ServerApi.TransactionRecord>\n> {\n  constructor(serverUrl: URL, httpClient: HttpClient) {\n    super(serverUrl, httpClient, \"transactions\");\n    this.setPath(\"transactions\");\n  }\n\n  /**\n   * The transaction details endpoint provides information on a single transaction. The transaction hash provided in the hash argument specifies which transaction to load.\n   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-a-transaction | Transaction Details}\n   * @param transactionId - Transaction ID\n   * @returns a CallBuilder instance\n   */\n  public transaction(\n    transactionId: string,\n  ): CallBuilder<ServerApi.TransactionRecord> {\n    const builder = new CallBuilder<ServerApi.TransactionRecord>(\n      new URL(this.url),\n      this.httpClient,\n    );\n    builder.filter.push([transactionId]);\n    return builder;\n  }\n\n  /**\n   * This endpoint represents all transactions that affected a given account.\n   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/get-transactions-by-account-id | Transactions for Account}\n   * @param accountId - For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`\n   * @returns current TransactionCallBuilder instance\n   */\n  public forAccount(accountId: string): this {\n    return this.forEndpoint(\"accounts\", accountId);\n  }\n\n  /**\n   * This endpoint represents all transactions that reference a given claimable_balance.\n   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/cb-retrieve-related-transactions | Transactions for Claimable Balance}\n   * @param claimableBalanceId - Claimable Balance ID\n   * @returns this TransactionCallBuilder instance\n   */\n  public forClaimableBalance(claimableBalanceId: string): this {\n    return this.forEndpoint(\"claimable_balances\", claimableBalanceId);\n  }\n\n  /**\n   * This endpoint represents all transactions in a given ledger.\n   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-a-ledgers-transactions | Transactions for Ledger}\n   * @param sequence - Ledger sequence\n   * @returns current TransactionCallBuilder instance\n   */\n  public forLedger(sequence: number | string): this {\n    return this.forEndpoint(\"ledgers\", sequence.toString());\n  }\n\n  /**\n   * This endpoint represents all transactions involving a particular liquidity pool.\n   *\n   * @param poolId - liquidity pool ID\n   * @returns this TransactionCallBuilder instance\n   */\n  public forLiquidityPool(poolId: string): this {\n    return this.forEndpoint(\"liquidity_pools\", poolId);\n  }\n\n  /**\n   * Adds a parameter defining whether to include failed transactions. By default only successful transactions are\n   * returned.\n   * @param value - Set to `true` to include failed transactions.\n   * @returns current TransactionCallBuilder instance\n   */\n  public includeFailed(value: boolean): this {\n    this.url.searchParams.set(\"include_failed\", value.toString());\n    return this;\n  }\n}\n"],"names":[],"mappings":";;AAaO,MAAM,+BAA+B,WAAA,CAE1C;AAAA,EACA,WAAA,CAAY,WAAgB,UAAA,EAAwB;AAClD,IAAA,KAAA,CAAM,SAAA,EAAW,YAAY,cAAc,CAAA;AAC3C,IAAA,IAAA,CAAK,QAAQ,cAAc,CAAA;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,YACL,aAAA,EAC0C;AAC1C,IAAA,MAAM,UAAU,IAAI,WAAA;AAAA,MAClB,IAAI,GAAA,CAAI,IAAA,CAAK,GAAG,CAAA;AAAA,MAChB,IAAA,CAAK;AAAA,KACP;AACA,IAAA,OAAA,CAAQ,MAAA,CAAO,IAAA,CAAK,CAAC,aAAa,CAAC,CAAA;AACnC,IAAA,OAAO,OAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,WAAW,SAAA,EAAyB;AACzC,IAAA,OAAO,IAAA,CAAK,WAAA,CAAY,UAAA,EAAY,SAAS,CAAA;AAAA,EAC/C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,oBAAoB,kBAAA,EAAkC;AAC3D,IAAA,OAAO,IAAA,CAAK,WAAA,CAAY,oBAAA,EAAsB,kBAAkB,CAAA;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,UAAU,QAAA,EAAiC;AAChD,IAAA,OAAO,IAAA,CAAK,WAAA,CAAY,SAAA,EAAW,QAAA,CAAS,UAAU,CAAA;AAAA,EACxD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,iBAAiB,MAAA,EAAsB;AAC5C,IAAA,OAAO,IAAA,CAAK,WAAA,CAAY,iBAAA,EAAmB,MAAM,CAAA;AAAA,EACnD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,cAAc,KAAA,EAAsB;AACzC,IAAA,IAAA,CAAK,IAAI,YAAA,CAAa,GAAA,CAAI,gBAAA,EAAkB,KAAA,CAAM,UAAU,CAAA;AAC5D,IAAA,OAAO,IAAA;AAAA,EACT;AACF;;;;"}

package/lib/esm/gateway/types/account.d.ts

@@ -0,0 +1,5 @@
+export interface AccountRecordSigners {
+    key: string;
+    weight: number;
+    type: string;
+}

package/lib/esm/gateway/types/assets.d.ts

@@ -0,0 +1,17 @@
+import type { AssetType } from "../../base/index.js";
+import { GatewayApi } from "../gateway_api.js";
+export interface AssetRecord extends GatewayApi.BaseResponse {
+    asset_type: AssetType.credit4 | AssetType.credit12;
+    asset_code: string;
+    asset_issuer: string;
+    paging_token: string;
+    accounts: GatewayApi.AssetAccounts;
+    balances: GatewayApi.AssetBalances;
+    num_claimable_balances: number;
+    num_liquidity_pools: number;
+    num_contracts: number;
+    claimable_balances_amount: string;
+    liquidity_pools_amount: string;
+    contracts_amount: string;
+    flags: GatewayApi.Flags;
+}