@stellar/stellar-sdk 11.0.0

package/lib/horizon/account_call_builder.js

@@ -0,0 +1,64 @@
+"use strict";
+
+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); }
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.AccountCallBuilder = void 0;
+var _call_builder = require("./call_builder");
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); Object.defineProperty(subClass, "prototype", { writable: false }); if (superClass) _setPrototypeOf(subClass, superClass); }
+function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
+function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
+function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
+var AccountCallBuilder = exports.AccountCallBuilder = function (_CallBuilder) {
+  _inherits(AccountCallBuilder, _CallBuilder);
+  var _super = _createSuper(AccountCallBuilder);
+  function AccountCallBuilder(serverUrl) {
+    var _this;
+    _classCallCheck(this, AccountCallBuilder);
+    _this = _super.call(this, serverUrl);
+    _this.url.segment("accounts");
+    return _this;
+  }
+  _createClass(AccountCallBuilder, [{
+    key: "accountId",
+    value: function accountId(id) {
+      var builder = new _call_builder.CallBuilder(this.url.clone());
+      builder.filter.push([id]);
+      return builder;
+    }
+  }, {
+    key: "forSigner",
+    value: function forSigner(id) {
+      this.url.setQuery("signer", id);
+      return this;
+    }
+  }, {
+    key: "forAsset",
+    value: function forAsset(asset) {
+      this.url.setQuery("asset", "".concat(asset));
+      return this;
+    }
+  }, {
+    key: "sponsor",
+    value: function sponsor(id) {
+      this.url.setQuery("sponsor", id);
+      return this;
+    }
+  }, {
+    key: "forLiquidityPool",
+    value: function forLiquidityPool(id) {
+      this.url.setQuery("liquidity_pool", id);
+      return this;
+    }
+  }]);
+  return AccountCallBuilder;
+}(_call_builder.CallBuilder);

package/lib/horizon/account_response.d.ts

@@ -0,0 +1,58 @@
+import { HorizonApi } from "./horizon_api";
+import { ServerApi } from "./server_api";
+/**
+ * Do not create this object directly, use {@link Server#loadAccount}.
+ *
+ * Returns information and links relating to a single account.
+ * The balances section in the returned JSON will also list all the trust lines this account has set up.
+ * It also contains {@link Account} object and exposes it's methods so can be used in {@link TransactionBuilder}.
+ *
+ * @see [Account Details](https://developers.stellar.org/api/resources/accounts/object/)
+ * @param {string} response Response from horizon account endpoint.
+ * @returns {AccountResponse} AccountResponse instance
+ */
+export declare class AccountResponse {
+    readonly id: string;
+    readonly paging_token: string;
+    readonly account_id: string;
+    sequence: string;
+    readonly sequence_ledger?: number;
+    readonly sequence_time?: string;
+    readonly subentry_count: number;
+    readonly home_domain?: string;
+    readonly inflation_destination?: string;
+    readonly last_modified_ledger: number;
+    readonly last_modified_time: string;
+    readonly thresholds: HorizonApi.AccountThresholds;
+    readonly flags: HorizonApi.Flags;
+    readonly balances: HorizonApi.BalanceLine[];
+    readonly signers: ServerApi.AccountRecordSigners[];
+    readonly data: (options: {
+        value: string;
+    }) => Promise<{
+        value: string;
+    }>;
+    readonly data_attr: Record<string, string>;
+    readonly effects: ServerApi.CallCollectionFunction<ServerApi.EffectRecord>;
+    readonly offers: ServerApi.CallCollectionFunction<ServerApi.OfferRecord>;
+    readonly operations: ServerApi.CallCollectionFunction<ServerApi.OperationRecord>;
+    readonly payments: ServerApi.CallCollectionFunction<ServerApi.PaymentOperationRecord>;
+    readonly trades: ServerApi.CallCollectionFunction<ServerApi.TradeRecord>;
+    private readonly _baseAccount;
+    constructor(response: ServerApi.AccountRecord);
+    /**
+     * Get Stellar account public key ex. `GB3KJPLFUYN5VL6R3GU3EGCGVCKFDSD7BEDX42HWG5BWFKB3KQGJJRMA`
+     * @returns {string} accountId
+     */
+    accountId(): string;
+    /**
+     * Get the current sequence number
+     * @returns {string} sequenceNumber
+     */
+    sequenceNumber(): string;
+    /**
+     * Increments sequence number in this object by one.
+     * @returns {void}
+     */
+    incrementSequenceNumber(): void;
+}

package/lib/horizon/account_response.js

