Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extracting the erc721 interface #5383

Merged
merged 6 commits into from
Dec 3, 2019
Merged

Extracting the erc721 interface #5383

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6a2d3e6
Temp fix for linting
nfurfaro Nov 28, 2019
e1c8367
Add imports and remove function interfaces
nfurfaro Nov 28, 2019
84594c9
Fix quotes
nfurfaro Nov 28, 2019
af6f166
Fix linting with comments
nfurfaro Dec 2, 2019
6ee1343
Ignore indentation for entire contract
nfurfaro Dec 3, 2019
c617e6c
Fix comment directive
nfurfaro Dec 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
168 changes: 8 additions & 160 deletions smart-contracts/contracts/interfaces/IPublicLock.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
pragma solidity ^0.5.0;

import './IERC721.sol';
import './IERC721Enumerable.sol';

/**
* @title The PublicLock Interface
* @author Nick Furfaro (unlock-protocol.com)
*/

interface IPublicLock {

contract IPublicLock is IERC721Enumerable, IERC721 {

// See indentationissue description here:
// https://github.com/duaraghav8/Ethlint/issues/268
// solium-disable indentation

///===================================================================
/// Events
Expand Down Expand Up @@ -51,23 +58,6 @@ interface IPublicLock {
uint transferFeeBasisPoints
);

/// @dev This emits when ownership of any NFT changes by any mechanism.
/// This event emits when NFTs are created (`from` == 0) and destroyed
/// (`to` == 0). Exception: during contract creation, any number of NFTs
/// may be created and assigned without emitting Transfer. At the time of
/// any transfer, the approved address for that NFT (if any) is reset to none.
event Transfer(address indexed _from, address indexed _to, uint indexed _tokenId);

/// @dev This emits when the approved address for an NFT is changed or
/// reaffirmed. The zero address indicates there is no approved address.
/// When a Transfer event emits, this also indicates that the approved
/// address for that NFT (if any) is reset to none.
event Approval(address indexed _owner, address indexed _approved, uint indexed _tokenId);

/// @dev This emits when an operator is enabled or disabled for an owner.
/// The operator can manage all NFTs of the owner.
event ApprovalForAll(address indexed _owner, address indexed _operator, bool _approved);

/// @notice emits anytime the nonce used for off-chain approvals changes.
event NonceChanged(
address indexed keyOwner,
Expand Down Expand Up @@ -444,20 +434,6 @@ interface IPublicLock {
function BASIS_POINTS_DEN() external view returns (uint256 );
///===================================================================

/// From Openzeppelin's IERC721.sol

/// @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE
/// TO CONFIRM THAT `_to` IS CAPABLE OF RECEIVING NFTS OR ELSE
/// THEY MAY BE PERMANENTLY LOST
/// @dev Throws unless `msg.sender` is the current owner, an authorized
/// operator, or the approved address for this NFT. Throws if `_from` is
/// not the current owner. Throws if `_to` is the zero address. Throws if
/// `_tokenId` is not a valid NFT.
/// @param _from The current owner of the NFT
/// @param _to The new owner
/// @param _tokenId The NFT to transfer
function transferFrom(address _from, address _to, uint _tokenId) external;

/**
* @notice Allows the key owner to share their key (parent key) by
* transferring a portion of the remaining time to a new key (child key).
Expand All @@ -474,138 +450,10 @@ interface IPublicLock {
uint _timeShared
) external;

/**
* @notice Allows the key owner to share their key (parent key) by
* transferring a portion of the remaining time to a new key (child key).
* @dev Throws if _from does not have a valid key.
* @dev Throws if _from does not have enough remaining time
* on parent key to both pay transfer fee and share time with a child key.
* @dev Throws if _timeShared > maxSharableTime.
* @dev Throws if `_to` is the zero address. When transfer is complete, this function
* checks if `_to` is a smart contract (code size > 0). If so, it calls
* `onERC721Received` on `_to` and throws if the return value is not
* `bytes4(keccak256('onERC721Received(address,address,uint,bytes)'))`.
* @param _from The owner of the parent key
* @param _to The recipient of the shared key
* @param _timeShared The amount of time shared
* @dev Emit Transfer event
*/
// function safeShareKey(
// address _from,
// address _to,
// uint _timeShared
// ) external;

/// @notice Set or reaffirm the approved address for an NFT
/// @dev The zero address indicates there is no approved address.
/// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized
/// operator of the current owner.
/// @param _approved The new approved NFT controller
/// @param _tokenId The NFT to approve
function approve(address _approved, uint _tokenId) external payable;

/// @notice Transfers the ownership of an NFT from one address to another address
/// @dev Throws unless `msg.sender` is the current owner, an authorized
/// operator, or the approved address for this NFT. Throws if `_from` is
/// not the current owner. Throws if `_to` is the zero address. Throws if
/// `_tokenId` is not a valid NFT. When transfer is complete, this function
/// checks if `_to` is a smart contract (code size > 0). If so, it calls
/// `onERC721Received` on `_to` and throws if the return value is not
/// `bytes4(keccak256('onERC721Received(address,address,uint,bytes)'))`.
/// @param _from The current owner of the NFT
/// @param _to The new owner
/// @param _tokenId The NFT to transfer
/// @param data Additional data with no specified format, sent in call to `_to`
function safeTransferFrom(address _from, address _to, uint _tokenId, bytes calldata data) external;

/// @notice Transfers the ownership of an NFT from one address to another address
/// @dev This works identically to the other function with an extra data parameter,
/// except this function just sets data to ''
/// @param _from The current owner of the NFT
/// @param _to The new owner
/// @param _tokenId The NFT to transfer
function safeTransferFrom(address _from, address _to, uint _tokenId) external;

/**
* @dev Sets or unsets the approval of a given operator
* An operator is allowed to transfer all tokens of the sender on their behalf
* @dev Throws if lock is disabled, or if _to == msg.sender.
* @param _to operator address to set the approval
* @param _approved representing the status of the approval to be set
*/
function setApprovalForAll(
address _to,
bool _approved
) external;

/**
* In the specific case of a Lock, each owner can own only at most 1 key.
* @return The number of NFTs owned by `_owner`, either 0 or 1.
* @dev Throws if _owner = address(0)
* @param _owner The address of the key owner
*/
function balanceOf(
address _owner
) external view returns (uint);

/// @notice Find the owner of an NFT
/// @dev NFTs assigned to zero address are considered invalid, and queries
/// about them do throw.
/// @param _tokenId The identifier for an NFT
/// @return The address of the owner of the NFT
function ownerOf(uint _tokenId) external view returns (address);

/**
* Will return the approved recipient for a key, if any.
* @param _tokenId The ID of the token we're inquiring about.
* @return address The approved address (if any)
*/
function getApproved(
uint _tokenId
) external view returns (address);

/**
* @dev Tells whether an operator is approved by a given owner
* @param _owner owner address which you want to query the approval of
* @param _operator operator address which you want to query the approval of
* @return bool whether the given operator is approved by the given owner
*/
function isApprovedForAll(
address _owner,
address _operator
) external view returns (bool);

/// @notice A descriptive name for a collection of NFTs in this contract
function name() external view returns (string memory _name);
///===================================================================

/// From IERC721Enumerable
function totalSupply(
) external view
returns (uint256);

/// @notice Enumerate valid NFTs
/// @dev Throws if `_index` >= `totalSupply()`.
/// @param _index A counter less than `totalSupply()`
/// @return The token identifier for the `_index`th NFT,
/// (sort order not specified)
function tokenByIndex(
uint256 _index
) external view returns (uint256);

/// @notice Enumerate NFTs assigned to an owner
/// @dev Throws if `_index` >= `balanceOf(_owner)` or if
/// `_owner` is the zero address, representing invalid NFTs.
/// @param _owner An address where we are interested in NFTs owned by them
/// @param _index A counter less than `balanceOf(_owner)`
/// @return The token identifier for the `_index`th NFT assigned to `_owner`,
/// (sort order not specified)
function tokenOfOwnerByIndex(
address _owner,
uint256 _index
) external view returns (uint256);
///===================================================================

/// From Openzeppelin's Ownable.sol
function owner() external view returns (address );

Expand Down