Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove mint and burn func #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

remove mint and burn func #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
node_modules
.env
coverage
coverage.json
typechain
typechain-types

# Hardhat files
cache
artifacts

5 changes: 0 additions & 5 deletions README.md
View file
Open in desktop

This file was deleted.

Empty file added contracts/.gitkeep
View file
Open in desktop
Empty file.
16 changes: 7 additions & 9 deletions contracts/IStockToken.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
// SPDX-License-Identifier: MIT

pragma solidity 0.8.4;
pragma solidity 0.8.17;

interface IStockToken {
/// @dev Function to mint the stock token into the user's wallet; called by the Reflection wallet when the user
/// buys a stock token on the Reflection platform
/// @param to The user's wallet address into which the StockToken will be minted
/// @param _amount The number of StockTokens that will be minted into the user's wallet
/// @dev Function to mint the stock token into the user's wallet; called when the user buys a stock token on the Reflection platform
/// @param to (address)
/// @param _amount (uint256)
function mint(address to, uint256 _amount) external;

/// @dev Function to burn the stock token out of the user's wallet; called by the Reflection wallet when the user
/// sells a stock token on the Reflection platform
/// @param from The user's wallet address from which the StockTokens will be burned
/// @param _amount The number of StockTokens that will be burned out of the user's wallet
/// @dev Function to burn the stock token out of the user's wallet; called when the user sells a stock token on the Reflection platform
/// @param from (address)
/// @param _amount (uint256)
function burn(address from, uint256 _amount) external;
}
188 changes: 85 additions & 103 deletions contracts/RUSD.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: MIT

pragma solidity 0.8.4;
pragma solidity 0.8.17;

import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
Expand All @@ -9,167 +9,149 @@ import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
import "./IStockToken.sol";

