@digitalworld/digital-world-sdk 16.0.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"call_builder.js","sources":["../../../src/gateway/call_builder.ts"],"sourcesContent":["import { EventSource } from \"eventsource\";\n\nimport {\n  BadRequestError,\n  NetworkError,\n  NotFoundError,\n} from \"../errors/index.js\";\nimport { GatewayApi } from \"./gateway_api.js\";\nimport { version } from \"./gateway_axios_client.js\";\nimport type { HttpClient } from \"../http-client/index.js\";\nimport { ServerApi } from \"./server_api.js\";\nimport type { Server } from \"../federation/index.js\";\nimport { expandUriTemplate } from \"../utils/url.js\";\n\n// Resources which can be included in the Horizon response via the `join`\n// query-param.\nconst JOINABLE = [\"transaction\"];\n\nexport interface EventSourceOptions<T> {\n  onmessage?: (\n    value: T extends ServerApi.CollectionPage<infer U> ? U : T,\n  ) => void;\n  onerror?: (event: MessageEvent) => void;\n  reconnectTimeout?: number;\n}\n\n/**\n * Creates a new {@link CallBuilder} pointed to server defined by serverUrl.\n *\n * This is an **abstract** class. Do not create this object directly, use {@link Server} class.\n * @param serverUrl - URL of Horizon server\n */\nexport class CallBuilder<\n  T extends\n    | GatewayApi.FeeStatsResponse\n    | GatewayApi.BaseResponse\n    | GatewayApi.RootResponse\n    | ServerApi.CollectionPage<GatewayApi.BaseResponse>,\n> {\n  protected url: URL;\n\n  public filter: string[][];\n\n  protected originalSegments: string[];\n\n  protected neighborRoot: string;\n\n  protected httpClient: HttpClient;\n\n  constructor(\n    serverUrl: URL,\n    httpClient: HttpClient,\n    neighborRoot: string = \"\",\n  ) {\n    this.url = new URL(serverUrl);\n    this.filter = [];\n\n    this.originalSegments = this.url.pathname\n      .split(\"/\")\n      .filter((s) => s.length > 0);\n    this.neighborRoot = neighborRoot;\n    this.httpClient = httpClient;\n  }\n\n  protected setPath(...segments: string[]): void {\n    const endpointSegments = segments.flatMap((segment) =>\n      segment.split(\"/\").filter((s) => s.length > 0),\n    );\n    this.url.pathname = this.originalSegments\n      .concat(endpointSegments)\n      .join(\"/\");\n  }\n\n  /**\n   * Triggers a HTTP request using this builder's current configuration.\n   * @returns a Promise that resolves to the server's response.\n   */\n  public call(): Promise<T> {\n    this.checkFilter();\n    return this._sendNormalRequest(this.url).then((r) =>\n      this._parseResponse(r),\n    );\n  }\n  //// TODO: Migrate to async, BUT that's a change in behavior and tests \"rejects two filters\" will fail.\n  //// It's because async will check within promise, which makes more sense when using awaits instead of Promises.\n  // public async call(): Promise<T> {\n  //   this.checkFilter();\n  //   const r = await this._sendNormalRequest(this.url);\n  //   return this._parseResponse(r);\n  // }\n  //// /* actually equals */\n  //// public call(): Promise<T> {\n  ////   return Promise.resolve().then(() => {\n  ////     this.checkFilter();\n  ////     return this._sendNormalRequest(this.url)\n  ////   }).then((r) => {\n  ////     this._parseResponse(r)\n  ////   });\n  //// }\n\n  /**\n   * Creates an EventSource that listens for incoming messages from the server. To stop listening for new\n   * events call the function returned by this method.\n   * @see [Gateway Response Format](https://docs.digitalworld.global/api/introduction/response-format/)\n   * @see [MDN EventSource](https://developer.mozilla.org/en-US/docs/Web/API/EventSource)\n   * @param options - (optional) EventSource options.\n   *   - `onmessage` (optional): Callback function to handle incoming messages.\n   *   - `onerror` (optional): Callback function to handle errors.\n   *   - `reconnectTimeout` (optional): Custom stream connection timeout in ms, default is 15 seconds.\n   * @returns Close function. Run to close the connection and stop listening for new events.\n   */\n  public stream(\n    options: EventSourceOptions<\n      T extends ServerApi.CollectionPage<infer U> ? U : T\n    > = {},\n  ): () => void {\n    this.checkFilter();\n\n    const streamUrl = new URL(this.url);\n    streamUrl.searchParams.set(\"X-Client-Name\", \"digital-world-js-sdk\");\n    streamUrl.searchParams.set(\"X-Client-Version\", version);\n\n    // Extract custom app headers from httpClient defaults and add as query params\n    // (EventSource doesn't support custom headers, so we use query params)\n    const { headers } = this.httpClient.defaults;\n    if (headers) {\n      const headerNames = [\"X-App-Name\", \"X-App-Version\"];\n      headerNames.forEach((name) => {\n        let value: string | undefined;\n        if (headers instanceof Headers) {\n          value = headers.get(name) ?? undefined;\n        } else if (Array.isArray(headers)) {\n          const entry = headers.find(([key]) => key === name);\n          value = entry?.[1];\n        } else {\n          value = headers[name];\n        }\n        if (value) {\n          streamUrl.searchParams.set(name, value);\n        }\n      });\n    }\n\n    // EventSource object\n    let es: EventSource;\n    // timeout is the id of the timeout to be triggered if there were no new messages\n    // in the last 15 seconds. The timeout is reset when a new message arrive.\n    // It prevents closing EventSource object in case of 504 errors as `readyState`\n    // property is not reliable.\n    let timeout: ReturnType<typeof setTimeout>;\n\n    const createTimeout = () => {\n      timeout = setTimeout(\n        () => {\n          es?.close();\n\n          es = createEventSource();\n        },\n        options.reconnectTimeout || 15 * 1000,\n      );\n    };\n\n    const createEventSource = (): EventSource => {\n      try {\n        es = new EventSource(streamUrl.toString());\n      } catch (err) {\n        if (options.onerror) {\n          options.onerror(err as MessageEvent);\n        }\n      }\n\n      createTimeout();\n      if (!es) {\n        return es;\n      }\n\n      // when receiving the close message from Horizon we should close the\n      // connection and recreate the event source (basically retrying forever)\n      let closed = false;\n      const onClose = () => {\n        if (closed) {\n          return;\n        }\n\n        clearTimeout(timeout);\n\n        es.close();\n        createEventSource();\n        closed = true;\n      };\n\n      const onMessage = (message: any) => {\n        if (message.type === \"close\") {\n          onClose();\n          return;\n        }\n\n        const result = message.data\n          ? this._parseRecord(JSON.parse(message.data))\n          : message;\n        if (result.paging_token) {\n          streamUrl.searchParams.set(\"cursor\", result.paging_token);\n        }\n        clearTimeout(timeout);\n        createTimeout();\n        if (typeof options.onmessage !== \"undefined\") {\n          options.onmessage(result);\n        }\n      };\n\n      const onError = (error: any) => {\n        if (options.onerror) {\n          options.onerror(error as MessageEvent);\n        }\n      };\n\n      if (es.addEventListener) {\n        es.addEventListener(\"message\", onMessage.bind(this));\n        es.addEventListener(\"error\", onError.bind(this));\n        es.addEventListener(\"close\", onClose.bind(this));\n      } else {\n        es.onmessage = onMessage.bind(this);\n        es.onerror = onError.bind(this);\n      }\n\n      return es;\n    };\n\n    createEventSource();\n    return () => {\n      clearTimeout(timeout);\n      es?.close();\n    };\n  }\n\n  /**\n   * Sets `cursor` parameter for the current call. Returns the CallBuilder object on which this method has been called.\n   * @see [Paging](https://docs.digitalworld.global/api/introduction/pagination/)\n   * @param cursor - A cursor is a value that points to a specific location in a collection of resources.\n   * @returns current CallBuilder instance\n   */\n  public cursor(cursor: string): this {\n    this.url.searchParams.set(\"cursor\", cursor);\n    return this;\n  }\n\n  /**\n   * Sets `limit` parameter for the current call. Returns the CallBuilder object on which this method has been called.\n   * @see [Paging](https://docs.digitalworld.global/api/introduction/pagination/)\n   * @param recordsNumber - Number of records the server should return.\n   * @returns current CallBuilder instance\n   */\n  public limit(recordsNumber: number): this {\n    this.url.searchParams.set(\"limit\", recordsNumber.toString());\n    return this;\n  }\n\n  /**\n   * Sets `order` parameter for the current call. Returns the CallBuilder object on which this method has been called.\n   * @param direction - Sort direction\n   * @returns current CallBuilder instance\n   */\n  public order(direction: \"asc\" | \"desc\"): this {\n    this.url.searchParams.set(\"order\", direction);\n    return this;\n  }\n\n  /**\n   * Sets `join` parameter for the current call. The `join` parameter\n   * includes the requested resource in the response. Currently, the\n   * only valid value for the parameter is `transactions` and is only\n   * supported on the operations and payments endpoints. The response\n   * will include a `transaction` field for each operation in the\n   * response.\n   *\n   * @param include - join Records to be included in the response.\n   * @returns current CallBuilder instance.\n   */\n  public join(include: \"transactions\"): this {\n    this.url.searchParams.set(\"join\", include);\n    return this;\n  }\n\n  /**\n   * A helper method to craft queries to \"neighbor\" endpoints.\n   *\n   *  For example, we have an `/effects` suffix endpoint on many different\n   *  \"root\" endpoints, such as `/transactions/:id` and `/accounts/:id`. So,\n   *  it's helpful to be able to conveniently create queries to the\n   *  `/accounts/:id/effects` endpoint:\n   *\n   *    `this.forEndpoint(\"accounts\", accountId)`.\n   *\n   * @param endpoint - neighbor endpoint in question, like /operations\n   * @param param - filter parameter, like an operation ID\n   *\n   * @returns this CallBuilder instance\n   */\n  protected forEndpoint(endpoint: string, param: string): this {\n    if (this.neighborRoot === \"\") {\n      throw new Error(\"Invalid usage: neighborRoot not set in constructor\");\n    }\n    this.filter.push([endpoint, param, this.neighborRoot]);\n    return this;\n  }\n\n  /**\n   * @hidden\n   * @returns    */\n  private checkFilter(): void {\n    if (this.filter.length >= 2) {\n      throw new BadRequestError(\"Too many filters specified\", this.filter);\n    }\n\n    if (this.filter.length === 1) {\n      // append filters to original segments\n      const newSegment = this.originalSegments.concat(this.filter[0]);\n      this.url.pathname = newSegment.join(\"/\");\n    }\n  }\n\n  /**\n   * Convert a link object to a function that fetches that link.\n   * @hidden\n   * @param link - A link object\n   *   - `href`: the URI of the link\n   *   - `templated` (optional): Whether the link is templated\n   * @returns A function that requests the link\n   */\n  private _requestFnForLink(\n    link: GatewayApi.ResponseLink,\n  ): (opts?: any) => any {\n    return async (opts: any = {}) => {\n      let uri;\n\n      if (link.templated) {\n        uri = new URL(expandUriTemplate(link.href, opts), this.url);\n      } else {\n        uri = new URL(link.href, this.url);\n      }\n\n      const r = await this._sendNormalRequest(uri);\n      return this._parseResponse(r);\n    };\n  }\n\n  /**\n   * Given the json response, find and convert each link into a function that\n   * calls that link.\n   * @hidden\n   * @param json - JSON response\n   * @returns JSON response with string links replaced with functions\n   */\n  private _parseRecord(json: any): any {\n    if (!json._links) {\n      return json;\n    }\n    Object.keys(json._links).forEach((key) => {\n      const n = json._links[key];\n      let included = false;\n      // If the key with the link name already exists, create a copy\n      if (typeof json[key] !== \"undefined\") {\n        json[`${key}_attr`] = json[key];\n        included = true;\n      }\n\n      /*\n       If the resource can be side-loaded using `join` query-param then don't\n       try to load from the server. We need to whitelist the keys which are\n       joinable, since there are other keys like `ledger` which is included in\n       some payloads, but doesn't represent the ledger resource, in that\n       scenario we want to make the call to the server using the URL from links.\n      */\n      if (included && JOINABLE.indexOf(key) >= 0) {\n        const record = this._parseRecord(json[key]);\n        // Maintain a promise based API so the behavior is the same whether you\n        // are loading from the server or in-memory (via join).\n        // eslint-disable-next-line @typescript-eslint/require-await\n        json[key] = async () => record;\n      } else {\n        json[key] = this._requestFnForLink(n as GatewayApi.ResponseLink);\n      }\n    });\n    return json;\n  }\n\n  private async _sendNormalRequest(initialUrl: URL) {\n    const url = new URL(initialUrl);\n\n    // Always use the configured server's authority and protocol.\n    // Horizon returns absolute URLs in _links that would bypass reverse proxies.\n    url.protocol = this.url.protocol;\n    url.host = this.url.host;\n\n    return this.httpClient\n      .get(url.toString())\n      .then((response) => response.data)\n      .catch(this._handleNetworkError);\n  }\n\n  /**\n   * @hidden\n   * @param json - Response object\n   * @returns Extended response\n   */\n  private _parseResponse(json: any) {\n    if (json._embedded && json._embedded.records) {\n      return this._toCollectionPage(json);\n    }\n    return this._parseRecord(json);\n  }\n\n  /**\n   * @hidden\n   * @param json - Response object\n   * @returns Extended response object\n   */\n  private _toCollectionPage(json: any): any {\n    for (let i = 0; i < json._embedded.records.length; i += 1) {\n      json._embedded.records[i] = this._parseRecord(json._embedded.records[i]);\n    }\n    return {\n      records: json._embedded.records,\n      next: async () => {\n        const r = await this._sendNormalRequest(\n          new URL(json._links.next.href, this.url),\n        );\n        return this._toCollectionPage(r);\n      },\n      prev: async () => {\n        const r = await this._sendNormalRequest(\n          new URL(json._links.prev.href, this.url),\n        );\n        return this._toCollectionPage(r);\n      },\n    };\n  }\n\n  /**\n   * @hidden\n   * @param error - Network error object\n   * @returns Promise that rejects with a human-readable error\n   */\n  private async _handleNetworkError(error: NetworkError): Promise<void> {\n    if (error.response && error.response.status) {\n      switch (error.response.status) {\n        case 404:\n          return Promise.reject(\n            new NotFoundError(\n              error.response.statusText ?? \"Not Found\",\n              error.response.data,\n            ),\n          );\n        default:\n          return Promise.reject(\n            new NetworkError(\n              error.response.statusText ?? \"Unknown\",\n              error.response.data,\n            ),\n          );\n      }\n    } else {\n      return Promise.reject(new Error(error.message));\n    }\n  }\n}\n"],"names":[],"mappings":";;;;;;;AAgBA,MAAM,QAAA,GAAW,CAAC,aAAa,CAAA;AAgBxB,MAAM,WAAA,CAMX;AAAA,EACU,GAAA;AAAA,EAEH,MAAA;AAAA,EAEG,gBAAA;AAAA,EAEA,YAAA;AAAA,EAEA,UAAA;AAAA,EAEV,WAAA,CACE,SAAA,EACA,UAAA,EACA,YAAA,GAAuB,EAAA,EACvB;AACA,IAAA,IAAA,CAAK,GAAA,GAAM,IAAI,GAAA,CAAI,SAAS,CAAA;AAC5B,IAAA,IAAA,CAAK,SAAS,EAAC;AAEf,IAAA,IAAA,CAAK,gBAAA,GAAmB,IAAA,CAAK,GAAA,CAAI,QAAA,CAC9B,KAAA,CAAM,GAAG,CAAA,CACT,MAAA,CAAO,CAAC,CAAA,KAAM,CAAA,CAAE,MAAA,GAAS,CAAC,CAAA;AAC7B,IAAA,IAAA,CAAK,YAAA,GAAe,YAAA;AACpB,IAAA,IAAA,CAAK,UAAA,GAAa,UAAA;AAAA,EACpB;AAAA,EAEU,WAAW,QAAA,EAA0B;AAC7C,IAAA,MAAM,mBAAmB,QAAA,CAAS,OAAA;AAAA,MAAQ,CAAC,OAAA,KACzC,OAAA,CAAQ,KAAA,CAAM,GAAG,CAAA,CAAE,MAAA,CAAO,CAAC,CAAA,KAAM,CAAA,CAAE,MAAA,GAAS,CAAC;AAAA,KAC/C;AACA,IAAA,IAAA,CAAK,GAAA,CAAI,WAAW,IAAA,CAAK,gBAAA,CACtB,OAAO,gBAAgB,CAAA,CACvB,KAAK,GAAG,CAAA;AAAA,EACb;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,IAAA,GAAmB;AACxB,IAAA,IAAA,CAAK,WAAA,EAAY;AACjB,IAAA,OAAO,IAAA,CAAK,kBAAA,CAAmB,IAAA,CAAK,GAAG,CAAA,CAAE,IAAA;AAAA,MAAK,CAAC,CAAA,KAC7C,IAAA,CAAK,cAAA,CAAe,CAAC;AAAA,KACvB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA6BO,MAAA,CACL,OAAA,GAEI,EAAC,EACO;AACZ,IAAA,IAAA,CAAK,WAAA,EAAY;AAEjB,IAAA,MAAM,SAAA,GAAY,IAAI,GAAA,CAAI,IAAA,CAAK,GAAG,CAAA;AAClC,IAAA,SAAA,CAAU,YAAA,CAAa,GAAA,CAAI,eAAA,EAAiB,sBAAsB,CAAA;AAClE,IAAA,SAAA,CAAU,YAAA,CAAa,GAAA,CAAI,kBAAA,EAAoB,OAAO,CAAA;AAItD,IAAA,MAAM,EAAE,OAAA,EAAQ,GAAI,IAAA,CAAK,UAAA,CAAW,QAAA;AACpC,IAAA,IAAI,OAAA,EAAS;AACX,MAAA,MAAM,WAAA,GAAc,CAAC,YAAA,EAAc,eAAe,CAAA;AAClD,MAAA,WAAA,CAAY,OAAA,CAAQ,CAAC,IAAA,KAAS;AAC5B,QAAA,IAAI,KAAA;AACJ,QAAA,IAAI,mBAAmB,OAAA,EAAS;AAC9B,UAAA,KAAA,GAAQ,OAAA,CAAQ,GAAA,CAAI,IAAI,CAAA,IAAK,MAAA;AAAA,QAC/B,CAAA,MAAA,IAAW,KAAA,CAAM,OAAA,CAAQ,OAAO,CAAA,EAAG;AACjC,UAAA,MAAM,KAAA,GAAQ,QAAQ,IAAA,CAAK,CAAC,CAAC,GAAG,CAAA,KAAM,QAAQ,IAAI,CAAA;AAClD,UAAA,KAAA,GAAQ,QAAQ,CAAC,CAAA;AAAA,QACnB,CAAA,MAAO;AACL,UAAA,KAAA,GAAQ,QAAQ,IAAI,CAAA;AAAA,QACtB;AACA,QAAA,IAAI,KAAA,EAAO;AACT,UAAA,SAAA,CAAU,YAAA,CAAa,GAAA,CAAI,IAAA,EAAM,KAAK,CAAA;AAAA,QACxC;AAAA,MACF,CAAC,CAAA;AAAA,IACH;AAGA,IAAA,IAAI,EAAA;AAKJ,IAAA,IAAI,OAAA;AAEJ,IAAA,MAAM,gBAAgB,MAAM;AAC1B,MAAA,OAAA,GAAU,UAAA;AAAA,QACR,MAAM;AACJ,UAAA,EAAA,EAAI,KAAA,EAAM;AAEV,UAAA,EAAA,GAAK,iBAAA,EAAkB;AAAA,QACzB,CAAA;AAAA,QACA,OAAA,CAAQ,oBAAoB,EAAA,GAAK;AAAA,OACnC;AAAA,IACF,CAAA;AAEA,IAAA,MAAM,oBAAoB,MAAmB;AAC3C,MAAA,IAAI;AACF,QAAA,EAAA,GAAK,IAAI,WAAA,CAAY,SAAA,CAAU,QAAA,EAAU,CAAA;AAAA,MAC3C,SAAS,GAAA,EAAK;AACZ,QAAA,IAAI,QAAQ,OAAA,EAAS;AACnB,UAAA,OAAA,CAAQ,QAAQ,GAAmB,CAAA;AAAA,QACrC;AAAA,MACF;AAEA,MAAA,aAAA,EAAc;AACd,MAAA,IAAI,CAAC,EAAA,EAAI;AACP,QAAA,OAAO,EAAA;AAAA,MACT;AAIA,MAAA,IAAI,MAAA,GAAS,KAAA;AACb,MAAA,MAAM,UAAU,MAAM;AACpB,QAAA,IAAI,MAAA,EAAQ;AACV,UAAA;AAAA,QACF;AAEA,QAAA,YAAA,CAAa,OAAO,CAAA;AAEpB,QAAA,EAAA,CAAG,KAAA,EAAM;AACT,QAAA,iBAAA,EAAkB;AAClB,QAAA,MAAA,GAAS,IAAA;AAAA,MACX,CAAA;AAEA,MAAA,MAAM,SAAA,GAAY,CAAC,OAAA,KAAiB;AAClC,QAAA,IAAI,OAAA,CAAQ,SAAS,OAAA,EAAS;AAC5B,UAAA,OAAA,EAAQ;AACR,UAAA;AAAA,QACF;AAEA,QAAA,MAAM,MAAA,GAAS,OAAA,CAAQ,IAAA,GACnB,IAAA,CAAK,YAAA,CAAa,KAAK,KAAA,CAAM,OAAA,CAAQ,IAAI,CAAC,CAAA,GAC1C,OAAA;AACJ,QAAA,IAAI,OAAO,YAAA,EAAc;AACvB,UAAA,SAAA,CAAU,YAAA,CAAa,GAAA,CAAI,QAAA,EAAU,MAAA,CAAO,YAAY,CAAA;AAAA,QAC1D;AACA,QAAA,YAAA,CAAa,OAAO,CAAA;AACpB,QAAA,aAAA,EAAc;AACd,QAAA,IAAI,OAAO,OAAA,CAAQ,SAAA,KAAc,WAAA,EAAa;AAC5C,UAAA,OAAA,CAAQ,UAAU,MAAM,CAAA;AAAA,QAC1B;AAAA,MACF,CAAA;AAEA,MAAA,MAAM,OAAA,GAAU,CAAC,KAAA,KAAe;AAC9B,QAAA,IAAI,QAAQ,OAAA,EAAS;AACnB,UAAA,OAAA,CAAQ,QAAQ,KAAqB,CAAA;AAAA,QACvC;AAAA,MACF,CAAA;AAEA,MAAA,IAAI,GAAG,gBAAA,EAAkB;AACvB,QAAA,EAAA,CAAG,gBAAA,CAAiB,SAAA,EAAW,SAAA,CAAU,IAAA,CAAK,IAAI,CAAC,CAAA;AACnD,QAAA,EAAA,CAAG,gBAAA,CAAiB,OAAA,EAAS,OAAA,CAAQ,IAAA,CAAK,IAAI,CAAC,CAAA;AAC/C,QAAA,EAAA,CAAG,gBAAA,CAAiB,OAAA,EAAS,OAAA,CAAQ,IAAA,CAAK,IAAI,CAAC,CAAA;AAAA,MACjD,CAAA,MAAO;AACL,QAAA,EAAA,CAAG,SAAA,GAAY,SAAA,CAAU,IAAA,CAAK,IAAI,CAAA;AAClC,QAAA,EAAA,CAAG,OAAA,GAAU,OAAA,CAAQ,IAAA,CAAK,IAAI,CAAA;AAAA,MAChC;AAEA,MAAA,OAAO,EAAA;AAAA,IACT,CAAA;AAEA,IAAA,iBAAA,EAAkB;AAClB,IAAA,OAAO,MAAM;AACX,MAAA,YAAA,CAAa,OAAO,CAAA;AACpB,MAAA,EAAA,EAAI,KAAA,EAAM;AAAA,IACZ,CAAA;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,OAAO,MAAA,EAAsB;AAClC,IAAA,IAAA,CAAK,GAAA,CAAI,YAAA,CAAa,GAAA,CAAI,QAAA,EAAU,MAAM,CAAA;AAC1C,IAAA,OAAO,IAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,MAAM,aAAA,EAA6B;AACxC,IAAA,IAAA,CAAK,IAAI,YAAA,CAAa,GAAA,CAAI,OAAA,EAAS,aAAA,CAAc,UAAU,CAAA;AAC3D,IAAA,OAAO,IAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,MAAM,SAAA,EAAiC;AAC5C,IAAA,IAAA,CAAK,GAAA,CAAI,YAAA,CAAa,GAAA,CAAI,OAAA,EAAS,SAAS,CAAA;AAC5C,IAAA,OAAO,IAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaO,KAAK,OAAA,EAA+B;AACzC,IAAA,IAAA,CAAK,GAAA,CAAI,YAAA,CAAa,GAAA,CAAI,MAAA,EAAQ,OAAO,CAAA;AACzC,IAAA,OAAO,IAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBU,WAAA,CAAY,UAAkB,KAAA,EAAqB;AAC3D,IAAA,IAAI,IAAA,CAAK,iBAAiB,EAAA,EAAI;AAC5B,MAAA,MAAM,IAAI,MAAM,oDAAoD,CAAA;AAAA,IACtE;AACA,IAAA,IAAA,CAAK,OAAO,IAAA,CAAK,CAAC,UAAU,KAAA,EAAO,IAAA,CAAK,YAAY,CAAC,CAAA;AACrD,IAAA,OAAO,IAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA,EAKQ,WAAA,GAAoB;AAC1B,IAAA,IAAI,IAAA,CAAK,MAAA,CAAO,MAAA,IAAU,CAAA,EAAG;AAC3B,MAAA,MAAM,IAAI,eAAA,CAAgB,4BAAA,EAA8B,IAAA,CAAK,MAAM,CAAA;AAAA,IACrE;AAEA,IAAA,IAAI,IAAA,CAAK,MAAA,CAAO,MAAA,KAAW,CAAA,EAAG;AAE5B,MAAA,MAAM,aAAa,IAAA,CAAK,gBAAA,CAAiB,OAAO,IAAA,CAAK,MAAA,CAAO,CAAC,CAAC,CAAA;AAC9D,MAAA,IAAA,CAAK,GAAA,CAAI,QAAA,GAAW,UAAA,CAAW,IAAA,CAAK,GAAG,CAAA;AAAA,IACzC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUQ,kBACN,IAAA,EACqB;AACrB,IAAA,OAAO,OAAO,IAAA,GAAY,EAAC,KAAM;AAC/B,MAAA,IAAI,GAAA;AAEJ,MAAA,IAAI,KAAK,SAAA,EAAW;AAClB,QAAA,GAAA,GAAM,IAAI,IAAI,iBAAA,CAAkB,IAAA,CAAK,MAAM,IAAI,CAAA,EAAG,KAAK,GAAG,CAAA;AAAA,MAC5D,CAAA,MAAO;AACL,QAAA,GAAA,GAAM,IAAI,GAAA,CAAI,IAAA,CAAK,IAAA,EAAM,KAAK,GAAG,CAAA;AAAA,MACnC;AAEA,MAAA,MAAM,CAAA,GAAI,MAAM,IAAA,CAAK,kBAAA,CAAmB,GAAG,CAAA;AAC3C,MAAA,OAAO,IAAA,CAAK,eAAe,CAAC,CAAA;AAAA,IAC9B,CAAA;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASQ,aAAa,IAAA,EAAgB;AACnC,IAAA,IAAI,CAAC,KAAK,MAAA,EAAQ;AAChB,MAAA,OAAO,IAAA;AAAA,IACT;AACA,IAAA,MAAA,CAAO,KAAK,IAAA,CAAK,MAAM,CAAA,CAAE,OAAA,CAAQ,CAAC,GAAA,KAAQ;AACxC,MAAA,MAAM,CAAA,GAAI,IAAA,CAAK,MAAA,CAAO,GAAG,CAAA;AACzB,MAAA,IAAI,QAAA,GAAW,KAAA;AAEf,MAAA,IAAI,OAAO,IAAA,CAAK,GAAG,CAAA,KAAM,WAAA,EAAa;AACpC,QAAA,IAAA,CAAK,CAAA,EAAG,GAAG,CAAA,KAAA,CAAO,CAAA,GAAI,KAAK,GAAG,CAAA;AAC9B,QAAA,QAAA,GAAW,IAAA;AAAA,MACb;AASA,MAAA,IAAI,QAAA,IAAY,QAAA,CAAS,OAAA,CAAQ,GAAG,KAAK,CAAA,EAAG;AAC1C,QAAA,MAAM,MAAA,GAAS,IAAA,CAAK,YAAA,CAAa,IAAA,CAAK,GAAG,CAAC,CAAA;AAI1C,QAAA,IAAA,CAAK,GAAG,IAAI,YAAY,MAAA;AAAA,MAC1B,CAAA,MAAO;AACL,QAAA,IAAA,CAAK,GAAG,CAAA,GAAI,IAAA,CAAK,iBAAA,CAAkB,CAA4B,CAAA;AAAA,MACjE;AAAA,IACF,CAAC,CAAA;AACD,IAAA,OAAO,IAAA;AAAA,EACT;AAAA,EAEA,MAAc,mBAAmB,UAAA,EAAiB;AAChD,IAAA,MAAM,GAAA,GAAM,IAAI,GAAA,CAAI,UAAU,CAAA;AAI9B,IAAA,GAAA,CAAI,QAAA,GAAW,KAAK,GAAA,CAAI,QAAA;AACxB,IAAA,GAAA,CAAI,IAAA,GAAO,KAAK,GAAA,CAAI,IAAA;AAEpB,IAAA,OAAO,IAAA,CAAK,UAAA,CACT,GAAA,CAAI,GAAA,CAAI,UAAU,CAAA,CAClB,IAAA,CAAK,CAAC,aAAa,QAAA,CAAS,IAAI,CAAA,CAChC,KAAA,CAAM,KAAK,mBAAmB,CAAA;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,eAAe,IAAA,EAAW;AAChC,IAAA,IAAI,IAAA,CAAK,SAAA,IAAa,IAAA,CAAK,SAAA,CAAU,OAAA,EAAS;AAC5C,MAAA,OAAO,IAAA,CAAK,kBAAkB,IAAI,CAAA;AAAA,IACpC;AACA,IAAA,OAAO,IAAA,CAAK,aAAa,IAAI,CAAA;AAAA,EAC/B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,kBAAkB,IAAA,EAAgB;AACxC,IAAA,KAAA,IAAS,CAAA,GAAI,GAAG,CAAA,GAAI,IAAA,CAAK,UAAU,OAAA,CAAQ,MAAA,EAAQ,KAAK,CAAA,EAAG;AACzD,MAAA,IAAA,CAAK,SAAA,CAAU,OAAA,CAAQ,CAAC,CAAA,GAAI,IAAA,CAAK,aAAa,IAAA,CAAK,SAAA,CAAU,OAAA,CAAQ,CAAC,CAAC,CAAA;AAAA,IACzE;AACA,IAAA,OAAO;AAAA,MACL,OAAA,EAAS,KAAK,SAAA,CAAU,OAAA;AAAA,MACxB,MAAM,YAAY;AAChB,QAAA,MAAM,CAAA,GAAI,MAAM,IAAA,CAAK,kBAAA;AAAA,UACnB,IAAI,GAAA,CAAI,IAAA,CAAK,OAAO,IAAA,CAAK,IAAA,EAAM,KAAK,GAAG;AAAA,SACzC;AACA,QAAA,OAAO,IAAA,CAAK,kBAAkB,CAAC,CAAA;AAAA,MACjC,CAAA;AAAA,MACA,MAAM,YAAY;AAChB,QAAA,MAAM,CAAA,GAAI,MAAM,IAAA,CAAK,kBAAA;AAAA,UACnB,IAAI,GAAA,CAAI,IAAA,CAAK,OAAO,IAAA,CAAK,IAAA,EAAM,KAAK,GAAG;AAAA,SACzC;AACA,QAAA,OAAO,IAAA,CAAK,kBAAkB,CAAC,CAAA;AAAA,MACjC;AAAA,KACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAc,oBAAoB,KAAA,EAAoC;AACpE,IAAA,IAAI,KAAA,CAAM,QAAA,IAAY,KAAA,CAAM,QAAA,CAAS,MAAA,EAAQ;AAC3C,MAAA,QAAQ,KAAA,CAAM,SAAS,MAAA;AAAQ,QAC7B,KAAK,GAAA;AACH,UAAA,OAAO,OAAA,CAAQ,MAAA;AAAA,YACb,IAAI,aAAA;AAAA,cACF,KAAA,CAAM,SAAS,UAAA,IAAc,WAAA;AAAA,cAC7B,MAAM,QAAA,CAAS;AAAA;AACjB,WACF;AAAA,QACF;AACE,UAAA,OAAO,OAAA,CAAQ,MAAA;AAAA,YACb,IAAI,YAAA;AAAA,cACF,KAAA,CAAM,SAAS,UAAA,IAAc,SAAA;AAAA,cAC7B,MAAM,QAAA,CAAS;AAAA;AACjB,WACF;AAAA;AACJ,IACF,CAAA,MAAO;AACL,MAAA,OAAO,QAAQ,MAAA,CAAO,IAAI,KAAA,CAAM,KAAA,CAAM,OAAO,CAAC,CAAA;AAAA,IAChD;AAAA,EACF;AACF;;;;"}

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

