BaseRegistrarImplementation

0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85 Copy

About

Stats

Public Functions 23

Event Types 9

Code Size 30,142 bytes

Events (9)

Approval Event

Parameters

owner	address
approved	address
tokenId	uint256

ApprovalForAll Event

Parameters

owner	address
operator	address
approved	bool

ControllerAdded Event

Parameters

controller

address

ControllerRemoved Event

Parameters

controller

address

NameMigrated Event

Parameters

id	uint256
owner	address
expires	uint

NameRegistered Event

Parameters

id	uint256
owner	address
expires	uint

NameRenewed Event

Parameters

id	uint256
expires	uint

OwnershipTransferred Event

Parameters

previousOwner	address
newOwner	address

Transfer Event

Parameters

from	address
to	address
tokenId	uint256

Constants (7)

INTERFACE_META_ID Constant

bytes4

UNKNOWN VALUE

ERC721_ID Constant

bytes4

UNKNOWN VALUE

RECLAIM_ID Constant

bytes4

UNKNOWN VALUE

GRACE_PERIOD Constant

uint

90 days

_ERC721_RECEIVED Constant

bytes4

0x150b7a02

_INTERFACE_ID_ERC721 Constant

bytes4

0x80ac58cd

_INTERFACE_ID_ERC165 Constant

bytes4

0x01ffc9a7

State Variables (10)

ens Variable

address

baseNode Variable

bytes32

controllers Variable

mapping(address => bool)

expiries Variable

mapping(uint256 => uint)

Internal Variable

_owner Variable

address

Internal Variable

_tokenOwner Variable

mapping(uint256 => address)

Internal Variable

_tokenApprovals Variable

mapping(uint256 => address)

Internal Variable

_ownedTokensCount Variable

mapping(address => uint256)

Internal Variable

_operatorApprovals Variable

mapping(address => mapping(address => bool))

Internal Variable

_supportedInterfaces Variable

mapping(bytes4 => bool)

Internal Variable

Functions Expand All Collapse All

balanceOf

Parameters

Name	Type
owner	address

Properties

Visibility public

Mutability view

Requirements

owner must not be equal to UNKNOWN VALUE

Source Code

function balanceOf(address owner) public view returns (uint256) {
  require(owner != address(0));
  return _ownedTokensCount[owner];
}

ownerOf

Parameters

Name	Type
tokenId	uint256

Properties

Visibility public

Mutability view

Requirements

now must be less than expiries for tokenId

Source Code

function ownerOf(uint256 tokenId) public view returns (address) {
  require(expiries[tokenId] > now);
  return super.ownerOf(tokenId);
}

approve

Parameters

Name	Type
to	address
tokenId	uint256

Properties

Visibility public

Mutability transaction

Requirements

to must not be equal to owner

One or more of the following: -null - OR owner must be equal to the sender's address

Source Code

function approve(address to, uint256 tokenId) public {
  address owner = ownerOf(tokenId);
  require(to != owner);
  require(msg.sender == owner || isApprovedForAll(owner, msg.sender));

  _tokenApprovals[tokenId] = to;
  emit Approval(owner, to, tokenId);
}

getApproved

Parameters

Name	Type
tokenId	uint256

Properties

Visibility public

Mutability view

Requirements

null

Source Code

function getApproved(uint256 tokenId) public view returns (address) {
  require(_exists(tokenId));
  return _tokenApprovals[tokenId];
}

setApprovalForAll

Parameters

Name	Type
to	address
approved	bool

Properties

Visibility public

Mutability transaction

Requirements

to must not be equal to the sender's address

Source Code

function setApprovalForAll(address to, bool approved) public {
  require(to != msg.sender);
  _operatorApprovals[msg.sender][to] = approved;
  emit ApprovalForAll(msg.sender, to, approved);
}

isApprovedForAll

Parameters

Name	Type
owner	address
operator	address

Properties

Visibility public

Mutability view

Source Code

function isApprovedForAll(address owner, address operator)
  public
  view
  returns (bool)
{
  return _operatorApprovals[owner][operator];
}

transferFrom

Parameters

Name	Type
from	address
to	address
tokenId	uint256

Properties

Visibility public

Mutability transaction

Requirements

null

from must be equal to the result of calling ownerOf with tokenId

to must not be equal to UNKNOWN VALUE

Source Code

function transferFrom(
  address from,
  address to,
  uint256 tokenId
) public {
  require(_isApprovedOrOwner(msg.sender, tokenId));

  _transferFrom(from, to, tokenId);
}

safeTransferFrom

Parameters

Name	Type
from	address
to	address
tokenId	uint256

Properties

Visibility public

Mutability transaction

Requirements

null

from must be equal to the result of calling ownerOf with tokenId

to must not be equal to UNKNOWN VALUE

null

Source Code

