[DRAFT] Extract ALP components into separate contracts by jordanschalm · Pull Request #160 · onflow/FlowALP

jordanschalm · 2026-02-12T19:02:11Z

This PR refactors ALP types and state fields. The PR is not ready for detailed review, but is ready for feedback on the high-level approach.

The goal is to:

Use interface types to store state to enable future upgrades (see pattern in https://github.com/jordanschalm/cadence-interface-upgrade-pattern)
Reduce the size of the main FlowALPv1 contract by moving code into separate contracts and removing duplicated functionality

Changes

Move InterestCurve interface, FixedRateInterestCurve, and KinkInterestCurve from FlowALPv1 into a new standalone FlowALPRateCurves contract
Move Pool config/state into a separate contract FlowALPModels
Remove where possible thin wrapper functions in FlowALPv1. For example, governance transactions that change config can share a Pool.borrowConfig function, rather than Pool defining setters itself
Moved some math functions to FlowALPMath. In this PR we decided to retain the separate Math contract. Given that, I think it makes sense to delegate pure math-related functions into that contract.

Comments

Events are currently split between FlowALP and FlowALPModels. (You can only emit an event in the contract in which it is defined.) I think all events should be consolidated in one place. I am thinking of moving all events to FlowALPModels and having access(account) fun emitEvent functions for them.
TokenState was moved over to FlowALPModels, but is not interface-typed. May want to apply that pattern to make its fields upgradeable as well.
May want to move other models to FlowALPModels
Revisit whether EImplementation is useful. If it is, apply and use it consistently.

Move InterestCurve interface, FixedRateInterestCurve, and KinkInterestCurve from FlowALPv1 into a new standalone FlowALPRateCurves contract to improve modularity and allow rate curve types to be reused independently. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

…rve to FixedCurve, KinkInterestCurve to KinkCurve Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Move 9 pool config fields (priceOracle, collateralFactor, borrowFactor, positionsProcessedPerCallback, liquidationTargetHF, warmupSec, lastUnpausedAt, dex, dexOracleDeviationBps) into a PoolConfigImpl struct in a new FlowALPModels contract, centralizing config validation logic. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Replace pure-delegation Pool wrapper functions (setDexOracleDeviationBps, setDEX) with a single borrowConfig() function that returns a mutable reference to the pool's PoolConfig. Callers can now invoke config setters directly. Wrapper functions with events/side effects are preserved. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Move TokenState struct and EImplementation entitlement to FlowALPModels. Create PoolStateImpl resource in FlowALPModels to hold Pool's movable state fields (globalLedger, reserves, insuranceFund, etc.). Move pure utility functions (perSecondInterestRate, compoundInterestIndex, dexOraclePriceDeviationInRange) to FlowALPMath, keeping thin wrappers in FlowALPv1 for backwards compatibility. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Pool.state is now typed as @{FlowALPModels.PoolState} instead of the concrete @FlowALPModels.PoolStateImpl, matching the PoolConfig/PoolConfigImpl pattern and allowing the implementation to be swapped in future upgrades. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

These are configuration fields, not state fields. Moving them to PoolConfig with getter/setter methods ensures they are upgradeable. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

All fields on the PoolState interface are now accessed through getter/setter methods rather than direct field access. This ensures the interface is upgradeable - fields cannot be changed in interface upgrades, but function signatures can evolve. Also fixes a test that relied on dictionary key ordering for position balances. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

These functions interact with pool-level state (reserves, insurance fund) and are better suited as Pool methods that accept a TokenState reference. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Base supported token logic on collateralFactor dictionary keys in PoolConfig rather than globalLedger keys in PoolState. Pool methods now delegate to config. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

- Move _borrowOrCreateReserveVault to PoolState as borrowOrCreateReserve - Move _getSwapperForLiquidation to PoolConfig as getSwapperForLiquidation - Remove setLiquidationParams, setPauseParams, pausePool wrappers - Remove setDebugLogging wrapper (callers use borrowConfig() directly) - Remove unused events: LiquidationParamsUpdated, PauseParamsUpdated, PoolPaused - Update transactions to use borrowConfig() for pause and debug logging Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

jordanschalm · 2026-02-13T19:22:35Z

cadence/contracts/FlowALPv1.cdc

@@ -1735,22 +999,11 @@ access(all) contract FlowALPv1 {

        /// Returns a reference to the reserve vault for the given type, if the token type is supported.
        /// If no reserve vault exists yet, and the token type is supported, the reserve vault is created.
-        access(self) fun _borrowOrCreateReserveVault(type: Type): &{FungibleToken.Vault} {


Didn't move docs over when refactoring

jordanschalm · 2026-02-13T19:23:07Z

cadence/contracts/FlowALPv1.cdc

@@ -1996,13 +1249,6 @@ access(all) contract FlowALPv1 {
        /// - No swapper is configured for the given token pair (seizeType -> debtType)
        ///
        /// @param seizeType: The collateral token type to swap from
-        /// @param debtType: The debt token type to swap to


didn't move docs

jordanschalm · 2026-02-13T19:26:50Z

cadence/contracts/FlowALPv1.cdc

-        let diffPct: UFix64 = dexPrice < oraclePrice ? diff / dexPrice : diff / oraclePrice
-        let diffBps = UInt16(diffPct * 10_000.0)
-        return diffBps <= maxDeviationBps
+        return FlowALPMath.dexOraclePriceDeviationInRange(dexPrice: dexPrice, oraclePrice: oraclePrice, maxDeviationBps: maxDeviationBps)


fix this duplication

bluesign · 2026-02-14T13:56:18Z

I did something similar, MVC pattern ( like https://github.com/jordanschalm/cadence-interface-upgrade-pattern)

I took a different approach ( used attachments basically ) and state code is generated. ( just pushed maybe inspires something: https://github.com/bluesign/upgradeable

Also my old splitting attempt on credit market ( https://github.com/bluesign/fcm-core/tree/master/cadence/contracts ) ( not using the upgradeable but similar ideas )

joshuahannan

Really good changes! I think you're on the right track

joshuahannan · 2026-02-17T16:03:57Z

cadence/contracts/FlowALPInterestRates.cdc

+            self.yearlyRate = yearlyRate
+        }
+
+        access(all) fun interestRate(creditBalance: UFix128, debitBalance: UFix128): UFix128 {


what are the parameters here for?

See https://github.com/onflow/FlowALP/pull/160/changes/BASE..dc21efb1e2fefca3fd6435033e721c0b468b9f97#diff-b68530c0b2e0dcf9d373ec5938f2b1f6222bb11bfb19e8dc333bcae7e48e9e35R10-R11.

(I'm trying to mainly move existing code and not add anything right now to keep the diff clean, but agree there should be documentation here.)

joshuahannan · 2026-02-17T16:05:24Z

cadence/contracts/FlowALPInterestRates.cdc

+        access(all) let baseRate: UFix128
+
+        /// The slope of the interest curve before the optimal point (gentle slope)
+        access(all) let slope1: UFix128


should these be called gentleSlope and steepSlope instead?

joshuahannan · 2026-02-17T16:06:59Z

cadence/contracts/FlowALPModels.cdc

+    ///
+    /// This entitlement is used internally by the protocol to maintain state consistency
+    /// and process queued operations. It should not be granted to external users.
+    access(all) entitlement EImplementation


I don't like using E for entitlement names. I think it should just be Implementation, or something else. Typically we use verbs and sometimes nouns

joshuahannan · 2026-02-17T16:09:00Z

cadence/contracts/FlowALPModels.cdc

+        access(all) fun setPriceOracle(_ newOracle: {DeFiActions.PriceOracle}, defaultToken: Type)
+        access(all) fun setCollateralFactor(tokenType: Type, factor: UFix64)
+        access(all) fun setBorrowFactor(tokenType: Type, factor: UFix64)
+        access(all) fun setPositionsProcessedPerCallback(_ count: UInt64)
+        access(all) fun setLiquidationTargetHF(_ targetHF: UFix128)
+        access(all) fun setWarmupSec(_ warmupSec: UInt64)
+        access(all) fun setLastUnpausedAt(_ time: UInt64?)
+        access(all) fun setDex(_ dex: {DeFiActions.SwapperProvider})
+        access(all) fun setDexOracleDeviationBps(_ bps: UInt16)
+        access(all) fun setPaused(_ paused: Bool)
+        access(all) fun setDebugLogging(_ enabled: Bool)


Is it safe to make all these access(all)? Should they be access(contract) or access(account) instead just to be safe?

joshuahannan

I just realized that we should do this for the auto balancer RecurringConfig also

jordanschalm and others added 6 commits February 12, 2026 10:37

Rename FlowALPRateCurves to FlowALPInterestRates, FixedRateInterestCu…

4495f56

…rve to FixedCurve, KinkInterestCurve to KinkCurve Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

split pool config/state

0e0971f

jordanschalm changed the title ~~[DRAFT] Extract InterestCurve types into FlowALPRateCurves contract~~ [DRAFT] Extract ALP components into separate contracts Feb 13, 2026

jordanschalm and others added 6 commits February 13, 2026 09:38

Move debugLogging and paused from PoolState to PoolConfig

959f911

These are configuration fields, not state fields. Moving them to PoolConfig with getter/setter methods ensures they are upgradeable. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Move collectInsurance and collectStability from TokenState to Pool

9608242

These functions interact with pool-level state (reserves, insurance fund) and are better suited as Pool methods that accept a TokenState reference. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Move getSupportedTokens and isTokenSupported to PoolConfig

0b642e0

Base supported token logic on collateralFactor dictionary keys in PoolConfig rather than globalLedger keys in PoolState. Pool methods now delegate to config. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

jordanschalm commented Feb 13, 2026

View reviewed changes

jordanschalm requested review from joshuahannan, liobrasil and nialexsan February 13, 2026 21:15

joshuahannan reviewed Feb 17, 2026

View reviewed changes

jordanschalm mentioned this pull request Feb 17, 2026

Explore options to improve future upgradeability #166

Open

joshuahannan reviewed Feb 17, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DRAFT] Extract ALP components into separate contracts#160

[DRAFT] Extract ALP components into separate contracts#160
jordanschalm wants to merge 12 commits intomainfrom
jord/split-contracts

jordanschalm commented Feb 12, 2026 •

edited

Loading

Uh oh!

jordanschalm Feb 13, 2026

Uh oh!

jordanschalm Feb 13, 2026

Uh oh!

jordanschalm Feb 13, 2026

Uh oh!

bluesign commented Feb 14, 2026 •

edited

Loading

Uh oh!

joshuahannan left a comment

Uh oh!

joshuahannan Feb 17, 2026

Uh oh!

jordanschalm Feb 17, 2026

Uh oh!

joshuahannan Feb 17, 2026

Uh oh!

joshuahannan Feb 17, 2026

Uh oh!

joshuahannan Feb 17, 2026

Uh oh!

joshuahannan left a comment •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

jordanschalm commented Feb 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Comments

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bluesign commented Feb 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

joshuahannan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joshuahannan left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jordanschalm commented Feb 12, 2026 •

edited

Loading

bluesign commented Feb 14, 2026 •

edited

Loading

joshuahannan left a comment •

edited

Loading