@@ -0,0 +1,48 @@
+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 ClaimableBalanceCallBuilder} pointed to server defined by serverUrl.
+ *
+ * Do not create this object directly, use {@link Gateway.Server.claimableBalances}.
+ *
+ * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/claimablebalances | Claimable Balances}
+ *
+ * @param serverUrl - Gateway server URL.
+ */
+export declare class ClaimableBalanceCallBuilder extends CallBuilder<ServerApi.CollectionPage<ServerApi.ClaimableBalanceRecord>> {
+    constructor(serverUrl: URL, httpClient: HttpClient);
+    /**
+     * The claimable balance details endpoint provides information on a single claimable balance.
+     *
+     * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-a-claimable-balance | Claimable Balance Details}
+     * @param claimableBalanceId - Claimable balance ID
+     * @returns `CallBuilder<ServerApi.ClaimableBalanceRecord>` OperationCallBuilder instance
+     */
+    claimableBalance(claimableBalanceId: string): CallBuilder<ServerApi.ClaimableBalanceRecord>;
+    /**
+     * Returns all claimable balances which are sponsored by the given account ID.
+     *
+     * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/list-all-claimable-balances | Claimable Balances}
+     * @param sponsor - For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
+     * @returns current ClaimableBalanceCallBuilder instance
+     */
+    sponsor(sponsor: string): this;
+    /**
+     * Returns all claimable balances which can be claimed by the given account ID.
+     *
+     * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/list-all-claimable-balances | Claimable Balances}
+     * @param claimant - For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
+     * @returns current ClaimableBalanceCallBuilder instance
+     */
+    claimant(claimant: string): this;
+    /**
+     * Returns all claimable balances which provide a balance for the given asset.
+     *
+     * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/list-all-claimable-balances | Claimable Balances}
+     * @param asset - The Asset held by the claimable balance
+     * @returns current ClaimableBalanceCallBuilder instance
+     */
+    asset(asset: Asset): this;
+}

