Skip to content

Commit b21e8c5

Browse files
authored
Merge pull request #100 from SundaeSwap-finance/permissioned-audit/spp-301
SPP-301 Missing inline documentation for new fields in pool datum
2 parents b8f8dbf + a5452c2 commit b21e8c5

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

lib/types/pool.ak

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,12 @@ pub type PoolDatum {
3232
/// and withdrawals never have to be for the full amount.
3333
/// TODO: should we add a field to the settings object to set a minimum initial protocol_fees on pool mint?
3434
protocol_fees: Int,
35+
/// An optional condition that must be present in the withdrawals to spend the pool UTXO. This condition is a script that must be satisfied
36+
/// and adds extra logic to a pool. Note that this condition is ignored when executing scoops with withdrawal orders only. This is to allow
37+
/// users to withdraw their funds even if the condition is no longer satisfiable
3538
condition: Option<ScriptHash>,
39+
/// A condition can have a need for extra data to be provided when spending the pool UTXO
40+
/// This is that extra data and can have different types depending on the condition script
3641
condition_datum: Option<Data>,
3742
}
3843

0 commit comments

Comments
 (0)