Blockium Token

0x27c743954bce1bfaef8bcbd685527531001d88d7 Copy

ERC20

This contract is an ERC20 token.

Name Blockium Token

Symbol BOK

Decimals 18

Total Supply 650,000,000 BOK

About

Stats

Public Functions 30

Event Types 9

Code Size 34,011 bytes

Library Use

Uses SafeMath for uint256.

Events (9)

Approval Event

Parameters

owner	address
spender	address
value	uint256

LogUpgrade Event

Parameters

from	address
to	address
value	uint256

LogUpgradeAgentSet Event

Parameters

agent

address

OwnershipTransferred Event

Parameters

previousOwner	address
newOwner	address

Paused Event

Parameters

account

address

PauserAdded Event

Parameters

account

address

PauserRemoved Event

Parameters

account

address

Transfer Event

Parameters

from	address
to	address
value	uint256

Unpaused Event

Parameters

account

address

Constants (1)

MAX_UINT Constant

uint256

UNKNOWN VALUE - 1

State Variables (15)

upgradeMaster Variable

address

upgradeAgent Variable

address

totalUpgraded Variable

uint256

previousToken Variable

address

version Variable

string

_balances Variable

mapping(address => uint256)

Internal Variable

_allowances Variable

mapping(address => mapping(address => uint256))

Internal Variable

_totalSupply Variable

uint256

Internal Variable

_paused Variable

bool

Internal Variable

_pausers Variable

Roles.Role

Internal Variable

_pausersCount Variable

uint256

Internal Variable

_name Variable

string

Internal Variable

_symbol Variable

string

Internal Variable

_decimals Variable

uint8

Internal Variable

_owner Variable

address

Internal Variable

Functions Expand All Collapse All

isUpgradeAgent

Parameters

This function has no parameters.

Properties

Visibility public

Mutability pure

Source Code

function isUpgradeAgent() external pure returns (bool) {
  return true;
}

upgradeFrom

Parameters

Name	Type
_from	address
_value	uint256

Properties

Visibility public

Mutability transaction

Modifiers

validateAddress checks for the following:

_from must not be equal to UNKNOWN VALUE

Requirements

previousToken must not be equal to UNKNOWN VALUE

previousToken must be equal to the sender's address

_from must not be equal to UNKNOWN VALUE

_value must not be equal to 0

Source Code

function upgradeFrom(address _from, uint256 _value)
  external
  validateAddress(_from)
{
  require(previousToken != address(0), "previousToken was not set");
  require(
    msg.sender == previousToken,
    "upgradeFrom should only be called by previousToken"
  );
  _mint(_from, _value);
}

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;
}

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);
}

name

Parameters

This function has no parameters.

Properties

Visibility public

Mutability view

Source Code

function name() public view returns (string memory) {
  return _name;
}

symbol

Parameters

This function has no parameters.

Properties

Visibility public

Mutability view

Source Code

function symbol() public view returns (string memory) {
  return _symbol;
}

decimals

Parameters

This function has no parameters.

Properties

Visibility public

Mutability view

Source Code

function decimals() public view returns (uint8) {
  return _decimals;
}

isPauser

Parameters

Name	Type
account	address

Properties

Visibility public

Mutability view

Source Code

function isPauser(address account) public view returns (bool) {
  return _pausers.has(account);
}

addPauser

Parameters

Name	Type
account	address

Properties

Visibility public

Mutability transaction

Modifiers

onlyPauser checks for the following:

null

Source Code

function addPauser(address account) public onlyPauser {
  _addPauser(account);
}

removePauser

Parameters

Name	Type
account	address

Properties

Visibility public

Mutability transaction

Modifiers

onlyPauser checks for the following:

null

Requirements

_pausersCount must be greater than 1

Source Code

function removePauser(address account) public onlyPauser {
  _removePauser(account);
}

paused

Parameters

This function has no parameters.

Properties

Visibility public

Mutability view

Source Code

function paused() public view returns (bool) {
  return _paused;
}

pause

Parameters

This function has no parameters.

Properties

Visibility public

Mutability transaction

Modifiers

onlyPauser checks for the following:

null

whenNotPaused checks for the following:

_paused must not be true

Source Code

function pause() public onlyPauser whenNotPaused {
  _paused = true;
  emit Paused(msg.sender);
}

unpause

Parameters

This function has no parameters.

Properties

Visibility public

Mutability transaction

Modifiers

onlyPauser checks for the following:

null

whenPaused checks for the following:

_paused must be true

Source Code

function unpause() public onlyPauser whenPaused {
  _paused = false;
  emit Unpaused(msg.sender);
}