package/lib/esm/gateway/claimable_balances_call_builder.js

@@ -0,0 +1,59 @@
+import { CallBuilder } from './call_builder.js';
+
+class ClaimableBalanceCallBuilder extends CallBuilder {
+  constructor(serverUrl, httpClient) {
+    super(serverUrl, httpClient);
+    this.setPath("claimable_balances");
+  }
+  /**
+   * The claimable balance details endpoint provides information on a single claimable balance.
+   *
+   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-a-claimable-balance | Claimable Balance Details}
+   * @param claimableBalanceId - Claimable balance ID
+   * @returns `CallBuilder<ServerApi.ClaimableBalanceRecord>` OperationCallBuilder instance
+   */
+  claimableBalance(claimableBalanceId) {
+    const builder = new CallBuilder(
+      new URL(this.url),
+      this.httpClient
+    );
+    builder.filter.push([claimableBalanceId]);
+    return builder;
+  }
+  /**
+   * Returns all claimable balances which are sponsored by the given account ID.
+   *
+   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/list-all-claimable-balances | Claimable Balances}
+   * @param sponsor - For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
+   * @returns current ClaimableBalanceCallBuilder instance
+   */
+  sponsor(sponsor) {
+    this.url.searchParams.set("sponsor", sponsor);
+    return this;
+  }
+  /**
+   * Returns all claimable balances which can be claimed by the given account ID.
+   *
+   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/list-all-claimable-balances | Claimable Balances}
+   * @param claimant - For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
+   * @returns current ClaimableBalanceCallBuilder instance
+   */
+  claimant(claimant) {
+    this.url.searchParams.set("claimant", claimant);
+    return this;
+  }
+  /**
+   * Returns all claimable balances which provide a balance for the given asset.
+   *
+   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/list-all-claimable-balances | Claimable Balances}
+   * @param asset - The Asset held by the claimable balance
+   * @returns current ClaimableBalanceCallBuilder instance
+   */
+  asset(asset) {
+    this.url.searchParams.set("asset", asset.toString());
+    return this;
+  }
+}
+
+export { ClaimableBalanceCallBuilder };
+//# sourceMappingURL=claimable_balances_call_builder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"claimable_balances_call_builder.js","sources":["../../../src/gateway/claimable_balances_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 ClaimableBalanceCallBuilder} pointed to server defined by serverUrl.\n *\n * Do not create this object directly, use {@link Gateway.Server.claimableBalances}.\n *\n * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/claimablebalances | Claimable Balances}\n *\n * @param serverUrl - Gateway server URL.\n */\nexport class ClaimableBalanceCallBuilder extends CallBuilder<\n  ServerApi.CollectionPage<ServerApi.ClaimableBalanceRecord>\n> {\n  constructor(serverUrl: URL, httpClient: HttpClient) {\n    super(serverUrl, httpClient);\n    this.setPath(\"claimable_balances\");\n  }\n\n  /**\n   * The claimable balance details endpoint provides information on a single claimable balance.\n   *\n   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-a-claimable-balance | Claimable Balance Details}\n   * @param claimableBalanceId - Claimable balance ID\n   * @returns `CallBuilder<ServerApi.ClaimableBalanceRecord>` OperationCallBuilder instance\n   */\n  public claimableBalance(\n    claimableBalanceId: string,\n  ): CallBuilder<ServerApi.ClaimableBalanceRecord> {\n    const builder = new CallBuilder<ServerApi.ClaimableBalanceRecord>(\n      new URL(this.url),\n      this.httpClient,\n    );\n    builder.filter.push([claimableBalanceId]);\n    return builder;\n  }\n\n  /**\n   * Returns all claimable balances which are sponsored by the given account ID.\n   *\n   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/list-all-claimable-balances | Claimable Balances}\n   * @param sponsor - For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`\n   * @returns current ClaimableBalanceCallBuilder instance\n   */\n  public sponsor(sponsor: string): this {\n    this.url.searchParams.set(\"sponsor\", sponsor);\n    return this;\n  }\n\n  /**\n   * Returns all claimable balances which can be claimed by the given account ID.\n   *\n   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/list-all-claimable-balances | Claimable Balances}\n   * @param claimant - For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`\n   * @returns current ClaimableBalanceCallBuilder instance\n   */\n  public claimant(claimant: string): this {\n    this.url.searchParams.set(\"claimant\", claimant);\n    return this;\n  }\n\n  /**\n   * Returns all claimable balances which provide a balance for the given asset.\n   *\n   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/list-all-claimable-balances | Claimable Balances}\n   * @param asset - The Asset held by the claimable balance\n   * @returns current ClaimableBalanceCallBuilder instance\n   */\n  public asset(asset: Asset): this {\n    this.url.searchParams.set(\"asset\", asset.toString());\n    return this;\n  }\n}\n"],"names":[],"mappings":";;AAcO,MAAM,oCAAoC,WAAA,CAE/C;AAAA,EACA,WAAA,CAAY,WAAgB,UAAA,EAAwB;AAClD,IAAA,KAAA,CAAM,WAAW,UAAU,CAAA;AAC3B,IAAA,IAAA,CAAK,QAAQ,oBAAoB,CAAA;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASO,iBACL,kBAAA,EAC+C;AAC/C,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,kBAAkB,CAAC,CAAA;AACxC,IAAA,OAAO,OAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASO,QAAQ,OAAA,EAAuB;AACpC,IAAA,IAAA,CAAK,GAAA,CAAI,YAAA,CAAa,GAAA,CAAI,SAAA,EAAW,OAAO,CAAA;AAC5C,IAAA,OAAO,IAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASO,SAAS,QAAA,EAAwB;AACtC,IAAA,IAAA,CAAK,GAAA,CAAI,YAAA,CAAa,GAAA,CAAI,UAAA,EAAY,QAAQ,CAAA;AAC9C,IAAA,OAAO,IAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASO,MAAM,KAAA,EAAoB;AAC/B,IAAA,IAAA,CAAK,IAAI,YAAA,CAAa,GAAA,CAAI,OAAA,EAAS,KAAA,CAAM,UAAU,CAAA;AACnD,IAAA,OAAO,IAAA;AAAA,EACT;AACF;;;;"}

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

