Skip to content

Commit

Permalink
Merge pull request #147 from Se7en-Seas/deploy/boring-queues
Browse files Browse the repository at this point in the history 
Deploy/boring queues
  • Loading branch information
@crispymangoes
crispymangoes authored Oct 24, 2024
2 parents 2bcc7e7 + 7f513b8 commit 9b165ac
Show file tree
Hide file tree
Showing 2 changed files with 206 additions and 0 deletions.
5 changes: 5 additions & 0 deletions resources/ContractNames.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ contract ContractNames {
string public constant IncentiveDistributorName = "Incentive Distributor V0.1";
string public constant PaymentSplitterName = "Payment Splitter V0.0";
string public constant PaymentSplitterRolesAuthorityName = "Payment Splitter Roles Authority V0.0";
string public constant BoringOnChainQueuesRolesAuthorityName = "Boring OnChain Queues Roles Authority V0.1";

// Migration
string public constant CellarMigrationAdaptorName = "Cellar Migration Adaptor V0.1";
Expand Down Expand Up @@ -40,6 +41,8 @@ contract ContractNames {
"EtherFi Liquid ETH Camelot Decoder and Sanitizer V0.0";
string public constant EtherFiLiquidEthAerodromeDecoderAndSanitizerName =
"EtherFi Liquid ETH Aerodrome Decoder and Sanitizer V0.0";
string public constant EtherFiLiquidEthQueueName = "EtherFi Liquid ETH Queue V0.0";
string public constant EtherFiLiquidEthQueueSolverName = "EtherFi Liquid ETH Queue Solver V0.0";

string public constant TestVaultEthRolesAuthorityName = "Test ETH Vault RolesAuthority Version 0.0";
string public constant TestVaultEthName = "Test ETH Vault V0.0";
Expand Down Expand Up @@ -140,6 +143,8 @@ contract ContractNames {
string public constant SymbioticLRTVaultTellerName = "Symbiotic LRT Vault Teller With Multi Asset Support V0.0";
string public constant SymbioticLRTVaultDecoderAndSanitizerName = "Symbiotic LRT Vault Decoder and Sanitizer V0.2";
string public constant SymbioticLRTVaultDelayedWithdrawer = "Symbiotic LRT Vault Delayed Withdrawer V0.0";
string public constant SymbioticLRTVaultQueueName = "Symbiotic LRT Vault Queue V0.1";
string public constant SymbioticLRTVaultQueueSolverName = "Symbiotic LRT Vault Queue Solver V0.1";

string public constant KarakVaultRolesAuthorityName = "Karak Vault RolesAuthority V0.0";
string public constant KarakVaultName = "Karak Vault V0.0";
Expand Down
201 changes: 201 additions & 0 deletions script/DeployBoringQueues.s.sol
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
// SPDX-License-Identifier: UNLICENSED
pragma solidity 0.8.21;

import {MainnetAddresses} from "test/resources/MainnetAddresses.sol";
import {ERC20} from "@solmate/tokens/ERC20.sol";
import {Deployer} from "src/helper/Deployer.sol";
import {ContractNames} from "resources/ContractNames.sol";
import {GenericRateProvider} from "src/helper/GenericRateProvider.sol";
import {AddressToBytes32Lib} from "src/helper/AddressToBytes32Lib.sol";
import {AccountantWithRateProviders} from "src/base/Roles/AccountantWithRateProviders.sol";
import {RolesAuthority, Authority} from "@solmate/auth/authorities/RolesAuthority.sol";
import {BoringOnChainQueue} from "src/base/Roles/BoringQueue/BoringOnChainQueue.sol";
import {BoringSolver} from "src/base/Roles/BoringQueue/BoringSolver.sol";
import {MerkleTreeHelper} from "test/resources/MerkleTreeHelper/MerkleTreeHelper.sol";

import "forge-std/Script.sol";
import "forge-std/StdJson.sol";

/**
* source .env && forge script script/DeployBoringQueues.s.sol:DeployBoringQueuesScript --with-gas-price 3000000000 --broadcast --etherscan-api-key $ETHERSCAN_KEY --verify
* @dev Optionally can change `--with-gas-price` to something more reasonable
*/
contract DeployBoringQueuesScript is Script, ContractNames, MerkleTreeHelper {
using AddressToBytes32Lib for address;

uint256 public privateKey;

address public devOwner = 0xf8553c8552f906C19286F21711721E206EE4909E;
address public canSolve = 0xf8553c8552f906C19286F21711721E206EE4909E;
address public admin = 0x41DFc53B13932a2690C9790527C1967d8579a6ae;
address public superAdmin = 0xf8553c8552f906C19286F21711721E206EE4909E;
address public globalOwner = 0xf8553c8552f906C19286F21711721E206EE4909E;

// Contracts to deploy
Deployer public deployer;

// Roles
uint8 public constant CAN_SOLVE_ROLE = 31;
uint8 public constant ONLY_QUEUE_ROLE = 32;
uint8 public constant ADMIN_ROLE = 33;
uint8 public constant SUPER_ADMIN_ROLE = 34;

function setUp() external {
privateKey = vm.envUint("ETHERFI_LIQUID_DEPLOYER");
vm.createSelectFork("mainnet");
setSourceChainName(mainnet);
deployer = Deployer(getAddress(sourceChain, "deployerAddress"));
}

function run() external {
bytes memory creationCode;
bytes memory constructorArgs;

vm.startBroadcast(privateKey);

creationCode = type(RolesAuthority).creationCode;
constructorArgs = abi.encode(devOwner, Authority(address(0)));
RolesAuthority rolesAuthority = RolesAuthority(
deployer.deployContract(BoringOnChainQueuesRolesAuthorityName, creationCode, constructorArgs, 0)
);

address[] memory assets = new address[](3);
//============================== LiquidEth ===============================
assets[0] = getAddress(sourceChain, "EETH");
assets[1] = getAddress(sourceChain, "WEETH");
assets[2] = getAddress(sourceChain, "WSTETH");
BoringOnChainQueue.WithdrawAsset[] memory assetsToSetup = new BoringOnChainQueue.WithdrawAsset[](3);
assetsToSetup[0] = BoringOnChainQueue.WithdrawAsset({
allowWithdraws: true, // not used in script.
secondsToMaturity: 7 days,
minimumSecondsToDeadline: 3 days,
minDiscount: 1,
maxDiscount: 10,
minimumShares: 0.0001e18
});
assetsToSetup[1] = BoringOnChainQueue.WithdrawAsset({
allowWithdraws: true, // not used in script.
secondsToMaturity: 7 days,
minimumSecondsToDeadline: 3 days,
minDiscount: 1,
maxDiscount: 10,
minimumShares: 0.0001e18
});
assetsToSetup[2] = BoringOnChainQueue.WithdrawAsset({
allowWithdraws: true, // not used in script.
secondsToMaturity: 7 days,
minimumSecondsToDeadline: 3 days,
minDiscount: 1,
maxDiscount: 10,
minimumShares: 0.0001e18
});

_deployContracts(
SymbioticLRTVaultName,
SymbioticLRTVaultAccountantName,
SymbioticLRTVaultQueueName,
SymbioticLRTVaultQueueSolverName,
rolesAuthority,
assets,
assetsToSetup
);

//============================== LiquidBtc ===============================
// TODO
rolesAuthority.setUserRole(canSolve, CAN_SOLVE_ROLE, true);
rolesAuthority.setUserRole(admin, ADMIN_ROLE, true);
rolesAuthority.setUserRole(superAdmin, SUPER_ADMIN_ROLE, true);
rolesAuthority.transferOwnership(globalOwner);

vm.stopBroadcast();
}

function _deployContracts(
string memory boringVaultName,
string memory accountantName,
string memory queueName,
string memory solverName,
RolesAuthority rolesAuthority,
address[] memory assets,
BoringOnChainQueue.WithdrawAsset[] memory assetsToSetup
) internal {
bytes memory creationCode;
bytes memory constructorArgs;

address boringVault = deployer.getAddress(boringVaultName);
address accountant = deployer.getAddress(accountantName);

creationCode = type(BoringOnChainQueue).creationCode;
constructorArgs = abi.encode(devOwner, address(rolesAuthority), payable(boringVault), accountant);
BoringOnChainQueue queue =
BoringOnChainQueue(deployer.deployContract(queueName, creationCode, constructorArgs, 0));

creationCode = type(BoringSolver).creationCode;
constructorArgs = abi.encode(devOwner, address(rolesAuthority), address(queue));
address solver = deployer.deployContract(solverName, creationCode, constructorArgs, 0);

// Setup withdraw assets.
for (uint256 i; i < assets.length; ++i) {
queue.updateWithdrawAsset(
assets[i],
assetsToSetup[i].secondsToMaturity,
assetsToSetup[i].minimumSecondsToDeadline,
assetsToSetup[i].minDiscount,
assetsToSetup[i].maxDiscount,
assetsToSetup[i].minimumShares
);
}

// Setup RolesAuthority.

// Public functions.
rolesAuthority.setPublicCapability(address(queue), BoringOnChainQueue.requestOnChainWithdraw.selector, true);
rolesAuthority.setPublicCapability(
address(queue), BoringOnChainQueue.requestOnChainWithdrawWithPermit.selector, true
);
rolesAuthority.setPublicCapability(address(queue), BoringOnChainQueue.cancelOnChainWithdraw.selector, true);
rolesAuthority.setPublicCapability(address(queue), BoringOnChainQueue.replaceOnChainWithdraw.selector, true);
/// @notice By default the self solve functions are not made public.

// CAN_SOLVE_ROLE
rolesAuthority.setRoleCapability(
CAN_SOLVE_ROLE, solver, BoringOnChainQueue.solveOnChainWithdraws.selector, true
);
rolesAuthority.setRoleCapability(CAN_SOLVE_ROLE, solver, BoringSolver.boringRedeemSolve.selector, true);
rolesAuthority.setRoleCapability(CAN_SOLVE_ROLE, solver, BoringSolver.boringRedeemMintSolve.selector, true);

// ONLY_QUEUE_ROLE
rolesAuthority.setRoleCapability(ONLY_QUEUE_ROLE, solver, BoringSolver.boringSolve.selector, true);

// ADMIN_ROLE
rolesAuthority.setRoleCapability(
ADMIN_ROLE, address(queue), BoringOnChainQueue.stopWithdrawsInAsset.selector, true
);
rolesAuthority.setRoleCapability(
ADMIN_ROLE, address(queue), BoringOnChainQueue.cancelUserWithdraws.selector, true
);
rolesAuthority.setRoleCapability(ADMIN_ROLE, address(queue), BoringOnChainQueue.pause.selector, true);

// SUPER_ADMIN_ROLE
rolesAuthority.setRoleCapability(
SUPER_ADMIN_ROLE, address(queue), BoringOnChainQueue.updateWithdrawAsset.selector, true
);
rolesAuthority.setRoleCapability(SUPER_ADMIN_ROLE, address(queue), BoringOnChainQueue.pause.selector, true);
rolesAuthority.setRoleCapability(SUPER_ADMIN_ROLE, address(queue), BoringOnChainQueue.unpause.selector, true);
rolesAuthority.setRoleCapability(
SUPER_ADMIN_ROLE, address(queue), BoringOnChainQueue.stopWithdrawsInAsset.selector, true
);
rolesAuthority.setRoleCapability(
SUPER_ADMIN_ROLE, address(queue), BoringOnChainQueue.rescueTokens.selector, true
);
rolesAuthority.setRoleCapability(SUPER_ADMIN_ROLE, solver, BoringOnChainQueue.rescueTokens.selector, true);

// Give Queue the OnlyQueue role.
rolesAuthority.setUserRole(address(queue), ONLY_QUEUE_ROLE, true);
rolesAuthority.setUserRole(solver, CAN_SOLVE_ROLE, true);

// Transfer ownership.
queue.transferOwnership(globalOwner);
BoringSolver(solver).transferOwnership(globalOwner);
}
}

0 comments on commit 9b165ac

Please sign in to comment.