InfoResponse
extends Response
in package
Response from info endpoint describing anchor capabilities and supported assets.
Contains comprehensive information about what the anchor's transfer server supports, including lists of supported assets for deposits and withdrawals (both regular and exchange operations), fee structures, endpoint capabilities, and feature flags.
This is the discovery endpoint response that clients should query first to understand what operations are available and how to interact with the anchor.
Tags
Table of Contents
Properties
- $depositAssets : array<string|int, DepositAsset>|null
- $depositExchangeAssets : array<string|int, DepositExchangeAsset>|null
- $featureFlags : AnchorFeatureFlags|null
- $feeInfo : AnchorFeeInfo|null
- $transactionInfo : AnchorTransactionInfo|null
- $transactionsInfo : AnchorTransactionsInfo|null
- $withdrawAssets : array<string|int, WithdrawAsset>|null
- $withdrawExchangeAssets : array<string|int, WithdrawExchangeAsset>|null
- $httpClient : Client|null
- $rateLimitLimit : int|null
- $rateLimitRemaining : int|null
- $rateLimitReset : int|null
Methods
- fromJson() : InfoResponse
- getHttpClient() : Client|null
- Gets the HTTP client used for pagination requests
- 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.
- 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 response data from a JSON array
Properties
$depositAssets
public
array<string|int, DepositAsset>|null
$depositAssets
= null
deposit assets of the info response.
$depositExchangeAssets
public
array<string|int, DepositExchangeAsset>|null
$depositExchangeAssets
= null
deposit exchange assets of the info response.
$featureFlags
public
AnchorFeatureFlags|null
$featureFlags
= null
contains boolean values indicating whether specific features are supported by the anchor.
$feeInfo
public
AnchorFeeInfo|null
$feeInfo
= null
info about the support of the fee endpoint.
$transactionInfo
public
AnchorTransactionInfo|null
$transactionInfo
= null
info about the support of the transaction endpoint.
$transactionsInfo
public
AnchorTransactionsInfo|null
$transactionsInfo
= null
info about the support of the transactions endpoint.
$withdrawAssets
public
array<string|int, WithdrawAsset>|null
$withdrawAssets
= null
withdrawal assets of the info response.
$withdrawExchangeAssets
public
array<string|int, WithdrawExchangeAsset>|null
$withdrawExchangeAssets
= null
withdrawal exchange assets of the info response.
$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()
public
static fromJson(array<string|int, mixed> $json) : InfoResponse
Parameters
- $json : array<string|int, mixed>
Return values
InfoResponsegetHttpClient()
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
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|nullsetHeaders()
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 response data from a JSON array
protected
loadFromJson(array<string|int, mixed> $json) : void
This method is used internally to populate response objects from parsed JSON. Subclasses override this to extract their specific data fields.
Parameters
- $json : array<string|int, mixed>
-
Associative array of parsed JSON data