OceanToken

0x985dd3d42de1e256d09e1c10f112bccb8015ad41 Copy

ERC20

This contract is an ERC20 token.

Name OceanToken

Symbol OCEAN

Decimals 18

Total Supply 613,099,141 OCEAN

About

Stats

Public Functions 32

Event Types 9

Code Size 25,556 bytes

Library Use

Uses SafeMath for uint256.

Events (9)

Approval Event

Parameters

owner	address
spender	address
value	uint256

MinterAdded Event

Parameters

account

address

MinterRemoved Event

Parameters

account

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 (2)

DECIMALS Constant

uint8

CAP Constant

uint256

690900000

State Variables (14)

TOTALSUPPLY Variable

uint256

Internal Variable

accounts Variable

address[]

Internal Variable

tokenHolders Variable

mapping(address => bool)

Internal Variable

_owner Variable

address

Internal Variable

_balances Variable

mapping(address => uint256)

Internal Variable

_allowed Variable

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

Internal Variable

_totalSupply Variable

uint256

Internal Variable

_paused Variable

bool

Internal Variable

_pausers Variable

Roles.Role

Internal Variable

_name Variable

string

Internal Variable

_symbol Variable

string

Internal Variable

_decimals Variable

uint8

Internal Variable

_cap Variable

uint256

Internal Variable

_minters Variable

Roles.Role

Internal Variable

Functions Expand All Collapse All

isMinter

Parameters

Name	Type
account	address

Properties

Visibility public

Mutability view

Source Code

function isMinter(address account) public view returns (bool) {
  return _minters.has(account);
}

addMinter

Parameters

Name	Type
account	address

Properties

Visibility public

Mutability transaction

Modifiers

onlyMinter checks for the following:

null

Source Code

function addMinter(address account) public onlyMinter {
  _addMinter(account);
}

renounceMinter

Parameters

This function has no parameters.

Properties

Visibility public

Mutability transaction

Source Code

