@stellar/stellar-sdk 14.3.3 → 14.4.1

package/lib/rpc/api.d.ts

@@ -1,6 +1,9 @@
 import { Contract, SorobanDataBuilder, xdr } from "@stellar/stellar-base";
 export declare namespace Api {
     export interface GetHealthResponse {
+        latestLedger: number;
+        ledgerRetentionWindow: number;
+        oldestLedger: number;
         status: "healthy";
     }
     export interface LedgerEntryResult {
@@ -218,7 +221,7 @@ export declare namespace Api {
     export type GetEventsRequest = {
         filters: Api.EventFilter[];
         startLedger: number;
-        endLedger: number;
+        endLedger?: number;
         cursor?: never;
         limit?: number;
     } | {
@@ -253,7 +256,7 @@ export declare namespace Api {
     }
     export interface RawEventResponse extends BaseEventResponse {
         contractId: string;
-        topic: string[];
+        topic?: string[];
         value: string;
     }
     interface RawLedgerEntryChange {
@@ -303,7 +306,7 @@ export declare namespace Api {
     }
     export type SimulationAuthMode = "enforce" | "record" | "record_allow_nonroot";
     /**
-     * Simplifies {@link Api.RawSimulateTransactionResponse} into separate interfaces
+     * Simplifies {@link RawSimulateTransactionResponse} into separate interfaces
      * based on status:
      *   - on success, this includes all fields, though `result` is only present
      *     if an invocation was simulated (since otherwise there's nothing to
@@ -358,9 +361,29 @@ export declare namespace Api {
             transactionData: SorobanDataBuilder;
         };
     }
+    /**
+     * Checks if a simulation response indicates an error.
+     * @param sim The simulation response to check.
+     * @returns True if the response indicates an error, false otherwise.
+     */
     export function isSimulationError(sim: SimulateTransactionResponse): sim is SimulateTransactionErrorResponse;
+    /**
+     * Checks if a simulation response indicates success.
+     * @param sim The simulation response to check.
+     * @returns True if the response indicates success, false otherwise.
+     */
     export function isSimulationSuccess(sim: SimulateTransactionResponse): sim is SimulateTransactionSuccessResponse;
+    /**
+     * Checks if a simulation response indicates that a restoration is needed.
+     * @param sim The simulation response to check.
+     * @returns True if the response indicates a restoration is needed, false otherwise.
+     */
     export function isSimulationRestore(sim: SimulateTransactionResponse): sim is SimulateTransactionRestoreResponse;
+    /**
+     * Checks if a simulation response is in raw (unparsed) form.
+     * @param sim The simulation response to check.
+     * @returns True if the response is raw, false otherwise.
+     */
     export function isSimulationRaw(sim: Api.SimulateTransactionResponse | Api.RawSimulateTransactionResponse): sim is Api.RawSimulateTransactionResponse;
     interface RawSimulateHostFunctionResult {
         auth?: string[];
@@ -427,10 +450,11 @@ export declare namespace Api {
         latestLedger: number;
         /** present only on success, otherwise request malformed or no balance */
         balanceEntry?: {
-            /** a 64-bit integer */
+            /** a 64-bit integer for trustlines, 128-bit value for contracts */
             amount: string;
             authorized: boolean;
             clawback: boolean;
+            revocable?: boolean;
             lastModifiedLedgerSeq?: number;
             liveUntilLedgerSeq?: number;
         };

package/lib/rpc/axios.js

@@ -12,7 +12,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
-var version = exports.version = "14.3.3";
+var version = exports.version = "14.4.1";
 function createHttpClient(headers) {
   return (0, _httpClient.create)({
     headers: _objectSpread(_objectSpread({}, headers), {}, {

package/lib/rpc/jsonrpc.d.ts

@@ -27,10 +27,11 @@ export interface Error<E = any> {
 /**
  * Sends the jsonrpc 'params' as a single 'param' object (no array support).
  *
+ * @param {HttpClient} client HttpClient instance to use for the request
  * @param {string} url URL to the RPC instance
  * @param {string} method RPC method name that should be called
  * @param {(any | null)} [param=null] params that should be supplied to the method
- * @returns {Promise<T>}
+ * @returns {Promise} Promise that resolves to the result of type T
  * @private
  */
 export declare function postObject<T>(client: HttpClient, url: string, method: string, param?: any): Promise<T>;

package/lib/rpc/jsonrpc.js

@@ -9,7 +9,7 @@ function _regeneratorDefine2(e, r, n, t) { var i = Object.defineProperty; try {
 function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
 function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
 function hasOwnProperty(obj, prop) {
-  return obj.hasOwnProperty(prop);
+  return Object.prototype.hasOwnProperty.call(obj, prop);
 }
 function postObject(_x, _x2, _x3) {
   return _postObject.apply(this, arguments);

package/lib/rpc/parsers.js

@@ -59,10 +59,12 @@ function parseTransactionInfo(raw) {
   switch (meta.switch()) {
     case 3:
     case 4:
-      var metaV = meta.value();
-      if (metaV.sorobanMeta() !== null) {
-        var _metaV$sorobanMeta$re, _metaV$sorobanMeta;
-        info.returnValue = (_metaV$sorobanMeta$re = (_metaV$sorobanMeta = metaV.sorobanMeta()) === null || _metaV$sorobanMeta === void 0 ? void 0 : _metaV$sorobanMeta.returnValue()) !== null && _metaV$sorobanMeta$re !== void 0 ? _metaV$sorobanMeta$re : undefined;
+      {
+        var metaV = meta.value();
+        if (metaV.sorobanMeta() !== null) {
+          var _metaV$sorobanMeta$re, _metaV$sorobanMeta;
+          info.returnValue = (_metaV$sorobanMeta$re = (_metaV$sorobanMeta = metaV.sorobanMeta()) === null || _metaV$sorobanMeta === void 0 ? void 0 : _metaV$sorobanMeta.returnValue()) !== null && _metaV$sorobanMeta$re !== void 0 ? _metaV$sorobanMeta$re : undefined;
+        }
       }
   }
   if (raw.diagnosticEventsXdr) {
@@ -87,12 +89,13 @@ function parseRawEvents(raw) {
     oldestLedgerCloseTime: raw.oldestLedgerCloseTime,
     cursor: raw.cursor,
     events: ((_raw$events3 = raw.events) !== null && _raw$events3 !== void 0 ? _raw$events3 : []).map(function (evt) {
+      var _evt$topic;
       var clone = _objectSpread({}, evt);
       delete clone.contractId;
       return _objectSpread(_objectSpread(_objectSpread({}, clone), evt.contractId !== "" && {
         contractId: new _stellarBase.Contract(evt.contractId)
       }), {}, {
-        topic: evt.topic.map(function (topic) {
+        topic: ((_evt$topic = evt.topic) !== null && _evt$topic !== void 0 ? _evt$topic : []).map(function (topic) {
           return _stellarBase.xdr.ScVal.fromXDR(topic, "base64");
         }),
         value: _stellarBase.xdr.ScVal.fromXDR(evt.value, "base64")

package/lib/rpc/server.d.ts

@@ -155,6 +155,7 @@ export declare class RpcServer {
      * @see
      * {@link https://developers.stellar.org/docs/data/rpc/api-reference/methods/getLedgerEntries | getLedgerEntries docs}
      *
+     * @deprecated Use {@link getAssetBalance}, instead
      * @example
      * const accountId = "GBZC6Y2Y7Q3ZQ2Y4QZJ2XZ3Z5YXZ6Z7Z2Y4QZJ2XZ3Z5YXZ6Z7Z2Y4";
      * const asset = new Asset(
@@ -187,6 +188,36 @@ export declare class RpcServer {
      * });
      */
     getClaimableBalance(id: string): Promise<xdr.ClaimableBalanceEntry>;
+    /**
+     * Fetch the balance of an asset held by an account or contract.
+     *
+     * The `address` argument may be provided as a string (as a {@link StrKey}),
+     * {@link Address}, or {@link Contract}.
+     *
+     * @param {string|Address|Contract} address The account or contract whose
+     *    balance should be fetched.
+     * @param {Asset} asset The asset whose balance you want to inspect.
+     * @param {string}  [networkPassphrase] optionally, when requesting the
+     *    balance of a contract, the network passphrase to which this token
+     *    applies. If omitted and necessary, a request about network information
+     *    will be made (see {@link getNetwork}), since contract IDs for assets are
+     *    specific to a network. You can refer to {@link Networks} for a list of
+     *    built-in passphrases, e.g., `Networks.TESTNET`.
+     * @returns {Promise<Api.BalanceResponse>} Resolves with balance entry details
+     *    when available.
+     *
+     * @throws {Error} If the supplied `address` is not a valid account or
+     *    contract strkey.
+     *
+     * @example
+     * const usdc = new Asset(
+     *   "USDC",
+     *   "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"
+     * );
+     * const balance = await server.getAssetBalance("GD...", usdc);
+     * console.log(balance.balanceEntry?.amount);
+     */
+    getAssetBalance(address: string | Address | Contract, asset: Asset, networkPassphrase?: string): Promise<Api.BalanceResponse>;
     /**
      * General node health check.
      *
@@ -320,6 +351,7 @@ export declare class RpcServer {
      * transaction completion and return a definitive state of success or failure.
      *
      * @param {string} hash   the transaction you're polling for
+     * @param {[RpcServer.PollingOptions]} [opts] polling options
      * @param {number} [opts.attempts] (optional) the number of attempts to make
      *    before returning the last-seen status. By default or on invalid inputs,
      *    try 5 times.
@@ -644,7 +676,7 @@ export declare class RpcServer {
      *    account, or the existing account if it's already funded with the
      *    populated sequence number (note that the account will not be "topped
      *    off" if it already exists)
-     * @throws If Friendbot is not configured on this network or request failure
+     * @throws {Error} If Friendbot is not configured on this network or request failure
      *
      * @see {@link https://developers.stellar.org/docs/learn/fundamentals/networks#friendbot | Friendbot docs}
      * @see {@link module:Friendbot.Api.Response}
@@ -679,8 +711,8 @@ export declare class RpcServer {
      *
      * This is a convenience wrapper around {@link Server.getLedgerEntries}.
      *
-     * @param {string}  address the contract (string `C...`) or account ID
-     *    (`G...`) whose balance of `sac` you want to know
+     * @param {string}  address the contract (string `C...`) whose balance of
+     *    `sac` you want to know
      * @param {Asset}   sac     the built-in SAC token (e.g. `USDC:GABC...`) that
      *    you are querying from the given `contract`.
      * @param {string}  [networkPassphrase] optionally, the network passphrase to
@@ -698,6 +730,7 @@ export declare class RpcServer {
      * @see getLedgerEntries
      * @see https://developers.stellar.org/docs/tokens/stellar-asset-contract
      *
+     * @deprecated Use {@link getAssetBalance}, instead
      * @example
      * // assume `address` is some contract or account with an XLM balance
      * // assume server is an instantiated `Server` instance.
@@ -733,7 +766,9 @@ export declare class RpcServer {
      * // Fetch ledgers starting from a specific sequence number
      * server.getLedgers({
      *   startLedger: 36233,
-     *   limit: 10
+     *   pagination: {
+     *     limit: 10
+     *   }
      * }).then((response) => {
      *   console.log("Ledgers:", response.ledgers);
      *   console.log("Latest Ledger:", response.latestLedger);
@@ -744,12 +779,16 @@ export declare class RpcServer {
      * // Paginate through ledgers using cursor
      * const firstPage = await server.getLedgers({
      *   startLedger: 36233,
-     *   limit: 5
+     *   pagination: {
+     *     limit: 5
+     *   }
      * });
      *
      * const nextPage = await server.getLedgers({
-     *   cursor: firstPage.cursor,
-     *   limit: 5
+     *   pagination: {
+     *     cursor: firstPage.cursor,
+     *     limit: 5
+     *   }
      * });
      */
     getLedgers(request: Api.GetLedgersRequest): Promise<Api.GetLedgersResponse>;