doc.gno
1.13 Kb · 22 lines
1// Package whitelist manages the direct pools available to GnoSwap orders.
2//
3// DCA and Limit have independent pool whitelists, selected by TargetDCA
4// ("dca") and TargetLimit ("limit"). Adding or removing a pool affects only
5// the selected target. Pools must exist before being added; removing one
6// prevents that target's orders from trading on it, not from cancelling.
7//
8// Admin, governance, or callers authorized by gno.land/r/gnoswap/order/keeper
9// can update membership. At deployment, AddWhitelistedPool and
10// RemoveWhitelistedPool are assigned to PoolManagerRole on this realm;
11// the target argument selects the pool list, not the authorization policy.
12// Queries expose membership, a read-only pool tree, and whether a pair has
13// an existing whitelisted direct pool at any registered fee tier.
14//
15// Files:
16// - whitelist.gno: AddWhitelistedPool and RemoveWhitelistedPool
17// - getters.gno: read-only queries
18// - state.gno: independent DCA and Limit whitelist states
19// - assert.gno: authorization, target, and pool validation
20// - consts.gno: supported target names
21// - emits.gno: pool membership events
22package whitelist