UNPKG

@stellar/stellar-sdk

Version:

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

46 lines (45 loc) 1.5 kB
import xdr from "./xdr.js"; /** * LiquidityPoolId class represents the asset referenced by a trustline to a * liquidity pool. */ export declare class LiquidityPoolId { liquidityPoolId: string; /** * @param liquidityPoolId - The ID of the liquidity pool in string 'hex'. */ constructor(liquidityPoolId: string); /** * Returns a liquidity pool ID object from its xdr.TrustLineAsset representation. * @param tlAssetXdr - The asset XDR object. */ static fromOperation(tlAssetXdr: xdr.TrustLineAsset): LiquidityPoolId; /** * Returns the `xdr.TrustLineAsset` object for this liquidity pool ID. * * Note: To convert from {@link Asset | `Asset`} to `xdr.TrustLineAsset` please * refer to the * {@link Asset.toTrustLineXDRObject | `Asset.toTrustLineXDRObject`} method. */ toXDRObject(): xdr.TrustLineAsset; /** * Returns the liquidity pool ID as a hex string. */ getLiquidityPoolId(): string; /** * Returns the asset type, always `"liquidity_pool_shares"`. * * @see [Assets concept](https://developers.stellar.org/docs/glossary/assets/) */ getAssetType(): "liquidity_pool_shares"; /** * Returns true if this liquidity pool ID equals the given one. * * @param asset - LiquidityPoolId to compare. */ equals(asset: LiquidityPoolId): boolean; /** * Returns a string representation of this liquidity pool ID. */ toString(): string; }