Migration & Deprecations¶
Deprecated in 2.3.0¶
The following still work, are @deprecated-tagged, and are planned for removal in v3.0.0:
| Deprecated | Replacement |
|---|---|
useVaultHoldings(poolId, tokenId) |
useVaultAssetDistribution(shareClassId) |
usePoolHoldings(poolId) |
useVaultAssetDistribution(shareClassId) |
useCentrifugeHoldings({ poolId, tokenId }) |
useVaultAssetDistribution(shareClassId) |
CentrifugeAPIClient.getVaultHoldings(poolId, tokenId) |
ArkonixAPIClient.getAssetDistribution(shareClassId) |
CentrifugeAPIClient.getPoolHoldings(poolId) |
ArkonixAPIClient.getAssetDistribution(shareClassId) |
Not a mechanical rename
Three things change when you migrate off the Centrifuge holdings surface:
- The key — a share-class id (obtained from
useVaultFinancials/getVaultFinancials), not the CentrifugepoolId/tokenIdpair. - The return shape —
VaultAssetDistributionwith weightedassets[](pctOfTvl,valueUsd,partial/partialReasons), not rawCentrifugeHoldingEscrow[]. - The backend — the Arkonix REST API, not the Centrifuge GraphQL API.
Plan for a small refactor, not a find-and-replace. See Working with Financial Data for the new semantics.
Not deprecated: the vault-discovery hooks (useCentrifugeVaults, usePoolVaults, useActiveVaults) and CentrifugeAPIClient.getHoldings(...) / getVaults(...).
Version history¶
| Version | Changes |
|---|---|
| 2.3.0 (current) | + useVaultTransactions, useVaultAssetDistribution, useShareClassFees and matching ArkonixAPIClient methods/types; Centrifuge holdings deprecated |
| 2.2.x | Breaking: apy* → return* field/hook/type renames (useApyHistory → useReturnHistory, ApyHistory[Point] → ReturnHistory[Point], getApyHistory → getReturnHistory); useCancelDeposit gained required vaultType arg; + financial-data layer, cancel flows, useClaimDeposit export, 5-chain support |
| ≤ 2.1.x | legacy apy* naming |
The /apy-history endpoint path did not change
The 2.2.0 renames covered the SDK surface and JSON field names only. The return-history HTTP endpoint remains GET /public/share-classes/{id}/apy-history for backward compatibility. See API Clients.
Full migration guide¶
A complete migration guide — rename tables, find-and-replace cheatsheet, and semantic notes — is maintained as MIGRATION.md in the repository.