LiquidityPoolEffectResponse
extends EffectResponse
in package
Base class for liquidity pool details in effect responses
This response provides comprehensive information about a liquidity pool's state including its reserves, shares, and fee structure. Used as a nested object in various liquidity pool effect responses.
Tags
Table of Contents
Properties
- $httpClient : Client|null
- $rateLimitLimit : int|null
- $rateLimitRemaining : int|null
- $rateLimitReset : int|null
Methods
- fromJson() : LiquidityPoolEffectResponse
- Creates an instance from JSON data
- getAccount() : string
- Gets the account address affected by this effect
- getAccountMuxed() : string|null
- Gets the muxed account address if the account is multiplexed
- getAccountMuxedId() : string|null
- Gets the muxed account ID if the account is multiplexed
- getCreatedAt() : string
- Gets the timestamp when this effect was created
- getEffectId() : string
- Gets the unique identifier for this effect
- getEffectType() : int
- Gets the numeric effect type identifier
- getFee() : int
- Gets the pool fee in basis points
- getHttpClient() : Client|null
- Gets the HTTP client used for pagination requests
- getHumanReadableEffectType() : string
- Gets the human-readable description of the effect type
- getLinks() : EffectLinksResponse
- Gets the links to related resources for this effect
- getPagingToken() : string
- Gets the paging token for this effect in list results
- getPoolId() : string
- Gets the unique identifier of the liquidity pool
- getRateLimitLimit() : int|null
- Returns X-RateLimit-Limit header from the response.
- getRateLimitRemaining() : int|null
- Returns X-RateLimit-Remaining header from the response.
- getRateLimitReset() : int|null
- Returns X-RateLimit-Reset header from the response. Seconds until a new window starts.
- getReserves() : ReservesResponse
- Gets the pool reserves
- getTotalShares() : string
- Gets the total shares issued by this pool
- getTotalTrustlines() : string
- Gets the total number of trustlines to this pool
- getType() : string
- Gets the pool type
- setHeaders() : void
- Extracts and sets rate limiting information from HTTP response headers
- setHttpClient() : void
- Sets the HTTP client for making follow-up requests
- loadFromJson() : void
- Loads object data from JSON array
Properties
$httpClient
protected
Client|null
$httpClient
= null
$rateLimitLimit
protected
int|null
$rateLimitLimit
= null
$rateLimitRemaining
protected
int|null
$rateLimitRemaining
= null
$rateLimitReset
protected
int|null
$rateLimitReset
= null
Methods
fromJson()
Creates an instance from JSON data
public
static fromJson(array<string|int, mixed> $jsonData) : LiquidityPoolEffectResponse
Parameters
- $jsonData : array<string|int, mixed>
-
JSON data array
Return values
LiquidityPoolEffectResponsegetAccount()
Gets the account address affected by this effect
public
getAccount() : string
Return values
string —The account ID
getAccountMuxed()
Gets the muxed account address if the account is multiplexed
public
getAccountMuxed() : string|null
Return values
string|null —The muxed account address, or null if not multiplexed
getAccountMuxedId()
Gets the muxed account ID if the account is multiplexed
public
getAccountMuxedId() : string|null
Return values
string|null —The muxed account ID, or null if not multiplexed
getCreatedAt()
Gets the timestamp when this effect was created
public
getCreatedAt() : string
Return values
string —The creation time in ISO 8601 format
getEffectId()
Gets the unique identifier for this effect
public
getEffectId() : string
Return values
string —The effect ID
getEffectType()
Gets the numeric effect type identifier
public
getEffectType() : int
Return values
int —The effect type code as defined in EffectType constants
getFee()
Gets the pool fee in basis points
public
getFee() : int
Return values
int —The fee in basis points
getHttpClient()
Gets the HTTP client used for pagination requests
public
getHttpClient() : Client|null
Return values
Client|null —The HTTP client instance, or null if not set
getHumanReadableEffectType()
Gets the human-readable description of the effect type
public
getHumanReadableEffectType() : string
Return values
string —The effect type name (e.g., "account_created", "trade")
getLinks()
Gets the links to related resources for this effect
public
getLinks() : EffectLinksResponse
Return values
EffectLinksResponse —The navigation links
getPagingToken()
Gets the paging token for this effect in list results
public
getPagingToken() : string
Return values
string —The paging token used for cursor-based pagination
getPoolId()
Gets the unique identifier of the liquidity pool
public
getPoolId() : string
Return values
string —The pool ID
getRateLimitLimit()
Returns X-RateLimit-Limit header from the response.
public
getRateLimitLimit() : int|null
This number represents the he maximum number of requests that the current client can make in one hour.
Tags
Return values
int|nullgetRateLimitRemaining()
Returns X-RateLimit-Remaining header from the response.
public
getRateLimitRemaining() : int|null
The number of remaining requests for the current window.
Tags
Return values
int|nullgetRateLimitReset()
Returns X-RateLimit-Reset header from the response. Seconds until a new window starts.
public
getRateLimitReset() : int|null
Tags
Return values
int|nullgetReserves()
Gets the pool reserves
public
getReserves() : ReservesResponse
Return values
ReservesResponse —The pool reserves
getTotalShares()
Gets the total shares issued by this pool
public
getTotalShares() : string
Return values
string —The total pool shares
getTotalTrustlines()
Gets the total number of trustlines to this pool
public
getTotalTrustlines() : string
Return values
string —The total trustlines count
getType()
Gets the pool type
public
getType() : string
Return values
string —The pool type (e.g., constant_product)
setHeaders()
Extracts and sets rate limiting information from HTTP response headers
public
setHeaders(array<string|int, mixed> $headers) : void
This method processes the X-Ratelimit-* headers from the HTTP response and stores them for client access.
Parameters
- $headers : array<string|int, mixed>
-
Associative array of HTTP headers from the response
setHttpClient()
Sets the HTTP client for making follow-up requests
public
setHttpClient([Client|null $httpClient = null ]) : void
Paginated responses contain links to next/previous pages. This HTTP client is used when following those links to fetch additional pages.
Parameters
- $httpClient : Client|null = null
-
The Guzzle HTTP client to use for pagination
loadFromJson()
Loads object data from JSON array
protected
loadFromJson(array<string|int, mixed> $json) : void
Parameters
- $json : array<string|int, mixed>
-
JSON data array