Renfter

Core protocol logic implementation

MIN_RENT_DURATION

uint64 MIN_RENT_DURATION

Minimum rental duration period in seconds

wNFTFactory

contract IwNFTFactory wNFTFactory

Interface of wNFTFactory contract

walletManager

contract IWalletManager walletManager

Interface of WalletManager contract

feeDistributor

contract IFeeDistributor feeDistributor

Interface of FeeDistributor contract

_wContracts

mapping(address => address) _wContracts

Original contract address to wrapper contract

_oContractsData

mapping(address => struct IRenfter.OCollectionData) _oContractsData

Wrapper contract address to original contract

_offers

mapping(address => mapping(uint256 => struct IRenfter.Offer)) _offers

Wrapper contract to token id to offer details

_rents

mapping(address => mapping(uint256 => struct IRenfter.Rent)) _rents

Wrapper contract to token id to rent details

notRented

modifier notRented(address wContract, uint256 tokenId)

isWrapper

modifier isWrapper(address wContract)

collectionNotWrapped

modifier collectionNotWrapped(address oContract)

collectionWrapped

modifier collectionWrapped(address oContract)

wrapperTokenExists

modifier wrapperTokenExists(address wContract, uint256 tokenId)

wrapperTokenNotExist

modifier wrapperTokenNotExist(address oContract, uint256 tokenId)

senderOTokenOwner

modifier senderOTokenOwner(address wContract, uint256 tokenId)

tokenOfferedForRent

modifier tokenOfferedForRent(address wContract, uint256 tokenId)

initialize

function initialize(address governator_, address wNFTFactory_, address walletManager_, address feeDistributor_) external

Zero address check for depending contracts intentionally omitted

Initializer method

Parameters

Name	Type	Description
governator_	address	governator address
wNFTFactory_	address	wNFTFactory contract address
walletManager_	address	WalletManager contract address
feeDistributor_	address	FeeDistributor contract address

setWNFTFactory

function setWNFTFactory(address wNFTFactory_) external

Sets address of wNFTFactory contract

Parameters

Name	Type	Description
wNFTFactory_	address	New wNFTFactory contract address

_setWNFTFactory

function _setWNFTFactory(address wNFTFactory_) private

Sets address of wNFTFactory contract

Parameters

Name	Type	Description
wNFTFactory_	address	New wNFTFactory contract address

setWalletManager

function setWalletManager(address walletManager_) external

Sets address of WalletFactory contract

Parameters

Name	Type	Description
walletManager_	address	New WalletManager contract address

_setWalletManager

function _setWalletManager(address walletManager_) private

Sets address of WalletManager contract

Parameters

Name	Type	Description
walletManager_	address	New WalletManager contract address

setFeeDistributor

function setFeeDistributor(address feeDistributor_) external

Sets address of FeeDistributor contract

Parameters

Name	Type	Description
feeDistributor_	address	New FeeDistributor contract address

_setFeeDistributor

function _setFeeDistributor(address feeDistributor_) private

Sets address of FeeDistributor contract

Parameters

Name	Type	Description
feeDistributor_	address	New FeeDistributor contract address

safeWrap721Collection

function safeWrap721Collection(address oContract, bytes4[] restrictedSelectors) external

Creates wrapper contract for ERC-721 collection

Parameters

Name	Type	Description
oContract	address	Collection address being wrapped
restrictedSelectors	bytes4[]	List of selectors restricted for call whitelisting

safeWrap1155Collection

function safeWrap1155Collection(address oContract, bytes4[] restrictedSelectors) external

Creates wrapper contract for ERC-1155 collection

Parameters

Name	Type	Description
oContract	address	Collection address being wrapped
restrictedSelectors	bytes4[]	List of selectors restricted for call whitelisting

_postWrapCollection

function _postWrapCollection(address oContract, address wContract, enum IRenfter.ERCType ercType, bytes4[] restrictedSelectors) private

Performs post-wrapper creation operations

Parameters

Name	Type	Description
oContract	address	Original contract address
wContract	address	Wrapper contract address
ercType	enum IRenfter.ERCType
restrictedSelectors	bytes4[]	List of selectors restricted for call whitelisting

safeWrap721Token

function safeWrap721Token(address oContract, uint256 tokenId) external

Creates a ERC-721 wrapper token of original contract with same token identifier

Parameters

Name	Type	Description
oContract	address	Collection address token is being wrapped
tokenId	uint256	Token identifier

wrapAndOffer721Token

function wrapAndOffer721Token(address oContract, uint256 tokenId, struct IRenfter.ConditionsParams conditions, struct WhitelistedParams[] whitelisted) external

Wraps ERC-721 token and offers it for renting

Parameters

Name	Type	Description
oContract	address	Collection address token is being wrapped
tokenId	uint256	Token identifier
conditions	struct IRenfter.ConditionsParams	ConditionsParams struct with offer conditions
whitelisted	struct WhitelistedParams[]	Array of WhitelistedParam structs with whitelisted method selectors

