Skip to content

Add dev fee and 2-step handover #19

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

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

Add dev fee and 2-step handover #19

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
5 changes: 4 additions & 1 deletion script/DeployOracleFactory.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@ contract DeployOracleFactory is Script {
function run() public {
vm.startBroadcast(vm.envUint("PRIVATE_KEY"));

factory = new OracleFactory(0xab53369e91dcFC275744DC0A30BD3E363B2785e0);
address devAddress = vm.envOr("DEV_ADDRESS", address(0xab53369e91dcFC275744DC0A30BD3E363B2785e0));
uint256 devFee = vm.envOr("DEV_FEE", uint256(1000)); // Default 1% (1000 / 1e5)

factory = new OracleFactory(0xab53369e91dcFC275744DC0A30BD3E363B2785e0, devAddress, devFee);

console.log("Factory Deployed: ", address(factory));

Expand Down
65 changes: 61 additions & 4 deletions src/Oracle.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ error PriceHistoryEndOutOfBounds();
error InvalidPriceHistoryRange();
error EmptyHistory();
error InvalidSampleSize();
error OnlyDev();
error OnlyProposedDev();
error DevFeeExceedsMax(uint256 devFee, uint256 maxDevFee);
error DevFeeTransferFailed();
error ZeroAddress();

contract Oracle is Ownable, ReentrancyGuard {

Expand All @@ -29,6 +34,10 @@ contract Oracle is Ownable, ReentrancyGuard {
event TokenWithdrawn(address indexed user, uint256 amount);
event Voted(address indexed target, address indexed voter, bool isBlacklist, uint256 weight);
event BlacklistStatusChanged(address indexed target, bool isBlacklisted);
event DevProposed(address indexed proposedDev);
event DevTransferred(address indexed oldDev, address indexed newDev);
event DevFeeReceiverUpdated(address indexed newReceiver);
event DevFeePaid(address indexed receiver, uint256 amount);

IERC20 public immutable WEIGHT_TOKEN;

Expand All @@ -54,6 +63,12 @@ contract Oracle is Ownable, ReentrancyGuard {

uint256 private constant DENOMINATOR = 1e5;
uint256 private constant WAD = 1e18;
uint256 public constant MAX_DEV_FEE = 30_000; // Maximum allowed dev fee: 30% of DENOMINATOR (1e5)

address public dev;
address public proposedDev;
address public devFeeReceiver;
uint256 public immutable devFee;

uint256 private latestValue; // most recent raw submission
uint256 private aggregatedValue; // last aggregated price (decayed weighted mean)
Expand Down Expand Up @@ -81,22 +96,64 @@ contract Oracle is Ownable, ReentrancyGuard {
_;
}

constructor(address owner_, string memory name_,string memory description_, address weightToken_,uint256 halfLifeSeconds_,uint256 q_,uint256 depositLockingPeriod_,uint256 withdrawalLockingPeriod_,uint256 rewardBps_, uint256 gamma_, uint256 defaultSampleSize_) Ownable(owner_) {
constructor(address owner_, address dev_, uint256 devFee_, string memory name_, string memory description_, address weightToken_, uint256 halfLifeSeconds_,uint256 q_, uint256 depositLockingPeriod_, uint256 withdrawalLockingPeriod_, uint256 rewardBps_, uint256 gamma_, uint256 defaultSampleSize_) Ownable(owner_) {
if (weightToken_ == address(0)) revert InvalidWeightTokenAddress();
if (defaultSampleSize_ == 0) revert InvalidSampleSize();
if (dev_ == address(0)) revert ZeroAddress();
if (devFee_ > MAX_DEV_FEE) revert DevFeeExceedsMax(devFee_, MAX_DEV_FEE);

dev = dev_;
devFeeReceiver = dev_;
devFee = devFee_;

WEIGHT_TOKEN = IERC20(weightToken_); HALF_LIFE_SECONDS = halfLifeSeconds_;
Q = q_; DEPOSIT_LOCKING_PERIOD = depositLockingPeriod_; WITHDRAWAL_LOCKING_PERIOD = withdrawalLockingPeriod_;
lastTimestamp = block.timestamp; lastUpdated = block.timestamp; REWARD_BPS = rewardBps_; name = name_; description = description_;
GAMMA = gamma_; defaultSampleSize = defaultSampleSize_;
}

receive() external payable {
lastTimestamp = block.timestamp;
emit Funded(msg.sender, msg.value);
_handleDeposit();
}

function deposit() external payable {
_handleDeposit();
}

function _handleDeposit() internal {
lastTimestamp = block.timestamp;
emit Funded(msg.sender, msg.value);
uint256 amount = msg.value;
if (amount > 0 && devFee > 0) {
uint256 fee = (amount * devFee) / DENOMINATOR;
if (fee > 0) {
(bool ok, ) = devFeeReceiver.call{value: fee}("");
if (!ok) revert DevFeeTransferFailed();
emit DevFeePaid(devFeeReceiver, fee);
}
}
emit Funded(msg.sender, amount);
}

function proposeDev(address newDev) external {
if (msg.sender != dev) revert OnlyDev();
if (newDev == address(0)) revert ZeroAddress();
proposedDev = newDev;
emit DevProposed(newDev);
}

function acceptDev() external {
if (msg.sender != proposedDev) revert OnlyProposedDev();
address oldDev = dev;
dev = msg.sender;
proposedDev = address(0);
emit DevTransferred(oldDev, msg.sender);
}

function setDevFeeReceiver(address newReceiver) external {
if (msg.sender != dev) revert OnlyDev();
if (newReceiver == address(0)) revert ZeroAddress();
devFeeReceiver = newReceiver;
emit DevFeeReceiverUpdated(newReceiver);
}

function submitValue(uint256 newValue) external nonReentrant onlyTokenHolder {
Expand Down
35 changes: 34 additions & 1 deletion src/OracleFactory.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,51 @@ import {Ownable} from "lib/openzeppelin-contracts/contracts/access/Ownable.sol";
import {Oracle} from "./Oracle.sol";

error InvalidWeightToken();
error OnlyDev();
error OnlyProposedDev();
error DevFeeExceedsMax(uint256 devFee, uint256 maxDevFee);
error ZeroAddress();

contract OracleFactory is Ownable {
event OracleCreated(address indexed oracle, address indexed creator, address token);
event DevProposed(address indexed proposedDev);
event DevTransferred(address indexed oldDev, address indexed newDev);

struct OracleInfo {
address oracle;
address token;
address creator;
}

uint256 public constant MAX_DEV_FEE = 30_000; // Maximum allowed dev fee: 30% of DENOMINATOR (1e5)
address public dev;
address public proposedDev;
uint256 public immutable devFee;

OracleInfo[] public oracles;
mapping(address => address[]) public creatorToOracle;

constructor(address initialOwner) Ownable(initialOwner) {}
constructor(address initialOwner, address initialDev, uint256 devFee_) Ownable(initialOwner) {
if (initialDev == address(0)) revert ZeroAddress();
if (devFee_ > MAX_DEV_FEE) revert DevFeeExceedsMax(devFee_, MAX_DEV_FEE);
dev = initialDev;
devFee = devFee_;
}

function proposeDev(address newDev) external {
if (msg.sender != dev) revert OnlyDev();
if (newDev == address(0)) revert ZeroAddress();
proposedDev = newDev;
emit DevProposed(newDev);
}

function acceptDev() external {
if (msg.sender != proposedDev) revert OnlyProposedDev();
address oldDev = dev;
dev = msg.sender;
proposedDev = address(0);
emit DevTransferred(oldDev, msg.sender);
}

/// @notice Anyone can create a new Oracle using an existing ERC20 token.
/// @param weightToken Address of the ERC20 token to be used for weighting.
Expand Down Expand Up @@ -46,6 +77,8 @@ contract OracleFactory is Ownable {

Oracle o = new Oracle(
msg.sender, // owner (oracle creator)
dev, // dev
devFee, // devFee
name,
description,
weightToken,
Expand Down
Loading
Loading