function renounceMinter() public {
  _removeMinter(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 _allowed[owner][spender];
}

transfer

Parameters

Name	Type
_to	address
_value	uint256

Properties

Visibility public

Mutability transaction

Source Code

function transfer(address _to, uint256 _value) public returns (bool) {
  bool success = super.transfer(_to, _value);
  if (success) {
    updateTokenHolders(msg.sender, _to);
  }
  return success;
}

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

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

Source Code

function transferFrom(
  address _from,
  address _to,
  uint256 _value
) public returns (bool) {
  bool success = super.transferFrom(_from, _to, _value);
  if (success) {
    updateTokenHolders(_from, _to);
  }
  return success;
}

increaseAllowance

Parameters

Name	Type
spender	address
addedValue	uint256

Properties

Visibility public

Mutability transaction

Requirements

spender must not be equal to UNKNOWN VALUE

Source Code

function increaseAllowance(address spender, uint256 addedValue)
  public
  returns (bool)
{
  require(spender != address(0));

  _allowed[msg.sender][spender] = _allowed[msg.sender][spender].add(addedValue);
  emit Approval(msg.sender, spender, _allowed[msg.sender][spender]);
  return true;
}

decreaseAllowance

Parameters

Name	Type
spender	address
subtractedValue	uint256

Properties

Visibility public

Mutability transaction

Requirements

spender must not be equal to UNKNOWN VALUE

Source Code

function decreaseAllowance(address spender, uint256 subtractedValue)
  public
  returns (bool)
{
  require(spender != address(0));

  _allowed[msg.sender][spender] = _allowed[msg.sender][spender].sub(
    subtractedValue
  );
  emit Approval(msg.sender, spender, _allowed[msg.sender][spender]);
  return true;
}

mint

Parameters

Name	Type
to	address
value	uint256

Properties

Visibility public

Mutability transaction

Modifiers

onlyMinter checks for the following:

null

Requirements

to must not be equal to UNKNOWN VALUE

Source Code

function mint(address to, uint256 value) public onlyMinter returns (bool) {
  _mint(to, value);
  return true;
}

cap

Parameters

This function has no parameters.

Properties

Visibility public

Mutability view

Source Code

function cap() public view returns (uint256) {
  return _cap;
}

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

renouncePauser

Parameters

This function has no parameters.

Properties

Visibility public

Mutability transaction

Source Code

function renouncePauser() public {
  _removePauser(msg.sender);
}

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

increaseAllowance

Parameters

Name	Type
spender	address
addedValue	uint

Properties

Visibility public

Mutability transaction

Modifiers

whenNotPaused checks for the following:

_paused must not be true

Requirements

spender must not be equal to UNKNOWN VALUE

Source Code

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

decreaseAllowance

Parameters

Name	Type
spender	address
subtractedValue	uint

Properties

Visibility public

Mutability transaction

Modifiers

whenNotPaused checks for the following:

_paused must not be true

Requirements

spender must not be equal to UNKNOWN VALUE

Source Code

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

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

getAccounts

Parameters

Name	Type
_start	uint256
_end	uint256

Properties

Visibility public

Mutability view

Modifiers

onlyOwner checks for the following:

null

Requirements

_end must be less than the number of values in accounts

_start must be less than or equal to _end

Source Code

function getAccounts(uint256 _start, uint256 _end)
  external
  view
  onlyOwner
  returns (address[] memory, uint256[] memory)
{
  require(
    _start <= _end && _end < accounts.length,
    "Array index out of bounds"
  );

  uint256 length = _end.sub(_start).add(1);

  address[] memory _tokenHolders = new address[](length);
  uint256[] memory _tokenBalances = new uint256[](length);

  for (uint256 i = _start; i <= _end; i++) {
    address account = accounts[i];
    uint256 accountBalance = super.balanceOf(account);
    if (accountBalance > 0) {
      _tokenBalances[i] = accountBalance;
      _tokenHolders[i] = account;
    }
  }

  return (_tokenHolders, _tokenBalances);
}

getAccountsLength

Parameters

This function has no parameters.

Properties

Visibility public

Mutability view

Modifiers

onlyOwner checks for the following:

null

Source Code

function getAccountsLength() external view onlyOwner returns (uint256) {
  return accounts.length;
}

kill

Parameters

This function has no parameters.

Properties

Visibility public

Mutability transaction

Modifiers

onlyOwner checks for the following:

null

Source Code

function kill() external onlyOwner {
  selfdestruct(address(uint160(owner())));
}

constructor

Parameters

This function has no parameters.

Properties

Visibility public

Mutability payable

Source Code

function() external payable {
  revert("Invalid ether transfer");
}

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 OceanToken.tryToAddTokenHolder

Parameters

Name	Type
account	address

Properties

Visibility private

Mutability transaction

Source Code

function tryToAddTokenHolder(address account) private {
  if (!tokenHolders[account] && super.balanceOf(account) > 0) {
    accounts.push(account);
    tokenHolders[account] = true;
  }
}

internal OceanToken.updateTokenHolders

Parameters

Name	Type
sender	address
receiver	address

Properties

Visibility private

Mutability transaction

Source Code

function updateTokenHolders(address sender, address receiver) private {
  tryToAddTokenHolder(sender);
  tryToAddTokenHolder(receiver);
}

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

Parameters

Name	Type
from	address
to	address
value	uint256

Properties

Visibility internal

Mutability transaction

Requirements

to must not be equal to UNKNOWN VALUE

Source Code

function _transfer(
  address from,
  address to,
  uint256 value
) internal {
  require(to != address(0));

  _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

to must not be equal to UNKNOWN VALUE

Source Code

function _mint(address account, uint256 value) internal {
  require(account != address(0));

  _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

account must not be equal to UNKNOWN VALUE

Source Code

function _burn(address account, uint256 value) internal {
  require(account != address(0));

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

internal ERC20._burnFrom

Parameters

Name	Type
account	address
value	uint256

Properties

Visibility internal

Mutability transaction

Requirements

account must not be equal to UNKNOWN VALUE

Source Code

function _burnFrom(address account, uint256 value) internal {
  _allowed[account][msg.sender] = _allowed[account][msg.sender].sub(value);
  _burn(account, value);
  emit Approval(account, msg.sender, _allowed[account][msg.sender]);
}

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 {
  _pausers.add(account);
  emit PauserAdded(account);
}

internal PauserRole._removePauser

Parameters

Name	Type
account	address

Properties

Visibility internal

Mutability transaction

Source Code

function _removePauser(address account) internal {
  _pausers.remove(account);
  emit PauserRemoved(account);
}

internal ERC20Capped._mint

Parameters

Name	Type
account	address
value	uint256

Properties

Visibility internal

Mutability transaction

Requirements

_cap must be greater than or equal to UNKNOWN VALUE

to must not be equal to UNKNOWN VALUE

Source Code

function _mint(address account, uint256 value) internal {
  require(totalSupply().add(value) <= _cap);
  super._mint(account, value);
}

internal ERC20._transfer

Parameters

Name	Type
from	address
to	address
value	uint256

Properties

Visibility internal

Mutability transaction

Requirements

to must not be equal to UNKNOWN VALUE

Source Code

function _transfer(
  address from,
  address to,
  uint256 value
) internal {
  require(to != address(0));

  _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

to must not be equal to UNKNOWN VALUE

Source Code

function _mint(address account, uint256 value) internal {
  require(account != address(0));

  _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

account must not be equal to UNKNOWN VALUE

Source Code

function _burn(address account, uint256 value) internal {
  require(account != address(0));

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

internal ERC20._burnFrom

Parameters

Name	Type
account	address
value	uint256

Properties

Visibility internal

Mutability transaction

Requirements

account must not be equal to UNKNOWN VALUE

Source Code

function _burnFrom(address account, uint256 value) internal {
  _allowed[account][msg.sender] = _allowed[account][msg.sender].sub(value);
  _burn(account, value);
  emit Approval(account, msg.sender, _allowed[account][msg.sender]);
}

internal MinterRole.constructor

Parameters

This function has no parameters.

Properties

Visibility internal

Mutability transaction

Source Code

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

internal MinterRole._addMinter

Parameters

Name	Type
account	address

Properties

Visibility internal

Mutability transaction

Source Code

function _addMinter(address account) internal {
  _minters.add(account);
  emit MinterAdded(account);
}

internal MinterRole._removeMinter

Parameters

Name	Type
account	address

Properties

Visibility internal

Mutability transaction

Source Code

function _removeMinter(address account) internal {
  _minters.remove(account);
  emit MinterRemoved(account);
}

OceanToken

ERC20

About

Stats

Library Use

Events (9) keyboard_arrow_up

Approval Event

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

MinterAdded Event

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

MinterRemoved 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 (2) keyboard_arrow_up

DECIMALS Constant

CAP Constant

State Variables (14) keyboard_arrow_up

TOTALSUPPLY Variable

accounts Variable

tokenHolders Variable

_owner Variable

_balances Variable

_allowed Variable

_totalSupply Variable

_paused Variable

_pausers Variable

_name Variable

_symbol Variable

_decimals Variable

_cap Variable

_minters Variable

Functions Expand All Collapse All

isMinter 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

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

onlyMinter checks for the following:

Source Code

renounceMinter 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

totalSupply 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

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

Source Code

allowance 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

transfer 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

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

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

whenNotPaused 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

Events (9)

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Constants (2)

State Variables (14)

isMinter

Parameters

addMinter

Parameters

Modifiers

renounceMinter

Parameters

totalSupply

Parameters

balanceOf

Parameters

allowance

Parameters

transfer

Parameters

approve

Parameters

Modifiers

Requirements

transferFrom

Parameters

increaseAllowance

Parameters

Requirements

decreaseAllowance

Parameters

Requirements

mint

Parameters

Modifiers

Requirements

cap

Parameters

name

Parameters

symbol

Parameters

decimals

Parameters

isPauser

Parameters

addPauser

Parameters

Modifiers

renouncePauser

Parameters

paused

Parameters

pause

Parameters

Modifiers

unpause

Parameters

Modifiers