Skip to main content

Recoverable Contract Technical Reference

This is a technical reference for the Media Protocol's Recoverable smart contract.

Inheritance​

The Recoverable contract inherits the Open Zeppelin's AccessControl and IERC721Receiver contracts.

Write Functions​

recoverNative​

Allows the contract owner to recover native coins sent unintentionally to the contract.

function recoverNative() external onlyRole(DEFAULT_ADMIN_ROLE) returns (bool);

Return:

Type
boolWhether the recovery was successful or not.

_recoverERC20​

Allows the contract owner to recover tokens sent unintentionally to the contract. It is an internal function. It is not meant to be called directly. To use this function, contracts that inherit from Recoverable should implement a public function that calls this function. In all our contracts, this function is called recoverERC20.

function _recoverERC20(IERC20 _token) internal onlyRole(DEFAULT_ADMIN_ROLE) returns (bool);

Parameters:

NameType
_tokenIERC20The token you want to recover.

Return:

Type
boolWhether the recovery was successful or not.

_recoverERC721​

Allows the contract owner to recover ERC721 tokens sent unintentionally to the contract. It is an internal function. It is not meant to be called directly. To use this function, contracts that inherit from Recoverable should implement a public function that calls this function. In all our contracts, this function is called recoverERC721.

function _recoverERC721(IERC721 _token, uint256 _tokenId) internal onlyRole(DEFAULT_ADMIN_ROLE) returns (bool);

Parameters:

NameType
_tokenThe token you want to recover.
_tokenIduint256The token ID you want to recover.

Return:

Type
boolWhether the recovery was successful or not.

Modifiers​

Modifiers are used to conditionally change the behavior of functions. For instance, certain functions can only be executed by the contract owner or by authorized addresses.

onlyRole(DEFAULT_ADMIN_ROLE)​

The onlyRole(DEFAULT_ADMIN_ROLE) modifier ensures that msg.sender is an admin.