SUKU

0x0763fdccf1ae541a5961815c0872a8c5bc6de4d7 Copy

ERC20

This contract is an ERC20 token.

Name SUKU

Symbol SUKU

Decimals 18

Total Supply 1,500,000,000 SUKU

About

SUKU (SUKU) is a cryptocurrency and operates on the Ethereum platform. SUKU has a current supply of 1,500,000,000 with 119,149,903 in circulation. The last known price of SUKU is 0.16801199 USD and is down -4.44 over the last 24 hours. It is currently trading on 7 active market(s) with $212,808.85 traded over the last 24 hours. More information can be found at https://www.suku.world/.

Stats

Public Functions 26

Event Types 9

Code Size 27,002 bytes

Events (9)

AddressAddedToWhitelist Event

Parameters

addedAddress	address
whitelist	uint8
addedBy	address

AddressRemovedFromWhitelist Event

Parameters

removedAddress	address
whitelist	uint8
removedBy	address

AdminAdded Event

Parameters

addedAdmin	address
addedBy	address

AdminRemoved Event

Parameters

removedAdmin	address
removedBy	address

Approval Event

Parameters

owner	address
spender	address
value	uint256

OutboundWhitelistUpdated Event

Parameters

updatedBy	address
sourceWhitelist	uint8
destinationWhitelist	uint8
from	bool
to	bool

OwnershipTransferred Event

Parameters

previousOwner	address
newOwner	address

RestrictionsDisabled Event

Parameters

owner

address

Transfer Event

Parameters

from	address
to	address
value	uint256

Constants (11)

TOKEN_NAME Constant

string

SUKU

TOKEN_SYMBOL Constant

string

SUKU

TOKEN_DECIMALS Constant

uint8

HUNDRED_MILLION Constant

uint256

100000000

TOKEN_SUPPLY Constant

uint256

15 * HUNDRED_MILLION * UNKNOWN VALUE

SUCCESS_CODE Constant

uint8

FAILURE_NON_WHITELIST Constant

uint8

SUCCESS_MESSAGE Constant

string

SUCCESS

FAILURE_NON_WHITELIST_MESSAGE Constant

string

The transfer was restricted due to white list configuration.

UNKNOWN_ERROR Constant

string

Unknown Error Code

NO_WHITELIST Constant

uint8

State Variables (11)

addressWhitelists Variable

mapping(address => uint8)

administrators Variable

mapping(address => bool)

_balances Variable

mapping(address => uint256)

Internal Variable

_allowed Variable

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

Internal Variable

_totalSupply Variable

uint256

Internal Variable

_name Variable

string

Internal Variable

_symbol Variable

string

Internal Variable

_decimals Variable

uint8

Internal Variable

outboundWhitelistsEnabled Variable

mapping(uint8 => mapping(uint8 => bool))

Internal Variable

_owner Variable

address

Internal Variable

_restrictionsEnabled Variable

bool

Internal Variable

Functions Expand All Collapse All

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

isRestrictionEnabled

Parameters

This function has no parameters.

Properties

Visibility public

Mutability view

Source Code

function isRestrictionEnabled() public view returns (bool) {
  return _restrictionsEnabled;
}

disableRestrictions

Parameters

This function has no parameters.

Properties

Visibility public

Mutability transaction

Modifiers

onlyOwner checks for the following:

null

Requirements

_restrictionsEnabled must be true

Source Code

function disableRestrictions() public onlyOwner {
  require(_restrictionsEnabled, "Restrictions are already disabled.");

  // Set the flag
  _restrictionsEnabled = false;

  // Trigger the event
  emit RestrictionsDisabled(msg.sender);
}

isAdministrator

Parameters

Name	Type
addressToTest	address

Properties

Visibility public

Mutability view

Source Code

function isAdministrator(address addressToTest) public view returns (bool) {
  return administrators[addressToTest];
}

addAdmin

Parameters

Name	Type
adminToAdd	address

Properties

Visibility public

Mutability transaction

Modifiers

onlyOwner checks for the following:

null

Requirements

administrators for adminToAdd must be equal to false

Source Code

function addAdmin(address adminToAdd) public onlyOwner {
  // Verify the account is not already an admin
  require(
    administrators[adminToAdd] == false,
    "Account to be added to admin list is already an admin"
  );

  // Set the address mapping to true to indicate it is an administrator account.
  administrators[adminToAdd] = true;

  // Emit the event for any watchers.
  emit AdminAdded(adminToAdd, msg.sender);
}

