stellar-sdk/lib/horizon/claimable_balances_call_builder.d.ts

A library for working with the Stellar network, including communication with the Horizon and Soroban RPC servers.

import { Asset } from "@stellar/stellar-base";
import { CallBuilder } from "./call_builder";
import { ServerApi } from "./server_api";
/**
 * Creates a new {@link ClaimableBalanceCallBuilder} pointed to server defined by serverUrl.
 * Do not create this object directly, use {@link Server#claimableBalances}.
 *
 * @see [Claimable Balances](https://developers.stellar.org/api/resources/claimablebalances/)
 * @class ClaimableBalanceCallBuilder
 * @class
 * @augments CallBuilder
 * @param {string} serverUrl Horizon server URL.
 */
export declare class ClaimableBalanceCallBuilder extends CallBuilder<ServerApi.CollectionPage<ServerApi.ClaimableBalanceRecord>> {
    constructor(serverUrl: URI);
    /**
     * The claimable balance details endpoint provides information on a single claimable balance.
     *
     * @see [Claimable Balance Details](https://developers.stellar.org/api/resources/claimablebalances/single/)
     * @param {string} claimableBalanceId Claimable balance ID
     * @returns {CallBuilder<ServerApi.ClaimableBalanceRecord>} CallBuilder<ServerApi.ClaimableBalanceRecord> OperationCallBuilder instance
     */
    claimableBalance(claimableBalanceId: string): CallBuilder<ServerApi.ClaimableBalanceRecord>;
    /**
     * Returns all claimable balances which are sponsored by the given account ID.
     *
     * @see [Claimable Balances](https://developers.stellar.org/api/resources/claimablebalances/list/)
     * @param {string} sponsor For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
     * @returns {ClaimableBalanceCallBuilder} current ClaimableBalanceCallBuilder instance
     */
    sponsor(sponsor: string): this;
    /**
     * Returns all claimable balances which can be claimed by the given account ID.
     *
     * @see [Claimable Balances](https://developers.stellar.org/api/resources/claimablebalances/list/)
     * @param {string} claimant For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
     * @returns {ClaimableBalanceCallBuilder} current ClaimableBalanceCallBuilder instance
     */
    claimant(claimant: string): this;
    /**
     * Returns all claimable balances which provide a balance for the given asset.
     *
     * @see [Claimable Balances](https://developers.stellar.org/api/resources/claimablebalances/list/)
     * @param {Asset} asset The Asset held by the claimable balance
     * @returns {ClaimableBalanceCallBuilder} current ClaimableBalanceCallBuilder instance
     */
    asset(asset: Asset): this;
}