IRenfter

Interface to protocol core functionalities

ERCType

enum ERCType {
  ERC721,
  ERC1155
}

OCollectionData

struct OCollectionData {
  address oAddress;
  enum IRenfter.ERCType ercType;
}

Offer

struct Offer {
  address lender;
  uint96 pricePerSecond;
  uint64 maxRentDuration;
  address beneficiary;
}

Rent

struct Rent {
  address holderWallet;
  uint64 expirationTs;
}

ConditionsParams

struct ConditionsParams {
  uint96 pricePerSecond;
  uint64 maxRentDuration;
  address beneficiary;
}

setWNFTFactory

function setWNFTFactory(address wNFTFactory_) external

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

setFeeDistributor

function setFeeDistributor(address feeDistributor_) external

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

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

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

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

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

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

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

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

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) external

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) external 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 originOwner, 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
originOwner	address	Original token owner
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

getERCCompatible

function getERCCompatible(address address_) external view returns (bool compatible721, bool compatible1155)

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

Parameters

Name	Type	Description
address_	address	Address being checked

Return Values

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

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[] tokenId) external view returns (bool)

Returns if all of oContracts have wrapper contract

Parameters

Name	Type	Description
contracts	address[]	Array of original contracts
tokenId	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

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

getLender

function getLender(address wContract, uint256 tokenId) external 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

getRentExpired

function getRentExpired(address wContract, uint256 tokenId) external 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