@@ -0,0 +1,51 @@
+import { CallBuilder } from "./call_builder.js";
+import { ServerApi } from "./server_api.js";
+import type { HttpClient } from "../http-client/index.js";
+/**
+ * Creates a new {@link EffectCallBuilder} pointed to server defined by serverUrl.
+ * Do not create this object directly, use {@link Gateway.Server.effects}.
+ *
+ * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/effects | All Effects}
+ *
+ * @param serverUrl - Gateway server URL.
+ */
+export declare class EffectCallBuilder extends CallBuilder<ServerApi.CollectionPage<ServerApi.EffectRecord>> {
+    constructor(serverUrl: URL, httpClient: HttpClient);
+    /**
+     * This endpoint represents all effects that changed a given account. It will return relevant effects from the creation of the account to the current ledger.
+     * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/get-effects-by-account-id | Effects for Account}
+     * @param accountId - For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
+     * @returns this EffectCallBuilder instance
+     */
+    forAccount(accountId: string): this;
+    /**
+     * Effects are the specific ways that the ledger was changed by any operation.
+     *
+     * This endpoint represents all effects that occurred in the given ledger.
+     * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-a-ledgers-effects | Effects for Ledger}
+     * @param sequence - Ledger sequence
+     * @returns this EffectCallBuilder instance
+     */
+    forLedger(sequence: number | string): this;
+    /**
+     * This endpoint represents all effects that occurred as a result of a given transaction.
+     * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-a-transactions-effects | Effects for Transaction}
+     * @param transactionId - Transaction ID
+     * @returns this EffectCallBuilder instance
+     */
+    forTransaction(transactionId: string): this;
+    /**
+     * This endpoint represents all effects that occurred as a result of a given operation.
+     * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-an-operations-effects | Effects for Operation}
+     * @param operationId - Operation ID
+     * @returns this EffectCallBuilder instance
+     */
+    forOperation(operationId: string): this;
+    /**
+     * This endpoint represents all effects involving a particular liquidity pool.
+     *
+     * @param poolId - liquidity pool ID
+     * @returns this EffectCallBuilder instance
+     */
+    forLiquidityPool(poolId: string): this;
+}