function safeTransferFrom(
  address from,
  address to,
  uint256 tokenId
) public {
  safeTransferFrom(from, to, tokenId, "");
}

safeTransferFrom

Parameters

Name	Type
from	address
to	address
tokenId	uint256
_data	bytes

Properties

Visibility public

Mutability transaction

Requirements

null

from must be equal to the result of calling ownerOf with tokenId

to must not be equal to UNKNOWN VALUE

null

Source Code

function safeTransferFrom(
  address from,
  address to,
  uint256 tokenId,
  bytes memory _data
) public {
  transferFrom(from, to, tokenId);
  require(_checkOnERC721Received(from, to, tokenId, _data));
}

supportsInterface

Parameters

Name	Type
interfaceID	bytes4

Properties

Visibility public

Mutability view

Source Code

function supportsInterface(bytes4 interfaceID) external view returns (bool) {
  return
    interfaceID == INTERFACE_META_ID ||
    interfaceID == ERC721_ID ||
    interfaceID == RECLAIM_ID;
}

owner

Parameters

This function has no parameters.

Properties

Visibility public

Mutability view

Source Code

function owner() public view returns (address) {
  return _owner;
}

isOwner

Parameters

This function has no parameters.

Properties

Visibility public

Mutability view

Source Code

function isOwner() public view returns (bool) {
  return msg.sender == _owner;
}

renounceOwnership

Parameters

This function has no parameters.

Properties

Visibility public

Mutability transaction

Modifiers

onlyOwner checks for the following:

null

Source Code

function renounceOwnership() public onlyOwner {
  emit OwnershipTransferred(_owner, address(0));
  _owner = address(0);
}

transferOwnership

Parameters

Name	Type
newOwner	address

Properties

Visibility public

Mutability transaction

Modifiers

onlyOwner checks for the following:

null

Requirements

newOwner must not be equal to UNKNOWN VALUE

Source Code

function transferOwnership(address newOwner) public onlyOwner {
  _transferOwnership(newOwner);
}

addController

Parameters

Name	Type
controller	address

Properties

Visibility public

Mutability transaction

Modifiers

onlyOwner checks for the following:

null

Source Code

function addController(address controller) external onlyOwner {
  controllers[controller] = true;
  emit ControllerAdded(controller);
}

removeController

Parameters

Name	Type
controller	address

Properties

Visibility public

Mutability transaction

Modifiers

onlyOwner checks for the following:

null

Source Code

function removeController(address controller) external onlyOwner {
  controllers[controller] = false;
  emit ControllerRemoved(controller);
}

setResolver

Parameters

Name	Type
resolver	address

Properties

Visibility public

Mutability transaction

Modifiers

onlyOwner checks for the following:

null

Source Code

function setResolver(address resolver) external onlyOwner {
  ens.setResolver(baseNode, resolver);
}

nameExpires

Parameters

Name	Type
id	uint256

Properties

Visibility public

Mutability view

Source Code

function nameExpires(uint256 id) external view returns (uint256) {
  return expiries[id];
}

available

Parameters

Name	Type
id	uint256

Properties

Visibility public

Mutability view

Source Code

function available(uint256 id) public view returns (bool) {
  // Not available if it's registered here or in its grace period.
  return expiries[id] + GRACE_PERIOD < now;
}

register

Parameters

Name	Type
id	uint256
owner	address
duration	uint

Properties

Visibility public

Mutability transaction

Requirements

null

now + duration + GRACE_PERIOD must be greater than now + GRACE_PERIOD

owner must not be equal to UNKNOWN VALUE

the result of calling _exists with id must not be true

Source Code

function register(
  uint256 id,
  address owner,
  uint256 duration
) external returns (uint256) {
  return _register(id, owner, duration, true);
}

renew

Parameters

Name	Type
id	uint256
duration	uint

Properties

Visibility public

Mutability transaction

Modifiers

live checks for the following:

UNKNOWN VALUE must be equal to UNKNOWN VALUE

onlyController checks for the following:

Requirements

now must be less than or equal to expiries for id + GRACE_PERIOD

expiries for id + duration + GRACE_PERIOD must be greater than duration + GRACE_PERIOD

Source Code

function renew(uint256 id, uint256 duration)
  external
  live
  onlyController
  returns (uint256)
{
  require(expiries[id] + GRACE_PERIOD >= now); // Name must be registered here or in grace period
  require(expiries[id] + duration + GRACE_PERIOD > duration + GRACE_PERIOD); // Prevent future overflow

  expiries[id] += duration;
  emit NameRenewed(id, expiries[id]);
  return expiries[id];
}

reclaim

Parameters

Name	Type
id	uint256
owner	address

Properties

Visibility public

Mutability transaction

Modifiers

live checks for the following:

UNKNOWN VALUE must be equal to UNKNOWN VALUE