/// @title RUSD
/// @dev This is the Reflection stablecoin, similar to other stablecoins such as USDC and USDT. It is backed 1-to-1
/// by a combination of US dollars and other stablecoins which in turn are backed by US dollars. RUSD can be
/// used to buy Reflection stock tokens, and, likewise, stock tokens can be redeemed for RUSD. */
/// @dev This is the Reflection stablecoin, similar to other stablecoins such as USDC and BUSD. It is backed 1-to-1 by a combination of US dollars and other stablecoins which in turn are backed by US dollars. RUSD can be used to buy Reflection stock tokens, and, likewise, stock tokens can be redeemed for RUSD. */
contract RUSD is ERC20, Ownable, ReentrancyGuard {
address public refWalletAddress;
using SafeERC20 for IERC20;
address public refWalletAddress;

/// @dev Access Modifier for methods that may only be called by the Reflection wallet
modifier onlyRefWallet() {
require(msg.sender == refWalletAddress, "Only ref wallet");
_;
}

/// @dev Constructor
/// @param _refWalletAddress Reflection wallet address that is allowed to call the methods with the onlyRefWallet
/// modifier
constructor(address _refWalletAddress) ERC20("Reflection USD Stablecoin", "RUSD") {
require(_refWalletAddress != address(0), "Zero Ref Address");
refWalletAddress = _refWalletAddress;
}
// events

// events
event SetRefWalletAddress(address RefWalletAddress);
event BuyStock(
address UserAddress,
event BuyStock(address UserAddress,
address StableCoinAddress,
address StockTokenAddress,
uint256 StableCoinAmount,
uint256 StockTokenAmount
);
uint256 StockTokenAmount);
event SellStock(
address UserAddress,
address StableCoinAddress,
address StockTokenAddress,
uint256 StableCoinAmount,
uint256 StockTokenAmount
);
event BuyRusd(address UserAddress, address StableCoinAddress, uint256 Amount);
event SellRusd(address UserAddress, address StableCoinAddress, uint256 Amount);
event SellRusd(
address UserAddress,
address StableCoinAddress,
uint256 Amount
);
event BuyRusd(
address UserAddress,
address StableCoinAddress,
uint256 Amount
);

/// @dev Access Modifier for methods that may only be called by the Reflection wallet
modifier onlyRefWalletAddress() {
require(msg.sender == refWalletAddress, "Only ref wallet");
_;
}

/// @dev Constructor
/// @param _refWalletAddress (address) Reflection wallet address that will be calling the methods
constructor(address _refWalletAddress) ERC20("Reflection USD Stablecoin", "RUSD") {
require(_refWalletAddress != address(0), "Zero Ref Address");
refWalletAddress = _refWalletAddress;
}

/// @dev Update the ref wallet address. This would most likely never be necessary, but it could be convenient
/// to have this if we should ever want to use a different Reflection wallet
/// @dev Update the ref wallet address. This would most likely never be necessary, but it could be convenient to have this if we should ever want to use a different Reflection wallet
/// @param _refWalletAddress (address)
function setRefWalletAddress(address _refWalletAddress) external onlyOwner {
require(_refWalletAddress != address(0), "Zero Ref Address");
refWalletAddress = _refWalletAddress;
emit SetRefWalletAddress(_refWalletAddress);
}

/// @dev Mint RUSD into the user's wallet. This is done when the user sells a stock token on the Reflection
/// platform. Called only by the Reflection wallet.
/// @param to (address)
/// @param _amount (uint256)
function mint(address to, uint256 _amount) external onlyRefWallet {
_mint(to, _amount);
}

/// @dev Burn RUSD out of the user's wallet. This is done when the user buys a Stock Token and wants to pay
/// with RUSD. Called only by the Reflection wallet.
/// @param from (address)
/// @param _amount (uint256)
function burn(address from, uint256 _amount) external onlyRefWallet {
_burn(from, _amount);
}

/// @dev Called when the user buys a stock token on the Reflection platform. This method will (1) mint the stock
/// token into the user's wallet, and (2) either burn RUSD out of their wallet (if they are paying with
/// RUSD), or transfer another stablecoin (such as USDC) from their wallet to the Reflection wallet (if they
/// are not paying with RUSD). The amount of stock tokens transacted are entered by the user on the platform.
/// The amount of stablecoin is calculated by the platform based on the current market stock price. Called
/// only by the Reflection wallet.
/// @param _userAddress The user's wallet address
/// @param _stableCoinAddress The stablecoin contract address, i.e. RUSD or USDC
/// @param _stockTokenAddress The address of the specific StockToken contract the user wishes to buy
/// @param _stableCoinAmount The total amount of stablecoin that the user will pay for the StockTokens
/// @param _stockTokenAmount The number of StockTokens that will be minted into the user's wallet
/// @dev Called when the user buys a stock token on the Reflection platform. This method will (1) mint the stock token into the user's wallet, and (2) either burn RUSD out of their wallet (if they are paying with RUSD), or transfer another stablecoin (such as BUSD) from their wallet to the Reflection wallet (if they are not paying with RUSD). The amount of stock tokens transacted are entered by the user on the platform. The amount of stablecoin is calculated by the platform based on the current market stock price.
/// @param _userAddress (address)
/// @param _stableCoinAddress (address)
/// @param _stockTokenAddress (address)
/// @param _stableCoinAmount (uint256)
/// @param _stockTokenAmount (uint256)
function buyStock(
address _userAddress,
address _stableCoinAddress,
address _stockTokenAddress,
uint256 _stableCoinAmount,
uint256 _stockTokenAmount
)
external nonReentrant onlyRefWallet {

) external nonReentrant onlyRefWalletAddress {
if (_stableCoinAddress == address(this)) {
_burn(_userAddress, _stableCoinAmount);
} else {
IERC20(_stableCoinAddress).safeTransferFrom(_userAddress, refWalletAddress, _stableCoinAmount);

IERC20(_stableCoinAddress).safeTransferFrom(
_userAddress,
refWalletAddress,
_stableCoinAmount
);
}
IStockToken(_stockTokenAddress).mint(_userAddress, _stockTokenAmount);
emit BuyStock(_userAddress,_stableCoinAddress, _stockTokenAddress,_stableCoinAmount, _stockTokenAmount);
}

/// @dev Called when the user sells a stock token on the Reflection platform. This method will (1) burn the
/// stock token out of the user's wallet, and (2) either mint RUSD into their wallet, or transfer another
/// stablecoin from the Reflection wallet to the user's wallet. The amount of stock tokens transacted are
/// entered by the user on the platform. The amount of stablecoin is calculated by the platform based on
/// the current market stock price. Called only by the Reflection wallet.
/// @param _userAddress The user's wallet address
/// @param _stableCoinAddress The stablecoin contract address, i.e. RUSD or USDC
/// @param _stockTokenAddress The address of the specific StockToken contract the user wishes to sell
/// @param _stableCoinAmount The total amount of stablecoin that the user will receive
/// @param _stockTokenAmount The number of StockTokens that will be burned out of the user's wallet

/// @dev Called when the user sells a stock token on the Reflection platform. This method will (1) burn the stock token out of the user's wallet, and (2) either mint RUSD into their wallet, or transfer another stablecoin from the Reflection wallet to the user's wallet. The amount of stock tokens transacted are entered by the user on the platform. The amount of stablecoin is calculated by the platform based on the current market stock price.
/// @param _userAddress (address)
/// @param _stableCoinAddress (address)
/// @param _stockTokenAddress (address)
/// @param _stableCoinAmount (uint256)
/// @param _stockTokenAmount (uint256)
function sellStock(
address _userAddress,
address _stableCoinAddress,
address _stockTokenAddress,
uint256 _stableCoinAmount,
uint256 _stockTokenAmount
)
external nonReentrant onlyRefWallet {

) external nonReentrant onlyRefWalletAddress {
if (_stableCoinAddress == address(this)) {
_mint(_userAddress, _stableCoinAmount);
} else {
IERC20(_stableCoinAddress).safeTransferFrom(refWalletAddress, _userAddress, _stableCoinAmount);

IERC20(_stableCoinAddress).safeTransferFrom(
refWalletAddress,
_userAddress,
_stableCoinAmount
);
}
IStockToken(_stockTokenAddress).burn(_userAddress, _stockTokenAmount);
emit SellStock(_userAddress,_stableCoinAddress,_stockTokenAddress,_stableCoinAmount,_stockTokenAmount);
}

/// @dev Function for buying RUSD stablecoin. Currently this method is never called, but we're leaving our
/// options open for the future. This method mints RUSD into the user's wallet and transfers the other
/// stablecoin from their wallet to the Reflection wallet.
/// @param _userAddress The user's wallet address
/// @param _stableCoinAddress The stablecoin contract address, i.e. RUSD or USDC
/// @param _amount The amount of RUSD that will be minted into the user's wallet
function buyRusd(
/// @dev Called when the user elects to redeem (sell) their RUSD stablecoin for some other stablecoin on the Reflection platform. We burn the RUSD out of the user's wallet and transfer the other stablecoin from the Reflection wallet to the user's wallet.
/// @param _userAddress (address)
/// @param _stableCoinAddress (address)
/// @param _amount (uint256)
function sellRusd(
address _userAddress,
address _stableCoinAddress,
uint256 _amount
)
external nonReentrant onlyRefWallet {

IERC20(_stableCoinAddress).safeTransferFrom(_userAddress, refWalletAddress, _amount);
_mint(_userAddress, _amount);
emit BuyRusd(_userAddress,_stableCoinAddress,_amount);
) external nonReentrant onlyRefWalletAddress {
// check stable.allowance(ref,rusd) > ?: make ref approve
_burn(_userAddress, _amount);
IERC20(_stableCoinAddress).safeTransferFrom(
refWalletAddress,
_userAddress,
_amount
);
emit SellRusd(_userAddress,_stableCoinAddress,_amount);
}

/// @dev Called when the user elects to redeem (sell) their RUSD stablecoin for some other stablecoin on the
/// Reflection platform. We burn the RUSD out of the user's wallet and transfer the other stablecoin from
/// the Reflection wallet to the user's wallet.
/// @param _userAddress The user's wallet address
/// @param _stableCoinAddress The stablecoin contract address, i.e. RUSD or USDC
/// @dev Function for buying RUSD stablecoin. Currently this method is never called, but we're leaving our options open for the future. This method mints RUSD into the user's wallet and transfers the other stablecoin from their wallet to the Reflection wallet.
/// @param _userAddress (address)
/// @param _stableCoinAddress (address)
/// @param _amount (uint256)
function sellRusd(
function buyRusd(
address _userAddress,
address _stableCoinAddress,
uint256 _amount
)
external nonReentrant onlyRefWallet {

_burn(_userAddress, _amount);
IERC20(_stableCoinAddress).safeTransferFrom(refWalletAddress, _userAddress, _amount);
emit SellRusd(_userAddress,_stableCoinAddress,_amount);
) external nonReentrant onlyRefWalletAddress {

IERC20(_stableCoinAddress).safeTransferFrom(
_userAddress,
refWalletAddress,
_amount
);
_mint(_userAddress, _amount);
emit BuyRusd(_userAddress,_stableCoinAddress,_amount);
}

/// @dev Use 6 decimals, same as the two market-leading stablecoins USDC and USDT
/// @return (uint8) the number of decimal places for the ERC20 token
function decimals() public pure override returns (uint8) {
return 6;
}
}
Loading