Skip to main content

IDLGTEv1

Git Source

Functions​

setMaxDelegateAddresses​

Set an account to have more or less than the DEFAULT_MAX_DELEGATE_ADDRESSES number of delegates.

function setMaxDelegateAddresses(address account, uint32 maxDelegateAddresses) external;

depositUndelegatedGohm​

gOHM is pulled from the calling policy and added to the undelegated balance.

  • This gOHM cannot be used for governance voting until it is delegated.
  • Deposted gOHM balances are tracked per policy. policyA cannot withdraw gOHM that policyB deposited*
function depositUndelegatedGohm(address onBehalfOf, uint256 amount) external;

withdrawUndelegatedGohm​

Undelegated gOHM is transferred to the calling policy.

  • If autoRescindMaxNumDelegates is greater than zero, the delegations will be automatically rescinded if required from up to autoRescindMaxNumDelegates number of delegate escrows. See rescindDelegations() for details
  • Will revert if there is still not enough undelegated gOHM for onBehalfOf OR if policy is attempting to withdraw more gOHM than it deposited Deposted gOHM balances are tracked per policy. policyA cannot withdraw gOHM that policyB deposited*
function withdrawUndelegatedGohm(address onBehalfOf, uint256 amount, uint256 autoRescindMaxNumDelegates) external;

applyDelegations​

Apply a set of delegation requests on behalf of a given account.

  • Each delegation request either delegates or undelegates to an address
  • It applies across total gOHM balances for a given account across all calling policies So policyA may (un)delegate the account's gOHM set by policyA, B and C
function applyDelegations(address onBehalfOf, DelegationRequest[] calldata delegationRequests)
    external
    returns (uint256 totalDelegated, uint256 totalUndelegated, uint256 undelegatedBalance);

rescindDelegations​

Rescind delegations until the amount undelegated for the onBehalfOf account is greater or equal to requestedUndelegatedBalance. No more than maxNumDelegates will be rescinded as part of this

  • Delegations are rescinded by iterating through the delegate addresses for the onBehalfOf address.
  • No guarantees on the order of who is rescinded -- it may change as delegations are removed
  • A calling policy may be able to rescind more than it added via depositUndelegatedGohm() however the policy cannot then withdraw an amount higher than what it deposited.
  • If the full requestedUndelegatedBalance cannot be fulfilled the actualUndelegatedBalance return parameter may be less than requestedUndelegatedBalance. The caller must decide on how to handle that.*
function rescindDelegations(address onBehalfOf, uint256 requestedUndelegatedBalance, uint256 maxNumDelegates)
    external
    returns (uint256 totalRescinded, uint256 newUndelegatedBalance);

policyAccountBalances​

Report the total delegated and undelegated gOHM balance for an account in a given policy

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

accountDelegationsList​

Paginated view of an account's delegations

This can be called sequentially, increasing the startIndex each time by the number of items returned in the previous call, until number of items returned is less than maxItems The totalAmount delegated within the return struct is across all policies for that account delegate

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

accountDelegationSummary​

A summary of an account's delegations

function accountDelegationSummary(address account)
    external
    view
    returns (
        uint256 totalGOhm,
        uint256 delegatedGOhm,
        uint256 numDelegateAddresses,
        uint256 maxAllowedDelegateAddresses
    );

totalDelegatedTo​

The total amount delegated to a particular delegate across all policies, and externally made delegations (including any permanent donations)

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

maxDelegateAddresses​

The maximum number of delegates an account can have accross all policies

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

gOHM​

The gOhm token supplied by accounts

function gOHM() external view returns (IERC20);

DEFAULT_MAX_DELEGATE_ADDRESSES​

The default maximum number of addresses an account can delegate to

function DEFAULT_MAX_DELEGATE_ADDRESSES() external view returns (uint32);

Events​

DelegationApplied​

event DelegationApplied(address indexed account, address indexed delegate, int256 amount);

MaxDelegateAddressesSet​

event MaxDelegateAddressesSet(address indexed account, uint256 maxDelegateAddresses);

Errors​

DLGTE_InvalidAddress​

error DLGTE_InvalidAddress();

DLGTE_InvalidDelegationRequests​

error DLGTE_InvalidDelegationRequests();

DLGTE_TooManyDelegates​

error DLGTE_TooManyDelegates();

DLGTE_InvalidDelegateEscrow​

error DLGTE_InvalidDelegateEscrow();

DLGTE_InvalidAmount​

error DLGTE_InvalidAmount();

DLGTE_ExceededUndelegatedBalance​

error DLGTE_ExceededUndelegatedBalance(uint256 balance, uint256 requested);

DLGTE_ExceededDelegatedBalance​

error DLGTE_ExceededDelegatedBalance(address delegate, uint256 balance, uint256 requested);

DLGTE_ExceededPolicyAccountBalance​

error DLGTE_ExceededPolicyAccountBalance(uint256 balance, uint256 requested);

Structs​

DelegationRequest​

struct DelegationRequest {
    address delegate;
    int256 amount;
}

AccountDelegation​

struct AccountDelegation {
    address delegate;
    uint256 amount;
    address escrow;
}