totalSupply

Parameters

This function has no parameters.

Properties

Visibility public

Mutability view

Source Code

function totalSupply() public view returns (uint256) {
  return _totalSupply;
}

balanceOf

Parameters

Name	Type
owner	address

Properties

Visibility public

Mutability view

Source Code

function balanceOf(address owner) public view returns (uint256) {
  return _balances[owner];
}

allowance

Parameters

Name	Type
owner	address
spender	address

Properties

Visibility public

Mutability view

Source Code

function allowance(address owner, address spender)
  public
  view
  returns (uint256)
{
  return _allowances[owner][spender];
}

transfer

Parameters

Name	Type
to	address
value	uint256

Properties

Visibility public

Mutability transaction

Modifiers

whenNotPaused checks for the following:

_paused must not be true

Requirements

the sender's address must not be equal to UNKNOWN VALUE

to must not be equal to UNKNOWN VALUE

Source Code

function transfer(address to, uint256 value)
  public
  whenNotPaused
  returns (bool)
{
  return super.transfer(to, value);
}

approve

Parameters

Name	Type
spender	address
value	uint256

Properties

Visibility public

Mutability transaction

Modifiers

whenNotPaused checks for the following:

_paused must not be true

Requirements

One or more of the following:

the sender's address must not be equal to UNKNOWN VALUE

spender must not be equal to UNKNOWN VALUE

Source Code

function approve(address spender, uint256 value)
  public
  whenNotPaused
  returns (bool)
{
  return super.approve(spender, value);
}

transferFrom

Parameters

Name	Type
from	address
to	address
value	uint256

Properties

Visibility public

Mutability transaction

Modifiers

whenNotPaused checks for the following:

_paused must not be true

Requirements

the sender's address must not be equal to UNKNOWN VALUE

to must not be equal to UNKNOWN VALUE

Source Code

function transferFrom(
  address from,
  address to,
  uint256 value
) public whenNotPaused returns (bool) {
  return super.transferFrom(from, to, value);
}

increaseAllowance

Parameters

Name	Type
spender	address
addedValue	uint256

Properties

Visibility public

Mutability transaction

Modifiers

whenNotPaused checks for the following:

_paused must not be true

Requirements

addedValue must be greater than 0

the sender's address must not be equal to UNKNOWN VALUE

spender must not be equal to UNKNOWN VALUE

Source Code

function increaseAllowance(address spender, uint256 addedValue)
  public
  whenNotPaused
  returns (bool)
{
  return super.increaseAllowance(spender, addedValue);
}

decreaseAllowance

Parameters

Name	Type
spender	address
subtractedValue	uint256

Properties

Visibility public

Mutability transaction

Modifiers

whenNotPaused checks for the following:

_paused must not be true

Requirements

subtractedValue must be greater than 0

_allowances for the sender's address for spender must be greater than 0

the sender's address must not be equal to UNKNOWN VALUE

spender must not be equal to UNKNOWN VALUE

Source Code

function decreaseAllowance(address spender, uint256 subtractedValue)
  public
  whenNotPaused
  returns (bool)
{
  return super.decreaseAllowance(spender, subtractedValue);
}

upgrade

Parameters

Name	Type
value	uint256

Properties

Visibility public

Mutability transaction

Requirements

One or more of the following: - state must be equal to UpgradeState.Upgrading - OR state must be equal to UpgradeState.ReadyToUpgrade

value must not be equal to 0

the sender's address must not be equal to UNKNOWN VALUE

Source Code

function upgrade(uint256 value) external {
  UpgradeState state = getUpgradeState();
  require(
    state == UpgradeState.ReadyToUpgrade || state == UpgradeState.Upgrading,
    "upgrade state does not allow upgrade"
  );
  require(value != 0, "value must be non-zero");

  // Take tokens out from circulation
  _burn(msg.sender, value);
  totalUpgraded = totalUpgraded.add(value);
  emit LogUpgrade(msg.sender, address(upgradeAgent), value);

  // Upgrade agent reissues the tokens
  upgradeAgent.upgradeFrom(msg.sender, value);
}

setUpgradeAgent

Parameters

Name	Type
newUpgradeAgent	UpgradeAgent

Properties

Visibility public

Mutability transaction

Modifiers

onlyUpgradeMaster checks for the following:

upgradeMaster must be equal to the sender's address

validateAddress checks for the following:

_from must not be equal to UNKNOWN VALUE

Requirements

the result of calling getUpgradeState must not be equal to UpgradeState.Upgrading

Source Code

