@varla/sdk 1.11.4 → 1.14.0

package/AGENTS.md

@@ -18,13 +18,15 @@ Published package: **@varla/sdk**
 - Contracts/bindings + views: `@varla/sdk` or `@varla/sdk/views`
 - Actions: `@varla/sdk/actions`
 - Events/indexer: `@varla/sdk/events`
+- Errors: `@varla/sdk/errors`
 - Utilities: `@varla/sdk/batch`, `@varla/sdk/format`
+- Leverage: `@varla/sdk/leverage`
 
 ---
 
 ## Frontend-oriented view helpers (quick map)
 
-> Tip: prefer **subpath imports** so it’s obvious what you’re using:
+> Tip: prefer **subpath imports** so it's obvious what you're using:
 >
 > ```ts
 > import * as views from "@varla/sdk/views";
@@ -37,7 +39,7 @@ Published package: **@varla/sdk**
   - `views.readLenderSnapshot({ pool, user })` →
     `{ shares, assets, maxWithdrawAssets, maxRedeemShares }`
   - Notes:
-    - `assets` is the **current underlying value** of the user’s ERC4626 shares (principal + interest).
+    - `assets` is the **current underlying value** of the user's ERC4626 shares (principal + interest).
     - `maxWithdrawAssets` is the **available-to-withdraw right now** (liquidity + reserve aware).
 
 - **Available-to-withdraw only**
@@ -69,25 +71,34 @@ Published package: **@varla/sdk**
   - `views.readHealthFactor({ core, user })` → `{ healthFactor, canBeLiquidated }`
   - `views.readLiquidationConfig({ core })` and `views.readTierLiquidationConfig({ core, tier })`
 
-### Home page / “Top opportunities” (suggested inputs)
+### Home page / "Top opportunities" (suggested inputs)
 
 The SDK can provide raw primitives; **ranking is app-side**:
 - `views.readPoolRates({ pool })` (supplyAPY, utilization)
 - `views.readPoolCaps({ pool })` (capacity constraints)
 - `views.readPoolHealthScore({ pool })` (simple risk signal)
 
+### Error decoding
+
+```ts
+import { decodeVarlaError, formatVarlaError } from "@varla/sdk/errors";
+
+const decoded = decodeVarlaError(err); // works with raw hex or caught errors
+if (decoded) console.log(formatVarlaError(decoded));
+```
+
 ---
 
 ## Not provided by the SDK (by design)
 
-- **“Interest accrued / lender earnings” for a user**
+- **"Interest accrued / lender earnings" for a user**
   - ERC4626 does not track principal per-user.
-  - To show “interest accrued”, you need a cost basis, e.g.:
+  - To show "interest accrued", you need a cost basis, e.g.:
     - app-side tracking of deposits/withdrawals, or
     - an indexer that reconstructs deposits/withdrawals from events.
 
-- **Borrow “net rate”**
-  - `borrowRate` and pool `supplyAPY` are available, but “net” is product-specific
+- **Borrow "net rate"**
+  - `borrowRate` and pool `supplyAPY` are available, but "net" is product-specific
     (depends on whether you consider collateral yield, whether user is also a lender, etc.).
 
 - **Cooldown period**
@@ -96,95 +107,71 @@ The SDK can provide raw primitives; **ranking is app-side**:
 
 ---
 
-## All view helpers (generated)
+## Full API Reference (auto-generated)
 
-<!-- BEGIN GENERATED:VIEW_HELPERS -->
+<!-- BEGIN GENERATED:EXPORTS -->
 <!--
-This section is auto-generated by scripts/sdk-generate-docs.ts.
-Do not edit manually.
+  Auto-generated by scripts/sdk/generate-docs.ts — DO NOT EDIT MANUALLY.
+  340 functions, 169 types across 10 subpaths.
 -->
 
-- `getInterestRateStrategyFromPool`
-- `hydrateOraclePositionIds`
-- `previewBorrow`
-- `previewRepay`
-- `readAccessManagerBasics`
-- `readAccountPositions`
-- `readAccountPositionsFull`
-- `readAccountSnapshot`
-- `readAdapterInfo`
-- `readBadDebtStatus`
-- `readBorrowLimits`
-- `readBorrowerState`
-- `readBorrowers`
-- `readBorrowersPage`
-- `readCalculateLiquidationBonus`
-- `readCanLiquidate`
-- `readConfiguredPositionIds`
-- `readConvertLiquidatorBasics`
-- `readCoreAddresses`
-- `readCoreGlobalDebt`
-- `readDefaultLtvConfig`
-- `readHasRole`
-- `readHealthFactor`
-- `readHypotheticalBorrowCapacity`
-- `readInterestRateStrategyBasics`
-- `readLenderSnapshot`
-- `readLiquidationBonusBps`
-- `readLiquidationConfig`
-- `readLiquidationParamsForPosition`
-- `readLiquidatorBasics`
-- `readLiquidity`
-- `readLtvForPosition`
-- `readManyAccountSnapshots`
-- `readManyBorrowLimits`
-- `readManyHasRole`
-- `readManyLiquidationBonusBps`
-- `readManyOraclePositionMeta`
-- `readManyPositionSnapshots`
-- `readManyTargetConfigs`
-- `readManyTargetFunctionRoles`
-- `readMaxPositionsConfig`
-- `readMaxRedeem`
-- `readMaxWithdraw`
-- `readMergeLiquidatorBasics`
-- `readNegRiskMarketPositionIds`
-- `readOracleBasics`
-- `readOracleCollateralStatus`
-- `readOracleConfig`
-- `readOracleFinalizationStatus`
-- `readOracleGuardsStatus`
-- `readOraclePositionMeta`
-- `readOraclePriceData`
-- `readOracleRegistry`
-- `readOracleRegistryPage`
-- `readOracleTiming`
-- `readPoolAccounting`
-- `readPoolCaps`
-- `readPoolCoreAddress`
-- `readPoolDebtState`
-- `readPoolHealthScore`
-- `readPoolRates`
-- `readPoolSharePrice`
-- `readPoolSnapshot`
-- `readPortfolioValue`
-- `readPositionBalance`
-- `readPositionBalances`
-- `readPositionCount`
-- `readPositionLiquidationConfigOverride`
-- `readPositionLtvOverride`
-- `readPositionSnapshot`
-- `readPreviewLiquidation`
-- `readPrice`
-- `readProxyAdminPaused`
-- `readRepayTiming`
-- `readRiskTier`
-- `readRoleSummary`
-- `readSpotPrice`
-- `readSystemSnapshot`
-- `readTargetConfig`
-- `readTierLiquidationConfig`
-- `readTieredLtvConfig`
-- `readTryGetPrice`
-- `readTwap`
-<!-- END GENERATED:VIEW_HELPERS -->
+### `@varla/sdk` (168 functions, 86 types, 8 constants)
+
+**Functions:** `prepareCoreSetDefaultLtvConfig`, `prepareCoreSetLiquidationConfig`, `prepareCoreSetTierLiquidationConfig`, `prepareCoreSetMaxPositions`, `prepareCoreSetMaxPositionsBounds`, `prepareCoreSetOracle`, `prepareCoreSetPositionLtvOverride`, `prepareCoreClearPositionLtvOverride`, `prepareCoreSetPositionLiquidationConfigOverride`, `prepareCoreClearPositionLiquidationConfigOverride`, `preparePoolSetDepositCap`, `preparePoolSetBorrowCap`, `preparePoolWithdrawReserve`, `preparePoolSetInterestRateStrategy`, `prepareOracleSetMaxStaleness`, `prepareOracleSetLiquidationGracePeriod`, `prepareOracleSetDefaultEarlyClosureWindow`, `prepareStrategySetPool`, `prepareStrategySetRateParams`, `prepareOracleUpdaterRouterSetPublisher`, `prepareCoreDeposit`, `prepareCoreWithdraw`, `prepareCoreBorrow`, `prepareCoreRepay`, `prepareErc20Approve`, `prepareErc1155SetApprovalForAll`, `prepareLiquidatorLiquidate`, `prepareLiquidatorLiquidateMulti`, `prepareLiquidatorLiquidateBadDebt`, `prepareLiquidatorResolveBadDebtWithReserve`, `prepareOracleConfigurePositionsBatch`, `prepareOracleConfigurePosition`, `prepareOracleSetUpdater`, `prepareOracleSetPositionEarlyClosureWindowOverride`, `prepareOracleClearPositionEarlyClosureWindowOverride`, `prepareOracleInvalidatePosition`, `prepareOracleValidatePosition`, `prepareOracleRegisterNegRiskMarketPositions`, `prepareOracleOverrideNegRiskMarketPositions`, `prepareOracleConfigureOppositePositions`, `prepareOracleConfigureNegRiskPositionsBatch`, `prepareOracleUpdatePrices`, `prepareOracleUpdatePrice`, `prepareOracleSetResolutionPrice`, `planOracleSeed`, `seedOracleFromJson`, `seedOracleFromJsonFiles`, `prepareOracleSeedPlan`, `executeOracleSeedPlan`, `buildNonce`, `splitNonce`, `toOracleUpdaterRouterTypedMessage`, `computeOracleUpdaterDigest`, `signOracleUpdaterRouterUpdate`, `prepareOracleUpdaterRouterUpdatePricesWithSig`, `preparePoolDeposit`, `preparePoolMint`, `preparePoolWithdraw`, `preparePoolRedeem`, `readCanCall`, `assertCanCallImmediate`, `sendTx`, `selectorFromSignature`, `chunk`, `multicallChunks`, `getAddressBook`, `getVarlaContracts`, `getRequiredVarlaContracts`, `getErc20`, `getErc1155`, `getErc4626`, `decodeEventLogs`, `getEventLogsChunked`, `syncOracleRegistryViaEvents`, `getRecentEvents`, `formatWad`, `formatBps`, `formatPriceE8`, `parseUnits`, `parseWad`, `isSupportedChain`, `assertSupportedChain`, `getChainMeta`, `readAccessManagerBasics`, `readRoleSummary`, `readTargetConfig`, `readHasRole`, `readManyHasRole`, `readManyTargetFunctionRoles`, `readManyTargetConfigs`, `readAdapterInfo`, `readInterestRateStrategyBasics`, `getInterestRateStrategyFromPool`, `readProxyAdminPaused`, `readRepayTiming`, `readPositionCount`, `readOracleGuardsStatus`, `readAccountSnapshot`, `readCoreAddresses`, `readMaxPositionsConfig`, `readAccountPositionsFull`, `readPositionBalances`, `readBorrowerState`, `readPortfolioValue`, `readBorrowers`, `readCoreGlobalDebt`, `readPositionLiquidationConfigOverride`, `readPositionBalance`, `readAccountPositions`, `readBorrowersPage`, `readManyAccountSnapshots`, `readHealthFactor`, `readLiquidationConfig`, `readDefaultLtvConfig`, `readTieredLtvConfig`, `readTierLiquidationConfig`, `readLiquidationParamsForPosition`, `readPositionLtvOverride`, `readLtvForPosition`, `readLiquidationBonusBps`, `readManyLiquidationBonusBps`, `previewBorrow`, `previewRepay`, `readBorrowLimits`, `readManyBorrowLimits`, `readHypotheticalBorrowCapacity`, `readLenderSnapshot`, `readMaxWithdraw`, `readMaxRedeem`, `readLiquidatorBasics`, `readCanLiquidate`, `readPreviewLiquidation`, `readCalculateLiquidationBonus`, `readBadDebtStatus`, `readMergeLiquidatorBasics`, `readConvertLiquidatorBasics`, `rankPositionsForLiquidation`, `readLiquidationCandidates`, `readOracleRegistry`, `readOracleRegistryPage`, `readOracleFinalizationStatus`, `readOracleConfig`, `readOracleCollateralStatus`, `readTryGetPrice`, `readOraclePriceData`, `readOracleBasics`, `readOracleTiming`, `readConfiguredPositionIds`, `readNegRiskMarketPositionIds`, `readRiskTier`, `readSpotPrice`, `readTwap`, `readPrice`, `readLiquidity`, `readPositionSnapshot`, `readManyPositionSnapshots`, `readOraclePositionMeta`, `readManyOraclePositionMeta`, `hydrateOraclePositionIds`, `readPoolSnapshot`, `readPoolCaps`, `readPoolAccounting`, `readPoolRates`, `readPoolSharePrice`, `readPoolHealthScore`, `readPoolDebtState`, `readPoolCoreAddress`, `readSystemSnapshot`
+
+**Types:** `StrategyRateParams`, `SimulatedTx`, `MarketConfigItem`, `OraclePriceUpdateItem`, `OracleLikeForSeeding`, `OracleSeedPlan`, `OracleSeedExecResult`, `MarketConfigItemJson`, `OppositePairItemJson`, `NegRiskMarketItemJson`, `SeedOracleFromJsonResult`, `OracleUpdaterRouterUpdate`, `AccessManagerCanCallLike`, `CanCallResult`, `MulticallChunkOptions`, `ReadonlyContract`, `VarlaContracts`, `GetVarlaContractsParams`, `DecodedEvent`, `GetEventLogsChunkedParams`, `OracleRegistryEntry`, `SyncOracleRegistryViaEventsParams`, `GetRecentEventsParams`, `VarlaChainKey`, `StablecoinKind`, `CollateralMeta`, `ChainMeta`, `ChainKey`, `AddressBook`, `ReadAccessManagerBasics`, `ReadManyHasRoleResult`, `ReadManyTargetFunctionRolesResult`, `ReadManyTargetConfigsResult`, `ReadAdapterInfo`, `InterestRateParams`, `ReadAccountSnapshot`, `ReadRepayTiming`, `ReadPositionCount`, `ReadOracleGuardsStatus`, `ReadCoreAddresses`, `ReadMaxPositionsConfig`, `ReadAccountPositionsFull`, `ReadPositionBalances`, `ReadBorrowerState`, `ReadPortfolioValue`, `ReadCoreGlobalDebt`, `ReadPositionLiquidationConfigOverride`, `ReadBorrowersPage`, `ReadHealthFactor`, `ReadLiquidationConfig`, `ReadDefaultLtvConfig`, `ReadTieredLtvConfig`, `ReadTierLiquidationConfig`, `ReadLiquidationParamsForPosition`, `ReadPositionLtvOverride`, `ReadManyLiquidationBonusBpsRow`, `ReadBorrowLimits`, `ReadHypotheticalBorrowCapacity`, `PreviewBorrow`, `PreviewRepay`, `ReadLenderSnapshot`, `ReadLiquidatorBasics`, `ReadCanLiquidate`, `ReadPreviewLiquidation`, `ReadBadDebtStatus`, `LiquidationCandidate`, `ReadLiquidationCandidates`, `ReadOracleRegistryParams`, `ReadOracleRegistryPage`, `ReadOracleConfig`, `ReadOracleFinalizationStatus`, `ReadOracleCollateralStatus`, `ReadTryGetPrice`, `ReadOraclePriceData`, `ReadOracleBasics`, `ReadOracleTiming`, `ReadPositionSnapshot`, `ReadOraclePositionMeta`, `ReadPoolSnapshot`, `ReadPoolDebtState`, `ReadPoolCaps`, `ReadPoolAccounting`, `ReadPoolRates`, `ReadPoolSharePrice`, `ReadPoolHealthScore`, `ReadSystemSnapshot`
+
+**Constants:** `ORACLE_UPDATER_ROUTER_EIP712`, `ORACLE_UPDATER_ROUTER_TYPES`, `UPDATE_TYPEHASH`, `ORACLE_SIGS`, `ORACLE_EVENTS`, `CORE_EVENTS`, `POOL_EVENTS`, `SUPPORTED_CHAINS`
+
+### `@varla/sdk/contracts` (6 functions, 3 types)
+
+**Functions:** `getAddressBook`, `getVarlaContracts`, `getRequiredVarlaContracts`, `getErc20`, `getErc1155`, `getErc4626`
+
+**Types:** `ReadonlyContract`, `VarlaContracts`, `GetVarlaContractsParams`
+
+### `@varla/sdk/views` (85 functions, 57 types)
+
+**Functions:** `readAccessManagerBasics`, `readRoleSummary`, `readTargetConfig`, `readHasRole`, `readManyHasRole`, `readManyTargetFunctionRoles`, `readManyTargetConfigs`, `readAdapterInfo`, `readInterestRateStrategyBasics`, `getInterestRateStrategyFromPool`, `readProxyAdminPaused`, `readRepayTiming`, `readPositionCount`, `readOracleGuardsStatus`, `readAccountSnapshot`, `readCoreAddresses`, `readMaxPositionsConfig`, `readAccountPositionsFull`, `readPositionBalances`, `readBorrowerState`, `readPortfolioValue`, `readBorrowers`, `readCoreGlobalDebt`, `readPositionLiquidationConfigOverride`, `readPositionBalance`, `readAccountPositions`, `readBorrowersPage`, `readManyAccountSnapshots`, `readHealthFactor`, `readLiquidationConfig`, `readDefaultLtvConfig`, `readTieredLtvConfig`, `readTierLiquidationConfig`, `readLiquidationParamsForPosition`, `readPositionLtvOverride`, `readLtvForPosition`, `readLiquidationBonusBps`, `readManyLiquidationBonusBps`, `previewBorrow`, `previewRepay`, `readBorrowLimits`, `readManyBorrowLimits`, `readHypotheticalBorrowCapacity`, `readLenderSnapshot`, `readMaxWithdraw`, `readMaxRedeem`, `readLiquidatorBasics`, `readCanLiquidate`, `readPreviewLiquidation`, `readCalculateLiquidationBonus`, `readBadDebtStatus`, `readMergeLiquidatorBasics`, `readConvertLiquidatorBasics`, `rankPositionsForLiquidation`, `readLiquidationCandidates`, `readOracleRegistry`, `readOracleRegistryPage`, `readOracleFinalizationStatus`, `readOracleConfig`, `readOracleCollateralStatus`, `readTryGetPrice`, `readOraclePriceData`, `readOracleBasics`, `readOracleTiming`, `readConfiguredPositionIds`, `readNegRiskMarketPositionIds`, `readRiskTier`, `readSpotPrice`, `readTwap`, `readPrice`, `readLiquidity`, `readPositionSnapshot`, `readManyPositionSnapshots`, `readOraclePositionMeta`, `readManyOraclePositionMeta`, `hydrateOraclePositionIds`, `readPoolSnapshot`, `readPoolCaps`, `readPoolAccounting`, `readPoolRates`, `readPoolSharePrice`, `readPoolHealthScore`, `readPoolDebtState`, `readPoolCoreAddress`, `readSystemSnapshot`
+
+**Types:** `ReadAccessManagerBasics`, `ReadManyHasRoleResult`, `ReadManyTargetFunctionRolesResult`, `ReadManyTargetConfigsResult`, `ReadAdapterInfo`, `InterestRateParams`, `ReadAccountSnapshot`, `ReadRepayTiming`, `ReadPositionCount`, `ReadOracleGuardsStatus`, `ReadCoreAddresses`, `ReadMaxPositionsConfig`, `ReadAccountPositionsFull`, `ReadPositionBalances`, `ReadBorrowerState`, `ReadPortfolioValue`, `ReadCoreGlobalDebt`, `ReadPositionLiquidationConfigOverride`, `ReadBorrowersPage`, `ReadHealthFactor`, `ReadLiquidationConfig`, `ReadDefaultLtvConfig`, `ReadTieredLtvConfig`, `ReadTierLiquidationConfig`, `ReadLiquidationParamsForPosition`, `ReadPositionLtvOverride`, `ReadManyLiquidationBonusBpsRow`, `ReadBorrowLimits`, `ReadHypotheticalBorrowCapacity`, `PreviewBorrow`, `PreviewRepay`, `ReadLenderSnapshot`, `ReadLiquidatorBasics`, `ReadCanLiquidate`, `ReadPreviewLiquidation`, `ReadBadDebtStatus`, `LiquidationCandidate`, `ReadLiquidationCandidates`, `ReadOracleRegistryParams`, `ReadOracleRegistryPage`, `ReadOracleConfig`, `ReadOracleFinalizationStatus`, `ReadOracleCollateralStatus`, `ReadTryGetPrice`, `ReadOraclePriceData`, `ReadOracleBasics`, `ReadOracleTiming`, `ReadPositionSnapshot`, `ReadOraclePositionMeta`, `ReadPoolSnapshot`, `ReadPoolDebtState`, `ReadPoolCaps`, `ReadPoolAccounting`, `ReadPoolRates`, `ReadPoolSharePrice`, `ReadPoolHealthScore`, `ReadSystemSnapshot`
+
+### `@varla/sdk/actions` (63 functions, 14 types, 4 constants)
+
+**Functions:** `prepareCoreSetDefaultLtvConfig`, `prepareCoreSetLiquidationConfig`, `prepareCoreSetTierLiquidationConfig`, `prepareCoreSetMaxPositions`, `prepareCoreSetMaxPositionsBounds`, `prepareCoreSetOracle`, `prepareCoreSetPositionLtvOverride`, `prepareCoreClearPositionLtvOverride`, `prepareCoreSetPositionLiquidationConfigOverride`, `prepareCoreClearPositionLiquidationConfigOverride`, `preparePoolSetDepositCap`, `preparePoolSetBorrowCap`, `preparePoolWithdrawReserve`, `preparePoolSetInterestRateStrategy`, `prepareOracleSetMaxStaleness`, `prepareOracleSetLiquidationGracePeriod`, `prepareOracleSetDefaultEarlyClosureWindow`, `prepareStrategySetPool`, `prepareStrategySetRateParams`, `prepareOracleUpdaterRouterSetPublisher`, `prepareCoreDeposit`, `prepareCoreWithdraw`, `prepareCoreBorrow`, `prepareCoreRepay`, `prepareErc20Approve`, `prepareErc1155SetApprovalForAll`, `prepareLiquidatorLiquidate`, `prepareLiquidatorLiquidateMulti`, `prepareLiquidatorLiquidateBadDebt`, `prepareLiquidatorResolveBadDebtWithReserve`, `prepareOracleConfigurePositionsBatch`, `prepareOracleConfigurePosition`, `prepareOracleSetUpdater`, `prepareOracleSetPositionEarlyClosureWindowOverride`, `prepareOracleClearPositionEarlyClosureWindowOverride`, `prepareOracleInvalidatePosition`, `prepareOracleValidatePosition`, `prepareOracleRegisterNegRiskMarketPositions`, `prepareOracleOverrideNegRiskMarketPositions`, `prepareOracleConfigureOppositePositions`, `prepareOracleConfigureNegRiskPositionsBatch`, `prepareOracleUpdatePrices`, `prepareOracleUpdatePrice`, `prepareOracleSetResolutionPrice`, `planOracleSeed`, `seedOracleFromJson`, `seedOracleFromJsonFiles`, `prepareOracleSeedPlan`, `executeOracleSeedPlan`, `buildNonce`, `splitNonce`, `toOracleUpdaterRouterTypedMessage`, `computeOracleUpdaterDigest`, `signOracleUpdaterRouterUpdate`, `prepareOracleUpdaterRouterUpdatePricesWithSig`, `preparePoolDeposit`, `preparePoolMint`, `preparePoolWithdraw`, `preparePoolRedeem`, `readCanCall`, `assertCanCallImmediate`, `sendTx`, `selectorFromSignature`
+
+**Types:** `StrategyRateParams`, `SimulatedTx`, `MarketConfigItem`, `OraclePriceUpdateItem`, `OracleLikeForSeeding`, `OracleSeedPlan`, `OracleSeedExecResult`, `MarketConfigItemJson`, `OppositePairItemJson`, `NegRiskMarketItemJson`, `SeedOracleFromJsonResult`, `OracleUpdaterRouterUpdate`, `AccessManagerCanCallLike`, `CanCallResult`
+
+**Constants:** `ORACLE_UPDATER_ROUTER_EIP712`, `ORACLE_UPDATER_ROUTER_TYPES`, `UPDATE_TYPEHASH`, `ORACLE_SIGS`
+
+### `@varla/sdk/events` (4 functions, 5 types, 3 constants)
+
+**Functions:** `decodeEventLogs`, `getEventLogsChunked`, `syncOracleRegistryViaEvents`, `getRecentEvents`
+
+**Types:** `DecodedEvent`, `GetEventLogsChunkedParams`, `OracleRegistryEntry`, `SyncOracleRegistryViaEventsParams`, `GetRecentEventsParams`
+
+**Constants:** `ORACLE_EVENTS`, `CORE_EVENTS`, `POOL_EVENTS`
+
+### `@varla/sdk/addresses` (2 constants)
+
+**Constants:** `polygon`, `bsc`
+
+### `@varla/sdk/types` (2 types)
+
+**Types:** `ChainKey`, `AddressBook`
+
+### `@varla/sdk/batch` (2 functions, 1 types)
+
+**Functions:** `chunk`, `multicallChunks`
+
+**Types:** `MulticallChunkOptions`
+
+### `@varla/sdk/format` (5 functions)
+
+**Functions:** `formatWad`, `formatBps`, `formatPriceE8`, `parseUnits`, `parseWad`
+
+### `@varla/sdk/errors` (7 functions, 1 types)
+
+**Functions:** `extractRevertData`, `decodeVarlaError`, `isVarlaError`, `formatVarlaError`, `tryFormatVarlaError`, `getAllVarlaErrorNames`, `getVarlaErrorSelectors`
+
+**Types:** `DecodedVarlaError`
+<!-- END GENERATED:EXPORTS -->

package/CHANGELOG.md

@@ -0,0 +1,367 @@
+# @varla-xyz/protocol
+
+## 1.14.0
+
+### Minor Changes
+
+- b201336: Add liquidation candidate ranking utilities and enrich liquidator views while updating the VarlaLiquidator ABI errors.
+
+  - add LiquidationCandidate types plus rankPositionsForLiquidation and readLiquidationCandidates helpers to fetch and sort liquidation targets,- update VarlaLiquidator ABI error names and include TooManyPositionIds for multi-position limits
+
+## 1.13.2
+
+### Patch Changes
+
+- 68344dc: Updated the unsupported chain error message wording in the SDK metadata helper.
+
+  - Adjusted the error text thrown by `assertSupportedChain` to improve clarity.
+
+## 1.13.1
+
+### Patch Changes
+
+- e88e5c3: Adjusted the unsupported chain error message format in assertSupportedChain.
+
+  - Update the error string to use a comma-separated phrasing for unsupported chain validation.
+
+## 1.13.0
+
+### Minor Changes
+
+- 8b15fe4: Added a new assertSupportedChain helper to validate supported chain keys with descriptive errors.
+
+  - Exported assertSupportedChain to throw a clear error when an unsupported chain key is provided.
+
+## 1.12.0
+
+### Minor Changes
+
+- a820ddc: Add supported chain constants and a type guard to the SDK metadata API.
+
+  - Expose SUPPORTED_CHAINS and isSupportedChain for checking valid chain keys
+
+## 1.11.8
+
+### Patch Changes
+
+- d4c9c9c: Reordered exports and import statements across the SDK for consistency without changing functionality.
+
+  - Reorganized module export ordering in actions, events, views, and leverage indices
+  - Cleaned up import ordering and formatting in several SDK files
+
+## 1.11.7
+
+### Patch Changes
+
+- 09f85ca: - Update SDK documentation files (README, AGENTS, BACKEND, FRONTEND)
+  - Adjust SDK tests in errors.unit.test.ts and generated views.referenced tests
+  - Minor configuration tweaks in package.json and tsconfig.json
+
+## 1.11.6
+
+### Patch Changes
+
+- 14f5de7: - feat(sdk): add deleverage execution and planning helpers
+  - feat(sdk): add leverage loop planning and execution utilities
+  - update leverage planning/types and adjust execute/index exports
+  - expand leverage and generated view test coverage
+
+## 1.11.5
+
+### Patch Changes
+
+- 2bdbab0: - add new leverage module utilities (execute, math, plan, types, and index)
+  - add extensive leverage unit tests covering edge cases, invariants, and math
+  - update sdk package.json for leverage additions
+
+## 1.11.4
+
+### Patch Changes
+
+- 1707039: - Refactor tokenomics funding flow to use distributor account
+  - Adjust core SDK views implementation in `packages/sdk/src/views/core.ts`
+  - Update and expand core and multicall view tests
+
+## 1.11.3
+
+### Patch Changes
+
+- 624a11d: - update SDK generated view reference test (`packages/sdk/test/generated/views.referenced.test.ts`)
+  - docs: align protocol docs with VarlaCore custody and risk model
+
+## 1.11.2
+
+### Patch Changes
+
+- 748ae7c: - add/update SDK documentation in AGENTS.md and FRONTEND.md
+  - tweak generated views referenced test (packages/sdk/test/generated/views.referenced.test.ts)
+  - include SDK release commit "chore(release): sdk v1.11.1"
+
+## 1.11.1
+
+### Patch Changes
+
+- 5e4af32: - feat(sdk): add oracle finalization status view
+  - feat: add early oracle resolution and ops tooling
+  - update SDK views (core, lenders, pool, index) and README
+  - expand SDK tests for views and RPCs (exports, referenced, bsc, polygon)
+
+## 1.11.0
+
+### Minor Changes
+
+- BSC deployments and updates:
+  - Added OracleUpdaterRouter deployment
+  - Updated Varla contracts (core, pool, oracle, liquidators, access manager, proxy admin)
+  - Updated OpinionCtfExecutionEngineAdapter deployment
+  - Added new BSC solc input artifacts for deployments
+
+## 1.10.14
+
+### Patch Changes
+
+- c17e34a: Updated oracle view utilities in `packages/sdk/src/views/oracle.ts` and expanded oracle view logic by 18 lines.
+
+## 1.10.13
+
+### Patch Changes
+
+- Updated `deployments/.touch` and included the CI release routing commit.
+- 7240619:
+  - Export `OracleUpdaterRouter` ABI via `generated.abis`.
+  - Export `OracleUpdaterRouter` action helpers via `@varla/sdk/actions`.
+  - Add `oracleUpdaterRouter` to `getVarlaContracts` / `getRequiredVarlaContracts`.
+  - Add admin helper to manage router publishers.
+
+## 1.10.12
+
+### Patch Changes
+
+- 6873b37:
+  - docs(sdk): add frontend integration guide
+  - feat(sdk): add action helpers and core view reads
+  - feat(sdk): add oracle seed helpers, JSON seeding, and RBAC/signature utilities
+  - Updated packaged SDK artifact (packages/sdk/varla-sdk-1.0.1.tgz)
+
+## 1.10.11
+
+### Patch Changes
+
+- Add frontend integration guide (`packages/sdk/FRONTEND.md`)
+- Update SDK README with integration info (`packages/sdk/README.md`)
+- Adjust SDK package metadata/version (`packages/sdk/package.json`)
+- Update generated views test snapshot (`packages/sdk/test/generated/views.referenced.test.ts`)
+
+## 1.10.10
+
+### Patch Changes
+
+- Update generated SDK view reference test expectations.
+  - Touch `packages/sdk/test/generated/views.referenced.test.ts`.
+
+## 1.10.9
+
+### Patch Changes
+
+- cd6a0d3:
+  - sdk: add oracle seed helpers, selector/JSON seeding, and execution/RBAC signature helpers
+  - sdk: add pool, liquidator, and admin write helpers
+  - tests: add oracle seed RBAC coverage for Anvil
+  - docs: update SDK README and actions admin/oracle modules
+
+## 1.10.8
+
+### Patch Changes
+
+- test(sdk): add oracle seed RBAC anvil coverage
+  - update anvil tests for `oracle.seed.rbac` and `write.local`
+  - adjust generated views referenced by tests
+
+## 1.10.7
+
+### Patch Changes
+
+- - feat(sdk): add pool, liquidator, and admin write helpers
+  - update actions index and SDK docs
+  - expand SDK tests for actions and local anvil writes
+
+## 1.10.6
+
+### Patch Changes
+
+- - feat(sdk): add oracle seed execution and RBAC signature helpers
+  - add JSON seeding and oracle seed helper utilities to SDK actions
+  - update SDK tests and README for the new helpers
+
+## 1.10.5
+
+### Patch Changes
+
+- 29f54e7: feat(sdk): add action helpers and core view reads
+  - add oracle action helpers and utilities in `packages/sdk/src/actions/*`
+  - add unit tests in `packages/sdk/test/actions/actions.unit.test.ts`
+
+## 1.10.4
+
+### Patch Changes
+
+- Added SDK action helpers across core, erc20, erc1155, oracle, rbac, and tx modules.
+  - Added core view read helpers, including repay timing and guard-related reads.
+  - Expanded SDK exports and tests to cover new actions and views.
+
+## 1.10.3
+
+### Patch Changes
+
+- Updated BSC deployment artifacts for Varla contracts (core, pool, oracle, liquidators, access manager, proxy admin), refreshed OpinionCtfExecutionEngineAdapter deployment data, and adjusted related BSC solc input artifacts.
+
+## 1.10.2
+
+### Patch Changes
+
+- Updated deployment artifacts for multiple Varla contracts on BSC.
+- Updated deployment artifacts for multiple Varla contracts on Polygon.
+- Adjusted solc input snapshots for BSC and Polygon deployments.
+
+## 1.10.1
+
+### Patch Changes
+
+- Add borrow/repay preview helpers to core views.
+- Add liquidation-related helpers to liquidator views.
+- Add unit tests for the new core and liquidator view helpers.
+
+## 1.10.0
+
+### Minor Changes
+
+- Add SDK view helpers:
+  - Core/oracle/pool helpers
+  - Borrow limit and pool rate helpers
+  - Paging for oracle registry and borrowers
+  - Oracle position metadata and system snapshot helpers
+
+## 1.9.0
+
+### Minor Changes
+
+- Added core/oracle/pool view helper APIs:
+  - Borrow limit and pool rate helpers
+  - Paging helpers for oracle registry and borrowers
+  - Oracle position metadata and system snapshot support
+
+## 1.8.0
+
+### Minor Changes
+
+- Updated SDK changelog for recent releases.
+- Adjusted package version metadata.
+- Made a minor documentation tweak in `AGENTS.md`.
+
+## 1.7.0
+
+### Minor Changes
+
+- Added SDK view helpers for core/oracle/pool data, borrow limits, and pool rates.
+- Added paging helpers for the oracle registry/borrowers and oracle position meta/system snapshots.
+- Updated SDK docs, changelog, and package metadata.
+
+## 1.6.0
+
+### Minor Changes
+
+- Bump `@varla/sdk` and update package metadata
+  - Update SDK changelog entries
+  - Refresh AGENTS documentation
+
+## 1.5.0
+
+### Minor Changes
+
+- Added SDK view/helper APIs for core/oracle/pool, including borrow limits, pool rates, and curated views
+  - Added paging helpers for oracle registry/borrowers and oracle position meta/system snapshot helpers
+  - Added multicall grid/formatting utilities and access manager + liquidation/LTV helpers
+  - Improved test coverage for multicall failure paths and strict helper reference checks
+
+## 1.4.0
+
+### Minor Changes
+
+- Updated SDK docs (README/AGENTS) and changelog
+  - Refreshed VarlaCore ABI definitions
+  - Adjusted generated views test reference
+
+## 1.3.0
+
+### Minor Changes
+
+- - Added new core and oracle view helper utilities in the SDK.
+  - Expanded and validated view exports with additional generated tests.
+  - Added RPC and unit test coverage for core/oracle views.
+
+## 1.2.1
+
+### Patch Changes
+
+- d26aa01: sdk: add oracle position metadata and system snapshot
+- 385745c: sdk: add oracle/core paging helpers
+
+## 1.2.0
+
+### Minor Changes
+
+- 65129cb: sdk: expanded view helpers + tests
+
+## 1.1.1
+
+### Patch Changes
+
+- 6d1298e: test: speed up SDK test suite by switching oracle registry sync to fixtures by default, adding an env-gated slow RPC test, and adding an ABI coverage smoke test.
+
+## 1.1.0
+
+### Minor Changes
+
+- ## SDK: read-only views, batching, and indexer helpers
+
+  ### Added
+
+  - Read-only viem contract bindings + helpers (`getVarlaContracts`, `getRequiredVarlaContracts`).
+  - High-level read facades for Core/Pool/Oracle (account snapshot/positions, pool snapshot, oracle registry).
+  - Multicall batching utilities (`multicallChunks`) to make frontend reads RPC-efficient.
+  - Adapter read facade (`readAdapterInfo`) for Polymarket + Opinion adapters.
+  - Event/indexer helpers:
+    - chunked event log fetching
+    - `syncOracleRegistryViaEvents()` (event-driven discovery + multicall hydration)
+
+  ### Testing
+
+  - Expanded RPC-backed tests (Polygon + BSC) and added Bun typechecking for tests.
+
+## 1.0.1
+
+### Patch Changes
+
+- bf48696: bump sdk version
+
+## 1.0.0
+
+### Major Changes
+
+- 1f05548: First stable protocol package release.
+
+  - Publishes Polygon + BSC deployments addressbooks
+  - Publishes canonical ABIs
+
+### Patch Changes
+
+- 9f411bf: trigger NPM publish
+
+## 1.0.0
+
+### Major Changes
+
+- 1f05548: First stable protocol package release.
+
+  - Publishes Polygon + BSC deployments addressbooks
+  - Publishes canonical ABIs

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Varla Labs Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.