Cashbox

Cashbox is a capital efficient market where users can deposit any ERC20 token and recieve a Pool Token which is an ownership token for your share of the pool. Users can use the cashbox to deposit a STOCK token and recieve the ERC20 at the determined rate. When buring the Pool Token for the contents of the pool token you will always recieve Stock Token as the first priority. If there isnt enought Stock Token the remaining balance will be given in the ERC20 token. There is also a Upper Cap which limits the minting of pool tokens when that upper cap is eached.

Constructor

constructor (address cashAddress,address stockTokenAddress,uint256 _stockToCashRate,uint256 cashCap,string memory name,string memory symbol,string memory _url)

1. cashAddress = The address of the ERC20 token used to provide as exchange for the Stock token.
2. stockTokenAddress = The addressof the stock token
3. stockToCashRate = Ratio of Stock to Cash
4. cashCap = The total value in ERC20 token allowed to be in the smart contract after which it will not allow more deposits
5. name = The name of the pool token
6. symbol = Symbol of the pool token
7. url = A string to be saved in the smart contract

CashBox Functions

function updateURL(string memory _url) public onlyOwner returns(string memory)

Allow the owner to update the URL string.

function updateCashValuationCap(uint256 daiCap) public onlyOwner returns(uint256)

Allows the owner to update the Upper Cap of the contract.

function stockTokenAddress() public view returns (address)

Returns Stock Token Address

function StockTokenAddress() public view returns (address)

Returns the address fof the stock token.

function _preValidateData(address beneficiary, uint256 Amount) internal pure

Checks if wither address is a zero address or if amount is zero

function contractCashBalance() public view returns(uint256 daiBalance)

Returns the balance of the ERC20 token.

function contractStockTokenBalance() public view returns(uint256 stockTokenBalance)

Returns the balance of the Stock Token.

function stockTokenCashValuation() internal view returns(uint256)

Returns the Value held in the contract in Cash .

function updatedPoolRate() internal returns (uint256 poolrate)

Updates the value of the Pool token in respect to the ERC20 token.

function mintPoolToken(uint256 inputCashAmount) external

Mints pool tokens if the Upper Cap is not reached, based on the value held in the smart contract.

function burnPoolToken(uint256 poolTokenAmount) external

Burns the pool token as return in Stock Token and the remaining amount in ERC20 when Stock Tokens are depleted.

function redeemStockToken(uint256 stockTokenAmount) external

Trade Stock token for the ERC20 according to the exchange rate.

function kill() external onlyOwner

Selfdestructs the contract

All other functions used are of Open Zeppelin.