function setUpgradeAgent(UpgradeAgent newUpgradeAgent)
  external
  onlyUpgradeMaster
  validateAddress(address(newUpgradeAgent))
{
  require(
    getUpgradeState() != UpgradeState.Upgrading,
    "upgrade already started"
  );

  upgradeAgent = newUpgradeAgent;
  emit LogUpgradeAgentSet(address(newUpgradeAgent));

  // Calling non-existent function will revert inside the call without this require error message
  require(newUpgradeAgent.isUpgradeAgent(), "Bad interface");
}

getUpgradeState

Parameters

This function has no parameters.

Properties

Visibility public

Mutability view

Source Code

function getUpgradeState() public view returns (UpgradeState) {
  if (address(upgradeAgent) == address(0)) {
    return UpgradeState.WaitingForAgent;
  } else if (totalUpgraded == 0) {
    return UpgradeState.ReadyToUpgrade;
  } else if (totalUpgraded < totalSupply()) {
    return UpgradeState.Upgrading;
  } else {
    return UpgradeState.UpgradeFinished;
  }
}

setUpgradeMaster

Parameters

Name	Type
master	address

Properties

Visibility public

Mutability transaction

Modifiers

onlyUpgradeMaster checks for the following:

upgradeMaster must be equal to the sender's address

validateAddress checks for the following:

_from must not be equal to UNKNOWN VALUE

Source Code

function setUpgradeMaster(address master)
  external
  onlyUpgradeMaster
  validateAddress(master)
{
  upgradeMaster = master;
}

recoverToken

Parameters

Name	Type
_token	IERC20

Properties

Visibility public

Mutability transaction

Modifiers

onlyOwner checks for the following:

null

Requirements

balance must be greater than 0

Source Code

function recoverToken(IERC20 _token) external onlyOwner {
  uint256 balance = _token.balanceOf(address(this));
  require(balance > 0, "no tokens to recover for received token type");
  SafeERC20.safeTransfer(_token, _owner, balance);
}

reclaimContract

Parameters

Name	Type
contractInst	Ownable

Properties

Visibility public

Mutability transaction

Modifiers

onlyOwner checks for the following:

null

Source Code

function reclaimContract(Ownable contractInst) external onlyOwner {
  contractInst.transferOwnership(_owner);
}

tokenFallback

Parameters

Name	Type
from	address
value	uint256
data	bytes

Properties

Visibility public

Mutability pure

Source Code

function tokenFallback(
  address from,
  uint256 value,
  bytes calldata data
) external pure {
  /* Use variables to remove warnings https://github.com/OpenZeppelin/openzeppelin-solidity/commit/b50391862c42857e3ff2388598e52ebab92fc9fa#diff-24aa1138eec9d5dd65b1a8a898e04dd2 */
  from;
  value;
  data;
  revert("this contract does not support receiving ERC223 tokens");
}

recoverEther

Parameters

This function has no parameters.

Properties

Visibility public

Mutability transaction

Modifiers

onlyOwner checks for the following:

null

Requirements

undefined.balance must be greater than 0

Source Code

function recoverEther() external onlyOwner {
  require(address(this).balance > 0, "no ether to recover");
  address(uint160(_owner)).transfer(address(this).balance);
}

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 ERC20._transfer

Parameters

Name	Type
from	address
to	address
value	uint256

Properties

Visibility internal

Mutability transaction

Requirements

the sender's address must not be equal to UNKNOWN VALUE

to must not be equal to UNKNOWN VALUE

Source Code

function _transfer(
  address from,
  address to,
  uint256 value
) internal {
  require(from != address(0), "ERC20: transfer from the zero address");
  require(to != address(0), "ERC20: transfer to the zero address");
  require(to != address(this), "ERC20: transfer to the contract address");

  _balances[from] = _balances[from].sub(value);
  _balances[to] = _balances[to].add(value);
  emit Transfer(from, to, value);
}

internal ERC20._mint

Parameters

Name	Type
account	address
value	uint256

Properties

Visibility internal

Mutability transaction

Requirements

_from must not be equal to UNKNOWN VALUE

_value must not be equal to 0

Source Code

function _mint(address account, uint256 value) internal {
  require(account != address(0), "ERC20: mint to the zero address");
  require(account != address(this), "ERC20: mint to the contract address");
  require(value != 0, "ERC20: mint value must be positive");

  _totalSupply = _totalSupply.add(value);
  _balances[account] = _balances[account].add(value);
  emit Transfer(address(0), account, value);
}

internal ERC20._burn

Parameters

Name	Type
account	address
value	uint256

Properties

Visibility internal

Mutability transaction

Requirements

the sender's address must not be equal to UNKNOWN VALUE

