Skip to main content

Comptrollerable

Git Source

Inherits: IComptrollerable

Title: Comptrollerable

See the documentation in IComptrollerable.

State Variables

comptroller

Retrieves the address of the comptroller contract.

ISablierComptroller public override comptroller

Functions

onlyComptroller

Reverts if called by any account other than the comptroller.

modifier onlyComptroller() ;

constructor

constructor(address initialComptroller) ;

Parameters

NameTypeDescription
initialComptrolleraddressThe address of the initial comptroller contract.

setComptroller

Sets the comptroller to a new address.

Emits a {SetComptroller} event. Requirements:

  • msg.sender must be the current comptroller.
  • The new comptroller must return true from {supportsInterface} with the comptroller's minimal interface ID which is defined as the XOR of the following function selectors:
  1. {calculateMinFeeWeiFor}
  2. {convertUSDFeeToWei}
  3. {execute}
  4. {getMinFeeUSDFor}
function setComptroller(ISablierComptroller newComptroller) external override onlyComptroller;

Parameters

NameTypeDescription
newComptrollerISablierComptrollerThe address of the new comptroller contract.

transferFeesToComptroller

Transfers the fees to the comptroller contract.

Emits a {TransferFeesToComptroller} event.

function transferFeesToComptroller() external override;

_checkComptroller

See the documentation for the user-facing functions that call this private function.

function _checkComptroller() private view;

_setComptroller

See the documentation for the user-facing functions that call this private function.

function _setComptroller(
ISablierComptroller previousComptroller,
ISablierComptroller newComptroller,
bytes4 minimalInterfaceId
)
private;