Skip to main content

OlympusGovDelegation

Git Source

Inherits: DLGTEv1

Olympus Governance Delegation (Module) Contract

The Olympus Governance Delegation Module enables policies to delegate gOHM on behalf of users. If the gOHM is undelegated, this module acts as an escrow for the gOHM. When the gOHM is delegated, new individual escrows are created for those delegates, and that portion of gOHM is transferred to that escrow. gOHM balances are tracked per (policy, account) separately such that one policy cannot pull the gOHM from another policy (eg policy B pulling collateral out of the Cooler policy).

State Variables

delegateEscrowFactory

DelegateEscrowFactory public immutable delegateEscrowFactory;

_accountState

The mapping of a delegate's address to their escrow contract

An account's current state across all policies A given account is allowed up to 10 delegates. This is capped because to avoid gas griefing, eg within Cooler, upon a liquidation, the gOHM needs to be pulled from all delegates.

mapping(address => AccountState) private _accountState;

_policyAccountBalances

The per policy balances of (delegated and undelegated) gOHM for each end user account One policy isn't allowed to deposit/withdraw to another policy's tracked balances Eg policy B cannot withdraw gOHM from the collateral held here by the Cooler policy

mapping(address => mapping(address => uint256)) private _policyAccountBalances;

Functions

constructor

constructor(Kernel kernel_, address gohm_, DelegateEscrowFactory delegateEscrowFactory_)
Module(kernel_)
DLGTEv1(gohm_);

KEYCODE

5 byte identifier for a module.

function KEYCODE() public pure override returns (Keycode);

VERSION

Returns which semantic version of a module is being implemented.

function VERSION() external pure override returns (uint8 major, uint8 minor);

Returns

NameTypeDescription
majoruint8- Major version upgrade indicates breaking change to the interface.
minoruint8- Minor version change retains backward-compatible interface.

depositUndelegatedGohm

function depositUndelegatedGohm(address onBehalfOf, uint256 amount) external override permissioned;

withdrawUndelegatedGohm

function withdrawUndelegatedGohm(address onBehalfOf, uint256 amount, uint256 autoRescindMaxNumDelegates)
external
override
permissioned;

rescindDelegations

function rescindDelegations(address onBehalfOf, uint256 requestedUndelegatedBalance, uint256 maxNumDelegates)
external
override
permissioned
returns (uint256 totalRescinded, uint256 newUndelegatedBalance);

applyDelegations

function applyDelegations(address onBehalfOf, IDLGTEv1.DelegationRequest[] calldata delegationRequests)
external
override
permissioned
returns (uint256 appliedDelegationAmounts, uint256 appliedUndelegationAmounts, uint256 undelegatedBalance);

setMaxDelegateAddresses

function setMaxDelegateAddresses(address account, uint32 maxDelegates) external override permissioned;

policyAccountBalances

function policyAccountBalances(address policy, address account) external view override returns (uint256 gOhmBalance);

accountDelegationsList

function accountDelegationsList(address account, uint256 startIndex, uint256 maxItems)
external
view
override
returns (IDLGTEv1.AccountDelegation[] memory delegations);

totalDelegatedTo

function totalDelegatedTo(address delegate) external view override returns (uint256);

accountDelegationSummary

function accountDelegationSummary(address account)
external
view
override
returns (uint256, uint256, uint256, uint256);

maxDelegateAddresses

function maxDelegateAddresses(address account) external view override returns (uint32 result);

_applyDelegations

function _applyDelegations(
address onBehalfOf,
AccountState storage aState,
uint256 undelegatedBalance,
IDLGTEv1.DelegationRequest[] calldata delegationRequests
)
private
returns (uint256 appliedDelegationAmounts, uint256 appliedUndelegationAmounts, uint256 newUndelegatedBalance);

_maxDelegateAddresses

function _maxDelegateAddresses(AccountState storage aState) private returns (uint32 maxDelegates);

_applyDelegation

function _applyDelegation(
address onBehalfOf,
uint256 undelegatedBalance,
uint32 maxDelegates,
EnumerableMap.AddressToUintMap storage acctDelegatedAmounts,
IDLGTEv1.DelegationRequest calldata delegationRequest
) private returns (uint256 delegatedAmount, uint256 undelegatedAmount);

_addDelegation

function _addDelegation(
address onBehalfOf,
address delegate,
uint256 delegatedAmount,
EnumerableMap.AddressToUintMap storage acctDelegatedAmounts,
uint32 maxDelegates
) private;

_autoRescindDelegations

function _autoRescindDelegations(
address onBehalfOf,
uint256 requestedUndelegatedBalance,
AccountState storage aState,
uint256 totalAccountGOhm,
uint256 maxNumDelegates
) private returns (uint256 totalRescinded, uint256 newUndelegatedBalance);

_rescindDelegation

function _rescindDelegation(
address onBehalfOf,
address delegate,
uint256 delegatedBalance,
uint256 rescindAmount,
EnumerableMap.AddressToUintMap storage acctDelegatedAmounts
) private;

Structs

AccountState

struct AccountState {
EnumerableMap.AddressToUintMap delegatedAmounts;
uint112 totalGOhm;
uint112 delegatedGOhm;
uint32 maxDelegateAddresses;
}