@@ -0,0 +1,50 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.AccountResponse = void 0;
+var _stellarBase = require("@stellar/stellar-base");
+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); }
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t.return && (u = t.return(), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+var AccountResponse = exports.AccountResponse = function () {
+  function AccountResponse(response) {
+    var _this = this;
+    _classCallCheck(this, AccountResponse);
+    this._baseAccount = new _stellarBase.Account(response.account_id, response.sequence);
+    Object.entries(response).forEach(function (_ref) {
+      var _ref2 = _slicedToArray(_ref, 2),
+        key = _ref2[0],
+        value = _ref2[1];
+      _this[key] = value;
+    });
+  }
+  _createClass(AccountResponse, [{
+    key: "accountId",
+    value: function accountId() {
+      return this._baseAccount.accountId();
+    }
+  }, {
+    key: "sequenceNumber",
+    value: function sequenceNumber() {
+      return this._baseAccount.sequenceNumber();
+    }
+  }, {
+    key: "incrementSequenceNumber",
+    value: function incrementSequenceNumber() {
+      this._baseAccount.incrementSequenceNumber();
+      this.sequence = this._baseAccount.sequenceNumber();
+    }
+  }]);
+  return AccountResponse;
+}();

package/lib/horizon/assets_call_builder.d.ts

@@ -0,0 +1,27 @@
+/// <reference types="urijs" />
+import { CallBuilder } from "./call_builder";
+import { ServerApi } from "./server_api";
+/**
+ * Creates a new {@link AssetsCallBuilder} pointed to server defined by serverUrl.
+ *
+ * Do not create this object directly, use {@link Server#assets}.
+ * @class AssetsCallBuilder
+ * @constructor
+ * @extends CallBuilder
+ * @param {string} serverUrl Horizon server URL.
+ */
+export declare class AssetsCallBuilder extends CallBuilder<ServerApi.CollectionPage<ServerApi.AssetRecord>> {
+    constructor(serverUrl: URI);
+    /**
+     * This endpoint filters all assets by the asset code.
+     * @param {string} value For example: `USD`
+     * @returns {AssetsCallBuilder} current AssetCallBuilder instance
+     */
+    forCode(value: string): AssetsCallBuilder;
+    /**
+     * This endpoint filters all assets by the asset issuer.
+     * @param {string} value For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
+     * @returns {AssetsCallBuilder} current AssetCallBuilder instance
+     */
+    forIssuer(value: string): AssetsCallBuilder;
+}

package/lib/horizon/assets_call_builder.js

@@ -0,0 +1,45 @@
+"use strict";
+
+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); }
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.AssetsCallBuilder = void 0;
+var _call_builder = require("./call_builder");
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); Object.defineProperty(subClass, "prototype", { writable: false }); if (superClass) _setPrototypeOf(subClass, superClass); }
+function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
+function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
+function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
+var AssetsCallBuilder = exports.AssetsCallBuilder = function (_CallBuilder) {
+  _inherits(AssetsCallBuilder, _CallBuilder);
+  var _super = _createSuper(AssetsCallBuilder);
+  function AssetsCallBuilder(serverUrl) {
+    var _this;
+    _classCallCheck(this, AssetsCallBuilder);
+    _this = _super.call(this, serverUrl);
+    _this.url.segment("assets");
+    return _this;
+  }
+  _createClass(AssetsCallBuilder, [{
+    key: "forCode",
+    value: function forCode(value) {
+      this.url.setQuery("asset_code", value);
+      return this;
+    }
+  }, {
+    key: "forIssuer",
+    value: function forIssuer(value) {
+      this.url.setQuery("asset_issuer", value);
+      return this;
+    }
+  }]);
+  return AssetsCallBuilder;
+}(_call_builder.CallBuilder);

package/lib/horizon/call_builder.d.ts