package/lib/esm/gateway/effect_call_builder.js

@@ -0,0 +1,58 @@
+import { CallBuilder } from './call_builder.js';
+
+class EffectCallBuilder extends CallBuilder {
+  constructor(serverUrl, httpClient) {
+    super(serverUrl, httpClient, "effects");
+    this.setPath("effects");
+  }
+  /**
+   * This endpoint represents all effects that changed a given account. It will return relevant effects from the creation of the account to the current ledger.
+   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/get-effects-by-account-id | Effects for Account}
+   * @param accountId - For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
+   * @returns this EffectCallBuilder instance
+   */
+  forAccount(accountId) {
+    return this.forEndpoint("accounts", accountId);
+  }
+  /**
+   * Effects are the specific ways that the ledger was changed by any operation.
+   *
+   * This endpoint represents all effects that occurred in the given ledger.
+   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-a-ledgers-effects | Effects for Ledger}
+   * @param sequence - Ledger sequence
+   * @returns this EffectCallBuilder instance
+   */
+  forLedger(sequence) {
+    return this.forEndpoint("ledgers", sequence.toString());
+  }
+  /**
+   * This endpoint represents all effects that occurred as a result of a given transaction.
+   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-a-transactions-effects | Effects for Transaction}
+   * @param transactionId - Transaction ID
+   * @returns this EffectCallBuilder instance
+   */
+  forTransaction(transactionId) {
+    return this.forEndpoint("transactions", transactionId);
+  }
+  /**
+   * This endpoint represents all effects that occurred as a result of a given operation.
+   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-an-operations-effects | Effects for Operation}
+   * @param operationId - Operation ID
+   * @returns this EffectCallBuilder instance
+   */
+  forOperation(operationId) {
+    return this.forEndpoint("operations", operationId);
+  }
+  /**
+   * This endpoint represents all effects involving a particular liquidity pool.
+   *
+   * @param poolId - liquidity pool ID
+   * @returns this EffectCallBuilder instance
+   */
+  forLiquidityPool(poolId) {
+    return this.forEndpoint("liquidity_pools", poolId);
+  }
+}
+
+export { EffectCallBuilder };
+//# sourceMappingURL=effect_call_builder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"effect_call_builder.js","sources":["../../../src/gateway/effect_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 EffectCallBuilder} pointed to server defined by serverUrl.\n * Do not create this object directly, use {@link Gateway.Server.effects}.\n *\n * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/effects | All Effects}\n *\n * @param serverUrl - Gateway server URL.\n */\nexport class EffectCallBuilder extends CallBuilder<\n  ServerApi.CollectionPage<ServerApi.EffectRecord>\n> {\n  constructor(serverUrl: URL, httpClient: HttpClient) {\n    super(serverUrl, httpClient, \"effects\");\n    this.setPath(\"effects\");\n  }\n\n  /**\n   * This endpoint represents all effects that changed a given account. It will return relevant effects from the creation of the account to the current ledger.\n   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/get-effects-by-account-id | Effects for Account}\n   * @param accountId - For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`\n   * @returns this EffectCallBuilder instance\n   */\n  public forAccount(accountId: string): this {\n    return this.forEndpoint(\"accounts\", accountId);\n  }\n\n  /**\n   * Effects are the specific ways that the ledger was changed by any operation.\n   *\n   * This endpoint represents all effects that occurred in the given ledger.\n   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-a-ledgers-effects | Effects for Ledger}\n   * @param sequence - Ledger sequence\n   * @returns this EffectCallBuilder instance\n   */\n  public forLedger(sequence: number | string): this {\n    return this.forEndpoint(\"ledgers\", sequence.toString());\n  }\n\n  /**\n   * This endpoint represents all effects that occurred as a result of a given transaction.\n   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-a-transactions-effects | Effects for Transaction}\n   * @param transactionId - Transaction ID\n   * @returns this EffectCallBuilder instance\n   */\n  public forTransaction(transactionId: string): this {\n    return this.forEndpoint(\"transactions\", transactionId);\n  }\n\n  /**\n   * This endpoint represents all effects that occurred as a result of a given operation.\n   * @see {@link https://docs.digitalworld.global/docs/data/horizon/api-reference/resources/retrieve-an-operations-effects | Effects for Operation}\n   * @param operationId - Operation ID\n   * @returns this EffectCallBuilder instance\n   */\n  public forOperation(operationId: string): this {\n    return this.forEndpoint(\"operations\", operationId);\n  }\n\n  /**\n   * This endpoint represents all effects involving a particular liquidity pool.\n   *\n   * @param poolId - liquidity pool ID\n   * @returns this EffectCallBuilder instance\n   */\n  public forLiquidityPool(poolId: string): this {\n    return this.forEndpoint(\"liquidity_pools\", poolId);\n  }\n}\n"],"names":[],"mappings":";;AAYO,MAAM,0BAA0B,WAAA,CAErC;AAAA,EACA,WAAA,CAAY,WAAgB,UAAA,EAAwB;AAClD,IAAA,KAAA,CAAM,SAAA,EAAW,YAAY,SAAS,CAAA;AACtC,IAAA,IAAA,CAAK,QAAQ,SAAS,CAAA;AAAA,EACxB;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;AAAA;AAAA,EAUO,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,eAAe,aAAA,EAA6B;AACjD,IAAA,OAAO,IAAA,CAAK,WAAA,CAAY,cAAA,EAAgB,aAAa,CAAA;AAAA,EACvD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,aAAa,WAAA,EAA2B;AAC7C,IAAA,OAAO,IAAA,CAAK,WAAA,CAAY,YAAA,EAAc,WAAW,CAAA;AAAA,EACnD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,iBAAiB,MAAA,EAAsB;AAC5C,IAAA,OAAO,IAAA,CAAK,WAAA,CAAY,iBAAA,EAAmB,MAAM,CAAA;AAAA,EACnD;AACF;;;;"}

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