_wrap721Token

function _wrap721Token(address oContract, uint256 tokenId, address sender) private

Creates a ERC-721 wrapper token of original contract with same token identifier

Parameters

Name	Type	Description
oContract	address	Collection address being wrapped
tokenId	uint256	Token identifier
sender	address	Sender address

safeWrap1155Token

function safeWrap1155Token(address oContract, uint256 tokenId) external

Creates a ERC-1155 wrapper token of original contract with same token identifier

Parameters

Name	Type	Description
oContract	address	Collection address token is being wrapped
tokenId	uint256	Token identifier

wrapAndOffer1155Token

function wrapAndOffer1155Token(address oContract, uint256 tokenId, struct IRenfter.ConditionsParams conditions, struct WhitelistedParams[] whitelisted) external

Wraps ERC-1155 token and offers it for renting

Parameters

Name	Type	Description
oContract	address	Collection address token is being wrapped
tokenId	uint256	Token identifier
conditions	struct IRenfter.ConditionsParams	ConditionsParams struct with offer conditions
whitelisted	struct WhitelistedParams[]	Array of WhitelistedParam structs with whitelisted method selectors

_wrap1155Token

function _wrap1155Token(address oContract, uint256 tokenId, address sender) private

Creates a ERC-1155 wrapper token of original contract with same token identifier

Parameters

Name	Type	Description
oContract	address	Collection address being wrapped
tokenId	uint256	Token identifier
sender	address	Sender address

_prepareTokenWrap

function _prepareTokenWrap(address oContract, uint256 tokenId, address sender) private returns (address wContract, address holderWallet)

Perform preparation for token wrapping

Parameters

Name	Type	Description
oContract	address	Original contract address
tokenId	uint256	Token identifier
sender	address	Sender address

offerForRent

function offerForRent(address wContract, uint256 tokenId, struct IRenfter.ConditionsParams conditions, struct WhitelistedParams[] whitelisted) external

Offers token for a rent with defined conditions and whitelisted methods

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
tokenId	uint256	Token identifier
conditions	struct IRenfter.ConditionsParams	ConditionsParams struct with offer conditions
whitelisted	struct WhitelistedParams[]	Array of WhitelistedParam structs with whitelisted method selectors

_offerForRent

function _offerForRent(address wContract, uint256 tokenId, struct IRenfter.ConditionsParams conditions, struct WhitelistedParams[] whitelisted) private

Sets wrapped token as ready for renting by setting rent conditions

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
tokenId	uint256	Token identifier
conditions	struct IRenfter.ConditionsParams	ConditionsParams struct with conditions
whitelisted	struct WhitelistedParams[]	Array of WhitelistedParams with whitelisted methods

removeRentalOffer

function removeRentalOffer(address wContract, uint256 tokenId) external

Sets previously listed token as unavailable for renting

Parameters

Name	Type	Description
wContract	address	Address of wrapper contract
tokenId	uint256	Token identifier

rentToken

function rentToken(address wContract, uint256 tokenId, uint64 duration) external

Rents wrapper token that was previously listed for renting

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
tokenId	uint256	Token identifier
duration	uint64	Rent duration in seconds

_getCurrentHolderOf

function _getCurrentHolderOf(address wContract, uint256 tokenId) private view returns (address currentHolder)

Returns current holder of the original token

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
tokenId	uint256	Token identifier

Return Values

Name	Type	Description
currentHolder	address	Current holder address

_transferWToken

function _transferWToken(address wContract, address to, uint256 tokenId) private

Transfers wrapper token

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
to	address	Receiver address
tokenId	uint256	Token identifier

_transferOToken

function _transferOToken(address wContract, address from, address to, uint256 tokenId) private

Transfers original token from wallet to to address

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
from	address	Sender address
to	address	Receiver address
tokenId	uint256	Token identifier

safeUnwrap721Token

function safeUnwrap721Token(address wContract, uint256 tokenId) external

Unwraps wrapped token ERC-721 token and returns original token to initial owner

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
tokenId	uint256	Token identifier

_unwrap721Token

function _unwrap721Token(address wContract, uint256 tokenId, bool isEmergency) private

Unwraps wrapped ERC-721 token token and returns original token to initial owner

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
tokenId	uint256	Token identifier
isEmergency	bool	Flag if its emergency unwrap

safeUnwrap1155Token

function safeUnwrap1155Token(address wContract, uint256 tokenId) external

Unwraps wrapped token ERC1155 token and returns original token to initial owner

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
tokenId	uint256	Token identifier

_unwrap1155Token

function _unwrap1155Token(address wContract, uint256 tokenId, bool isEmergency) private

Unwraps wrapped ERC-1155 token and returns original token to initial owner

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
tokenId	uint256	Token identifier
isEmergency	bool	Flag if its emergency unwrap

