@xoxno/sdk-js 1.0.224 → 1.0.226

package/dist/esm/sdk/stellar/lending-read.js

@@ -0,0 +1,341 @@
+/** Typed Stellar lending reads. Configure the API deployment with XOXNOClient.apiUrl.
+ * These cached HTTP reads do not simulate transactions or authorize spending.
+ */ const BASE = '/stellar-lending';
+const enc = encodeURIComponent;
+/** Load assets, hubs, spokes, reserves and keyed reserve details in one response.
+ * @category Stellar lending reads
+ */ export const getStellarLendingContext = (client, init)=>client.fetchWithTimeout(`${BASE}/context`, init);
+/** Read live indexes and the controller collateral floor. Cached data is not transaction simulation.
+ * @category Stellar lending reads
+ */ export const getStellarLendingLiveState = (client, init)=>client.fetchWithTimeout(`${BASE}/live-state`, init);
+/** Read detailed live market state for every hub and asset.
+ * @category Stellar lending reads
+ */ export const getStellarDetailedMarkets = (client, init)=>client.fetchWithTimeout(`${BASE}/markets/detailed`, init);
+/** List lending assets aggregated across hubs.
+ * @category Stellar lending reads
+ */ export const getStellarAssets = (client, init)=>client.fetchWithTimeout(`${BASE}/assets`, init);
+/** List liquidity hubs and their aggregate balances.
+ * @category Stellar lending reads
+ */ export const getStellarHubs = (client, init)=>client.fetchWithTimeout(`${BASE}/hubs`, init);
+/** List risk spokes for market selection.
+ * @category Stellar lending reads
+ */ export const getStellarSpokes = (client, init)=>client.fetchWithTimeout(`${BASE}/spokes`, init);
+/** List reserves, optionally filtered by hub, spoke and asset. A reserve is one (spokeId, hubId, asset) coordinate.
+ * @category Stellar lending reads
+ */ export const getStellarReserves = (client, params = {}, init)=>client.fetchWithTimeout(`${BASE}/reserves`, {
+        ...init,
+        params: {
+            ...params
+        }
+    });
+/** Read one reserve with risk flags, capacity, rates and liquidity.
+ * @category Stellar lending reads
+ */ export const getStellarReserve = (client, spokeId, hubId, asset, init)=>client.fetchWithTimeout(`${BASE}/reserves/${spokeId}/${hubId}/${enc(asset)}`, init);
+/** Read the aggregate overview for one lending token contract.
+ * @category Stellar lending reads
+ */ export const getStellarAsset = (client, asset, init)=>client.fetchWithTimeout(`${BASE}/assets/${enc(asset)}`, init);
+/** Read hub totals and typed per-asset opportunities. USD totals are numbers.
+ * @category Stellar lending reads
+ */ export const getStellarHub = (client, hubId, init)=>client.fetchWithTimeout(`${BASE}/hubs/${hubId}`, init);
+/** Read spoke totals, connected hubs and risk-configured markets.
+ * @category Stellar lending reads
+ */ export const getStellarSpoke = (client, spokeId, init)=>client.fetchWithTimeout(`${BASE}/spokes/${spokeId}`, init);
+/** Read all positions for a wallet. supplyAmount and borrowAmount are RAY token quantities, not transaction base units.
+ * @category Stellar lending reads
+ */ export const getStellarUserPositions = (client, owner, init)=>client.fetchWithTimeout(`${BASE}/users/${enc(owner)}/positions`, init);
+/** Read a single lending account, identified by its decimal ID; balances use RAY token quantities.
+ * @category Stellar lending reads
+ */ export const getStellarAccountPositions = (client, accountId, init)=>client.fetchWithTimeout(`${BASE}/accounts/${enc(accountId)}/positions`, init);
+/** Read exact token base-unit holdings for a G or C wallet. Holdings may exceed spendable funds. Requires the API release exposing this route; older deployments return 404.
+ * @category Stellar lending reads
+ */ export const getStellarWalletBalance = (client, owner, asset, init)=>client.fetchWithTimeout(`${BASE}/users/${enc(owner)}/assets/${enc(asset)}/balance`, init);
+/** Load overview, deposit/borrow markets and chart series for an asset page.
+ * @category Stellar lending reads
+ */ export const getStellarAssetPage = (client, asset, query, init)=>client.fetchWithTimeout(`${BASE}/assets/${enc(asset)}/page`, {
+        ...init,
+        params: {
+            ...query
+        }
+    });
+/** List an asset’s markets, including pause/freeze flags and remaining capacity. side is deposit or borrow.
+ * @category Stellar lending reads
+ */ export const getStellarAssetMarkets = (client, asset, side, init)=>client.fetchWithTimeout(`${BASE}/assets/${enc(asset)}/markets`, {
+        ...init,
+        params: {
+            side
+        }
+    });
+/** List holders and their shares; side is deposits or borrows.
+ * @category Stellar lending reads
+ */ export const getStellarReserveHolders = (client, spokeId, hubId, asset, side, init)=>client.fetchWithTimeout(`${BASE}/reserves/${spokeId}/${hubId}/${enc(asset)}/holders`, {
+        ...init,
+        params: {
+            side
+        }
+    });
+/** List holders and their shares; side is deposits or borrows.
+ * @category Stellar lending reads
+ */ export const getStellarHubHolders = (client, hubId, side, init)=>client.fetchWithTimeout(`${BASE}/hubs/${hubId}/holders`, {
+        ...init,
+        params: {
+            side
+        }
+    });
+/** List holders and their shares; side is deposits or borrows.
+ * @category Stellar lending reads
+ */ export const getStellarSpokeHolders = (client, spokeId, side, init)=>client.fetchWithTimeout(`${BASE}/spokes/${spokeId}/holders`, {
+        ...init,
+        params: {
+            side
+        }
+    });
+/** Read binned market-history points.
+ * @category Stellar lending reads
+ */ export const getStellarAssetGraph = (client, asset, query, init)=>client.fetchWithTimeout(`${BASE}/assets/${enc(asset)}/graph`, {
+        ...init,
+        params: {
+            ...query
+        }
+    });
+/** Read binned market-history points.
+ * @category Stellar lending reads
+ */ export const getStellarHubGraph = (client, hubId, query, init)=>client.fetchWithTimeout(`${BASE}/hubs/${hubId}/graph`, {
+        ...init,
+        params: {
+            ...query
+        }
+    });
+/** Read spoke-attributed suppliedUsd/borrowedUsd and blended APYs.
+ * @category Stellar lending reads
+ */ export const getStellarSpokeGraph = (client, spokeId, query, init)=>client.fetchWithTimeout(`${BASE}/spokes/${spokeId}/graph`, {
+        ...init,
+        params: {
+            ...query
+        }
+    });
+/** Read binned market-history points.
+ * @category Stellar lending reads
+ */ export const getStellarReserveGraph = (client, spokeId, hubId, asset, query, init)=>client.fetchWithTimeout(`${BASE}/reserves/${spokeId}/${hubId}/${enc(asset)}/graph`, {
+        ...init,
+        params: {
+            ...query
+        }
+    });
+/** Read the legacy paged action feed. Display amounts are floating point; use userActivityPage for exact amounts and transaction hashes when available.
+ * @category Stellar lending reads
+ */ export const getStellarUserActivity = (client, owner, params = {}, init)=>client.fetchWithTimeout(`${BASE}/users/${enc(owner)}/activity`, {
+        ...init,
+        params: {
+            ...params
+        }
+    });
+/** Read exact owner-attributed activity. Pass the opaque continuationToken unchanged for the next page. Requires the API release exposing this route; older deployments return 404.
+ * @category Stellar lending reads
+ */ export const getStellarUserActivityPage = (client, owner, params = {}, init)=>client.fetchWithTimeout(`${BASE}/users/${enc(owner)}/activity/page`, {
+        ...init,
+        params: {
+            ...params
+        }
+    });
+/** Read governance proposals; pass the opaque continuationToken unchanged.
+ * @category Stellar lending reads
+ */ export const getStellarGovernanceProposals = (client, params = {}, init)=>client.fetchWithTimeout(`${BASE}/governance/proposals`, {
+        ...init,
+        params: {
+            ...params
+        }
+    });
+/** Read a paged wallet leaderboard under positions. Its healthFactor is debt / liquidation-weighted collateral × 100; higher is riskier.
+ * @category Stellar lending reads
+ */ export const getStellarPositionsLeaderboard = (client, params = {}, init)=>client.fetchWithTimeout(`${BASE}/positions`, {
+        ...init,
+        params: {
+            ...params
+        }
+    });
+/** Read distinct supplier, borrower and total account counts.
+ * @category Stellar lending reads
+ */ export const getStellarParticipantCounts = (client, params = {}, init)=>client.fetchWithTimeout(`${BASE}/participants`, {
+        ...init,
+        params: {
+            ...params
+        }
+    });
+/** Read liquidators ranked by gross seized USD.
+ * @category Stellar lending reads
+ */ export const getStellarLiquidationsLeaderboard = (client, params = {}, init)=>client.fetchWithTimeout(`${BASE}/liquidations/leaderboard`, {
+        ...init,
+        params: {
+            ...params
+        }
+    });
+/** Read position-size distribution; side is deposits or borrows.
+ * @category Stellar lending reads
+ */ export const getStellarHolderDistribution = (client, params = {}, init)=>client.fetchWithTimeout(`${BASE}/distribution`, {
+        ...init,
+        params: {
+            ...params
+        }
+    });
+/** Read the paged Stellar campaign leaderboard.
+ * @category Stellar lending reads
+ */ export const getStellarCampaignLeaderboard = (client, params = {}, init)=>client.fetchWithTimeout(`${BASE}/campaign/leaderboard`, {
+        ...init,
+        params: {
+            ...params
+        }
+    });
+/** Read protocol USD history as parallel arrays sharing timestamps.
+ * @category Stellar lending reads
+ */ export const getStellarStatsHistory = (client, query, init)=>client.fetchWithTimeout(`${BASE}/stats/history`, {
+        ...init,
+        params: {
+            ...query
+        }
+    });
+/** Read reserve interest revenue for the selected scope.
+ * @category Stellar lending reads
+ */ export const getStellarRevenueSeries = (client, query, init)=>client.fetchWithTimeout(`${BASE}/revenue`, {
+        ...init,
+        params: {
+            ...query
+        }
+    });
+/** Read flash-loan and strategy-fee revenue.
+ * @category Stellar lending reads
+ */ export const getStellarFeeRevenueSeries = (client, query, init)=>client.fetchWithTimeout(`${BASE}/revenue/fees`, {
+        ...init,
+        params: {
+            ...query
+        }
+    });
+/** Read liquidation history. Gross seized collateral differs from net liquidator credit.
+ * @category Stellar lending reads
+ */ export const getStellarLiquidationsSeries = (client, query, init)=>client.fetchWithTimeout(`${BASE}/liquidations`, {
+        ...init,
+        params: {
+            ...query
+        }
+    });
+/** Read supply, borrow, withdrawal and repayment volume.
+ * @category Stellar lending reads
+ */ export const getStellarVolumeSeries = (client, query, init)=>client.fetchWithTimeout(`${BASE}/volume`, {
+        ...init,
+        params: {
+            ...query
+        }
+    });
+/** Read active owners/accounts and new-user history.
+ * @category Stellar lending reads
+ */ export const getStellarActiveUsersSeries = (client, query, init)=>client.fetchWithTimeout(`${BASE}/active-users`, {
+        ...init,
+        params: {
+            ...query
+        }
+    });
+/** Read per-market borrow-minus-supply APY spreads.
+ * @category Stellar lending reads
+ */ export const getStellarRateSpreadSeries = (client, query, init)=>client.fetchWithTimeout(`${BASE}/rate-spread`, {
+        ...init,
+        params: {
+            ...query
+        }
+    });
+/** Read protocol TVL, borrowing, fees and revenue dimensions.
+ * @category Stellar lending reads
+ */ export const getStellarDefiLlamaDimensions = (client, query, init)=>client.fetchWithTimeout(`${BASE}/defillama`, {
+        ...init,
+        params: {
+            ...query
+        }
+    });
+/** Read supplied/borrowed history for a lending account, not a wallet address.
+ * @category Stellar lending reads
+ */ export const getStellarUserHistory = (client, accountId, query, init)=>client.fetchWithTimeout(`${BASE}/users/${enc(accountId)}/history`, {
+        ...init,
+        params: {
+            ...query
+        }
+    });
+/** Read realized and unrealized interest PnL by asset for one account.
+ * @category Stellar lending reads
+ */ export const getStellarPositionsPnl = (client, accountId, init)=>client.fetchWithTimeout(`${BASE}/pnl`, {
+        ...init,
+        params: {
+            accountId
+        }
+    });
+/** Read cross-account PnL grouped by scope.
+ * @category Stellar lending reads
+ */ export const getStellarPnlByScope = (client, scope, init)=>client.fetchWithTimeout(`${BASE}/pnl/scope`, {
+        ...init,
+        params: {
+            scope
+        }
+    });
+/** Read one wallet’s Stellar campaign row.
+ * @category Stellar lending reads
+ */ export const getStellarCampaignMe = (client, owner, init)=>client.fetchWithTimeout(`${BASE}/campaign/me`, {
+        ...init,
+        params: {
+            owner
+        }
+    });
+/** Bind a client once for typed market and portfolio reads.
+ * @param client - API client configured for the same Stellar deployment as your RPC/controller.
+ * @example
+ * ```ts
+ * const read = stellarLendingRead(new XOXNOClient({ apiUrl }))
+ * const markets = await read.reserves({ spokeId: 1 })
+ * const positions = await read.userPositions(walletAddress)
+ * ```
+ * @category Stellar lending reads
+ */ export const stellarLendingRead = (client)=>({
+        /** {@inheritDoc getStellarLendingContext} */ context: (init)=>getStellarLendingContext(client, init),
+        /** {@inheritDoc getStellarLendingLiveState} */ liveState: (init)=>getStellarLendingLiveState(client, init),
+        /** {@inheritDoc getStellarDetailedMarkets} */ marketsDetailed: (init)=>getStellarDetailedMarkets(client, init),
+        /** {@inheritDoc getStellarAssets} */ assets: (init)=>getStellarAssets(client, init),
+        /** {@inheritDoc getStellarHubs} */ hubs: (init)=>getStellarHubs(client, init),
+        /** {@inheritDoc getStellarSpokes} */ spokes: (init)=>getStellarSpokes(client, init),
+        /** List reserves. The one-argument request-init form is retained for compatibility. */ reserves: (paramsOrInit = {}, init)=>{
+            const filters = init !== undefined || 'hubId' in paramsOrInit || 'spokeId' in paramsOrInit || 'asset' in paramsOrInit;
+            return filters ? getStellarReserves(client, paramsOrInit, init) : getStellarReserves(client, {}, paramsOrInit);
+        },
+        /** {@inheritDoc getStellarReserve} */ reserve: (spokeId, hubId, asset, init)=>getStellarReserve(client, spokeId, hubId, asset, init),
+        /** {@inheritDoc getStellarAsset} */ asset: (asset, init)=>getStellarAsset(client, asset, init),
+        /** {@inheritDoc getStellarHub} */ hub: (hubId, init)=>getStellarHub(client, hubId, init),
+        /** {@inheritDoc getStellarSpoke} */ spoke: (spokeId, init)=>getStellarSpoke(client, spokeId, init),
+        /** {@inheritDoc getStellarUserPositions} */ userPositions: (owner, init)=>getStellarUserPositions(client, owner, init),
+        /** {@inheritDoc getStellarAccountPositions} */ accountPositions: (accountId, init)=>getStellarAccountPositions(client, accountId, init),
+        /** {@inheritDoc getStellarWalletBalance} */ walletBalance: (owner, asset, init)=>getStellarWalletBalance(client, owner, asset, init),
+        /** {@inheritDoc getStellarAssetPage} */ assetPage: (asset, query, init)=>getStellarAssetPage(client, asset, query, init),
+        /** {@inheritDoc getStellarAssetMarkets} */ assetMarkets: (asset, side, init)=>getStellarAssetMarkets(client, asset, side, init),
+        /** {@inheritDoc getStellarReserveHolders} */ reserveHolders: (spokeId, hubId, asset, side, init)=>getStellarReserveHolders(client, spokeId, hubId, asset, side, init),
+        /** {@inheritDoc getStellarHubHolders} */ hubHolders: (hubId, side, init)=>getStellarHubHolders(client, hubId, side, init),
+        /** {@inheritDoc getStellarSpokeHolders} */ spokeHolders: (spokeId, side, init)=>getStellarSpokeHolders(client, spokeId, side, init),
+        /** {@inheritDoc getStellarAssetGraph} */ assetGraph: (asset, query, init)=>getStellarAssetGraph(client, asset, query, init),
+        /** {@inheritDoc getStellarHubGraph} */ hubGraph: (hubId, query, init)=>getStellarHubGraph(client, hubId, query, init),
+        /** {@inheritDoc getStellarSpokeGraph} */ spokeGraph: (spokeId, query, init)=>getStellarSpokeGraph(client, spokeId, query, init),
+        /** {@inheritDoc getStellarReserveGraph} */ reserveGraph: (spokeId, hubId, asset, query, init)=>getStellarReserveGraph(client, spokeId, hubId, asset, query, init),
+        /** {@inheritDoc getStellarUserActivity} */ userActivity: (owner, params = {}, init)=>getStellarUserActivity(client, owner, params, init),
+        /** {@inheritDoc getStellarUserActivityPage} */ userActivityPage: (owner, params = {}, init)=>getStellarUserActivityPage(client, owner, params, init),
+        /** {@inheritDoc getStellarGovernanceProposals} */ governanceProposals: (params = {}, init)=>getStellarGovernanceProposals(client, params, init),
+        /** {@inheritDoc getStellarPositionsLeaderboard} */ positionsLeaderboard: (params = {}, init)=>getStellarPositionsLeaderboard(client, params, init),
+        /** {@inheritDoc getStellarParticipantCounts} */ participants: (params = {}, init)=>getStellarParticipantCounts(client, params, init),
+        /** {@inheritDoc getStellarLiquidationsLeaderboard} */ liquidationsLeaderboard: (params = {}, init)=>getStellarLiquidationsLeaderboard(client, params, init),
+        /** {@inheritDoc getStellarHolderDistribution} */ distribution: (params = {}, init)=>getStellarHolderDistribution(client, params, init),
+        /** {@inheritDoc getStellarCampaignLeaderboard} */ campaignLeaderboard: (params = {}, init)=>getStellarCampaignLeaderboard(client, params, init),
+        /** {@inheritDoc getStellarStatsHistory} */ statsHistory: (query, init)=>getStellarStatsHistory(client, query, init),
+        /** {@inheritDoc getStellarRevenueSeries} */ revenue: (query, init)=>getStellarRevenueSeries(client, query, init),
+        /** {@inheritDoc getStellarFeeRevenueSeries} */ feeRevenue: (query, init)=>getStellarFeeRevenueSeries(client, query, init),
+        /** {@inheritDoc getStellarLiquidationsSeries} */ liquidations: (query, init)=>getStellarLiquidationsSeries(client, query, init),
+        /** {@inheritDoc getStellarVolumeSeries} */ volume: (query, init)=>getStellarVolumeSeries(client, query, init),
+        /** {@inheritDoc getStellarActiveUsersSeries} */ activeUsers: (query, init)=>getStellarActiveUsersSeries(client, query, init),
+        /** {@inheritDoc getStellarRateSpreadSeries} */ rateSpread: (query, init)=>getStellarRateSpreadSeries(client, query, init),
+        /** {@inheritDoc getStellarDefiLlamaDimensions} */ defillama: (query, init)=>getStellarDefiLlamaDimensions(client, query, init),
+        /** {@inheritDoc getStellarUserHistory} */ userHistory: (accountId, query, init)=>getStellarUserHistory(client, accountId, query, init),
+        /** {@inheritDoc getStellarPositionsPnl} */ positionsPnl: (accountId, init)=>getStellarPositionsPnl(client, accountId, init),
+        /** {@inheritDoc getStellarPnlByScope} */ pnlByScope: (scope, init)=>getStellarPnlByScope(client, scope, init),
+        /** {@inheritDoc getStellarCampaignMe} */ campaignMe: (owner, init)=>getStellarCampaignMe(client, owner, init)
+    });
+export * from "./lending-read-types.js";