@stellar/stellar-sdk 14.3.2 → 14.4.0

package/lib/no-axios/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>;