_prepareTokenUnwrap

function _prepareTokenUnwrap(address wContract, uint256 tokenId) private returns (address lender, address oTokenOwner)

Perform pre-unwrapping operations

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
tokenId	uint256	Token identifier

Return Values

Name	Type	Description
lender	address	Original owner address
oTokenOwner	address	Current original token owner

emergencyUnwrap

function emergencyUnwrap(address wContract, uint256 tokenId) external

Performs emergency unwrap of wrapper token

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
tokenId	uint256	Token identifier

forwardCall

function forwardCall(uint256 tokenId, bytes data) external payable

Forwards call received by wrapper contract

Parameters

Name	Type	Description
tokenId	uint256	Token identifier
data	bytes	Calldata being passed as calldata (selector + data)

batchResetOwnership

function batchResetOwnership(address[] wContracts, uint256[] tokenIds) external

Batch method for reseting ownership of wrapper and original tokens if rent has expired

Parameters

Name	Type	Description
wContracts	address[]	Array of wrapper contract addresses
tokenIds	uint256[]	Array of token identifiers

resetOwnership

function resetOwnership(address wContract, uint256 tokenId) public

Resets ownership of wrapper and original tokens if rent has expired

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
tokenId	uint256	Token identifier

getHolderOf

function getHolderOf(address wContract, uint256 tokenId) public view returns (address)

It probably won't return the same result as for example ownerOf method, as tokens are not transferred on rent expiration

Returns the address that should hold original token

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
tokenId	uint256	Token identifier

getOriginTokenData

function getOriginTokenData(address wContract, uint256 tokenId) external view returns (address oContract, address lender, address wTokenOwner)

Returns original token data

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
tokenId	uint256	Token identifier

Return Values

Name	Type	Description
oContract	address	Original collection address
lender	address
wTokenOwner	address	Wrapper token owner

getWrapperTokenData

function getWrapperTokenData(address oContract, uint256 tokenId) external view returns (address wContract, address wTokenOwner)

Returns wrapper token data

Parameters

Name	Type	Description
oContract	address	Original collection address
tokenId	uint256	Token identifier

Return Values

Name	Type	Description
wContract	address	Wrapper contract address
wTokenOwner	address	Wrapper token owner

getOriginalContract

function getOriginalContract(address wContract) external view returns (address)

Returns original contract address for wContract

Parameters

Name	Type	Description
wContract	address	Wrapper contract address

Return Values

Name	Type	Description
[0]	address	Original collection address

getWrapperContract

function getWrapperContract(address oContract) external view returns (address)

Returns wrapper contract address for oContract

Parameters

Name	Type	Description
oContract	address	Address of original contract

Return Values

Name	Type	Description
[0]	address	Address of wrapper contract

getBatchWrapperTokenExist

function getBatchWrapperTokenExist(address[] contracts, uint256[] tokenIds) external view returns (bool)

Returns if all of oContracts have wrapper contract

Parameters

Name	Type	Description
contracts	address[]	Array of original contracts
tokenIds	uint256[]

Return Values

Name	Type	Description
[0]	bool	Flag if all original contracts have wrapper contracts

getOfferDetails

function getOfferDetails(address wContract, uint256 tokenId) external view returns (struct IRenfter.Offer)

Returns offer details for wrapper token

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
tokenId	uint256	Token identifier

Return Values

Name	Type	Description
[0]	struct IRenfter.Offer	{Offer} struct with data

getRentDetails

function getRentDetails(address wContract, uint256 tokenId) external view returns (struct IRenfter.Rent)

Returns rent details for wrapper token

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
tokenId	uint256	Token identifier

Return Values

Name	Type	Description
[0]	struct IRenfter.Rent	{Rent} struct with data

getLender

function getLender(address wContract, uint256 tokenId) public view returns (address)

Returns original owner of wrapper token

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
tokenId	uint256	Token identifier

Return Values

Name	Type	Description
[0]	address	Original owner address

getOffered

function getOffered(address wContract, uint256 tokenId) external view returns (bool)

Returns if token is listed for renting

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
tokenId	uint256	Token identifier

getERCCompatible

function getERCCompatible(address addr) public view returns (bool compatible721, bool compatible1155)

Returns whether if address_ is compatible with ERC-721 or ERC-1155 standard

Parameters

Name	Type	Description
addr	address

Return Values

Name	Type	Description
compatible721	bool	Flag if address_ compatible with ERC-721
compatible1155	bool	Flag if address_ comaptible with ERC-1155

getRentExpired

function getRentExpired(address wContract, uint256 tokenId) public view returns (bool)

Returns if rent has expired for token

Parameters

Name	Type	Description
wContract	address	Wrapper contract address
tokenId	uint256	Token identifier

Return Values

Name	Type	Description
[0]	bool	Flag if rent has expired