@@ -0,0 +1,128 @@
+import URI from "urijs";
+import { HorizonApi } from "./horizon_api";
+import { ServerApi } from "./server_api";
+export interface EventSourceOptions<T> {
+    onmessage?: (value: T) => void;
+    onerror?: (event: MessageEvent) => void;
+    reconnectTimeout?: number;
+}
+/**
+ * Creates a new {@link CallBuilder} pointed to server defined by serverUrl.
+ *
+ * This is an **abstract** class. Do not create this object directly, use {@link Server} class.
+ * @param {string} serverUrl URL of Horizon server
+ * @class CallBuilder
+ */
+export declare class CallBuilder<T extends HorizonApi.FeeStatsResponse | HorizonApi.BaseResponse | ServerApi.CollectionPage<HorizonApi.BaseResponse>> {
+    protected url: URI;
+    filter: string[][];
+    protected originalSegments: string[];
+    protected neighborRoot: string;
+    constructor(serverUrl: URI, neighborRoot?: string);
+    /**
+     * Triggers a HTTP request using this builder's current configuration.
+     * @returns {Promise} a Promise that resolves to the server's response.
+     */
+    call(): Promise<T>;
+    /**
+     * Creates an EventSource that listens for incoming messages from the server. To stop listening for new
+     * events call the function returned by this method.
+     * @see [Horizon Response Format](https://developers.stellar.org/api/introduction/response-format/)
+     * @see [MDN EventSource](https://developer.mozilla.org/en-US/docs/Web/API/EventSource)
+     * @param {object} [options] EventSource options.
+     * @param {function} [options.onmessage] Callback function to handle incoming messages.
+     * @param {function} [options.onerror] Callback function to handle errors.
+     * @param {number} [options.reconnectTimeout] Custom stream connection timeout in ms, default is 15 seconds.
+     * @returns {function} Close function. Run to close the connection and stop listening for new events.
+     */
+    stream(options?: EventSourceOptions<T>): () => void;
+    /**
+     * Sets `cursor` parameter for the current call. Returns the CallBuilder object on which this method has been called.
+     * @see [Paging](https://developers.stellar.org/api/introduction/pagination/)
+     * @param {string} cursor A cursor is a value that points to a specific location in a collection of resources.
+     * @returns {object} current CallBuilder instance
+     */
+    cursor(cursor: string): this;
+    /**
+     * Sets `limit` parameter for the current call. Returns the CallBuilder object on which this method has been called.
+     * @see [Paging](https://developers.stellar.org/api/introduction/pagination/)
+     * @param {number} number Number of records the server should return.
+     * @returns {object} current CallBuilder instance
+     */
+    limit(recordsNumber: number): this;
+    /**
+     * Sets `order` parameter for the current call. Returns the CallBuilder object on which this method has been called.
+     * @param {"asc"|"desc"} direction Sort direction
+     * @returns {object} current CallBuilder instance
+     */
+    order(direction: "asc" | "desc"): this;
+    /**
+     * Sets `join` parameter for the current call. The `join` parameter
+     * includes the requested resource in the response. Currently, the
+     * only valid value for the parameter is `transactions` and is only
+     * supported on the operations and payments endpoints. The response
+     * will include a `transaction` field for each operation in the
+     * response.
+     *
+     * @param {"transactions"} join Records to be included in the response.
+     * @returns {object} current CallBuilder instance.
+     */
+    join(include: "transactions"): this;
+    /**
+     * A helper method to craft queries to "neighbor" endpoints.
+     *
+     *  For example, we have an `/effects` suffix endpoint on many different
+     *  "root" endpoints, such as `/transactions/:id` and `/accounts/:id`. So,
+     *  it's helpful to be able to conveniently create queries to the
+     *  `/accounts/:id/effects` endpoint:
+     *
+     *    this.forEndpoint("accounts", accountId)`.
+     *
+     * @param  {string} endpoint neighbor endpoint in question, like /operations
+     * @param  {string} param    filter parameter, like an operation ID
+     *
+     * @returns {CallBuilder} this CallBuilder instance
+     */
+    protected forEndpoint(endpoint: string, param: string): this;
+    /**
+     * @private
+     * @returns {void}
+     */
+    private checkFilter;
+    /**
+     * Convert a link object to a function that fetches that link.
+     * @private
+     * @param {object} link A link object
+     * @param {bool} link.href the URI of the link
+     * @param {bool} [link.templated] Whether the link is templated
+     * @returns {function} A function that requests the link
+     */
+    private _requestFnForLink;
+    /**
+     * Given the json response, find and convert each link into a function that
+     * calls that link.
+     * @private
+     * @param {object} json JSON response
+     * @returns {object} JSON response with string links replaced with functions
+     */
+    private _parseRecord;
+    private _sendNormalRequest;
+    /**
+     * @private
+     * @param {object} json Response object
+     * @returns {object} Extended response
+     */
+    private _parseResponse;
+    /**
+     * @private
+     * @param {object} json Response object
+     * @returns {object} Extended response object
+     */
+    private _toCollectionPage;
+    /**
+     * @private
+     * @param {object} error Network error object
+     * @returns {Promise<Error>} Promise that rejects with a human-readable error
+     */
+    private _handleNetworkError;
+}