TermController.sol

This contract operates at the protocol level and governs all instances of a Term Repo. This contract manages Term Finance protocol permissions and controls

TermController

This contract manages Term Finance protocol permissions and controls

This contract operates at the protocol level and governs all instances of a Term Repo

ADMIN_ROLE

bytes32 ADMIN_ROLE

AUCTION_ROLE

bytes32 AUCTION_ROLE

CONTROLLER_ADMIN_ROLE

bytes32 CONTROLLER_ADMIN_ROLE

DEVOPS_ROLE

bytes32 DEVOPS_ROLE

INITIALIZER_ROLE

bytes32 INITIALIZER_ROLE

FACTORY_DEPLOYER_ROLE

bytes32 FACTORY_DEPLOYER_ROLE

SPECIALIST_ROLE

bytes32 SPECIALIST_ROLE

termContractsPaused

bool termContractsPaused

Returns whether all Term Finance contracts are currently paused

Return Values

Name	Type	Description

treasuryWallet

address treasuryWallet

protocolReserveWallet

address protocolReserveWallet

termAddresses

mapping(address => bool) termAddresses

factoryDeployedAddresses

mapping(address => bool) factoryDeployedAddresses

approvedExternalAddresses

mapping(address => bool) approvedExternalAddresses

registeredRepoIds

mapping(bytes32 => bool) registeredRepoIds

External view function which returns if term repo id is registered in Controller

Parameters

Name	Type	Description

Return Values

Name	Type	Description

registeredAuctionIds

mapping(bytes32 => bool) registeredAuctionIds

External view function which returns if term auction id is registered in Controller

Parameters

Name	Type	Description

Return Values

Name	Type	Description

termAuctionResults

mapping(bytes32 => struct TermAuctionResults) termAuctionResults

onlyInitializerOrFactoryDeployer

modifier onlyInitializerOrFactoryDeployer()

constructor

constructor() public

initialize

function initialize(address treasuryWallet_, address protocolReserveWallet_, address controllerAdminWallet_, address devopsWallet_, address adminWallet_) external

pairInitializer

function pairInitializer(address initializer) external

pairFactoryDeployer

function pairFactoryDeployer(address factoryDeployer) external

pairAuction

function pairAuction(address auction) external

Initializer function to pair a new Term Auction with the controller

Parameters

Name	Type	Description
auction	address	new auction address

getTreasuryAddress

function getTreasuryAddress() external view returns (address)

External view function which returns contract address of treasury wallet

getProtocolReserveAddress

function getProtocolReserveAddress() external view returns (address)

External view function which returns contract address of protocol reserve

Return Values

Name	Type	Description
[0]	address	The protocol reserve address

getTermAuctionResults

function getTermAuctionResults(bytes32 termRepoId) external view returns (struct AuctionMetadata[] auctionMetadata, uint8 numOfAuctions)

Returns history of all completed auctions within a term

Parameters

Name	Type	Description
termRepoId	bytes32	term repo id to look up

isTermDeployed

function isTermDeployed(address contractAddress) external view returns (bool)

External view function which returns whether contract address is deployed by Term Finance Protocol

Parameters

Name	Type	Description
contractAddress	address	The input contract address to query

Return Values

Name	Type	Description
[0]	bool	Whether the given address is deployed by Term Finance Protocol

isFactoryDeployed

function isFactoryDeployed(address contractAddress) external view returns (bool)

External view function which returns whether contract address is deployed by a Term Finance factory

Parameters

Name	Type	Description
contractAddress	address	The input contract address to query

Return Values

Name	Type	Description
[0]	bool	Whether the given address is deployed by a Term Finance factory

isTermApproved

function isTermApproved(address contractAddress) external view returns (bool)

External view function which returns whether contract address is approved for integration

Parameters

Name	Type	Description
contractAddress	address	The input contract address to query

Return Values

Name	Type	Description
[0]	bool	Whether the given address is approved for integration

verifyMintExposureAccess

function verifyMintExposureAccess(address authedUser) external view returns (bool)

Parameters

Name	Type	Description
authedUser	address	The address of user to check access for mint exposure

updateTreasuryAddress

function updateTreasuryAddress(address newTreasuryWallet) external

Admin function to update the Term Finance treasury wallet address

Parameters

Name	Type	Description
newTreasuryWallet	address	The new treasury address

updateProtocolReserveAddress

function updateProtocolReserveAddress(address newProtocolReserveWallet) external

Admin function to update the Term Finance protocol reserve wallet address

Parameters

Name	Type	Description
newProtocolReserveWallet	address	The new protocol reserve wallet address

updateControllerAdminWallet

function updateControllerAdminWallet(address oldControllerAdminWallet, address newControllerAdminWallet) external

Admin function to update the designated controller admin wallet that calls markTermDeployed

Parameters

Name	Type	Description
oldControllerAdminWallet	address	The current controller admin wallet to revoke permissions for
newControllerAdminWallet	address	The new controller admin wallet to grant permissions for

markTermDeployed

function markTermDeployed(address termContract) external

Admin function to add a new Term Finance contract to Controller

Parameters

Name	Type	Description
termContract	address	The new term contract address

unmarkTermDeployed

function unmarkTermDeployed(address termContract) external

Admin function to remove a contract from Controller

Parameters

Name	Type	Description
termContract	address	The new term contract address

markTermFactoryDeployed

function markTermFactoryDeployed(address factoryDeployedContract) external

Admin function to add a new factory-deployed contract to Controller

Parameters

Name	Type	Description
factoryDeployedContract	address	The factory-deployed contract address

unmarkTermFactoryDeployed

function unmarkTermFactoryDeployed(address factoryDeployedContract) external

Admin function to remove a factory-deployed contract from Controller

Parameters

Name	Type	Description
factoryDeployedContract	address	The factory-deployed contract address

registerRepoId

function registerRepoId(bytes32 repoId) external

Admin function to add a new term repo id to Controller

Parameters

Name	Type	Description
repoId	bytes32	The new term repo id

registerAuctionId

function registerAuctionId(bytes32 auctionId) external

Admin function to add a new term auction id to Controller

Parameters

Name	Type	Description
auctionId	bytes32	The new term auction id

markTermApproved

function markTermApproved(address externalContract) external

Admin function to add a new external contract to Controller

Parameters

Name	Type	Description
externalContract	address	The new external contract address

unmarkTermApproved

function unmarkTermApproved(address externalContract) external

Admin function to remove an external contract from Controller

Parameters

Name	Type	Description
externalContract	address	The new external contract address

grantMintExposureAccess

function grantMintExposureAccess(address authedUser) external

Parameters

Name	Type	Description
authedUser	address	The address of user granted access to create mint exposure

revokeMintExposureAccess

function revokeMintExposureAccess(address revokedUser) external

Parameters

Name	Type	Description
revokedUser	address	The address of user to revoke access to create mint exposure

pauseTermContracts

function pauseTermContracts() external

Pauses all Term Finance contracts

Sets the global pause state to true, halting contract operations

unpauseTermContracts

function unpauseTermContracts() external

Unpauses all Term Finance contracts

Sets the global pause state to false, resuming contract operations

recordAuctionResult

function recordAuctionResult(bytes32 termRepoId, bytes32 termAuctionId, uint256 auctionClearingRate) external

_authorizeUpgrade

function _authorizeUpgrade(address) internal view

required override by the OpenZeppelin UUPS module