removeAdmin

Parameters

Name	Type
adminToRemove	address

Properties

Visibility public

Mutability transaction

Modifiers

onlyOwner checks for the following:

null

Requirements

administrators for adminToRemove must be equal to true

Source Code

function removeAdmin(address adminToRemove) public onlyOwner {
  // Verify the account is an admin
  require(
    administrators[adminToRemove] == true,
    "Account to be removed from admin list is not already an admin"
  );

  // Set the address mapping to false to indicate it is NOT an administrator account.
  administrators[adminToRemove] = false;

  // Emit the event for any watchers.
  emit AdminRemoved(adminToRemove, msg.sender);
}

addToWhitelist

Parameters

Name	Type
addressToAdd	address
whitelist	uint8

Properties

Visibility public

Mutability transaction

Modifiers

onlyAdministrator checks for the following:

null

Requirements

whitelist must not be equal to NO_WHITELIST

Source Code

function addToWhitelist(address addressToAdd, uint8 whitelist)
  public
  onlyAdministrator
{
  // Verify the whitelist is valid
  require(whitelist != NO_WHITELIST, "Invalid whitelist ID supplied");

  // Save off the previous white list
  uint8 previousWhitelist = addressWhitelists[addressToAdd];

  // Set the address's white list ID
  addressWhitelists[addressToAdd] = whitelist;

  // If the previous whitelist existed then we want to indicate it has been removed
  if (previousWhitelist != NO_WHITELIST) {
    // Emit the event for tracking
    emit AddressRemovedFromWhitelist(
      addressToAdd,
      previousWhitelist,
      msg.sender
    );
  }

  // Emit the event for new whitelist
  emit AddressAddedToWhitelist(addressToAdd, whitelist, msg.sender);
}

removeFromWhitelist

Parameters

Name	Type
addressToRemove	address

Properties

Visibility public

Mutability transaction

Modifiers

onlyAdministrator checks for the following:

null

Source Code

function removeFromWhitelist(address addressToRemove) public onlyAdministrator {
  // Save off the previous white list
  uint8 previousWhitelist = addressWhitelists[addressToRemove];

  // Zero out the previous white list
  addressWhitelists[addressToRemove] = NO_WHITELIST;

  // Emit the event for tracking
  emit AddressRemovedFromWhitelist(
    addressToRemove,
    previousWhitelist,
    msg.sender
  );
}

updateOutboundWhitelistEnabled

Parameters

Name	Type
sourceWhitelist	uint8
destinationWhitelist	uint8
newEnabledValue	bool

Properties

Visibility public

Mutability transaction

Modifiers

onlyAdministrator checks for the following:

null

Source Code

function updateOutboundWhitelistEnabled(
  uint8 sourceWhitelist,
  uint8 destinationWhitelist,
  bool newEnabledValue
) public onlyAdministrator {
  // Get the old enabled flag
  bool oldEnabledValue = outboundWhitelistsEnabled[sourceWhitelist][
    destinationWhitelist
  ];

  // Update to the new value
  outboundWhitelistsEnabled[sourceWhitelist][
    destinationWhitelist
  ] = newEnabledValue;

  // Emit event for tracking
  emit OutboundWhitelistUpdated(
    msg.sender,
    sourceWhitelist,
    destinationWhitelist,
    oldEnabledValue,
    newEnabledValue
  );
}

checkWhitelistAllowed

Parameters

Name	Type
sender	address
receiver	address

Properties

Visibility public

Mutability view

Source Code

function checkWhitelistAllowed(address sender, address receiver)
  public
  view
  returns (bool)
{
  // First get each address white list
  uint8 senderWhiteList = addressWhitelists[sender];
  uint8 receiverWhiteList = addressWhitelists[receiver];

  // If either address is not on a white list then the check should fail
  if (senderWhiteList == NO_WHITELIST || receiverWhiteList == NO_WHITELIST) {
    return false;
  }

  // Determine if the sending whitelist is allowed to send to the destination whitelist
  return outboundWhitelistsEnabled[senderWhiteList][receiverWhiteList];
}

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

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

Modifiers

notRestricted checks for the following:

restrictionCode must be equal to SUCCESS_CODE

