TransferSelectorNFT
LooksRare protocol team (👀,💎); bitbeckers;
TransferSelectorNFT
This contract handles the logic for transferring non-fungible items.
Methods​
MAGIC_VALUE_ORDER_NONCE_EXECUTED​
function MAGIC_VALUE_ORDER_NONCE_EXECUTED() external view returns (bytes32)
Magic value nonce returned if executed (or cancelled).
Returns​
| Name | Type | Description |
|---|---|---|
| _0 | bytes32 | undefined |
addStrategy​
function addStrategy(uint16 standardProtocolFeeBp, uint16 minTotalFeeBp, uint16 maxProtocolFeeBp, bytes4 selector, bool isMakerBid, address implementation) external nonpayable
This function allows the owner to add a new execution strategy to the protocol.
Strategies have an id that is incremental. Only callable by owner.
Parameters​
| Name | Type | Description |
|---|---|---|
| standardProtocolFeeBp | uint16 | Standard protocol fee (in basis point) |
| minTotalFeeBp | uint16 | Minimum total fee (in basis point) |
| maxProtocolFeeBp | uint16 | Maximum protocol fee (in basis point) |
| selector | bytes4 | Function selector for the strategy |
| isMakerBid | bool | Whether the function selector is for maker bid |
| implementation | address | Implementation address |
cancelOrderNonces​
function cancelOrderNonces(uint256[] orderNonces) external nonpayable
This function allows a user to cancel an array of order nonces.
It does not check the status of the nonces to save gas and to prevent revertion if one of the orders is filled in the same block.
Parameters​
| Name | Type | Description |
|---|---|---|
| orderNonces | uint256[] | Array of order nonces |
cancelOwnershipTransfer​
function cancelOwnershipTransfer() external nonpayable
This function is used to cancel the ownership transfer.
This function can be used for both cancelling a transfer to a new owner and cancelling the renouncement of the ownership.
cancelSubsetNonces​
function cancelSubsetNonces(uint256[] subsetNonces) external nonpayable
This function allows a user to cancel an array of subset nonces.
It does not check the status of the nonces to save gas.
Parameters​
| Name | Type | Description |
|---|---|---|
| subsetNonces | uint256[] | Array of subset nonces |
confirmOwnershipRenouncement​
function confirmOwnershipRenouncement() external nonpayable
This function is used to confirm the ownership renouncement.
confirmOwnershipTransfer​
function confirmOwnershipTransfer() external nonpayable
This function is used to confirm the ownership transfer.
This function can only be called by the current potential owner.
creatorFeeManager​
function creatorFeeManager() external view returns (contract ICreatorFeeManager)
Creator fee manager.
Returns​
| Name | Type | Description |
|---|---|---|
| _0 | contract ICreatorFeeManager | undefined |
incrementBidAskNonces​
function incrementBidAskNonces(bool bid, bool ask) external nonpayable
This function increments a user's bid/ask nonces.
The logic for computing the quasi-random number is inspired by Seaport v1.2. The pseudo-randomness allows non-deterministic computation of the next ask/bid nonce. A deterministic increment would make the cancel-all process non-effective in certain cases (orders signed with a greater ask/bid nonce). The same quasi-random number is used for incrementing both the bid and ask nonces if both values are incremented in the same transaction. If this function is used twice in the same block, it will return the same quasiRandomNumber but this will not impact the overall business logic.
Parameters​
| Name | Type | Description |
|---|---|---|
| bid | bool | Whether to increment the user bid nonce |
| ask | bool | Whether to increment the user ask nonce |
initiateOwnershipRenouncement​
function initiateOwnershipRenouncement() external nonpayable
This function is used to initiate the ownership renouncement.
initiateOwnershipTransfer​
function initiateOwnershipTransfer(address newPotentialOwner) external nonpayable
This function is used to initiate the transfer of ownership to a new owner.
Parameters​
| Name | Type | Description |
|---|---|---|
| newPotentialOwner | address | New potential owner address |
isCurrencyAllowed​
function isCurrencyAllowed(address) external view returns (bool)
It checks whether the currency is allowed for transacting.
Parameters​
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
Returns​
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
maxCreatorFeeBp​
function maxCreatorFeeBp() external view returns (uint16)
Maximum creator fee (in basis point).
Returns​
| Name | Type | Description |
|---|---|---|
| _0 | uint16 | undefined |
owner​
function owner() external view returns (address)
Address of the current owner.
Returns​
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
ownershipStatus​
function ownershipStatus() external view returns (enum IOwnableTwoSteps.Status)
Ownership status.
Returns​
| Name | Type | Description |
|---|---|---|
| _0 | enum IOwnableTwoSteps.Status | undefined |
potentialOwner​
function potentialOwner() external view returns (address)
Address of the potential owner.
Returns​
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
protocolFeeRecipient​
function protocolFeeRecipient() external view returns (address)
Protocol fee recipient.
Returns​
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
strategyInfo​
function strategyInfo(uint256) external view returns (bool isActive, uint16 standardProtocolFeeBp, uint16 minTotalFeeBp, uint16 maxProtocolFeeBp, bytes4 selector, bool isMakerBid, address implementation)
This returns the strategy information for a strategy id.
Parameters​
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
Returns​
| Name | Type | Description |
|---|---|---|
| isActive | bool | undefined |
| standardProtocolFeeBp | uint16 | undefined |
| minTotalFeeBp | uint16 | undefined |
| maxProtocolFeeBp | uint16 | undefined |
| selector | bytes4 | undefined |
| isMakerBid | bool | undefined |
| implementation | address | undefined |
transferManager​
function transferManager() external view returns (contract TransferManager)
Transfer manager for ERC721, ERC1155 and Hypercerts.
Returns​
| Name | Type | Description |
|---|---|---|
| _0 | contract TransferManager | undefined |
updateCreatorFeeManager​
function updateCreatorFeeManager(address newCreatorFeeManager) external nonpayable
This function allows the owner to update the creator fee manager address.
Only callable by owner.
Parameters​
| Name | Type | Description |
|---|---|---|
| newCreatorFeeManager | address | Address of the creator fee manager |
updateCurrencyStatus​
function updateCurrencyStatus(address currency, bool isAllowed) external nonpayable
This function allows the owner to update the status of a currency.
Only callable by owner.
Parameters​
| Name | Type | Description |
|---|---|---|
| currency | address | Currency address (address(0) for ETH) |
| isAllowed | bool | Whether the currency should be allowed for trading |
updateMaxCreatorFeeBp​
function updateMaxCreatorFeeBp(uint16 newMaxCreatorFeeBp) external nonpayable
This function allows the owner to update the maximum creator fee (in basis point).
The maximum value that can be set is 25%. Only callable by owner.
Parameters​
| Name | Type | Description |
|---|---|---|
| newMaxCreatorFeeBp | uint16 | New maximum creator fee (in basis point) |
updateProtocolFeeRecipient​
function updateProtocolFeeRecipient(address newProtocolFeeRecipient) external nonpayable
This function allows the owner to update the protocol fee recipient.
Only callable by owner.
Parameters​
| Name | Type | Description |
|---|---|---|
| newProtocolFeeRecipient | address | New protocol fee recipient address |
updateStrategy​
function updateStrategy(uint256 strategyId, bool isActive, uint16 newStandardProtocolFee, uint16 newMinTotalFee) external nonpayable
This function allows the owner to update parameters for an existing execution strategy.
Only callable by owner.
Parameters​
| Name | Type | Description |
|---|---|---|
| strategyId | uint256 | Strategy id |
| isActive | bool | Whether the strategy must be active |
| newStandardProtocolFee | uint16 | New standard protocol fee (in basis point) |
| newMinTotalFee | uint16 | New minimum total fee (in basis point) |
userBidAskNonces​
function userBidAskNonces(address) external view returns (uint256 bidNonce, uint256 askNonce)
This tracks the bid and ask nonces for a user address.
Parameters​
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
Returns​
| Name | Type | Description |
|---|---|---|
| bidNonce | uint256 | undefined |
| askNonce | uint256 | undefined |
userOrderNonce​
function userOrderNonce(address, uint256) external view returns (bytes32)
This checks whether the order nonce for a user was executed or cancelled.
Parameters​
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| _1 | uint256 | undefined |
Returns​
| Name | Type | Description |
|---|---|---|
| _0 | bytes32 | undefined |
userSubsetNonce​
function userSubsetNonce(address, uint256) external view returns (bool)
This checks whether the subset nonce for a user was cancelled.
Parameters​
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| _1 | uint256 | undefined |
Returns​
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
Events​
CancelOwnershipTransfer​
event CancelOwnershipTransfer()
This is emitted if the ownership transfer is cancelled.
CurrencyStatusUpdated​
event CurrencyStatusUpdated(address currency, bool isAllowed)
It is emitted if the currency status in the allowlist is updated.
Parameters​
| Name | Type | Description |
|---|---|---|
| currency | address | undefined |
| isAllowed | bool | undefined |
InitiateOwnershipRenouncement​
event InitiateOwnershipRenouncement()
This is emitted if the ownership renouncement is initiated.
InitiateOwnershipTransfer​
event InitiateOwnershipTransfer(address previousOwner, address potentialOwner)
This is emitted if the ownership transfer is initiated.
Parameters​
| Name | Type | Description |
|---|---|---|
| previousOwner | address | undefined |
| potentialOwner | address | undefined |
NewBidAskNonces​
event NewBidAskNonces(address user, uint256 bidNonce, uint256 askNonce)
It is emitted when there is an update of the global bid/ask nonces for a user.
Parameters​
| Name | Type | Description |
|---|---|---|
| user | address | undefined |
| bidNonce | uint256 | undefined |
| askNonce | uint256 | undefined |
NewCreatorFeeManager​
event NewCreatorFeeManager(address creatorFeeManager)
It is issued when there is a new creator fee manager.
Parameters​
| Name | Type | Description |
|---|---|---|
| creatorFeeManager | address | undefined |
NewMaxCreatorFeeBp​
event NewMaxCreatorFeeBp(uint256 maxCreatorFeeBp)
It is issued when there is a new maximum creator fee (in basis point).
Parameters​
| Name | Type | Description |
|---|---|---|
| maxCreatorFeeBp | uint256 | undefined |
NewOwner​
event NewOwner(address newOwner)
This is emitted when there is a new owner.
Parameters​
| Name | Type | Description |
|---|---|---|
| newOwner | address | undefined |
NewProtocolFeeRecipient​
event NewProtocolFeeRecipient(address protocolFeeRecipient)
It is issued when there is a new protocol fee recipient address.
Parameters ​
| Name | Type | Description |
|---|---|---|
| protocolFeeRecipient | address | undefined |
NewStrategy​
event NewStrategy(uint256 strategyId, uint16 standardProtocolFeeBp, uint16 minTotalFeeBp, uint16 maxProtocolFeeBp, bytes4 selector, bool isMakerBid, address implementation)
It is emitted when a new strategy is added.
Parameters​
| Name | Type | Description |
|---|---|---|
| strategyId | uint256 | undefined |
| standardProtocolFeeBp | uint16 | undefined |
| minTotalFeeBp | uint16 | undefined |
| maxProtocolFeeBp | uint16 | undefined |
| selector | bytes4 | undefined |
| isMakerBid | bool | undefined |
| implementation | address | undefined |
OrderNoncesCancelled​
event OrderNoncesCancelled(address user, uint256[] orderNonces)
It is emitted when order nonces are cancelled for a user.
Parameters​
| Name | Type | Description |
|---|---|---|
| user | address | undefined |
| orderNonces | uint256[] | undefined |
StrategyUpdated​
event StrategyUpdated(uint256 strategyId, bool isActive, uint16 standardProtocolFeeBp, uint16 minTotalFeeBp)
It is emitted when an existing strategy is updated.
Parameters​
| Name | Type | Description |
|---|---|---|
| strategyId | uint256 | undefined |
| isActive | bool | undefined |
| standardProtocolFeeBp | uint16 | undefined |
| minTotalFeeBp | uint16 | undefined |
SubsetNoncesCancelled​
event SubsetNoncesCancelled(address user, uint256[] subsetNonces)
It is emitted when subset nonces are cancelled for a user.
Parameters​
| Name | Type | Description |
|---|---|---|
| user | address | undefined |
| subsetNonces | uint256[] | undefined |
Errors​
CreatorFeeBpTooHigh​
error CreatorFeeBpTooHigh()
It is returned if the creator fee (in basis point) is too high.
LengthsInvalid​
error LengthsInvalid()
It is returned if there is either a mismatch or an error in the length of the array(s).
NewProtocolFeeRecipientCannotBeNullAddress​
error NewProtocolFeeRecipientCannotBeNullAddress()
It is returned if the new protocol fee recipient is set to address(0).
NoOngoingTransferInProgress​
error NoOngoingTransferInProgress()
This is returned when there is no transfer of ownership in progress.
NoSelectorForStrategy​
error NoSelectorForStrategy()
It is returned if there is no selector for maker ask/bid for a given strategyId, depending on the quote type.
NotOwner​
error NotOwner()
This is returned when the caller is not the owner.
NotV2Strategy​
error NotV2Strategy()
If the strategy has not set properly its implementation contract.
It can only be returned for owner operations.
OutsideOfTimeRange​
error OutsideOfTimeRange()
It is returned if the current block timestamp is not between start and end times in the maker order.
ReentrancyFail​
error ReentrancyFail()
This is returned when there is a reentrant call.
RenouncementNotInProgress​
error RenouncementNotInProgress()
This is returned when there is no renouncement in progress but the owner tries to validate the ownership renouncement.
StrategyHasNoSelector​
error StrategyHasNoSelector()
It is returned if the strategy has no selector.
It can only be returned for owner operations.
StrategyNotAvailable​
error StrategyNotAvailable(uint256 strategyId)
It is returned if the strategy id has no implementation.
It is returned if there is no implementation address and the strategyId is strictly greater than 0.
Parameters​
| Name | Type | Description |
|---|---|---|
| strategyId | uint256 | undefined |
StrategyNotUsed​
error StrategyNotUsed()
It is returned if the strategyId is invalid.
StrategyProtocolFeeTooHigh​
error StrategyProtocolFeeTooHigh()
It is returned if the strategy's protocol fee is too high.
It can only be returned for owner operations.
TransferAlreadyInProgress​
error TransferAlreadyInProgress()
This is returned when the transfer is already in progress but the owner tries initiate a new ownership transfer.
TransferNotInProgress​
error TransferNotInProgress()
This is returned when there is no ownership transfer in progress but the ownership change tries to be approved.
UnsupportedCollectionType​
error UnsupportedCollectionType()
WrongPotentialOwner​
error WrongPotentialOwner()
This is returned when the ownership transfer is attempted to be validated by the a caller that is not the potential owner.