Skip to content

FLO-20: eliminate per-position capability controller bloat #247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
holyfuchs wants to merge 1 commit into
base: main
Choose a base branch
from
Open

FLO-20: eliminate per-position capability controller bloat #247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ coverage.json
/.pr-body.md
/.github/pr_bodies/
lcov.info
.flow-fork-cache
93 changes: 41 additions & 52 deletions cadence/contracts/FlowALPPositionResources.cdc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,19 @@ import "FlowALPModels"

access(all) contract FlowALPPositionResources {

/// A single authorized Capability to the Pool, shared across all Position resources.
/// Issued once at pool creation time to avoid per-position capability controller bloat.
access(self) var poolCap: Capability<auth(FlowALPModels.EPosition) &{FlowALPModels.PositionPool}>?

/// Sets the contract-level pool capability. Called once by FlowALPv0 when the Pool is created.
access(account) fun setPoolCap(cap: Capability<auth(FlowALPModels.EPosition) &{FlowALPModels.PositionPool}>) {
FlowALPPositionResources.poolCap = cap
}

access(self) fun borrowPool(): auth(FlowALPModels.EPosition) &{FlowALPModels.PositionPool} {
return self.poolCap!.borrow()!
}

/// Position
///
/// A Position is a resource representing ownership of value deposited to the protocol.
Expand All @@ -23,24 +36,13 @@ access(all) contract FlowALPPositionResources {
/// The unique ID of the Position used to track deposits and withdrawals to the Pool
access(all) let id: UInt64

/// An authorized Capability to the Pool for which this Position was opened.
access(self) let pool: Capability<auth(FlowALPModels.EPosition) &{FlowALPModels.PositionPool}>

init(
id: UInt64,
pool: Capability<auth(FlowALPModels.EPosition) &{FlowALPModels.PositionPool}>
) {
pre {
pool.check():
"Invalid Pool Capability provided - cannot construct Position"
}
init(id: UInt64) {
self.id = id
self.pool = pool
}

/// Returns the balances (both positive and negative) for all tokens in this position.
access(all) fun getBalances(): [FlowALPModels.PositionBalance] {
let pool = self.pool.borrow()!
let pool = FlowALPPositionResources.borrowPool()
return pool.getPositionDetails(pid: self.id).balances
}

Expand All @@ -49,54 +51,54 @@ access(all) contract FlowALPPositionResources {
/// below its min health. If pullFromTopUpSource is false, the calculation will return the balance currently
/// available without topping up the position.
access(all) fun availableBalance(type: Type, pullFromTopUpSource: Bool): UFix64 {
let pool = self.pool.borrow()!
let pool = FlowALPPositionResources.borrowPool()
return pool.availableBalance(pid: self.id, type: type, pullFromTopUpSource: pullFromTopUpSource)
}

/// Returns the current health of the position
access(all) fun getHealth(): UFix128 {
let pool = self.pool.borrow()!
let pool = FlowALPPositionResources.borrowPool()
return pool.positionHealth(pid: self.id)
}

/// Returns the Position's target health (unitless ratio ≥ 1.0)
access(all) fun getTargetHealth(): UFix64 {
let pool = self.pool.borrow()!
let pool = FlowALPPositionResources.borrowPool()
let pos = pool.borrowPosition(pid: self.id)
return FlowALPMath.toUFix64Round(pos.getTargetHealth())
}

/// Sets the target health of the Position
access(FlowALPModels.EPositionAdmin) fun setTargetHealth(targetHealth: UFix64) {
let pool = self.pool.borrow()!
let pool = FlowALPPositionResources.borrowPool()
let pos = pool.borrowPosition(pid: self.id)
pos.setTargetHealth(UFix128(targetHealth))
}

/// Returns the minimum health of the Position
access(all) fun getMinHealth(): UFix64 {
let pool = self.pool.borrow()!
let pool = FlowALPPositionResources.borrowPool()
let pos = pool.borrowPosition(pid: self.id)
return FlowALPMath.toUFix64Round(pos.getMinHealth())
}

/// Sets the minimum health of the Position
access(FlowALPModels.EPositionAdmin) fun setMinHealth(minHealth: UFix64) {
let pool = self.pool.borrow()!
let pool = FlowALPPositionResources.borrowPool()
let pos = pool.borrowPosition(pid: self.id)
pos.setMinHealth(UFix128(minHealth))
}

/// Returns the maximum health of the Position
access(all) fun getMaxHealth(): UFix64 {
let pool = self.pool.borrow()!
let pool = FlowALPPositionResources.borrowPool()
let pos = pool.borrowPosition(pid: self.id)
return FlowALPMath.toUFix64Round(pos.getMaxHealth())
}

/// Sets the maximum health of the position
access(FlowALPModels.EPositionAdmin) fun setMaxHealth(maxHealth: UFix64) {
let pool = self.pool.borrow()!
let pool = FlowALPPositionResources.borrowPool()
let pos = pool.borrowPosition(pid: self.id)
pos.setMaxHealth(UFix128(maxHealth))
}
Expand All @@ -123,7 +125,7 @@ access(all) contract FlowALPPositionResources {
from: @{FungibleToken.Vault},
pushToDrawDownSink: Bool
) {
let pool = self.pool.borrow()!
let pool = FlowALPPositionResources.borrowPool()
pool.depositAndPush(
pid: self.id,
from: <-from,
Expand All @@ -148,7 +150,7 @@ access(all) contract FlowALPPositionResources {
amount: UFix64,
pullFromTopUpSource: Bool
): @{FungibleToken.Vault} {
let pool = self.pool.borrow()!
let pool = FlowALPPositionResources.borrowPool()
return <- pool.withdrawAndPull(
pid: self.id,
type: type,
Expand Down Expand Up @@ -179,10 +181,8 @@ access(all) contract FlowALPPositionResources {
type: Type,
pushToDrawDownSink: Bool
): {DeFiActions.Sink} {
let pool = self.pool.borrow()!
return PositionSink(
id: self.id,
pool: self.pool,
type: type,
pushToDrawDownSink: pushToDrawDownSink
)
Expand Down Expand Up @@ -210,10 +210,8 @@ access(all) contract FlowALPPositionResources {
type: Type,
pullFromTopUpSource: Bool
): {DeFiActions.Source} {
let pool = self.pool.borrow()!
return PositionSource(
id: self.id,
pool: self.pool,
type: type,
pullFromTopUpSource: pullFromTopUpSource
)
Expand All @@ -230,7 +228,7 @@ access(all) contract FlowALPPositionResources {
///
/// Pass nil to configure the position to not push tokens when the Position exceeds its maximum health.
access(FlowALPModels.EPositionAdmin) fun provideSink(sink: {DeFiActions.Sink}?) {
let pool = self.pool.borrow()!
let pool = FlowALPPositionResources.borrowPool()
pool.lockPosition(self.id)
let pos = pool.borrowPosition(pid: self.id)
pos.setDrawDownSink(sink)
Expand All @@ -246,7 +244,7 @@ access(all) contract FlowALPPositionResources {
///
/// Pass nil to configure the position to not pull tokens.
access(FlowALPModels.EPositionAdmin) fun provideSource(source: {DeFiActions.Source}?) {
let pool = self.pool.borrow()!
let pool = FlowALPPositionResources.borrowPool()
pool.lockPosition(self.id)
let pos = pool.borrowPosition(pid: self.id)
pos.setTopUpSource(source)
Expand All @@ -262,7 +260,7 @@ access(all) contract FlowALPPositionResources {
/// of either cannot accept/provide sufficient funds for rebalancing, the rebalance will still occur but will
/// not cause the position to reach its target health.
access(FlowALPModels.EPosition | FlowALPModels.ERebalance) fun rebalance(force: Bool) {
let pool = self.pool.borrow()!
let pool = FlowALPPositionResources.borrowPool()
pool.rebalancePosition(pid: self.id, force: force)
}
}
Expand Down Expand Up @@ -320,11 +318,8 @@ access(all) contract FlowALPPositionResources {

/// Creates and returns a new Position resource.
/// This remains account-scoped so only the protocol account can mint canonical wrappers.
access(account) fun createPosition(
id: UInt64,
pool: Capability<auth(FlowALPModels.EPosition) &{FlowALPModels.PositionPool}>
): @Position {
return <- create Position(id: id, pool: pool)
access(account) fun createPosition(id: UInt64): @Position {
return <- create Position(id: id)
}

/// Creates and returns a new PositionManager resource
Expand All @@ -342,9 +337,6 @@ access(all) contract FlowALPPositionResources {
/// An optional DeFiActions.UniqueIdentifier that identifies this Sink with the DeFiActions stack its a part of
access(contract) var uniqueID: DeFiActions.UniqueIdentifier?

/// An authorized Capability on the Pool for which the related Position is in
access(self) let pool: Capability<auth(FlowALPModels.EPosition) &{FlowALPModels.PositionPool}>

/// The ID of the position in the Pool
access(self) let positionID: UInt64

Expand All @@ -357,13 +349,11 @@ access(all) contract FlowALPPositionResources {

init(
id: UInt64,
pool: Capability<auth(FlowALPModels.EPosition) &{FlowALPModels.PositionPool}>,
type: Type,
pushToDrawDownSink: Bool
) {
self.uniqueID = nil
self.positionID = id
self.pool = pool
self.type = type
self.pushToDrawDownSink = pushToDrawDownSink
}
Expand All @@ -375,13 +365,13 @@ access(all) contract FlowALPPositionResources {

/// Returns the minimum capacity this Sink can accept as deposits
access(all) fun minimumCapacity(): UFix64 {
return self.pool.check() ? UFix64.max : 0.0
return FlowALPPositionResources.poolCap?.check() ?? false ? UFix64.max : 0.0
}

/// Deposits the funds from the provided Vault reference to the related Position
access(all) fun depositCapacity(from: auth(FungibleToken.Withdraw) &{FungibleToken.Vault}) {
if let pool = self.pool.borrow() {
pool.depositAndPush(
if let pool = FlowALPPositionResources.poolCap?.borrow() {
Copy link
Member

@jordanschalm jordanschalm Mar 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kind of weird that this doesn't bind the non-nil pool value inside the conditional block. I guess because there is an optional operation on poolCap first. Almost seems like a Cadence bug, though -- I feel like the if..let statement should only consider the value assigned to pool.

Copy link
Member

@jordanschalm jordanschalm Mar 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://flow-foundation.slack.com/archives/C07RZKJH679/p1773332138529409

pool!.depositAndPush(
pid: self.positionID,
from: <-from.withdraw(amount: from.balance),
pushToDrawDownSink: self.pushToDrawDownSink
Expand Down Expand Up @@ -416,9 +406,6 @@ access(all) contract FlowALPPositionResources {
/// An optional DeFiActions.UniqueIdentifier that identifies this Sink with the DeFiActions stack its a part of
access(contract) var uniqueID: DeFiActions.UniqueIdentifier?

/// An authorized Capability on the Pool for which the related Position is in
access(self) let pool: Capability<auth(FlowALPModels.EPosition) &{FlowALPModels.PositionPool}>

/// The ID of the position in the Pool
access(self) let positionID: UInt64

Expand All @@ -431,13 +418,11 @@ access(all) contract FlowALPPositionResources {

init(
id: UInt64,
pool: Capability<auth(FlowALPModels.EPosition) &{FlowALPModels.PositionPool}>,
type: Type,
pullFromTopUpSource: Bool
) {
self.uniqueID = nil
self.positionID = id
self.pool = pool
self.type = type
self.pullFromTopUpSource = pullFromTopUpSource
}
Expand All @@ -449,11 +434,11 @@ access(all) contract FlowALPPositionResources {

/// Returns the minimum available this Source can provide on withdrawal
access(all) fun minimumAvailable(): UFix64 {
if !self.pool.check() {
if FlowALPPositionResources.poolCap?.check() != true {
return 0.0
}

let pool = self.pool.borrow()!
let pool = FlowALPPositionResources.borrowPool()
return pool.availableBalance(
pid: self.positionID,
type: self.type,
Expand All @@ -463,11 +448,11 @@ access(all) contract FlowALPPositionResources {

/// Withdraws up to the max amount as the sourceType Vault
access(FungibleToken.Withdraw) fun withdrawAvailable(maxAmount: UFix64): @{FungibleToken.Vault} {
if !self.pool.check() {
if FlowALPPositionResources.poolCap?.check() != true {
return <- DeFiActionsUtils.getEmptyVault(self.type)
}

let pool = self.pool.borrow()!
let pool = FlowALPPositionResources.borrowPool()
let available = pool.availableBalance(
pid: self.positionID,
type: self.type,
Expand Down Expand Up @@ -503,4 +488,8 @@ access(all) contract FlowALPPositionResources {
self.uniqueID = id
}
}

init() {
self.poolCap = nil
}
}
Loading
Loading