Source Code

function transfer(address to, uint256 value)
  public
  notRestricted(msg.sender, to, value)
  returns (bool success)
{
  success = super.transfer(to, value);
}

approve

Parameters

Name	Type
spender	address
value	uint256

Properties

Visibility public

Mutability transaction

Requirements

spender must not be equal to UNKNOWN VALUE

Source Code

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

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

transferFrom

Parameters

Name	Type
from	address
to	address
value	uint256

Properties

Visibility public

Mutability transaction

Modifiers

notRestricted checks for the following:

restrictionCode must be equal to SUCCESS_CODE

Source Code

function transferFrom(
  address from,
  address to,
  uint256 value
) public notRestricted(from, to, value) returns (bool success) {
  success = super.transferFrom(from, to, value);
}

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

detectTransferRestriction

Parameters

Name	Type
from	address
to	address
	uint256

Properties

Visibility public

Mutability view

Source Code

function detectTransferRestriction(
  address from,
  address to,
  uint256
) public view returns (uint8) {
  // If the restrictions have been disabled by the owner, then just return success
  // Logic defined in Restrictable parent class
  if (!isRestrictionEnabled()) {
    return SUCCESS_CODE;
  }

  // If the contract owner is transferring, then ignore reistrictions
  if (from == owner()) {
    return SUCCESS_CODE;
  }

  // Restrictions are enabled, so verify the whitelist config allows the transfer.
  // Logic defined in Whitelistable parent class
  if (!checkWhitelistAllowed(from, to)) {
    return FAILURE_NON_WHITELIST;
  }

  // If no restrictions were triggered return success
  return SUCCESS_CODE;
}

messageForTransferRestriction

Parameters

Name	Type
restrictionCode	uint8

Properties

Visibility public

Mutability view

Source Code

function messageForTransferRestriction(uint8 restrictionCode)
  public
  view
  returns (string memory)
{
  if (restrictionCode == SUCCESS_CODE) {
    return SUCCESS_MESSAGE;
  }

  if (restrictionCode == FAILURE_NON_WHITELIST) {
    return FAILURE_NON_WHITELIST_MESSAGE;
  }

  // An unknown error code was passed in.
  return UNKNOWN_ERROR;
}

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

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

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

SUKU

ERC20

About link description

Stats

Events (9) keyboard_arrow_up

AddressAddedToWhitelist Event

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

AddressRemovedFromWhitelist Event

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

AdminAdded Event

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

AdminRemoved Event

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

Approval Event

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

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

RestrictionsDisabled 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 (11) keyboard_arrow_up

TOKEN_NAME Constant

TOKEN_SYMBOL Constant

TOKEN_DECIMALS Constant

HUNDRED_MILLION Constant

TOKEN_SUPPLY Constant

SUCCESS_CODE Constant

FAILURE_NON_WHITELIST Constant

SUCCESS_MESSAGE Constant

FAILURE_NON_WHITELIST_MESSAGE Constant

UNKNOWN_ERROR Constant

NO_WHITELIST Constant

State Variables (11) keyboard_arrow_up

addressWhitelists Variable

administrators Variable

_balances Variable

_allowed Variable

_totalSupply Variable

_name Variable

_symbol Variable

_decimals Variable

outboundWhitelistsEnabled Variable

_owner Variable

_restrictionsEnabled Variable

Functions Expand All Collapse All

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

renounceOwnership 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:

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

isRestrictionEnabled 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

disableRestrictions 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

About

Events (9)

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Constants (11)

State Variables (11)

owner

Parameters

isOwner

Parameters

renounceOwnership

Parameters

Modifiers

transferOwnership

Parameters

Modifiers

Requirements

isRestrictionEnabled

Parameters

disableRestrictions

Parameters

Modifiers

Requirements

isAdministrator

Parameters

addAdmin

Parameters

Modifiers

Requirements

removeAdmin

Parameters

Modifiers

Requirements

addToWhitelist

Parameters

Modifiers

Requirements

removeFromWhitelist

Parameters

Modifiers

updateOutboundWhitelistEnabled

Parameters

Modifiers

checkWhitelistAllowed

Parameters

name

Parameters

symbol

Parameters

decimals

Parameters

totalSupply

Parameters

balanceOf

Parameters

allowance

Parameters

transfer

Parameters

Modifiers