Skip to content

Commit

Permalink
Refactoring open ended (#52)
Browse files Browse the repository at this point in the history 
* perf: optimize modifiers

* refactor: rename streamDebt to streamDebtOf

* fix: add override

* style: solhint-disable no-console

* chore: use return variable in streamDebtOf

* test: update streamDebt files

---------

Co-authored-by: andreivladbrg <andreivladbrg@gmail.com>
  • Loading branch information
@smol-ninja @andreivladbrg
smol-ninja and andreivladbrg authored Apr 29, 2024
1 parent 6cca0e6 commit e15c02c
Show file tree
Hide file tree
Showing 6 changed files with 111 additions and 44 deletions.
3 changes: 2 additions & 1 deletion script/Base.s.sol
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
// SPDX-License-Identifier: GPL-3.0-or-later
// solhint-disable no-console
pragma solidity >=0.8.22;

import { Strings } from "@openzeppelin/contracts/utils/Strings.sol";
Expand Down Expand Up @@ -57,7 +58,7 @@ abstract contract BaseScript is Script {
string memory json = vm.readFile("package.json");
string memory version = json.readString(".version");
string memory create2Salt = string.concat("ChainID ", chainId, ", Version ", version);
console2.log("The CREATE2 salt is \"%s\"", create2Salt);
console2.log("The CREATE2 salt is %s", create2Salt);
return bytes32(abi.encodePacked(create2Salt));
}
}
88 changes: 75 additions & 13 deletions src/SablierV2OpenEnded.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ contract SablierV2OpenEnded is ISablierV2OpenEnded, NoDelegateCall, SablierV2Ope
view
override
notCanceled(streamId)
notNull(streamId)
returns (uint128 refundableAmount)
{
refundableAmount = _refundableAmountOf(streamId, uint40(block.timestamp));
Expand All @@ -42,25 +43,40 @@ contract SablierV2OpenEnded is ISablierV2OpenEnded, NoDelegateCall, SablierV2Ope
view
override
notCanceled(streamId)
notNull(streamId)
returns (uint128 refundableAmount)
{
refundableAmount = _refundableAmountOf(streamId, time);
}

/// @inheritdoc ISablierV2OpenEnded
function streamDebt(uint256 streamId) external view notCanceled(streamId) returns (uint128 debt) {
function streamDebtOf(uint256 streamId)
external
view
override
notCanceled(streamId)
notNull(streamId)
returns (uint128 debt)
{
uint128 balance = _streams[streamId].balance;
uint128 streamedAmount = _streamedAmountOf(streamId, uint40(block.timestamp));

if (balance >= streamedAmount) {
if (balance < streamedAmount) {
debt = streamedAmount - balance;
} else {
return 0;
}

debt = streamedAmount - balance;
}

/// @inheritdoc ISablierV2OpenEnded
function streamedAmountOf(uint256 streamId) external view notCanceled(streamId) returns (uint128 streamedAmount) {
function streamedAmountOf(uint256 streamId)
external
view
override
notCanceled(streamId)
notNull(streamId)
returns (uint128 streamedAmount)
{
streamedAmount = _streamedAmountOf(streamId, uint40(block.timestamp));
}

Expand All @@ -71,7 +87,9 @@ contract SablierV2OpenEnded is ISablierV2OpenEnded, NoDelegateCall, SablierV2Ope
)
external
view
override
notCanceled(streamId)
notNull(streamId)
returns (uint128 streamedAmount)
{
streamedAmount = _streamedAmountOf(streamId, time);
Expand All @@ -81,7 +99,9 @@ contract SablierV2OpenEnded is ISablierV2OpenEnded, NoDelegateCall, SablierV2Ope
function withdrawableAmountOf(uint256 streamId)
external
view
override
notCanceled(streamId)
notNull(streamId)
returns (uint128 withdrawableAmount)
{
withdrawableAmount = _withdrawableAmountOf(streamId, uint40(block.timestamp));
Expand All @@ -94,7 +114,9 @@ contract SablierV2OpenEnded is ISablierV2OpenEnded, NoDelegateCall, SablierV2Ope
)
external
view
override
notCanceled(streamId)
notNull(streamId)
returns (uint128 withdrawableAmount)
{
withdrawableAmount = _withdrawableAmountOf(streamId, time);
Expand All @@ -110,16 +132,25 @@ contract SablierV2OpenEnded is ISablierV2OpenEnded, NoDelegateCall, SablierV2Ope
uint128 newRatePerSecond
)
external
override
noDelegateCall
notCanceled(streamId)
notNull(streamId)
onlySender(streamId)
{
// Effects and Interactions: adjust the stream.
_adjustRatePerSecond(streamId, newRatePerSecond);
}

/// @inheritdoc ISablierV2OpenEnded
function cancel(uint256 streamId) public noDelegateCall notCanceled(streamId) onlySender(streamId) {
function cancel(uint256 streamId)
public
override
noDelegateCall
notCanceled(streamId)
notNull(streamId)
onlySender(streamId)
{
_cancel(streamId);
}

Expand All @@ -141,6 +172,7 @@ contract SablierV2OpenEnded is ISablierV2OpenEnded, NoDelegateCall, SablierV2Ope
IERC20 asset
)
external
override
returns (uint256 streamId)
{
// Checks, Effects and Interactions: create the stream.
Expand All @@ -156,6 +188,7 @@ contract SablierV2OpenEnded is ISablierV2OpenEnded, NoDelegateCall, SablierV2Ope
uint128 depositAmount
)
external
override
returns (uint256 streamId)
{
// Checks, Effects and Interactions: create the stream.
Expand All @@ -173,6 +206,7 @@ contract SablierV2OpenEnded is ISablierV2OpenEnded, NoDelegateCall, SablierV2Ope
IERC20 asset
)
public
override
returns (uint256[] memory streamIds)
{
uint256 recipientsCount = recipients.length;
Expand Down Expand Up @@ -202,6 +236,7 @@ contract SablierV2OpenEnded is ISablierV2OpenEnded, NoDelegateCall, SablierV2Ope
uint128[] calldata depositAmounts
)
external
override
returns (uint256[] memory streamIds)
{
streamIds = new uint256[](recipients.length);
Expand All @@ -211,13 +246,22 @@ contract SablierV2OpenEnded is ISablierV2OpenEnded, NoDelegateCall, SablierV2Ope
}

/// @inheritdoc ISablierV2OpenEnded
function deposit(uint256 streamId, uint128 depositAmount) external noDelegateCall notCanceled(streamId) {
function deposit(
uint256 streamId,
uint128 depositAmount
)
external
override
noDelegateCall
notCanceled(streamId)
notNull(streamId)
{
// Checks, Effects and Interactions: deposit on stream.
_deposit(streamId, depositAmount);
}

/// @inheritdoc ISablierV2OpenEnded
function depositMultiple(uint256[] memory streamIds, uint128[] calldata amounts) public noDelegateCall {
function depositMultiple(uint256[] memory streamIds, uint128[] calldata amounts) public override noDelegateCall {
uint256 streamIdsCount = streamIds.length;
uint256 depositAmountsCount = amounts.length;

Expand All @@ -238,13 +282,20 @@ contract SablierV2OpenEnded is ISablierV2OpenEnded, NoDelegateCall, SablierV2Ope
}

/// @inheritdoc ISablierV2OpenEnded
function restartStream(uint256 streamId, uint128 ratePerSecond) external {
function restartStream(uint256 streamId, uint128 ratePerSecond) external override {
// Checks, Effects and Interactions: restart the stream.
_restartStream(streamId, ratePerSecond);
}

/// @inheritdoc ISablierV2OpenEnded
function restartStreamAndDeposit(uint256 streamId, uint128 ratePerSecond, uint128 depositAmount) external {
function restartStreamAndDeposit(
uint256 streamId,
uint128 ratePerSecond,
uint128 depositAmount
)
external
override
{
// Checks, Effects and Interactions: restart the stream.
_restartStream(streamId, ratePerSecond);

Expand All @@ -258,16 +309,18 @@ contract SablierV2OpenEnded is ISablierV2OpenEnded, NoDelegateCall, SablierV2Ope
uint128 refundAmount
)
external
override
noDelegateCall
notCanceled(streamId)
notNull(streamId)
onlySender(streamId)
{
// Checks, Effects and Interactions: make the refund.
_refundFromStream(streamId, refundAmount);
}

/// @inheritdoc ISablierV2OpenEnded
function withdraw(uint256 streamId, address to, uint40 time) external {
function withdraw(uint256 streamId, address to, uint40 time) external override {
// Checks, Effects and Interactions: make the withdrawal.
_withdraw(streamId, to, time);
}
Expand All @@ -289,7 +342,7 @@ contract SablierV2OpenEnded is ISablierV2OpenEnded, NoDelegateCall, SablierV2Ope
}

/// @inheritdoc ISablierV2OpenEnded
function withdrawMax(uint256 streamId, address to) external {
function withdrawMax(uint256 streamId, address to) external override {
// Checks, Effects and Interactions: make the withdrawal.
_withdraw(streamId, to, uint40(block.timestamp));
}
Expand Down Expand Up @@ -632,7 +685,16 @@ contract SablierV2OpenEnded is ISablierV2OpenEnded, NoDelegateCall, SablierV2Ope
}

/// @dev See the documentation for the user-facing functions that call this internal function.
function _withdraw(uint256 streamId, address to, uint40 time) internal noDelegateCall notCanceled(streamId) {
function _withdraw(
uint256 streamId,
address to,
uint40 time
)
internal
noDelegateCall
notCanceled(streamId)
notNull(streamId)
{
// Check: the withdrawal address is not zero.
if (to == address(0)) {
revert Errors.SablierV2OpenEnded_WithdrawToZeroAddress();
Expand Down
26 changes: 11 additions & 15 deletions src/abstracts/SablierV2OpenEndedState.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ abstract contract SablierV2OpenEndedState is ISablierV2OpenEndedState {

/// @dev Checks that `streamId` does not reference a canceled stream.
modifier notCanceled(uint256 streamId) {
if (isCanceled(streamId)) {
if (_streams[streamId].isCanceled) {
revert Errors.SablierV2OpenEnded_StreamCanceled(streamId);
}
_;
Expand All @@ -50,7 +50,7 @@ abstract contract SablierV2OpenEndedState is ISablierV2OpenEndedState {

/// @dev Checks the `msg.sender` is the stream's sender.
modifier onlySender(uint256 streamId) {
if (!_isCallerStreamSender(streamId)) {
if (msg.sender != _streams[streamId].sender) {
revert Errors.SablierV2OpenEnded_Unauthorized(streamId, msg.sender);
}
_;
Expand Down Expand Up @@ -109,12 +109,18 @@ abstract contract SablierV2OpenEndedState is ISablierV2OpenEndedState {
}

/// @inheritdoc ISablierV2OpenEndedState
function getSender(uint256 streamId) external view notNull(streamId) returns (address sender) {
function getSender(uint256 streamId) external view override notNull(streamId) returns (address sender) {
sender = _streams[streamId].sender;
}

/// @inheritdoc ISablierV2OpenEndedState
function getStream(uint256 streamId) external view notNull(streamId) returns (OpenEnded.Stream memory stream) {
function getStream(uint256 streamId)
external
view
override
notNull(streamId)
returns (OpenEnded.Stream memory stream)
{
stream = _streams[streamId];
}

Expand All @@ -124,17 +130,7 @@ abstract contract SablierV2OpenEndedState is ISablierV2OpenEndedState {
}

/// @inheritdoc ISablierV2OpenEndedState
function isStream(uint256 streamId) public view returns (bool result) {
function isStream(uint256 streamId) public view override returns (bool result) {
result = _streams[streamId].isStream;
}

/*//////////////////////////////////////////////////////////////////////////
INTERNAL CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/

/// @notice Checks whether `msg.sender` is the stream's sender.
/// @param streamId The stream ID for the query.
function _isCallerStreamSender(uint256 streamId) internal view returns (bool) {
return msg.sender == _streams[streamId].sender;
}
}
18 changes: 10 additions & 8 deletions src/interfaces/ISablierV2OpenEnded.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,42 +99,44 @@ interface ISablierV2OpenEnded is ISablierV2OpenEndedState {
//////////////////////////////////////////////////////////////////////////*/

/// @notice Calculates the amount that the sender can refund from stream, denoted in 18 decimals.
/// @dev Reverts if `streamId` references a canceled stream.
/// @dev Reverts if `streamId` references a canceled or a null stream.
/// @param streamId The stream ID for the query.
/// @return refundableAmount The amount that the sender can refund.
function refundableAmountOf(uint256 streamId) external view returns (uint128 refundableAmount);

/// @notice Calculates the amount that the sender can refund from stream at `time`, denoted in 18 decimals.
/// @dev Reverts if `streamId` references a canceled stream.
/// @dev Reverts if `streamId` references a canceled or a null stream.
/// @param streamId The stream ID for the query.
/// @param time The Unix timestamp for the streamed amount calculation.
/// @return refundableAmount The amount that the sender can refund.
function refundableAmountOf(uint256 streamId, uint40 time) external view returns (uint128 refundableAmount);

/// @notice Calculates the amount that the sender owes on the stream, i.e. if more assets have been streamed than
/// its balance, denoted in 18 decimals. If there is no debt, it will return zero.
/// @dev Reverts if `streamId` references a canceled stream.
/// @dev Reverts if `streamId` references a canceled or a null stream.
/// @param streamId The stream ID for the query.
function streamDebt(uint256 streamId) external view returns (uint128 debt);
function streamDebtOf(uint256 streamId) external view returns (uint128 debt);

/// @notice Calculates the amount streamed to the recipient from the last time update to the current time,
/// denoted in 18 decimals.
/// @dev Reverts if `streamId` references a canceled stream.
/// @dev Reverts if `streamId` references a canceled or a null stream.
/// @param streamId The stream ID for the query.
function streamedAmountOf(uint256 streamId) external view returns (uint128 streamedAmount);

/// @notice Calculates the amount streamed to the recipient from the last time update to `time` passed as parameter,
/// denoted in 18 decimals.
/// @dev Reverts if `streamId` references a canceled stream.
/// @dev Reverts if `streamId` references a canceled or a null stream.
/// @param streamId The stream ID for the query.
/// @param time The Unix timestamp for the streamed amount calculation.
function streamedAmountOf(uint256 streamId, uint40 time) external view returns (uint128 streamedAmount);

/// @notice Calculates the amount that the recipient can withdraw from the stream, denoted in 18 decimals.
/// @dev Reverts if `streamId` references a canceled stream.
/// @dev Reverts if `streamId` references a canceled or a null stream.
/// @param streamId The stream ID for the query.
function withdrawableAmountOf(uint256 streamId) external view returns (uint128 withdrawableAmount);

/// @notice Calculates the amount that the recipient can withdraw from the stream at `time`, denoted in 18 decimals.
/// @dev Reverts if `streamId` references a canceled stream.
/// @dev Reverts if `streamId` references a canceled or a null stream.
/// @param streamId The stream ID for the query.
/// @param time The Unix timestamp for the streamed amount calculation.
function withdrawableAmountOf(uint256 streamId, uint40 time) external view returns (uint128 withdrawableAmount);
Expand Down
Loading

0 comments on commit e15c02c

Please sign in to comment.