Requirements

null

Source Code

function reclaim(uint256 id, address owner) external live {
  require(_isApprovedOrOwner(msg.sender, id));
  ens.setSubnodeOwner(baseNode, bytes32(id), owner);
}

registerOnly

Parameters

Name	Type
id	uint256
owner	address
duration	uint

Properties

Visibility public

Mutability transaction

Requirements

null

now + duration + GRACE_PERIOD must be greater than now + GRACE_PERIOD

owner must not be equal to UNKNOWN VALUE

the result of calling _exists with id must not be true

Source Code

function registerOnly(
  uint256 id,
  address owner,
  uint256 duration
) external returns (uint256) {
  return _register(id, owner, duration, false);
}

Internal Functions Expand All Collapse All

Internal functions are parts of the contract that can't be used directly, but instead are used by the public functions listed above.

internal BaseRegistrarImplementation._register

Parameters

Name	Type
id	uint256
owner	address
duration	uint
updateRegistry	bool

Properties

Visibility internal

Mutability transaction

Modifiers

live checks for the following:

UNKNOWN VALUE must be equal to UNKNOWN VALUE

onlyController checks for the following:

Requirements

null

now + duration + GRACE_PERIOD must be greater than now + GRACE_PERIOD

owner must not be equal to UNKNOWN VALUE

the result of calling _exists with id must not be true

Source Code

function _register(
  uint256 id,
  address owner,
  uint256 duration,
  bool updateRegistry
) internal live onlyController returns (uint256) {
  require(available(id));
  require(now + duration + GRACE_PERIOD > now + GRACE_PERIOD); // Prevent future overflow

  expiries[id] = now + duration;
  if (_exists(id)) {
    // Name was previously owned, and expired
    _burn(id);
  }
  _mint(owner, id);
  if (updateRegistry) {
    ens.setSubnodeOwner(baseNode, bytes32(id), owner);
  }

  emit NameRegistered(id, owner, now + duration);

  return now + duration;
}

internal Ownable.constructor

Parameters

This function has no parameters.

Properties

Visibility internal

Mutability transaction

Source Code

constructor() internal {
  _owner = msg.sender;
  emit OwnershipTransferred(address(0), _owner);
}

internal Ownable._transferOwnership

Parameters

Name	Type
newOwner	address

Properties

Visibility internal

Mutability transaction

Requirements

newOwner must not be equal to UNKNOWN VALUE

Source Code

function _transferOwnership(address newOwner) internal {
  require(newOwner != address(0));
  emit OwnershipTransferred(_owner, newOwner);
  _owner = newOwner;
}

internal ERC721._exists

Parameters

Name	Type
tokenId	uint256

Properties

Visibility internal

Mutability view

Source Code

function _exists(uint256 tokenId) internal view returns (bool) {
  address owner = _tokenOwner[tokenId];
  return owner != address(0);
}

internal ERC721._isApprovedOrOwner

Parameters

Name	Type
spender	address
tokenId	uint256

Properties

Visibility internal

Mutability view

Source Code

function _isApprovedOrOwner(address spender, uint256 tokenId)
  internal
  view
  returns (bool)
{
  address owner = ownerOf(tokenId);
  return (spender == owner ||
    getApproved(tokenId) == spender ||
    isApprovedForAll(owner, spender));
}

internal ERC721._mint

Parameters

Name	Type
to	address
tokenId	uint256

Properties

Visibility internal

Mutability transaction

Requirements

owner must not be equal to UNKNOWN VALUE

the result of calling _exists with id must not be true

Source Code

function _mint(address to, uint256 tokenId) internal {
  require(to != address(0));
  require(!_exists(tokenId));

  _tokenOwner[tokenId] = to;
  _ownedTokensCount[to] = _ownedTokensCount[to].add(1);

  emit Transfer(address(0), to, tokenId);
}

internal ERC721._burn

Parameters

Name	Type
owner	address
tokenId	uint256

Properties

Visibility internal

Mutability transaction

Requirements

owner must be equal to the result of calling ownerOf with tokenId

Source Code

function _burn(address owner, uint256 tokenId) internal {
  require(ownerOf(tokenId) == owner);

  _clearApproval(tokenId);

  _ownedTokensCount[owner] = _ownedTokensCount[owner].sub(1);
  _tokenOwner[tokenId] = address(0);

  emit Transfer(owner, address(0), tokenId);
}

internal ERC721._burn

Parameters

Name	Type
tokenId	uint256

Properties

Visibility internal

Mutability transaction

Requirements

the result of calling ownerOf with tokenId must be equal to the result of calling ownerOf with tokenId

Source Code

function _burn(uint256 tokenId) internal {
  _burn(ownerOf(tokenId), tokenId);
}

internal ERC721._transferFrom

