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

storage refs - readability & gas impv [SLT-353] #3303

Merged
merged 4 commits into from
Oct 18, 2024
Merged

storage refs - readability & gas impv [SLT-353] #3303

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0341472
storage refs - readability & gas impv
parodime Oct 17, 2024
b0b1fdd
rearrange reads on dispute
parodime Oct 17, 2024
d8b8e14
read storage to local stack - claim
parodime Oct 17, 2024
d0be8f4
docs: make storage writes more explicit
ChiTimesChi Oct 18, 2024
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
83 changes: 48 additions & 35 deletions packages/contracts-rfq/contracts/FastBridgeV2.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,18 +77,22 @@ contract FastBridgeV2 is Admin, IFastBridgeV2, IFastBridgeV2Errors {

/// @inheritdoc IFastBridge
function dispute(bytes32 transactionId) external onlyRole(GUARD_ROLE) {
if (bridgeTxDetails[transactionId].status != BridgeStatus.RELAYER_PROVED) revert StatusIncorrect();
if (_timeSince(bridgeTxDetails[transactionId].proofBlockTimestamp) > DISPUTE_PERIOD) {
BridgeTxDetails storage $ = bridgeTxDetails[transactionId];

address disputedRelayer = $.proofRelayer;
BridgeStatus status = $.status;
uint40 proofBlockTimestamp = $.proofBlockTimestamp;

if (status != BridgeStatus.RELAYER_PROVED) revert StatusIncorrect();
if (_timeSince(proofBlockTimestamp) > DISPUTE_PERIOD) {
revert DisputePeriodPassed();
}

address disputedRelayer = bridgeTxDetails[transactionId].proofRelayer;

// @dev relayer gets slashed effectively if dest relay has gone thru
bridgeTxDetails[transactionId].status = BridgeStatus.REQUESTED;
bridgeTxDetails[transactionId].proofRelayer = address(0);
bridgeTxDetails[transactionId].proofBlockTimestamp = 0;
bridgeTxDetails[transactionId].proofBlockNumber = 0;
// Note: these are storage writes
$.status = BridgeStatus.REQUESTED;
$.proofRelayer = address(0);
$.proofBlockTimestamp = 0;
$.proofBlockNumber = 0;

emit BridgeProofDisputed(transactionId, disputedRelayer);
}
Expand All @@ -99,7 +103,9 @@ contract FastBridgeV2 is Admin, IFastBridgeV2, IFastBridgeV2Errors {

BridgeTransactionV2 memory transaction = getBridgeTransactionV2(request);

if (bridgeTxDetails[transactionId].status != BridgeStatus.REQUESTED) revert StatusIncorrect();
BridgeTxDetails storage $ = bridgeTxDetails[transactionId];

if ($.status != BridgeStatus.REQUESTED) revert StatusIncorrect();

if (hasRole(REFUNDER_ROLE, msg.sender)) {
// Refunder can refund if deadline has passed
Expand All @@ -109,8 +115,8 @@ contract FastBridgeV2 is Admin, IFastBridgeV2, IFastBridgeV2Errors {
if (block.timestamp <= transaction.deadline + REFUND_DELAY) revert DeadlineNotExceeded();
}

// if all checks passed, set to REFUNDED status
bridgeTxDetails[transactionId].status = BridgeStatus.REFUNDED;
// Note: this is a storage write
$.status = BridgeStatus.REFUNDED;

// transfer origin collateral back to original sender
uint256 amount = transaction.originAmount + transaction.originFeeAmount;
Expand All @@ -128,9 +134,11 @@ contract FastBridgeV2 is Admin, IFastBridgeV2, IFastBridgeV2Errors {

/// @inheritdoc IFastBridge
function canClaim(bytes32 transactionId, address relayer) external view returns (bool) {
if (bridgeTxDetails[transactionId].status != BridgeStatus.RELAYER_PROVED) revert StatusIncorrect();
if (bridgeTxDetails[transactionId].proofRelayer != relayer) revert SenderIncorrect();
return _timeSince(bridgeTxDetails[transactionId].proofBlockTimestamp) > DISPUTE_PERIOD;
BridgeTxDetails storage $ = bridgeTxDetails[transactionId];

if ($.status != BridgeStatus.RELAYER_PROVED) revert StatusIncorrect();
if ($.proofRelayer != relayer) revert SenderIncorrect();
return _timeSince($.proofBlockTimestamp) > DISPUTE_PERIOD;
}

/// @inheritdoc IFastBridge
Expand Down Expand Up @@ -273,12 +281,15 @@ contract FastBridgeV2 is Admin, IFastBridgeV2, IFastBridgeV2Errors {

/// @inheritdoc IFastBridgeV2
function prove(bytes32 transactionId, bytes32 destTxHash, address relayer) public onlyRole(RELAYER_ROLE) {
BridgeTxDetails storage $ = bridgeTxDetails[transactionId];

// update bridge tx status given proof provided
if (bridgeTxDetails[transactionId].status != BridgeStatus.REQUESTED) revert StatusIncorrect();
bridgeTxDetails[transactionId].status = BridgeStatus.RELAYER_PROVED;
bridgeTxDetails[transactionId].proofBlockTimestamp = uint40(block.timestamp);
bridgeTxDetails[transactionId].proofBlockNumber = uint48(block.number);
bridgeTxDetails[transactionId].proofRelayer = relayer;
if ($.status != BridgeStatus.REQUESTED) revert StatusIncorrect();
// Note: these are storage writes
$.status = BridgeStatus.RELAYER_PROVED;
$.proofBlockTimestamp = uint40(block.timestamp);
$.proofBlockNumber = uint48(block.number);
$.proofRelayer = relayer;

emit BridgeProofProvided(transactionId, relayer, destTxHash);
}
Expand All @@ -288,21 +299,27 @@ contract FastBridgeV2 is Admin, IFastBridgeV2, IFastBridgeV2Errors {
bytes32 transactionId = keccak256(request);
BridgeTransactionV2 memory transaction = getBridgeTransactionV2(request);

BridgeTxDetails storage $ = bridgeTxDetails[transactionId];
ChiTimesChi marked this conversation as resolved.
Show resolved Hide resolved

address proofRelayer = $.proofRelayer;
BridgeStatus status = $.status;
uint40 proofBlockTimestamp = $.proofBlockTimestamp;

// update bridge tx status if able to claim origin collateral
if (bridgeTxDetails[transactionId].status != BridgeStatus.RELAYER_PROVED) revert StatusIncorrect();
if (status != BridgeStatus.RELAYER_PROVED) revert StatusIncorrect();

// if "to" is zero addr, permissionlessly send funds to proven relayer
if (to == address(0)) {
to = bridgeTxDetails[transactionId].proofRelayer;
} else if (bridgeTxDetails[transactionId].proofRelayer != msg.sender) {
to = proofRelayer;
} else if (proofRelayer != msg.sender) {
revert SenderIncorrect();
}

if (_timeSince(bridgeTxDetails[transactionId].proofBlockTimestamp) <= DISPUTE_PERIOD) {
if (_timeSince(proofBlockTimestamp) <= DISPUTE_PERIOD) {
revert DisputePeriodNotPassed();
}

bridgeTxDetails[transactionId].status = BridgeStatus.RELAYER_CLAIMED;
// Note: this is a storage write
$.status = BridgeStatus.RELAYER_CLAIMED;

// update protocol fees if origin fee amount exists
if (transaction.originFeeAmount > 0) protocolFees[transaction.originToken] += transaction.originFeeAmount;
Expand All @@ -317,22 +334,18 @@ contract FastBridgeV2 is Admin, IFastBridgeV2, IFastBridgeV2Errors {
IERC20(token).safeTransfer(to, amount);
}

emit BridgeDepositClaimed(
transactionId,
bridgeTxDetails[transactionId].proofRelayer,
to,
transaction.originToken,
transaction.originAmount
);
emit BridgeDepositClaimed(transactionId, proofRelayer, to, transaction.originToken, transaction.originAmount);
}

function bridgeStatuses(bytes32 transactionId) public view returns (BridgeStatus status) {
return bridgeTxDetails[transactionId].status;
}

function bridgeProofs(bytes32 transactionId) public view returns (uint96 timestamp, address relayer) {
timestamp = bridgeTxDetails[transactionId].proofBlockTimestamp;
relayer = bridgeTxDetails[transactionId].proofRelayer;
BridgeTxDetails storage $ = bridgeTxDetails[transactionId];

timestamp = $.proofBlockTimestamp;
relayer = $.proofRelayer;
}

/// @inheritdoc IFastBridgeV2
Expand Down
Loading