Source Code

function _burn(address account, uint256 value) internal {
  require(account != address(0), "ERC20: burn from the zero address");
  require(account != address(this), "ERC20: burn from the contract address");

  _totalSupply = _totalSupply.sub(value);
  _balances[account] = _balances[account].sub(value);
  emit Transfer(account, address(0), value);
}

internal ERC20._approve

Parameters

Name	Type
owner	address
spender	address
value	uint256

Properties

Visibility internal

Mutability transaction

Requirements

the sender's address must not be equal to UNKNOWN VALUE

spender must not be equal to UNKNOWN VALUE

Source Code

function _approve(
  address owner,
  address spender,
  uint256 value
) internal {
  require(owner != address(0), "ERC20: approve from the zero address");
  require(spender != address(0), "ERC20: approve to the zero address");

  _allowances[owner][spender] = value;
  emit Approval(owner, spender, value);
}

internal ERC20._burnFrom

Parameters

Name	Type
account	address
value	uint256

Properties

Visibility internal

Mutability transaction

Requirements

the sender's address must not be equal to UNKNOWN VALUE

Source Code

function _burnFrom(address account, uint256 value) internal {
  _burn(account, value);
  _approve(account, msg.sender, _allowances[account][msg.sender].sub(value));
}

internal Pausable.constructor

Parameters

This function has no parameters.

Properties

Visibility internal

Mutability transaction

Source Code

constructor() internal {
  _paused = false;
}

internal PauserRole.constructor

Parameters

This function has no parameters.

Properties

Visibility internal

Mutability transaction

Source Code

constructor() internal {
  _addPauser(msg.sender);
}

internal PauserRole._addPauser

Parameters

Name	Type
account	address

Properties

Visibility internal

Mutability transaction

Source Code

function _addPauser(address account) internal {
  _pausersCount = _pausersCount.add(1);
  _pausers.add(account);
  emit PauserAdded(account);
}

internal PauserRole._removePauser

Parameters

Name	Type
account	address

Properties

Visibility internal

Mutability transaction

Requirements

_pausersCount must be greater than 1

Source Code

function _removePauser(address account) internal {
  require(
    _pausersCount > 1,
    "PauserRole: there should always be at least one pauser left"
  );
  _pausersCount = _pausersCount.sub(1);
  _pausers.remove(account);
  emit PauserRemoved(account);
}

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), "Ownable: new owner is the zero address");
  require(
    newOwner != address(this),
    "Ownable: new owner is the contract address"
  );
  emit OwnershipTransferred(_owner, newOwner);
  _owner = newOwner;
}

Blockium Token

ERC20

About

Stats

Library Use

Events (9) keyboard_arrow_up

Approval Event

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

LogUpgrade Event

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

LogUpgradeAgentSet 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.

Paused Event

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

PauserAdded Event

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

PauserRemoved 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.

Unpaused Event

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

Constants (1) keyboard_arrow_up

MAX_UINT Constant

State Variables (15) keyboard_arrow_up

upgradeMaster Variable

upgradeAgent Variable

totalUpgraded Variable

previousToken Variable

version Variable

_balances Variable

_allowances Variable

_totalSupply Variable

_paused Variable

_pausers Variable

_pausersCount Variable

_name Variable

_symbol Variable

_decimals Variable

_owner Variable

Functions Expand All Collapse All

isUpgradeAgent 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

upgradeFrom keyboard_arrow_up

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

Properties

Modifiers help Modifiers are additions to a function that typically make various checks before the function is run.

validateAddress checks for the following:

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

owner 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

isOwner 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

transferOwnership keyboard_arrow_up

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

Properties

Modifiers help Modifiers are additions to a function that typically make various checks before the function is run.

onlyOwner checks for the following:

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

name 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

symbol 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

decimals keyboard_arrow_up

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

Properties

Events (9)

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Constants (1)

State Variables (15)

isUpgradeAgent

Parameters

upgradeFrom

Parameters

Modifiers

Requirements

owner

Parameters

isOwner

Parameters

transferOwnership

Parameters

Modifiers

Requirements

name

Parameters

symbol

Parameters

decimals

Parameters

isPauser

Parameters

addPauser

Parameters

Modifiers

removePauser

Parameters

Modifiers

Requirements

paused

Parameters

pause

Parameters

Modifiers

unpause

Parameters

Modifiers

totalSupply

Parameters

balanceOf

Parameters

allowance

Parameters

transfer

Parameters

Modifiers

Requirements

approve

Parameters

Modifiers

Requirements

transferFrom

Parameters

Modifiers

Requirements