@@ -0,0 +1,5 @@
+import { CallBuilder } from "./call_builder.js";
+import type { HttpClient } from "../http-client/index.js";
+export declare class Faucet extends CallBuilder<any> {
+    constructor(serverUrl: URL, httpClient: HttpClient, address: string);
+}

package/lib/esm/gateway/faucet.js

@@ -0,0 +1,12 @@
+import { CallBuilder } from './call_builder.js';
+
+class Faucet extends CallBuilder {
+  constructor(serverUrl, httpClient, address) {
+    super(serverUrl, httpClient);
+    this.setPath("faucet");
+    this.url.searchParams.set("addr", address);
+  }
+}
+
+export { Faucet };
+//# sourceMappingURL=faucet.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"faucet.js","sources":["../../../src/gateway/faucet.ts"],"sourcesContent":["import { CallBuilder } from \"./call_builder.js\";\nimport type { HttpClient } from \"../http-client/index.js\";\n\nexport class Faucet extends CallBuilder<any> {\n  constructor(serverUrl: URL, httpClient: HttpClient, address: string) {\n    super(serverUrl, httpClient);\n    this.setPath(\"faucet\");\n    this.url.searchParams.set(\"addr\", address);\n  }\n}\n"],"names":[],"mappings":";;AAGO,MAAM,eAAe,WAAA,CAAiB;AAAA,EAC3C,WAAA,CAAY,SAAA,EAAgB,UAAA,EAAwB,OAAA,EAAiB;AACnE,IAAA,KAAA,CAAM,WAAW,UAAU,CAAA;AAC3B,IAAA,IAAA,CAAK,QAAQ,QAAQ,CAAA;AACrB,IAAA,IAAA,CAAK,GAAA,CAAI,YAAA,CAAa,GAAA,CAAI,MAAA,EAAQ,OAAO,CAAA;AAAA,EAC3C;AACF;;;;"}