ERC20 totalSupply not returning the correct value

Question

I am testing an ERC20 contract based on Openzeppelin-solidity template. But I am observing a curious behavior with reading a global variable. Here is the contract:

pragma solidity ^0.4.24;

import "../node_modules/openzeppelin-solidity/contracts/token/ERC20/ERC20.sol";


contract FunnyToken is ERC20 {
    string public constant name = "FunnyToken";
    string public constant symbol = "FYT";
    uint8 public constant decimals = 18;
    uint256 private _totalSupply = 10000 * (10 ** uint256(decimals));
    address private owner;

    constructor() public {
        owner = msg.sender;
    }
}

then I truffle migrate it to ganache-cli and run the following commands on truffle console:

FunnyToken.deployed().then(inst=> tok=inst);
tok.totalSupply();

the value returne is: BigNumber { s: 1, e: 0, c: [ 0 ] }. So I conclude that the _totalSupply global variable is not being initialized properly, because the function totalSupply is implemented like this:

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

Can anyone explain me what is going on?

Answer 1

The problem is that you are creating a new storage variable in your FunnyToken contract. The base contract will still access the old storage variable.

One solution is to assign the value in the constructor.

pragma solidity ^0.4.0;

contract TokenBase {
    uint _totalSupply;
    function totalSupply() public view returns (uint) {
        return _totalSupply;
    }
}

contract Token is TokenBase {
    // uint _totalSupply = 4321; // <-- this creates a new storage variable
    constructor() public {
        _totalSupply = 1234; // It is better to initialize the old variable
    }
}

Another possible solution is to override the function totalSupply() in your contract, but you will be wasting an extra slot of storage.

Answer 2

All you need to do is convert the bignumber to an actual number. Additionally, considering how many people use open zeppelin, seems pretty unusual for this to happen. Try to display the bignumber as a number.

const number = tok.totalSupply()
number.toNumber()

See How to convert BigNumber to Number in Truffle framework?

Answer 3

I found the answer to my own question: Upon inheritance, derived contracts cannot access private variables from the base contract (funny, but true) therefore the when I call totalSupply (defined the base contract) it will access the _totalSupply from the base contract, instead of the one I defined on the derived contract, thus returning 0.

I guess that to get around this I'd have to overload the totalSupply method on the derived contract. I haven't tested that though.

Answer 4

You declared _totalSupply as

uint256 private _totalSupply = 10000 * (10 ** uint256(decimals));

Since it's a private variable inside your base contract, you won't be able to call it from any of your derived contracts (Reason).

Now, it's even simpler to bypass the same in Solidity ^0.5.0:

pragma solidity ^0.5.0;

import 'openzeppelin-solidity/contracts/token/ERC721/ERC721Full.sol';
import 'openzeppelin-solidity/contracts/token/ERC721/ERC721Mintable.sol';

contract FunnyToken is ERC20 {
    string public constant name = "FunnyToken";
    string public constant symbol = "FYT";
    uint8 public constant decimals = 18;
    uint256 public _totalSupply = 10000;
    address private owner;

    constructor() public {
        owner = msg.sender;
    }
}

Hope am clear on the above. Thanks