Parameters

Name	Type
from	address
to	address
tokenId	uint256

Properties

Visibility internal

Mutability transaction

Requirements

from must be equal to the result of calling ownerOf with tokenId

to must not be equal to UNKNOWN VALUE

Source Code

function _transferFrom(
  address from,
  address to,
  uint256 tokenId
) internal {
  require(ownerOf(tokenId) == from);
  require(to != address(0));

  _clearApproval(tokenId);

  _ownedTokensCount[from] = _ownedTokensCount[from].sub(1);
  _ownedTokensCount[to] = _ownedTokensCount[to].add(1);

  _tokenOwner[tokenId] = to;

  emit Transfer(from, to, tokenId);
}

internal ERC721._checkOnERC721Received

Parameters

Name	Type
from	address
to	address
tokenId	uint256
_data	bytes

Properties

Visibility internal

Mutability transaction

Source Code

function _checkOnERC721Received(
  address from,
  address to,
  uint256 tokenId,
  bytes memory _data
) internal returns (bool) {
  if (!to.isContract()) {
    return true;
  }

  bytes4 retval = IERC721Receiver(to).onERC721Received(
    msg.sender,
    from,
    tokenId,
    _data
  );
  return (retval == _ERC721_RECEIVED);
}

internal ERC721._clearApproval

Parameters

Name	Type
tokenId	uint256

Properties

Visibility private

Mutability transaction

Source Code

function _clearApproval(uint256 tokenId) private {
  if (_tokenApprovals[tokenId] != address(0)) {
    _tokenApprovals[tokenId] = address(0);
  }
}

internal ERC165.constructor

Parameters

This function has no parameters.

Properties

Visibility internal

Mutability transaction

Requirements

_INTERFACE_ID_ERC165 must not be equal to 0xffffffff

Source Code

constructor() internal {
  _registerInterface(_INTERFACE_ID_ERC165);
}

internal ERC165._registerInterface

Parameters

Name	Type
interfaceId	bytes4

Properties

Visibility internal

Mutability transaction

Requirements

_INTERFACE_ID_ERC165 must not be equal to 0xffffffff

Source Code

function _registerInterface(bytes4 interfaceId) internal {
  require(interfaceId != 0xffffffff);
  _supportedInterfaces[interfaceId] = true;
}

BaseRegistrarImplementation

About

Stats

Events (9) keyboard_arrow_up

Approval Event

Parameters help Event parameters list the data that an event contains.

ApprovalForAll Event

Parameters help Event parameters list the data that an event contains.

ControllerAdded Event

Parameters help Event parameters list the data that an event contains.

ControllerRemoved Event

Parameters help Event parameters list the data that an event contains.

NameMigrated Event

Parameters help Event parameters list the data that an event contains.

NameRegistered Event

Parameters help Event parameters list the data that an event contains.

NameRenewed Event

Parameters help Event parameters list the data that an event contains.

OwnershipTransferred Event

Parameters help Event parameters list the data that an event contains.

Transfer Event

Parameters help Event parameters list the data that an event contains.

Constants (7) keyboard_arrow_up

INTERFACE_META_ID Constant

ERC721_ID Constant

RECLAIM_ID Constant

GRACE_PERIOD Constant

_ERC721_RECEIVED Constant

_INTERFACE_ID_ERC721 Constant

_INTERFACE_ID_ERC165 Constant

State Variables (10) keyboard_arrow_up

ens Variable

baseNode Variable

controllers Variable

expiries Variable

_owner Variable

_tokenOwner Variable

_tokenApprovals Variable

_ownedTokensCount Variable

_operatorApprovals Variable

_supportedInterfaces Variable

Functions Expand All Collapse All

balanceOf keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

Source Code

ownerOf keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

Source Code

approve keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

Source Code

getApproved keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

Source Code

setApprovalForAll keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

Source Code

isApprovedForAll keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Source Code

transferFrom keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

Source Code

safeTransferFrom keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

Events (9)

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Constants (7)

State Variables (10)

balanceOf

Parameters

Requirements

ownerOf

Parameters

Requirements

approve

Parameters

Requirements

getApproved

Parameters

Requirements

setApprovalForAll

Parameters

Requirements

isApprovedForAll

Parameters

transferFrom

Parameters

Requirements

safeTransferFrom

Parameters

Requirements

safeTransferFrom

Parameters

Requirements

supportsInterface

Parameters

owner

Parameters

isOwner

Parameters

renounceOwnership

Parameters

Modifiers

transferOwnership

Parameters

Modifiers

Requirements

addController

Parameters

Modifiers

removeController

Parameters

Modifiers

setResolver

Parameters

Modifiers

nameExpires

Parameters

available

Parameters

register

Parameters

Requirements

renew

Parameters

Modifiers

Requirements