diff --git a/.env.deployment.example b/.env.deployment.example
new file mode 100644
index 000000000..9ba86c60e
--- /dev/null
+++ b/.env.deployment.example
@@ -0,0 +1,29 @@
+# Used by the multi-chain deployment script
+
+# General
+export MNEMONIC="YOUR_MNEMONIC"
+
+# RPC URLs
+export ARBITRUM_RPC_URL="YOUR_RPC_URL"
+export ARBITRUM_SEPOLIA_RPC_URL="YOUR_RPC_URL"
+export AVALANCHE_RPC_URL="YOUR_RPC_URL"
+export BASE_RPC_URL="YOUR_RPC_URL"
+export BNB_RPC_URL="YOUR_RPC_URL"
+export GNOSIS_RPC_URL="YOUR_RPC_URL"
+export MAINNET_RPC_URL="YOUR_RPC_URL"
+export OPTIMISM_RPC_URL="YOUR_RPC_URL"
+export POLYGON_RPC_URL="YOUR_RPC_URL"
+export SCROLL_RPC_URL="YOUR_RPC_URL"
+export SEPOLIA_RPC_URL="YOUR_RPC_URL"
+
+# Etherscan API keys
+export ARBISCAN_API_KEY="YOUR_API_KEY"
+export BASESCAN_API_KEY="YOUR_API_KEY"
+export BSCSCAN_API_KEY="YOUR_API_KEY"
+export ETHERSCAN_API_KEY="YOUR_API_KEY"
+export GNOSISSCAN_API_KEY="YOUR_API_KEY"
+export OPTIMISTIC_API_KEY="YOUR_API_KEY"
+export POLYGONSCAN_API_KEY="YOUR_API_KEY"
+export SCROLLSCAN_API_KEY="YOUR_API_KEY"
+export SNOWTRACE_API_KEY="YOUR_API_KEY"
+
diff --git a/.env.example b/.env.example
index 8e4a32221..9a1fd9318 100644
--- a/.env.example
+++ b/.env.example
@@ -1,11 +1,6 @@
-export API_KEY_ARBISCAN="YOUR_API_KEY_ARBISCAN"
-export API_KEY_BSCSCAN="YOUR_API_KEY_BSCSCAN"
-export API_KEY_ETHERSCAN="YOUR_API_KEY_ETHERSCAN"
-export API_KEY_GNOSISSCAN="YOUR_API_KEY_GNOSISSCAN"
export API_KEY_INFURA="YOUR_API_KEY_INFURA"
-export API_KEY_OPTIMISTIC_ETHERSCAN="YOUR_API_KEY_OPTIMISTIC_ETHERSCAN"
-export API_KEY_POLYGONSCAN="YOUR_API_KEY_POLYGONSCAN"
-export API_KEY_SNOWTRACE="YOUR_API_KEY_SNOWTRACE"
-export RPC_URL_MAINNET="YOUR_RPC_URL_MAINNET"
+export EOA="YOUR_EOA_ADDRESS"
export FOUNDRY_PROFILE="lite"
export MNEMONIC="YOUR_MNEMONIC"
+export RPC_URL_MAINNET="YOUR_RPC_URL_MAINNET"
+
diff --git a/.gas-snapshot b/.gas-snapshot
deleted file mode 100644
index 22f579f78..000000000
--- a/.gas-snapshot
+++ /dev/null
@@ -1,413 +0,0 @@
-Burn_LockupDynamic_Integration_Concrete_Test:test_Burn_CallerApprovedOperator() (gas: 87632)
-Burn_LockupDynamic_Integration_Concrete_Test:test_Burn_CallerNFTOwner() (gas: 78216)
-Burn_LockupDynamic_Integration_Concrete_Test:test_Burn_NonTransferableNFT() (gas: 78225)
-Burn_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_NFTDoesNotExist() (gas: 79430)
-Burn_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11325)
-Burn_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_StatusCanceled() (gas: 90312)
-Burn_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_StatusPending() (gas: 14289)
-Burn_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_StatusSettled() (gas: 19525)
-Burn_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_StatusStreaming() (gas: 19561)
-Burn_LockupLinear_Integration_Concrete_Test:test_Burn_CallerApprovedOperator() (gas: 87770)
-Burn_LockupLinear_Integration_Concrete_Test:test_Burn_CallerNFTOwner() (gas: 78343)
-Burn_LockupLinear_Integration_Concrete_Test:test_Burn_NonTransferableNFT() (gas: 78352)
-Burn_LockupLinear_Integration_Concrete_Test:test_RevertGiven_NFTDoesNotExist() (gas: 79539)
-Burn_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11311)
-Burn_LockupLinear_Integration_Concrete_Test:test_RevertGiven_StatusCanceled() (gas: 81013)
-Burn_LockupLinear_Integration_Concrete_Test:test_RevertGiven_StatusPending() (gas: 14275)
-Burn_LockupLinear_Integration_Concrete_Test:test_RevertGiven_StatusSettled() (gas: 19511)
-Burn_LockupLinear_Integration_Concrete_Test:test_RevertGiven_StatusStreaming() (gas: 19547)
-CancelMultiple_LockupDynamic_Integration_Concrete_Test:test_CancelMultiple() (gas: 833554)
-CancelMultiple_LockupDynamic_Integration_Concrete_Test:test_CancelMultiple_ArrayCountZero() (gas: 6271)
-CancelMultiple_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_AllStreamsCold() (gas: 32346)
-CancelMultiple_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_AllStreamsNotCancelable() (gas: 859532)
-CancelMultiple_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_OnlyNull() (gas: 12362)
-CancelMultiple_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_SomeNull() (gas: 78556)
-CancelMultiple_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_SomeStreamsCold() (gas: 341289)
-CancelMultiple_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_SomeStreamsNotCancelable() (gas: 946037)
-CancelMultiple_LockupDynamic_Integration_Fuzz_Test:testFuzz_CancelMultiple(uint256,uint40) (runs: 50, μ: 1197307, ~: 1201972)
-CancelMultiple_LockupLinear_Integration_Concrete_Test:test_CancelMultiple() (gas: 565501)
-CancelMultiple_LockupLinear_Integration_Concrete_Test:test_CancelMultiple_ArrayCountZero() (gas: 6294)
-CancelMultiple_LockupLinear_Integration_Concrete_Test:test_RevertGiven_AllStreamsCold() (gas: 32494)
-CancelMultiple_LockupLinear_Integration_Concrete_Test:test_RevertGiven_AllStreamsNotCancelable() (gas: 572744)
-CancelMultiple_LockupLinear_Integration_Concrete_Test:test_RevertGiven_OnlyNull() (gas: 12391)
-CancelMultiple_LockupLinear_Integration_Concrete_Test:test_RevertGiven_SomeNull() (gas: 78577)
-CancelMultiple_LockupLinear_Integration_Concrete_Test:test_RevertGiven_SomeStreamsCold() (gas: 245380)
-CancelMultiple_LockupLinear_Integration_Concrete_Test:test_RevertGiven_SomeStreamsNotCancelable() (gas: 657233)
-CancelMultiple_LockupLinear_Integration_Fuzz_Test:testFuzz_CancelMultiple(uint256,uint40) (runs: 50, μ: 797110, ~: 798213)
-Cancel_LockupDynamic_Integration_Concrete_Test:test_Cancel() (gas: 386274)
-Cancel_LockupDynamic_Integration_Concrete_Test:test_Cancel_RecipientDoesNotImplementHook() (gas: 371426)
-Cancel_LockupDynamic_Integration_Concrete_Test:test_Cancel_RecipientNotContract() (gas: 97176)
-Cancel_LockupDynamic_Integration_Concrete_Test:test_Cancel_RecipientReentrancy() (gas: 373617)
-Cancel_LockupDynamic_Integration_Concrete_Test:test_Cancel_RecipientReverts() (gas: 371993)
-Cancel_LockupDynamic_Integration_Concrete_Test:test_Cancel_StatusPending() (gas: 76401)
-Cancel_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11321)
-Cancel_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_StatusCanceled() (gas: 87398)
-Cancel_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_StatusDepleted() (gas: 68085)
-Cancel_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_StatusSettled() (gas: 27022)
-Cancel_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_StreamNotCancelable() (gas: 261520)
-Cancel_LockupDynamic_Integration_Fuzz_Test:testFuzz_Cancel(uint256,uint128) (runs: 50, μ: 453577, ~: 454727)
-Cancel_LockupDynamic_Integration_Fuzz_Test:testFuzz_Cancel_StatusPending(uint256) (runs: 50, μ: 76907, ~: 76982)
-Cancel_LockupLinear_Integration_Concrete_Test:test_Cancel() (gas: 269481)
-Cancel_LockupLinear_Integration_Concrete_Test:test_Cancel_RecipientDoesNotImplementHook() (gas: 254609)
-Cancel_LockupLinear_Integration_Concrete_Test:test_Cancel_RecipientNotContract() (gas: 77523)
-Cancel_LockupLinear_Integration_Concrete_Test:test_Cancel_RecipientReentrancy() (gas: 256789)
-Cancel_LockupLinear_Integration_Concrete_Test:test_Cancel_RecipientReverts() (gas: 255176)
-Cancel_LockupLinear_Integration_Concrete_Test:test_Cancel_StatusPending() (gas: 76441)
-Cancel_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11307)
-Cancel_LockupLinear_Integration_Concrete_Test:test_RevertGiven_StatusCanceled() (gas: 78102)
-Cancel_LockupLinear_Integration_Concrete_Test:test_RevertGiven_StatusDepleted() (gas: 68238)
-Cancel_LockupLinear_Integration_Concrete_Test:test_RevertGiven_StatusSettled() (gas: 27130)
-Cancel_LockupLinear_Integration_Concrete_Test:test_RevertGiven_StreamNotCancelable() (gas: 185647)
-Cancel_LockupLinear_Integration_Fuzz_Test:testFuzz_Cancel(uint256,uint128) (runs: 50, μ: 309387, ~: 310054)
-Cancel_LockupLinear_Integration_Fuzz_Test:testFuzz_Cancel_StatusPending(uint256) (runs: 50, μ: 76947, ~: 77022)
-ClaimProtocolRevenues_LockupDynamic_Integration_Concrete_Test:test_ClaimProtocolRevenues() (gas: 319728)
-ClaimProtocolRevenues_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_ProtocolRevenuesZero() (gas: 18907)
-ClaimProtocolRevenues_LockupLinear_Integration_Concrete_Test:test_ClaimProtocolRevenues() (gas: 246456)
-ClaimProtocolRevenues_LockupLinear_Integration_Concrete_Test:test_RevertGiven_ProtocolRevenuesZero() (gas: 18915)
-Constructor_LockupDynamic_Integration_Concrete_Test:test_Constructor() (gas: 5374061)
-Constructor_LockupLinear_Integration_Concrete_Test:test_Constructor() (gas: 4181201)
-CreateWithDeltas_LockupDynamic_Integration_Concrete_Test:test_CreateWithDeltas() (gas: 380621)
-CreateWithDeltas_LockupDynamic_Integration_Fuzz_Test:testFuzz_CreateWithDeltas((uint128,uint64,uint40)[]) (runs: 50, μ: 4100448, ~: 3558725)
-CreateWithDurations_LockupLinear_Integration_Concrete_Test:test_CreateWithDurations() (gas: 287592)
-CreateWithDurations_LockupLinear_Integration_Fuzz_Test:testFuzz_CreateWithDurations((uint40,uint40)) (runs: 50, μ: 286442, ~: 286543)
-CreateWithMilestones_LockupDynamic_Integration_Concrete_Test:test_CreateWithMilestones() (gas: 370968)
-CreateWithMilestones_LockupDynamic_Integration_Concrete_Test:test_CreateWithMilestones_AssetMissingReturnValue() (gas: 377756)
-CreateWithMilestones_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_EndTimeNotInTheFuture() (gas: 47537)
-CreateWithMilestones_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_ProtocolFeeTooHigh() (gas: 58079)
-CreateWithMilestones_LockupDynamic_Integration_Fuzz_Test:testFuzz_CreateWithMilestones(address,(address,uint40,bool,bool,address,uint128,address,(address,uint256),(uint128,uint64,uint40)[]),uint256) (runs: 50, μ: 3967005, ~: 3991455)
-CreateWithRange_LockupLinear_Integration_Concrete_Test:test_CreateWithRange() (gas: 282990)
-CreateWithRange_LockupLinear_Integration_Concrete_Test:test_CreateWithRange_AssetMissingReturnValue() (gas: 289757)
-CreateWithRange_LockupLinear_Integration_Concrete_Test:test_RevertGiven_EndTimeNotInTheFuture() (gas: 41154)
-CreateWithRange_LockupLinear_Integration_Concrete_Test:test_RevertGiven_ProtocolFeeTooHigh() (gas: 51749)
-CreateWithRange_LockupLinear_Integration_Fuzz_Test:testFuzz_CreateWithRange(address,(address,address,uint128,address,bool,bool,(uint40,uint40,uint40),(address,uint256)),uint256) (runs: 50, μ: 371749, ~: 379742)
-FlashFee_Integration_Concrete_Test:test_FlashFee() (gas: 50968)
-FlashFee_Integration_Concrete_Test:test_RevertGiven_AssetNotFlashLoanable() (gas: 18626)
-FlashFee_Integration_Fuzz_Test:testFuzz_FlashFee(uint256,uint256) (runs: 50, μ: 51839, ~: 52081)
-FlashLoanFunction_Integration_Concrete_Test:test_FlashLoan() (gas: 402140)
-FlashLoanFunction_Integration_Concrete_Test:test_RevertGiven_AssetNotFlashLoanable() (gas: 21603)
-FlashLoanFunction_Integration_Fuzz_Test:testFuzz_FlashLoanFunction(uint256,uint128,bytes) (runs: 50, μ: 403153, ~: 406890)
-GenerateAccentColor_Integration_Concrete_Test:test_GenerateAccentColor() (gas: 13215)
-GetAsset_LockupDynamic_Integration_Concrete_Test:test_GetAsset() (gas: 307759)
-GetAsset_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 12049)
-GetAsset_LockupLinear_Integration_Concrete_Test:test_GetAsset() (gas: 234467)
-GetAsset_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 12035)
-GetCliffTime_LockupLinear_Integration_Concrete_Test:test_GetCliffTime() (gas: 234951)
-GetCliffTime_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11392)
-GetDepositedAmount_LockupDynamic_Integration_Concrete_Test:test_GetDepositedAmount() (gas: 310556)
-GetDepositedAmount_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11682)
-GetDepositedAmount_LockupLinear_Integration_Concrete_Test:test_GetDepositedAmount() (gas: 237238)
-GetDepositedAmount_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11678)
-GetEndTime_LockupDynamic_Integration_Concrete_Test:test_GetEndTime() (gas: 310354)
-GetEndTime_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11538)
-GetEndTime_LockupLinear_Integration_Concrete_Test:test_GetEndTime() (gas: 237090)
-GetEndTime_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11546)
-GetRange_LockupDynamic_Integration_Concrete_Test:test_GetRange() (gas: 309780)
-GetRange_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 13125)
-GetRange_LockupLinear_Integration_Concrete_Test:test_GetRange() (gas: 237308)
-GetRange_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 13308)
-GetRecipient_LockupDynamic_Integration_Concrete_Test:test_GetRecipient() (gas: 12585)
-GetRecipient_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_NFTBurned() (gas: 72524)
-GetRecipient_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 10989)
-GetRecipient_LockupLinear_Integration_Concrete_Test:test_GetRecipient() (gas: 12565)
-GetRecipient_LockupLinear_Integration_Concrete_Test:test_RevertGiven_NFTBurned() (gas: 72651)
-GetRecipient_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 10993)
-GetRefundedAmount_LockupDynamic_Integration_Concrete_Test:test_GetRefundedAmount_StatusDepleted() (gas: 362867)
-GetRefundedAmount_LockupDynamic_Integration_Concrete_Test:test_GetRefundedAmount_StatusPending() (gas: 332698)
-GetRefundedAmount_LockupDynamic_Integration_Concrete_Test:test_GetRefundedAmount_StatusSettled() (gas: 337906)
-GetRefundedAmount_LockupDynamic_Integration_Concrete_Test:test_GetRefundedAmount_StatusStreaming() (gas: 337920)
-GetRefundedAmount_LockupDynamic_Integration_Concrete_Test:test_GetRefundedAmount_StreamHasBeenCanceled_StatusCanceled() (gas: 377552)
-GetRefundedAmount_LockupDynamic_Integration_Concrete_Test:test_GetRefundedAmount_StreamHasBeenCanceled_StatusDepleted() (gas: 399390)
-GetRefundedAmount_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 12045)
-GetRefundedAmount_LockupLinear_Integration_Concrete_Test:test_GetRefundedAmount_StatusDepleted() (gas: 287754)
-GetRefundedAmount_LockupLinear_Integration_Concrete_Test:test_GetRefundedAmount_StatusPending() (gas: 257418)
-GetRefundedAmount_LockupLinear_Integration_Concrete_Test:test_GetRefundedAmount_StatusSettled() (gas: 262626)
-GetRefundedAmount_LockupLinear_Integration_Concrete_Test:test_GetRefundedAmount_StatusStreaming() (gas: 262640)
-GetRefundedAmount_LockupLinear_Integration_Concrete_Test:test_GetRefundedAmount_StreamHasBeenCanceled_StatusCanceled() (gas: 298987)
-GetRefundedAmount_LockupLinear_Integration_Concrete_Test:test_GetRefundedAmount_StreamHasBeenCanceled_StatusDepleted() (gas: 320748)
-GetRefundedAmount_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 12031)
-GetSegments_LockupDynamic_Integration_Concrete_Test:test_GetSegments() (gas: 315258)
-GetSegments_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 13758)
-GetSender_LockupDynamic_Integration_Concrete_Test:test_GetSender() (gas: 307477)
-GetSender_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11814)
-GetSender_LockupLinear_Integration_Concrete_Test:test_GetSender() (gas: 234201)
-GetSender_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11816)
-GetStartTime_LockupDynamic_Integration_Concrete_Test:test_GetStartTime() (gas: 310683)
-GetStartTime_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11823)
-GetStartTime_LockupLinear_Integration_Concrete_Test:test_GetStartTime() (gas: 237413)
-GetStartTime_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11831)
-GetStream_LockupDynamic_Integration_Concrete_Test:test_GetStream() (gas: 278720)
-GetStream_LockupDynamic_Integration_Concrete_Test:test_GetStream_StatusSettled() (gas: 52024)
-GetStream_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 15544)
-GetStream_LockupLinear_Integration_Concrete_Test:test_GetStream() (gas: 34920)
-GetStream_LockupLinear_Integration_Concrete_Test:test_GetStream_StatusSettled() (gas: 39431)
-GetStream_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 14299)
-GetWithdrawnAmount_LockupDynamic_Integration_Concrete_Test:test_GetWithdrawnAmount() (gas: 384696)
-GetWithdrawnAmount_LockupDynamic_Integration_Concrete_Test:test_GetWithdrawnAmount_NoPreviousWithdrawals() (gas: 335880)
-GetWithdrawnAmount_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 12012)
-GetWithdrawnAmount_LockupDynamic_Integration_Fuzz_Test:testFuzz_GetWithdrawnAmount(uint256,uint128) (runs: 50, μ: 387702, ~: 388140)
-GetWithdrawnAmount_LockupDynamic_Integration_Fuzz_Test:testFuzz_GetWithdrawnAmount_NoPreviousWithdrawals(uint256) (runs: 50, μ: 337638, ~: 337804)
-GetWithdrawnAmount_LockupLinear_Integration_Concrete_Test:test_GetWithdrawnAmount() (gas: 282118)
-GetWithdrawnAmount_LockupLinear_Integration_Concrete_Test:test_GetWithdrawnAmount_NoPreviousWithdrawals() (gas: 262600)
-GetWithdrawnAmount_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11998)
-GetWithdrawnAmount_LockupLinear_Integration_Fuzz_Test:testFuzz_GetWithdrawnAmount(uint256,uint128) (runs: 50, μ: 285328, ~: 285260)
-GetWithdrawnAmount_LockupLinear_Integration_Fuzz_Test:testFuzz_GetWithdrawnAmount_NoPreviousWithdrawals(uint256) (runs: 50, μ: 264330, ~: 264524)
-IsCancelable_LockupDynamic_Integration_Concrete_Test:test_IsCancelable() (gas: 515865)
-IsCancelable_LockupDynamic_Integration_Concrete_Test:test_IsCancelable_Cold() (gas: 336103)
-IsCancelable_LockupDynamic_Integration_Concrete_Test:test_IsCancelable_StreamCancelable() (gas: 327347)
-IsCancelable_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11239)
-IsCancelable_LockupLinear_Integration_Concrete_Test:test_IsCancelable() (gas: 372779)
-IsCancelable_LockupLinear_Integration_Concrete_Test:test_IsCancelable_Cold() (gas: 262975)
-IsCancelable_LockupLinear_Integration_Concrete_Test:test_IsCancelable_StreamCancelable() (gas: 254102)
-IsCancelable_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11263)
-IsCold_LockupDynamic_Integration_Concrete_Test:test_IsCold_StatusCanceled() (gas: 376250)
-IsCold_LockupDynamic_Integration_Concrete_Test:test_IsCold_StatusDepleted() (gas: 362513)
-IsCold_LockupDynamic_Integration_Concrete_Test:test_IsCold_StatusPending() (gas: 330604)
-IsCold_LockupDynamic_Integration_Concrete_Test:test_IsCold_StatusSettled() (gas: 336374)
-IsCold_LockupDynamic_Integration_Concrete_Test:test_IsCold_StatusStreaming() (gas: 352684)
-IsCold_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11525)
-IsCold_LockupLinear_Integration_Concrete_Test:test_IsCold_StatusCanceled() (gas: 297736)
-IsCold_LockupLinear_Integration_Concrete_Test:test_IsCold_StatusDepleted() (gas: 287458)
-IsCold_LockupLinear_Integration_Concrete_Test:test_IsCold_StatusPending() (gas: 257382)
-IsCold_LockupLinear_Integration_Concrete_Test:test_IsCold_StatusSettled() (gas: 263264)
-IsCold_LockupLinear_Integration_Concrete_Test:test_IsCold_StatusStreaming() (gas: 263799)
-IsCold_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11568)
-IsDepleted_LockupDynamic_Integration_Concrete_Test:test_IsDepleted() (gas: 361951)
-IsDepleted_LockupDynamic_Integration_Concrete_Test:test_IsDepleted_StreamNotDepleted() (gas: 326771)
-IsDepleted_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11191)
-IsDepleted_LockupLinear_Integration_Concrete_Test:test_IsDepleted() (gas: 286858)
-IsDepleted_LockupLinear_Integration_Concrete_Test:test_IsDepleted_StreamNotDepleted() (gas: 253511)
-IsDepleted_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11212)
-IsStream_LockupDynamic_Integration_Concrete_Test:test_IsStream() (gas: 327111)
-IsStream_LockupDynamic_Integration_Concrete_Test:test_IsStream_Null() (gas: 8527)
-IsStream_LockupLinear_Integration_Concrete_Test:test_IsStream() (gas: 253873)
-IsStream_LockupLinear_Integration_Concrete_Test:test_IsStream_Null() (gas: 8570)
-IsTransferable_LockupDynamic_Integration_Concrete_Test:test_IsTransferable_Stream() (gas: 327273)
-IsTransferable_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11674)
-IsTransferable_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_StreamTransferNotEnabled() (gas: 515864)
-IsTransferable_LockupLinear_Integration_Concrete_Test:test_IsTransferable_Stream() (gas: 254057)
-IsTransferable_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11739)
-IsTransferable_LockupLinear_Integration_Concrete_Test:test_RevertGiven_StreamTransferNotEnabled() (gas: 372834)
-IsWarm_LockupDynamic_Integration_Concrete_Test:test_IsWarm_StatusCanceled() (gas: 375788)
-IsWarm_LockupDynamic_Integration_Concrete_Test:test_IsWarm_StatusDepleted() (gas: 362027)
-IsWarm_LockupDynamic_Integration_Concrete_Test:test_IsWarm_StatusPending() (gas: 330041)
-IsWarm_LockupDynamic_Integration_Concrete_Test:test_IsWarm_StatusSettled() (gas: 335985)
-IsWarm_LockupDynamic_Integration_Concrete_Test:test_IsWarm_StatusStreaming() (gas: 352169)
-IsWarm_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11085)
-IsWarm_LockupLinear_Integration_Concrete_Test:test_IsWarm_StatusCanceled() (gas: 297243)
-IsWarm_LockupLinear_Integration_Concrete_Test:test_IsWarm_StatusDepleted() (gas: 286934)
-IsWarm_LockupLinear_Integration_Concrete_Test:test_IsWarm_StatusPending() (gas: 256781)
-IsWarm_LockupLinear_Integration_Concrete_Test:test_IsWarm_StatusSettled() (gas: 262847)
-IsWarm_LockupLinear_Integration_Concrete_Test:test_IsWarm_StatusStreaming() (gas: 263246)
-IsWarm_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11106)
-MapSymbol_Integration_Concrete_Test:test_MapSymbol_LockupDynamic() (gas: 16959)
-MapSymbol_Integration_Concrete_Test:test_MapSymbol_LockupLinear() (gas: 16733)
-MapSymbol_Integration_Concrete_Test:test_RevertGiven_UnknownNFT() (gas: 1039753)
-MaxFlashLoan_Integration_Concrete_Test:test_MaxFlashLoan() (gas: 178987)
-MaxFlashLoan_Integration_Concrete_Test:test_MaxFlashLoan_AssetNotFlashLoanable() (gas: 15248)
-MaxFlashLoan_Integration_Fuzz_Test:testFuzz_MaxFlashLoan(uint256) (runs: 50, μ: 178984, ~: 179002)
-ProtocolFees_Integration_Concrete_Test:test_ProtocolFees() (gas: 41254)
-ProtocolFees_Integration_Concrete_Test:test_ProtocolFees_ProtocolFeeNotSet() (gas: 9943)
-ProtocolRevenues_LockupDynamic_Integration_Concrete_Test:test_ProtocolRevenues() (gas: 320228)
-ProtocolRevenues_LockupDynamic_Integration_Concrete_Test:test_ProtocolRevenues_ProtocolRevenuesZero() (gas: 10125)
-ProtocolRevenues_LockupLinear_Integration_Concrete_Test:test_ProtocolRevenues() (gas: 246945)
-ProtocolRevenues_LockupLinear_Integration_Concrete_Test:test_ProtocolRevenues_ProtocolRevenuesZero() (gas: 10111)
-RefundableAmountOf_LockupDynamic_Integration_Concrete_Test:test_RefundableAmountOf_StatusDepleted() (gas: 361988)
-RefundableAmountOf_LockupDynamic_Integration_Concrete_Test:test_RefundableAmountOf_StatusPending() (gas: 335841)
-RefundableAmountOf_LockupDynamic_Integration_Concrete_Test:test_RefundableAmountOf_StatusSettled() (gas: 335834)
-RefundableAmountOf_LockupDynamic_Integration_Concrete_Test:test_RefundableAmountOf_StatusStreaming() (gas: 342703)
-RefundableAmountOf_LockupDynamic_Integration_Concrete_Test:test_RefundableAmountOf_StreamHasBeenCanceled_StatusCanceled() (gas: 375697)
-RefundableAmountOf_LockupDynamic_Integration_Concrete_Test:test_RefundableAmountOf_StreamHasBeenCanceled_StatusDepleted() (gas: 398898)
-RefundableAmountOf_LockupDynamic_Integration_Concrete_Test:test_RefundableAmountOf_StreamNotCancelable() (gas: 523491)
-RefundableAmountOf_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11099)
-RefundableAmountOf_LockupDynamic_Integration_Fuzz_Test:testFuzz_RefundableAmountOf(uint256) (runs: 50, μ: 45465, ~: 30742)
-RefundableAmountOf_LockupLinear_Integration_Concrete_Test:test_RefundableAmountOf_StatusDepleted() (gas: 286891)
-RefundableAmountOf_LockupLinear_Integration_Concrete_Test:test_RefundableAmountOf_StatusPending() (gas: 262568)
-RefundableAmountOf_LockupLinear_Integration_Concrete_Test:test_RefundableAmountOf_StatusSettled() (gas: 262691)
-RefundableAmountOf_LockupLinear_Integration_Concrete_Test:test_RefundableAmountOf_StatusStreaming() (gas: 264178)
-RefundableAmountOf_LockupLinear_Integration_Concrete_Test:test_RefundableAmountOf_StreamHasBeenCanceled_StatusCanceled() (gas: 297148)
-RefundableAmountOf_LockupLinear_Integration_Concrete_Test:test_RefundableAmountOf_StreamHasBeenCanceled_StatusDepleted() (gas: 320272)
-RefundableAmountOf_LockupLinear_Integration_Concrete_Test:test_RefundableAmountOf_StreamNotCancelable() (gas: 380410)
-RefundableAmountOf_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11110)
-RefundableAmountOf_LockupLinear_Integration_Fuzz_Test:testFuzz_RefundableAmountOf(uint256) (runs: 50, μ: 30678, ~: 30858)
-Renounce_LockupDynamic_Integration_Concrete_Test:test_Renounce() (gas: 694498)
-Renounce_LockupDynamic_Integration_Concrete_Test:test_Renounce_RecipientDoesNotImplementHook() (gas: 687573)
-Renounce_LockupDynamic_Integration_Concrete_Test:test_Renounce_RecipientNotContract() (gas: 292606)
-Renounce_LockupDynamic_Integration_Concrete_Test:test_Renounce_RecipientReentrancy() (gas: 692702)
-Renounce_LockupDynamic_Integration_Concrete_Test:test_Renounce_RecipientReverts() (gas: 688180)
-Renounce_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11567)
-Renounce_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_StatusCanceled() (gas: 87385)
-Renounce_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_StatusDepleted() (gas: 68389)
-Renounce_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_StatusSettled() (gas: 24692)
-Renounce_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_StreamNotCancelable() (gas: 649846)
-Renounce_LockupLinear_Integration_Concrete_Test:test_Renounce() (gas: 481553)
-Renounce_LockupLinear_Integration_Concrete_Test:test_Renounce_RecipientDoesNotImplementHook() (gas: 474596)
-Renounce_LockupLinear_Integration_Concrete_Test:test_Renounce_RecipientNotContract() (gas: 219349)
-Renounce_LockupLinear_Integration_Concrete_Test:test_Renounce_RecipientReentrancy() (gas: 479733)
-Renounce_LockupLinear_Integration_Concrete_Test:test_Renounce_RecipientReverts() (gas: 475203)
-Renounce_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11575)
-Renounce_LockupLinear_Integration_Concrete_Test:test_RevertGiven_StatusCanceled() (gas: 78108)
-Renounce_LockupLinear_Integration_Concrete_Test:test_RevertGiven_StatusDepleted() (gas: 68564)
-Renounce_LockupLinear_Integration_Concrete_Test:test_RevertGiven_StatusSettled() (gas: 24822)
-Renounce_LockupLinear_Integration_Concrete_Test:test_RevertGiven_StreamNotCancelable() (gas: 436925)
-SafeAssetDecimals_Integration_Concrete_Test:test_SafeAssetDecimals() (gas: 12117)
-SafeAssetDecimals_Integration_Concrete_Test:test_SafeAssetDecimals_DecimalsNotImplemented() (gas: 10852)
-SafeAssetDecimals_Integration_Concrete_Test:test_SafeAssetDecimals_EOA() (gas: 11625)
-SafeAssetSymbol_Integration_Concrete_Test:test_SafeAssetSymbol() (gas: 18550)
-SafeAssetSymbol_Integration_Concrete_Test:test_SafeAssetSymbol_Bytes32() (gas: 62214)
-SafeAssetSymbol_Integration_Concrete_Test:test_SafeAssetSymbol_EOA() (gas: 13222)
-SafeAssetSymbol_Integration_Concrete_Test:test_SafeAssetSymbol_LongSymbol() (gas: 624896)
-SafeAssetSymbol_Integration_Concrete_Test:test_SafeAssetSymbol_SymbolNotImplemented() (gas: 12399)
-SetComptroller_LockupDynamic_Integration_Concrete_Test:test_SetComptroller_NewComptroller() (gas: 311753)
-SetComptroller_LockupDynamic_Integration_Concrete_Test:test_SetComptroller_SameComptroller() (gas: 23283)
-SetComptroller_LockupLinear_Integration_Concrete_Test:test_SetComptroller_NewComptroller() (gas: 311750)
-SetComptroller_LockupLinear_Integration_Concrete_Test:test_SetComptroller_SameComptroller() (gas: 23280)
-SetFlashFee_Integration_Fuzz_Test:testFuzz_SetFlashFee(uint256) (runs: 50, μ: 37754, ~: 39448)
-SetNFTDescriptor_LockupDynamic_Integration_Concrete_Test:test_SetNFTDescriptor_NewNFTDescriptor() (gas: 6551561)
-SetNFTDescriptor_LockupDynamic_Integration_Concrete_Test:test_SetNFTDescriptor_SameNFTDescriptor() (gas: 2258131)
-SetNFTDescriptor_LockupLinear_Integration_Concrete_Test:test_SetNFTDescriptor_NewNFTDescriptor() (gas: 6550197)
-SetNFTDescriptor_LockupLinear_Integration_Concrete_Test:test_SetNFTDescriptor_SameNFTDescriptor() (gas: 2256602)
-SetProtocolFee_Integration_Concrete_Test:test_SetProtocolFee() (gas: 47804)
-SetProtocolFee_Integration_Concrete_Test:test_SetProtocolFee_SameFee() (gas: 22636)
-SetProtocolFee_Integration_Fuzz_Test:testFuzz_SetProtocolFee(uint256) (runs: 50, μ: 43131, ~: 43074)
-StatusOf_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11651)
-StatusOf_LockupDynamic_Integration_Concrete_Test:test_StatusOf() (gas: 352806)
-StatusOf_LockupDynamic_Integration_Concrete_Test:test_StatusOf_AssetsFullyWithdrawn() (gas: 362652)
-StatusOf_LockupDynamic_Integration_Concrete_Test:test_StatusOf_RefundableAmountNotZero() (gas: 336586)
-StatusOf_LockupDynamic_Integration_Concrete_Test:test_StatusOf_StartTimeInTheFuture() (gas: 330685)
-StatusOf_LockupDynamic_Integration_Concrete_Test:test_StatusOf_StreamCanceled() (gas: 376424)
-StatusOf_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11681)
-StatusOf_LockupLinear_Integration_Concrete_Test:test_StatusOf() (gas: 263297)
-StatusOf_LockupLinear_Integration_Concrete_Test:test_StatusOf_AssetsFullyWithdrawn() (gas: 287573)
-StatusOf_LockupLinear_Integration_Concrete_Test:test_StatusOf_RefundableAmountNotZero() (gas: 263462)
-StatusOf_LockupLinear_Integration_Concrete_Test:test_StatusOf_StartTimeInTheFuture() (gas: 257439)
-StatusOf_LockupLinear_Integration_Concrete_Test:test_StatusOf_StreamCanceled() (gas: 297893)
-StreamedAmountOf_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11319)
-StreamedAmountOf_LockupDynamic_Integration_Concrete_Test:test_StreamedAmountOf_CurrentMilestone1st() (gas: 45931)
-StreamedAmountOf_LockupDynamic_Integration_Concrete_Test:test_StreamedAmountOf_CurrentMilestoneNot1st() (gas: 50774)
-StreamedAmountOf_LockupDynamic_Integration_Concrete_Test:test_StreamedAmountOf_OneSegment() (gas: 257024)
-StreamedAmountOf_LockupDynamic_Integration_Concrete_Test:test_StreamedAmountOf_StartTimeInTheFuture() (gas: 20230)
-StreamedAmountOf_LockupDynamic_Integration_Concrete_Test:test_StreamedAmountOf_StartTimeInThePresent() (gas: 25593)
-StreamedAmountOf_LockupDynamic_Integration_Concrete_Test:test_StreamedAmountOf_StatusDepleted() (gas: 68723)
-StreamedAmountOf_LockupDynamic_Integration_Concrete_Test:test_StreamedAmountOf_StatusPending() (gas: 20360)
-StreamedAmountOf_LockupDynamic_Integration_Concrete_Test:test_StreamedAmountOf_StatusSettled() (gas: 26624)
-StreamedAmountOf_LockupDynamic_Integration_Concrete_Test:test_StreamedAmountOf_StreamHasBeenCanceled_StatusCanceled() (gas: 87798)
-StreamedAmountOf_LockupDynamic_Integration_Concrete_Test:test_StreamedAmountOf_StreamHasBeenCanceled_StatusDepleted() (gas: 116445)
-StreamedAmountOf_LockupDynamic_Integration_Fuzz_Test:testFuzz_StreamedAmountOf_Calculation((uint128,uint64,uint40)[],uint40) (runs: 50, μ: 3521669, ~: 3127614)
-StreamedAmountOf_LockupDynamic_Integration_Fuzz_Test:testFuzz_StreamedAmountOf_Monotonicity((uint128,uint64,uint40)[],uint40,uint40) (runs: 50, μ: 3971180, ~: 4105954)
-StreamedAmountOf_LockupDynamic_Integration_Fuzz_Test:testFuzz_StreamedAmountOf_OneSegment((uint128,uint64,uint40),uint40) (runs: 50, μ: 276351, ~: 270631)
-StreamedAmountOf_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 11349)
-StreamedAmountOf_LockupLinear_Integration_Concrete_Test:test_StreamedAmountOf_CliffTimeInTheFuture() (gas: 26236)
-StreamedAmountOf_LockupLinear_Integration_Concrete_Test:test_StreamedAmountOf_CliffTimeInThePast() (gas: 17291)
-StreamedAmountOf_LockupLinear_Integration_Concrete_Test:test_StreamedAmountOf_CliffTimeInThePresent() (gas: 27121)
-StreamedAmountOf_LockupLinear_Integration_Concrete_Test:test_StreamedAmountOf_StatusDepleted() (gas: 68877)
-StreamedAmountOf_LockupLinear_Integration_Concrete_Test:test_StreamedAmountOf_StatusPending() (gas: 20305)
-StreamedAmountOf_LockupLinear_Integration_Concrete_Test:test_StreamedAmountOf_StatusSettled() (gas: 26688)
-StreamedAmountOf_LockupLinear_Integration_Concrete_Test:test_StreamedAmountOf_StreamHasBeenCanceled_StatusCanceled() (gas: 78522)
-StreamedAmountOf_LockupLinear_Integration_Concrete_Test:test_StreamedAmountOf_StreamHasBeenCanceled_StatusDepleted() (gas: 107059)
-StreamedAmountOf_LockupLinear_Integration_Fuzz_Test:testFuzz_StreamedAmountOf_Calculation(uint40,uint128) (runs: 50, μ: 234550, ~: 235267)
-StreamedAmountOf_LockupLinear_Integration_Fuzz_Test:testFuzz_StreamedAmountOf_CliffTimeInTheFuture(uint40) (runs: 50, μ: 27341, ~: 27604)
-StreamedAmountOf_LockupLinear_Integration_Fuzz_Test:testFuzz_StreamedAmountOf_Monotonicity(uint40,uint40,uint128) (runs: 50, μ: 239192, ~: 241446)
-ToggleFlashAsset_Integration_Concrete_Test:test_ToggleFlashAsset() (gas: 31848)
-ToggleFlashAsset_Integration_Concrete_Test:test_ToggleFlashAsset_FlagNotEnabled() (gas: 41868)
-TokenURI_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_NFTDoesNotExist() (gas: 13542)
-TokenURI_LockupDynamic_Integration_Concrete_Test:test_TokenURI_Decoded() (gas: 6624)
-TokenURI_LockupDynamic_Integration_Concrete_Test:test_TokenURI_Full() (gas: 6601)
-TokenURI_LockupLinear_Integration_Concrete_Test:test_RevertGiven_NFTDoesNotExist() (gas: 13525)
-TokenURI_LockupLinear_Integration_Concrete_Test:test_TokenURI_Decoded() (gas: 6624)
-TokenURI_LockupLinear_Integration_Concrete_Test:test_TokenURI_Full() (gas: 6601)
-TransferFrom_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_StreamNotTransferable() (gas: 314210)
-TransferFrom_LockupDynamic_Integration_Concrete_Test:test_TransferFrom() (gas: 326549)
-TransferFrom_LockupLinear_Integration_Concrete_Test:test_RevertGiven_StreamNotTransferable() (gas: 240360)
-TransferFrom_LockupLinear_Integration_Concrete_Test:test_TransferFrom() (gas: 253204)
-WasCanceled_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 12048)
-WasCanceled_LockupDynamic_Integration_Concrete_Test:test_WasCanceled() (gas: 364519)
-WasCanceled_LockupDynamic_Integration_Concrete_Test:test_WasCanceled_StreamNotCanceled() (gas: 327661)
-WasCanceled_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 12069)
-WasCanceled_LockupLinear_Integration_Concrete_Test:test_WasCanceled() (gas: 289228)
-WasCanceled_LockupLinear_Integration_Concrete_Test:test_WasCanceled_StreamNotCanceled() (gas: 254401)
-WithdrawMaxAndTransfer_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_NFTBurned() (gas: 75443)
-WithdrawMaxAndTransfer_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 14165)
-WithdrawMaxAndTransfer_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_StreamNotTransferable() (gas: 265059)
-WithdrawMaxAndTransfer_LockupDynamic_Integration_Concrete_Test:test_WithdrawMaxAndTransfer() (gas: 158734)
-WithdrawMaxAndTransfer_LockupDynamic_Integration_Concrete_Test:test_WithdrawMaxAndTransfer_WithdrawableAmountZero() (gas: 100587)
-WithdrawMaxAndTransfer_LockupDynamic_Integration_Fuzz_Test:testFuzz_WithdrawMaxAndTransfer(uint256,address) (runs: 50, μ: 140673, ~: 156073)
-WithdrawMaxAndTransfer_LockupLinear_Integration_Concrete_Test:test_RevertGiven_NFTBurned() (gas: 75583)
-WithdrawMaxAndTransfer_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 14179)
-WithdrawMaxAndTransfer_LockupLinear_Integration_Concrete_Test:test_RevertGiven_StreamNotTransferable() (gas: 189290)
-WithdrawMaxAndTransfer_LockupLinear_Integration_Concrete_Test:test_WithdrawMaxAndTransfer() (gas: 111578)
-WithdrawMaxAndTransfer_LockupLinear_Integration_Concrete_Test:test_WithdrawMaxAndTransfer_WithdrawableAmountZero() (gas: 100775)
-WithdrawMaxAndTransfer_LockupLinear_Integration_Fuzz_Test:testFuzz_WithdrawMaxAndTransfer(uint256,address) (runs: 50, μ: 99101, ~: 109924)
-WithdrawMax_LockupDynamic_Integration_Concrete_Test:test_WithdrawMax() (gas: 135217)
-WithdrawMax_LockupDynamic_Integration_Concrete_Test:test_WithdrawMax_EndTimeNotInTheFuture() (gas: 80287)
-WithdrawMax_LockupDynamic_Integration_Fuzz_Test:testFuzz_WithdrawMax(uint256) (runs: 50, μ: 117564, ~: 120638)
-WithdrawMax_LockupDynamic_Integration_Fuzz_Test:testFuzz_WithdrawMax_EndTimeNotInTheFuture(uint256) (runs: 50, μ: 82928, ~: 83069)
-WithdrawMax_LockupLinear_Integration_Concrete_Test:test_WithdrawMax() (gas: 74491)
-WithdrawMax_LockupLinear_Integration_Concrete_Test:test_WithdrawMax_EndTimeNotInTheFuture() (gas: 80494)
-WithdrawMax_LockupLinear_Integration_Fuzz_Test:testFuzz_WithdrawMax(uint256) (runs: 50, μ: 73574, ~: 73703)
-WithdrawMax_LockupLinear_Integration_Fuzz_Test:testFuzz_WithdrawMax_EndTimeNotInTheFuture(uint256) (runs: 50, μ: 83080, ~: 83218)
-WithdrawMultiple_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_AllStatusesDepleted() (gas: 73894)
-WithdrawMultiple_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_OnlyNull() (gas: 21063)
-WithdrawMultiple_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_SomeNull() (gas: 124687)
-WithdrawMultiple_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_SomeStatusesDepleted() (gas: 83367)
-WithdrawMultiple_LockupDynamic_Integration_Concrete_Test:test_WithdrawMultiple() (gas: 1831194)
-WithdrawMultiple_LockupDynamic_Integration_Concrete_Test:test_WithdrawMultiple_ArrayCountsZero() (gas: 9109)
-WithdrawMultiple_LockupDynamic_Integration_Fuzz_Test:testFuzz_WithdrawMultiple(uint256,address,uint128) (runs: 50, μ: 2745706, ~: 2745970)
-WithdrawMultiple_LockupLinear_Integration_Concrete_Test:test_RevertGiven_AllStatusesDepleted() (gas: 74018)
-WithdrawMultiple_LockupLinear_Integration_Concrete_Test:test_RevertGiven_OnlyNull() (gas: 21020)
-WithdrawMultiple_LockupLinear_Integration_Concrete_Test:test_RevertGiven_SomeNull() (gas: 105130)
-WithdrawMultiple_LockupLinear_Integration_Concrete_Test:test_RevertGiven_SomeStatusesDepleted() (gas: 83491)
-WithdrawMultiple_LockupLinear_Integration_Concrete_Test:test_WithdrawMultiple() (gas: 1264004)
-WithdrawMultiple_LockupLinear_Integration_Concrete_Test:test_WithdrawMultiple_ArrayCountsZero() (gas: 9165)
-WithdrawMultiple_LockupLinear_Integration_Fuzz_Test:testFuzz_WithdrawMultiple(uint256,address,uint128) (runs: 50, μ: 1773592, ~: 1773439)
-Withdraw_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 19918)
-Withdraw_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_StreamDepleted() (gas: 67854)
-Withdraw_LockupDynamic_Integration_Concrete_Test:test_Withdraw() (gas: 385175)
-Withdraw_LockupDynamic_Integration_Concrete_Test:test_Withdraw_CallerApprovedOperator() (gas: 112713)
-Withdraw_LockupDynamic_Integration_Concrete_Test:test_Withdraw_CallerRecipient() (gas: 81272)
-Withdraw_LockupDynamic_Integration_Concrete_Test:test_Withdraw_EndTimeNotInTheFuture() (gas: 72502)
-Withdraw_LockupDynamic_Integration_Concrete_Test:test_Withdraw_RecipientDoesNotImplementHook() (gas: 362822)
-Withdraw_LockupDynamic_Integration_Concrete_Test:test_Withdraw_RecipientNotContract() (gas: 122683)
-Withdraw_LockupDynamic_Integration_Concrete_Test:test_Withdraw_RecipientReentrancy() (gas: 390163)
-Withdraw_LockupDynamic_Integration_Concrete_Test:test_Withdraw_RecipientReverts() (gas: 363377)
-Withdraw_LockupDynamic_Integration_Concrete_Test:test_Withdraw_StreamHasBeenCanceled() (gas: 382351)
-Withdraw_LockupDynamic_Integration_Fuzz_Test:testFuzz_Withdraw(uint256,address,uint128) (runs: 50, μ: 121478, ~: 98629)
-Withdraw_LockupDynamic_Integration_Fuzz_Test:testFuzz_Withdraw_CallerApprovedOperator(address) (runs: 50, μ: 145456, ~: 145456)
-Withdraw_LockupDynamic_Integration_Fuzz_Test:testFuzz_Withdraw_SegmentFuzing(((uint128,uint64,uint40)[],uint256,address)) (runs: 50, μ: 3965055, ~: 4005165)
-Withdraw_LockupDynamic_Integration_Fuzz_Test:testFuzz_Withdraw_StreamHasBeenCanceled(uint256,address,uint128) (runs: 50, μ: 160774, ~: 160963)
-Withdraw_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 19917)
-Withdraw_LockupLinear_Integration_Concrete_Test:test_RevertGiven_StreamDepleted() (gas: 68020)
-Withdraw_LockupLinear_Integration_Concrete_Test:test_Withdraw() (gas: 268395)
-Withdraw_LockupLinear_Integration_Concrete_Test:test_Withdraw_CallerApprovedOperator() (gas: 93092)
-Withdraw_LockupLinear_Integration_Concrete_Test:test_Withdraw_CallerRecipient() (gas: 61640)
-Withdraw_LockupLinear_Integration_Concrete_Test:test_Withdraw_EndTimeNotInTheFuture() (gas: 72719)
-Withdraw_LockupLinear_Integration_Concrete_Test:test_Withdraw_RecipientDoesNotImplementHook() (gas: 259694)
-Withdraw_LockupLinear_Integration_Concrete_Test:test_Withdraw_RecipientNotContract() (gas: 75746)
-Withdraw_LockupLinear_Integration_Concrete_Test:test_Withdraw_RecipientReentrancy() (gas: 273430)
-Withdraw_LockupLinear_Integration_Concrete_Test:test_Withdraw_RecipientReverts() (gas: 260249)
-Withdraw_LockupLinear_Integration_Concrete_Test:test_Withdraw_StreamHasBeenCanceled() (gas: 292858)
-Withdraw_LockupLinear_Integration_Fuzz_Test:testFuzz_Withdraw(uint256,address,uint128) (runs: 50, μ: 99389, ~: 99269)
-Withdraw_LockupLinear_Integration_Fuzz_Test:testFuzz_Withdraw_CallerApprovedOperator(address) (runs: 50, μ: 112211, ~: 112211)
-Withdraw_LockupLinear_Integration_Fuzz_Test:testFuzz_Withdraw_StreamHasBeenCanceled(uint256,address,uint128) (runs: 50, μ: 141114, ~: 141030)
-WithdrawableAmountOf_LockupDynamic_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 12045)
-WithdrawableAmountOf_LockupDynamic_Integration_Concrete_Test:test_WithdrawableAmountOf() (gas: 378164)
-WithdrawableAmountOf_LockupDynamic_Integration_Concrete_Test:test_WithdrawableAmountOf_NoPreviousWithdrawals() (gas: 347681)
-WithdrawableAmountOf_LockupDynamic_Integration_Concrete_Test:test_WithdrawableAmountOf_StartTimeInThePresent() (gas: 337258)
-WithdrawableAmountOf_LockupDynamic_Integration_Concrete_Test:test_WithdrawableAmountOf_StatusDepleted() (gas: 363782)
-WithdrawableAmountOf_LockupDynamic_Integration_Concrete_Test:test_WithdrawableAmountOf_StatusPending() (gas: 334007)
-WithdrawableAmountOf_LockupDynamic_Integration_Concrete_Test:test_WithdrawableAmountOf_StatusSettled() (gas: 340230)
-WithdrawableAmountOf_LockupDynamic_Integration_Concrete_Test:test_WithdrawableAmountOf_StreamHasBeenCanceled_StatusCanceled() (gas: 378537)
-WithdrawableAmountOf_LockupDynamic_Integration_Concrete_Test:test_WithdrawableAmountOf_StreamHasBeenCanceled_StatusDepleted() (gas: 400691)
-WithdrawableAmountOf_LockupDynamic_Integration_Fuzz_Test:testFuzz_WithdrawableAmountOf(uint40,uint128) (runs: 50, μ: 335154, ~: 352469)
-WithdrawableAmountOf_LockupDynamic_Integration_Fuzz_Test:testFuzz_WithdrawableAmountOf_NoPreviousWithdrawals(uint40) (runs: 50, μ: 298041, ~: 289776)
-WithdrawableAmountOf_LockupLinear_Integration_Concrete_Test:test_RevertGiven_Null() (gas: 12076)
-WithdrawableAmountOf_LockupLinear_Integration_Concrete_Test:test_WithdrawableAmountOf_CliffTimeInTheFuture() (gas: 253622)
-WithdrawableAmountOf_LockupLinear_Integration_Concrete_Test:test_WithdrawableAmountOf_NoPreviousWithdrawals() (gas: 263493)
-WithdrawableAmountOf_LockupLinear_Integration_Concrete_Test:test_WithdrawableAmountOf_StatusDepleted() (gas: 288666)
-WithdrawableAmountOf_LockupLinear_Integration_Concrete_Test:test_WithdrawableAmountOf_StatusPending() (gas: 258694)
-WithdrawableAmountOf_LockupLinear_Integration_Concrete_Test:test_WithdrawableAmountOf_StatusSettled() (gas: 265047)
-WithdrawableAmountOf_LockupLinear_Integration_Concrete_Test:test_WithdrawableAmountOf_StreamHasBeenCanceled_StatusCanceled() (gas: 300014)
-WithdrawableAmountOf_LockupLinear_Integration_Concrete_Test:test_WithdrawableAmountOf_StreamHasBeenCanceled_StatusDepleted() (gas: 322024)
-WithdrawableAmountOf_LockupLinear_Integration_Concrete_Test:test_WithdrawableAmountOf_WithWithdrawals() (gas: 287044)
-WithdrawableAmountOf_LockupLinear_Integration_Fuzz_Test:testFuzz_WithdrawableAmountOf(uint40,uint128,uint128) (runs: 50, μ: 463735, ~: 463093)
-WithdrawableAmountOf_LockupLinear_Integration_Fuzz_Test:testFuzz_WithdrawableAmountOf_CliffTimeInTheFuture(uint40) (runs: 50, μ: 263728, ~: 263963)
-WithdrawableAmountOf_LockupLinear_Integration_Fuzz_Test:testFuzz_WithdrawableAmountOf_NoPreviousWithdrawals(uint40,uint128) (runs: 50, μ: 440141, ~: 440973)
\ No newline at end of file
diff --git a/.gitattributes b/.gitattributes
deleted file mode 100644
index d5e5d2770..000000000
--- a/.gitattributes
+++ /dev/null
@@ -1 +0,0 @@
-lib/** linguist-vendored
diff --git a/.github/workflows/ci-deep.yml b/.github/workflows/ci-deep.yml
index 66f525ad6..16d942d5a 100644
--- a/.github/workflows/ci-deep.yml
+++ b/.github/workflows/ci-deep.yml
@@ -1,7 +1,6 @@
name: "CI Deep"
env:
- API_KEY_ETHERSCAN: ${{ secrets.API_KEY_ETHERSCAN }}
API_KEY_INFURA: ${{ secrets.API_KEY_INFURA }}
RPC_URL_MAINNET: ${{ secrets.RPC_URL_MAINNET }}
@@ -11,11 +10,11 @@ on:
workflow_dispatch:
inputs:
unitFuzzRuns:
- default: "100000"
+ default: "50000"
description: "Unit: number of fuzz runs."
required: false
integrationFuzzRuns:
- default: "100000"
+ default: "50000"
description: "Integration: number of fuzz runs."
required: false
invariantRuns:
@@ -33,204 +32,46 @@ on:
jobs:
lint:
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Install Pnpm"
- uses: "pnpm/action-setup@v2"
- with:
- version: "8"
-
- - name: "Install Node.js"
- uses: "actions/setup-node@v3"
- with:
- cache: "pnpm"
- node-version: "lts/*"
-
- - name: "Install the Node.js dependencies"
- run: "pnpm install"
-
- - name: "Lint the contracts"
- run: "pnpm lint"
-
- - name: "Add lint summary"
- run: |
- echo "## Lint result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+ uses: "sablier-labs/reusable-workflows/.github/workflows/forge-lint.yml@main"
build:
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Install Pnpm"
- uses: "pnpm/action-setup@v2"
- with:
- version: "8"
-
- - name: "Install Node.js"
- uses: "actions/setup-node@v3"
- with:
- cache: "pnpm"
- node-version: "lts/*"
-
- - name: "Install the Node.js dependencies"
- run: "pnpm install"
-
- - name: "Show the Foundry config"
- run: "forge config"
-
- - name: "Produce an optimized build with --via-ir"
- run: "FOUNDRY_PROFILE=optimized forge build"
-
- - name: "Build the test contracts"
- run: "FOUNDRY_PROFILE=test-optimized forge build"
-
- - name: "Cache the build and the node modules so that they can be re-used by the other jobs"
- uses: "actions/cache/save@v3"
- with:
- key: "build-and-modules-${{ github.sha }}"
- path: |
- cache
- node_modules
- out
- out-optimized
-
- - name: "Add build summary"
- run: |
- echo "## Build result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+ uses: "sablier-labs/reusable-workflows/.github/workflows/forge-build.yml@main"
test-unit:
- env:
- FOUNDRY_FUZZ_RUNS: ${{ inputs.unitFuzzRuns || '100000' }}
needs: ["lint", "build"]
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Restore the cached build and the node modules"
- uses: "actions/cache/restore@v3"
- with:
- fail-on-cache-miss: true
- key: "build-and-modules-${{ github.sha }}"
- path: |
- cache
- node_modules
- out
- out-optimized
-
- - name: "Run the unit tests against the optimized build"
- run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/unit\""
-
- - name: "Add test summary"
- run: |
- echo "## Unit tests result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+ uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+ with:
+ foundry-fuzz-runs: ${{ inputs.unitFuzzRuns || 50000 }}
+ foundry-profile: "test-optimized"
+ match-path: "test/unit/**/*.sol"
+ name: "Unit tests"
test-integration:
- env:
- FOUNDRY_FUZZ_RUNS: ${{ inputs.integrationFuzzRuns || '100000' }}
needs: ["lint", "build"]
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Restore the cached build and the node modules"
- uses: "actions/cache/restore@v3"
- with:
- fail-on-cache-miss: true
- key: "build-and-modules-${{ github.sha }}"
- path: |
- cache
- node_modules
- out
- out-optimized
-
- - name: "Run the integration tests against the optimized build"
- run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/integration/**/*.sol\""
-
- - name: "Add test summary"
- run: |
- echo "## Integration tests result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+ uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+ with:
+ foundry-fuzz-runs: ${{ inputs.integrationFuzzRuns || 50000 }}
+ foundry-profile: "test-optimized"
+ match-path: "test/integration/**/*.sol"
+ name: "Integration tests"
test-invariant:
- env:
- FOUNDRY_INVARIANT_DEPTH: ${{ inputs.invariantDepth || '100' }}
- FOUNDRY_INVARIANT_RUNS: ${{ inputs.invariantRuns || '100' }}
needs: ["lint", "build"]
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Restore the cached build and the node modules"
- uses: "actions/cache/restore@v3"
- with:
- fail-on-cache-miss: true
- key: "build-and-modules-${{ github.sha }}"
- path: |
- cache
- node_modules
- out
- out-optimized
-
- - name: "Run the invariant tests against the optimized build"
- run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/invariant/**/*.sol\""
-
- - name: "Add test summary"
- run: |
- echo "## Invariant tests result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+ uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+ with:
+ foundry-invariant-depth: ${{ inputs.invariantDepth || 100 }}
+ foundry-invariant-runs: ${{ inputs.invariantRuns || 100 }}
+ foundry-profile: "test-optimized"
+ match-path: "test/invariant/**/*.sol"
+ name: "Invariant tests"
test-fork:
- env:
- FOUNDRY_FUZZ_RUNS: ${{ inputs.forkFuzzRuns || '1000' }}
needs: ["lint", "build"]
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Restore the cached build and the node modules"
- uses: "actions/cache/restore@v3"
- with:
- fail-on-cache-miss: true
- key: "build-and-modules-${{ github.sha }}"
- path: |
- cache
- node_modules
- out
- out-optimized
-
- - name: "Run the fork tests against the optimized build"
- run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/fork/**/*.sol\""
-
- - name: "Add test summary"
- run: |
- echo "## Fork tests result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+ secrets:
+ RPC_URL_MAINNET: ${{ secrets.RPC_URL_MAINNET }}
+ uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+ with:
+ foundry-fuzz-runs: ${{ inputs.forkFuzzRuns || 1000 }}
+ foundry-profile: "test-optimized"
+ match-path: "test/fork/**/*.sol"
+ name: "Fork tests"
diff --git a/.github/workflows/ci-fork.yml b/.github/workflows/ci-fork.yml
new file mode 100644
index 000000000..1de1165e0
--- /dev/null
+++ b/.github/workflows/ci-fork.yml
@@ -0,0 +1,32 @@
+name: "CI Fork and Util tests"
+
+on:
+ schedule:
+ - cron: "0 3 * * 1,3,5" # at 3:00 AM UTC on Monday, Wednesday and Friday
+
+jobs:
+ lint:
+ uses: "sablier-labs/reusable-workflows/.github/workflows/forge-lint.yml@main"
+
+ build:
+ uses: "sablier-labs/reusable-workflows/.github/workflows/forge-build.yml@main"
+
+ test-fork:
+ needs: ["lint", "build"]
+ secrets:
+ RPC_URL_MAINNET: ${{ secrets.RPC_URL_MAINNET }}
+ uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+ with:
+ foundry-fuzz-runs: 100
+ foundry-profile: "test-optimized"
+ fuzz-seed: true
+ match-path: "test/fork/**/*.sol"
+ name: "Fork tests"
+
+ test-utils:
+ needs: ["lint", "build"]
+ uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+ with:
+ foundry-profile: "test-optimized"
+ match-path: "test/utils/**/*.sol"
+ name: "Utils tests"
diff --git a/.github/workflows/ci-slither.yml b/.github/workflows/ci-slither.yml
index d2e2f57d5..aef1c9066 100644
--- a/.github/workflows/ci-slither.yml
+++ b/.github/workflows/ci-slither.yml
@@ -1,83 +1,12 @@
name: "CI Slither"
-env:
- API_KEY_ETHERSCAN: ${{ secrets.API_KEY_ETHERSCAN }}
- API_KEY_INFURA: ${{ secrets.API_KEY_INFURA }}
- RPC_URL_MAINNET: ${{ secrets.RPC_URL_MAINNET }}
-
on:
schedule:
- cron: "0 3 * * 0" # at 3:00am UTC every Sunday
jobs:
lint:
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Install Pnpm"
- uses: "pnpm/action-setup@v2"
- with:
- version: "8"
-
- - name: "Install Node.js"
- uses: "actions/setup-node@v3"
- with:
- cache: "pnpm"
- node-version: "lts/*"
-
- - name: "Install the Node.js dependencies"
- run: "pnpm install"
-
- - name: "Lint the contracts"
- run: "pnpm lint"
-
- - name: "Add lint summary"
- run: |
- echo "## Lint result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+ uses: "sablier-labs/reusable-workflows/.github/workflows/forge-lint.yml@main"
slither-analyze:
- runs-on: "ubuntu-latest"
- permissions:
- actions: "read"
- contents: "read"
- security-events: "write"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
-
- - name: "Install Pnpm"
- uses: "pnpm/action-setup@v2"
- with:
- version: "8"
-
- - name: "Install Node.js"
- uses: "actions/setup-node@v3"
- with:
- cache: "pnpm"
- node-version: "lts/*"
-
- - name: "Install the Node.js dependencies"
- run: "pnpm install"
-
- - name: "Run Slither analysis"
- uses: "crytic/slither-action@v0.3.0"
- id: "slither"
- with:
- fail-on: "none"
- sarif: "results.sarif"
-
- - name: "Upload SARIF file to GitHub code scanning"
- uses: "github/codeql-action/upload-sarif@v2"
- with:
- sarif_file: ${{ steps.slither.outputs.sarif }}
-
- - name: "Add Slither summary"
- run: |
- echo "## Slither result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Uploaded to GitHub code scanning" >> $GITHUB_STEP_SUMMARY
+ uses: "sablier-labs/reusable-workflows/.github/workflows/slither-analyze.yml@main"
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 2c424484e..4d1e4703c 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -4,298 +4,63 @@ concurrency:
cancel-in-progress: true
group: ${{github.workflow}}-${{github.ref}}
-env:
- API_KEY_ETHERSCAN: ${{ secrets.API_KEY_ETHERSCAN }}
- API_KEY_INFURA: ${{ secrets.API_KEY_INFURA }}
- RPC_URL_MAINNET: ${{ secrets.RPC_URL_MAINNET }}
-
on:
workflow_dispatch:
pull_request:
push:
branches:
- "main"
+ - "staging"
+ - "staging-blast"
jobs:
lint:
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Install Pnpm"
- uses: "pnpm/action-setup@v2"
- with:
- version: "8"
-
- - name: "Install Node.js"
- uses: "actions/setup-node@v3"
- with:
- cache: "pnpm"
- node-version: "lts/*"
-
- - name: "Install the Node.js dependencies"
- run: "pnpm install"
-
- - name: "Lint the contracts"
- run: "pnpm lint"
-
- - name: "Add lint summary"
- run: |
- echo "## Lint result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+ uses: "sablier-labs/reusable-workflows/.github/workflows/forge-lint.yml@main"
build:
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Install Pnpm"
- uses: "pnpm/action-setup@v2"
- with:
- version: "8"
-
- - name: "Install Node.js"
- uses: "actions/setup-node@v3"
- with:
- cache: "pnpm"
- node-version: "lts/*"
-
- - name: "Install the Node.js dependencies"
- run: "pnpm install"
-
- - name: "Show the Foundry config"
- run: "forge config"
-
- - name: "Generate and prepare the contract artifacts"
- run: "./shell/prepare-artifacts.sh"
-
- - name: "Build the test contracts"
- run: "FOUNDRY_PROFILE=test-optimized forge build"
-
- - name: "Cache the build and the node modules so that they can be re-used by the other jobs"
- uses: "actions/cache/save@v3"
- with:
- key: "build-and-modules-${{ github.sha }}"
- path: |
- cache
- node_modules
- out
- out-optimized
-
- - name: "Store the contract artifacts in CI"
- uses: "actions/upload-artifact@v3"
- with:
- name: "contract-artifacts"
- path: "artifacts"
- - name: "Add build summary"
- run: |
- echo "## Build result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+ uses: "sablier-labs/reusable-workflows/.github/workflows/forge-build.yml@main"
test-unit:
needs: ["lint", "build"]
- env:
- FOUNDRY_FUZZ_RUNS: "5000"
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Install Pnpm"
- uses: "pnpm/action-setup@v2"
- with:
- version: "8"
-
- - name: "Install Node.js"
- uses: "actions/setup-node@v3"
- with:
- cache: "pnpm"
- node-version: "lts/*"
-
- - name: "Restore the cached build and the node modules"
- uses: "actions/cache/restore@v3"
- with:
- fail-on-cache-miss: true
- key: "build-and-modules-${{ github.sha }}"
- path: |
- cache
- node_modules
- out
- out-optimized
-
- - name: "Run the unit tests against the optimized build"
- run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/unit/**/*.sol\""
-
- - name: "Add test summary"
- run: |
- echo "## Unit tests result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+ uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+ with:
+ foundry-fuzz-runs: 5000
+ foundry-profile: "test-optimized"
+ match-path: "test/unit/**/*.sol"
+ name: "Unit tests"
test-integration:
needs: ["lint", "build"]
- env:
- FOUNDRY_FUZZ_RUNS: "5000"
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Restore the cached build and the node modules"
- uses: "actions/cache/restore@v3"
- with:
- fail-on-cache-miss: true
- key: "build-and-modules-${{ github.sha }}"
- path: |
- cache
- node_modules
- out
- out-optimized
-
- - name: "Run the integration tests against the optimized build"
- run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/integration/**/*.sol\""
-
- - name: "Add test summary"
- run: |
- echo "## Integration tests result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
-
- test-utils:
- needs: ["lint", "build"]
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Restore the cached build and the node modules"
- uses: "actions/cache/restore@v3"
- with:
- fail-on-cache-miss: true
- key: "build-and-modules-${{ github.sha }}"
- path: |
- cache
- node_modules
- out
- out-optimized
-
- - name: "Run the utils tests against the optimized build"
- run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/utils/**/*.sol\""
-
- - name: "Add test summary"
- run: |
- echo "## Utils tests result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+ uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+ with:
+ foundry-fuzz-runs: 5000
+ foundry-profile: "test-optimized"
+ match-path: "test/integration/**/*.sol"
+ name: "Integration tests"
test-invariant:
needs: ["lint", "build"]
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Restore the cached build and the node modules"
- uses: "actions/cache/restore@v3"
- with:
- fail-on-cache-miss: true
- key: "build-and-modules-${{ github.sha }}"
- path: |
- cache
- node_modules
- out
- out-optimized
-
- - name: "Run the invariant tests against the optimized build"
- run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/invariant/**/*.sol\""
-
- - name: "Add test summary"
- run: |
- echo "## Invariant tests result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+ uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+ with:
+ foundry-profile: "test-optimized"
+ match-path: "test/invariant/**/*.sol"
+ name: "Invariant tests"
test-fork:
needs: ["lint", "build"]
- env:
- FOUNDRY_FUZZ_RUNS: "100"
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Restore the cached build and the node modules"
- uses: "actions/cache/restore@v3"
- with:
- fail-on-cache-miss: true
- key: "build-and-modules-${{ github.sha }}"
- path: |
- cache
- node_modules
- out
- out-optimized
-
- - name: "Generate fuzz seed that changes weekly to avoid burning through RPC allowance"
- run: |
- echo "FOUNDRY_FUZZ_SEED=$(echo $(($EPOCHSECONDS / 604800)))" >> $GITHUB_ENV
-
- - name: "Run the fork tests against the optimized build"
- run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/fork/**/*.sol\""
-
- - name: "Add test summary"
- run: |
- echo "## Fork tests result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+ secrets:
+ RPC_URL_MAINNET: ${{ secrets.RPC_URL_MAINNET }}
+ uses: "sablier-labs/reusable-workflows/.github/workflows/forge-test.yml@main"
+ with:
+ foundry-fuzz-runs: 20
+ foundry-profile: "test-optimized"
+ match-path: "test/fork/**/*.sol"
+ name: "Fork tests"
coverage:
needs: ["lint", "build"]
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Restore the cached build and the node modules"
- uses: "actions/cache/restore@v3"
- with:
- fail-on-cache-miss: true
- key: "build-and-modules-${{ github.sha }}"
- path: |
- cache
- node_modules
- out
- out-optimized
-
- - name: "Generate the coverage report using the unit and the integration tests"
- run: "forge coverage --match-path \"test/{unit,integration}/**/*.sol\" --report lcov"
-
- - name: "Upload coverage report to Codecov"
- uses: "codecov/codecov-action@v3"
- with:
- files: "./lcov.info"
-
- - name: "Add coverage summary"
- run: |
- echo "## Coverage result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Uploaded to Codecov" >> $GITHUB_STEP_SUMMARY
+ secrets:
+ CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+ uses: "sablier-labs/reusable-workflows/.github/workflows/forge-coverage.yml@main"
+ with:
+ match-path: "test/{integration,unit}/**/*.sol"
diff --git a/.github/workflows/deploy-comptroller.yml b/.github/workflows/deploy-comptroller.yml
deleted file mode 100644
index 03eff8a05..000000000
--- a/.github/workflows/deploy-comptroller.yml
+++ /dev/null
@@ -1,52 +0,0 @@
-name: "Deploy Comptroller"
-
-env:
- API_KEY_ARBISCAN: ${{ secrets.API_KEY_ARBISCAN }}
- API_KEY_BSCSCAN: ${{ secrets.API_KEY_BSCSCAN }}
- API_KEY_ETHERSCAN: ${{ secrets.API_KEY_ETHERSCAN }}
- API_KEY_GNOSISSCAN: ${{ secrets.API_KEY_GNOSISSCAN }}
- API_KEY_INFURA: ${{ secrets.API_KEY_INFURA }}
- API_KEY_OPTIMISTIC_ETHERSCAN: ${{ secrets.API_KEY_OPTIMISTIC_ETHERSCAN }}
- API_KEY_POLYGONSCAN: ${{ secrets.API_KEY_POLYGONSCAN }}
- API_KEY_SNOWTRACE: ${{ secrets.API_KEY_SNOWTRACE }}
- FOUNDRY_PROFILE: "optimized"
- MNEMONIC: ${{ secrets.MNEMONIC }}
-
-on:
- workflow_dispatch:
- inputs:
- admin:
- default: "0xF3663da48030b6c88535413Fd643aB0B5F3496ff"
- description: "Initial contract admin."
- required: false
- chain:
- default: "sepolia"
- description: "Chain name as defined in the Foundry config."
- required: false
-
-jobs:
- deploy-comptroller:
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
- with:
- submodules: "recursive"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Deploy the SablierV2Comptroller contract"
- run: >-
- forge script script/DeployComptroller.s.sol
- --broadcast
- --rpc-url "${{ inputs.chain }}"
- --sig "run(address)"
- --verify
- -vvvv
- "${{ inputs.admin }}"
-
- - name: "Add workflow summary"
- run: |
- echo "## Result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Done" >> $GITHUB_STEP_SUMMARY
diff --git a/.github/workflows/deploy-core.yml b/.github/workflows/deploy-core.yml
deleted file mode 100644
index 24159ddd5..000000000
--- a/.github/workflows/deploy-core.yml
+++ /dev/null
@@ -1,57 +0,0 @@
-name: "Deploy Core"
-
-env:
- API_KEY_ARBISCAN: ${{ secrets.API_KEY_ARBISCAN }}
- API_KEY_BSCSCAN: ${{ secrets.API_KEY_BSCSCAN }}
- API_KEY_ETHERSCAN: ${{ secrets.API_KEY_ETHERSCAN }}
- API_KEY_GNOSISSCAN: ${{ secrets.API_KEY_GNOSISSCAN }}
- API_KEY_INFURA: ${{ secrets.API_KEY_INFURA }}
- API_KEY_OPTIMISTIC_ETHERSCAN: ${{ secrets.API_KEY_OPTIMISTIC_ETHERSCAN }}
- API_KEY_POLYGONSCAN: ${{ secrets.API_KEY_POLYGONSCAN }}
- API_KEY_SNOWTRACE: ${{ secrets.API_KEY_SNOWTRACE }}
- FOUNDRY_PROFILE: "optimized"
- MNEMONIC: ${{ secrets.MNEMONIC }}
-
-on:
- workflow_dispatch:
- inputs:
- admin:
- default: "0xF3663da48030b6c88535413Fd643aB0B5F3496ff"
- description: "Initial protocol admin."
- required: false
- chain:
- default: "sepolia"
- description: "Chain name as defined in the Foundry config."
- required: false
- max-segment-count:
- default: "300"
- description: "Maximum number of segments allowed in a stream."
- required: false
-
-jobs:
- deploy-core:
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
- with:
- submodules: "recursive"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Deploy the Sablier V2 Core protocol"
- run: >-
- forge script script/DeployCore.s.sol
- --broadcast
- --rpc-url "${{ inputs.chain }}"
- --sig "run(address,uint256)"
- --verify
- "${{ inputs.admin }}"
- "${{ inputs.max-segment-count }}"
- -vvvv
-
- - name: "Add workflow summary"
- run: |
- echo "## Result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Done" >> $GITHUB_STEP_SUMMARY
diff --git a/.github/workflows/deploy-lockup-dynamic.yml b/.github/workflows/deploy-lockup-dynamic.yml
deleted file mode 100644
index f2d7c72a5..000000000
--- a/.github/workflows/deploy-lockup-dynamic.yml
+++ /dev/null
@@ -1,65 +0,0 @@
-name: "Deploy Lockup Dynamic"
-
-env:
- API_KEY_ARBISCAN: ${{ secrets.API_KEY_ARBISCAN }}
- API_KEY_BSCSCAN: ${{ secrets.API_KEY_BSCSCAN }}
- API_KEY_ETHERSCAN: ${{ secrets.API_KEY_ETHERSCAN }}
- API_KEY_GNOSISSCAN: ${{ secrets.API_KEY_GNOSISSCAN }}
- API_KEY_INFURA: ${{ secrets.API_KEY_INFURA }}
- API_KEY_OPTIMISTIC_ETHERSCAN: ${{ secrets.API_KEY_OPTIMISTIC_ETHERSCAN }}
- API_KEY_POLYGONSCAN: ${{ secrets.API_KEY_POLYGONSCAN }}
- API_KEY_SNOWTRACE: ${{ secrets.API_KEY_SNOWTRACE }}
- FOUNDRY_PROFILE: "optimized"
- MNEMONIC: ${{ secrets.MNEMONIC }}
-
-on:
- workflow_dispatch:
- inputs:
- admin:
- default: "0xF3663da48030b6c88535413Fd643aB0B5F3496ff"
- description: "Initial contract admin."
- required: false
- chain:
- default: "sepolia"
- description: "Chain name as defined in the Foundry config."
- required: false
- comptroller:
- description: "Address of an already deployed comptroller."
- required: true
- nft-descriptor:
- description: "Address of an NFT descriptor contract."
- required: true
- max-segment-count:
- default: "300"
- description: "Maximum number of segments allowed in a stream."
- required: false
-
-jobs:
- deploy-lockup-dynamic:
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
- with:
- submodules: "recursive"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Deploy the SablierV2LockupDynamic contract"
- run: >-
- forge script script/DeployLockupDynamic.s.sol
- --broadcast
- --rpc-url "${{ inputs.chain }}"
- --sig "run(address,address,address,uint256)"
- --verify
- "${{ inputs.admin }}"
- "${{ inputs.comptroller }}"
- "${{ inputs.nft-descriptor }}"
- "${{ inputs.max-segment-count }}"
- -vvvv
-
- - name: "Add workflow summary"
- run: |
- echo "## Result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Done" >> $GITHUB_STEP_SUMMARY
diff --git a/.github/workflows/deploy-lockup-linear.yml b/.github/workflows/deploy-lockup-linear.yml
deleted file mode 100644
index 9d51e5855..000000000
--- a/.github/workflows/deploy-lockup-linear.yml
+++ /dev/null
@@ -1,60 +0,0 @@
-name: "Deploy Lockup Linear"
-
-env:
- API_KEY_ARBISCAN: ${{ secrets.API_KEY_ARBISCAN }}
- API_KEY_BSCSCAN: ${{ secrets.API_KEY_BSCSCAN }}
- API_KEY_ETHERSCAN: ${{ secrets.API_KEY_ETHERSCAN }}
- API_KEY_GNOSISSCAN: ${{ secrets.API_KEY_GNOSISSCAN }}
- API_KEY_INFURA: ${{ secrets.API_KEY_INFURA }}
- API_KEY_OPTIMISTIC_ETHERSCAN: ${{ secrets.API_KEY_OPTIMISTIC_ETHERSCAN }}
- API_KEY_POLYGONSCAN: ${{ secrets.API_KEY_POLYGONSCAN }}
- API_KEY_SNOWTRACE: ${{ secrets.API_KEY_SNOWTRACE }}
- FOUNDRY_PROFILE: "optimized"
- MNEMONIC: ${{ secrets.MNEMONIC }}
-
-on:
- workflow_dispatch:
- inputs:
- admin:
- default: "0xF3663da48030b6c88535413Fd643aB0B5F3496ff"
- description: "Initial contract admin."
- required: false
- chain:
- default: "sepolia"
- description: "Chain name as defined in the Foundry config."
- required: false
- comptroller:
- description: "Address of an already deployed comptroller."
- required: true
- nft-descriptor:
- description: "Address of an NFT descriptor contract."
- required: true
-
-jobs:
- deploy-lockup-linear:
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
- with:
- submodules: "recursive"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Deploy the SablierV2LockupLinear contract"
- run: >-
- forge script script/DeployLockupLinear.s.sol
- --broadcast
- --rpc-url ${{ inputs.chain }}
- --sig "run(address,address,address)"
- --verify
- "${{ inputs.admin }}"
- "${{ inputs.comptroller }}"
- "${{ inputs.nft-descriptor }}"
- -vvvv
-
- - name: "Add workflow summary"
- run: |
- echo "## Result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Done" >> $GITHUB_STEP_SUMMARY
diff --git a/.github/workflows/deploy-nft-descriptor.yml b/.github/workflows/deploy-nft-descriptor.yml
deleted file mode 100644
index ef5ee19f4..000000000
--- a/.github/workflows/deploy-nft-descriptor.yml
+++ /dev/null
@@ -1,46 +0,0 @@
-name: "Deploy NFT Descriptor"
-
-env:
- API_KEY_ARBISCAN: ${{ secrets.API_KEY_ARBISCAN }}
- API_KEY_BSCSCAN: ${{ secrets.API_KEY_BSCSCAN }}
- API_KEY_ETHERSCAN: ${{ secrets.API_KEY_ETHERSCAN }}
- API_KEY_GNOSISSCAN: ${{ secrets.API_KEY_GNOSISSCAN }}
- API_KEY_INFURA: ${{ secrets.API_KEY_INFURA }}
- API_KEY_OPTIMISTIC_ETHERSCAN: ${{ secrets.API_KEY_OPTIMISTIC_ETHERSCAN }}
- API_KEY_POLYGONSCAN: ${{ secrets.API_KEY_POLYGONSCAN }}
- API_KEY_SNOWTRACE: ${{ secrets.API_KEY_SNOWTRACE }}
- FOUNDRY_PROFILE: "optimized"
- MNEMONIC: ${{ secrets.MNEMONIC }}
-
-on:
- workflow_dispatch:
- inputs:
- chain:
- default: "sepolia"
- description: "Chain name as defined in the Foundry config."
- required: false
-
-jobs:
- deploy-nft-descriptor:
- runs-on: "ubuntu-latest"
- steps:
- - name: "Check out the repo"
- uses: "actions/checkout@v3"
- with:
- submodules: "recursive"
-
- - name: "Install Foundry"
- uses: "foundry-rs/foundry-toolchain@v1"
-
- - name: "Deploy the NFT Descriptor"
- run: >-
- forge script script/DeployNFTDescriptor.s.sol
- --broadcast
- --rpc-url "${{ inputs.chain }}"
- --verify
- -vvvv
-
- - name: "Add workflow summary"
- run: |
- echo "## Result" >> $GITHUB_STEP_SUMMARY
- echo "✅ Done" >> $GITHUB_STEP_SUMMARY
diff --git a/.github/workflows/generate-svg.yml b/.github/workflows/generate-svg.yml
index f97355082..6c2f0d0c9 100644
--- a/.github/workflows/generate-svg.yml
+++ b/.github/workflows/generate-svg.yml
@@ -21,10 +21,7 @@ jobs:
runs-on: "ubuntu-latest"
steps:
- name: "Check out the repo"
- uses: "actions/checkout@v3"
- with:
- submodules: "recursive"
- token: ${{ secrets.CI_TOKEN }}
+ uses: "actions/checkout@v4"
- name: "Install Foundry"
uses: "foundry-rs/foundry-toolchain@v1"
diff --git a/.github/workflows/multibuild.yml b/.github/workflows/multibuild.yml
new file mode 100644
index 000000000..bd42ec6f0
--- /dev/null
+++ b/.github/workflows/multibuild.yml
@@ -0,0 +1,26 @@
+name: "Multibuild"
+
+on:
+ workflow_dispatch:
+ schedule:
+ - cron: "0 3 * * 0" # at 3:00am UTC every Sunday
+
+jobs:
+ multibuild:
+ runs-on: "ubuntu-latest"
+ steps:
+ - name: "Check out the repo"
+ uses: "actions/checkout@v4"
+
+ - name: "Install Bun"
+ uses: "oven-sh/setup-bun@v1"
+
+ - name: "Install the Node.js dependencies"
+ run: "bun install --frozen-lockfile"
+
+ - name: "Check that the project can be built with multiple Solidity versions"
+ uses: "PaulRBerg/foundry-multibuild@v1"
+ with:
+ min: "0.8.22"
+ max: "0.8.26"
+ skip-test: "true"
diff --git a/.github/workflows/run-smtchecker.yml b/.github/workflows/run-smtchecker.yml
index a6aaa12bb..9df7b5718 100644
--- a/.github/workflows/run-smtchecker.yml
+++ b/.github/workflows/run-smtchecker.yml
@@ -7,9 +7,7 @@ jobs:
runs-on: "macos-latest"
steps:
- name: "Check out the repo"
- uses: "actions/checkout@v3"
- with:
- submodules: "recursive"
+ uses: "actions/checkout@v4"
- name: "Install Foundry"
uses: "foundry-rs/foundry-toolchain@v1"
@@ -18,7 +16,7 @@ jobs:
run: "FOUNDRY_PROFILE=smt forge build > smtchecker-report.txt"
- name: "Store the report as an artifact"
- uses: "actions/upload-artifact@v3"
+ uses: "actions/upload-artifact@v4"
with:
name: smtchecker-report
path: "smtchecker-report.txt"
diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
new file mode 100644
index 000000000..a717e9753
--- /dev/null
+++ b/.github/workflows/stale.yml
@@ -0,0 +1,10 @@
+name: "Close stale issues and PRs"
+
+on:
+ workflow_dispatch:
+ schedule:
+ - cron: "0 3 * * 0" # at 3:00am UTC every Sunday
+
+jobs:
+ stale:
+ uses: "sablier-labs/reusable-workflows/.github/workflows/stale.yml@main"
diff --git a/.gitignore b/.gitignore
index 9d4d1426a..7a74302fe 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,6 +3,7 @@ artifacts
broadcast
cache
coverage
+deployments
docs
node_modules
out
@@ -11,9 +12,11 @@ out-svg
# files
*.env
+*.env.deployment
*.log
.DS_Store
.pnp.*
lcov.info
package-lock.json
+pnpm-lock.yaml
yarn.lock
diff --git a/.prettierignore b/.prettierignore
index b3ec58260..0fba7f6e2 100644
--- a/.prettierignore
+++ b/.prettierignore
@@ -4,7 +4,6 @@ broadcast
cache
coverage
docs
-lib
node_modules
out
out-optimized
@@ -16,6 +15,7 @@ out-svg
*.sol
.DS_Store
.pnp.*
+bun.lockb
lcov.info
package-lock.json
pnpm-lock.yaml
diff --git a/.solhint.json b/.solhint.json
index 31a4d5b8c..d9bf4b91a 100644
--- a/.solhint.json
+++ b/.solhint.json
@@ -3,13 +3,13 @@
"rules": {
"avoid-low-level-calls": "off",
"code-complexity": ["error", 9],
- "compiler-version": ["error", ">=0.8.19"],
+ "compiler-version": ["error", ">=0.8.22"],
"contract-name-camelcase": "off",
"const-name-snakecase": "off",
- "custom-errors": "off",
"func-name-mixedcase": "off",
"func-visibility": ["error", { "ignoreConstructors": true }],
- "max-line-length": ["error", 123],
+ "gas-custom-errors": "off",
+ "max-line-length": ["error", 124],
"named-parameters-mapping": "warn",
"no-empty-blocks": "off",
"not-rely-on-time": "off",
diff --git a/.vscode/settings.json b/.vscode/settings.json
index be6b5a15e..436b490ae 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -9,11 +9,9 @@
".gas-snapshot": "julia"
},
"editor.formatOnSave": true,
- "npm.exclude": "**/lib/**",
"prettier.documentSelectors": ["**/*.svg"],
"search.exclude": {
- "**/node_modules": true,
- "lib": true
+ "**/node_modules": true
},
"solidity.formatter": "forge"
}
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 4513f1a16..fb01c70e6 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Common Changelog](https://common-changelog.org/).
+[1.2.0]: https://github.com/sablier-labs/v2-core/compare/v1.1.2...v1.2.0
[1.1.2]: https://github.com/sablier-labs/v2-core/compare/v1.1.1...v1.1.2
[1.1.1]: https://github.com/sablier-labs/v2-core/compare/v1.1.0...v1.1.1
[1.1.0]: https://github.com/sablier-labs/v2-core/compare/v1.0.2...v1.1.0
@@ -11,11 +12,47 @@ The format is based on [Common Changelog](https://common-changelog.org/).
[1.0.1]: https://github.com/sablier-labs/v2-core/compare/v1.0.0...v1.0.1
[1.0.0]: https://github.com/sablier-labs/v2-core/releases/tag/v1.0.0
+## [1.2.0] - 2024-07-04
+
+### Changed
+
+- **Breaking:** move common logic into `Lockup` contract ([#784](https://github.com/sablier-labs/v2-core/pull/784),
+ [#813](https://github.com/sablier-labs/v2-core/pull/813), [#850](https://github.com/sablier-labs/v2-core/pull/850),
+ [#941](https://github.com/sablier-labs/v2-core/pull/941))
+- **Breaking:** use a new hook system ([#951](https://github.com/sablier-labs/v2-core/pull/951))
+ - Replace `ISablierV2Recipient` with `ISablierLockupRecipient` hook interface
+ - Remove `try..catch` block from hook calls
+- Allow only supported characters in NFT Descriptor asset symbols
+ ([#945](https://github.com/sablier-labs/v2-core/pull/945), [#960](https://github.com/sablier-labs/v2-core/pull/960),
+ [#949](https://github.com/sablier-labs/v2-core/pull/949))
+- Bump build dependencies ([#806](https://github.com/sablier-labs/v2-core/pull/806),
+ [#942](https://github.com/sablier-labs/v2-core/pull/942), [#944](https://github.com/sablier-labs/v2-core/pull/944))
+- Change permissions of `withdraw` function to public ([#785](https://github.com/sablier-labs/v2-core/pull/785))
+- Disallow zero `startTime` ([#813](https://github.com/sablier-labs/v2-core/pull/813),
+ [#852](https://github.com/sablier-labs/v2-core/pull/852))
+- Rename create functions `createWithTimestamps` and `createWithDurations` across all lockup contracts
+ ([#798](https://github.com/sablier-labs/v2-core/pull/798))
+- Switch to Bun ([#775](https://github.com/sablier-labs/v2-core/pull/775))
+- Use Solidity v0.8.26 ([#944](https://github.com/sablier-labs/v2-core/pull/944))
+
+### Added
+
+- Add Lockup Tranched contract ([#817](https://github.com/sablier-labs/v2-core/pull/817))
+- Add `precompiles` in the NPM release ([#841](https://github.com/sablier-labs/v2-core/pull/841))
+- Add return value in `withdrawMax` and `withdrawMaxAndTransfer`
+ ([#961](https://github.com/sablier-labs/v2-core/pull/961))
+
+### Removed
+
+- **Breaking:** remove protocol fee ([#839](https://github.com/sablier-labs/v2-core/pull/839))
+- Remove flash loan abstract contract ([#779](https://github.com/sablier-labs/v2-core/pull/779))
+- Remove `to` from `withdrawMultiple` function ([#785](https://github.com/sablier-labs/v2-core/pull/785))
+
## [1.1.2] - 2023-12-19
### Changed
-- Upgrade Solidity to `0.8.23` ([#758](https://github.com/sablier-labs/v2-core/pull/758))
+- Use Solidity v0.8.23 ([#758](https://github.com/sablier-labs/v2-core/pull/758))
## [1.1.1] - 2023-12-16
@@ -35,7 +72,7 @@ The format is based on [Common Changelog](https://common-changelog.org/).
- Simplify `renounce` and `withdraw` implementations ([#683](https://github.com/sablier-labs/v2-core/pull/683),
[#705](https://github.com/sablier-labs/v2-core/pull/705))
- Update import paths to use Node.js dependencies ([#734](https://github.com/sablier-labs/v2-core/pull/734))
-- Upgrade Solidity to `0.8.21` ([#688](https://github.com/sablier-labs/v2-core/pull/688))
+- Use Solidity v0.8.21 ([#688](https://github.com/sablier-labs/v2-core/pull/688))
### Added
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1f7ea57fc..3f0810fa5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -14,7 +14,7 @@ You will need the following software on your machine:
- [Git](https://git-scm.com/downloads)
- [Foundry](https://github.com/foundry-rs/foundry)
- [Node.Js](https://nodejs.org/en/download/)
-- [Pnpm](https://pnpm.io/)
+- [Bun](https://bun.sh/)
In addition, familiarity with [Solidity](https://soliditylang.org/) is requisite.
@@ -26,14 +26,21 @@ Clone this repository including submodules:
$ git clone --recurse-submodules -j8 git@github.com:sablier-labs/v2-core.git
```
-Then, inside the project's directory, run this to install the Node.js dependencies:
+Then, inside the project's directory, run this to install the Node.js dependencies and build the contracts:
```shell
-$ pnpm install
+$ bun install
+$ bun run build
```
Now you can start making changes.
+To see a list of all available scripts:
+
+```shell
+$ bun run
+```
+
## Pull Requests
When making a pull request, ensure that:
@@ -48,7 +55,6 @@ When making a pull request, ensure that:
- Gas snapshots are provided and demonstrate an improvement (or an acceptable deficit given other improvements).
- Reference contracts are modified correspondingly if relevant.
- New tests are included for all new features or code paths.
-- If making a modification to third-party Node.js dependencies, `pnpm audit` passes.
- A descriptive summary of the PR has been provided.
## Environment Variables
@@ -63,7 +69,6 @@ populate it with the appropriate environment values. You need to provide your mn
To make CI work in your pull request, ensure that the necessary environment variables are configured in your forked
repository's secrets. Please add the following variables in your GitHub Secrets:
-- API_KEY_ETHERSCAN
- API_KEY_INFURA
- RPC_URL_MAINNET
diff --git a/LICENSE.md b/LICENSE.md
index be1df6c0a..f89bb709d 100644
--- a/LICENSE.md
+++ b/LICENSE.md
@@ -9,11 +9,11 @@ Parameters
Licensor: Sablier Labs Ltd
-Licensed Work: Sablier V2 Core The Licensed Work is (C) 2023 Sablier Labs Ltd
+Licensed Work: Sablier V2 Core The Licensed Work is (C) 2024 Sablier Labs Ltd
Additional Use Grant: Any uses listed and defined at v2-core-license-grants.sablier.eth
-Change Date: The earlier of 2027-07-01 or a date specified at v2-core-license-date.sablier.eth
+Change Date: The earlier of 2028-07-03 or a date specified at v2-core-license-date.sablier.eth
Change License: GNU General Public License v3.0 or later
diff --git a/README.md b/README.md
index 44fc6ce53..781609aca 100644
--- a/README.md
+++ b/README.md
@@ -30,13 +30,13 @@ of tokens deposited.
This is the recommended approach.
-Install Sablier V2 Core as a Node.js package:
+Install Sablier V2 Core using your favorite package manager, e.g., with Bun:
```shell
-yarn add @sablier/v2-core
+bun add @sablier/v2-core
```
-Then, if you are using Foundry, add these to your `remappings.txt` file:
+Then, if you are using Foundry, you need to add these to your `remappings.txt` file:
```text
@sablier/v2-core/=node_modules/@sablier/v2-core/
@@ -46,16 +46,18 @@ Then, if you are using Foundry, add these to your `remappings.txt` file:
### Git Submodules
+This installation method is not recommended, but it is available for those who prefer it.
+
First, install the submodule using Forge:
```shell
-forge install sablier-labs/v2-core
+forge install --no-commit sablier-labs/v2-core
```
Second, install the project's dependencies:
```shell
-forge install --no-commit OpenZeppelin/openzeppelin-contracts@v4.9.2 PaulRBerg/prb-math@v4
+forge install --no-commit OpenZeppelin/openzeppelin-contracts@v5.0.2 PaulRBerg/prb-math@v4.0.3
```
Finally, add these to your `remappings.txt` file:
@@ -85,9 +87,9 @@ contract MyContract {
## Architecture
-V2 Core uses a singleton-style architecture, where all streams are managed in the `LockupLinear` and `LockupDynamic`
-contracts. That is, Sablier does not deploy a new contract for each stream. It bundles all streams into a single
-contract, which is more gas-efficient and easier to maintain.
+V2 Core uses a singleton-style architecture, where all streams are managed in the `LockupLinear`, `LockupDynamic` and
+`LockupTranched` contracts. That is, Sablier does not deploy a new contract for each stream. It bundles all streams into
+a single contract, which is more gas-efficient and easier to maintain.
For more information, see the [Technical Overview](https://docs.sablier.com/contracts/v2/reference/overview) in our
docs, as well as these [diagrams](https://docs.sablier.com/contracts/v2/reference/diagrams).
@@ -102,10 +104,6 @@ it is explained in depth [here](https://github.com/sablier-labs/v2-core/wiki/Tes
The list of all deployment addresses can be found [here](https://docs.sablier.com). For guidance on the deploy scripts,
see the [Deployments wiki](https://github.com/sablier-labs/v2-core/wiki/Deployments).
-It is worth noting that not every file in this repository is included in the current deployments. For instance, the
-`SablierV2FlashLoan` abstract is not inherited by any contract on the `main` branch, but we have kept it in version
-control because we may decide to use it in the future.
-
## Security
The codebase has undergone rigorous audits by leading security experts from Cantina, as well as independent auditors.
diff --git a/SECURITY.md b/SECURITY.md
index 8ae591510..dbf5eb603 100644
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -12,8 +12,8 @@ report it to us.
Starting on July 1, 2023, the [sablier-labs/v2-core](https://github.com/sablier-labs/v2-core) repository is subject to
the Sablier V2 Bug Bounty (the "Program") to incentivize responsible bug disclosure.
-We are limiting the scope of the Program to critical and high severity bugs, and are offering a reward of up to $50,000.
-Happy hunting!
+We are limiting the scope of the Program to critical and high severity bugs, and are offering a reward of up to
+$100,000. Happy hunting!
### Scope
@@ -22,8 +22,8 @@ The scope of the Program is limited to bugs that result in the draining of funds
The Program does NOT cover the following:
- Code located in the [test](./test) or [script](./script) directories.
-- External code in the [lib](./lib) directory, except for code that is explicitly used by a deployed contract located in
- the [src](./src) directory.
+- External code in `node_modules`, except for code that is explicitly used by a deployed contract located in the
+ [src](./src) directory.
- Contract deployments on test networks, such as Sepolia.
- Bugs in third-party contracts or platforms interacting with Sablier V2 Core.
- Previously reported or discovered vulnerabilities in contracts built by third parties on Sablier V2 Core.
@@ -31,8 +31,8 @@ The Program does NOT cover the following:
Vulnerabilities contingent upon the occurrence of any of the following also are outside the scope of this Program:
-- Front-end bugs
-- DDOS attacks
+- Front-end bugs (clickjacking etc.)
+- DDoS attacks
- Spamming
- Phishing
- Social engineering attacks
@@ -45,19 +45,23 @@ Vulnerabilities contingent upon the occurrence of any of the following also are
Sablier V2 Core has been developed with a number of technical assumptions in mind. For a disclosure to qualify as a
vulnerability, it must adhere to these assumptions as well:
-- The immutable variable `MAX_SEGMENT_COUNT` has a low value that cannot lead to an overflow of the block gas limit.
-- The total supply of any ERC-20 token remains below 2128 - 1, i.e. `type(uint128).max`.
+- The immutable variables `MAX_SEGMENT_COUNT` and `MAX_TRANCHE_COUNT` have values that cannot lead to an overflow of the
+ block gas limit.
+- The total supply of any ERC-20 token remains below 2128 - 1, i.e., `type(uint128).max`.
- The `transfer` and `transferFrom` methods of any ERC-20 token strictly reduce the sender's balance by the transfer
amount and increase the recipient's balance by the same amount. In other words, tokens that charge fees on transfers
are not supported.
- An address' ERC-20 balance can only change as a result of a `transfer` call by the sender or a `transferFrom` call by
an approved address. This excludes rebase tokens and interest-bearing tokens.
- The token contract does not allow callbacks (e.g. ERC-777 is not supported).
+- There is no need for exponents greater than ~18.44 in `LockupDynamic` segments.
+- Recipient contracts on the hook allowlist have gone through due diligence and are assumed to expose no risk to the
+ Sablier protocol.
### Rewards
Rewards will be allocated based on the severity of the bug disclosed and will be evaluated and rewarded at the
-discretion of the Sablier Labs team. For critical bugs that lead to any loss of user funds, rewards of up to $50,000
+discretion of the Sablier Labs team. For critical bugs that lead to any loss of user funds, rewards of up to $100,000
will be granted. Lower severity bugs will be rewarded at the discretion of the team.
### Disclosure
diff --git a/benchmark/Benchmark.t.sol b/benchmark/Benchmark.t.sol
new file mode 100644
index 000000000..78856032f
--- /dev/null
+++ b/benchmark/Benchmark.t.sol
@@ -0,0 +1,174 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22;
+
+import { UD60x18, ud } from "@prb/math/src/UD60x18.sol";
+import { ISablierV2Lockup } from "../src/interfaces/ISablierV2Lockup.sol";
+
+import { Base_Test } from "../test/Base.t.sol";
+
+/// @notice Benchmark contract with common logic needed by all tests.
+abstract contract Benchmark_Test is Base_Test {
+ /*//////////////////////////////////////////////////////////////////////////
+ STATE VARIABLES
+ //////////////////////////////////////////////////////////////////////////*/
+
+ uint128 internal immutable AMOUNT_PER_SEGMENT = 100e18;
+ uint128 internal immutable AMOUNT_PER_TRANCHE = 100e18;
+ uint256[7] internal streamIds = [50, 51, 52, 53, 54, 55, 56];
+
+ /// @dev The directory where the benchmark files are stored.
+ string internal benchmarkResults = "benchmark/results/";
+
+ /// @dev The path to the file where the benchmark results are stored.
+ string internal benchmarkResultsFile;
+
+ /// @dev A variable used to store the content to append to the results file.
+ string internal contentToAppend;
+
+ ISablierV2Lockup internal lockup;
+
+ /*//////////////////////////////////////////////////////////////////////////
+ SET-UP FUNCTION
+ //////////////////////////////////////////////////////////////////////////*/
+
+ function setUp() public virtual override {
+ super.setUp();
+
+ deal({ token: address(dai), to: users.sender, give: type(uint256).max });
+ resetPrank({ msgSender: users.sender });
+
+ // Create the first streams in each Lockup contract to initialize all the variables.
+ _createFewStreams();
+ }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ GAS FUNCTIONS FOR SHARED IMPLEMENTATIONS
+ //////////////////////////////////////////////////////////////////////////*/
+
+ function gasBurn() internal {
+ // Set the caller to the Recipient for `burn` and change timestamp to the end time.
+ resetPrank({ msgSender: users.recipient });
+
+ vm.warp({ newTimestamp: defaults.END_TIME() });
+
+ lockup.withdrawMax(streamIds[0], users.recipient);
+
+ uint256 initialGas = gasleft();
+ lockup.burn(streamIds[0]);
+ string memory gasUsed = vm.toString(initialGas - gasleft());
+
+ contentToAppend = string.concat("| `burn` | ", gasUsed, " |");
+
+ // Append the content to the file.
+ _appendToFile(benchmarkResultsFile, contentToAppend);
+ }
+
+ function gasCancel() internal {
+ // Set the caller to the Sender for the next calls and change timestamp to before end time
+ resetPrank({ msgSender: users.sender });
+
+ uint256 initialGas = gasleft();
+ lockup.cancel(streamIds[1]);
+ string memory gasUsed = vm.toString(initialGas - gasleft());
+
+ contentToAppend = string.concat("| `cancel` | ", gasUsed, " |");
+
+ // Append the content to the file.
+ _appendToFile(benchmarkResultsFile, contentToAppend);
+ }
+
+ function gasRenounce() internal {
+ // Set the caller to the Sender for the next calls and change timestamp to before end time.
+ resetPrank({ msgSender: users.sender });
+
+ uint256 initialGas = gasleft();
+ lockup.renounce(streamIds[2]);
+ string memory gasUsed = vm.toString(initialGas - gasleft());
+
+ contentToAppend = string.concat("| `renounce` | ", gasUsed, " |");
+
+ // Append the content to the file.
+ _appendToFile(benchmarkResultsFile, contentToAppend);
+ }
+
+ function gasWithdraw(uint256 streamId, address caller, address to, string memory extraInfo) internal {
+ resetPrank({ msgSender: caller });
+
+ uint128 withdrawAmount = lockup.withdrawableAmountOf(streamId);
+
+ uint256 initialGas = gasleft();
+ lockup.withdraw(streamId, to, withdrawAmount);
+ string memory gasUsed = vm.toString(initialGas - gasleft());
+
+ // Check if caller is recipient or not.
+ bool isCallerRecipient = caller == users.recipient;
+
+ string memory s = isCallerRecipient
+ ? string.concat("| `withdraw` ", extraInfo, " (by Recipient) | ")
+ : string.concat("| `withdraw` ", extraInfo, " (by Anyone) | ");
+ contentToAppend = string.concat(s, gasUsed, " |");
+
+ // Append the data to the file.
+ _appendToFile(benchmarkResultsFile, contentToAppend);
+ }
+
+ function gasWithdraw_AfterEndTime(uint256 streamId, address caller, address to, string memory extraInfo) internal {
+ extraInfo = string.concat(extraInfo, " (After End Time)");
+
+ uint256 warpTime = lockup.getEndTime(streamId) + 1;
+ vm.warp({ newTimestamp: warpTime });
+
+ gasWithdraw(streamId, caller, to, extraInfo);
+ }
+
+ function gasWithdraw_BeforeEndTime(
+ uint256 streamId,
+ address caller,
+ address to,
+ string memory extraInfo
+ )
+ internal
+ {
+ extraInfo = string.concat(extraInfo, " (Before End Time)");
+
+ uint256 warpTime = lockup.getEndTime(streamId) - 1;
+ vm.warp({ newTimestamp: warpTime });
+
+ gasWithdraw(streamId, caller, to, extraInfo);
+ }
+
+ function gasWithdraw_ByAnyone(uint256 streamId1, uint256 streamId2, string memory extraInfo) internal {
+ gasWithdraw_AfterEndTime(streamId1, users.sender, users.recipient, extraInfo);
+ gasWithdraw_BeforeEndTime(streamId2, users.sender, users.recipient, extraInfo);
+ }
+
+ function gasWithdraw_ByRecipient(uint256 streamId1, uint256 streamId2, string memory extraInfo) internal {
+ gasWithdraw_AfterEndTime(streamId1, users.recipient, users.alice, extraInfo);
+ gasWithdraw_BeforeEndTime(streamId2, users.recipient, users.alice, extraInfo);
+ }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ HELPERS
+ //////////////////////////////////////////////////////////////////////////*/
+
+ /// @dev Append a line to the file at given path.
+ function _appendToFile(string memory path, string memory line) internal {
+ vm.writeLine({ path: path, data: line });
+ }
+
+ /// @dev Calculates the total amount to be deposited in the stream, by accounting for the broker fee.
+ function _calculateTotalAmount(uint128 depositAmount, UD60x18 brokerFee) internal pure returns (uint128) {
+ UD60x18 factor = ud(1e18);
+ UD60x18 totalAmount = ud(depositAmount).mul(factor).div(factor.sub(brokerFee));
+ return totalAmount.intoUint128();
+ }
+
+ /// @dev Internal function to creates a few streams in each Lockup contract.
+ function _createFewStreams() internal {
+ for (uint128 i = 0; i < 100; ++i) {
+ lockupDynamic.createWithTimestamps(defaults.createWithTimestampsLD());
+ lockupLinear.createWithTimestamps(defaults.createWithTimestampsLL());
+ lockupTranched.createWithTimestamps(defaults.createWithTimestampsLT());
+ }
+ }
+}
diff --git a/benchmark/EstimateMaxCount.t.sol b/benchmark/EstimateMaxCount.t.sol
new file mode 100644
index 000000000..792f8ad80
--- /dev/null
+++ b/benchmark/EstimateMaxCount.t.sol
@@ -0,0 +1,91 @@
+// solhint-disable no-console
+pragma solidity >=0.8.22 <0.9.0;
+
+import { console2 } from "forge-std/src/console2.sol";
+import { Test } from "forge-std/src/Test.sol";
+
+import { LockupDynamic_Gas_Test } from "./LockupDynamic.Gas.t.sol";
+import { LockupTranched_Gas_Test } from "./LockupTranched.Gas.t.sol";
+
+/// @notice Structure to group the block gas limit and chain id.
+struct ChainInfo {
+ uint256 blockGasLimit;
+ uint256 chainId;
+}
+
+contract EstimateMaxCount is Test {
+ // Buffer gas units to be deducted from the block gas limit so that the max count never exceeds the block limit.
+ uint256 public constant BUFFER_GAS = 1_000_000;
+
+ // Initial guess for the maximum number of segments/tranches.
+ uint128 public constant INITIAL_GUESS = 240;
+
+ /// @dev List of chains with their block gas limit.
+ ChainInfo[] public chains;
+
+ constructor() {
+ chains.push(ChainInfo({ blockGasLimit: 32_000_000, chainId: 42_161 })); // Arbitrum
+ chains.push(ChainInfo({ blockGasLimit: 15_000_000, chainId: 43_114 })); // Avalanche
+ chains.push(ChainInfo({ blockGasLimit: 60_000_000, chainId: 8453 })); // Base
+ chains.push(ChainInfo({ blockGasLimit: 30_000_000, chainId: 238 })); // Blast
+ chains.push(ChainInfo({ blockGasLimit: 138_000_000, chainId: 56 })); // BNB
+ chains.push(ChainInfo({ blockGasLimit: 30_000_000, chainId: 1 })); // Ethereum
+ chains.push(ChainInfo({ blockGasLimit: 17_000_000, chainId: 100 })); // Gnosis
+ chains.push(ChainInfo({ blockGasLimit: 30_000_000, chainId: 10 })); // Optimism
+ chains.push(ChainInfo({ blockGasLimit: 30_000_000, chainId: 137 })); // Polygon
+ chains.push(ChainInfo({ blockGasLimit: 10_000_000, chainId: 534_352 })); // Scroll
+ chains.push(ChainInfo({ blockGasLimit: 30_000_000, chainId: 11_155_111 })); // Sepolia
+ }
+
+ /// @notice Estimate the maximum number of segments allowed in LockupDynamic.
+ function test_EstimateSegments() public {
+ LockupDynamic_Gas_Test lockupDynamicGasTest = new LockupDynamic_Gas_Test();
+ lockupDynamicGasTest.setUp();
+
+ for (uint256 i = 0; i < chains.length; ++i) {
+ uint128 count = INITIAL_GUESS;
+
+ // Subtract `BUFFER_GAS` from `blockGasLimit` as an additional precaution to account for the dynamic gas for
+ // ether transfer on different chains.
+ uint256 blockGasLimit = chains[i].blockGasLimit - BUFFER_GAS;
+
+ uint256 gasConsumed = 0;
+ uint256 lastGasConsumed = 0;
+ while (blockGasLimit > gasConsumed) {
+ count += 10;
+ lastGasConsumed = gasConsumed;
+
+ // Estimate the gas consumed by adding 10 segments.
+ gasConsumed = lockupDynamicGasTest.computeGas_CreateWithDurations(count + 10);
+ }
+
+ console2.log("count: %d and gasUsed: %d and chainId: %d", count, lastGasConsumed, chains[i].chainId);
+ }
+ }
+
+ /// @notice Estimate the maximum number of tranches allowed in LockupTranched.
+ function test_EstimateTranches() public {
+ LockupTranched_Gas_Test lockupTranchedGasTest = new LockupTranched_Gas_Test();
+ lockupTranchedGasTest.setUp();
+
+ for (uint256 i = 0; i < chains.length; ++i) {
+ uint128 count = INITIAL_GUESS;
+
+ // Subtract `BUFFER_GAS` from `blockGasLimit` as an additional precaution to account for the dynamic gas for
+ // ether transfer on different chains.
+ uint256 blockGasLimit = chains[i].blockGasLimit - BUFFER_GAS;
+
+ uint256 gasConsumed = 0;
+ uint256 lastGasConsumed = 0;
+ while (blockGasLimit > gasConsumed) {
+ count += 10;
+ lastGasConsumed = gasConsumed;
+
+ // Estimate the gas consumed by adding 10 tranches.
+ gasConsumed = lockupTranchedGasTest.computeGas_CreateWithDurations(count + 10);
+ }
+
+ console2.log("count: %d and gasUsed: %d and chainId: %d", count, lastGasConsumed, chains[i].chainId);
+ }
+ }
+}
diff --git a/benchmark/LockupDynamic.Gas.t.sol b/benchmark/LockupDynamic.Gas.t.sol
new file mode 100644
index 000000000..afac9403d
--- /dev/null
+++ b/benchmark/LockupDynamic.Gas.t.sol
@@ -0,0 +1,237 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22;
+
+import { ud2x18 } from "@prb/math/src/UD2x18.sol";
+import { UD60x18, ud } from "@prb/math/src/UD60x18.sol";
+
+import { Broker, LockupDynamic } from "../src/types/DataTypes.sol";
+import { Benchmark_Test } from "./Benchmark.t.sol";
+
+/// @notice Tests used to benchmark LockupDynamic.
+/// @dev This contract creates a Markdown file with the gas usage of each function.
+contract LockupDynamic_Gas_Test is Benchmark_Test {
+ /*//////////////////////////////////////////////////////////////////////////
+ STATE VARIABLES
+ //////////////////////////////////////////////////////////////////////////*/
+
+ uint128[] internal _segments = [2, 10, 100];
+ uint256[] internal _streamIdsForWithdraw = new uint256[](4);
+
+ /*//////////////////////////////////////////////////////////////////////////
+ SET-UP FUNCTION
+ //////////////////////////////////////////////////////////////////////////*/
+ function setUp() public override {
+ super.setUp();
+
+ lockup = lockupDynamic;
+ }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ TEST FUNCTION
+ //////////////////////////////////////////////////////////////////////////*/
+
+ function testGas_Implementations() external {
+ // Set the file path.
+ benchmarkResultsFile = string.concat(benchmarkResults, "SablierV2LockupDynamic.md");
+
+ // Create the file if it doesn't exist, otherwise overwrite it.
+ vm.writeFile({
+ path: benchmarkResultsFile,
+ data: string.concat("# Benchmarks for LockupDynamic\n\n", "| Implementation | Gas Usage |\n", "| --- | --- |\n")
+ });
+
+ vm.warp({ newTimestamp: defaults.END_TIME() });
+ gasBurn();
+
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
+
+ gasCancel();
+
+ gasRenounce();
+
+ // Create streams with different number of segments.
+ for (uint256 i; i < _segments.length; ++i) {
+ gasCreateWithDurations({ totalSegments: _segments[i] });
+ gasCreateWithTimestamps({ totalSegments: _segments[i] });
+
+ gasWithdraw_ByRecipient(
+ _streamIdsForWithdraw[0],
+ _streamIdsForWithdraw[1],
+ string.concat("(", vm.toString(_segments[i]), " segments)")
+ );
+ gasWithdraw_ByAnyone(
+ _streamIdsForWithdraw[2],
+ _streamIdsForWithdraw[3],
+ string.concat("(", vm.toString(_segments[i]), " segments)")
+ );
+ }
+ }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ GAS BENCHMARKS FOR CREATE FUNCTIONS
+ //////////////////////////////////////////////////////////////////////////*/
+
+ // The following function is used in the estimations of `MAX_SEGMENT_COUNT`.
+ function computeGas_CreateWithDurations(uint128 totalSegments) public returns (uint256 gasUsed) {
+ LockupDynamic.CreateWithDurations memory params =
+ _createWithDurationParams(totalSegments, defaults.BROKER_FEE());
+
+ uint256 beforeGas = gasleft();
+ lockupDynamic.createWithDurations(params);
+
+ gasUsed = beforeGas - gasleft();
+ }
+
+ function gasCreateWithDurations(uint128 totalSegments) internal {
+ // Set the caller to the Sender for the next calls and change timestamp to before end time.
+ resetPrank({ msgSender: users.sender });
+
+ LockupDynamic.CreateWithDurations memory params =
+ _createWithDurationParams(totalSegments, defaults.BROKER_FEE());
+
+ uint256 beforeGas = gasleft();
+ lockupDynamic.createWithDurations(params);
+ string memory gasUsed = vm.toString(beforeGas - gasleft());
+
+ contentToAppend = string.concat(
+ "| `createWithDurations` (", vm.toString(totalSegments), " segments) (Broker fee set) | ", gasUsed, " |"
+ );
+
+ // Append the content to the file.
+ _appendToFile(benchmarkResultsFile, contentToAppend);
+
+ // Calculate gas usage without broker fee.
+ params = _createWithDurationParams(totalSegments, ud(0));
+
+ beforeGas = gasleft();
+ lockupDynamic.createWithDurations(params);
+ gasUsed = vm.toString(beforeGas - gasleft());
+
+ contentToAppend = string.concat(
+ "| `createWithDurations` (", vm.toString(totalSegments), " segments) (Broker fee not set) | ", gasUsed, " |"
+ );
+
+ _appendToFile(benchmarkResultsFile, contentToAppend);
+
+ // Store the last 2 streams IDs for withdraw gas benchmark.
+ _streamIdsForWithdraw[0] = lockupDynamic.nextStreamId() - 2;
+ _streamIdsForWithdraw[1] = lockupDynamic.nextStreamId() - 1;
+
+ // Create 2 more streams for withdraw gas benchmark.
+ _streamIdsForWithdraw[2] = lockupDynamic.createWithDurations(params);
+ _streamIdsForWithdraw[3] = lockupDynamic.createWithDurations(params);
+ }
+
+ function gasCreateWithTimestamps(uint128 totalSegments) internal {
+ // Set the caller to the Sender for the next calls and change timestamp to before end time
+ resetPrank({ msgSender: users.sender });
+
+ LockupDynamic.CreateWithTimestamps memory params =
+ _createWithTimestampParams(totalSegments, defaults.BROKER_FEE());
+
+ uint256 beforeGas = gasleft();
+ lockupDynamic.createWithTimestamps(params);
+
+ string memory gasUsed = vm.toString(beforeGas - gasleft());
+
+ contentToAppend = string.concat(
+ "| `createWithTimestamps` (", vm.toString(totalSegments), " segments) (Broker fee set) | ", gasUsed, " |"
+ );
+
+ // Append the data to the file
+ _appendToFile(benchmarkResultsFile, contentToAppend);
+
+ // Calculate gas usage without broker fee.
+ params = _createWithTimestampParams(totalSegments, ud(0));
+
+ beforeGas = gasleft();
+ lockupDynamic.createWithTimestamps(params);
+ gasUsed = vm.toString(beforeGas - gasleft());
+
+ contentToAppend = string.concat(
+ "| `createWithTimestamps` (",
+ vm.toString(totalSegments),
+ " segments) (Broker fee not set) | ",
+ gasUsed,
+ " |"
+ );
+
+ // Append the data to the file
+ _appendToFile(benchmarkResultsFile, contentToAppend);
+ }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ HELPERS
+ //////////////////////////////////////////////////////////////////////////*/
+
+ function _createWithDurationParams(
+ uint128 totalSegments,
+ UD60x18 brokerFee
+ )
+ private
+ view
+ returns (LockupDynamic.CreateWithDurations memory)
+ {
+ LockupDynamic.SegmentWithDuration[] memory segments_ = new LockupDynamic.SegmentWithDuration[](totalSegments);
+
+ // Populate segments.
+ for (uint256 i = 0; i < totalSegments; ++i) {
+ segments_[i] = (
+ LockupDynamic.SegmentWithDuration({
+ amount: AMOUNT_PER_SEGMENT,
+ exponent: ud2x18(0.5e18),
+ duration: defaults.CLIFF_DURATION()
+ })
+ );
+ }
+
+ uint128 depositAmount = AMOUNT_PER_SEGMENT * totalSegments;
+
+ return LockupDynamic.CreateWithDurations({
+ sender: users.sender,
+ recipient: users.recipient,
+ totalAmount: _calculateTotalAmount(depositAmount, brokerFee),
+ asset: dai,
+ cancelable: true,
+ transferable: true,
+ segments: segments_,
+ broker: Broker({ account: users.broker, fee: brokerFee })
+ });
+ }
+
+ function _createWithTimestampParams(
+ uint128 totalSegments,
+ UD60x18 brokerFee
+ )
+ private
+ view
+ returns (LockupDynamic.CreateWithTimestamps memory)
+ {
+ LockupDynamic.Segment[] memory segments_ = new LockupDynamic.Segment[](totalSegments);
+
+ // Populate segments.
+ for (uint256 i = 0; i < totalSegments; ++i) {
+ segments_[i] = (
+ LockupDynamic.Segment({
+ amount: AMOUNT_PER_SEGMENT,
+ exponent: ud2x18(0.5e18),
+ timestamp: getBlockTimestamp() + uint40(defaults.CLIFF_DURATION() * (1 + i))
+ })
+ );
+ }
+
+ uint128 depositAmount = AMOUNT_PER_SEGMENT * totalSegments;
+
+ return LockupDynamic.CreateWithTimestamps({
+ sender: users.sender,
+ recipient: users.recipient,
+ totalAmount: _calculateTotalAmount(depositAmount, brokerFee),
+ asset: dai,
+ cancelable: true,
+ transferable: true,
+ startTime: getBlockTimestamp(),
+ segments: segments_,
+ broker: Broker({ account: users.broker, fee: brokerFee })
+ });
+ }
+}
diff --git a/benchmark/LockupLinear.Gas.t.sol b/benchmark/LockupLinear.Gas.t.sol
new file mode 100644
index 000000000..f4d35e961
--- /dev/null
+++ b/benchmark/LockupLinear.Gas.t.sol
@@ -0,0 +1,125 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22;
+
+import { ud } from "@prb/math/src/UD60x18.sol";
+
+import { LockupLinear } from "../src/types/DataTypes.sol";
+
+import { Benchmark_Test } from "./Benchmark.t.sol";
+
+/// @notice Tests used to benchmark LockupLinear.
+/// @dev This contract creates a Markdown file with the gas usage of each function.
+contract LockupLinear_Gas_Test is Benchmark_Test {
+ /*//////////////////////////////////////////////////////////////////////////
+ SET-UP FUNCTION
+ //////////////////////////////////////////////////////////////////////////*/
+
+ function setUp() public override {
+ super.setUp();
+
+ lockup = lockupLinear;
+ }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ TEST FUNCTION
+ //////////////////////////////////////////////////////////////////////////*/
+
+ function testGas_Implementations() external {
+ // Set the file path.
+ benchmarkResultsFile = string.concat(benchmarkResults, "SablierV2LockupLinear.md");
+
+ // Create the file if it doesn't exist, otherwise overwrite it.
+ vm.writeFile({
+ path: benchmarkResultsFile,
+ data: string.concat("# Benchmarks for LockupLinear\n\n", "| Implementation | Gas Usage |\n", "| --- | --- |\n")
+ });
+
+ vm.warp({ newTimestamp: defaults.END_TIME() });
+ gasBurn();
+
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
+ gasCancel();
+
+ gasRenounce();
+
+ gasCreateWithDurations({ cliffDuration: 0 });
+ gasCreateWithDurations({ cliffDuration: defaults.CLIFF_DURATION() });
+
+ gasCreateWithTimestamps({ cliffTime: 0 });
+ gasCreateWithTimestamps({ cliffTime: defaults.CLIFF_TIME() });
+
+ gasWithdraw_ByRecipient(streamIds[3], streamIds[4], "");
+ gasWithdraw_ByAnyone(streamIds[5], streamIds[6], "");
+ }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ GAS BENCHMARKS FOR CREATE FUNCTIONS
+ //////////////////////////////////////////////////////////////////////////*/
+
+ function gasCreateWithDurations(uint40 cliffDuration) internal {
+ // Set the caller to the Sender for the next calls and change timestamp to before end time.
+ resetPrank({ msgSender: users.sender });
+
+ LockupLinear.CreateWithDurations memory params = defaults.createWithDurationsLL();
+ params.durations.cliff = cliffDuration;
+
+ uint256 beforeGas = gasleft();
+ lockupLinear.createWithDurations(params);
+ string memory gasUsed = vm.toString(beforeGas - gasleft());
+
+ string memory cliffSetOrNot = cliffDuration == 0 ? " (cliff not set)" : " (cliff set)";
+
+ contentToAppend = string.concat("| `createWithDurations` (Broker fee set)", cliffSetOrNot, " | ", gasUsed, " |");
+
+ // Append the content to the file.
+ _appendToFile(benchmarkResultsFile, contentToAppend);
+
+ // Calculate gas usage without broker fee.
+ params.broker.fee = ud(0);
+ params.totalAmount = _calculateTotalAmount(defaults.DEPOSIT_AMOUNT(), ud(0));
+
+ beforeGas = gasleft();
+ lockupLinear.createWithDurations(params);
+ gasUsed = vm.toString(beforeGas - gasleft());
+
+ contentToAppend =
+ string.concat("| `createWithDurations` (Broker fee not set)", cliffSetOrNot, " | ", gasUsed, " |");
+
+ // Append the content to the file.
+ _appendToFile(benchmarkResultsFile, contentToAppend);
+ }
+
+ function gasCreateWithTimestamps(uint40 cliffTime) internal {
+ // Set the caller to the Sender for the next calls and change timestamp to before end time.
+ resetPrank({ msgSender: users.sender });
+
+ LockupLinear.CreateWithTimestamps memory params = defaults.createWithTimestampsLL();
+ params.timestamps.cliff = cliffTime;
+
+ uint256 beforeGas = gasleft();
+ lockupLinear.createWithTimestamps(params);
+ string memory gasUsed = vm.toString(beforeGas - gasleft());
+
+ string memory cliffSetOrNot = cliffTime == 0 ? " (cliff not set)" : " (cliff set)";
+
+ contentToAppend =
+ string.concat("| `createWithTimestamps` (Broker fee set)", cliffSetOrNot, " | ", gasUsed, " |");
+
+ // Append the content to the file.
+ _appendToFile(benchmarkResultsFile, contentToAppend);
+
+ // Calculate gas usage without broker fee.
+ params.broker.fee = ud(0);
+ params.totalAmount = _calculateTotalAmount(defaults.DEPOSIT_AMOUNT(), ud(0));
+
+ beforeGas = gasleft();
+ lockupLinear.createWithTimestamps(params);
+ gasUsed = vm.toString(beforeGas - gasleft());
+
+ contentToAppend =
+ string.concat("| `createWithTimestamps` (Broker fee not set)", cliffSetOrNot, " | ", gasUsed, " |");
+
+ // Append the content to the file.
+ _appendToFile(benchmarkResultsFile, contentToAppend);
+ }
+}
diff --git a/benchmark/LockupTranched.Gas.t.sol b/benchmark/LockupTranched.Gas.t.sol
new file mode 100644
index 000000000..591e80c89
--- /dev/null
+++ b/benchmark/LockupTranched.Gas.t.sol
@@ -0,0 +1,229 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22;
+
+import { UD60x18, ud } from "@prb/math/src/UD60x18.sol";
+
+import { Broker, LockupTranched } from "../src/types/DataTypes.sol";
+
+import { Benchmark_Test } from "./Benchmark.t.sol";
+
+/// @notice Tests used to benchmark LockupTranched.
+/// @dev This contract creates a Markdown file with the gas usage of each function.
+contract LockupTranched_Gas_Test is Benchmark_Test {
+ /*//////////////////////////////////////////////////////////////////////////
+ STATE VARIABLES
+ //////////////////////////////////////////////////////////////////////////*/
+
+ uint128[] internal _tranches = [2, 10, 100];
+ uint256[] internal _streamIdsForWithdraw = new uint256[](4);
+
+ /*//////////////////////////////////////////////////////////////////////////
+ SET-UP FUNCTION
+ //////////////////////////////////////////////////////////////////////////*/
+
+ function setUp() public override {
+ super.setUp();
+
+ lockup = lockupTranched;
+ }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ TEST FUNCTION
+ //////////////////////////////////////////////////////////////////////////*/
+
+ function testGas_Implementations() external {
+ // Set the file path.
+ benchmarkResultsFile = string.concat(benchmarkResults, "SablierV2LockupTranched.md");
+
+ // Create the file if it doesn't exist, otherwise overwrite it.
+ vm.writeFile({
+ path: benchmarkResultsFile,
+ data: string.concat(
+ "# Benchmarks for LockupTranched\n\n", "| Implementation | Gas Usage |\n", "| --- | --- |\n"
+ )
+ });
+
+ vm.warp({ newTimestamp: defaults.END_TIME() });
+ gasBurn();
+
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
+
+ gasCancel();
+
+ gasRenounce();
+
+ // Create streams with different number of tranches.
+ for (uint256 i; i < _tranches.length; ++i) {
+ gasCreateWithDurations({ totalTranches: _tranches[i] });
+ gasCreateWithTimestamps({ totalTranches: _tranches[i] });
+
+ gasWithdraw_ByRecipient(
+ _streamIdsForWithdraw[0],
+ _streamIdsForWithdraw[1],
+ string.concat("(", vm.toString(_tranches[i]), " tranches)")
+ );
+ gasWithdraw_ByAnyone(
+ _streamIdsForWithdraw[2],
+ _streamIdsForWithdraw[3],
+ string.concat("(", vm.toString(_tranches[i]), " tranches)")
+ );
+ }
+ }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ GAS BENCHMARKS FOR CREATE FUNCTIONS
+ //////////////////////////////////////////////////////////////////////////*/
+
+ // The following function is used in the estimation of `MAX_TRANCHE_COUNT`
+ function computeGas_CreateWithDurations(uint128 totalTranches) public returns (uint256 gasUsed) {
+ LockupTranched.CreateWithDurations memory params =
+ _createWithDurationParams(totalTranches, defaults.BROKER_FEE());
+
+ uint256 beforeGas = gasleft();
+ lockupTranched.createWithDurations(params);
+
+ gasUsed = beforeGas - gasleft();
+ }
+
+ function gasCreateWithDurations(uint128 totalTranches) internal {
+ // Set the caller to the Sender for the next calls and change timestamp to before end time.
+ resetPrank({ msgSender: users.sender });
+
+ LockupTranched.CreateWithDurations memory params =
+ _createWithDurationParams(totalTranches, defaults.BROKER_FEE());
+
+ uint256 beforeGas = gasleft();
+ lockupTranched.createWithDurations(params);
+ string memory gasUsed = vm.toString(beforeGas - gasleft());
+
+ contentToAppend = string.concat(
+ "| `createWithDurations` (", vm.toString(totalTranches), " tranches) (Broker fee set) | ", gasUsed, " |"
+ );
+
+ // Append the content to the file.
+ _appendToFile(benchmarkResultsFile, contentToAppend);
+
+ // Calculate gas usage without broker fee.
+ params = _createWithDurationParams(totalTranches, ud(0));
+
+ beforeGas = gasleft();
+ lockupTranched.createWithDurations(params);
+ gasUsed = vm.toString(beforeGas - gasleft());
+
+ contentToAppend = string.concat(
+ "| `createWithDurations` (", vm.toString(totalTranches), " tranches) (Broker fee not set) | ", gasUsed, " |"
+ );
+
+ _appendToFile(benchmarkResultsFile, contentToAppend);
+
+ // Store the last 2 streams IDs for withdraw gas benchmark.
+ _streamIdsForWithdraw[0] = lockupTranched.nextStreamId() - 2;
+ _streamIdsForWithdraw[1] = lockupTranched.nextStreamId() - 1;
+
+ // Create 2 more streams for withdraw gas benchmark.
+ _streamIdsForWithdraw[2] = lockupTranched.createWithDurations(params);
+ _streamIdsForWithdraw[3] = lockupTranched.createWithDurations(params);
+ }
+
+ function gasCreateWithTimestamps(uint128 totalTranches) internal {
+ // Set the caller to the Sender for the next calls and change timestamp to before end time.
+ resetPrank({ msgSender: users.sender });
+
+ uint256 beforeGas = gasleft();
+ lockupTranched.createWithTimestamps({ params: _createWithTimestampParams(totalTranches, defaults.BROKER_FEE()) });
+
+ string memory gasUsed = vm.toString(beforeGas - gasleft());
+
+ contentToAppend = string.concat(
+ "| `createWithTimestamps` (", vm.toString(totalTranches), " tranches) (Broker fee set) | ", gasUsed, " |"
+ );
+
+ // Append the content to the file.
+ _appendToFile(benchmarkResultsFile, contentToAppend);
+
+ beforeGas = gasleft();
+ lockupTranched.createWithTimestamps({ params: _createWithTimestampParams(totalTranches, ud(0)) });
+ gasUsed = vm.toString(beforeGas - gasleft());
+
+ contentToAppend = string.concat(
+ "| `createWithTimestamps` (",
+ vm.toString(totalTranches),
+ " tranches) (Broker fee not set) | ",
+ gasUsed,
+ " |"
+ );
+
+ // Append the content to the file.
+ _appendToFile(benchmarkResultsFile, contentToAppend);
+ }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ HELPERS
+ //////////////////////////////////////////////////////////////////////////*/
+
+ function _createWithDurationParams(
+ uint128 totalTranches,
+ UD60x18 brokerFee
+ )
+ private
+ view
+ returns (LockupTranched.CreateWithDurations memory)
+ {
+ LockupTranched.TrancheWithDuration[] memory tranches_ = new LockupTranched.TrancheWithDuration[](totalTranches);
+
+ // Populate tranches
+ for (uint256 i = 0; i < totalTranches; ++i) {
+ tranches_[i] = (
+ LockupTranched.TrancheWithDuration({ amount: AMOUNT_PER_TRANCHE, duration: defaults.CLIFF_DURATION() })
+ );
+ }
+
+ uint128 depositAmount = AMOUNT_PER_SEGMENT * totalTranches;
+
+ return LockupTranched.CreateWithDurations({
+ sender: users.sender,
+ recipient: users.recipient,
+ totalAmount: _calculateTotalAmount(depositAmount, brokerFee),
+ asset: dai,
+ cancelable: true,
+ transferable: true,
+ tranches: tranches_,
+ broker: Broker({ account: users.broker, fee: brokerFee })
+ });
+ }
+
+ function _createWithTimestampParams(
+ uint128 totalTranches,
+ UD60x18 brokerFee
+ )
+ private
+ view
+ returns (LockupTranched.CreateWithTimestamps memory)
+ {
+ LockupTranched.Tranche[] memory tranches_ = new LockupTranched.Tranche[](totalTranches);
+
+ // Populate tranches.
+ for (uint256 i = 0; i < totalTranches; ++i) {
+ tranches_[i] = (
+ LockupTranched.Tranche({
+ amount: AMOUNT_PER_TRANCHE,
+ timestamp: getBlockTimestamp() + uint40(defaults.CLIFF_DURATION() * (1 + i))
+ })
+ );
+ }
+
+ uint128 depositAmount = AMOUNT_PER_SEGMENT * totalTranches;
+
+ return LockupTranched.CreateWithTimestamps({
+ sender: users.sender,
+ recipient: users.recipient,
+ totalAmount: _calculateTotalAmount(depositAmount, brokerFee),
+ asset: dai,
+ cancelable: true,
+ transferable: true,
+ startTime: getBlockTimestamp(),
+ tranches: tranches_,
+ broker: Broker({ account: users.broker, fee: brokerFee })
+ });
+ }
+}
diff --git a/benchmark/results/SablierV2LockupDynamic.md b/benchmark/results/SablierV2LockupDynamic.md
new file mode 100644
index 000000000..de8e2145b
--- /dev/null
+++ b/benchmark/results/SablierV2LockupDynamic.md
@@ -0,0 +1,31 @@
+# Benchmarks for LockupDynamic
+
+| Implementation | Gas Usage |
+| ---------------------------------------------------------- | --------- |
+| `burn` | 15716 |
+| `cancel` | 74341 |
+| `renounce` | 39007 |
+| `createWithDurations` (2 segments) (Broker fee set) | 200602 |
+| `createWithDurations` (2 segments) (Broker fee not set) | 185037 |
+| `createWithTimestamps` (2 segments) (Broker fee set) | 184780 |
+| `createWithTimestamps` (2 segments) (Broker fee not set) | 180015 |
+| `withdraw` (2 segments) (After End Time) (by Recipient) | 19108 |
+| `withdraw` (2 segments) (Before End Time) (by Recipient) | 27554 |
+| `withdraw` (2 segments) (After End Time) (by Anyone) | 14239 |
+| `withdraw` (2 segments) (Before End Time) (by Anyone) | 27485 |
+| `createWithDurations` (10 segments) (Broker fee set) | 395084 |
+| `createWithDurations` (10 segments) (Broker fee not set) | 390326 |
+| `createWithTimestamps` (10 segments) (Broker fee set) | 385125 |
+| `createWithTimestamps` (10 segments) (Broker fee not set) | 380375 |
+| `withdraw` (10 segments) (After End Time) (by Recipient) | 14295 |
+| `withdraw` (10 segments) (Before End Time) (by Recipient) | 32545 |
+| `withdraw` (10 segments) (After End Time) (by Anyone) | 14246 |
+| `withdraw` (10 segments) (Before End Time) (by Anyone) | 32476 |
+| `createWithDurations` (100 segments) (Broker fee set) | 2740781 |
+| `createWithDurations` (100 segments) (Broker fee not set) | 2736987 |
+| `createWithTimestamps` (100 segments) (Broker fee set) | 2642946 |
+| `createWithTimestamps` (100 segments) (Broker fee not set) | 2639185 |
+| `withdraw` (100 segments) (After End Time) (by Recipient) | 14295 |
+| `withdraw` (100 segments) (Before End Time) (by Recipient) | 88968 |
+| `withdraw` (100 segments) (After End Time) (by Anyone) | 14226 |
+| `withdraw` (100 segments) (Before End Time) (by Anyone) | 88899 |
diff --git a/benchmark/results/SablierV2LockupLinear.md b/benchmark/results/SablierV2LockupLinear.md
new file mode 100644
index 000000000..d53fa08f9
--- /dev/null
+++ b/benchmark/results/SablierV2LockupLinear.md
@@ -0,0 +1,19 @@
+# Benchmarks for LockupLinear
+
+| Implementation | Gas Usage |
+| ----------------------------------------------------------- | --------- |
+| `burn` | 15694 |
+| `cancel` | 56829 |
+| `renounce` | 19381 |
+| `createWithDurations` (Broker fee set) (cliff not set) | 129276 |
+| `createWithDurations` (Broker fee not set) (cliff not set) | 113680 |
+| `createWithDurations` (Broker fee set) (cliff set) | 138071 |
+| `createWithDurations` (Broker fee not set) (cliff set) | 133273 |
+| `createWithTimestamps` (Broker fee set) (cliff not set) | 115334 |
+| `createWithTimestamps` (Broker fee not set) (cliff not set) | 110530 |
+| `createWithTimestamps` (Broker fee set) (cliff set) | 137629 |
+| `createWithTimestamps` (Broker fee not set) (cliff set) | 132827 |
+| `withdraw` (After End Time) (by Recipient) | 29701 |
+| `withdraw` (Before End Time) (by Recipient) | 19104 |
+| `withdraw` (After End Time) (by Anyone) | 24799 |
+| `withdraw` (Before End Time) (by Anyone) | 19002 |
diff --git a/benchmark/results/SablierV2LockupTranched.md b/benchmark/results/SablierV2LockupTranched.md
new file mode 100644
index 000000000..ec7ea9494
--- /dev/null
+++ b/benchmark/results/SablierV2LockupTranched.md
@@ -0,0 +1,31 @@
+# Benchmarks for LockupTranched
+
+| Implementation | Gas Usage |
+| ---------------------------------------------------------- | --------- |
+| `burn` | 15738 |
+| `cancel` | 63994 |
+| `renounce` | 26501 |
+| `createWithDurations` (2 tranches) (Broker fee set) | 199536 |
+| `createWithDurations` (2 tranches) (Broker fee not set) | 183969 |
+| `createWithTimestamps` (2 tranches) (Broker fee set) | 189410 |
+| `createWithTimestamps` (2 tranches) (Broker fee not set) | 183945 |
+| `withdraw` (2 tranches) (After End Time) (by Recipient) | 20100 |
+| `withdraw` (2 tranches) (Before End Time) (by Recipient) | 14797 |
+| `withdraw` (2 tranches) (After End Time) (by Anyone) | 15199 |
+| `withdraw` (2 tranches) (Before End Time) (by Anyone) | 14695 |
+| `createWithDurations` (10 tranches) (Broker fee set) | 388757 |
+| `createWithDurations` (10 tranches) (Broker fee not set) | 383998 |
+| `createWithTimestamps` (10 tranches) (Broker fee set) | 397102 |
+| `createWithTimestamps` (10 tranches) (Broker fee not set) | 391750 |
+| `withdraw` (10 tranches) (After End Time) (by Recipient) | 17855 |
+| `withdraw` (10 tranches) (Before End Time) (by Recipient) | 19616 |
+| `withdraw` (10 tranches) (After End Time) (by Anyone) | 17760 |
+| `withdraw` (10 tranches) (Before End Time) (by Anyone) | 19514 |
+| `createWithDurations` (100 tranches) (Broker fee set) | 2672918 |
+| `createWithDurations` (100 tranches) (Broker fee not set) | 2668643 |
+| `createWithTimestamps` (100 tranches) (Broker fee set) | 2738297 |
+| `createWithTimestamps` (100 tranches) (Broker fee not set) | 2734635 |
+| `withdraw` (100 tranches) (After End Time) (by Recipient) | 46746 |
+| `withdraw` (100 tranches) (Before End Time) (by Recipient) | 73989 |
+| `withdraw` (100 tranches) (After End Time) (by Anyone) | 46644 |
+| `withdraw` (100 tranches) (Before End Time) (by Anyone) | 73887 |
diff --git a/bun.lockb b/bun.lockb
new file mode 100755
index 000000000..c7900ccb4
Binary files /dev/null and b/bun.lockb differ
diff --git a/codecov.yml b/codecov.yml
index eca34cf1b..1ab56482e 100644
--- a/codecov.yml
+++ b/codecov.yml
@@ -5,6 +5,7 @@ coverage:
status:
patch: off
ignore:
+ - "precompiles"
- "script"
- "src/libraries/NFTSVG.sol"
- "src/libraries/SVGElements.sol"
diff --git a/foundry.toml b/foundry.toml
index be5079296..a95fb8642 100644
--- a/foundry.toml
+++ b/foundry.toml
@@ -1,13 +1,17 @@
[profile.default]
auto_detect_solc = false
bytecode_hash = "none"
- emv_version = "paris"
- fs_permissions = [{ access = "read", path = "out-optimized" }]
- libs = ["lib"]
+ evm_version = "shanghai"
+ fs_permissions = [
+ { access = "read", path = "./out-optimized" },
+ { access = "read", path = "package.json" },
+ { access = "read-write", path = "./benchmark/results" },
+ ]
+ gas_limit = 9223372036854775807
gas_reports = [
- "SablierV2Comptroller",
"SablierV2LockupDynamic",
"SablierV2LockupLinear",
+ "SablierV2LockupTranched",
"SablierV2NFTDescriptor",
]
optimizer = true
@@ -15,7 +19,7 @@
out = "out"
script = "script"
sender = "0x1804c8AB1F12E6bbf3894d4083f33e07309d1f38"
- solc = "0.8.23"
+ solc = "0.8.26"
src = "src"
test = "test"
@@ -29,6 +33,10 @@
fail_on_revert = true
runs = 20
+# Run only the code inside benchmark directory
+[profile.benchmark]
+ test = "benchmark"
+
# Speed up compilation and tests during development
[profile.lite]
optimizer = false
@@ -68,6 +76,7 @@
[profile.smt.model_checker.contracts]
"src/SablierV2LockupDynamic.sol" = ["SablierV2LockupDynamic"]
"src/SablierV2LockupLinear.sol" = ["SablierV2LockupLinear"]
+ "src/SablierV2LockupTranched.sol" = ["SablierV2LockupTranched"]
"src/SablierV2NFTDescriptor.sol" = ["SablierV2NFTDescriptor"]
# Test the optimized contracts without re-compiling them
@@ -79,16 +88,6 @@
out = "docs"
repository = "https://github.com/sablier-labs/v2-core"
-[etherscan]
- arbitrum = { key = "${API_KEY_ARBISCAN}" }
- avalanche = { key = "${API_KEY_SNOWTRACE" }
- bnb_smart_chain = { key = "${API_KEY_BSCSCAN}" }
- gnosis_chain = { key = "${API_KEY_GNOSISSCAN}" }
- mainnet = { key = "${API_KEY_ETHERSCAN}" }
- optimism = { key = "${API_KEY_OPTIMISTIC_ETHERSCAN}" }
- polygon = { key = "${API_KEY_POLYGONSCAN}" }
- sepolia = { key = "${API_KEY_ETHERSCAN}" }
-
[fmt]
bracket_spacing = true
int_types = "long"
@@ -102,9 +101,11 @@
[rpc_endpoints]
arbitrum = "https://arbitrum-mainnet.infura.io/v3/${API_KEY_INFURA}"
avalanche = "https://avalanche-mainnet.infura.io/v3/${API_KEY_INFURA}"
- bnb_smart_chain = "https://bsc-dataseed.binance.org"
- gnosis_chain = "https://rpc.gnosischain.com"
+ base = "https://mainnet.base.org"
+ bnb = "https://bsc-dataseed.binance.org"
+ gnosis = "https://rpc.gnosischain.com"
localhost = "http://localhost:8545"
+ ethereum = "${RPC_URL_MAINNET}"
mainnet = "${RPC_URL_MAINNET}"
optimism = "https://optimism-mainnet.infura.io/v3/${API_KEY_INFURA}"
polygon = "https://polygon-mainnet.infura.io/v3/${API_KEY_INFURA}"
diff --git a/funding.json b/funding.json
new file mode 100644
index 000000000..c47fccfee
--- /dev/null
+++ b/funding.json
@@ -0,0 +1,5 @@
+{
+ "opRetro": {
+ "projectId": "0x7262ed9c020b3b41ac7ba405aab4ff37575f8b6f975ebed2e65554a08419f8f4"
+ }
+}
diff --git a/package.json b/package.json
index 968765499..c8138bf07 100644
--- a/package.json
+++ b/package.json
@@ -2,7 +2,7 @@
"name": "@sablier/v2-core",
"description": "Core smart contracts of the Sablier V2 token distribution protocol",
"license": "BUSL-1.1",
- "version": "1.1.2",
+ "version": "1.2.0",
"author": {
"name": "Sablier Labs Ltd",
"url": "https://sablier.com"
@@ -11,19 +11,19 @@
"url": "https://github.com/sablier-labs/v2-core/issues"
},
"dependencies": {
- "@openzeppelin/contracts": "4.9.2",
- "@prb/math": "4.0.2"
+ "@openzeppelin/contracts": "5.0.2",
+ "@prb/math": "4.0.3"
},
"devDependencies": {
- "@prb/test": "0.6.4",
- "forge-std": "github:foundry-rs/forge-std#v1.5.6",
- "prettier": "^2.8.8",
- "solady": "0.0.129",
- "solarray": "github:evmcheb/solarray#0625e7e",
- "solhint": "^4.0.0"
+ "forge-std": "github:foundry-rs/forge-std#v1.8.2",
+ "prettier": "^3.3.2",
+ "solady": "0.0.208",
+ "solarray": "github:evmcheb/solarray#a547630",
+ "solhint": "^5.0.1"
},
"files": [
"artifacts",
+ "precompiles",
"src",
"test/utils",
"CHANGELOG.md",
@@ -58,20 +58,18 @@
},
"repository": "github.com/sablier-labs/v2-core",
"scripts": {
+ "benchmark": "bun run build:optimized && FOUNDRY_PROFILE=benchmark forge test --mt testGas && bun run prettier:write",
"build": "forge build",
"build:optimized": "FOUNDRY_PROFILE=optimized forge build",
"build:smt": "FOUNDRY_PROFILE=smt forge build",
"clean": "rm -rf artifacts broadcast cache docs out out-optimized out-svg",
- "gas:report": "forge test --gas-report --mp \"./test/integration/**/*.sol\" --nmt \"test(Fuzz)?_RevertWhen_\\w{1,}?\"",
- "gas:snapshot": "forge snapshot --mp \"./test/integration/**/*.sol\" --nmt \"test(Fuzz)?_RevertWhen_\\w{1,}?\"",
- "gas:snapshot:optimized": "pnpm build:optimized && FOUNDRY_PROFILE=test-optimized forge snapshot --mp \"./test/integration/**/*.sol\" --nmt \"test(Fork)?(Fuzz)?_RevertWhen_\\w{1,}?\"",
- "lint": "pnpm lint:sol && pnpm prettier:check",
- "lint:sol": "forge fmt --check && pnpm solhint \"{script,src,test}/**/*.sol\"",
- "prepack": "bash ./shell/prepare-artifacts.sh",
+ "lint": "bun run lint:sol && bun run prettier:check",
+ "lint:sol": "forge fmt --check && bun solhint \"{precompiles,script,src,test}/**/*.sol\"",
+ "prepack": "bun install && bash ./shell/prepare-artifacts.sh",
"prettier:check": "prettier --check \"**/*.{json,md,svg,yml}\"",
"prettier:write": "prettier --write \"**/*.{json,md,svg,yml}\"",
"test": "forge test",
"test:lite": "FOUNDRY_PROFILE=lite forge test",
- "test:optimized": "pnpm build:optimized && FOUNDRY_PROFILE=test-optimized forge test"
+ "test:optimized": "bun run build:optimized && FOUNDRY_PROFILE=test-optimized forge test"
}
}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
deleted file mode 100644
index 1b136c4d2..000000000
--- a/pnpm-lock.yaml
+++ /dev/null
@@ -1,738 +0,0 @@
-lockfileVersion: '6.0'
-
-settings:
- autoInstallPeers: true
- excludeLinksFromLockfile: false
-
-dependencies:
- '@openzeppelin/contracts':
- specifier: 4.9.2
- version: 4.9.2
- '@prb/math':
- specifier: 4.0.2
- version: 4.0.2
-
-devDependencies:
- '@prb/test':
- specifier: 0.6.4
- version: 0.6.4
- forge-std:
- specifier: github:foundry-rs/forge-std#v1.5.6
- version: github.com/foundry-rs/forge-std/e8a047e3f40f13fa37af6fe14e6e06283d9a060e
- prettier:
- specifier: ^2.8.8
- version: 2.8.8
- solady:
- specifier: 0.0.129
- version: 0.0.129
- solarray:
- specifier: github:evmcheb/solarray#0625e7e
- version: github.com/evmcheb/solarray/0625e7e
- solhint:
- specifier: ^4.0.0
- version: 4.0.0
-
-packages:
-
- /@babel/code-frame@7.22.5:
- resolution: {integrity: sha512-Xmwn266vad+6DAqEB2A6V/CcZVp62BbwVmcOJc2RPuwih1kw02TjQvWVWlcKGbBPd+8/0V5DEkOcizRGYsspYQ==}
- engines: {node: '>=6.9.0'}
- dependencies:
- '@babel/highlight': 7.22.5
- dev: true
-
- /@babel/helper-validator-identifier@7.22.5:
- resolution: {integrity: sha512-aJXu+6lErq8ltp+JhkJUfk1MTGyuA4v7f3pA+BJ5HLfNC6nAQ0Cpi9uOquUj8Hehg0aUiHzWQbOVJGao6ztBAQ==}
- engines: {node: '>=6.9.0'}
- dev: true
-
- /@babel/highlight@7.22.5:
- resolution: {integrity: sha512-BSKlD1hgnedS5XRnGOljZawtag7H1yPfQp0tdNJCHoH6AZ+Pcm9VvkrK59/Yy593Ypg0zMxH2BxD1VPYUQ7UIw==}
- engines: {node: '>=6.9.0'}
- dependencies:
- '@babel/helper-validator-identifier': 7.22.5
- chalk: 2.4.2
- js-tokens: 4.0.0
- dev: true
-
- /@openzeppelin/contracts@4.9.2:
- resolution: {integrity: sha512-mO+y6JaqXjWeMh9glYVzVu8HYPGknAAnWyxTRhGeckOruyXQMNnlcW6w/Dx9ftLeIQk6N+ZJFuVmTwF7lEIFrg==}
- dev: false
-
- /@pnpm/config.env-replace@1.1.0:
- resolution: {integrity: sha512-htyl8TWnKL7K/ESFa1oW2UB5lVDxuF5DpM7tBi6Hu2LNL3mWkIzNLG6N4zoCUP1lCKNxWy/3iu8mS8MvToGd6w==}
- engines: {node: '>=12.22.0'}
- dev: true
-
- /@pnpm/network.ca-file@1.0.2:
- resolution: {integrity: sha512-YcPQ8a0jwYU9bTdJDpXjMi7Brhkr1mXsXrUJvjqM2mQDgkRiz8jFaQGOdaLxgjtUfQgZhKy/O3cG/YwmgKaxLA==}
- engines: {node: '>=12.22.0'}
- dependencies:
- graceful-fs: 4.2.10
- dev: true
-
- /@pnpm/npm-conf@2.2.2:
- resolution: {integrity: sha512-UA91GwWPhFExt3IizW6bOeY/pQ0BkuNwKjk9iQW9KqxluGCrg4VenZ0/L+2Y0+ZOtme72EVvg6v0zo3AMQRCeA==}
- engines: {node: '>=12'}
- dependencies:
- '@pnpm/config.env-replace': 1.1.0
- '@pnpm/network.ca-file': 1.0.2
- config-chain: 1.1.13
- dev: true
-
- /@prb/math@4.0.2:
- resolution: {integrity: sha512-kJgqvXR6iyU7+N959RzggSFhBdnRuSDnc/bs8u6MzdWw7aYIUaAr+uMVdpP6Dheypjerd7sfJgFOs19FRFhscg==}
- dev: false
-
- /@prb/test@0.6.4:
- resolution: {integrity: sha512-P0tTMsB6XQ0Wp61EYdXJYFhsOVGyZvcOFub2y9yk0sF+GYDusctR7DzEI+vOP0SILm3knFkEJASjewHEBppdRQ==}
- dev: true
-
- /@sindresorhus/is@5.6.0:
- resolution: {integrity: sha512-TV7t8GKYaJWsn00tFDqBw8+Uqmr8A0fRU1tvTQhyZzGv0sJCGRQL3JGMI3ucuKo3XIZdUP+Lx7/gh2t3lewy7g==}
- engines: {node: '>=14.16'}
- dev: true
-
- /@solidity-parser/parser@0.16.0:
- resolution: {integrity: sha512-ESipEcHyRHg4Np4SqBCfcXwyxxna1DgFVz69bgpLV8vzl/NP1DtcKsJ4dJZXWQhY/Z4J2LeKBiOkOVZn9ct33Q==}
- dependencies:
- antlr4ts: 0.5.0-alpha.4
- dev: true
-
- /@szmarczak/http-timer@5.0.1:
- resolution: {integrity: sha512-+PmQX0PiAYPMeVYe237LJAYvOMYW1j2rH5YROyS3b4CTVJum34HfRvKvAzozHAQG0TnHNdUfY9nCeUyRAs//cw==}
- engines: {node: '>=14.16'}
- dependencies:
- defer-to-connect: 2.0.1
- dev: true
-
- /@types/http-cache-semantics@4.0.4:
- resolution: {integrity: sha512-1m0bIFVc7eJWyve9S0RnuRgcQqF/Xd5QsUZAZeQFr1Q3/p9JWoQQEqmVy+DPTNpGXwhgIetAoYF8JSc33q29QA==}
- dev: true
-
- /ajv@6.12.6:
- resolution: {integrity: sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==}
- dependencies:
- fast-deep-equal: 3.1.3
- fast-json-stable-stringify: 2.1.0
- json-schema-traverse: 0.4.1
- uri-js: 4.4.1
- dev: true
-
- /ajv@8.12.0:
- resolution: {integrity: sha512-sRu1kpcO9yLtYxBKvqfTeh9KzZEwO3STyX1HT+4CaDzC6HpTGYhIhPIzj9XuKU7KYDwnaeh5hcOwjy1QuJzBPA==}
- dependencies:
- fast-deep-equal: 3.1.3
- json-schema-traverse: 1.0.0
- require-from-string: 2.0.2
- uri-js: 4.4.1
- dev: true
-
- /ansi-regex@5.0.1:
- resolution: {integrity: sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==}
- engines: {node: '>=8'}
- dev: true
-
- /ansi-styles@3.2.1:
- resolution: {integrity: sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==}
- engines: {node: '>=4'}
- dependencies:
- color-convert: 1.9.3
- dev: true
-
- /ansi-styles@4.3.0:
- resolution: {integrity: sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==}
- engines: {node: '>=8'}
- dependencies:
- color-convert: 2.0.1
- dev: true
-
- /antlr4@4.13.0:
- resolution: {integrity: sha512-zooUbt+UscjnWyOrsuY/tVFL4rwrAGwOivpQmvmUDE22hy/lUA467Rc1rcixyRwcRUIXFYBwv7+dClDSHdmmew==}
- engines: {node: '>=16'}
- dev: true
-
- /antlr4ts@0.5.0-alpha.4:
- resolution: {integrity: sha512-WPQDt1B74OfPv/IMS2ekXAKkTZIHl88uMetg6q3OTqgFxZ/dxDXI0EWLyZid/1Pe6hTftyg5N7gel5wNAGxXyQ==}
- dev: true
-
- /argparse@2.0.1:
- resolution: {integrity: sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==}
- dev: true
-
- /ast-parents@0.0.1:
- resolution: {integrity: sha512-XHusKxKz3zoYk1ic8Un640joHbFMhbqneyoZfoKnEGtf2ey9Uh/IdpcQplODdO/kENaMIWsD0nJm4+wX3UNLHA==}
- dev: true
-
- /astral-regex@2.0.0:
- resolution: {integrity: sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==}
- engines: {node: '>=8'}
- dev: true
-
- /balanced-match@1.0.2:
- resolution: {integrity: sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==}
- dev: true
-
- /brace-expansion@2.0.1:
- resolution: {integrity: sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==}
- dependencies:
- balanced-match: 1.0.2
- dev: true
-
- /cacheable-lookup@7.0.0:
- resolution: {integrity: sha512-+qJyx4xiKra8mZrcwhjMRMUhD5NR1R8esPkzIYxX96JiecFoxAXFuz/GpR3+ev4PE1WamHip78wV0vcmPQtp8w==}
- engines: {node: '>=14.16'}
- dev: true
-
- /cacheable-request@10.2.14:
- resolution: {integrity: sha512-zkDT5WAF4hSSoUgyfg5tFIxz8XQK+25W/TLVojJTMKBaxevLBBtLxgqguAuVQB8PVW79FVjHcU+GJ9tVbDZ9mQ==}
- engines: {node: '>=14.16'}
- dependencies:
- '@types/http-cache-semantics': 4.0.4
- get-stream: 6.0.1
- http-cache-semantics: 4.1.1
- keyv: 4.5.4
- mimic-response: 4.0.0
- normalize-url: 8.0.0
- responselike: 3.0.0
- dev: true
-
- /callsites@3.1.0:
- resolution: {integrity: sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==}
- engines: {node: '>=6'}
- dev: true
-
- /chalk@2.4.2:
- resolution: {integrity: sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==}
- engines: {node: '>=4'}
- dependencies:
- ansi-styles: 3.2.1
- escape-string-regexp: 1.0.5
- supports-color: 5.5.0
- dev: true
-
- /chalk@4.1.2:
- resolution: {integrity: sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==}
- engines: {node: '>=10'}
- dependencies:
- ansi-styles: 4.3.0
- supports-color: 7.2.0
- dev: true
-
- /color-convert@1.9.3:
- resolution: {integrity: sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==}
- dependencies:
- color-name: 1.1.3
- dev: true
-
- /color-convert@2.0.1:
- resolution: {integrity: sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==}
- engines: {node: '>=7.0.0'}
- dependencies:
- color-name: 1.1.4
- dev: true
-
- /color-name@1.1.3:
- resolution: {integrity: sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==}
- dev: true
-
- /color-name@1.1.4:
- resolution: {integrity: sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==}
- dev: true
-
- /commander@10.0.1:
- resolution: {integrity: sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug==}
- engines: {node: '>=14'}
- dev: true
-
- /config-chain@1.1.13:
- resolution: {integrity: sha512-qj+f8APARXHrM0hraqXYb2/bOVSV4PvJQlNZ/DVj0QrmNM2q2euizkeuVckQ57J+W0mRH6Hvi+k50M4Jul2VRQ==}
- dependencies:
- ini: 1.3.8
- proto-list: 1.2.4
- dev: true
-
- /cosmiconfig@8.2.0:
- resolution: {integrity: sha512-3rTMnFJA1tCOPwRxtgF4wd7Ab2qvDbL8jX+3smjIbS4HlZBagTlpERbdN7iAbWlrfxE3M8c27kTwTawQ7st+OQ==}
- engines: {node: '>=14'}
- dependencies:
- import-fresh: 3.3.0
- js-yaml: 4.1.0
- parse-json: 5.2.0
- path-type: 4.0.0
- dev: true
-
- /decompress-response@6.0.0:
- resolution: {integrity: sha512-aW35yZM6Bb/4oJlZncMH2LCoZtJXTRxES17vE3hoRiowU2kWHaJKFkSBDnDR+cm9J+9QhXmREyIfv0pji9ejCQ==}
- engines: {node: '>=10'}
- dependencies:
- mimic-response: 3.1.0
- dev: true
-
- /deep-extend@0.6.0:
- resolution: {integrity: sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==}
- engines: {node: '>=4.0.0'}
- dev: true
-
- /defer-to-connect@2.0.1:
- resolution: {integrity: sha512-4tvttepXG1VaYGrRibk5EwJd1t4udunSOVMdLSAL6mId1ix438oPwPZMALY41FCijukO1L0twNcGsdzS7dHgDg==}
- engines: {node: '>=10'}
- dev: true
-
- /emoji-regex@8.0.0:
- resolution: {integrity: sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==}
- dev: true
-
- /error-ex@1.3.2:
- resolution: {integrity: sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==}
- dependencies:
- is-arrayish: 0.2.1
- dev: true
-
- /escape-string-regexp@1.0.5:
- resolution: {integrity: sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==}
- engines: {node: '>=0.8.0'}
- dev: true
-
- /fast-deep-equal@3.1.3:
- resolution: {integrity: sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==}
- dev: true
-
- /fast-diff@1.3.0:
- resolution: {integrity: sha512-VxPP4NqbUjj6MaAOafWeUn2cXWLcCtljklUtZf0Ind4XQ+QPtmA0b18zZy0jIQx+ExRVCR/ZQpBmik5lXshNsw==}
- dev: true
-
- /fast-json-stable-stringify@2.1.0:
- resolution: {integrity: sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==}
- dev: true
-
- /form-data-encoder@2.1.4:
- resolution: {integrity: sha512-yDYSgNMraqvnxiEXO4hi88+YZxaHC6QKzb5N84iRCTDeRO7ZALpir/lVmf/uXUhnwUr2O4HU8s/n6x+yNjQkHw==}
- engines: {node: '>= 14.17'}
- dev: true
-
- /fs.realpath@1.0.0:
- resolution: {integrity: sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==}
- dev: true
-
- /get-stream@6.0.1:
- resolution: {integrity: sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==}
- engines: {node: '>=10'}
- dev: true
-
- /glob@8.1.0:
- resolution: {integrity: sha512-r8hpEjiQEYlF2QU0df3dS+nxxSIreXQS1qRhMJM0Q5NDdR386C7jb7Hwwod8Fgiuex+k0GFjgft18yvxm5XoCQ==}
- engines: {node: '>=12'}
- dependencies:
- fs.realpath: 1.0.0
- inflight: 1.0.6
- inherits: 2.0.4
- minimatch: 5.1.6
- once: 1.4.0
- dev: true
-
- /got@12.6.1:
- resolution: {integrity: sha512-mThBblvlAF1d4O5oqyvN+ZxLAYwIJK7bpMxgYqPD9okW0C3qm5FFn7k811QrcuEBwaogR3ngOFoCfs6mRv7teQ==}
- engines: {node: '>=14.16'}
- dependencies:
- '@sindresorhus/is': 5.6.0
- '@szmarczak/http-timer': 5.0.1
- cacheable-lookup: 7.0.0
- cacheable-request: 10.2.14
- decompress-response: 6.0.0
- form-data-encoder: 2.1.4
- get-stream: 6.0.1
- http2-wrapper: 2.2.1
- lowercase-keys: 3.0.0
- p-cancelable: 3.0.0
- responselike: 3.0.0
- dev: true
-
- /graceful-fs@4.2.10:
- resolution: {integrity: sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA==}
- dev: true
-
- /has-flag@3.0.0:
- resolution: {integrity: sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==}
- engines: {node: '>=4'}
- dev: true
-
- /has-flag@4.0.0:
- resolution: {integrity: sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==}
- engines: {node: '>=8'}
- dev: true
-
- /http-cache-semantics@4.1.1:
- resolution: {integrity: sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ==}
- dev: true
-
- /http2-wrapper@2.2.1:
- resolution: {integrity: sha512-V5nVw1PAOgfI3Lmeaj2Exmeg7fenjhRUgz1lPSezy1CuhPYbgQtbQj4jZfEAEMlaL+vupsvhjqCyjzob0yxsmQ==}
- engines: {node: '>=10.19.0'}
- dependencies:
- quick-lru: 5.1.1
- resolve-alpn: 1.2.1
- dev: true
-
- /ignore@5.2.4:
- resolution: {integrity: sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ==}
- engines: {node: '>= 4'}
- dev: true
-
- /import-fresh@3.3.0:
- resolution: {integrity: sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==}
- engines: {node: '>=6'}
- dependencies:
- parent-module: 1.0.1
- resolve-from: 4.0.0
- dev: true
-
- /inflight@1.0.6:
- resolution: {integrity: sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==}
- dependencies:
- once: 1.4.0
- wrappy: 1.0.2
- dev: true
-
- /inherits@2.0.4:
- resolution: {integrity: sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==}
- dev: true
-
- /ini@1.3.8:
- resolution: {integrity: sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==}
- dev: true
-
- /is-arrayish@0.2.1:
- resolution: {integrity: sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==}
- dev: true
-
- /is-fullwidth-code-point@3.0.0:
- resolution: {integrity: sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==}
- engines: {node: '>=8'}
- dev: true
-
- /js-tokens@4.0.0:
- resolution: {integrity: sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==}
- dev: true
-
- /js-yaml@4.1.0:
- resolution: {integrity: sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==}
- hasBin: true
- dependencies:
- argparse: 2.0.1
- dev: true
-
- /json-buffer@3.0.1:
- resolution: {integrity: sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==}
- dev: true
-
- /json-parse-even-better-errors@2.3.1:
- resolution: {integrity: sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==}
- dev: true
-
- /json-schema-traverse@0.4.1:
- resolution: {integrity: sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==}
- dev: true
-
- /json-schema-traverse@1.0.0:
- resolution: {integrity: sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==}
- dev: true
-
- /keyv@4.5.4:
- resolution: {integrity: sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==}
- dependencies:
- json-buffer: 3.0.1
- dev: true
-
- /latest-version@7.0.0:
- resolution: {integrity: sha512-KvNT4XqAMzdcL6ka6Tl3i2lYeFDgXNCuIX+xNx6ZMVR1dFq+idXd9FLKNMOIx0t9mJ9/HudyX4oZWXZQ0UJHeg==}
- engines: {node: '>=14.16'}
- dependencies:
- package-json: 8.1.1
- dev: true
-
- /lines-and-columns@1.2.4:
- resolution: {integrity: sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==}
- dev: true
-
- /lodash.truncate@4.4.2:
- resolution: {integrity: sha512-jttmRe7bRse52OsWIMDLaXxWqRAmtIUccAQ3garviCqJjafXOfNMO0yMfNpdD6zbGaTU0P5Nz7e7gAT6cKmJRw==}
- dev: true
-
- /lodash@4.17.21:
- resolution: {integrity: sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==}
- dev: true
-
- /lowercase-keys@3.0.0:
- resolution: {integrity: sha512-ozCC6gdQ+glXOQsveKD0YsDy8DSQFjDTz4zyzEHNV5+JP5D62LmfDZ6o1cycFx9ouG940M5dE8C8CTewdj2YWQ==}
- engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0}
- dev: true
-
- /lru-cache@6.0.0:
- resolution: {integrity: sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==}
- engines: {node: '>=10'}
- dependencies:
- yallist: 4.0.0
- dev: true
-
- /mimic-response@3.1.0:
- resolution: {integrity: sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ==}
- engines: {node: '>=10'}
- dev: true
-
- /mimic-response@4.0.0:
- resolution: {integrity: sha512-e5ISH9xMYU0DzrT+jl8q2ze9D6eWBto+I8CNpe+VI+K2J/F/k3PdkdTdz4wvGVH4NTpo+NRYTVIuMQEMMcsLqg==}
- engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0}
- dev: true
-
- /minimatch@5.1.6:
- resolution: {integrity: sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==}
- engines: {node: '>=10'}
- dependencies:
- brace-expansion: 2.0.1
- dev: true
-
- /minimist@1.2.8:
- resolution: {integrity: sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==}
- dev: true
-
- /normalize-url@8.0.0:
- resolution: {integrity: sha512-uVFpKhj5MheNBJRTiMZ9pE/7hD1QTeEvugSJW/OmLzAp78PB5O6adfMNTvmfKhXBkvCzC+rqifWcVYpGFwTjnw==}
- engines: {node: '>=14.16'}
- dev: true
-
- /once@1.4.0:
- resolution: {integrity: sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==}
- dependencies:
- wrappy: 1.0.2
- dev: true
-
- /p-cancelable@3.0.0:
- resolution: {integrity: sha512-mlVgR3PGuzlo0MmTdk4cXqXWlwQDLnONTAg6sm62XkMJEiRxN3GL3SffkYvqwonbkJBcrI7Uvv5Zh9yjvn2iUw==}
- engines: {node: '>=12.20'}
- dev: true
-
- /package-json@8.1.1:
- resolution: {integrity: sha512-cbH9IAIJHNj9uXi196JVsRlt7cHKak6u/e6AkL/bkRelZ7rlL3X1YKxsZwa36xipOEKAsdtmaG6aAJoM1fx2zA==}
- engines: {node: '>=14.16'}
- dependencies:
- got: 12.6.1
- registry-auth-token: 5.0.2
- registry-url: 6.0.1
- semver: 7.5.4
- dev: true
-
- /parent-module@1.0.1:
- resolution: {integrity: sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==}
- engines: {node: '>=6'}
- dependencies:
- callsites: 3.1.0
- dev: true
-
- /parse-json@5.2.0:
- resolution: {integrity: sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==}
- engines: {node: '>=8'}
- dependencies:
- '@babel/code-frame': 7.22.5
- error-ex: 1.3.2
- json-parse-even-better-errors: 2.3.1
- lines-and-columns: 1.2.4
- dev: true
-
- /path-type@4.0.0:
- resolution: {integrity: sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==}
- engines: {node: '>=8'}
- dev: true
-
- /pluralize@8.0.0:
- resolution: {integrity: sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==}
- engines: {node: '>=4'}
- dev: true
-
- /prettier@2.8.8:
- resolution: {integrity: sha512-tdN8qQGvNjw4CHbY+XXk0JgCXn9QiF21a55rBe5LJAU+kDyC4WQn4+awm2Xfk2lQMk5fKup9XgzTZtGkjBdP9Q==}
- engines: {node: '>=10.13.0'}
- hasBin: true
- dev: true
-
- /proto-list@1.2.4:
- resolution: {integrity: sha512-vtK/94akxsTMhe0/cbfpR+syPuszcuwhqVjJq26CuNDgFGj682oRBXOP5MJpv2r7JtE8MsiepGIqvvOTBwn2vA==}
- dev: true
-
- /punycode@2.3.0:
- resolution: {integrity: sha512-rRV+zQD8tVFys26lAGR9WUuS4iUAngJScM+ZRSKtvl5tKeZ2t5bvdNFdNHBW9FWR4guGHlgmsZ1G7BSm2wTbuA==}
- engines: {node: '>=6'}
- dev: true
-
- /quick-lru@5.1.1:
- resolution: {integrity: sha512-WuyALRjWPDGtt/wzJiadO5AXY+8hZ80hVpe6MyivgraREW751X3SbhRvG3eLKOYN+8VEvqLcf3wdnt44Z4S4SA==}
- engines: {node: '>=10'}
- dev: true
-
- /rc@1.2.8:
- resolution: {integrity: sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==}
- hasBin: true
- dependencies:
- deep-extend: 0.6.0
- ini: 1.3.8
- minimist: 1.2.8
- strip-json-comments: 2.0.1
- dev: true
-
- /registry-auth-token@5.0.2:
- resolution: {integrity: sha512-o/3ikDxtXaA59BmZuZrJZDJv8NMDGSj+6j6XaeBmHw8eY1i1qd9+6H+LjVvQXx3HN6aRCGa1cUdJ9RaJZUugnQ==}
- engines: {node: '>=14'}
- dependencies:
- '@pnpm/npm-conf': 2.2.2
- dev: true
-
- /registry-url@6.0.1:
- resolution: {integrity: sha512-+crtS5QjFRqFCoQmvGduwYWEBng99ZvmFvF+cUJkGYF1L1BfU8C6Zp9T7f5vPAwyLkUExpvK+ANVZmGU49qi4Q==}
- engines: {node: '>=12'}
- dependencies:
- rc: 1.2.8
- dev: true
-
- /require-from-string@2.0.2:
- resolution: {integrity: sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==}
- engines: {node: '>=0.10.0'}
- dev: true
-
- /resolve-alpn@1.2.1:
- resolution: {integrity: sha512-0a1F4l73/ZFZOakJnQ3FvkJ2+gSTQWz/r2KE5OdDY0TxPm5h4GkqkWWfM47T7HsbnOtcJVEF4epCVy6u7Q3K+g==}
- dev: true
-
- /resolve-from@4.0.0:
- resolution: {integrity: sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==}
- engines: {node: '>=4'}
- dev: true
-
- /responselike@3.0.0:
- resolution: {integrity: sha512-40yHxbNcl2+rzXvZuVkrYohathsSJlMTXKryG5y8uciHv1+xDLHQpgjG64JUO9nrEq2jGLH6IZ8BcZyw3wrweg==}
- engines: {node: '>=14.16'}
- dependencies:
- lowercase-keys: 3.0.0
- dev: true
-
- /semver@7.5.4:
- resolution: {integrity: sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==}
- engines: {node: '>=10'}
- hasBin: true
- dependencies:
- lru-cache: 6.0.0
- dev: true
-
- /slice-ansi@4.0.0:
- resolution: {integrity: sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==}
- engines: {node: '>=10'}
- dependencies:
- ansi-styles: 4.3.0
- astral-regex: 2.0.0
- is-fullwidth-code-point: 3.0.0
- dev: true
-
- /solady@0.0.129:
- resolution: {integrity: sha512-2i+8lsLLT7nAED+A9C+ZLi8YmpSnUNKGKozkesN2Qm3P3iMvorXAsD5LyT1MAC3eyVfhY3PuvBkvgd31nUzkoQ==}
- dev: true
-
- /solhint@4.0.0:
- resolution: {integrity: sha512-bFViMcFvhqVd/HK3Roo7xZXX5nbujS7Bxeg5vnZc9QvH0yCWCrQ38Yrn1pbAY9tlKROc6wFr+rK1mxYgYrjZgA==}
- hasBin: true
- dependencies:
- '@solidity-parser/parser': 0.16.0
- ajv: 6.12.6
- antlr4: 4.13.0
- ast-parents: 0.0.1
- chalk: 4.1.2
- commander: 10.0.1
- cosmiconfig: 8.2.0
- fast-diff: 1.3.0
- glob: 8.1.0
- ignore: 5.2.4
- js-yaml: 4.1.0
- latest-version: 7.0.0
- lodash: 4.17.21
- pluralize: 8.0.0
- semver: 7.5.4
- strip-ansi: 6.0.1
- table: 6.8.1
- text-table: 0.2.0
- optionalDependencies:
- prettier: 2.8.8
- dev: true
-
- /string-width@4.2.3:
- resolution: {integrity: sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==}
- engines: {node: '>=8'}
- dependencies:
- emoji-regex: 8.0.0
- is-fullwidth-code-point: 3.0.0
- strip-ansi: 6.0.1
- dev: true
-
- /strip-ansi@6.0.1:
- resolution: {integrity: sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==}
- engines: {node: '>=8'}
- dependencies:
- ansi-regex: 5.0.1
- dev: true
-
- /strip-json-comments@2.0.1:
- resolution: {integrity: sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==}
- engines: {node: '>=0.10.0'}
- dev: true
-
- /supports-color@5.5.0:
- resolution: {integrity: sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==}
- engines: {node: '>=4'}
- dependencies:
- has-flag: 3.0.0
- dev: true
-
- /supports-color@7.2.0:
- resolution: {integrity: sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==}
- engines: {node: '>=8'}
- dependencies:
- has-flag: 4.0.0
- dev: true
-
- /table@6.8.1:
- resolution: {integrity: sha512-Y4X9zqrCftUhMeH2EptSSERdVKt/nEdijTOacGD/97EKjhQ/Qs8RTlEGABSJNNN8lac9kheH+af7yAkEWlgneA==}
- engines: {node: '>=10.0.0'}
- dependencies:
- ajv: 8.12.0
- lodash.truncate: 4.4.2
- slice-ansi: 4.0.0
- string-width: 4.2.3
- strip-ansi: 6.0.1
- dev: true
-
- /text-table@0.2.0:
- resolution: {integrity: sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw==}
- dev: true
-
- /uri-js@4.4.1:
- resolution: {integrity: sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==}
- dependencies:
- punycode: 2.3.0
- dev: true
-
- /wrappy@1.0.2:
- resolution: {integrity: sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==}
- dev: true
-
- /yallist@4.0.0:
- resolution: {integrity: sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==}
- dev: true
-
- github.com/evmcheb/solarray/0625e7e:
- resolution: {tarball: https://codeload.github.com/evmcheb/solarray/tar.gz/0625e7e}
- name: solarray#0625e7e
- version: 0.0.0
- dev: true
-
- github.com/foundry-rs/forge-std/e8a047e3f40f13fa37af6fe14e6e06283d9a060e:
- resolution: {tarball: https://codeload.github.com/foundry-rs/forge-std/tar.gz/e8a047e3f40f13fa37af6fe14e6e06283d9a060e}
- name: forge-std
- version: 1.5.6
- dev: true
diff --git a/precompiles/Precompiles.sol b/precompiles/Precompiles.sol
new file mode 100644
index 000000000..a2fea12b5
--- /dev/null
+++ b/precompiles/Precompiles.sol
@@ -0,0 +1,200 @@
+// SPDX-License-Identifier: BUSL-1.1
+// solhint-disable max-line-length,no-inline-assembly,reason-string
+pragma solidity >=0.8.22;
+
+import { ISablierV2LockupDynamic } from "../src/interfaces/ISablierV2LockupDynamic.sol";
+import { ISablierV2LockupLinear } from "../src/interfaces/ISablierV2LockupLinear.sol";
+import { ISablierV2LockupTranched } from "../src/interfaces/ISablierV2LockupTranched.sol";
+import { ISablierV2NFTDescriptor } from "../src/interfaces/ISablierV2NFTDescriptor.sol";
+import { SablierV2NFTDescriptor } from "../src/SablierV2NFTDescriptor.sol";
+
+/// @notice This is useful for external integrations seeking to test against the exact deployed bytecode, as recompiling
+/// with via IR enabled would be time-consuming.
+///
+/// The BUSL-1.1 license permits non-production usage of this file. This prohibits running the code on mainnet,
+/// but allows for execution in test environments, such as a local development network or a testnet.
+contract Precompiles {
+ /*//////////////////////////////////////////////////////////////////////////
+ CONSTANTS
+ //////////////////////////////////////////////////////////////////////////*/
+
+ uint256 public constant MAX_SEGMENT_COUNT = 500;
+ uint256 public constant MAX_TRANCHE_COUNT = 500;
+
+ /*//////////////////////////////////////////////////////////////////////////
+ BYTECODES
+ //////////////////////////////////////////////////////////////////////////*/
+
+ bytes public constant BYTECODE_LOCKUP_DYNAMIC =
+ hex"60c0604052346103e457615a506060813803918261001c816103e8565b9384928339810103126103e45780516001600160a01b038116908190036103e45760208201516001600160a01b03811692908390036103e4576040015161006360406103e8565b92601d84527f5361626c696572205632204c6f636b75702044796e616d6963204e4654000000602085015261009860406103e8565b601181527029a0a116ab1916a627a1a5aaa816a22ca760791b602082015230608052845190946001600160401b0382116102e75760015490600182811c921680156103da575b60208310146102c95781601f84931161036c575b50602090601f8311600114610306575f926102fb575b50508160011b915f199060031b1c1916176001555b83516001600160401b0381116102e757600254600181811c911680156102dd575b60208210146102c957601f8111610266575b50602094601f8211600114610203579481929394955f926101f8575b50508160011b915f199060031b1c1916176002555b5f80546001600160a01b031990811685178255600880549091169290921790915560405192907fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf808180a360a0526001600755615642908161040e823960805181613935015260a051818181610bca01526139ff0152f35b015190505f8061016c565b601f1982169560025f52805f20915f5b88811061024e57508360019596979810610236575b505050811b01600255610181565b01515f1960f88460031b161c191690555f8080610228565b91926020600181928685015181550194019201610213565b60025f527f405787fa12a823e0f2b7631cc41b3ba8828b3321ca811111fa75cd3aa3bb5ace601f830160051c810191602084106102bf575b601f0160051c01905b8181106102b45750610150565b5f81556001016102a7565b909150819061029e565b634e487b7160e01b5f52602260045260245ffd5b90607f169061013e565b634e487b7160e01b5f52604160045260245ffd5b015190505f80610108565b60015f9081528281209350601f198516905b818110610354575090846001959493921061033c575b505050811b0160015561011d565b01515f1960f88460031b161c191690555f808061032e565b92936020600181928786015181550195019301610318565b60015f529091507fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6601f840160051c810191602085106103d0575b90601f859493920160051c01905b8181106103c257506100f2565b5f81558493506001016103b5565b90915081906103a7565b91607f16916100de565b5f80fd5b6040519190601f01601f191682016001600160401b038111838210176102e75760405256fe6080806040526004361015610012575f80fd5b5f3560e01c90816301ffc9a7146127c657508063027b6744146127a457806306fdde03146126e9578063081812fc146126cb578063095ea7b3146125c65780631400ecec146125155780631c1cdd4c146124b15780631e99d5691461249457806323b872dd1461247d578063303acc851461244057806331df3d481461232d578063406887cb146121be57806340e58ee514611ea5578063425d30dd14611e5557806342842e0e14611e2c57806342966c6814611c685780634426757014611c425780634857501f14611bd15780634869e12d14611b975780634cc55e1114611a9f57806354c02292146117ee57806357404b12146117605780636352211e146117315780636d0cee751461173157806370a08231146116c757806375829def146116595780637cad6cd1146115685780637de6b1db146113e95780638659c27014610feb578063894e9a0d14610cbc5780638f69b99314610c3c5780639067b67714610bed5780639188ec8414610bb357806395d89b4114610aab578063a22cb465146109f7578063a80fc071146109a6578063ad35efd414610947578063b2564569146108f7578063b637b8651461089e578063b88d4fde14610816578063b8a3be66146107e1578063b971302a14610793578063bc2be1be14610744578063c156a11d1461060e578063c87b56dd146104f8578063d4dbd20b146104a7578063d511609f1461045c578063d975dfed14610422578063e985e9c5146103c9578063ea5ead1914610385578063eac8f5b814610334578063f590c176146102d9578063f851a440146102b45763fdd46d601461026e575f80fd5b346102b05760603660031901126102b0576102876128f3565b6044356001600160801b03811681036102b0576102ae916102a661392b565b6004356133df565b005b5f80fd5b346102b0575f3660031901126102b05760206001600160a01b035f5416604051908152f35b346102b05760203660031901126102b057600435805f52600a60205260ff600160405f20015460a81c1615610323575f52600a602052602060405f205460f81c6040519015158152f35b62b8e7e760e51b5f5260045260245ffd5b346102b05760203660031901126102b057600435805f52600a60205260ff600160405f20015460a81c1615610323575f52600a60205260206001600160a01b03600160405f20015416604051908152f35b346102b05760403660031901126102b05760206004356103b86103a66128f3565b916103b081614206565b928391613082565b6001600160801b0360405191168152f35b346102b05760403660031901126102b0576103e26128dd565b6001600160a01b036103f26128f3565b91165f5260066020526001600160a01b0360405f2091165f52602052602060ff60405f2054166040519015158152f35b346102b05760203660031901126102b057600435805f52600a60205260ff600160405f20015460a81c1615610323576103b8602091614206565b346102b05760203660031901126102b057600435805f52600a60205260ff600160405f20015460a81c1615610323575f52600a6020526020600260405f20015460801c604051908152f35b346102b05760203660031901126102b057600435805f52600a60205260ff600160405f20015460a81c1615610323575f52600a60205260206001600160801b03600360405f20015416604051908152f35b346102b05760203660031901126102b057600435610515816136ad565b505f6001600160a01b0360085416916044604051809481937fe9dc637500000000000000000000000000000000000000000000000000000000835230600484015260248301525afa8015610603575f90610586575b610582906040519182916020835260208301906128b8565b0390f35b503d805f833e6105968183612a76565b8101906020818303126102b05780519067ffffffffffffffff82116102b057019080601f830112156102b0578151916105ce83612a98565b916105dc6040519384612a76565b838352602084830101116102b057610582926105fe9160208085019101612897565b61056a565b6040513d5f823e3d90fd5b346102b05760403660031901126102b05760043561062a6128f3565b61063261392b565b815f52600a60205260ff600160405f20015460a81c161561073257815f5260036020526001600160a01b0360405f205416908133036107125761067483614206565b6001600160801b0381169182610702575b6001600160a01b038116156106ef576106a6856001600160a01b03926137f1565b1692836106c05784637e27328960e01b5f5260045260245ffd5b80859185036106d457602084604051908152f35b8492506364283d7b60e01b5f5260045260245260445260645ffd5b633250574960e11b5f525f60045260245ffd5b61070d828587613082565b610685565b8263216caf0d60e01b5f526004526001600160a01b03331660245260445ffd5b5062b8e7e760e51b5f5260045260245ffd5b346102b05760203660031901126102b057600435805f52600a60205260ff600160405f20015460a81c1615610323575f52600a602052602064ffffffffff60405f205460a01c16604051908152f35b346102b05760203660031901126102b057600435805f52600a60205260ff600160405f20015460a81c1615610323575f52600a60205260206001600160a01b0360405f205416604051908152f35b346102b05760203660031901126102b0576004355f52600a602052602060ff600160405f20015460a81c166040519015158152f35b346102b05760803660031901126102b05761082f6128dd565b6108376128f3565b6064359167ffffffffffffffff83116102b057366023840112156102b05782600401359161086483612a98565b926108726040519485612a76565b80845236602482870101116102b0576020815f9260246102ae9801838801378501015260443591612f92565b346102b05760203660031901126102b057600435805f52600a60205260ff600160405f20015460a81c1615610323575f52600b6020526105826108e360405f20612f0b565b604051918291602083526020830190612988565b346102b05760203660031901126102b057600435805f52600a60205260ff600160405f20015460a81c1615610323575f52600a602052602060ff600160405f20015460b01c166040519015158152f35b346102b05760203660031901126102b057600435805f52600a60205260ff600160405f20015460a81c16156103235761097f9061375d565b6040516005821015610992576020918152f35b634e487b7160e01b5f52602160045260245ffd5b346102b05760203660031901126102b057600435805f52600a60205260ff600160405f20015460a81c1615610323575f52600a60205260206001600160801b03600260405f20015416604051908152f35b346102b05760403660031901126102b057610a106128dd565b602435908115158092036102b0576001600160a01b0316908115610a7f57335f52600660205260405f20825f5260205260405f2060ff1981541660ff83161790556040519081527f17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c3160203392a3005b507f5b08ba18000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b346102b0575f3660031901126102b0576040515f6002548060011c90600181168015610ba9575b602083108114610b9557828552908115610b715750600114610b13575b61058283610aff81850382612a76565b6040519182916020835260208301906128b8565b91905060025f527f405787fa12a823e0f2b7631cc41b3ba8828b3321ca811111fa75cd3aa3bb5ace915f905b808210610b5757509091508101602001610aff610aef565b919260018160209254838588010152019101909291610b3f565b60ff191660208086019190915291151560051b84019091019150610aff9050610aef565b634e487b7160e01b5f52602260045260245ffd5b91607f1691610ad2565b346102b0575f3660031901126102b05760206040517f00000000000000000000000000000000000000000000000000000000000000008152f35b346102b05760203660031901126102b057600435805f52600a60205260ff600160405f20015460a81c1615610323575f52600a602052602064ffffffffff60405f205460c81c16604051908152f35b346102b05760203660031901126102b057600435805f52600a60205260ff600160405f20015460a81c161561032357610c749061375d565b6005811015806109925760028214908115610cb0575b8115610c9e575b6020826040519015158152f35b90506109925760046020911482610c91565b5050600381145f610c8a565b346102b05760203660031901126102b057600435604051610180810181811067ffffffffffffffff821117610fd757606091610160916040525f81525f60208201525f60408201525f838201525f60808201525f60a08201525f60c08201525f60e08201525f6101008201525f610120820152610d37612ebb565b6101408201520152805f52600a60205260ff600160405f20015460a81c161561032357805f52600a60205260405f20604051610d7281612a59565b8154906001600160a01b0382168152602081019264ffffffffff8360a01c1684526040820164ffffffffff8460c81c168152606083019160ff8560f01c1615158352608084019460f81c1515855260018101549160a08501946001600160a01b038416865260c0810160ff8560a01c1615158152610e11600260e084019560ff8860a81c161515875260ff61010086019860b01c161515885201612ed9565b61012083019081526002610e248c61375d565b610e2d816129fa565b14610fcf575b5196516001600160a01b0316925164ffffffffff1695511515905115159351151594511515958a5f52600360205260405f20546001600160a01b03169a5f52600b60205260405f2092516001600160a01b0316995164ffffffffff1698511515926040519a610ea46101808d612a76565b8b5260208b019b8c5260408b01998a5260608b0191825260808b0192835260a08b0193845260c08b0194855260e08b019586526101008b019687526101208b019788526101408b01988952610ef890612f0b565b986101608b01998a526040519b8c9b60208d52516001600160a01b031660208d0152516001600160a01b031660408c01525164ffffffffff1660608b01525164ffffffffff1660808a015251151560a089015251151560c0880152516001600160a01b031660e08701525115156101008601525115156101208501525115156101408401525180516001600160801b031661016084015260208101516001600160801b0316610180840152604001516001600160801b03166101a0830152516101c082016101c090526101e0820161058291612988565b5f8752610e33565b634e487b7160e01b5f52604160045260245ffd5b346102b05760203660031901126102b05760043567ffffffffffffffff81116102b05761101c903690600401612957565b9061102561392b565b5f915b80831061103157005b61103c838284612e4a565b359261104661392b565b835f52600a60205260ff600160405f20015460a81c16156113d657835f52600a60205260ff600160405f20015460a01c165f146110905783634a5541ef60e01b5f5260045260245ffd5b909192805f52600a60205260405f205460f81c6113c4576110c5815f52600a6020526001600160a01b0360405f205416331490565b156113ae576110d3816136ce565b90805f52600a6020526110eb600260405f2001612ed9565b916001600160801b038351166001600160801b038216101561139a57815f52600a60205260ff60405f205460f01c161561138657806001600160801b0360208161113f948188511603169501511690612aea565b5f828152600a6020526040902080547dffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff16600160f81b179055916001600160801b038316908115611361575b825f52600a602052600360405f20016001600160801b0382166fffffffffffffffffffffffffffffffff19825416179055825f52600a6020526001600160a01b0360405f205416835f5260036020526001600160a01b0360405f20541694845f52600a60205285827f5edb27d6c1a327513b90a792050debf074b7194444885e3144d4decc5caaaa5061125a6001600160a01b03600160405f2001541694611232888588614660565b604080518b81526001600160801b03808b166020830152909216908201529081906060820190565b0390a47ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051868152a160ff6112a4866001600160a01b03165f52600960205260405f2090565b54166112ba575b50505050506001019190611028565b60405193630d4af11f60e31b855260048501526024840152604483015260648201526020816084815f865af190811561060357630d4af11f60e31b916001600160e01b0319915f91611333575b50160361131757808080806112ab565b632187e5e760e21b5f526001600160a01b03602491166004525ffd5b611354915060203d811161135a575b61134c8183612a76565b81019061368d565b87611307565b503d611342565b825f52600a602052600160405f2001600160a01b60ff60a01b19825416179055611189565b506339c6dc7360e21b5f526024906004525ffd5b506322cad1af60e11b5f526024906004525ffd5b63216caf0d60e01b5f526004523360245260445ffd5b63fe19f19f60e01b5f5260045260245ffd5b8362b8e7e760e51b5f526024906004525ffd5b346102b05760203660031901126102b05760043561140561392b565b805f52600a60205260ff600160405f20015460a81c1615610323576114298161375d565b611432816129fa565b6004810361144d5750634a5541ef60e01b5f5260045260245ffd5b611456816129fa565b60038103611471575063fe19f19f60e01b5f5260045260245ffd5b60029061147d816129fa565b14611556576114a0815f52600a6020526001600160a01b0360405f205416331490565b1561153757805f52600a60205260ff60405f205460f01c1615611525576020817ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce7925f52600a825260405f2060ff60f01b19815416905560405190807f0eb069207093cd3e51cd1370d2d369770057fbe29947e577e5fb428c6c6fc78f5f80a28152a1005b6339c6dc7360e21b5f5260045260245ffd5b63216caf0d60e01b5f526004526001600160a01b03331660245260445ffd5b6322cad1af60e11b5f5260045260245ffd5b346102b05760203660031901126102b0576004356001600160a01b0381168091036102b0576001600160a01b035f5416338103611643575060085490806001600160a01b03198316176008556001600160a01b036040519216825260208201527fa2548bd4b805e907c1558a47b5858324fe8bb4a2e1ddfca647eecbf65610eebc60403392a26007545f19810190811161162f5760407f6bd5c950a8d8df17f772f5af37cb3655737899cbf903264b9795592da439661c91815190600182526020820152a1005b634e487b7160e01b5f52601160045260245ffd5b6331b339a960e21b5f526004523360245260445ffd5b346102b05760203660031901126102b0576116726128dd565b5f546001600160a01b03811633810361164357506001600160a01b036001600160a01b0319921691829116175f55337fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf805f80a3005b346102b05760203660031901126102b0576001600160a01b036116e86128dd565b168015611705575f526004602052602060405f2054604051908152f35b7f89c62b64000000000000000000000000000000000000000000000000000000005f525f60045260245ffd5b346102b05760203660031901126102b057602061174f6004356136ad565b6001600160a01b0360405191168152f35b346102b05760203660031901126102b05760043561177c612ea3565b50805f52600a60205260ff600160405f20015460a81c1615610323575f908152600a6020526040908190205481519064ffffffffff60c882901c81169160a01c166117c683612a3d565b825260208201526117ec8251809264ffffffffff60208092828151168552015116910152565bf35b346102b05760203660031901126102b05760043567ffffffffffffffff81116102b0578036036101206003198201126102b05761182961392b565b60c482013590602219018112156102b057810160048101359067ffffffffffffffff82116102b05760240160608202360381136102b05761186b913691612d66565b9081519161187883612d4e565b926118866040519485612a76565b808452601f1961189582612d4e565b015f5b818110611a8857505064ffffffffff4216916001600160801b036118bb82613985565b51511667ffffffffffffffff60206118d284613985565b5101511664ffffffffff8060406118e886613985565b5101511686011690604051926118fd84612a21565b83526020830152604082015261191286613985565b5261191c85613985565b5060015b8281106119f45750505061193682600401612e82565b9261194360248401612e82565b9261195060448201612e6e565b916064820135936001600160a01b0385168095036102b0576020966119ec966119ac966001600160801b036119e1976001600160a01b0361199360848a01612e96565b94816119a160a48c01612e96565b976040519d8e612a04565b168c52168c8b0152166040890152606088015215156080870152151560a086015260c085015260e084015260e4369101612e03565b6101008201526139a6565b604051908152f35b806001600160801b03611a0960019385613992565b51511667ffffffffffffffff6020611a218487613992565b5101511664ffffffffff806040611a3b5f1987018d613992565b51015116816040611a4c878a613992565b5101511601169060405192611a6084612a21565b835260208301526040820152611a768289613992565b52611a818188613992565b5001611920565b602090611a93612ebb565b82828901015201611898565b346102b05760403660031901126102b05760043567ffffffffffffffff81116102b057611ad0903690600401612957565b9060243567ffffffffffffffff81116102b057611af1903690600401612957565b9091611afb61392b565b818403611b67575f5b848110611b0d57005b80611b61611b1e6001938886612e4a565b35611b2a838987612e4a565b355f5260036020526001600160a01b0360405f205416611b53611b4e85898b612e4a565b612e6e565b91611b5c61392b565b6133df565b01611b04565b50827faec93440000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b346102b05760203660031901126102b057600435805f52600a60205260ff600160405f20015460a81c1615610323576103b8602091614156565b346102b05760203660031901126102b057600435805f52600a60205260ff600160405f20015460a81c1615610323575f611c0a8261375d565b600581101561099257600203611c28575b6020906040519015158152f35b505f52600a602052602060ff60405f205460f01c16611c1b565b346102b0575f3660031901126102b05760206001600160a01b0360085416604051908152f35b346102b05760203660031901126102b057600435611c8461392b565b805f52600a60205260ff600160405f20015460a81c161561032357805f52600a60205260ff600160405f20015460a01c1615611e0157611cc3816140e4565b156113ae57805f5260036020526001600160a01b0360405f205416151580611dfa575b80611ddd575b611dcb577ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051838152a1805f5260036020526001600160a01b0360405f2054168015908115611d94575b825f52600360205260405f206001600160a01b03198154169055825f827fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef8280a450611d8257005b637e27328960e01b5f5260045260245ffd5b611db3835f52600560205260405f206001600160a01b03198154169055565b805f52600460205260405f205f198154019055611d3a565b630da9b01360e01b5f5260045260245ffd5b50805f52600a60205260ff600160405f20015460b01c1615611cec565b505f611ce6565b7f817cd639000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b346102b0576102ae611e3d3661291d565b9060405192611e4d602085612a76565b5f8452612f92565b346102b05760203660031901126102b057600435805f52600a60205260ff600160405f20015460a81c1615610323575f52600a602052602060ff600160405f20015460a01c166040519015158152f35b346102b05760203660031901126102b057600435611ec161392b565b805f52600a60205260ff600160405f20015460a81c161561032357805f52600a60205260ff600160405f20015460a01c165f14611f0a57634a5541ef60e01b5f5260045260245ffd5b805f52600a60205260405f205460f81c6113c457611f3c815f52600a6020526001600160a01b0360405f205416331490565b1561153757611f4a816136ce565b90805f52600a602052611f62600260405f2001612ed9565b916001600160801b038351166001600160801b03821610156121ab57815f52600a60205260ff60405f205460f01c161561219857806001600160801b03602081611fb6948188511603169501511690612aea565b5f828152600a6020526040902080547dffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff16600160f81b179055916001600160801b038316908115612173575b825f52600a602052600360405f20016001600160801b0382166fffffffffffffffffffffffffffffffff19825416179055825f52600a6020526001600160a01b0360405f205416835f5260036020526001600160a01b0360405f20541694845f52600a60205285827f5edb27d6c1a327513b90a792050debf074b7194444885e3144d4decc5caaaa506120a96001600160a01b03600160405f2001541694611232888588614660565b0390a47ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051868152a1845f52600960205260ff60405f2054166120ec57005b60405193630d4af11f60e31b855260048501526024840152604483015260648201526020816084815f865af190811561060357630d4af11f60e31b916001600160e01b0319915f91612154575b50160361214257005b632187e5e760e21b5f5260045260245ffd5b61216d915060203d60201161135a5761134c8183612a76565b84612139565b825f52600a602052600160405f2001600160a01b60ff60a01b19825416179055612000565b506339c6dc7360e21b5f5260045260245ffd5b506322cad1af60e11b5f5260045260245ffd5b346102b05760203660031901126102b0576121d76128dd565b6001600160a01b035f54169033820361231657806001600160a01b03913b156122ea57166040516301ffc9a760e01b81527ff8ee98d3000000000000000000000000000000000000000000000000000000006004820152602081602481855afa908115610603575f916122bb575b501561229057805f52600960205260405f20600160ff198254161790556040519081527fb4378d4e289cb3f40f4f75a99c9cafa76e3df1c4dc31309babc23dc91bd7280160203392a2005b7f7fb843ea000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b6122dd915060203d6020116122e3575b6122d58183612a76565b810190612e32565b82612245565b503d6122cb565b7f5a2b2d83000000000000000000000000000000000000000000000000000000005f521660045260245ffd5b506331b339a960e21b5f526004523360245260445ffd5b346102b05760203660031901126102b05760043567ffffffffffffffff81116102b05761014060031982360301126102b05761236761392b565b6040519061237482612a04565b61238081600401612909565b825261238e60248201612909565b602083015261239f60448201612ab4565b604083015260648101356001600160a01b03811681036102b05760608301526123ca608482016129ed565b60808301526123db60a482016129ed565b60a08301526123ec60c48201612d3c565b60c083015260e481013567ffffffffffffffff81116102b057810191366023840112156102b0576119e16119ec926124306020953690602460048201359101612d66565b60e0840152610104369101612e03565b346102b05760203660031901126102b0576001600160a01b036124616128dd565b165f526009602052602060ff60405f2054166040519015158152f35b346102b0576102ae61248e3661291d565b91612b0a565b346102b0575f3660031901126102b0576020600754604051908152f35b346102b05760203660031901126102b057600435805f52600a60205260ff600160405f20015460a81c1615610323576124e99061375d565b600581101561099257806020911590811561250a575b506040519015158152f35b6001915014826124ff565b346102b05760203660031901126102b057600435805f52600a60205260ff600160405f20015460a81c1615610323576020905f90805f52600a835260ff60405f205460f01c16806125aa575b612578575b506001600160801b0360405191168152f35b6125a49150805f52600a835261259e6001600160801b03600260405f20015416916136ce565b90612aea565b82612566565b50805f52600a835260ff600160405f20015460a01c1615612561565b346102b05760403660031901126102b0576125df6128dd565b6024356125eb816136ad565b331515806126b8575b80612685575b6126595781906001600160a01b0380851691167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b9255f80a45f5260056020526001600160a01b0360405f2091166001600160a01b03198254161790555f80f35b7fa9fbf51f000000000000000000000000000000000000000000000000000000005f523360045260245ffd5b506001600160a01b0381165f52600660205260405f206001600160a01b0333165f5260205260ff60405f205416156125fa565b50336001600160a01b03821614156125f4565b346102b05760203660031901126102b057602061174f600435612ac8565b346102b0575f3660031901126102b0576040515f6001548060011c9060018116801561279a575b602083108114610b9557828552908115610b71575060011461273c5761058283610aff81850382612a76565b91905060015f527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6915f905b80821061278057509091508101602001610aff610aef565b919260018160209254838588010152019101909291612768565b91607f1691612710565b346102b0575f3660031901126102b057602060405167016345785d8a00008152f35b346102b05760203660031901126102b057600435906001600160e01b031982168092036102b057817f490649060000000000000000000000000000000000000000000000000000000060209314908115612822575b5015158152f35b7f80ac58cd0000000000000000000000000000000000000000000000000000000081149150811561286d575b811561285c575b508361281b565b6301ffc9a760e01b91501483612855565b7f5b5e139f000000000000000000000000000000000000000000000000000000008114915061284e565b5f5b8381106128a85750505f910152565b8181015183820152602001612899565b906020916128d181518092818552858086019101612897565b601f01601f1916010190565b600435906001600160a01b03821682036102b057565b602435906001600160a01b03821682036102b057565b35906001600160a01b03821682036102b057565b60609060031901126102b0576004356001600160a01b03811681036102b057906024356001600160a01b03811681036102b0579060443590565b9181601f840112156102b05782359167ffffffffffffffff83116102b0576020808501948460051b0101116102b057565b90602080835192838152019201905f5b8181106129a55750505090565b9091926020606060019264ffffffffff604088516001600160801b03815116845267ffffffffffffffff86820151168685015201511660408201520194019101919091612998565b359081151582036102b057565b6005111561099257565b610120810190811067ffffffffffffffff821117610fd757604052565b6060810190811067ffffffffffffffff821117610fd757604052565b6040810190811067ffffffffffffffff821117610fd757604052565b610140810190811067ffffffffffffffff821117610fd757604052565b90601f8019910116810190811067ffffffffffffffff821117610fd757604052565b67ffffffffffffffff8111610fd757601f01601f191660200190565b35906001600160801b03821682036102b057565b612ad1816136ad565b505f5260056020526001600160a01b0360405f20541690565b906001600160801b03809116911603906001600160801b03821161162f57565b91906001600160a01b031680156106ef57815f5260036020526001600160a01b0360405f205416151580612d34575b80612d17575b612d04577ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051848152a1815f5260036020526001600160a01b0360405f20541692823315159283612c4f575b6001600160a01b03935085612c18575b805f52600460205260405f2060018154019055815f52600360205260405f20816001600160a01b0319825416179055857fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef5f80a416808303612c0057505050565b6364283d7b60e01b5f5260045260245260445260645ffd5b612c37825f52600560205260405f206001600160a01b03198154169055565b855f52600460205260405f205f198154019055612b9f565b9192905080612cad575b15612c6657828291612b8f565b8284612c7e57637e27328960e01b5f5260045260245ffd5b7f177e802f000000000000000000000000000000000000000000000000000000005f523360045260245260445ffd5b503384148015612cdb575b80612c595750825f526005602052336001600160a01b0360405f20541614612c59565b50835f52600660205260405f206001600160a01b0333165f5260205260ff60405f205416612cb8565b50630da9b01360e01b5f5260045260245ffd5b50815f52600a60205260ff600160405f20015460b01c1615612b3f565b506001612b39565b359064ffffffffff821682036102b057565b67ffffffffffffffff8111610fd75760051b60200190565b929192612d7282612d4e565b93612d806040519586612a76565b60606020868581520193028201918183116102b057925b828410612da45750505050565b6060848303126102b05760405190612dbb82612a21565b612dc485612ab4565b825260208501359067ffffffffffffffff821682036102b05782602092836060950152612df360408801612d3c565b6040820152815201930192612d97565b91908260409103126102b057604051612e1b81612a3d565b6020808294612e2981612909565b84520135910152565b908160209103126102b0575180151581036102b05790565b9190811015612e5a5760051b0190565b634e487b7160e01b5f52603260045260245ffd5b356001600160801b03811681036102b05790565b356001600160a01b03811681036102b05790565b3580151581036102b05790565b60405190612eb082612a3d565b5f6020838281520152565b60405190612ec882612a21565b5f6040838281528260208201520152565b90604051612ee681612a21565b60406001600160801b03600183958054838116865260801c6020860152015416910152565b908154612f1781612d4e565b92612f256040519485612a76565b81845260208401905f5260205f205f915b838310612f435750505050565b600160208192604051612f5581612a21565b64ffffffffff86546001600160801b038116835267ffffffffffffffff8160801c168584015260c01c166040820152815201920192019190612f36565b90612f9e838284612b0a565b803b612fab575b50505050565b602091612ff16001600160a01b03809316956040519586948594630a85bd0160e11b865233600487015216602485015260448401526080606484015260848301906128b8565b03815f865af15f9181613061575b5061302d575061300d6141d7565b805190816130285782633250574960e11b5f5260045260245ffd5b602001fd5b6001600160e01b0319630a85bd0160e11b91160361304f57505f808080612fa5565b633250574960e11b5f5260045260245ffd5b61307b91925060203d60201161135a5761134c8183612a76565b905f612fff565b9061308b61392b565b815f52600a60205260ff600160405f20015460a81c161561073257815f52600a60205260ff600160405f20015460a01c166133cc576001600160a01b03811680156133a0576001600160801b03841691821561337457835f5260036020526001600160a01b0360405f205416948583141580613364575b613330576001600160801b0361311786614206565b168085116132fd575061313c90855f52600a602052600260405f20015460801c61422c565b5f858152600a6020526040902060020180546001600160801b031660809290921b6fffffffffffffffffffffffffffffffff191691909117815561317f90612ed9565b6001600160801b036131a38160208401511692826040818351169201511690612aea565b1611156132cb575b835f52600a6020526131cf836001600160a01b03600160405f200154169283614660565b81847f40b88e5c41c5a97ffb7b6ef88a0a2d505aa0c634cf8a0275cb236ea7dd87ed4d6020604051878152a47ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051858152a183331415806132b5575b6132395750505050565b604051926392b9102b60e01b84526004840152336024840152604483015260648201526020816084815f865af1908115610603576392b9102b60e01b916001600160e01b0319915f91613296575b50160361214257808080612fa5565b6132af915060203d60201161135a5761134c8183612a76565b5f613287565b50835f52600960205260ff60405f20541661322f565b5f848152600a6020526040902060018101805460ff60a01b1916600160a01b179055805460ff60f01b191690556131ab565b84867fa1fb2bbc000000000000000000000000000000000000000000000000000000005f5260045260245260445260645ffd5b82857fb34359d3000000000000000000000000000000000000000000000000000000005f526004523360245260445260645ffd5b5061336e856140e4565b15613102565b837fd2aabcd9000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b827f7fbf7168000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b50634a5541ef60e01b5f5260045260245ffd5b90815f52600a60205260ff600160405f20015460a81c161561073257815f52600a60205260ff600160405f20015460a01c166133cc576001600160a01b03811680156133a0576001600160801b03841691821561337457835f5260036020526001600160a01b0360405f20541694858314158061367d575b613330576001600160801b0361346c86614206565b168085116132fd575061349190855f52600a602052600260405f20015460801c61422c565b5f858152600a6020526040902060020180546001600160801b031660809290921b6fffffffffffffffffffffffffffffffff19169190911781556134d490612ed9565b6001600160801b036134f88160208401511692826040818351169201511690612aea565b16111561364b575b835f52600a602052613524836001600160a01b03600160405f200154169283614660565b81847f40b88e5c41c5a97ffb7b6ef88a0a2d505aa0c634cf8a0275cb236ea7dd87ed4d6020604051878152a47ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051858152a18333141580613626575b61358e5750505050565b604051926392b9102b60e01b84526004840152336024840152604483015260648201526020816084815f865af1908115610603576392b9102b60e01b916001600160e01b0319915f91613607575b5016036135eb57808080612fa5565b6001600160a01b0390632187e5e760e21b5f521660045260245ffd5b613620915060203d60201161135a5761134c8183612a76565b5f6135dc565b5060ff613644856001600160a01b03165f52600960205260405f2090565b5416613584565b5f848152600a6020526040902060018101805460ff60a01b1916600160a01b179055805460ff60f01b19169055613500565b50613687856140e4565b15613457565b908160209103126102b057516001600160e01b0319811681036102b05790565b805f5260036020526001600160a01b0360405f205416908115611d82575090565b64ffffffffff4216815f52600a6020528064ffffffffff60405f205460a01c16101561375757815f52600a60205264ffffffffff60405f205460c81c16111561373c57805f52600b602052600160405f2054115f14613733576137309061430c565b90565b6137309061424c565b5f52600a6020526001600160801b03600260405f2001541690565b50505f90565b805f52600a60205260ff600160405f20015460a01c165f1461377f5750600490565b805f52600a60205260405f205460f81c6137eb57805f52600a60205264ffffffffff60405f205460a01c1642106137e6576137b9816136ce565b905f52600a6020526001600160801b0380600260405f200154169116105f146137e157600190565b600290565b505f90565b50600390565b90805f5260036020526001600160a01b0360405f205416151580613919575b806138fc575b611dcb577ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051838152a1805f5260036020526001600160a01b038060405f20541692836138c5575b16806138ad575b815f52600360205260405f20816001600160a01b0319825416179055827fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef5f80a490565b805f52600460205260405f2060018154019055613869565b6138e4835f52600560205260405f206001600160a01b03198154169055565b835f52600460205260405f205f198154019055613862565b50805f52600a60205260ff600160405f20015460b01c1615613816565b506001600160a01b0382161515613810565b6001600160a01b037f000000000000000000000000000000000000000000000000000000000000000016300361395d57565b7fa1c0d6e5000000000000000000000000000000000000000000000000000000005f5260045ffd5b805115612e5a5760200190565b8051821015612e5a5760209160051b010190565b906139c86001600160801b036040840151166020610100850151015190614522565b916001600160801b038351169060e08101519160c082019264ffffffffff84511682156140bc578015614094578151801561406c577f00000000000000000000000000000000000000000000000000000000000000008111614041575064ffffffffff6040613a3684613985565b51015116811015613ffd57505f905f905f81515f905b808210613f75575050505064ffffffffff80421691169081811015613f475750506001600160801b031690818103613f1957505060075493845f52600a60205260405f20916001600160801b038251166001600160801b036002850191166fffffffffffffffffffffffffffffffff198254161790556001600160a01b03606082015116916001600160a01b036001850193166001600160a01b031984541617835560808201948551151560ff60f01b197eff00000000000000000000000000000000000000000000000000000000000087549260f01b169116178555835493750100000000000000000000000000000000000000000060a08501957fffffffffffffffffff0000ffffffffffffffffffffffffffffffffffffffffff76ff000000000000000000000000000000000000000000008851151560b01b169116171790556001600160a01b0380845116166001600160a01b03198654161785555184549060e0840151917fffff00000000000000000000ffffffffffffffffffffffffffffffffffffffff78ffffffffff00000000000000000000000000000000000000007dffffffffff000000000000000000000000000000000000000000000000006040613c218751975f19890190613992565b51015160c81b169360a01b169116171785555f5b818110613e0b575050600187016007556001600160a01b0360208301511680156106ef57613c6b886001600160a01b03926137f1565b16613ddf578682613cb96001600160a01b0360607f33eb09bbf19ea3fb22c760d5164234f8bf62ca07dcf5a437ad389e96b0bd6443960151166001600160801b0385511690309033906145ff565b6001600160801b0360208401511680613daf575b506001600160a01b0381511694613da4613d866001600160a01b03602085015116986001600160a01b036060860151169a511515935115156001600160a01b0361010060e088015193549764ffffffffff60405199613d2b8b612a3d565b818160a01c168b5260c81c1660208a015201515116946001600160801b0360206040519a8b9a8b5233828c01528281511660408c01520151166060890152608088015260a087015261014060c0870152610140860190612988565b9260e085019064ffffffffff60208092828151168552015116910152565b6101208301520390a4565b613dd9906001600160a01b036060840151166001600160a01b0361010085015151169033906145ff565b5f613ccd565b7f73c6ac6e000000000000000000000000000000000000000000000000000000005f525f60045260245ffd5b885f52600b60205260405f2090613e268160e0870151613992565b51825468010000000000000000811015610fd75760018101808555811015612e5a576001935f5260205f2001906001600160801b0380825116166fffffffffffffffffffffffffffffffff198354161782556020810151907fffffff00000000000000000000000000ffffffffffffffffffffffffffffffff7cffffffffff000000000000000000000000000000000000000000000000604077ffffffffffffffff0000000000000000000000000000000086549560801b1693847fffffffffffffffff0000000000000000ffffffffffffffffffffffffffffffff8716178755015160c01b1692161717905501613c35565b7fd90b7e39000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b7f210aec0e000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b9193509193613f99906001600160801b03613f908588613992565b5151169061422c565b9364ffffffffff806040613fad8685613992565b51015116941680851115613fc957506001849301909291613a4c565b8490847f9588ac09000000000000000000000000000000000000000000000000000000005f5260045260245260445260645ffd5b64ffffffffff604061400e84613985565b51015116907ff539a17c000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b7f4757689b000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b7f3952c64e000000000000000000000000000000000000000000000000000000005f5260045ffd5b7fd572dbcb000000000000000000000000000000000000000000000000000000005f5260045ffd5b7f6095d3bc000000000000000000000000000000000000000000000000000000005f5260045ffd5b805f5260036020526001600160a01b0360405f2054169081331491821561412a575b508115614111575090565b90506001600160a01b036141253392612ac8565b161490565b9091505f52600660205260405f206001600160a01b0333165f5260205260ff60405f205416905f614106565b805f52600a60205261416d600260405f2001612ed9565b90805f52600a60205260ff600160405f20015460a01c165f1461419b5750602001516001600160801b031690565b90815f52600a60205260405f205460f81c6141ba5750613730906136ce565b61373091506001600160801b036040818351169201511690612aea565b3d15614201573d906141e882612a98565b916141f66040519384612a76565b82523d5f602084013e565b606090565b6137309061421381614156565b905f52600a602052600260405f20015460801c90612aea565b906001600160801b03809116911601906001600160801b03821161162f57565b5f818152600a60205260409020546142839064ffffffffff60a082901c811660c89290921c811682900381169142821603166146b0565b90805f52600b60205260405f20805415612e5a575f526142d867ffffffffffffffff60205f205460801c1692825f52600a6020526142d36001600160801b03600260405f20015416948592614790565b614803565b9182136142f557506142f16001600160801b03916148de565b1690565b90505f52600a602052600260405f20015460801c90565b9064ffffffffff421691805f52600a60205260405f20906040519061433082612a59565b6101206143c360028554956001600160a01b0387168652602086019664ffffffffff8160a01c16885264ffffffffff8160c81c16604088015260ff8160f01c161515606088015260f81c1515608087015260ff60018201546001600160a01b03811660a0890152818160a01c16151560c0890152818160a81c16151560e089015260b01c16151561010087015201612ed9565b92019182525f52600b6020526143db60405f20612f0b565b915f9264ffffffffff60406143ef83613985565b510151168664ffffffffff5f925b16106144e3578161447464ffffffffff9697988784816001600160801b0361442c6142d3986144799b9a613992565b5151169a8b9867ffffffffffffffff6020614447868b613992565b51015116978260406144598784613992565b5101511694806144c6575050511680925b03169203166146b0565b614790565b91821361449a5750906001600160801b0361449481936148de565b16011690565b6001600160801b03915060209051015116806001600160801b038316115f146144c1575090565b905090565b60409250906144d8915f190190613992565b51015116809261446a565b936001600160801b03600191816144fa8886613992565b51511601169401958064ffffffffff8060406145168b87613992565b510151169892986143fd565b91909160405161453181612a3d565b5f81525f6020820152926001600160801b0382169081156145e25767016345785d8a000081116145ab5761456d6001600160801b0391836154fb565b1660208501918183521115614597576001600160801b03918261459292511690612aea565b168252565b634e487b7160e01b5f52600160045260245ffd5b7f4fea5c1a000000000000000000000000000000000000000000000000000000005f5260045267016345785d8a000060245260445ffd5b50505090506040516145f381612a3d565b5f81525f602082015290565b9091926001600160a01b0361465e9481604051957f23b872dd000000000000000000000000000000000000000000000000000000006020880152166024860152166044840152606483015260648252614659608483612a76565b614913565b565b61465e926001600160a01b03604051937fa9059cbb000000000000000000000000000000000000000000000000000000006020860152166024840152604483015260448252614659606483612a76565b600160ff1b81148015614783575b61475b575f811215614752576146e2815f035b5f84121561474b57835f0390614998565b917f7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff831161471c575f19911813156147175790565b5f0390565b907fd49c26b3000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b8390614998565b6146e2816146d1565b7f9fe2b450000000000000000000000000000000000000000000000000000000005f5260045ffd5b50600160ff1b82146146be565b806147aa57506147a657670de0b6b3a764000090565b5f90565b90670de0b6b3a764000082146147f557806147cd575050670de0b6b3a764000090565b670de0b6b3a764000081146147f1576147ec906142d361373093614a9e565b614bf5565b5090565b5050670de0b6b3a764000090565b600160ff1b811480156148d1575b6148a9575f8112156148a057614835815f035b5f84121561489957835f03906154fb565b917f7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff831161486a575f19911813156147175790565b907f120b5b43000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b83906154fb565b61483581614824565b7fa6070c25000000000000000000000000000000000000000000000000000000005f5260045ffd5b50600160ff1b8214614811565b5f81126148e85790565b7f2463f3d5000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b5f806001600160a01b0361493c93169360208151910182865af16149356141d7565b90836155a9565b805190811515918261497d575b50506149525750565b7f5274afe7000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b6149909250602080918301019101612e32565b155f80614949565b5f19670de0b6b3a7640000820991670de0b6b3a7640000820291828085109403938085039414614a635781841015614a2957670de0b6b3a7640000829109600182190182168092046002816003021880820260020302808202600203028082026002030280820260020302808202600203028091026002030293600183805f03040190848311900302920304170290565b7f63a05778000000000000000000000000000000000000000000000000000000005f52600452670de0b6b3a764000060245260445260645ffd5b5091508115614a70570490565b634e487b7160e01b5f52601260045260245ffd5b8015614a70576ec097ce7bc90715b34b9f10000000000590565b805f811315614bca57670de0b6b3a76400008112614baa57506001905b670de0b6b3a764000081056001600160801b03811160071b90811c67ffffffffffffffff811160061b90811c63ffffffff811160051b90811c61ffff811160041b90811c9060ff821160031b91821c92600f841160021b93841c94600160038711811b96871c119617171717171717670de0b6b3a7640000810291811d90670de0b6b3a76400008214614b9757506706f05b59d3b20000905b5f8213614b615750500290565b80670de0b6b3a764000091020590671bc16d674ec80000821215614b89575b60011d90614b54565b809192019160011d90614b80565b9050670de0b6b3a7640000929150020290565b5f1991508015614a70576ec097ce7bc90715b34b9f100000000005614abb565b7f059b101b000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b5f811215614c225768033dd1780914b971141981126137e657614c19905f03614bf5565b61373090614a84565b680a688906bd8affffff81136154d057670de0b6b3a76400009060401b057780000000000000000000000000000000000000000000000067ff00000000000000821661539b575b670de0b6b3a76400009066ff000000000000831661528b575b65ff00000000008316615183575b64ff000000008316615083575b63ff0000008316614f8b575b62ff00008316614e9b575b61ff008316614db3575b60ff8316614cd3575b029060401c60bf031c90565b60808316614da0575b60408316614d8d575b60208316614d7a575b60108316614d67575b60088316614d54575b60048316614d41575b60028316614d2e575b6001831615614cc757680100000000000000010260401c614cc7565b680100000000000000010260401c614d12565b680100000000000000030260401c614d09565b680100000000000000060260401c614d00565b6801000000000000000b0260401c614cf7565b680100000000000000160260401c614cee565b6801000000000000002c0260401c614ce5565b680100000000000000590260401c614cdc565b6180008316614e88575b6140008316614e75575b6120008316614e62575b6110008316614e4f575b6108008316614e3c575b6104008316614e29575b6102008316614e16575b610100831615614cbe57680100000000000000b10260401c614cbe565b680100000000000001630260401c614df9565b680100000000000002c60260401c614def565b6801000000000000058c0260401c614de5565b68010000000000000b170260401c614ddb565b6801000000000000162e0260401c614dd1565b68010000000000002c5d0260401c614dc7565b680100000000000058b90260401c614dbd565b628000008316614f78575b624000008316614f65575b622000008316614f52575b621000008316614f3f575b620800008316614f2c575b620400008316614f19575b620200008316614f06575b62010000831615614cb4576801000000000000b1720260401c614cb4565b680100000000000162e40260401c614ee8565b6801000000000002c5c80260401c614edd565b68010000000000058b910260401c614ed2565b680100000000000b17210260401c614ec7565b68010000000000162e430260401c614ebc565b680100000000002c5c860260401c614eb1565b6801000000000058b90c0260401c614ea6565b63800000008316615070575b6340000000831661505d575b6320000000831661504a575b63100000008316615037575b63080000008316615024575b63040000008316615011575b63020000008316614ffe575b6301000000831615614ca95768010000000000b172180260401c614ca9565b6801000000000162e4300260401c614fdf565b68010000000002c5c8600260401c614fd3565b680100000000058b90c00260401c614fc7565b6801000000000b17217f0260401c614fbb565b680100000000162e42ff0260401c614faf565b6801000000002c5c85fe0260401c614fa3565b68010000000058b90bfc0260401c614f97565b6480000000008316615170575b644000000000831661515d575b642000000000831661514a575b6410000000008316615137575b6408000000008316615124575b6404000000008316615111575b64020000000083166150fe575b640100000000831615614c9d57680100000000b17217f80260401c614c9d565b68010000000162e42ff10260401c6150de565b680100000002c5c85fe30260401c6150d1565b6801000000058b90bfce0260401c6150c4565b68010000000b17217fbb0260401c6150b7565b6801000000162e42fff00260401c6150aa565b68010000002c5c8601cc0260401c61509d565b680100000058b90c0b490260401c615090565b658000000000008316615278575b654000000000008316615265575b652000000000008316615252575b65100000000000831661523f575b65080000000000831661522c575b650400000000008316615219575b650200000000008316615206575b65010000000000831615614c90576801000000b1721835510260401c614c90565b680100000162e430e5a20260401c6151e5565b6801000002c5c863b73f0260401c6151d7565b68010000058b90cf1e6e0260401c6151c9565b680100000b1721bcfc9a0260401c6151bb565b68010000162e43f4f8310260401c6151ad565b680100002c5c89d5ec6d0260401c61519f565b6801000058b91b5bc9ae0260401c615191565b66800000000000008316615388575b66400000000000008316615375575b66200000000000008316615362575b6610000000000000831661534f575b6608000000000000831661533c575b66040000000000008316615329575b66020000000000008316615316575b6601000000000000831615614c825768010000b17255775c040260401c614c82565b6801000162e525ee05470260401c6152f4565b68010002c5cc37da94920260401c6152e5565b680100058ba01fb9f96d0260401c6152d6565b6801000b175effdc76ba0260401c6152c7565b680100162f3904051fa10260401c6152b8565b6801002c605e2e8cec500260401c6152a9565b68010058c86da1c09ea20260401c61529a565b67800000000000000082166154b1575b670de0b6b3a764000090674000000000000000831661549e575b672000000000000000831661548b575b6710000000000000008316615478575b6708000000000000008316615465575b6704000000000000008316615452575b670200000000000000831661543f575b670100000000000000831661542c575b9050614c69565b680100b1afa5abcbed610260401c615425565b68010163da9fb33356d80260401c615415565b680102c9a3e778060ee70260401c615405565b6801059b0d31585743ae0260401c6153f5565b68010b5586cf9890f62a0260401c6153e5565b6801172b83c7d517adce0260401c6153d5565b6801306fe0a31b7152df0260401c6153c5565b5077b504f333f9de6484800000000000000000000000000000006153ab565b7f0360d028000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b9091905f198382098382029182808310920391808303921461559857670de0b6b3a7640000821015615568577faccb18165bd6fe31ae1cf318dc5b51eee0e1ba569b88cd74c1773b91fac106699394670de0b6b3a7640000910990828211900360ee1b910360121c170290565b84907f5173648d000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b5050670de0b6b3a764000090049150565b906155e657508051156155be57805190602001fd5b7f1425ea42000000000000000000000000000000000000000000000000000000005f5260045ffd5b8151158061562c575b6155f7575090565b6001600160a01b03907f9996b315000000000000000000000000000000000000000000000000000000005f521660045260245ffd5b50803b156155ef56fea164736f6c634300081a000a";
+ bytes public constant BYTECODE_LOCKUP_LINEAR =
+ hex"60a0604052346103bf57614b706040813803918261001c816103c3565b9384928339810103126103bf5780516001600160a01b03811691908290036103bf57602001516001600160a01b038116908190036103bf5761005e60406103c3565b91601c83527f5361626c696572205632204c6f636b7570204c696e656172204e465400000000602084015261009360406103c3565b601181527029a0a116ab1916a627a1a5aaa816a624a760791b60208201523060805283519092906001600160401b0381116102d057600154600181811c911680156103b5575b60208210146102b257601f8111610352575b50602094601f82116001146102ef579481929394955f926102e4575b50508160011b915f199060031b1c1916176001555b82516001600160401b0381116102d057600254600181811c911680156102c6575b60208210146102b257601f811161024f575b506020601f82116001146101ec57819293945f926101e1575b50508160011b915f199060031b1c1916176002555b5f80546001600160a01b031990811684178255600880549091169290921790915560405191907fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf808180a3600160075561478790816103e9823960805181613adb0152f35b015190505f80610168565b601f1982169060025f52805f20915f5b8181106102375750958360019596971061021f575b505050811b0160025561017d565b01515f1960f88460031b161c191690555f8080610211565b9192602060018192868b0151815501940192016101fc565b60025f527f405787fa12a823e0f2b7631cc41b3ba8828b3321ca811111fa75cd3aa3bb5ace601f830160051c810191602084106102a8575b601f0160051c01905b81811061029d575061014f565b5f8155600101610290565b9091508190610287565b634e487b7160e01b5f52602260045260245ffd5b90607f169061013d565b634e487b7160e01b5f52604160045260245ffd5b015190505f80610107565b601f1982169560015f52805f20915f5b88811061033a57508360019596979810610322575b505050811b0160015561011c565b01515f1960f88460031b161c191690555f8080610314565b919260206001819286850151815501940192016102ff565b60015f527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6601f830160051c810191602084106103ab575b601f0160051c01905b8181106103a057506100eb565b5f8155600101610393565b909150819061038a565b90607f16906100d9565b5f80fd5b6040519190601f01601f191682016001600160401b038111838210176102d05760405256fe6080806040526004361015610012575f80fd5b5f3560e01c90816301ffc9a71461313757508063027b67441461311557806306fdde031461305a578063081812fc1461303c578063095ea7b314612f375780631400ecec14612e865780631c1cdd4c14612e225780631e99d56914612e0557806323b872dd14612dee578063303acc8514612db1578063406887cb14612c4257806340e58ee51461296b578063425d30dd1461291b57806342842e0e146128f257806342966c681461272e57806344267570146127085780634857501f146126975780634869e12d1461265d5780634cc55e11146122b657806353b157271461218b57806357404b12146120c55780636352211e146120965780636d0cee751461209657806370a082311461202c57806375829def14611fbe578063780a82c814611f725780637cad6cd114611e955780637de6b1db14611d485780638659c27014611991578063894e9a0d146116a95780638f69b993146116295780639067b677146115da57806395d89b41146114d2578063a22cb4651461141e578063a80fc071146113cd578063ab167ccc1461125c578063ad35efd4146111fd578063b2564569146111ad578063b88d4fde14611123578063b8a3be66146110ee578063b971302a146110a0578063bc2be1be14611051578063c156a11d14610c3c578063c87b56dd14610b31578063d4dbd20b14610ae0578063d511609f14610a95578063d975dfed14610a4a578063e985e9c5146109f1578063ea5ead19146106ac578063eac8f5b81461065b578063f590c17614610600578063f851a440146105db5763fdd46d6014610263575f80fd5b346105d75760603660031901126105d75760043561027f613264565b906102886133c6565b610290613ad1565b815f52600a60205260ff600160405f20015460a81c16156105c557815f52600a60205260ff600160405f20015460a01c166105b2576001600160a01b03831690811561059f576001600160801b031690811561058c57825f5260036020526001600160a01b0360405f20541693848214158061057c575b610561576001600160801b0361031c8561431b565b168084116105475750835f52600a60205282600260405f20015460801c016001600160801b0381116105335761037b90855f52600a602052600260405f2001906001600160801b036001600160801b031983549260801b169116179055565b835f52600a602052610392600260405f20016136aa565b6001600160801b036103b681602084015116928260408183511692015116906133fe565b161115610501575b835f52600a6020526103e2836001600160a01b03600160405f200154169283614341565b81847f40b88e5c41c5a97ffb7b6ef88a0a2d505aa0c634cf8a0275cb236ea7dd87ed4d6020604051878152a47ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051858152a183331415806104eb575b61044857005b604051926392b9102b60e01b84526004840152336024840152604483015260648201526020816084815f865af19081156104e0576392b9102b60e01b916001600160e01b0319915f916104b1575b50160361049f57005b632187e5e760e21b5f5260045260245ffd5b6104d3915060203d6020116104d9575b6104cb8183613388565b8101906137e0565b5f610496565b503d6104c1565b6040513d5f823e3d90fd5b50835f52600960205260ff60405f205416610442565b5f848152600a6020526040902060018101805460ff60a01b1916600160a01b179055805460ff60f01b191690556103be565b634e487b7160e01b5f52601160045260245ffd5b838563287ecaef60e21b5f5260045260245260445260645ffd5b508263b34359d360e01b5f526004523360245260445260645ffd5b5061058684613b2b565b15610307565b8263d2aabcd960e01b5f5260045260245ffd5b82630ff7ee2d60e31b5f5260045260245ffd5b50634a5541ef60e01b5f5260045260245ffd5b5062b8e7e760e51b5f5260045260245ffd5b5f80fd5b346105d7575f3660031901126105d75760206001600160a01b035f5416604051908152f35b346105d75760203660031901126105d757600435805f52600a60205260ff600160405f20015460a81c161561064a575f52600a602052602060405f205460f81c6040519015158152f35b62b8e7e760e51b5f5260045260245ffd5b346105d75760203660031901126105d757600435805f52600a60205260ff600160405f20015460a81c161561064a575f52600a60205260206001600160a01b03600160405f20015416604051908152f35b346105d75760403660031901126105d7576004356106c8613264565b906106d28161431b565b906106db613ad1565b805f52600a60205260ff600160405f20015460a81c161561064a57805f52600a60205260ff600160405f20015460a01c166109df576001600160a01b0383169182156109cc576001600160801b03169182156109b957815f5260036020526001600160a01b0360405f2054169384821415806109a9575b61098e576001600160801b036107678461431b565b168085116109745750825f52600a60205283600260405f20015460801c016001600160801b038111610533576107c690845f52600a602052600260405f2001906001600160801b036001600160801b031983549260801b169116179055565b825f52600a6020526107dd600260405f20016136aa565b6001600160801b0361080181602084015116928260408183511692015116906133fe565b161115610942575b825f52600a60205261082d846001600160a01b03600160405f200154169283614341565b81837f40b88e5c41c5a97ffb7b6ef88a0a2d505aa0c634cf8a0275cb236ea7dd87ed4d6020604051888152a47ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051848152a1833314158061092c575b61089d575b602083604051908152f35b604051916392b9102b60e01b8352600483015233602483015260448201528160648201526020816084815f875af19081156104e0576392b9102b60e01b916001600160e01b0319915f9161090d575b5016036108fa578180610892565b50632187e5e760e21b5f5260045260245ffd5b610926915060203d6020116104d9576104cb8183613388565b856108ec565b50835f52600960205260ff60405f20541661088d565b5f838152600a6020526040902060018101805460ff60a01b1916600160a01b179055805460ff60f01b19169055610809565b848463287ecaef60e21b5f5260045260245260445260645ffd5b509063b34359d360e01b5f526004523360245260445260645ffd5b506109b383613b2b565b15610752565b5063d2aabcd960e01b5f5260045260245ffd5b50630ff7ee2d60e31b5f5260045260245ffd5b634a5541ef60e01b5f5260045260245ffd5b346105d75760403660031901126105d757610a0a61324e565b6001600160a01b03610a1a613264565b91165f5260066020526001600160a01b0360405f2091165f52602052602060ff60405f2054166040519015158152f35b346105d75760203660031901126105d757600435805f52600a60205260ff600160405f20015460a81c161561064a57610a8460209161431b565b6001600160801b0360405191168152f35b346105d75760203660031901126105d757600435805f52600a60205260ff600160405f20015460a81c161561064a575f52600a6020526020600260405f20015460801c604051908152f35b346105d75760203660031901126105d757600435805f52600a60205260ff600160405f20015460a81c161561064a575f52600a60205260206001600160801b03600360405f20015416604051908152f35b346105d75760203660031901126105d757600435610b4e81613800565b505f6001600160a01b0360085416916044604051809481937fe9dc637500000000000000000000000000000000000000000000000000000000835230600484015260248301525afa80156104e0575f90610bbf575b610bbb90604051918291602083526020830190613229565b0390f35b503d805f833e610bcf8183613388565b8101906020818303126105d75780519067ffffffffffffffff82116105d757019080601f830112156105d757815191610c07836133aa565b91610c156040519384613388565b838352602084830101116105d757610bbb92610c379160208085019101613208565b610ba3565b346105d75760403660031901126105d757600435610c58613264565b610c60613ad1565b815f52600a60205260ff600160405f20015460a81c16156105c557815f5260036020526001600160a01b0360405f2054169081330361103a576001600160801b03610caa8461431b565b169081158015610d33575b506001600160a01b03811615610d2057610cd7846001600160a01b0392613997565b169182610cf15783637e27328960e01b5f5260045260245ffd5b8084918403610d0557602083604051908152f35b9091506364283d7b60e01b5f5260045260245260445260645ffd5b633250574960e11b5f525f60045260245ffd5b610d3b613ad1565b845f52600a60205260ff600160405f20015460a81c161561102857845f52600a60205260ff600160405f20015460a01c1661101557831561100257610fef57835f5260036020526001600160a01b0360405f2054168084141580610fdf575b610fc4576001600160801b03610daf8661431b565b16808411610faa5750845f52600a60205282600260405f20015460801c016001600160801b03811161053357610e0e90865f52600a602052600260405f2001906001600160801b036001600160801b031983549260801b169116179055565b845f52600a602052610e25600260405f20016136aa565b6001600160801b03610e4981602084015116928260408183511692015116906133fe565b161115610f78575b845f52600a6020526001600160a01b03600160405f20015416610e75848683614341565b84867f40b88e5c41c5a97ffb7b6ef88a0a2d505aa0c634cf8a0275cb236ea7dd87ed4d6020604051888152a47ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051878152a18033141580610f62575b15610cb5576040516392b9102b60e01b81528560048201523360248201528460448201528360648201526020816084815f865af19081156104e0576392b9102b60e01b916001600160e01b0319915f91610f43575b501614610cb557632187e5e760e21b5f5260045260245ffd5b610f5c915060203d6020116104d9576104cb8183613388565b88610f2a565b50805f52600960205260ff60405f205416610ed5565b5f858152600a6020526040902060018101805460ff60a01b1916600160a01b179055805460ff60f01b19169055610e51565b838663287ecaef60e21b5f5260045260245260445260645ffd5b838563b34359d360e01b5f526004523360245260445260645ffd5b50610fe985613b2b565b15610d9a565b8363d2aabcd960e01b5f5260045260245ffd5b84630ff7ee2d60e31b5f5260045260245ffd5b84634a5541ef60e01b5f5260045260245ffd5b8462b8e7e760e51b5f5260045260245ffd5b8263216caf0d60e01b5f526004523360245260445ffd5b346105d75760203660031901126105d757600435805f52600a60205260ff600160405f20015460a81c161561064a575f52600a602052602064ffffffffff60405f205460a01c16604051908152f35b346105d75760203660031901126105d757600435805f52600a60205260ff600160405f20015460a81c161561064a575f52600a60205260206001600160a01b0360405f205416604051908152f35b346105d75760203660031901126105d7576004355f52600a602052602060ff600160405f20015460a81c166040519015158152f35b346105d75760803660031901126105d75761113c61324e565b611144613264565b6064359167ffffffffffffffff83116105d757366023840112156105d757826004013591611171836133aa565b9261117f6040519485613388565b80845236602482870101116105d7576020815f9260246111ab98018388013785010152604435916136f0565b005b346105d75760203660031901126105d757600435805f52600a60205260ff600160405f20015460a81c161561064a575f52600a602052602060ff600160405f20015460b01c166040519015158152f35b346105d75760203660031901126105d757600435805f52600a60205260ff600160405f20015460a81c161561064a5761123590613903565b6040516005821015611248576020918152f35b634e487b7160e01b5f52602160045260245ffd5b346105d7576101403660031901126105d757611276613ad1565b61127e61368c565b64ffffffffff421680825264ffffffffff6112976136dc565b166113b2575b60e43564ffffffffff811681036105d75764ffffffffff9101166040820152600435906001600160a01b038216918281036105d757506024356001600160a01b038116908181036105d757506044356001600160801b038116908181036105d757506064356001600160a01b0381168091036105d75760843591821515928381036105d7575060a43593841515948581036105d7575060405196611340886132e5565b8752602087015260408601526060850152608084015260a083015260c08201526040610103193601126105d7576040519061137a8261336c565b61010435906001600160a01b03821682036105d757826113aa9260209452610124358482015260e0820152613c21565b604051908152f35b64ffffffffff6113c06136dc565b820116602083015261129d565b346105d75760203660031901126105d757600435805f52600a60205260ff600160405f20015460a81c161561064a575f52600a60205260206001600160801b03600260405f20015416604051908152f35b346105d75760403660031901126105d75761143761324e565b602435908115158092036105d7576001600160a01b03169081156114a657335f52600660205260405f20825f5260205260405f2060ff1981541660ff83161790556040519081527f17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c3160203392a3005b507f5b08ba18000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b346105d7575f3660031901126105d7576040515f6002548060011c906001811680156115d0575b6020831081146115bc57828552908115611598575060011461153a575b610bbb8361152681850382613388565b604051918291602083526020830190613229565b91905060025f527f405787fa12a823e0f2b7631cc41b3ba8828b3321ca811111fa75cd3aa3bb5ace915f905b80821061157e57509091508101602001611526611516565b919260018160209254838588010152019101909291611566565b60ff191660208086019190915291151560051b840190910191506115269050611516565b634e487b7160e01b5f52602260045260245ffd5b91607f16916114f9565b346105d75760203660031901126105d757600435805f52600a60205260ff600160405f20015460a81c161561064a575f52600a602052602064ffffffffff60405f205460c81c16604051908152f35b346105d75760203660031901126105d757600435805f52600a60205260ff600160405f20015460a81c161561064a5761166190613903565b600581101580611248576002821490811561169d575b811561168b575b6020826040519015158152f35b9050611248576004602091148261167e565b5050600381145f611677565b346105d75760203660031901126105d7576004355f6101606040516116cd81613332565b8281528260208201528260408201528260608201528260808201528260a08201528260c08201528260e0820152826101008201528261012082015261171061368c565b6101408201520152805f52600a60205260ff600160405f20015460a81c161561064a57805f52600a60205260405f2060405161174b8161334f565b81546001600160a01b0381168252602082019364ffffffffff8260a01c168552604083019364ffffffffff8360c81c1685526060840160ff8460f01c1615158152608085019360f81c1515845260018201549360a08601956001600160a01b038616875260c081019560ff8160a01c16151587526117ea600260e084019660ff8460a81c161515885260ff61010086019460b01c1615158452016136aa565b61012083019081526117fb87613903565b600581101561124857600214611989575b5197516001600160a01b031692865f52600b60205260405f205464ffffffffff16995164ffffffffff1694511515915115159751151595511515965f52600360205260405f20546001600160a01b031692516001600160a01b03169a5164ffffffffff16905115159260405161188181613332565b8c81526020810191825260408101928352606081019384526080810194855260a0810195865260c0810196875260e0810197885261010081019889526101208101998a5261014081019a8b52610160019a8b526040519b8c52516001600160a01b031660208c01525164ffffffffff1660408b015251151560608a01525115156080890152516001600160a01b031660a08801525164ffffffffff1660c087015251151560e08601525115156101008501525115156101208401525180516001600160801b031661014084015260208101516001600160801b0316610160840152604001516001600160801b03166101808301525164ffffffffff166101a08201526101c090f35b5f855261180c565b346105d75760203660031901126105d75760043567ffffffffffffffff81116105d7576119c29036906004016132b4565b906119cb613ad1565b5f915b8083106119d757005b6119e2838284613668565b35926119ec613ad1565b835f52600a60205260ff600160405f20015460a81c1615611d3657835f52600a60205260ff600160405f20015460a01c165f14611a365783634a5541ef60e01b5f5260045260245ffd5b909192805f52600a60205260405f205460f81c611d2457611a6b815f52600a6020526001600160a01b0360405f205416331490565b15611d0e57611a7981613821565b90805f52600a602052611a91600260405f20016136aa565b916001600160801b038351166001600160801b0382161015611cfb57815f52600a60205260ff60405f205460f01c1615611ce857806001600160801b03602081611ae59481885116031695015116906133fe565b5f828152600a6020526040902080547dffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff16600160f81b179055916001600160801b038316908115611cc3575b825f52600a602052600360405f20016001600160801b0382166001600160801b0319825416179055825f52600a6020526001600160a01b0360405f205416835f5260036020526001600160a01b0360405f20541694845f52600a60205285827f5edb27d6c1a327513b90a792050debf074b7194444885e3144d4decc5caaaa50611bf76001600160a01b03600160405f2001541694611bcf888588614341565b604080518b81526001600160801b03808b166020830152909216908201529081906060820190565b0390a47ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051868152a1845f52600960205260ff60405f205416611c48575b505050505060010191906119ce565b60405193630d4af11f60e31b855260048501526024840152604483015260648201526020816084815f865af19081156104e057630d4af11f60e31b916001600160e01b0319915f91611ca5575b50160361049f5780808080611c39565b611cbd915060203d81116104d9576104cb8183613388565b87611c95565b825f52600a602052600160405f2001600160a01b60ff60a01b19825416179055611b2f565b506339c6dc7360e21b5f5260045260245ffd5b506322cad1af60e11b5f5260045260245ffd5b63216caf0d60e01b5f526004523360245260445ffd5b63fe19f19f60e01b5f5260045260245ffd5b8362b8e7e760e51b5f5260045260245ffd5b346105d75760203660031901126105d757600435611d64613ad1565b805f52600a60205260ff600160405f20015460a81c161561064a57611d8881613903565b60058110156112485760048103611dac5750634a5541ef60e01b5f5260045260245ffd5b60038103611dc7575063fe19f19f60e01b5f5260045260245ffd5b600214611e8357611dec815f52600a6020526001600160a01b0360405f205416331490565b15611d0e57805f52600a60205260ff60405f205460f01c1615611e71576020817ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce7925f52600a825260405f2060ff60f01b19815416905560405190807f0eb069207093cd3e51cd1370d2d369770057fbe29947e577e5fb428c6c6fc78f5f80a28152a1005b6339c6dc7360e21b5f5260045260245ffd5b6322cad1af60e11b5f5260045260245ffd5b346105d75760203660031901126105d7576004356001600160a01b0381168091036105d7576001600160a01b035f5416338103611f5c575060085490806001600160a01b03198316176008556001600160a01b036040519216825260208201527fa2548bd4b805e907c1558a47b5858324fe8bb4a2e1ddfca647eecbf65610eebc60403392a26007545f1981019081116105335760407f6bd5c950a8d8df17f772f5af37cb3655737899cbf903264b9795592da439661c91815190600182526020820152a1005b6331b339a960e21b5f526004523360245260445ffd5b346105d75760203660031901126105d757600435805f52600a60205260ff600160405f20015460a81c161561064a575f52600b602052602064ffffffffff60405f205416604051908152f35b346105d75760203660031901126105d757611fd761324e565b5f546001600160a01b038116338103611f5c57506001600160a01b036001600160a01b0319921691829116175f55337fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf805f80a3005b346105d75760203660031901126105d7576001600160a01b0361204d61324e565b16801561206a575f526004602052602060405f2054604051908152f35b7f89c62b64000000000000000000000000000000000000000000000000000000005f525f60045260245ffd5b346105d75760203660031901126105d75760206120b4600435613800565b6001600160a01b0360405191168152f35b346105d75760203660031901126105d7576004356120e161368c565b50805f52600a60205260ff600160405f20015460a81c161561064a57806060915f52600a60205264ffffffffff60405f205460a01c1690805f52600b60205264ffffffffff60405f205416905f52600a60205264ffffffffff60405f205460c81c16906040519261215184613316565b835260208301526040820152612189604051809264ffffffffff60408092828151168552826020820151166020860152015116910152565bf35b346105d7576101603660031901126105d7576121a5613ad1565b6040516121b1816132e5565b6121b961324e565b81526121c3613264565b60208201526121d06133c6565b60408201526064356001600160a01b03811681036105d757606082015260843580151581036105d757608082015260a43580151581036105d75760a082015260603660c31901126105d75760405161222781613316565b60c43564ffffffffff811681036105d757815260e43564ffffffffff811681036105d75760208201526101043564ffffffffff811681036105d757604082015260c08201526040610123193601126105d757604051906122868261336c565b61012435906001600160a01b03821682036105d757826113aa9260209452610144358482015260e0820152613c21565b346105d75760403660031901126105d75760043567ffffffffffffffff81116105d7576122e79036906004016132b4565b60243567ffffffffffffffff81116105d7576123079036906004016132b4565b612312939193613ad1565b80830361262e575f5b83811061232457005b61232f818585613668565b3561233b828686613668565b355f5260036020526001600160a01b0360405f2054169061235d838589613668565b356001600160801b038116908181036105d75750612379613ad1565b815f52600a60205260ff600160405f20015460a81c16156105c557815f52600a60205260ff600160405f20015460a01c166105b25782156109cc5780156109b957815f5260036020526001600160a01b0360405f20541692838114158061261e575b612604576001600160801b036123f08461431b565b168083116125ea5750825f52600a60205281600260405f20015460801c016001600160801b0381116105335761244f90845f52600a602052600260405f2001906001600160801b036001600160801b031983549260801b169116179055565b825f52600a602052612466600260405f20016136aa565b6001600160801b0361248a81602084015116928260408183511692015116906133fe565b1611156125b8575b825f52600a6020526001600160a01b03600160405f200154166124b6838383614341565b81847f40b88e5c41c5a97ffb7b6ef88a0a2d505aa0c634cf8a0275cb236ea7dd87ed4d6020604051878152a47ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051858152a183331415806125a2575b612527575b5050505060010161231b565b604051926392b9102b60e01b84526004840152336024840152604483015260648201526020816084815f865af19081156104e0576392b9102b60e01b916001600160e01b0319915f91612584575b50160361049f5780808061251b565b61259c915060203d81116104d9576104cb8183613388565b89612575565b50835f52600960205260ff60405f205416612516565b5f838152600a6020526040902060018101805460ff60a01b1916600160a01b179055805460ff60f01b19169055612492565b828463287ecaef60e21b5f5260045260245260445260645ffd5b8263b34359d360e01b5f526004523360245260445260645ffd5b5061262883613b2b565b156123db565b827faec93440000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b346105d75760203660031901126105d757600435805f52600a60205260ff600160405f20015460a81c161561064a57610a84602091613b9d565b346105d75760203660031901126105d757600435805f52600a60205260ff600160405f20015460a81c161561064a575f6126d082613903565b6005811015611248576002036126ee575b6020906040519015158152f35b505f52600a602052602060ff60405f205460f01c166126e1565b346105d7575f3660031901126105d75760206001600160a01b0360085416604051908152f35b346105d75760203660031901126105d75760043561274a613ad1565b805f52600a60205260ff600160405f20015460a81c161561064a57805f52600a60205260ff600160405f20015460a01c16156128c75761278981613b2b565b15611d0e57805f5260036020526001600160a01b0360405f2054161515806128c0575b806128a3575b612891577ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051838152a1805f5260036020526001600160a01b0360405f205416801590811561285a575b825f52600360205260405f206001600160a01b03198154169055825f827fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef8280a45061284857005b637e27328960e01b5f5260045260245ffd5b612879835f52600560205260405f206001600160a01b03198154169055565b805f52600460205260405f205f198154019055612800565b630da9b01360e01b5f5260045260245ffd5b50805f52600a60205260ff600160405f20015460b01c16156127b2565b505f6127ac565b7f817cd639000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b346105d7576111ab6129033661327a565b9060405192612913602085613388565b5f84526136f0565b346105d75760203660031901126105d757600435805f52600a60205260ff600160405f20015460a81c161561064a575f52600a602052602060ff600160405f20015460a01c166040519015158152f35b346105d75760203660031901126105d757600435612987613ad1565b805f52600a60205260ff600160405f20015460a81c161561064a57805f52600a60205260ff600160405f20015460a01c165f146129d057634a5541ef60e01b5f5260045260245ffd5b805f52600a60205260405f205460f81c611d2457612a02815f52600a6020526001600160a01b0360405f205416331490565b15611d0e57612a1081613821565b90805f52600a602052612a28600260405f20016136aa565b916001600160801b038351166001600160801b0382161015611cfb57815f52600a60205260ff60405f205460f01c1615611ce857806001600160801b03602081612a7c9481885116031695015116906133fe565b5f828152600a6020526040902080547dffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff16600160f81b179055916001600160801b038316908115612c1d575b825f52600a602052600360405f20016001600160801b0382166001600160801b0319825416179055825f52600a6020526001600160a01b0360405f205416835f5260036020526001600160a01b0360405f20541694845f52600a60205285827f5edb27d6c1a327513b90a792050debf074b7194444885e3144d4decc5caaaa50612b666001600160a01b03600160405f2001541694611bcf888588614341565b0390a47ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051868152a1845f52600960205260ff60405f205416612ba957005b60405193630d4af11f60e31b855260048501526024840152604483015260648201526020816084815f865af19081156104e057630d4af11f60e31b916001600160e01b0319915f91612bfe5750160361049f57005b612c17915060203d6020116104d9576104cb8183613388565b84610496565b825f52600a602052600160405f2001600160a01b60ff60a01b19825416179055612ac6565b346105d75760203660031901126105d757612c5b61324e565b6001600160a01b035f541690338203612d9a57806001600160a01b03913b15612d6e57166040516301ffc9a760e01b81527ff8ee98d3000000000000000000000000000000000000000000000000000000006004820152602081602481855afa9081156104e0575f91612d3f575b5015612d1457805f52600960205260405f20600160ff198254161790556040519081527fb4378d4e289cb3f40f4f75a99c9cafa76e3df1c4dc31309babc23dc91bd7280160203392a2005b7f7fb843ea000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b612d61915060203d602011612d67575b612d598183613388565b810190613650565b82612cc9565b503d612d4f565b7f5a2b2d83000000000000000000000000000000000000000000000000000000005f521660045260245ffd5b506331b339a960e21b5f526004523360245260445ffd5b346105d75760203660031901126105d7576001600160a01b03612dd261324e565b165f526009602052602060ff60405f2054166040519015158152f35b346105d7576111ab612dff3661327a565b9161341e565b346105d7575f3660031901126105d7576020600754604051908152f35b346105d75760203660031901126105d757600435805f52600a60205260ff600160405f20015460a81c161561064a57612e5a90613903565b6005811015611248578060209115908115612e7b575b506040519015158152f35b600191501482612e70565b346105d75760203660031901126105d757600435805f52600a60205260ff600160405f20015460a81c161561064a576020905f90805f52600a835260ff60405f205460f01c1680612f1b575b612ee9575b506001600160801b0360405191168152f35b612f159150805f52600a8352612f0f6001600160801b03600260405f2001541691613821565b906133fe565b82612ed7565b50805f52600a835260ff600160405f20015460a01c1615612ed2565b346105d75760403660031901126105d757612f5061324e565b602435612f5c81613800565b33151580613029575b80612ff6575b612fca5781906001600160a01b0380851691167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b9255f80a45f5260056020526001600160a01b0360405f2091166001600160a01b03198254161790555f80f35b7fa9fbf51f000000000000000000000000000000000000000000000000000000005f523360045260245ffd5b506001600160a01b0381165f52600660205260405f206001600160a01b0333165f5260205260ff60405f20541615612f6b565b50336001600160a01b0382161415612f65565b346105d75760203660031901126105d75760206120b46004356133dc565b346105d7575f3660031901126105d7576040515f6001548060011c9060018116801561310b575b6020831081146115bc5782855290811561159857506001146130ad57610bbb8361152681850382613388565b91905060015f527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6915f905b8082106130f157509091508101602001611526611516565b9192600181602092548385880101520191019092916130d9565b91607f1691613081565b346105d7575f3660031901126105d757602060405167016345785d8a00008152f35b346105d75760203660031901126105d757600435906001600160e01b031982168092036105d757817f490649060000000000000000000000000000000000000000000000000000000060209314908115613193575b5015158152f35b7f80ac58cd000000000000000000000000000000000000000000000000000000008114915081156131de575b81156131cd575b508361318c565b6301ffc9a760e01b915014836131c6565b7f5b5e139f00000000000000000000000000000000000000000000000000000000811491506131bf565b5f5b8381106132195750505f910152565b818101518382015260200161320a565b9060209161324281518092818552858086019101613208565b601f01601f1916010190565b600435906001600160a01b03821682036105d757565b602435906001600160a01b03821682036105d757565b60609060031901126105d7576004356001600160a01b03811681036105d757906024356001600160a01b03811681036105d7579060443590565b9181601f840112156105d75782359167ffffffffffffffff83116105d7576020808501948460051b0101116105d757565b610100810190811067ffffffffffffffff82111761330257604052565b634e487b7160e01b5f52604160045260245ffd5b6060810190811067ffffffffffffffff82111761330257604052565b610180810190811067ffffffffffffffff82111761330257604052565b610140810190811067ffffffffffffffff82111761330257604052565b6040810190811067ffffffffffffffff82111761330257604052565b90601f8019910116810190811067ffffffffffffffff82111761330257604052565b67ffffffffffffffff811161330257601f01601f191660200190565b604435906001600160801b03821682036105d757565b6133e581613800565b505f5260056020526001600160a01b0360405f20541690565b906001600160801b03809116911603906001600160801b03821161053357565b91906001600160a01b03168015610d2057815f5260036020526001600160a01b0360405f205416151580613648575b8061362b575b613618577ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051848152a1815f5260036020526001600160a01b0360405f20541692823315159283613563575b6001600160a01b0393508561352c575b805f52600460205260405f2060018154019055815f52600360205260405f20816001600160a01b0319825416179055857fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef5f80a41680830361351457505050565b6364283d7b60e01b5f5260045260245260445260645ffd5b61354b825f52600560205260405f206001600160a01b03198154169055565b855f52600460205260405f205f1981540190556134b3565b91929050806135c1575b1561357a578282916134a3565b828461359257637e27328960e01b5f5260045260245ffd5b7f177e802f000000000000000000000000000000000000000000000000000000005f523360045260245260445ffd5b5033841480156135ef575b8061356d5750825f526005602052336001600160a01b0360405f2054161461356d565b50835f52600660205260405f206001600160a01b0333165f5260205260ff60405f2054166135cc565b50630da9b01360e01b5f5260045260245ffd5b50815f52600a60205260ff600160405f20015460b01c1615613453565b50600161344d565b908160209103126105d7575180151581036105d75790565b91908110156136785760051b0190565b634e487b7160e01b5f52603260045260245ffd5b6040519061369982613316565b5f6040838281528260208201520152565b906040516136b781613316565b60406001600160801b03600183958054838116865260801c6020860152015416910152565b60c43564ffffffffff811681036105d75790565b906136fc83828461341e565b803b613709575b50505050565b60209161374f6001600160a01b03809316956040519586948594630a85bd0160e11b86523360048701521660248501526044840152608060648401526084830190613229565b03815f865af15f91816137bf575b5061378b575061376b6142ec565b805190816137865782633250574960e11b5f5260045260245ffd5b602001fd5b6001600160e01b0319630a85bd0160e11b9116036137ad57505f808080613703565b633250574960e11b5f5260045260245ffd5b6137d991925060203d6020116104d9576104cb8183613388565b905f61375d565b908160209103126105d757516001600160e01b0319811681036105d75790565b805f5260036020526001600160a01b0360405f205416908115612848575090565b805f52600b60205264ffffffffff60405f205416815f52600a60205264ffffffffff60405f205460a01c1690421080156138f9575b6138f357815f52600a60205264ffffffffff60405f205460c81c1690814210156138d6578061388892039042036144cf565b815f52600a6020526138ab6001600160801b03600260405f2001541680926145bb565b9081116138c0576001600160801b0391501690565b505f52600a602052600260405f20015460801c90565b50505f52600a6020526001600160801b03600260405f2001541690565b50505f90565b5042811015613856565b805f52600a60205260ff600160405f20015460a01c165f146139255750600490565b805f52600a60205260405f205460f81c61399157805f52600a60205264ffffffffff60405f205460a01c16421061398c5761395f81613821565b905f52600a6020526001600160801b0380600260405f200154169116105f1461398757600190565b600290565b505f90565b50600390565b90805f5260036020526001600160a01b0360405f205416151580613abf575b80613aa2575b612891577ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051838152a1805f5260036020526001600160a01b038060405f2054169283613a6b575b1680613a53575b815f52600360205260405f20816001600160a01b0319825416179055827fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef5f80a490565b805f52600460205260405f2060018154019055613a0f565b613a8a835f52600560205260405f206001600160a01b03198154169055565b835f52600460205260405f205f198154019055613a08565b50805f52600a60205260ff600160405f20015460b01c16156139bc565b506001600160a01b03821615156139b6565b6001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000163003613b0357565b7fa1c0d6e5000000000000000000000000000000000000000000000000000000005f5260045ffd5b805f5260036020526001600160a01b0360405f20541690813314918215613b71575b508115613b58575090565b90506001600160a01b03613b6c33926133dc565b161490565b9091505f52600660205260405f206001600160a01b0333165f5260205260ff60405f205416905f613b4d565b805f52600a602052613bb4600260405f20016136aa565b90805f52600a60205260ff600160405f20015460a01c165f14613be25750602001516001600160801b031690565b90815f52600a60205260405f205460f81c613c045750613c0190613821565b90565b613c0191506001600160801b0360408183511692015116906133fe565b90613c426001600160801b03604084015116602060e0850151015190614398565b916001600160801b0383511660c082015190156142c45764ffffffffff8151161561429c576020810164ffffffffff81511680614210575b5050604064ffffffffff82511691019064ffffffffff82511690818110156141e257505064ffffffffff80421691511690818110156141b45750506007549280516001600160801b03169160405192613cd284613316565b8352602083015f9052604083015f905260608101516001600160a01b03169260c082015190604082015164ffffffffff16946080840195888751151560a087015115159287516001600160a01b0316965164ffffffffff169160405197613d388961334f565b885260208801928352604088019182526060880190815260808801915f835260a0890196875260c08901935f855260e08a0195600187526101008b019788526101208b01998a525f52600a60205260405f2099516001600160a01b03166001600160a01b03168a546001600160a01b031916178a5551908954905160c81b7dffffffffff00000000000000000000000000000000000000000000000000169160a01b78ffffffffff000000000000000000000000000000000000000016907fffff00000000000000000000ffffffffffffffffffffffffffffffffffffffff161717885551151587549060f01b7eff000000000000000000000000000000000000000000000000000000000000169060ff60f01b191617875551151586549060f81b7fff0000000000000000000000000000000000000000000000000000000000000016907effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff161786556001860193516001600160a01b03166001600160a01b031684546001600160a01b03191617845551151583549060a01b74ff0000000000000000000000000000000000000000169060ff60a01b19161783555115159082549051151560b01b76ff00000000000000000000000000000000000000000000169160a81b75ff00000000000000000000000000000000000000000016907fffffffffffffffffff0000ffffffffffffffffffffffffffffffffffffffffff16171790556002820190519081516001600160801b03166001600160801b031681546001600160801b03191617815560208201516001600160801b0316613fb891906001600160801b036001600160801b031983549260801b169116179055565b604001516001600160801b031690600301906001600160801b031681546001600160801b03191617905560c08101516020015164ffffffffff1680614194575b50600185016007556001600160a01b036020820151168015610d2057614026866001600160a01b0392613997565b16614168576140516001600160a01b036060830151166001600160801b038451169030903390614475565b7f44cb432df42caa86b7ec73644ab8aec922bc44c71c98fc330addc75b88adbc7c6101408660208501946001600160801b0386511680614139575b506141306001600160a01b03865116956001600160a01b03602082015116976001600160a01b03606083015116995115156001600160801b0360a0840151151592816001600160a01b0360e060c0880151970151511697604051998a523360208b01525116604089015251166060870152608086015260a085015260c084019064ffffffffff60408092828151168552826020820151166020860152015116910152565b610120820152a4565b614162906001600160a01b036060880151166001600160a01b0360e08901515116903390614475565b5f61408c565b7f73c6ac6e000000000000000000000000000000000000000000000000000000005f525f60045260245ffd5b855f52600b60205260405f209064ffffffffff198254161790555f613ff8565b7f210aec0e000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b7f5057f084000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b64ffffffffff8351168181101561426e57505064ffffffffff90511664ffffffffff60408301511690818110613c7a577f9fee2691000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b7fb39831ea000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b7fd572dbcb000000000000000000000000000000000000000000000000000000005f5260045ffd5b7f6095d3bc000000000000000000000000000000000000000000000000000000005f5260045ffd5b3d15614316573d906142fd826133aa565b9161430b6040519384613388565b82523d5f602084013e565b606090565b613c019061432881613b9d565b905f52600a602052600260405f20015460801c906133fe565b614396926001600160a01b03604051937fa9059cbb000000000000000000000000000000000000000000000000000000006020860152166024840152604483015260448252614391606483613388565b614669565b565b9190916040516143a78161336c565b5f81525f6020820152926001600160801b0382169081156144585767016345785d8a00008111614421576143e36001600160801b0391836145bb565b166020850191818352111561440d576001600160801b039182614408925116906133fe565b168252565b634e487b7160e01b5f52600160045260245ffd5b7f4fea5c1a000000000000000000000000000000000000000000000000000000005f5260045267016345785d8a000060245260445ffd5b50505090506040516144698161336c565b5f81525f602082015290565b9091926001600160a01b036143969481604051957f23b872dd000000000000000000000000000000000000000000000000000000006020880152166024860152166044840152606483015260648252614391608483613388565b5f19670de0b6b3a7640000820991670de0b6b3a764000082029182808510940393808503941461459a578184101561456057670de0b6b3a7640000829109600182190182168092046002816003021880820260020302808202600203028082026002030280820260020302808202600203028091026002030293600183805f03040190848311900302920304170290565b7f63a05778000000000000000000000000000000000000000000000000000000005f52600452670de0b6b3a764000060245260445260645ffd5b50915081156145a7570490565b634e487b7160e01b5f52601260045260245ffd5b9091905f198382098382029182808310920391808303921461465857670de0b6b3a7640000821015614628577faccb18165bd6fe31ae1cf318dc5b51eee0e1ba569b88cd74c1773b91fac106699394670de0b6b3a7640000910990828211900360ee1b910360121c170290565b84907f5173648d000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b5050670de0b6b3a764000090049150565b5f806001600160a01b0361469293169360208151910182865af161468b6142ec565b90836146ee565b80519081151591826146d3575b50506146a85750565b7f5274afe7000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b6146e69250602080918301019101613650565b155f8061469f565b9061472b575080511561470357805190602001fd5b7f1425ea42000000000000000000000000000000000000000000000000000000005f5260045ffd5b81511580614771575b61473c575090565b6001600160a01b03907f9996b315000000000000000000000000000000000000000000000000000000005f521660045260245ffd5b50803b1561473456fea164736f6c634300081a000a";
+ bytes public constant BYTECODE_LOCKUP_TRANCHED =
+ hex"60c0604052346103e457614e2e6060813803918261001c816103e8565b9384928339810103126103e45780516001600160a01b038116908190036103e45760208201516001600160a01b03811692908390036103e4576040015161006360406103e8565b92601e84527f5361626c696572205632204c6f636b7570205472616e63686564204e46540000602085015261009860406103e8565b60118152705341422d56322d4c4f434b55502d54524160781b602082015230608052845190946001600160401b0382116102e75760015490600182811c921680156103da575b60208310146102c95781601f84931161036c575b50602090601f8311600114610306575f926102fb575b50508160011b915f199060031b1c1916176001555b83516001600160401b0381116102e757600254600181811c911680156102dd575b60208210146102c957601f8111610266575b50602094601f8211600114610203579481929394955f926101f8575b50508160011b915f199060031b1c1916176002555b5f80546001600160a01b031990811685178255600880549091169290921790915560405192907fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf808180a360a0526001600755614a20908161040e823960805181613e32015260a051818181612fa10152613edb0152f35b015190505f8061016c565b601f1982169560025f52805f20915f5b88811061024e57508360019596979810610236575b505050811b01600255610181565b01515f1960f88460031b161c191690555f8080610228565b91926020600181928685015181550194019201610213565b60025f527f405787fa12a823e0f2b7631cc41b3ba8828b3321ca811111fa75cd3aa3bb5ace601f830160051c810191602084106102bf575b601f0160051c01905b8181106102b45750610150565b5f81556001016102a7565b909150819061029e565b634e487b7160e01b5f52602260045260245ffd5b90607f169061013e565b634e487b7160e01b5f52604160045260245ffd5b015190505f80610108565b60015f9081528281209350601f198516905b818110610354575090846001959493921061033c575b505050811b0160015561011d565b01515f1960f88460031b161c191690555f808061032e565b92936020600181928786015181550195019301610318565b60015f529091507fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6601f840160051c810191602085106103d0575b90601f859493920160051c01905b8181106103c257506100f2565b5f81558493506001016103b5565b90915081906103a7565b91607f16916100de565b5f80fd5b6040519190601f01601f191682016001600160401b038111838210176102e75760405256fe6080806040526004361015610012575f80fd5b5f3560e01c90816301ffc9a71461330d57508063027b6744146132eb57806306fdde0314613230578063081812fc14613212578063095ea7b31461310d5780631400ecec1461305c5780631c1cdd4c14612ff85780631e99d56914612fdb57806323b872dd14612fc45780632fe4304114612f8a578063303acc8514612f4d57806332fbe22b14612df0578063406887cb14612c8157806340e58ee5146129aa578063425d30dd1461295a57806342842e0e1461293157806342966c681461276d57806344267570146127475780634857501f146126d65780634869e12d1461269c5780634cc55e11146122f657806357404b12146122685780636352211e146122395780636d0cee751461223957806370a08231146121cf57806375829def146121615780637cad6cd1146120705780637de6b1db14611f235780637f5799f914611eca5780638659c27014611b13578063894e9a0d146117d4578063897f362b146115095780638f69b993146114895780639067b6771461143a57806395d89b4114611332578063a22cb4651461127e578063a80fc0711461122d578063ad35efd4146111ce578063b25645691461117e578063b88d4fde146110f4578063b8a3be66146110bf578063b971302a14611071578063bc2be1be14611022578063c156a11d14610c08578063c87b56dd14610afd578063d4dbd20b14610aac578063d511609f14610a61578063d975dfed14610a16578063e985e9c5146109bd578063ea5ead1914610690578063eac8f5b81461063f578063f590c176146105e4578063f851a440146105bf5763fdd46d601461026e575f80fd5b346105bb5760603660031901126105bb5760043561028a61343a565b90604435916001600160801b038316908184036105bb576102a9613e28565b825f52600a60205260ff600160405f20015460a81c16156105a957825f52600a60205260ff600160405f20015460a01c16610596576001600160a01b03811690811561058357821561057057835f5260036020526001600160a01b0360405f205416948583141580610560575b610545576001600160801b0361032b86614680565b1680851161052b575061035090855f52600a602052600260405f20015460801c6146a6565b5f858152600a6020526040902060020180546001600160801b031660809290921b6001600160801b03191691909117815561038a906139ce565b6001600160801b036103ae8160208401511692826040818351169201511690613611565b1611156104f9575b835f52600a6020526103da836001600160a01b03600160405f200154169283614804565b81847f40b88e5c41c5a97ffb7b6ef88a0a2d505aa0c634cf8a0275cb236ea7dd87ed4d6020604051878152a47ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051858152a183331415806104e3575b61044057005b604051926392b9102b60e01b84526004840152336024840152604483015260648201526020816084815f865af19081156104d8576392b9102b60e01b916001600160e01b0319915f916104a9575b50160361049757005b632187e5e760e21b5f5260045260245ffd5b6104cb915060203d6020116104d1575b6104c3818361359d565b810190613b11565b5f61048e565b503d6104b9565b6040513d5f823e3d90fd5b50835f52600960205260ff60405f20541661043a565b5f848152600a6020526040902060018101805460ff60a01b1916600160a01b179055805460ff60f01b191690556103b6565b848663287ecaef60e21b5f5260045260245260445260645ffd5b828563b34359d360e01b5f526004523360245260445260645ffd5b5061056a8561455b565b15610316565b8363d2aabcd960e01b5f5260045260245ffd5b83630ff7ee2d60e31b5f5260045260245ffd5b82634a5541ef60e01b5f5260045260245ffd5b8262b8e7e760e51b5f5260045260245ffd5b5f80fd5b346105bb575f3660031901126105bb5760206001600160a01b035f5416604051908152f35b346105bb5760203660031901126105bb57600435805f52600a60205260ff600160405f20015460a81c161561062e575f52600a602052602060405f205460f81c6040519015158152f35b62b8e7e760e51b5f5260045260245ffd5b346105bb5760203660031901126105bb57600435805f52600a60205260ff600160405f20015460a81c161561062e575f52600a60205260206001600160a01b03600160405f20015416604051908152f35b346105bb5760403660031901126105bb576004356106ac61343a565b6106b582614680565b916106be613e28565b805f52600a60205260ff600160405f20015460a81c161561062e57805f52600a60205260ff600160405f20015460a01c166109ab576001600160a01b0382168015610998576001600160801b03841692831561098557825f5260036020526001600160a01b0360405f205416948583141580610975575b61095a576001600160801b0361074a85614680565b16808611610940575061076f90845f52600a602052600260405f20015460801c6146a6565b5f848152600a6020526040902060020180546001600160801b031660809290921b6001600160801b0319169190911781556107a9906139ce565b6001600160801b036107cd8160208401511692826040818351169201511690613611565b16111561090e575b825f52600a6020526107f9846001600160a01b03600160405f200154169283614804565b81837f40b88e5c41c5a97ffb7b6ef88a0a2d505aa0c634cf8a0275cb236ea7dd87ed4d6020604051888152a47ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051848152a183331415806108f8575b610869575b602083604051908152f35b604051916392b9102b60e01b8352600483015233602483015260448201528160648201526020816084815f875af19081156104d8576392b9102b60e01b916001600160e01b0319915f916108d9575b5016036108c657818061085e565b50632187e5e760e21b5f5260045260245ffd5b6108f2915060203d6020116104d1576104c3818361359d565b856108b8565b50835f52600960205260ff60405f205416610859565b5f838152600a6020526040902060018101805460ff60a01b1916600160a01b179055805460ff60f01b191690556107d5565b858563287ecaef60e21b5f5260045260245260445260645ffd5b828463b34359d360e01b5f526004523360245260445260645ffd5b5061097f8461455b565b15610735565b8263d2aabcd960e01b5f5260045260245ffd5b50630ff7ee2d60e31b5f5260045260245ffd5b634a5541ef60e01b5f5260045260245ffd5b346105bb5760403660031901126105bb576109d6613424565b6001600160a01b036109e661343a565b91165f5260066020526001600160a01b0360405f2091165f52602052602060ff60405f2054166040519015158152f35b346105bb5760203660031901126105bb57600435805f52600a60205260ff600160405f20015460a81c161561062e57610a50602091614680565b6001600160801b0360405191168152f35b346105bb5760203660031901126105bb57600435805f52600a60205260ff600160405f20015460a81c161561062e575f52600a6020526020600260405f20015460801c604051908152f35b346105bb5760203660031901126105bb57600435805f52600a60205260ff600160405f20015460a81c161561062e575f52600a60205260206001600160801b03600360405f20015416604051908152f35b346105bb5760203660031901126105bb57600435610b1a81613b31565b505f6001600160a01b0360085416916044604051809481937fe9dc637500000000000000000000000000000000000000000000000000000000835230600484015260248301525afa80156104d8575f90610b8b575b610b87906040519182916020835260208301906133ff565b0390f35b503d805f833e610b9b818361359d565b8101906020818303126105bb5780519067ffffffffffffffff82116105bb57019080601f830112156105bb57815191610bd3836135bf565b91610be1604051938461359d565b838352602084830101116105bb57610b8792610c0391602080850191016133de565b610b6f565b346105bb5760403660031901126105bb57600435610c2461343a565b610c2c613e28565b815f52600a60205260ff600160405f20015460a81c161561101057815f5260036020526001600160a01b0360405f20541690813303610ff957610c6e83614680565b906001600160801b0382169182158015610d02575b50506001600160a01b03811615610cef57610ca6846001600160a01b0392613cee565b169182610cc05783637e27328960e01b5f5260045260245ffd5b8084918403610cd457602083604051908152f35b9091506364283d7b60e01b5f5260045260245260445260645ffd5b633250574960e11b5f525f60045260245ffd5b610d0a613e28565b855f52600a60205260ff600160405f20015460a81c1615610fe757855f52600a60205260ff600160405f20015460a01c16610fd4578415610fc157610fae57845f5260036020526001600160a01b0360405f205416908185141580610f9e575b610f83576001600160801b03610d7f87614680565b16808511610f695750610da490865f52600a602052600260405f20015460801c6146a6565b5f868152600a6020526040902060020180546001600160801b031660809290921b6001600160801b031916919091178155610dde906139ce565b6001600160801b03610e028160208401511692826040818351169201511690613611565b161115610f37575b845f52600a6020526001600160a01b03600160405f20015416610e2e848683614804565b84867f40b88e5c41c5a97ffb7b6ef88a0a2d505aa0c634cf8a0275cb236ea7dd87ed4d6020604051888152a47ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051878152a18033141580610f21575b610e99575b80610c83565b6040516392b9102b60e01b81528560048201523360248201528460448201528360648201526020816084815f865af19081156104d8576392b9102b60e01b916001600160e01b0319915f91610f02575b501614610e9357632187e5e760e21b5f5260045260245ffd5b610f1b915060203d6020116104d1576104c3818361359d565b88610ee9565b50805f52600960205260ff60405f205416610e8e565b5f858152600a6020526040902060018101805460ff60a01b1916600160a01b179055805460ff60f01b19169055610e0a565b848763287ecaef60e21b5f5260045260245260445260645ffd5b848663b34359d360e01b5f526004523360245260445260645ffd5b50610fa88661455b565b15610d6a565b8463d2aabcd960e01b5f5260045260245ffd5b85630ff7ee2d60e31b5f5260045260245ffd5b85634a5541ef60e01b5f5260045260245ffd5b8562b8e7e760e51b5f5260045260245ffd5b8263216caf0d60e01b5f526004523360245260445ffd5b5062b8e7e760e51b5f5260045260245ffd5b346105bb5760203660031901126105bb57600435805f52600a60205260ff600160405f20015460a81c161561062e575f52600a602052602064ffffffffff60405f205460a01c16604051908152f35b346105bb5760203660031901126105bb57600435805f52600a60205260ff600160405f20015460a81c161561062e575f52600a60205260206001600160a01b0360405f205416604051908152f35b346105bb5760203660031901126105bb576004355f52600a602052602060ff600160405f20015460a81c166040519015158152f35b346105bb5760803660031901126105bb5761110d613424565b61111561343a565b6064359167ffffffffffffffff83116105bb57366023840112156105bb57826004013591611142836135bf565b92611150604051948561359d565b80845236602482870101116105bb576020815f92602461117c9801838801378501015260443591613a21565b005b346105bb5760203660031901126105bb57600435805f52600a60205260ff600160405f20015460a81c161561062e575f52600a602052602060ff600160405f20015460b01c166040519015158152f35b346105bb5760203660031901126105bb57600435805f52600a60205260ff600160405f20015460a81c161561062e5761120690613c5a565b6040516005821015611219576020918152f35b634e487b7160e01b5f52602160045260245ffd5b346105bb5760203660031901126105bb57600435805f52600a60205260ff600160405f20015460a81c161561062e575f52600a60205260206001600160801b03600260405f20015416604051908152f35b346105bb5760403660031901126105bb57611297613424565b602435908115158092036105bb576001600160a01b031690811561130657335f52600660205260405f20825f5260205260405f2060ff1981541660ff83161790556040519081527f17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c3160203392a3005b507f5b08ba18000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b346105bb575f3660031901126105bb576040515f6002548060011c90600181168015611430575b60208310811461141c578285529081156113f8575060011461139a575b610b87836113868185038261359d565b6040519182916020835260208301906133ff565b91905060025f527f405787fa12a823e0f2b7631cc41b3ba8828b3321ca811111fa75cd3aa3bb5ace915f905b8082106113de57509091508101602001611386611376565b9192600181602092548385880101520191019092916113c6565b60ff191660208086019190915291151560051b840190910191506113869050611376565b634e487b7160e01b5f52602260045260245ffd5b91607f1691611359565b346105bb5760203660031901126105bb57600435805f52600a60205260ff600160405f20015460a81c161561062e575f52600a602052602064ffffffffff60405f205460c81c16604051908152f35b346105bb5760203660031901126105bb57600435805f52600a60205260ff600160405f20015460a81c161561062e576114c190613c5a565b60058110158061121957600282149081156114fd575b81156114eb575b6020826040519015158152f35b905061121957600460209114826114de565b5050600381145f6114d7565b346105bb5760203660031901126105bb5760043567ffffffffffffffff81116105bb578036036101206003198201126105bb57611544613e28565b60c482013590602219018112156105bb5781019060048201359167ffffffffffffffff83116105bb5760248101908360061b80360383136105bb57600460209161158d87613875565b9661159b604051988961359d565b875282870193010101913683116105bb57905b8282106117ba575050508151916115c483613875565b926115d2604051948561359d565b808452601f196115e182613875565b015f5b81811061179757505064ffffffffff4216916001600160801b0361160782613b52565b51511664ffffffffff80602061161c85613b52565b510151168501166040519161163083613548565b8252602082015261164086613b52565b5261164a85613b52565b5060015b8281106117225750505061166482600401613a00565b9261167160248401613a00565b9261167e6044820161392e565b916064820135936001600160a01b0385168095036105bb5760209661171a966116da966001600160801b0361170f976001600160a01b036116c160848a01613a14565b94816116cf60a48c01613a14565b976040519d8e61352b565b168c52168c8b0152166040890152606088015215156080870152151560a086015260c085015260e084015260e43691016138c3565b610100820152613e82565b604051908152f35b806001600160801b0361173760019385613b5f565b51511664ffffffffff8060206117505f1986018c613b5f565b510151168160206117618689613b5f565b5101511601166040519161177483613548565b825260208201526117858289613b5f565b526117908188613b5f565b500161164e565b6020906040516117a681613548565b5f81525f83820152828289010152016115e4565b60206040916117c9368561388d565b8152019101906115ae565b346105bb5760203660031901126105bb5760043560606101606040516117f981613564565b5f81525f60208201525f60408201525f838201525f60808201525f60a08201525f60c08201525f60e08201525f6101008201525f61012082015260405161183f81613581565b5f81525f60208201525f60408201526101408201520152805f52600a60205260ff600160405f20015460a81c161561062e57805f52600a60205260405f2060405191610140830183811067ffffffffffffffff821117611aff576040528154916001600160a01b0383168452602084019264ffffffffff8160a01c168452604085019064ffffffffff8160c81c16825285606081019260ff8360f01c1615158452608082019260f81c1515835260018501549260a08301956001600160a01b038516875261193c600260c086019260ff8860a01c161515845260ff61010060e0890198828b60a81c1615158a52019860b01c1615158852016139ce565b6101208b0190815261194d89613c5a565b600581101561121957600214611af7575b5196516001600160a01b0316925164ffffffffff169551151590511515935115159451151595885f52600360205260405f20546001600160a01b03169a516001600160a01b0316995164ffffffffff16985f52600b60205260405f2092511515926040519a6119cc8c613564565b8b5260208b019b8c5260408b01998a5260608b0191825260808b0192835260a08b0193845260c08b0194855260e08b019586526101008b019687526101208b019788526101408b01988952611a209061395a565b986101608b01998a526040519b8c9b60208d52516001600160a01b031660208d0152516001600160a01b031660408c01525164ffffffffff1660608b01525164ffffffffff1660808a015251151560a089015251151560c0880152516001600160a01b031660e08701525115156101008601525115156101208501525115156101408401525180516001600160801b031661016084015260208101516001600160801b0316610180840152604001516001600160801b03166101a0830152516101c082016101c090526101e08201610b87916134cf565b5f875261195e565b634e487b7160e01b5f52604160045260245ffd5b346105bb5760203660031901126105bb5760043567ffffffffffffffff81116105bb57611b4490369060040161349e565b90611b4d613e28565b5f915b808310611b5957005b611b6483828461390a565b3592611b6e613e28565b835f52600a60205260ff600160405f20015460a81c1615611eb857835f52600a60205260ff600160405f20015460a01c165f14611bb85783634a5541ef60e01b5f5260045260245ffd5b909192805f52600a60205260405f205460f81c611ea657611bed815f52600a6020526001600160a01b0360405f205416331490565b15611e9057611bfb81613b73565b90805f52600a602052611c13600260405f20016139ce565b916001600160801b038351166001600160801b0382161015611e7d57815f52600a60205260ff60405f205460f01c1615611e6a57806001600160801b03602081611c67948188511603169501511690613611565b5f828152600a6020526040902080547dffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff16600160f81b179055916001600160801b038316908115611e45575b825f52600a602052600360405f20016001600160801b0382166001600160801b0319825416179055825f52600a6020526001600160a01b0360405f205416835f5260036020526001600160a01b0360405f20541694845f52600a60205285827f5edb27d6c1a327513b90a792050debf074b7194444885e3144d4decc5caaaa50611d796001600160a01b03600160405f2001541694611d51888588614804565b604080518b81526001600160801b03808b166020830152909216908201529081906060820190565b0390a47ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051868152a1845f52600960205260ff60405f205416611dca575b50505050506001019190611b50565b60405193630d4af11f60e31b855260048501526024840152604483015260648201526020816084815f865af19081156104d857630d4af11f60e31b916001600160e01b0319915f91611e27575b5016036104975780808080611dbb565b611e3f915060203d81116104d1576104c3818361359d565b87611e17565b825f52600a602052600160405f2001600160a01b60ff60a01b19825416179055611cb1565b506339c6dc7360e21b5f5260045260245ffd5b506322cad1af60e11b5f5260045260245ffd5b63216caf0d60e01b5f526004523360245260445ffd5b63fe19f19f60e01b5f5260045260245ffd5b8362b8e7e760e51b5f5260045260245ffd5b346105bb5760203660031901126105bb57600435805f52600a60205260ff600160405f20015460a81c161561062e575f52600b602052610b87611f0f60405f2061395a565b6040519182916020835260208301906134cf565b346105bb5760203660031901126105bb57600435611f3f613e28565b805f52600a60205260ff600160405f20015460a81c161561062e57611f6381613c5a565b60058110156112195760048103611f875750634a5541ef60e01b5f5260045260245ffd5b60038103611fa2575063fe19f19f60e01b5f5260045260245ffd5b60021461205e57611fc7815f52600a6020526001600160a01b0360405f205416331490565b15611e9057805f52600a60205260ff60405f205460f01c161561204c576020817ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce7925f52600a825260405f2060ff60f01b19815416905560405190807f0eb069207093cd3e51cd1370d2d369770057fbe29947e577e5fb428c6c6fc78f5f80a28152a1005b6339c6dc7360e21b5f5260045260245ffd5b6322cad1af60e11b5f5260045260245ffd5b346105bb5760203660031901126105bb576004356001600160a01b0381168091036105bb576001600160a01b035f541633810361214b575060085490806001600160a01b03198316176008556001600160a01b036040519216825260208201527fa2548bd4b805e907c1558a47b5858324fe8bb4a2e1ddfca647eecbf65610eebc60403392a26007545f1981019081116121375760407f6bd5c950a8d8df17f772f5af37cb3655737899cbf903264b9795592da439661c91815190600182526020820152a1005b634e487b7160e01b5f52601160045260245ffd5b6331b339a960e21b5f526004523360245260445ffd5b346105bb5760203660031901126105bb5761217a613424565b5f546001600160a01b03811633810361214b57506001600160a01b036001600160a01b0319921691829116175f55337fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf805f80a3005b346105bb5760203660031901126105bb576001600160a01b036121f0613424565b16801561220d575f526004602052602060405f2054604051908152f35b7f89c62b64000000000000000000000000000000000000000000000000000000005f525f60045260245ffd5b346105bb5760203660031901126105bb576020612257600435613b31565b6001600160a01b0360405191168152f35b346105bb5760203660031901126105bb57600435612284613942565b50805f52600a60205260ff600160405f20015460a81c161561062e575f908152600a6020526040908190205481519064ffffffffff60c882901c81169160a01c166122ce83613548565b825260208201526122f48251809264ffffffffff60208092828151168552015116910152565bf35b346105bb5760403660031901126105bb5760043567ffffffffffffffff81116105bb5761232790369060040161349e565b9060243567ffffffffffffffff81116105bb5761234890369060040161349e565b919092612353613e28565b82810361266c575f5b81811061236557005b61237081838561390a565b3561237c82848661390a565b355f5260036020526001600160a01b0360405f205416906123a66123a184888a61390a565b61392e565b916123af613e28565b815f52600a60205260ff600160405f20015460a81c161561101057815f52600a60205260ff600160405f20015460a01c16612659578015610998576001600160801b03831690811561098557825f5260036020526001600160a01b0360405f205416938482141580612649575b61262e576001600160801b0361243185614680565b16808411612614575061245690845f52600a602052600260405f20015460801c6146a6565b5f848152600a6020526040902060020180546001600160801b031660809290921b6001600160801b031916919091178155612490906139ce565b6001600160801b036124b48160208401511692826040818351169201511690613611565b1611156125e2575b825f52600a6020526001600160a01b03600160405f200154166124e0838383614804565b81847f40b88e5c41c5a97ffb7b6ef88a0a2d505aa0c634cf8a0275cb236ea7dd87ed4d6020604051878152a47ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051858152a183331415806125cc575b612551575b5050505060010161235c565b604051926392b9102b60e01b84526004840152336024840152604483015260648201526020816084815f865af19081156104d8576392b9102b60e01b916001600160e01b0319915f916125ae575b50160361049757808080612545565b6125c6915060203d81116104d1576104c3818361359d565b8961259f565b50835f52600960205260ff60405f205416612540565b5f838152600a6020526040902060018101805460ff60a01b1916600160a01b179055805460ff60f01b191690556124bc565b838563287ecaef60e21b5f5260045260245260445260645ffd5b508263b34359d360e01b5f526004523360245260445260645ffd5b506126538461455b565b1561241c565b50634a5541ef60e01b5f5260045260245ffd5b90507faec93440000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b346105bb5760203660031901126105bb57600435805f52600a60205260ff600160405f20015460a81c161561062e57610a506020916145cd565b346105bb5760203660031901126105bb57600435805f52600a60205260ff600160405f20015460a81c161561062e575f61270f82613c5a565b60058110156112195760020361272d575b6020906040519015158152f35b505f52600a602052602060ff60405f205460f01c16612720565b346105bb575f3660031901126105bb5760206001600160a01b0360085416604051908152f35b346105bb5760203660031901126105bb57600435612789613e28565b805f52600a60205260ff600160405f20015460a81c161561062e57805f52600a60205260ff600160405f20015460a01c1615612906576127c88161455b565b15611e9057805f5260036020526001600160a01b0360405f2054161515806128ff575b806128e2575b6128d0577ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051838152a1805f5260036020526001600160a01b0360405f2054168015908115612899575b825f52600360205260405f206001600160a01b03198154169055825f827fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef8280a45061288757005b637e27328960e01b5f5260045260245ffd5b6128b8835f52600560205260405f206001600160a01b03198154169055565b805f52600460205260405f205f19815401905561283f565b630da9b01360e01b5f5260045260245ffd5b50805f52600a60205260ff600160405f20015460b01c16156127f1565b505f6127eb565b7f817cd639000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b346105bb5761117c61294236613464565b906040519261295260208561359d565b5f8452613a21565b346105bb5760203660031901126105bb57600435805f52600a60205260ff600160405f20015460a81c161561062e575f52600a602052602060ff600160405f20015460a01c166040519015158152f35b346105bb5760203660031901126105bb576004356129c6613e28565b805f52600a60205260ff600160405f20015460a81c161561062e57805f52600a60205260ff600160405f20015460a01c165f14612a0f57634a5541ef60e01b5f5260045260245ffd5b805f52600a60205260405f205460f81c611ea657612a41815f52600a6020526001600160a01b0360405f205416331490565b15611e9057612a4f81613b73565b90805f52600a602052612a67600260405f20016139ce565b916001600160801b038351166001600160801b0382161015611e7d57815f52600a60205260ff60405f205460f01c1615611e6a57806001600160801b03602081612abb948188511603169501511690613611565b5f828152600a6020526040902080547dffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff16600160f81b179055916001600160801b038316908115612c5c575b825f52600a602052600360405f20016001600160801b0382166001600160801b0319825416179055825f52600a6020526001600160a01b0360405f205416835f5260036020526001600160a01b0360405f20541694845f52600a60205285827f5edb27d6c1a327513b90a792050debf074b7194444885e3144d4decc5caaaa50612ba56001600160a01b03600160405f2001541694611d51888588614804565b0390a47ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051868152a1845f52600960205260ff60405f205416612be857005b60405193630d4af11f60e31b855260048501526024840152604483015260648201526020816084815f865af19081156104d857630d4af11f60e31b916001600160e01b0319915f91612c3d5750160361049757005b612c56915060203d6020116104d1576104c3818361359d565b8461048e565b825f52600a602052600160405f2001600160a01b60ff60a01b19825416179055612b05565b346105bb5760203660031901126105bb57612c9a613424565b6001600160a01b035f541690338203612dd957806001600160a01b03913b15612dad57166040516301ffc9a760e01b81527ff8ee98d3000000000000000000000000000000000000000000000000000000006004820152602081602481855afa9081156104d8575f91612d7e575b5015612d5357805f52600960205260405f20600160ff198254161790556040519081527fb4378d4e289cb3f40f4f75a99c9cafa76e3df1c4dc31309babc23dc91bd7280160203392a2005b7f7fb843ea000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b612da0915060203d602011612da6575b612d98818361359d565b8101906138f2565b82612d08565b503d612d8e565b7f5a2b2d83000000000000000000000000000000000000000000000000000000005f521660045260245ffd5b506331b339a960e21b5f526004523360245260445ffd5b346105bb5760203660031901126105bb5760043567ffffffffffffffff81116105bb5761014060031982360301126105bb57612e2a613e28565b604051612e368161352b565b612e4282600401613450565b8152612e5060248301613450565b6020820152612e61604483016135db565b604082015260648201356001600160a01b03811681036105bb576060820152612e8c6084830161351e565b6080820152612e9d60a4830161351e565b60a0820152612eae60c48301613863565b60c082015260e482013567ffffffffffffffff81116105bb57820191366023840112156105bb57600483013592612ee484613875565b90612ef2604051928361359d565b848252602060048184019660061b83010101903682116105bb57602401945b818610612f3357602061171a8661170f878760e08401526101043691016138c3565b6020604091612f42368961388d565b815201950194612f11565b346105bb5760203660031901126105bb576001600160a01b03612f6e613424565b165f526009602052602060ff60405f2054166040519015158152f35b346105bb575f3660031901126105bb5760206040517f00000000000000000000000000000000000000000000000000000000000000008152f35b346105bb5761117c612fd536613464565b91613631565b346105bb575f3660031901126105bb576020600754604051908152f35b346105bb5760203660031901126105bb57600435805f52600a60205260ff600160405f20015460a81c161561062e5761303090613c5a565b6005811015611219578060209115908115613051575b506040519015158152f35b600191501482613046565b346105bb5760203660031901126105bb57600435805f52600a60205260ff600160405f20015460a81c161561062e576020905f90805f52600a835260ff60405f205460f01c16806130f1575b6130bf575b506001600160801b0360405191168152f35b6130eb9150805f52600a83526130e56001600160801b03600260405f2001541691613b73565b90613611565b826130ad565b50805f52600a835260ff600160405f20015460a01c16156130a8565b346105bb5760403660031901126105bb57613126613424565b60243561313281613b31565b331515806131ff575b806131cc575b6131a05781906001600160a01b0380851691167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b9255f80a45f5260056020526001600160a01b0360405f2091166001600160a01b03198254161790555f80f35b7fa9fbf51f000000000000000000000000000000000000000000000000000000005f523360045260245ffd5b506001600160a01b0381165f52600660205260405f206001600160a01b0333165f5260205260ff60405f20541615613141565b50336001600160a01b038216141561313b565b346105bb5760203660031901126105bb5760206122576004356135ef565b346105bb575f3660031901126105bb576040515f6001548060011c906001811680156132e1575b60208310811461141c578285529081156113f8575060011461328357610b87836113868185038261359d565b91905060015f527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6915f905b8082106132c757509091508101602001611386611376565b9192600181602092548385880101520191019092916132af565b91607f1691613257565b346105bb575f3660031901126105bb57602060405167016345785d8a00008152f35b346105bb5760203660031901126105bb57600435906001600160e01b031982168092036105bb57817f490649060000000000000000000000000000000000000000000000000000000060209314908115613369575b5015158152f35b7f80ac58cd000000000000000000000000000000000000000000000000000000008114915081156133b4575b81156133a3575b5083613362565b6301ffc9a760e01b9150148361339c565b7f5b5e139f0000000000000000000000000000000000000000000000000000000081149150613395565b5f5b8381106133ef5750505f910152565b81810151838201526020016133e0565b90602091613418815180928185528580860191016133de565b601f01601f1916010190565b600435906001600160a01b03821682036105bb57565b602435906001600160a01b03821682036105bb57565b35906001600160a01b03821682036105bb57565b60609060031901126105bb576004356001600160a01b03811681036105bb57906024356001600160a01b03811681036105bb579060443590565b9181601f840112156105bb5782359167ffffffffffffffff83116105bb576020808501948460051b0101116105bb57565b90602080835192838152019201905f5b8181106134ec5750505090565b825180516001600160801b0316855260209081015164ffffffffff1681860152604090940193909201916001016134df565b359081151582036105bb57565b610120810190811067ffffffffffffffff821117611aff57604052565b6040810190811067ffffffffffffffff821117611aff57604052565b610180810190811067ffffffffffffffff821117611aff57604052565b6060810190811067ffffffffffffffff821117611aff57604052565b90601f8019910116810190811067ffffffffffffffff821117611aff57604052565b67ffffffffffffffff8111611aff57601f01601f191660200190565b35906001600160801b03821682036105bb57565b6135f881613b31565b505f5260056020526001600160a01b0360405f20541690565b906001600160801b03809116911603906001600160801b03821161213757565b91906001600160a01b03168015610cef57815f5260036020526001600160a01b0360405f20541615158061385b575b8061383e575b61382b577ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051848152a1815f5260036020526001600160a01b0360405f20541692823315159283613776575b6001600160a01b0393508561373f575b805f52600460205260405f2060018154019055815f52600360205260405f20816001600160a01b0319825416179055857fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef5f80a41680830361372757505050565b6364283d7b60e01b5f5260045260245260445260645ffd5b61375e825f52600560205260405f206001600160a01b03198154169055565b855f52600460205260405f205f1981540190556136c6565b91929050806137d4575b1561378d578282916136b6565b82846137a557637e27328960e01b5f5260045260245ffd5b7f177e802f000000000000000000000000000000000000000000000000000000005f523360045260245260445ffd5b503384148015613802575b806137805750825f526005602052336001600160a01b0360405f20541614613780565b50835f52600660205260405f206001600160a01b0333165f5260205260ff60405f2054166137df565b50630da9b01360e01b5f5260045260245ffd5b50815f52600a60205260ff600160405f20015460b01c1615613666565b506001613660565b359064ffffffffff821682036105bb57565b67ffffffffffffffff8111611aff5760051b60200190565b91908260409103126105bb576040516138a581613548565b60206138be8183956138b6816135db565b855201613863565b910152565b91908260409103126105bb576040516138db81613548565b60208082946138e981613450565b84520135910152565b908160209103126105bb575180151581036105bb5790565b919081101561391a5760051b0190565b634e487b7160e01b5f52603260045260245ffd5b356001600160801b03811681036105bb5790565b6040519061394f82613548565b5f6020838281520152565b90815461396681613875565b92613974604051948561359d565b81845260208401905f5260205f205f915b8383106139925750505050565b6001602081926040516139a481613548565b64ffffffffff86546001600160801b038116835260801c1683820152815201920192019190613985565b906040516139db81613581565b60406001600160801b03600183958054838116865260801c6020860152015416910152565b356001600160a01b03811681036105bb5790565b3580151581036105bb5790565b90613a2d838284613631565b803b613a3a575b50505050565b602091613a806001600160a01b03809316956040519586948594630a85bd0160e11b865233600487015216602485015260448401526080606484015260848301906133ff565b03815f865af15f9181613af0575b50613abc5750613a9c614651565b80519081613ab75782633250574960e11b5f5260045260245ffd5b602001fd5b6001600160e01b0319630a85bd0160e11b911603613ade57505f808080613a34565b633250574960e11b5f5260045260245ffd5b613b0a91925060203d6020116104d1576104c3818361359d565b905f613a8e565b908160209103126105bb57516001600160e01b0319811681036105bb5790565b805f5260036020526001600160a01b0360405f205416908115612887575090565b80511561391a5760200190565b805182101561391a5760209160051b010190565b9064ffffffffff421691805f52600b602052613b9160405f2061395a565b908364ffffffffff6020613ba485613b52565b5101511611613c5357805f52600a6020528364ffffffffff60405f205460c81c161115613c3457506001600160801b03613bdd82613b52565b515116916001925b8251841015613c2d578464ffffffffff6020613c018787613b5f565b5101511611613c2d576001600160801b0360019181613c208787613b5f565b5151160116930192613be5565b9350915050565b919250505f52600a6020526001600160801b03600260405f2001541690565b505f925050565b805f52600a60205260ff600160405f20015460a01c165f14613c7c5750600490565b805f52600a60205260405f205460f81c613ce857805f52600a60205264ffffffffff60405f205460a01c164210613ce357613cb681613b73565b905f52600a6020526001600160801b0380600260405f200154169116105f14613cde57600190565b600290565b505f90565b50600390565b90805f5260036020526001600160a01b0360405f205416151580613e16575b80613df9575b6128d0577ff8e1a15aba9398e019f0b49df1a4fde98ee17ae345cb5f6b5e2c27f5033e8ce76020604051838152a1805f5260036020526001600160a01b038060405f2054169283613dc2575b1680613daa575b815f52600360205260405f20816001600160a01b0319825416179055827fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef5f80a490565b805f52600460205260405f2060018154019055613d66565b613de1835f52600560205260405f206001600160a01b03198154169055565b835f52600460205260405f205f198154019055613d5f565b50805f52600a60205260ff600160405f20015460b01c1615613d13565b506001600160a01b0382161515613d0d565b6001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000163003613e5a57565b7fa1c0d6e5000000000000000000000000000000000000000000000000000000005f5260045ffd5b90613ea46001600160801b0360408401511660206101008501510151906146c6565b916001600160801b038351169060e08101519160c082019264ffffffffff845116821561453357801561450b57815180156144e3577f000000000000000000000000000000000000000000000000000000000000000081116144b8575064ffffffffff6020613f1284613b52565b5101511681101561447457505f905f905f81515f905b8082106143ec575050505064ffffffffff804216911690818110156143be5750506001600160801b03169081810361439057505060075493845f52600a60205260405f20916001600160801b038251166001600160801b036002850191166001600160801b03198254161790556001600160a01b03606082015116916001600160a01b036001850193166001600160a01b031984541617835560808201948551151560ff60f01b197eff00000000000000000000000000000000000000000000000000000000000087549260f01b169116178555835493750100000000000000000000000000000000000000000060a08501957fffffffffffffffffff0000ffffffffffffffffffffffffffffffffffffffffff76ff000000000000000000000000000000000000000000008851151560b01b169116171790556001600160a01b0380845116166001600160a01b03198654161785555184549060e0840151917fffff00000000000000000000ffffffffffffffffffffffffffffffffffffffff78ffffffffff00000000000000000000000000000000000000007dffffffffff0000000000000000000000000000000000000000000000000060206140f48751975f19890190613b5f565b51015160c81b169360a01b169116171785555f5b8181106142de575050600187016007556001600160a01b036020830151168015610cef5761413e886001600160a01b0392613cee565b166142b257868261418c6001600160a01b0360607ffeb1cb9ce021c8bd5fb1eb836e6284c68866fa32d1d844238de19955238f8076960151166001600160801b0385511690309033906147a3565b6001600160801b0360208401511680614282575b506001600160a01b03815116946142776142596001600160a01b03602085015116986001600160a01b036060860151169a511515935115156001600160a01b0361010060e088015193549764ffffffffff604051996141fe8b613548565b818160a01c168b5260c81c1660208a015201515116946001600160801b0360206040519a8b9a8b5233828c01528281511660408c01520151166060890152608088015260a087015261014060c08701526101408601906134cf565b9260e085019064ffffffffff60208092828151168552015116910152565b6101208301520390a4565b6142ac906001600160a01b036060840151166001600160a01b0361010085015151169033906147a3565b5f6141a0565b7f73c6ac6e000000000000000000000000000000000000000000000000000000005f525f60045260245ffd5b885f52600b60205260405f20906142f98160e0870151613b5f565b5182549268010000000000000000841015611aff576001840180825584101561391a576001936020915f52815f2001916001600160801b0380825116166001600160801b031984541617835501517fffffffffffffffffffffff0000000000ffffffffffffffffffffffffffffffff74ffffffffff0000000000000000000000000000000083549260801b16911617905501614108565b7f6375ff13000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b7f210aec0e000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b9193509193614410906001600160801b036144078588613b5f565b515116906146a6565b9364ffffffffff8060206144248685613b5f565b5101511694168085111561444057506001849301909291613f28565b8490847fd97494c6000000000000000000000000000000000000000000000000000000005f5260045260245260445260645ffd5b64ffffffffff602061448584613b52565b51015116907ff1fb2cc5000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b7f73627f74000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b7f7ea4ccdf000000000000000000000000000000000000000000000000000000005f5260045ffd5b7fd572dbcb000000000000000000000000000000000000000000000000000000005f5260045ffd5b7f6095d3bc000000000000000000000000000000000000000000000000000000005f5260045ffd5b805f5260036020526001600160a01b0360405f205416908133149182156145a1575b508115614588575090565b90506001600160a01b0361459c33926135ef565b161490565b9091505f52600660205260405f206001600160a01b0333165f5260205260ff60405f205416905f61457d565b805f52600a6020526145e4600260405f20016139ce565b90805f52600a60205260ff600160405f20015460a01c165f146146125750602001516001600160801b031690565b90815f52600a60205260405f205460f81c614634575061463190613b73565b90565b61463191506001600160801b036040818351169201511690613611565b3d1561467b573d90614662826135bf565b91614670604051938461359d565b82523d5f602084013e565b606090565b6146319061468d816145cd565b905f52600a602052600260405f20015460801c90613611565b906001600160801b03809116911601906001600160801b03821161213757565b9190916040516146d581613548565b5f81525f6020820152926001600160801b0382169081156147865767016345785d8a0000811161474f576147116001600160801b0391836148d9565b166020850191818352111561473b576001600160801b03918261473692511690613611565b168252565b634e487b7160e01b5f52600160045260245ffd5b7f4fea5c1a000000000000000000000000000000000000000000000000000000005f5260045267016345785d8a000060245260445ffd5b505050905060405161479781613548565b5f81525f602082015290565b9091926001600160a01b036148029481604051957f23b872dd0000000000000000000000000000000000000000000000000000000060208801521660248601521660448401526064830152606482526147fd60848361359d565b614854565b565b614802926001600160a01b03604051937fa9059cbb0000000000000000000000000000000000000000000000000000000060208601521660248401526044830152604482526147fd60648361359d565b5f806001600160a01b0361487d93169360208151910182865af1614876614651565b9083614987565b80519081151591826148be575b50506148935750565b7f5274afe7000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b6148d192506020809183010191016138f2565b155f8061488a565b9091905f198382098382029182808310920391808303921461497657670de0b6b3a7640000821015614946577faccb18165bd6fe31ae1cf318dc5b51eee0e1ba569b88cd74c1773b91fac106699394670de0b6b3a7640000910990828211900360ee1b910360121c170290565b84907f5173648d000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b5050670de0b6b3a764000090049150565b906149c4575080511561499c57805190602001fd5b7f1425ea42000000000000000000000000000000000000000000000000000000005f5260045ffd5b81511580614a0a575b6149d5575090565b6001600160a01b03907f9996b315000000000000000000000000000000000000000000000000000000005f521660045260245ffd5b50803b156149cd56fea164736f6c634300081a000a";
+ bytes public constant BYTECODE_NFT_DESCRIPTOR =
+ hex"60808060405234601557615eaf908161001a8239f35b5f80fdfe6102406040526004361015610012575f80fd5b5f3560e01c63e9dc637514610025575f80fd5b346141bf5760403660031901126141bf576001600160a01b036004351680600435036141bf576103e06040525f61024081905260606102608190526102808290526102a08290526102c08190526102e0819052610320819052610340819052610360819052610380526103a08190526103c0526103008190526100b6906100ad600435614827565b61032052614a3d565b61034052610300516040517feac8f5b80000000000000000000000000000000000000000000000000000000081526024803560048301529091602091839182906001600160a01b03165afa9081156145bb575f91614684575b506001600160a01b0361012791168061024052614b39565b61026052610300516040517fa80fc0710000000000000000000000000000000000000000000000000000000081526024803560048301529091602091839182906001600160a01b03165afa80156145bb576fffffffffffffffffffffffffffffffff915f91614665575b501661028052610300516040517fad35efd40000000000000000000000000000000000000000000000000000000081526024803560048301529091602091839182906001600160a01b03165afa80156145bb575f90614628575b6101f59150614cdb565b61036052610300516040517f4869e12d0000000000000000000000000000000000000000000000000000000081526024803560048301529091602091839182906001600160a01b03165afa9081156145bb575f916145f9575b50610280516fffffffffffffffffffffffffffffffff1680156145e5576fffffffffffffffffffffffffffffffff612710819302160416610160610240015260405160208101904682526bffffffffffffffffffffffff1960043560601b1660408201526024356054820152605481526102c9607482614713565b51902061040a60028061016861ffff8560101c160693600161031c63ffffffff601e61031482601461030c82604660ff6050818d60081c16069b16069d16615408565b970116615408565b980116615408565b60246040519788947f68736c2800000000000000000000000000000000000000000000000000000000602087015261035d815180926020868a0191016146cd565b85017f2c00000000000000000000000000000000000000000000000000000000000000838201526103988251809360206025850191016146cd565b01017f252c000000000000000000000000000000000000000000000000000000000000838201526103d38251809360206003850191016146cd565b01017f2529000000000000000000000000000000000000000000000000000000000000838201520301601d19810184520182614713565b6104446fffffffffffffffffffffffffffffffff604061024001511660ff61043d6001600160a01b036102405116614ddb565b1690614f41565b9061045a6001600160a01b036102405116614a3d565b6020610240015190602460206001600160a01b0360c0610240015116604051928380927fbc2be1be000000000000000000000000000000000000000000000000000000008252823560048301525afa80156145bb576024915f916145c6575b5060206001600160a01b0360c0610240015116604051938480927f9067b677000000000000000000000000000000000000000000000000000000008252823560048301525afa80156145bb5764ffffffffff8091610521945f9161458c575b50169116615237565b610340516103a05190939091906105ac600161054a60646105438188066158b3565b9604615408565b6020604051968261056489945180928580880191016146cd565b8301610578825180938580850191016146cd565b01017f2500000000000000000000000000000000000000000000000000000000000000815203601e19810186520184614713565b61016061024001519361012061024001519760e061024001519760405161016052610140610160510161016051811067ffffffffffffffff821117614578576040526101605152602061016051015260406101605101526060610160510152608061016051015260a061016051015260c061016051015260e06101605101526101006101605101526101206101605101526040516101c0810181811067ffffffffffffffff82111761457857604052606081525f60208201525f60408201526060808201525f6080820152606060a08201525f60c08201525f60e082015260606101008201525f6101208201525f61014082015260606101608201525f6101808201525f6101a082015260a06101605101516108eb6109ca60046007602760586106e260c06101605101516101605151906159b4565b60b76106ed5f615ca7565b985f6102205260206102205261071560405161070c6102205182614713565b5f8152846156d2565b1561456e57601b60909a5b6107298c615408565b906040519b8c9889937f3c672069643d220000000000000000000000000000000000000000000000000061022051860152835161076f81846102205188019801886146cd565b8b017f222066696c6c3d2223666666223e000000000000000000000000000000000000838201527f3c726563742077696474683d220000000000000000000000000000000000000060358201526107d282518093604284019061022051016146cd565b0101917f22206865696768743d22313030222066696c6c2d6f7061636974793d222e3033858401527f222072783d223135222072793d22313522207374726f6b653d22236666662220603b8401527f7374726f6b652d6f7061636974793d222e3122207374726f6b652d7769647468605b8401527f3d2234222f3e0000000000000000000000000000000000000000000000000000607b8401527f3c7465787420783d2232302220793d2233342220666f6e742d66616d696c793d60818401527f2227436f7572696572204e6577272c417269616c2c6d6f6e6f7370616365222060a18401527f666f6e742d73697a653d2232327078223e00000000000000000000000000000060c184015251809360d28401906146cd565b0101661e17ba32bc3a1f60c91b838201527f3c7465787420783d2232302220793d2237322220666f6e742d66616d696c793d60be8201527f2227436f7572696572204e6577272c417269616c2c6d6f6e6f7370616365222060de8201527f666f6e742d73697a653d2232367078223e00000000000000000000000000000060fe8201526109858251809361010f84019061022051016146cd565b0101661e17ba32bc3a1f60c91b838201526109ac82518093605f84019061022051016146cd565b0101631e17b39f60e11b838201520301601b19810184520182614713565b6101008301526101208201526101206101605101516108eb610a3860046007602760586040516109fd6102205182614713565b5f815260b7610a0c6001615ca7565b98601b6028610a1a8c615db2565b610a2384615e2a565b8082111561456757505b019a6107298c615408565b61016083015261018082015260206101605101516108eb610a796004600760276058604051610a6a6102205182614713565b5f815260b7610a0c6002615ca7565b8252602082015260286080610160510151604051610a9a6102205182614713565b5f81526108eb610ae46004600760276058610ab56003615ca7565b9660b7610ac189615db2565b610aca8b615e2a565b8082111561455f5750995b601b8c8c019a6107298c615408565b60a085015260c0840152602083015101016101208201510161018082015101603081016080830152602f19906103e8030160011c8061014083015261012082015101601081016101a083015261018082015101610220518101604083015260106102205191602084015101010160e0820152610b7361010082015161016083015183519060a085015192614ed4565b60608201526101006101208190526040516101a0819052610b949190614713565b60c76101a051527f3c726563742077696474683d223130302522206865696768743d223130302522610220516101a05101527f2066696c7465723d2275726c28234e6f69736529222f3e3c7265637420783d2260406101a05101527f37302220793d223730222077696474683d2238363022206865696768743d223860606101a05101527f3630222066696c6c3d2223666666222066696c6c2d6f7061636974793d222e3060806101a05101527f33222072783d223435222072793d22343522207374726f6b653d22236666662260a06101a05101527f207374726f6b652d6f7061636974793d222e3122207374726f6b652d7769647460c06101a05101527f683d2234222f3e0000000000000000000000000000000000000000000000000060e06101a05101526101605151610120610160510151906060830151610140525f610200526060610200526040516101e052610cf6610200516101e051614713565b60336101e051527f3c636972636c652069643d22476c6f772220723d22353030222066696c6c3d22610220516101e05101527f75726c282352616469616c476c6f7729222f3e0000000000000000000000000060406101e051015261014060405190610d628183614713565b61011c82527f3c66696c7465722069643d224e6f697365223e3c6665466c6f6f6420783d2230610220518301527f2220793d2230222077696474683d223130302522206865696768743d2231303060408301527f252220666c6f6f642d636f6c6f723d2268736c283233302c3231252c31312529610200518301527f2220666c6f6f642d6f7061636974793d22312220726573756c743d22666c6f6f60808301527f6446696c6c222f3e3c666554757262756c656e6365206261736546726571756560a08301527f6e63793d222e3422206e756d4f6374617665733d22332220726573756c743d2260c08301527f4e6f6973652220747970653d226672616374616c4e6f697365222f3e3c66654260e08301527f6c656e6420696e3d224e6f6973652220696e323d22666c6f6f6446696c6c2220610120518301527f6d6f64653d22736f66742d6c69676874222f3e3c2f66696c7465723e000000006101208301525f6101c0526103a06101c0526119416118bc6073606b60405196610eeb6101c05189614713565b61037b88527f3c706174682069643d224c6f676f222066696c6c3d2223666666222066696c6c610220518901527f2d6f7061636974793d222e312220643d226d3133332e3535392c3132342e303360408901527f34632d2e3031332c322e3431322d312e3035392c342e3834382d322e3932332c610200518901527f362e3430322d322e3535382c312e3831392d352e3136382c332e3433392d372e60808901527f3838382c342e3939362d31342e34342c382e3236322d33312e3034372c31322e60a08901527f3536352d34372e3637342c31322e3536392d382e3835382e3033362d31372e3860c08901527f33382d312e3237322d32362e3332382d332e3636332d392e3830362d322e373660e08901527f362d31392e3038372d372e3131332d32372e3536322d31322e3737382d31332e610120518901527f3834322d382e3032352c392e3436382d32382e3630362c31362e3135332d33356101208901527f2e323635683063322e3033352d312e3833382c342e3235322d332e3534362c36868901527f2e3436332d352e323234683063362e3432392d352e3635352c31362e3231382d6101608901527f322e3833352c32302e3335382c342e31372c342e3134332c352e3035372c382e6101808901527f3831362c392e3634392c31332e39322c31332e373334682e30333763352e37336101a08901527f362c362e3436312c31352e3335372d322e3235332c392e33382d382e34382c306101c08901527f2c302d332e3531352d332e3531352d332e3531352d332e3531352d31312e34396101e08901527f2d31312e3437382d35322e3635362d35322e3636342d36342e3833372d36342e6102008901527f3833376c2e3034392d2e303337632d312e3732352d312e3630362d322e3731396102208901527f2d332e3834372d322e3735312d362e3230346830632d2e3034362d322e3337356102408901527f2c312e3036322d342e3538322c322e3732362d362e32323968306c2e3138352d6102608901527f2e3134386830632e3039392d2e3036322c2e3232322d2e3134382c2e33372d2e6102808901527f323539683063322e30362d312e3336322c332e3935312d322e3632312c362e306102a08901527f34342d332e3834324335372e3736332d332e3437332c39372e37362d322e33346102c08901527f312c3132382e3633372c31382e3333326331362e3637312c392e3934362d32366102e08901527f2e3334342c35342e3831332d33382e3635312c34302e3139392d362e3239392d6103008901527f362e3039362d31382e3036332d31372e3734332d31392e3636382d31382e38316103208901527f312d362e3031362d342e3034372d31332e3036312c342e3737362d372e3735326103408901527f2c392e3735316c36382e3235342c36382e33373163312e3732342c312e3630316103608901527f2c322e3731342c332e38342c322e3733382c362e3139325a222f3e00000000006103808901525f6101805260a06101805260405160a0526113506101805160a051614713565b607560a051527f3c706174682069643d22466c6f6174696e6754657874222066696c6c3d226e6f6102205160a05101527f6e652220643d224d313235203435683735307338302030203830203830763735604060a05101527f307330203830202d3830203830682d373530732d38302030202d3830202d38306102005160a05101527f762d3735307330202d3830203830202d3830222f3e0000000000000000000000608060a051015261193c60146022611409615979565b9360a2604051957f3c72616469616c4772616469656e742069643d2252616469616c476c6f77223e610220518801527f3c73746f70206f66667365743d223025222073746f702d636f6c6f723d220000604088015261153e6025603589605e8751956102205189019661147f818486018a6146cd565b83017f222073746f702d6f7061636974793d222e36222f3e0000000000000000000000838201528f7f3c73746f70206f66667365743d2231303025222073746f702d636f6c6f723d22908201526114e282518093609384019061022051016146cd565b01017f222073746f702d6f7061636974793d2230222f3e000000000000000000000000838201527f3c2f72616469616c4772616469656e743e00000000000000000000000000000060498201520301600581018a520188614713565b61165585602361154c615979565b6040519b8c917f3c6c696e6561724772616469656e742069643d2253616e64546f70222078313d610220518401527f223025222079313d223025223e0000000000000000000000000000000000000060408401527f3c73746f70206f66667365743d223025222073746f702d636f6c6f723d220000604d84015288516115d5818486018a6146cd565b83016211179f60e91b838201527f3c73746f70206f66667365743d2231303025222073746f702d636f6c6f723d22606e82015261161e82518093608e84019061022051016146cd565b01016211179f60e91b83820152701e17b634b732b0b923b930b234b2b73a1f60791b60268201520301600b1981018b520189614713565b6117df60726023611664615979565b6040519c8d917f3c6c696e6561724772616469656e742069643d2253616e64426f74746f6d2220610220518401527f78313d2231303025222079313d2231303025223e00000000000000000000000060408401527f3c73746f70206f66667365743d22313025222073746f702d636f6c6f723d220060548401526116f3815180928486019061022051016146cd565b82016211179f60e91b828201527f3c73746f70206f66667365743d2231303025222073746f702d636f6c6f723d22607682015288519061173782609683018a6146cd565b01016211179f60e91b838201527f3c616e696d617465206174747269627574654e616d653d22783122206475723d60268201527f2236732220726570656174436f756e743d22696e646566696e6974652220766160468201527f6c7565733d223330253b3630253b313230253b3630253b3330253b222f3e00006066820152701e17b634b732b0b923b930b234b2b73a1f60791b60848201520301605281018c52018a614713565b6117e7615979565b906040519a8b947f3c6c696e6561724772616469656e742069643d22486f7572676c617373537472610220518701527f6f6b6522206772616469656e745472616e73666f726d3d22726f74617465283960408701527f302922206772616469656e74556e6974733d227573657253706163654f6e5573610200518701527f65223e000000000000000000000000000000000000000000000000000000000060808701527f3c73746f70206f66667365743d22353025222073746f702d636f6c6f723d22006083870152518092858701906146cd565b83016211179f60e91b838201527f3c73746f70206f66667365743d22383025222073746f702d636f6c6f723d220060a58201526119058251809360c484019061022051016146cd565b01016211179f60e91b83820152701e17b634b732b0b923b930b234b2b73a1f60791b60258201520301600b19810187520185614713565b614ed4565b60e05261195561194f614c65565b856156d2565b938415614544575b5060c061010081905260405191906119759083614713565b609082527f3c7061746820643d224d2035302c3336302061203330302c333030203020312c610220518301527f31203630302c302061203330302c333030203020312c31202d3630302c30222060408301527f66696c6c3d2223666666222066696c6c2d6f7061636974793d222e3032222073610200518301527f74726f6b653d2275726c2823486f7572676c6173735374726f6b65292220737460808301527f726f6b652d77696474683d2234222f3e00000000000000000000000000000000610180518301526102c060405160c052611a528160c051614713565b61029860c051527f3c7061746820643d226d3536362c3136312e323031762d35332e39323463302d6102205160c05101527f31392e3338322d32322e3531332d33372e3536332d36332e3339382d35312e31604060c05101527f39382d34302e3735362d31332e3539322d39342e3934362d32312e3037392d316102005160c05101527f35322e3538372d32312e303739732d3131312e3833382c372e3438372d313532608060c05101527f2e3630322c32312e303739632d34302e3839332c31332e3633362d36332e34316101805160c05101527f332c33312e3831362d36332e3431332c35312e3139387635332e39323463302c6101005160c05101527f31372e3138312c31372e3730342c33332e3432372c35302e3232332c34362e3360e060c05101527f3934763238342e383039632d33322e3531392c31322e39362d35302e3232332c6101205160c05101527f32392e3230362d35302e3232332c34362e3339347635332e39323463302c313961012060c05101527f2e3338322c32322e35322c33372e3536332c36332e3431332c35312e3139382c8260c05101527f34302e3736332c31332e3539322c39342e3935342c32312e3037392c3135322e61016060c05101527f3630322c32312e303739733131312e3833312d372e3438372c3135322e35383761018060c05101527f2d32312e3037396334302e3838362d31332e3633362c36332e3339382d33312e6101a060c05101527f3831362c36332e3339382d35312e313938762d35332e39323463302d31372e316101c060c05101527f39362d31372e3730342d33332e3433352d35302e3232332d34362e34303156326101e060c05101527f30372e3630336333322e3531392d31322e3936372c35302e3232332d32392e3261020060c05101527f30362c35302e3232332d34362e3430315a6d2d3334372e3436322c35372e373961022060c05101527f336c3133302e3935392c3133312e3032372d3133302e3935392c3133312e303161024060c05101527f33563231382e3939345a6d3236322e3932342e303232763236322e3031386c2d61026060c05101527f3133302e3933372d3133312e3030362c3133302e3933372d3133312e3031335a61028060c05101527f222066696c6c3d2223313631383232223e3c2f706174683e00000000000000006102a060c0510152855f1461432f57604051611dcd6102205182614713565b5f8152955b156141dc57604051611de66101e082614713565b6101b181527f3c7061746820643d226d3438312e34362c3438312e35347638312e3031632d32610220518201527f2e33352e37372d342e38322c312e35312d372e33392c322e32332d33302e332c60408201527f382e35342d37342e36352c31332e39322d3132342e30362c31332e39322d3533610200518201527f2e362c302d3130312e32342d362e33332d3133312e34372d31362e3136762d3860808201527f316c34362e332d34362e3331683137302e33336c34362e32392c34362e33315a610180518201527f222066696c6c3d2275726c282353616e64426f74746f6d29222f3e3c70617468610100518201527f20643d226d3433352e31372c3433352e323363302c312e31372d2e34362c322e60e08201527f33322d312e33332c332e34342d372e31312c392e30382d34312e39332c31352e610120518201527f39382d38332e38312c31352e3938732d37362e372d362e392d38332e38322d316101208201527f352e3938632d2e38372d312e31322d312e33332d322e32372d312e33332d332e838201527f3434762d2e30346c382e33342d382e33352e30312d2e30316331332e37322d366101608201527f2e35312c34322e39352d31312e30322c37362e382d31312e30327336322e39376101808201527f2c342e34392c37362e37322c31316c382e34322c382e34325a222066696c6c3d6101a08201527f2275726c282353616e64546f7029222f3e0000000000000000000000000000006101c0820152905b6040519261201f6107e085614713565b6107a7845261022080517f3c672066696c6c3d226e6f6e6522207374726f6b653d2275726c2823486f7572908601527f676c6173735374726f6b652922207374726f6b652d6c696e656361703d22726f60408087019190915261020080517f756e6422207374726f6b652d6d697465726c696d69743d22313022207374726f908801527f6b652d77696474683d2234223e3c7061746820643d226d3536352e3634312c31608088015261018080517f30372e323863302c392e3533372d352e35362c31382e3632392d31352e36373690890152610100517f2c32362e393733682d2e303233632d392e3230342c372e3539362d32322e3139908901527f342c31342e3536322d33382e3139372c32302e3539322d33392e3530342c313460e089015261012080517f2e3933362d39372e3332352c32342e3335352d3136312e3733332c32342e3335908a01527f352d39302e34382c302d3136372e3934382d31382e3538322d3139392e393533908901527f2d34342e393438682d2e303233632d31302e3131352d382e3334342d31352e36948801949094527f37362d31372e3433372d31352e3637362d32362e3937332c302d33392e3733356101608801527f2c39362e3535342d37312e3932312c3231352e3635322d37312e393231733231938701939093527f352e3632392c33322e3138352c3231352e3632392c37312e3932315a222f3e3c6101a08701527f7061746820643d226d3133342e33362c3136312e32303363302c33392e3733356101c0808801919091527f2c39362e3535342c37312e3932312c3231352e3635322c37312e3932317332316101e08801527f352e3632392d33322e3138362c3231352e3632392d37312e393231222f3e3c6c938701939093527f696e652078313d223133342e3336222079313d223136312e323033222078323d828701527f223133342e3336222079323d223130372e3238222f3e3c6c696e652078313d226102408701527f3536352e3634222079313d223136312e323033222078323d223536352e3634226102608701527f2079323d223130372e3238222f3e3c6c696e652078313d223138342e353834226102808701527f2079313d223230362e383233222078323d223138342e353835222079323d22356102a08701527f33372e353739222f3e3c6c696e652078313d223231382e313831222079313d22938601939093527f3231382e313138222078323d223231382e313831222079323d223536322e35336102e08601527f37222f3e3c6c696e652078313d223438312e383138222079313d223231382e316103008601527f3432222078323d223438312e383139222079323d223536322e343238222f3e3c6103208601527f6c696e652078313d223531352e343135222079313d223230372e3335322220786103408601527f323d223531352e343136222079323d223533372e353739222f3e3c70617468206103608601527f643d226d3138342e35382c3533372e353863302c352e34352c342e32372c313061038086015290517f2e36352c31322e30332c31352e3432682e303263352e35312c332e33392c3132908501527f2e37392c362e35352c32312e35352c392e34322c33302e32312c392e392c37386103c08501527f2e30322c31362e32382c3133312e38332c31362e32382c34392e34312c302c396103e08501527f332e37362d352e33382c3132342e30362d31332e39322c322e372d2e37362c356104008501527f2e32392d312e35342c372e37352d322e33352c382e37372d322e38372c31362e6104208501527f30352d362e30342c32312e35362d392e3433683063372e37362d342e37372c316104408501527f322e30342d392e39372c31322e30342d31352e3432222f3e3c7061746820643d6104608501527f226d3138342e3538322c3439322e363536632d33312e3335342c31322e3438356104808501527f2d35302e3232332c32382e35382d35302e3232332c34362e3134322c302c392e6104a08501527f3533362c352e3536342c31382e3632372c31352e3637372c32362e393639682e6104c08501527f30323263382e3530332c372e3030352c32302e3231332c31332e3436332c33346104e08501527f2e3532342c31392e3135392c392e3939392c332e3939312c32312e3236392c376105008501527f2e3630392c33332e3539372c31302e3738382c33362e34352c392e3430372c386105208501527f322e3138312c31352e3030322c3133312e3833352c31352e3030327339352e336105408501527f36332d352e3539352c3133312e3830372d31352e3030326331302e3834372d326105608501527f2e37392c32302e3836372d352e3932362c32392e3932342d392e3334392c312e6105808501527f3234342d2e3436372c322e3437332d2e3934322c332e3637332d312e3432342c6105a08501527f31342e3332362d352e3639362c32362e3033352d31322e3136312c33342e35326105c08501527f342d31392e313733682e3032326331302e3131342d382e3334322c31352e36376105e08501527f372d31372e3433332c31352e3637372d32362e3936392c302d31372e3536322d6106008501527f31382e3836392d33332e3636352d35302e3232332d34362e3135222f3e3c70616106208501527f746820643d226d3133342e33362c3539322e373263302c33392e3733352c39366106408501527f2e3535342c37312e3932312c3231352e3635322c37312e393231733231352e366106608501527f32392d33322e3138362c3231352e3632392d37312e393231222f3e3c6c696e656106808501527f2078313d223133342e3336222079313d223539322e3732222078323d223133346106a08501527f2e3336222079323d223533382e373937222f3e3c6c696e652078313d223536356106c08501527f2e3634222079313d223539322e3732222078323d223536352e3634222079323d6106e08501527f223533382e373937222f3e3c706f6c796c696e6520706f696e74733d223438316107008501527f2e383232203438312e393031203438312e373938203438312e383737203438316107208501527f2e373735203438312e383534203335302e303135203335302e303236203231386107408501527f2e313835203231382e313239222f3e3c706f6c796c696e6520706f696e74733d6107608501527f223231382e313835203438312e393031203231382e323331203438312e3835346107808501527f203335302e303135203335302e303236203438312e383232203231382e3135326107a08501527f222f3e3c2f673e000000000000000000000000000000000000000000000000006107c0850152905181517f3c672069643d22486f7572676c617373223e00000000000000000000000000009082015284519151909788959092916129ee9183916032890191016146cd565b840160c051519060328101826102205160c0510191612a0c926146cd565b016032018082518093610220510191612a24926146cd565b018082518093610220510191612a39926146cd565b018082518093610220510191612a4e926146cd565b01631e17b39f60e11b815203601b1981018452600401612a6e9084614713565b60405160805261022051608051017f3c646566733e000000000000000000000000000000000000000000000000000090526101e0515160805160260181610220516101e0510191612abe926146cd565b60805101815191826026830191610220510191612ada926146cd565b016026018082518093610220510191612af2926146cd565b0160a051519080826102205160a0510191612b0c926146cd565b0160e051519080826102205160e0510191612b26926146cd565b018082518093610220510191612b3b926146cd565b01610140515190808261022051610140510191612b57926146cd565b017f3c2f646566733e000000000000000000000000000000000000000000000000008152608051900360181981016080515260070160805190612b9991614713565b6101605160e0015190610160516101000151916101605160400151906101605160600151612bc78583615bf8565b916040958651612bd78882614713565b600581526102205181017f2d31303025000000000000000000000000000000000000000000000000000000905287519485916102205183017f3c74657874506174682073746172744f66667365743d220000000000000000009052805190816037850191610220510191612c4a926146cd565b7f2220687265663d2223466c6f6174696e6754657874222066696c6c3d222366666037918401918201527f662220666f6e742d66616d696c793d2227436f7572696572204e6577272c417260578201527f69616c2c6d6f6e6f7370616365222066696c6c2d6f7061636974793d222e3822607782015271103337b73a16b9b4bd329e91191b383c111f60711b60978201527f3c616e696d6174652061646469746976653d2273756d2220617474726962757460a98201527f654e616d653d2273746172744f66667365742220626567696e3d22307322206460c98201527f75723d22353073222066726f6d3d2230252220726570656174436f756e743d2260e98201527f696e646566696e6974652220746f3d2231303025222f3e0000000000000000006101098201528151610220519092612d8e918491610120850191016146cd565b0160370160e981016a1e17ba32bc3a2830ba341f60a91b90520360e90160141981018552600b01612dbf9085614713565b612dc891615bf8565b928551612dd58782614713565b60028152610220518101947f3025000000000000000000000000000000000000000000000000000000000000865287519586926102205184017f3c74657874506174682073746172744f66667365743d22000000000000000000905251908160378501612e41926146cd565b7f2220687265663d2223466c6f6174696e6754657874222066696c6c3d222366666037918401918201527f662220666f6e742d66616d696c793d2227436f7572696572204e6577272c417260578201527f69616c2c6d6f6e6f7370616365222066696c6c2d6f7061636974793d222e3822607782015271103337b73a16b9b4bd329e91191b383c111f60711b60978201527f3c616e696d6174652061646469746976653d2273756d2220617474726962757460a98201527f654e616d653d2273746172744f66667365742220626567696e3d22307322206460c98201527f75723d22353073222066726f6d3d2230252220726570656174436f756e743d2260e98201527f696e646566696e6974652220746f3d2231303025222f3e0000000000000000006101098201528151610220519092612f85918491610120850191016146cd565b0160370160e981016a1e17ba32bc3a2830ba341f60a91b90520360e90160141981018552600b01612fb69085614713565b612fc08282615c62565b918651612fcd8882614713565b60048152610220518101937f2d35302500000000000000000000000000000000000000000000000000000000855288519485926102205184017f3c74657874506174682073746172744f66667365743d22000000000000000000905251908160378501613039926146cd565b7f2220687265663d2223466c6f6174696e6754657874222066696c6c3d222366666037918401918201527f662220666f6e742d66616d696c793d2227436f7572696572204e6577272c417260578201527f69616c2c6d6f6e6f7370616365222066696c6c2d6f7061636974793d222e3822607782015271103337b73a16b9b4bd329e91191b383c111f60711b60978201527f3c616e696d6174652061646469746976653d2273756d2220617474726962757460a98201527f654e616d653d2273746172744f66667365742220626567696e3d22307322206460c98201527f75723d22353073222066726f6d3d2230252220726570656174436f756e743d2260e98201527f696e646566696e6974652220746f3d2231303025222f3e000000000000000000610109820152815161022051909261317d918491610120850191016146cd565b0160370160e981016a1e17ba32bc3a2830ba341f60a91b90520360e90160141981018452600b016131ae9084614713565b6131b791615c62565b9085516131c48782614713565b60038152610220518101927f3530250000000000000000000000000000000000000000000000000000000000845287519384926102205184017f3c74657874506174682073746172744f66667365743d22000000000000000000905251908160378501613230926146cd565b7f2220687265663d2223466c6f6174696e6754657874222066696c6c3d222366666037918401918201527f662220666f6e742d66616d696c793d2227436f7572696572204e6577272c417260578201527f69616c2c6d6f6e6f7370616365222066696c6c2d6f7061636974793d222e3822607782015271103337b73a16b9b4bd329e91191b383c111f60711b60978201527f3c616e696d6174652061646469746976653d2273756d2220617474726962757460a98201527f654e616d653d2273746172744f66667365742220626567696e3d22307322206460c98201527f75723d22353073222066726f6d3d2230252220726570656174436f756e743d2260e98201527f696e646566696e6974652220746f3d2231303025222f3e0000000000000000006101098201528151610220519092613374918491610120850191016146cd565b0160370160e981016a1e17ba32bc3a2830ba341f60a91b90520360e90160141981018352600b016133a59083614713565b85519384936102205185017f3c7465787420746578742d72656e646572696e673d226f7074696d697a65537090528785017f656564223e0000000000000000000000000000000000000000000000000000009052805190816045870191610220510191613411926146cd565b840181519182604583019161022051019161342b926146cd565b016045018082518093610220510191613443926146cd565b018082518093610220510191613458926146cd565b01661e17ba32bc3a1f60c91b8152036018198101825260070161347b9082614713565b610140820151916101a08101519060408101519060e001519361349d90615408565b916134a790615408565b906134b190615408565b936134bb90615408565b8551948592610220518401947f3c75736520687265663d2223476c6f77222066696c6c2d6f7061636974793d2286528885017f2e39222f3e0000000000000000000000000000000000000000000000000000009052604585017f3c75736520687265663d2223476c6f772220783d22313030302220793d2231309052606585017f3030222066696c6c2d6f7061636974793d222e39222f3e0000000000000000009052607c85017f3c75736520687265663d22234c6f676f2220783d223137302220793d223137309052609c85017f22207472616e73666f726d3d227363616c65282e3629222f3e3c757365206872905260bc85017f65663d2223486f7572676c6173732220783d223135302220793d223930222074905260dc85017f72616e73666f726d3d22726f746174652831302922207472616e73666f726d2d905260fc85017f6f726967696e3d2235303020353030222f3e0000000000000000000000000000905261010e85017f3c75736520687265663d222350726f67726573732220783d2200000000000000905280519081610127870191610220510191613662926146cd565b840161012781016a11103c9e911b9c9811179f60a91b905261013281017f3c75736520687265663d22235374617475732220783d220000000000000000009052815191826101498301916102205101916136bb926146cd565b0161012701602281016a11103c9e911b9c9811179f60a91b9052602d81017f3c75736520687265663d2223416d6f756e742220783d220000000000000000009052815191826044830191610220510191613714926146cd565b01602201602281016a11103c9e911b9c9811179f60a91b9052602d81017f3c75736520687265663d22234475726174696f6e2220783d2200000000000000905281519182604683019161022051019161376c926146cd565b01602201602481016a11103c9e911b9c9811179f60a91b90520360240160141981018452600b0161379d9084614713565b83519283926102205184017f3c73766720786d6c6e733d22687474703a2f2f7777772e77332e6f72672f323090528584017f30302f737667222077696474683d223130303022206865696768743d2231303090526102005184017f30222076696577426f783d2230203020313030302031303030223e000000000090526101a05151607b850181610220516101a0510191613837926146cd565b84016080515190607b810182610220516080510191613855926146cd565b01607b01808251809361022051019161386d926146cd565b0191829151809361387d926146cd565b017f3c2f7376673e0000000000000000000000000000000000000000000000000000815203601919810182526006016138b69082614713565b61038052610300518151610220517fb25645690000000000000000000000000000000000000000000000000000000090820190815260248035818401528252916001600160a01b03169061390b604482614713565b515a925f93928493fa61391c614796565b6102e0819052901580156103c0526141d45761022051818051810103126141bf5761022051015180151581036141bf575b15156102a052610260516103005182517fb971302a00000000000000000000000000000000000000000000000000000000815260248035600483015261022051919283919082906001600160a01b03165afa9081156141ca575f9161417e575b50600360236139be613ad693614a3d565b938161012061024001518780519788947f5b7b2274726169745f74797065223a224173736574222c2276616c7565223a2261022051870152613a0b815180928589019061022051016146cd565b85017f227d2c7b2274726169745f74797065223a2253656e646572222c2276616c75658382015262111d1160e91b61020051820152613a5682518093606384019061022051016146cd565b01017f227d2c7b2274726169745f74797065223a22537461747573222c2276616c75658382015262111d1160e91b6043820152613a9f82518093604684019061022051016146cd565b01017f227d5d0000000000000000000000000000000000000000000000000000000000838201520301601c19810184520182614713565b6103205161026051610340516102405191939291613afc906001600160a01b0316614a3d565b613b07602435615408565b6102a051909190156140f25761010051875190613b249082614713565b609b81527fe29aa0efb88f205741524e494e473a205472616e7366657272696e6720746865610220518201527f204e4654206d616b657320746865206e6577206f776e65722074686520726563888201527f697069656e74206f66207468652073747265616d2e205468652066756e647320610200518201527f617265206e6f74206175746f6d61746963616c6c792077697468647261776e2060808201527f666f72207468652070726576696f757320726563697069656e742e000000000061018051820152915b8751968794610220518601967f54686973204e465420726570726573656e74732061207061796d656e7420737488528a87017f7265616d20696e2061205361626c6965722056322000000000000000000000009052805190610220518101918060558a0190613c5c91856146cd565b7f20636f6e74726163742e20546865206f776e6572206f662074686973204e46546055918a01918201527f2063616e207769746864726177207468652073747265616d656420617373657460758201527f732c207768696368206172652064656e6f6d696e6174656420696e2000000000609582015284516102205186019691613cea8260b183018a6146cd565b01605501605c81017f2e5c6e5c6e2d2053747265616d2049443a200000000000000000000000000000905281519182606e830191610220510191613d2d926146cd565b01605c0190601282016302e3716960e51b905251918260168301613d50926146cd565b01601201600481016901020b2323932b9b99d160b51b905281519182600e830191610220510191613d80926146cd565b0160040190600a82016302e3716960e51b9052519182600e8301613da3926146cd565b01600a01600481016901020b2323932b9b99d160b51b905281519182600e830191610220510191613dd3926146cd565b01600401600a81017f5c6e5c6e00000000000000000000000000000000000000000000000000000000905281519182600e830191610220510191613e16926146cd565b01600a0103600401601f1981018452613e2f9084614713565b61032051613e3e602435615408565b85518091610220518201936a029b0b13634b2b9102b19160ad1b855280519081602b850191610220510191613e72926146cd565b8201602b81017f2023000000000000000000000000000000000000000000000000000000000000905281519182602d830191610220510191613eb3926146cd565b01602b0103600201601f1981018252613ecc9082614713565b61038051613ed990615567565b9286519586956102205187017f7b2261747472696275746573223a000000000000000000000000000000000000905280519081602e890191610220510191613f20926146cd565b860190602e82017f2c226465736372697074696f6e223a22000000000000000000000000000000009052519182603e8301613f5a926146cd565b01602e0190601082017f222c2265787465726e616c5f75726c223a2268747470733a2f2f7361626c69659052603082017f722e636f6d222c226e616d65223a2200000000000000000000000000000000009052519182603f8301613fbd926146cd565b01601001602f81017f222c22696d616765223a22646174613a696d6167652f7376672b786d6c3b62619052604f81017f736536342c0000000000000000000000000000000000000000000000000000009052815191826054830191610220510191614027926146cd565b01602f01602581017f227d000000000000000000000000000000000000000000000000000000000000905203602501601d198101825260020161406a9082614713565b6102c081905261407990615567565b90805180926102205182017f646174613a6170706c69636174696f6e2f6a736f6e3b6261736536342c000000905280519081603d8401916102205101916140bf926146cd565b810103603d01601f19810183526140d69083614713565b5180916102205182526102205182016140ee916146ee565b0390f35b86516140ff608082614713565b605b81527fe29d95494e464f3a2054686973204e4654206973206e6f6e2d7472616e736665610220518201527f7261626c652e2049742063616e6e6f7420626520736f6c64206f72207472616e888201527f7366657272656420746f20616e6f74686572206163636f756e742e00000000006102005182015291613bed565b9050610220513d61022051116141c3575b6141998183614713565b816102205191810103126141bf57516001600160a01b03811681036141bf5760036139ad565b5f80fd5b503d61418f565b83513d5f823e3d90fd5b50600161394d565b6040516141eb61012082614713565b60f881527f3c7061746820643d226d3438312e34362c3530342e3130317635382e34343963610220518201527f2d322e33352e37372d342e38322c312e35312d372e33392c322e32332d33302e60408201527f332c382e35342d37342e36352c31332e39322d3132342e30362c31332e39322d610200518201527f35332e362c302d3130312e32342d362e33332d3133312e34372d31362e31367660808201527f2d35382e343339683236322e39325a222066696c6c3d2275726c282353616e64610180518201527f426f74746f6d29222f3e3c656c6c697073652063783d22333530222063793d22610100518201527f3530342e313031222072783d223133312e343632222072793d2232382e31303860e08201527f222066696c6c3d2275726c282353616e64546f7029222f3e0000000000000000610120518201529061200f565b60405161433e6101c082614713565b61019981527f3c706f6c79676f6e20706f696e74733d22333530203335302e30323620343135610220518201527f2e3033203238342e39373820323835203238342e39373820333530203335302e60408201527f303236222066696c6c3d2275726c282353616e64426f74746f6d29222f3e3c70610200518201527f61746820643d226d3431362e3334312c3238312e39373563302c2e3931342d2e60808201527f3335342c312e3830392d312e3033352c322e36382d352e3534322c372e303736610180518201527f2d33322e3636312c31322e34352d36352e32382c31322e34352d33322e363234610100518201527f2c302d35392e3733382d352e3337342d36352e32382d31322e34352d2e36383160e08201527f2d2e3837322d312e3033352d312e3736372d312e3033352d322e36382c302d2e610120518201527f3931342e3335342d312e3830382c312e3033352d322e3637362c352e3534322d6101208201527f372e3037362c33322e3635362d31322e34352c36352e32382d31322e34352c33838201527f322e3631392c302c35392e3733382c352e3337342c36352e32382c31322e34356101608201527f2e3638312e3836372c312e3033352c312e3736322c312e3033352c322e3637366101808201527f5a222066696c6c3d2275726c282353616e64546f7029222f3e000000000000006101a082015295611dd2565b614558919450614552614ca0565b906156d2565b925f61195d565b905099610ad5565b9050610a2d565b601b60d09a610720565b634e487b7160e01b5f52604160045260245ffd5b6145ae915060203d6020116145b4575b6145a68183614713565b81019061475d565b5f610518565b503d61459c565b6040513d5f823e3d90fd5b6145df915060203d6020116145b4576145a68183614713565b5f6104b9565b634e487b7160e01b5f52601260045260245ffd5b61461b915060203d602011614621575b6146138183614713565b810190614735565b5f61024e565b503d614609565b506020813d60201161465d575b8161464260209383614713565b810103126141bf575160058110156141bf576101f5906101eb565b3d9150614635565b61467e915060203d602011614621576146138183614713565b5f610191565b90506020813d6020116146c5575b8161469f60209383614713565b810103126141bf57516001600160a01b03811681036141bf576001600160a01b0361010f565b3d9150614692565b5f5b8381106146de5750505f910152565b81810151838201526020016146cf565b90602091614707815180928185528580860191016146cd565b601f01601f1916010190565b90601f8019910116810190811067ffffffffffffffff82111761457857604052565b908160209103126141bf57516fffffffffffffffffffffffffffffffff811681036141bf5790565b908160209103126141bf575164ffffffffff811681036141bf5790565b67ffffffffffffffff811161457857601f01601f191660200190565b3d156147c0573d906147a78261477a565b916147b56040519384614713565b82523d5f602084013e565b606090565b6020818303126141bf5780519067ffffffffffffffff82116141bf570181601f820112156141bf5780516147f88161477a565b926148066040519485614713565b818452602082840101116141bf5761482491602080850191016146cd565b90565b6001600160a01b0316604051906395d89b4160e01b82525f82600481845afa9182156145bb575f92614a19575b5060409161489783516148678582614713565b601181527f5341422d56322d4c4f434b55502d4c494e0000000000000000000000000000006020820152826156d2565b156148d75750506148aa81519182614713565b600d81527f4c6f636b7570204c696e65617200000000000000000000000000000000000000602082015290565b61491683516148e68582614713565b601181527f5341422d56322d4c4f434b55502d44594e0000000000000000000000000000006020820152826156d2565b1561495657505061492981519182614713565b600e81527f4c6f636b75702044796e616d6963000000000000000000000000000000000000602082015290565b61499583516149658582614713565b601181527f5341422d56322d4c4f434b55502d5452410000000000000000000000000000006020820152826156d2565b156149d55750506149a881519182614713565b600f81527f4c6f636b7570205472616e636865640000000000000000000000000000000000602082015290565b614a159083519384937f814a8a2e0000000000000000000000000000000000000000000000000000000085526004850152602484015260448301906146ee565b0390fd5b614a369192503d805f833e614a2e8183614713565b8101906147c5565b905f614854565b6001600160a01b03168060405191614a56606084614713565b602a8352602083016040368237835115614b255760309053825160011015614b25576078602184015360295b60018111614ac35750614a93575090565b7fe22e27eb000000000000000000000000000000000000000000000000000000005f52600452601460245260445ffd5b90600f81166010811015614b25577f3031323334353637383961626364656600000000000000000000000000000000901a614afe83866156ff565b5360041c908015614b11575f1901614a82565b634e487b7160e01b5f52601160045260245ffd5b634e487b7160e01b5f52603260045260245ffd5b5f809160405160208101906395d89b4160e01b825260048152614b5d602482614713565b51915afa614b69614796565b90158015614c59575b614c1d5780602080614b89935183010191016147c5565b601e8151115f14614bd05750604051614ba3604082614713565b600b81527f4c6f6e672053796d626f6c000000000000000000000000000000000000000000602082015290565b614bd981615710565b15614be15790565b50604051614bf0604082614713565b601281527f556e737570706f727465642053796d626f6c0000000000000000000000000000602082015290565b50604051614c2c604082614713565b600581527f4552433230000000000000000000000000000000000000000000000000000000602082015290565b50604081511115614b72565b60405190614c74604083614713565b600782527f536574746c6564000000000000000000000000000000000000000000000000006020830152565b60405190614caf604083614713565b600882527f4465706c657465640000000000000000000000000000000000000000000000006020830152565b6005811015614dc75760048103614cf55750614824614ca0565b60038103614d395750604051614d0c604082614713565b600881527f43616e63656c6564000000000000000000000000000000000000000000000000602082015290565b60018103614d7d5750604051614d50604082614713565b600981527f53747265616d696e670000000000000000000000000000000000000000000000602082015290565b600203614d8c57614824614c65565b604051614d9a604082614713565b600781527f50656e64696e6700000000000000000000000000000000000000000000000000602082015290565b634e487b7160e01b5f52602160045260245ffd5b5f809160405160208101907f313ce56700000000000000000000000000000000000000000000000000000000825260048152614e18602482614713565b51915afa614e24614796565b9080614e53575b15614e4e576020818051810103126141bf576020015160ff811681036141bf5790565b505f90565b506020815114614e2b565b60405190614e6d604083614713565b600482527f2667743b000000000000000000000000000000000000000000000000000000006020830152565b60405190614ea8604083614713565b600482527f266c743b000000000000000000000000000000000000000000000000000000006020830152565b90614eff9493614f306020614f3f95614f22828096816040519c8d8b83829d519485930191016146cd565b8901614f13825180938580850191016146cd565b010191828151948592016146cd565b0191828151948592016146cd565b0103601f198101845283614713565b565b908115615216578061520657505b806001811015614fb8575050614f63614e99565b6148246002602060405184614f8182965180928580860191016146cd565b81017f2031000000000000000000000000000000000000000000000000000000000000838201520301601d19810184520182614713565b66038d7ea4c6800011156151a8576040519060a0820182811067ffffffffffffffff82111761457857604052602091604051614ff48482614713565b5f8152815260409182516150088482614713565b600181527f4b00000000000000000000000000000000000000000000000000000000000000858201528483015282516150418482614713565b600181527f4d000000000000000000000000000000000000000000000000000000000000008582015283830152825161507a8482614713565b600181527f420000000000000000000000000000000000000000000000000000000000000085820152606083015282516150b48482614713565b600181527f54000000000000000000000000000000000000000000000000000000000000008582015260808301525f905f945b6103e882101561518e578451946150fe8187614713565b600786527f2623383830353b000000000000000000000000000000000000000000000000008287015251945f5b6007811061517b575050600160fd1b602786015250600884526151629061515c90615157602887614713565b615408565b916158b3565b916005851015614b25576148249460051b015192614ed4565b818101830151878201840152820161512b565b9490915060016103e86064600a85040693049101946150e7565b506151b1614e5e565b61482460086020604051846151cf82965180928580860191016146cd565b81017f203939392e393954000000000000000000000000000000000000000000000000838201520301601719810184520182614713565b600a0a9081156145e55704614f4f565b5050604051615226604082614713565b60018152600360fc1b602082015290565b62015180910304806152a1575061524c614e99565b614824600660206040518461526a82965180928580860191016146cd565b81017f2031204461790000000000000000000000000000000000000000000000000000838201520301601919810184520182614713565b61270f81116153785760018103615334576148246152f66040516152c6604082614713565b600481527f2044617900000000000000000000000000000000000000000000000000000000602082015292615408565b6020604051938261531086945180928580880191016146cd565b8301615324825180938580850191016146cd565b010103601f198101835282614713565b6148246152f6604051615348604082614713565b600581527f2044617973000000000000000000000000000000000000000000000000000000602082015292615408565b50615381614e5e565b614824600a60206040518461539f82965180928580860191016146cd565b81017f2039393939204461797300000000000000000000000000000000000000000000838201520301601519810184520182614713565b906153e08261477a565b6153ed6040519182614713565b82815280926153fe601f199161477a565b0190602036910137565b805f917a184f03e93ff9f4daa797ed6e38ed64bf6a1f01000000000000000082101561553f575b806d04ee2d6d415b85acef8100000000600a921015615524575b662386f26fc10000811015615510575b6305f5e1008110156154ff575b6127108110156154f0575b60648110156154e2575b10156154d7575b600a6021615492600185016153d6565b938401015b5f1901917f30313233343536373839616263646566000000000000000000000000000000008282061a83530480156154d257600a9091615497565b505090565b600190910190615482565b60646002910493019261547b565b61271060049104930192615471565b6305f5e10060089104930192615466565b662386f26fc1000060109104930192615459565b6d04ee2d6d415b85acef810000000060209104930192615449565b50604091507a184f03e93ff9f4daa797ed6e38ed64bf6a1f010000000000000000810461542f565b908151156156bc576040519161557e606084614713565b604083527f4142434445464748494a4b4c4d4e4f505152535455565758595a61626364656660208401527f6768696a6b6c6d6e6f707172737475767778797a303132333435363738392b2f6040840152805160028101809111614b1157600390047f3fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff81168103614b11576156149060021b6153d6565b90602082019080815182019560208701908151925f83525b88811061566e575050600393949596505251068060011461565c57600214615652575090565b603d905f19015390565b50603d90815f19820153600119015390565b600360049199969901986001603f8b5182828260121c16870101518453828282600c1c16870101518385015382828260061c168701015160028501531684010151600382015301949761562c565b90506040516156cc602082614713565b5f815290565b90815181519081811493846156e9575b5050505090565b602092939450820120920120145f8080806156e2565b908151811015614b25570160200190565b8051905f5b82811061572457505050600190565b7fff0000000000000000000000000000000000000000000000000000000000000061574f82846156ff565b5116600160fd1b811490600360fc1b81101580615889575b7f4100000000000000000000000000000000000000000000000000000000000000821015908161585e575b7f61000000000000000000000000000000000000000000000000000000000000008310159283615833575b8415615809575b508315615801575b5082156157f9575b5081156157f1575b50156157ea57600101615715565b5050505f90565b90505f6157dc565b91505f6157d4565b92505f6157cc565b7f2d000000000000000000000000000000000000000000000000000000000000001493505f6157c4565b7f7a0000000000000000000000000000000000000000000000000000000000000081111593506157bd565b7f5a000000000000000000000000000000000000000000000000000000000000008311159150615792565b507f3900000000000000000000000000000000000000000000000000000000000000811115615767565b806158c757506040516156cc602082614713565b600a81101561592d576158d990615408565b614824602260405180937f2e30000000000000000000000000000000000000000000000000000000000000602083015261591c81518092602086860191016146cd565b81010301601f198101835282614713565b61593690615408565b614824602160405180937f2e00000000000000000000000000000000000000000000000000000000000000602083015261591c81518092602086860191016146cd565b60405190615988604083614713565b601082527f68736c283233302c3231252c31312529000000000000000000000000000000006020830152565b8015615be8576159c2615979565b9061271003906127108211614b1157602e60619160506159e461482495615408565b60576040519788947f3c672066696c6c3d226e6f6e65223e000000000000000000000000000000000060208701527f3c636972636c652063783d22313636222063793d2235302220723d2232322220602f8701527f7374726f6b653d22000000000000000000000000000000000000000000000000604f870152615a71815180926020868a0191016146cd565b85017f22207374726f6b652d77696474683d223130222f3e0000000000000000000000838201527f3c636972636c652063783d22313636222063793d2235302220706174684c656e606c8201527f6774683d2231303030302220723d22323222207374726f6b653d220000000000608c820152615af882518093602060a7850191016146cd565b01017f22207374726f6b652d6461736861727261793d22313030303022207374726f6b838201527f652d646173686f66667365743d220000000000000000000000000000000000006070820152615b59825180936020607e850191016146cd565b01017f22207374726f6b652d6c696e656361703d22726f756e6422207374726f6b652d838201527f77696474683d223522207472616e73666f726d3d22726f74617465282d393029604e8201527f22207472616e73666f726d2d6f726967696e3d22313636203530222f3e000000606e820152631e17b39f60e11b608b82015203016041810184520182614713565b50506040516156cc602082614713565b6010614f3f9193929360206040519582615c1b88945180928580880191016146cd565b830164010714051160dd1b838201526a029b0b13634b2b9102b19160ad1b6025820152615c5182518093856030850191016146cd565b01010301601f198101845283614713565b6005614f3f9193929360206040519582615c8588945180928580880191016146cd565b830164010714051160dd1b83820152615c5182518093856025850191016146cd565b6004811015614dc75780615cf15750604051615cc4604082614713565b600881527f50726f6772657373000000000000000000000000000000000000000000000000602082015290565b60018103615d355750604051615d08604082614713565b600681527f5374617475730000000000000000000000000000000000000000000000000000602082015290565b600203615d7757604051615d4a604082614713565b600681527f416d6f756e740000000000000000000000000000000000000000000000000000602082015290565b604051615d85604082614713565b600881527f4475726174696f6e000000000000000000000000000000000000000000000000602082015290565b5f90805180156157ea5790600d915f925f925b828410615dd85750505050600d02900390565b90919294603b60f81b7fff00000000000000000000000000000000000000000000000000000000000000615e0c88856156ff565b511614615e22575b820194600101929190615dc5565b859450615e14565b5f90805180156157ea57906010915f925f925b828410615e50575050505060041b900390565b90919294603b60f81b7fff00000000000000000000000000000000000000000000000000000000000000615e8488856156ff565b511614615e9a575b820194600101929190615e3d565b859450615e8c56fea164736f6c634300081a000a";
+
+ /*//////////////////////////////////////////////////////////////////////////
+ DEPLOYERS
+ //////////////////////////////////////////////////////////////////////////*/
+
+ /// @notice Deploys {SablierV2LockupDynamic} from precompiled bytecode, passing a default value for the
+ /// `maxSegmentCount` parameter.
+ /// @dev Notes:
+ /// - A default value is passed for `maxSegmentCount`.
+ /// - A dummy {SablierV2NFTDescriptor} is deployed so that the user does not have to provide one.
+ function deployLockupDynamic(address initialAdmin) public returns (ISablierV2LockupDynamic lockupDynamic) {
+ uint256 maxSegmentCount = MAX_SEGMENT_COUNT;
+ lockupDynamic = deployLockupDynamic(initialAdmin, maxSegmentCount);
+ }
+
+ /// @notice Deploys {SablierV2LockupDynamic} from precompiled bytecode.
+ /// @dev A dummy {SablierV2NFTDescriptor} is deployed so that the user does not have to provide one.
+ function deployLockupDynamic(
+ address initialAdmin,
+ uint256 maxSegmentCount
+ )
+ public
+ returns (ISablierV2LockupDynamic lockupDynamic)
+ {
+ ISablierV2NFTDescriptor nftDescriptor = new SablierV2NFTDescriptor();
+ lockupDynamic = deployLockupDynamic(initialAdmin, nftDescriptor, maxSegmentCount);
+ }
+
+ /// @notice Deploys {SablierV2LockupDynamic} from precompiled bytecode.
+ /// @dev A default value is passed for `maxSegmentCount`.
+ function deployLockupDynamic(
+ address initialAdmin,
+ ISablierV2NFTDescriptor nftDescriptor
+ )
+ public
+ returns (ISablierV2LockupDynamic lockupDynamic)
+ {
+ lockupDynamic = deployLockupDynamic(initialAdmin, nftDescriptor, MAX_SEGMENT_COUNT);
+ }
+
+ /// @notice Deploys {SablierV2LockupDynamic} from precompiled bytecode.
+ function deployLockupDynamic(
+ address initialAdmin,
+ ISablierV2NFTDescriptor nftDescriptor,
+ uint256 maxSegmentCount
+ )
+ public
+ returns (ISablierV2LockupDynamic lockupDynamic)
+ {
+ bytes memory creationBytecode =
+ bytes.concat(BYTECODE_LOCKUP_DYNAMIC, abi.encode(initialAdmin, nftDescriptor, maxSegmentCount));
+ assembly {
+ lockupDynamic := create(0, add(creationBytecode, 0x20), mload(creationBytecode))
+ }
+ require(
+ address(lockupDynamic) != address(0), "Sablier V2 Precompiles: deployment failed for LockupDynamic contract"
+ );
+ }
+
+ /// @notice Deploys {SablierV2LockupLinear} from precompiled bytecode.
+ /// @dev A dummy {SablierV2NFTDescriptor} is deployed so that the user does not have to provide one.
+ function deployLockupLinear(address initialAdmin) public returns (ISablierV2LockupLinear lockupLinear) {
+ ISablierV2NFTDescriptor nftDescriptor = new SablierV2NFTDescriptor();
+ lockupLinear = deployLockupLinear(initialAdmin, nftDescriptor);
+ }
+
+ /// @notice Deploys {SablierV2LockupLinear} from precompiled bytecode.
+ function deployLockupLinear(
+ address initialAdmin,
+ ISablierV2NFTDescriptor nftDescriptor
+ )
+ public
+ returns (ISablierV2LockupLinear lockupLinear)
+ {
+ bytes memory creationBytecode = bytes.concat(BYTECODE_LOCKUP_LINEAR, abi.encode(initialAdmin, nftDescriptor));
+ assembly {
+ lockupLinear := create(0, add(creationBytecode, 0x20), mload(creationBytecode))
+ }
+ require(
+ address(lockupLinear) != address(0), "Sablier V2 Precompiles: deployment failed for LockupLinear contract"
+ );
+ }
+
+ /// @notice Deploys {SablierV2LockupTranched} from precompiled bytecode, passing a default value for the
+ /// `maxTrancheCount` parameter.
+ /// @dev Notes:
+ /// - A default value is passed for `maxTrancheCount`.
+ /// - A dummy {SablierV2NFTDescriptor} is deployed so that the user does not have to provide one.
+ function deployLockupTranched(address initialAdmin) public returns (ISablierV2LockupTranched lockupTranched) {
+ uint256 maxTrancheCount = MAX_TRANCHE_COUNT;
+ lockupTranched = deployLockupTranched(initialAdmin, maxTrancheCount);
+ }
+
+ /// @notice Deploys {SablierV2LockupTranched} from precompiled bytecode.
+ /// @dev A dummy {SablierV2NFTDescriptor} is deployed so that the user does not have to provide one.
+ function deployLockupTranched(
+ address initialAdmin,
+ uint256 maxTrancheCount
+ )
+ public
+ returns (ISablierV2LockupTranched lockupTranched)
+ {
+ ISablierV2NFTDescriptor nftDescriptor = new SablierV2NFTDescriptor();
+ lockupTranched = deployLockupTranched(initialAdmin, nftDescriptor, maxTrancheCount);
+ }
+
+ /// @notice Deploys {SablierV2LockupTranched} from precompiled bytecode.
+ /// @dev A default value is passed for `maxTrancheCount`.
+ function deployLockupTranched(
+ address initialAdmin,
+ ISablierV2NFTDescriptor nftDescriptor
+ )
+ public
+ returns (ISablierV2LockupTranched lockupTranched)
+ {
+ lockupTranched = deployLockupTranched(initialAdmin, nftDescriptor, MAX_TRANCHE_COUNT);
+ }
+
+ /// @notice Deploys {SablierV2LockupTranched} from precompiled bytecode.
+ function deployLockupTranched(
+ address initialAdmin,
+ ISablierV2NFTDescriptor nftDescriptor,
+ uint256 maxTrancheCount
+ )
+ public
+ returns (ISablierV2LockupTranched lockupTranched)
+ {
+ bytes memory creationBytecode =
+ bytes.concat(BYTECODE_LOCKUP_TRANCHED, abi.encode(initialAdmin, nftDescriptor, maxTrancheCount));
+ assembly {
+ lockupTranched := create(0, add(creationBytecode, 0x20), mload(creationBytecode))
+ }
+ require(
+ address(lockupTranched) != address(0),
+ "Sablier V2 Precompiles: deployment failed for LockupTranched contract"
+ );
+ }
+
+ /// @notice Deploys {SablierV2NFTDescriptor} from precompiled bytecode.
+ function deployNFTDescriptor() public returns (ISablierV2NFTDescriptor nftDescriptor) {
+ bytes memory bytecode = BYTECODE_NFT_DESCRIPTOR;
+ assembly {
+ nftDescriptor := create(0, add(bytecode, 0x20), mload(bytecode))
+ }
+ require(
+ address(nftDescriptor) != address(0), "Sablier V2 Precompiles: deployment failed for NFTDescriptor contract"
+ );
+ }
+
+ /// @notice Deploys all V2 Core contracts.
+ function deployCore(address initialAdmin)
+ public
+ returns (
+ ISablierV2LockupDynamic lockupDynamic,
+ ISablierV2LockupLinear lockupLinear,
+ ISablierV2LockupTranched lockupTranched,
+ ISablierV2NFTDescriptor nftDescriptor
+ )
+ {
+ nftDescriptor = deployNFTDescriptor();
+ lockupDynamic = deployLockupDynamic(initialAdmin);
+ lockupLinear = deployLockupLinear(initialAdmin);
+ lockupTranched = deployLockupTranched(initialAdmin);
+ }
+}
diff --git a/remappings.txt b/remappings.txt
index 167506d32..8f1a7a740 100644
--- a/remappings.txt
+++ b/remappings.txt
@@ -1,6 +1,5 @@
@openzeppelin/contracts/=node_modules/@openzeppelin/contracts/
@prb/math/=node_modules/@prb/math/
-@prb/test/=node_modules/@prb/test/
forge-std/=node_modules/forge-std/
solady/=node_modules/solady/
-solarray/=node_modules/solarray/
\ No newline at end of file
+solarray/=node_modules/solarray/
diff --git a/script/Base.s.sol b/script/Base.s.sol
index e9f18740e..35cb9c755 100644
--- a/script/Base.s.sol
+++ b/script/Base.s.sol
@@ -1,9 +1,20 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19 <0.9.0;
+// solhint-disable no-console
+pragma solidity >=0.8.22 <0.9.0;
+import { Strings } from "@openzeppelin/contracts/utils/Strings.sol";
+
+import { console2 } from "forge-std/src/console2.sol";
import { Script } from "forge-std/src/Script.sol";
+import { stdJson } from "forge-std/src/StdJson.sol";
+
+contract BaseScript is Script {
+ using Strings for uint256;
+ using stdJson for string;
+
+ /// @dev The default value for `segmentCountMap` and `trancheCountMap`.
+ uint256 internal constant DEFAULT_MAX_COUNT = 500;
-abstract contract BaseScript is Script {
/// @dev Included to enable compilation of the script without a $MNEMONIC environment variable.
string internal constant TEST_MNEMONIC = "test test test test test test test test test test test junk";
@@ -13,24 +24,41 @@ abstract contract BaseScript is Script {
/// @dev The address of the transaction broadcaster.
address internal broadcaster;
- /// @dev Used to derive the broadcaster's address if $ETH_FROM is not defined.
+ /// @dev Used to derive the broadcaster's address if $EOA is not defined.
string internal mnemonic;
+ /// @dev Maximum segment count mapped by the chain Id.
+ mapping(uint256 chainId => uint256 count) internal segmentCountMap;
+
+ /// @dev Maximum tranche count mapped by the chain Id.
+ mapping(uint256 chainId => uint256 count) internal trancheCountMap;
+
/// @dev Initializes the transaction broadcaster like this:
///
- /// - If $ETH_FROM is defined, use it.
+ /// - If $EOA is defined, use it.
/// - Otherwise, derive the broadcaster address from $MNEMONIC.
/// - If $MNEMONIC is not defined, default to a test mnemonic.
///
- /// The use case for $ETH_FROM is to specify the broadcaster key and its address via the command line.
+ /// The use case for $EOA is to specify the broadcaster key and its address via the command line.
constructor() {
- address from = vm.envOr({ name: "ETH_FROM", defaultValue: address(0) });
+ address from = vm.envOr({ name: "EOA", defaultValue: address(0) });
if (from != address(0)) {
broadcaster = from;
} else {
mnemonic = vm.envOr({ name: "MNEMONIC", defaultValue: TEST_MNEMONIC });
(broadcaster,) = deriveRememberKey({ mnemonic: mnemonic, index: 0 });
}
+
+ // Populate the segment and tranche count map.
+ populateSegmentAndTrancheCountMap();
+
+ // If there is no maximum value set for a specific chain, use the default value.
+ if (segmentCountMap[block.chainid] == 0) {
+ segmentCountMap[block.chainid] = DEFAULT_MAX_COUNT;
+ }
+ if (trancheCountMap[block.chainid] == 0) {
+ trancheCountMap[block.chainid] = DEFAULT_MAX_COUNT;
+ }
}
modifier broadcast() {
@@ -38,4 +66,70 @@ abstract contract BaseScript is Script {
_;
vm.stopBroadcast();
}
+
+ /// @dev The presence of the salt instructs Forge to deploy contracts via this deterministic CREATE2 factory:
+ /// https://github.com/Arachnid/deterministic-deployment-proxy
+ ///
+ /// Notes:
+ /// - The salt format is "ChainID , Version ".
+ /// - The version is obtained from `package.json`.
+ function constructCreate2Salt() public view returns (bytes32) {
+ string memory chainId = block.chainid.toString();
+ 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);
+ return bytes32(abi.encodePacked(create2Salt));
+ }
+
+ /// @dev Populates the segment & tranche count map. Values can be updated using the `update-counts.sh` script.
+ function populateSegmentAndTrancheCountMap() internal {
+ // forgefmt: disable-start
+
+ // Arbitrum chain ID
+ segmentCountMap[42161] = 1160;
+ trancheCountMap[42161] = 1200;
+
+ // Avalanche chain ID.
+ segmentCountMap[43114] = 520;
+ trancheCountMap[43114] = 540;
+
+ // Base chain ID.
+ segmentCountMap[8453] = 2170;
+ trancheCountMap[8453] = 2270;
+
+ // Blast chain ID.
+ segmentCountMap[238] = 1080;
+ trancheCountMap[238] = 1120;
+
+ // BNB chain ID.
+ segmentCountMap[56] = 4820;
+ trancheCountMap[56] = 5130;
+
+ // Ethereum chain ID.
+ segmentCountMap[1] = 1080;
+ trancheCountMap[1] = 1120;
+
+ // Gnosis chain ID.
+ segmentCountMap[100] = 600;
+ trancheCountMap[100] = 620;
+
+ // Optimism chain ID.
+ segmentCountMap[10] = 1080;
+ trancheCountMap[10] = 1120;
+
+ // Polygon chain ID.
+ segmentCountMap[137] = 1080;
+ trancheCountMap[137] = 1120;
+
+ // Scroll chain ID.
+ segmentCountMap[534352] = 330;
+ trancheCountMap[534352] = 340;
+
+ // Sepolia chain ID.
+ segmentCountMap[11155111] = 1080;
+ trancheCountMap[11155111] = 1120;
+
+ // forgefmt: disable-end
+ }
}
diff --git a/script/DeployComptroller.s.sol b/script/DeployComptroller.s.sol
deleted file mode 100644
index cfeb4769c..000000000
--- a/script/DeployComptroller.s.sol
+++ /dev/null
@@ -1,12 +0,0 @@
-// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19 <0.9.0;
-
-import { SablierV2Comptroller } from "../src/SablierV2Comptroller.sol";
-
-import { BaseScript } from "./Base.s.sol";
-
-contract DeployComptroller is BaseScript {
- function run(address initialAdmin) public virtual broadcast returns (SablierV2Comptroller comptroller) {
- comptroller = new SablierV2Comptroller(initialAdmin);
- }
-}
diff --git a/script/DeployCore.s.sol b/script/DeployCore.s.sol
index cb70fa7a1..df6239c8a 100644
--- a/script/DeployCore.s.sol
+++ b/script/DeployCore.s.sol
@@ -1,37 +1,29 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
-import { SablierV2Comptroller } from "../src/SablierV2Comptroller.sol";
import { SablierV2LockupDynamic } from "../src/SablierV2LockupDynamic.sol";
import { SablierV2LockupLinear } from "../src/SablierV2LockupLinear.sol";
+import { SablierV2LockupTranched } from "../src/SablierV2LockupTranched.sol";
import { SablierV2NFTDescriptor } from "../src/SablierV2NFTDescriptor.sol";
import { BaseScript } from "./Base.s.sol";
-/// @notice Deploys all V2 Core contract in the following order:
-///
-/// 1. {SablierV2Comptroller}
-/// 2. {SablierV2NFTDescriptor}
-/// 3. {SablierV2LockupDynamic}
-/// 4. {SablierV2LockupLinear}
+/// @notice Deploys all V2 Core contracts.
contract DeployCore is BaseScript {
- function run(
- address initialAdmin,
- uint256 maxSegmentCount
- )
+ function run(address initialAdmin)
public
virtual
broadcast
returns (
- SablierV2Comptroller comptroller,
SablierV2LockupDynamic lockupDynamic,
SablierV2LockupLinear lockupLinear,
+ SablierV2LockupTranched lockupTranched,
SablierV2NFTDescriptor nftDescriptor
)
{
- comptroller = new SablierV2Comptroller(initialAdmin);
nftDescriptor = new SablierV2NFTDescriptor();
- lockupDynamic = new SablierV2LockupDynamic(initialAdmin, comptroller, nftDescriptor, maxSegmentCount);
- lockupLinear = new SablierV2LockupLinear(initialAdmin, comptroller, nftDescriptor);
+ lockupDynamic = new SablierV2LockupDynamic(initialAdmin, nftDescriptor, segmentCountMap[block.chainid]);
+ lockupLinear = new SablierV2LockupLinear(initialAdmin, nftDescriptor);
+ lockupTranched = new SablierV2LockupTranched(initialAdmin, nftDescriptor, trancheCountMap[block.chainid]);
}
}
diff --git a/script/DeployCore2.s.sol b/script/DeployCore2.s.sol
index 3ce985c69..a8059dabc 100644
--- a/script/DeployCore2.s.sol
+++ b/script/DeployCore2.s.sol
@@ -1,35 +1,29 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { ISablierV2NFTDescriptor } from "../src/interfaces/ISablierV2NFTDescriptor.sol";
-import { SablierV2Comptroller } from "../src/SablierV2Comptroller.sol";
import { SablierV2LockupDynamic } from "../src/SablierV2LockupDynamic.sol";
import { SablierV2LockupLinear } from "../src/SablierV2LockupLinear.sol";
+import { SablierV2LockupTranched } from "../src/SablierV2LockupTranched.sol";
import { BaseScript } from "./Base.s.sol";
-/// @notice Deploys these contracts in the following order:
-///
-/// 1. {SablierV2Comptroller}
-/// 2. {SablierV2LockupDynamic}
-/// 3. {SablierV2LockupLinear}
contract DeployCore2 is BaseScript {
function run(
address initialAdmin,
- ISablierV2NFTDescriptor nftDescriptor,
- uint256 maxSegmentCount
+ ISablierV2NFTDescriptor nftDescriptor
)
public
virtual
broadcast
returns (
- SablierV2Comptroller comptroller,
SablierV2LockupDynamic lockupDynamic,
- SablierV2LockupLinear lockupLinear
+ SablierV2LockupLinear lockupLinear,
+ SablierV2LockupTranched lockupTranched
)
{
- comptroller = new SablierV2Comptroller(initialAdmin);
- lockupDynamic = new SablierV2LockupDynamic(initialAdmin, comptroller, nftDescriptor, maxSegmentCount);
- lockupLinear = new SablierV2LockupLinear(initialAdmin, comptroller, nftDescriptor);
+ lockupDynamic = new SablierV2LockupDynamic(initialAdmin, nftDescriptor, segmentCountMap[block.chainid]);
+ lockupLinear = new SablierV2LockupLinear(initialAdmin, nftDescriptor);
+ lockupTranched = new SablierV2LockupTranched(initialAdmin, nftDescriptor, trancheCountMap[block.chainid]);
}
}
diff --git a/script/DeployDeterministicComptroller.s.sol b/script/DeployDeterministicComptroller.s.sol
deleted file mode 100644
index e609d960c..000000000
--- a/script/DeployDeterministicComptroller.s.sol
+++ /dev/null
@@ -1,24 +0,0 @@
-// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19 <0.9.0;
-
-import { SablierV2Comptroller } from "../src/SablierV2Comptroller.sol";
-
-import { BaseScript } from "./Base.s.sol";
-
-/// @notice Deploys {SablierV2Comptroller} at a deterministic address across chains.
-/// @dev Reverts if the contract has already been deployed.
-contract DeployDeterministicComptroller is BaseScript {
- /// @dev The presence of the salt instructs Forge to deploy contracts via this deterministic CREATE2 factory:
- /// https://github.com/Arachnid/deterministic-deployment-proxy
- function run(
- string memory create2Salt,
- address initialAdmin
- )
- public
- virtual
- broadcast
- returns (SablierV2Comptroller comptroller)
- {
- comptroller = new SablierV2Comptroller{ salt: bytes32(abi.encodePacked(create2Salt)) }(initialAdmin);
- }
-}
diff --git a/script/DeployDeterministicCore.s.sol b/script/DeployDeterministicCore.s.sol
index aac8a7ab9..b65be9ae7 100644
--- a/script/DeployDeterministicCore.s.sol
+++ b/script/DeployDeterministicCore.s.sol
@@ -1,45 +1,33 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
-import { SablierV2Comptroller } from "../src/SablierV2Comptroller.sol";
import { SablierV2LockupDynamic } from "../src/SablierV2LockupDynamic.sol";
import { SablierV2LockupLinear } from "../src/SablierV2LockupLinear.sol";
+import { SablierV2LockupTranched } from "../src/SablierV2LockupTranched.sol";
import { SablierV2NFTDescriptor } from "../src/SablierV2NFTDescriptor.sol";
import { BaseScript } from "./Base.s.sol";
-/// @notice Deploys all V2 Core contracts at deterministic addresses across chains, in the following order:
-///
-/// 1. {SablierV2Comptroller}
-/// 2. {SablierV2NFTDescriptor}
-/// 3. {SablierV2LockupDynamic}
-/// 4. {SablierV2LockupLinear}
-///
+/// @notice Deploys all V2 Core contracts at deterministic addresses across chains.
/// @dev Reverts if any contract has already been deployed.
contract DeployDeterministicCore is BaseScript {
- /// @dev The presence of the salt instructs Forge to deploy the contract via a deterministic CREATE2 factory.
- /// https://github.com/Arachnid/deterministic-deployment-proxy
- function run(
- string memory create2Salt,
- address initialAdmin,
- uint256 maxSegmentCount
- )
+ function run(address initialAdmin)
public
virtual
broadcast
returns (
- SablierV2Comptroller comptroller,
SablierV2LockupDynamic lockupDynamic,
SablierV2LockupLinear lockupLinear,
+ SablierV2LockupTranched lockupTranched,
SablierV2NFTDescriptor nftDescriptor
)
{
- bytes32 salt = bytes32(abi.encodePacked(create2Salt));
- comptroller = new SablierV2Comptroller{ salt: salt }(initialAdmin);
+ bytes32 salt = constructCreate2Salt();
nftDescriptor = new SablierV2NFTDescriptor{ salt: salt }();
- // forgefmt: disable-next-line
lockupDynamic =
- new SablierV2LockupDynamic{ salt: salt }(initialAdmin, comptroller, nftDescriptor, maxSegmentCount);
- lockupLinear = new SablierV2LockupLinear{ salt: salt }(initialAdmin, comptroller, nftDescriptor);
+ new SablierV2LockupDynamic{ salt: salt }(initialAdmin, nftDescriptor, segmentCountMap[block.chainid]);
+ lockupLinear = new SablierV2LockupLinear{ salt: salt }(initialAdmin, nftDescriptor);
+ lockupTranched =
+ new SablierV2LockupTranched{ salt: salt }(initialAdmin, nftDescriptor, trancheCountMap[block.chainid]);
}
}
diff --git a/script/DeployDeterministicCore2.s.sol b/script/DeployDeterministicCore2.s.sol
index 71015d65e..7b50fb75d 100644
--- a/script/DeployDeterministicCore2.s.sol
+++ b/script/DeployDeterministicCore2.s.sol
@@ -1,43 +1,33 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { ISablierV2NFTDescriptor } from "../src/interfaces/ISablierV2NFTDescriptor.sol";
-import { SablierV2Comptroller } from "../src/SablierV2Comptroller.sol";
import { SablierV2LockupDynamic } from "../src/SablierV2LockupDynamic.sol";
import { SablierV2LockupLinear } from "../src/SablierV2LockupLinear.sol";
+import { SablierV2LockupTranched } from "../src/SablierV2LockupTranched.sol";
import { BaseScript } from "./Base.s.sol";
-/// @notice Deploys these contracts at deterministic addresses across chains, in the following order:
-///
-/// 1. {SablierV2Comptroller}
-/// 2. {SablierV2LockupDynamic}
-/// 3. {SablierV2LockupLinear}
-///
/// @dev Reverts if any contract has already been deployed.
contract DeployDeterministicCore2 is BaseScript {
- /// @dev The presence of the salt instructs Forge to deploy the contract via a deterministic CREATE2 factory.
- /// https://github.com/Arachnid/deterministic-deployment-proxy
function run(
- string memory create2Salt,
address initialAdmin,
- ISablierV2NFTDescriptor nftDescriptor,
- uint256 maxSegmentCount
+ ISablierV2NFTDescriptor nftDescriptor
)
public
virtual
broadcast
returns (
- SablierV2Comptroller comptroller,
SablierV2LockupDynamic lockupDynamic,
- SablierV2LockupLinear lockupLinear
+ SablierV2LockupLinear lockupLinear,
+ SablierV2LockupTranched lockupTranched
)
{
- bytes32 salt = bytes32(abi.encodePacked(create2Salt));
- comptroller = new SablierV2Comptroller{ salt: salt }(initialAdmin);
- // forgefmt: disable-next-line
+ bytes32 salt = constructCreate2Salt();
lockupDynamic =
- new SablierV2LockupDynamic{ salt: salt }(initialAdmin, comptroller, nftDescriptor, maxSegmentCount);
- lockupLinear = new SablierV2LockupLinear{ salt: salt }(initialAdmin, comptroller, nftDescriptor);
+ new SablierV2LockupDynamic{ salt: salt }(initialAdmin, nftDescriptor, segmentCountMap[block.chainid]);
+ lockupLinear = new SablierV2LockupLinear{ salt: salt }(initialAdmin, nftDescriptor);
+ lockupTranched =
+ new SablierV2LockupTranched{ salt: salt }(initialAdmin, nftDescriptor, trancheCountMap[block.chainid]);
}
}
diff --git a/script/DeployDeterministicLockupDynamic.s.sol b/script/DeployDeterministicLockupDynamic.s.sol
index 8c25b4a83..512f89223 100644
--- a/script/DeployDeterministicLockupDynamic.s.sol
+++ b/script/DeployDeterministicLockupDynamic.s.sol
@@ -1,7 +1,6 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
-import { ISablierV2Comptroller } from "../src/interfaces/ISablierV2Comptroller.sol";
import { ISablierV2NFTDescriptor } from "../src/interfaces/ISablierV2NFTDescriptor.sol";
import { SablierV2LockupDynamic } from "../src/SablierV2LockupDynamic.sol";
@@ -10,22 +9,17 @@ import { BaseScript } from "./Base.s.sol";
/// @notice Deploys {SablierV2LockupDynamic} at a deterministic address across chains.
/// @dev Reverts if the contract has already been deployed.
contract DeployDeterministicLockupDynamic is BaseScript {
- /// @dev The presence of the salt instructs Forge to deploy contracts via this deterministic CREATE2 factory:
- /// https://github.com/Arachnid/deterministic-deployment-proxy
function run(
- string memory create2Salt,
address initialAdmin,
- ISablierV2Comptroller initialComptroller,
- ISablierV2NFTDescriptor initialNFTDescriptor,
- uint256 maxSegmentCount
+ ISablierV2NFTDescriptor initialNFTDescriptor
)
public
virtual
broadcast
returns (SablierV2LockupDynamic lockupDynamic)
{
- lockupDynamic = new SablierV2LockupDynamic{ salt: bytes32(abi.encodePacked(create2Salt)) }(
- initialAdmin, initialComptroller, initialNFTDescriptor, maxSegmentCount
- );
+ bytes32 salt = constructCreate2Salt();
+ lockupDynamic =
+ new SablierV2LockupDynamic{ salt: salt }(initialAdmin, initialNFTDescriptor, segmentCountMap[block.chainid]);
}
}
diff --git a/script/DeployDeterministicLockupLinear.s.sol b/script/DeployDeterministicLockupLinear.s.sol
index 3526a45fb..de36726ab 100644
--- a/script/DeployDeterministicLockupLinear.s.sol
+++ b/script/DeployDeterministicLockupLinear.s.sol
@@ -1,7 +1,6 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
-import { ISablierV2Comptroller } from "../src/interfaces/ISablierV2Comptroller.sol";
import { ISablierV2NFTDescriptor } from "../src/interfaces/ISablierV2NFTDescriptor.sol";
import { SablierV2LockupLinear } from "../src/SablierV2LockupLinear.sol";
@@ -10,12 +9,8 @@ import { BaseScript } from "./Base.s.sol";
/// @dev Deploys {SablierV2LockupLinear} at a deterministic address across chains.
/// @dev Reverts if the contract has already been deployed.
contract DeployDeterministicLockupLinear is BaseScript {
- /// @dev The presence of the salt instructs Forge to deploy contracts via this deterministic CREATE2 factory:
- /// https://github.com/Arachnid/deterministic-deployment-proxy
function run(
- string memory create2Salt,
address initialAdmin,
- ISablierV2Comptroller initialComptroller,
ISablierV2NFTDescriptor initialNFTDescriptor
)
public
@@ -23,8 +18,7 @@ contract DeployDeterministicLockupLinear is BaseScript {
broadcast
returns (SablierV2LockupLinear lockupLinear)
{
- lockupLinear = new SablierV2LockupLinear{ salt: bytes32(abi.encodePacked(create2Salt)) }(
- initialAdmin, initialComptroller, initialNFTDescriptor
- );
+ bytes32 salt = constructCreate2Salt();
+ lockupLinear = new SablierV2LockupLinear{ salt: salt }(initialAdmin, initialNFTDescriptor);
}
}
diff --git a/script/DeployDeterministicLockupTranched.s.sol b/script/DeployDeterministicLockupTranched.s.sol
new file mode 100644
index 000000000..9e2641c99
--- /dev/null
+++ b/script/DeployDeterministicLockupTranched.s.sol
@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity >=0.8.22 <0.9.0;
+
+import { ISablierV2NFTDescriptor } from "../src/interfaces/ISablierV2NFTDescriptor.sol";
+import { SablierV2LockupTranched } from "../src/SablierV2LockupTranched.sol";
+
+import { BaseScript } from "./Base.s.sol";
+
+/// @dev Deploys {SablierV2LockupTranched} at a deterministic address across chains.
+/// @dev Reverts if the contract has already been deployed.
+contract DeployDeterministicLockupTranched is BaseScript {
+ function run(
+ address initialAdmin,
+ ISablierV2NFTDescriptor initialNFTDescriptor
+ )
+ public
+ virtual
+ broadcast
+ returns (SablierV2LockupTranched lockupTranched)
+ {
+ bytes32 salt = constructCreate2Salt();
+ lockupTranched = new SablierV2LockupTranched{ salt: salt }(
+ initialAdmin, initialNFTDescriptor, trancheCountMap[block.chainid]
+ );
+ }
+}
diff --git a/script/DeployDeterministicNFTDescriptor.s.sol b/script/DeployDeterministicNFTDescriptor.s.sol
index f7a348b74..f7a72bff2 100644
--- a/script/DeployDeterministicNFTDescriptor.s.sol
+++ b/script/DeployDeterministicNFTDescriptor.s.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { SablierV2NFTDescriptor } from "../src/SablierV2NFTDescriptor.sol";
@@ -8,9 +8,8 @@ import { BaseScript } from "./Base.s.sol";
/// @dev Deploys {SablierV2NFTDescriptor} at a deterministic address across chains.
/// @dev Reverts if the contract has already been deployed.
contract DeployDeterministicNFTDescriptor is BaseScript {
- /// @dev The presence of the salt instructs Forge to deploy contracts via this deterministic CREATE2 factory:
- /// https://github.com/Arachnid/deterministic-deployment-proxy
- function run(string memory create2Salt) public virtual broadcast returns (SablierV2NFTDescriptor nftDescriptor) {
- nftDescriptor = new SablierV2NFTDescriptor{ salt: bytes32(abi.encodePacked(create2Salt)) }();
+ function run() public virtual broadcast returns (SablierV2NFTDescriptor nftDescriptor) {
+ bytes32 salt = constructCreate2Salt();
+ nftDescriptor = new SablierV2NFTDescriptor{ salt: salt }();
}
}
diff --git a/script/DeployLockupDynamic.s.sol b/script/DeployLockupDynamic.s.sol
index b27f75396..ae5a9a7cc 100644
--- a/script/DeployLockupDynamic.s.sol
+++ b/script/DeployLockupDynamic.s.sol
@@ -1,7 +1,6 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
-import { ISablierV2Comptroller } from "../src/interfaces/ISablierV2Comptroller.sol";
import { ISablierV2NFTDescriptor } from "../src/interfaces/ISablierV2NFTDescriptor.sol";
import { SablierV2LockupDynamic } from "../src/SablierV2LockupDynamic.sol";
@@ -10,16 +9,13 @@ import { BaseScript } from "./Base.s.sol";
contract DeployLockupDynamic is BaseScript {
function run(
address initialAdmin,
- ISablierV2Comptroller initialComptroller,
- ISablierV2NFTDescriptor initialNFTDescriptor,
- uint256 maxSegmentCount
+ ISablierV2NFTDescriptor initialNFTDescriptor
)
public
virtual
broadcast
returns (SablierV2LockupDynamic lockupDynamic)
{
- lockupDynamic =
- new SablierV2LockupDynamic(initialAdmin, initialComptroller, initialNFTDescriptor, maxSegmentCount);
+ lockupDynamic = new SablierV2LockupDynamic(initialAdmin, initialNFTDescriptor, segmentCountMap[block.chainid]);
}
}
diff --git a/script/DeployLockupLinear.s.sol b/script/DeployLockupLinear.s.sol
index b3af99d1b..940966a2f 100644
--- a/script/DeployLockupLinear.s.sol
+++ b/script/DeployLockupLinear.s.sol
@@ -1,7 +1,6 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
-import { ISablierV2Comptroller } from "../src/interfaces/ISablierV2Comptroller.sol";
import { ISablierV2NFTDescriptor } from "../src/interfaces/ISablierV2NFTDescriptor.sol";
import { SablierV2LockupLinear } from "../src/SablierV2LockupLinear.sol";
@@ -10,7 +9,6 @@ import { BaseScript } from "./Base.s.sol";
contract DeployLockupLinear is BaseScript {
function run(
address initialAdmin,
- ISablierV2Comptroller initialComptroller,
ISablierV2NFTDescriptor initialNFTDescriptor
)
public
@@ -18,6 +16,6 @@ contract DeployLockupLinear is BaseScript {
broadcast
returns (SablierV2LockupLinear lockupLinear)
{
- lockupLinear = new SablierV2LockupLinear(initialAdmin, initialComptroller, initialNFTDescriptor);
+ lockupLinear = new SablierV2LockupLinear(initialAdmin, initialNFTDescriptor);
}
}
diff --git a/script/DeployLockupTranched.s.sol b/script/DeployLockupTranched.s.sol
new file mode 100644
index 000000000..adae8f7fe
--- /dev/null
+++ b/script/DeployLockupTranched.s.sol
@@ -0,0 +1,21 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity >=0.8.22 <0.9.0;
+
+import { ISablierV2NFTDescriptor } from "../src/interfaces/ISablierV2NFTDescriptor.sol";
+import { SablierV2LockupTranched } from "../src/SablierV2LockupTranched.sol";
+
+import { BaseScript } from "./Base.s.sol";
+
+contract DeployLockupTranched is BaseScript {
+ function run(
+ address initialAdmin,
+ ISablierV2NFTDescriptor initialNFTDescriptor
+ )
+ public
+ virtual
+ broadcast
+ returns (SablierV2LockupTranched lockupTranched)
+ {
+ lockupTranched = new SablierV2LockupTranched(initialAdmin, initialNFTDescriptor, trancheCountMap[block.chainid]);
+ }
+}
diff --git a/script/DeployNFTDescriptor.s.sol b/script/DeployNFTDescriptor.s.sol
index a84ebb90d..6f3019171 100644
--- a/script/DeployNFTDescriptor.s.sol
+++ b/script/DeployNFTDescriptor.s.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { SablierV2NFTDescriptor } from "../src/SablierV2NFTDescriptor.sol";
diff --git a/script/GenerateSVG.s.sol b/script/GenerateSVG.s.sol
index df3bbc9d7..9a3b63b98 100644
--- a/script/GenerateSVG.s.sol
+++ b/script/GenerateSVG.s.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Strings } from "@openzeppelin/contracts/utils/Strings.sol";
@@ -38,11 +38,11 @@ contract GenerateSVG is BaseScript, SablierV2NFTDescriptor {
assetAddress: DAI.toHexString(),
assetSymbol: "DAI",
duration: calculateDurationInDays({ startTime: 0, endTime: duration * 1 days }),
- sablierAddress: LOCKUP_LINEAR.toHexString(),
progress: stringifyPercentage(progress),
progressNumerical: progress,
- status: status,
- streamingModel: "Lockup Linear"
+ sablierAddress: LOCKUP_LINEAR.toHexString(),
+ sablierModel: "Lockup Linear",
+ status: status
})
);
}
diff --git a/script/Init.s.sol b/script/Init.s.sol
index 8a99762ac..a944d4a94 100644
--- a/script/Init.s.sol
+++ b/script/Init.s.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { ud2x18 } from "@prb/math/src/UD2x18.sol";
@@ -7,7 +7,6 @@ import { ud60x18 } from "@prb/math/src/UD60x18.sol";
import { Solarray } from "solarray/src/Solarray.sol";
-import { ISablierV2Comptroller } from "../src/interfaces/ISablierV2Comptroller.sol";
import { ISablierV2LockupDynamic } from "../src/interfaces/ISablierV2LockupDynamic.sol";
import { ISablierV2LockupLinear } from "../src/interfaces/ISablierV2LockupLinear.sol";
import { Broker, LockupDynamic, LockupLinear } from "../src/types/DataTypes.sol";
@@ -15,13 +14,12 @@ import { Broker, LockupDynamic, LockupLinear } from "../src/types/DataTypes.sol"
import { BaseScript } from "./Base.s.sol";
interface IERC20Mint {
- function mint(address beneficiary, uint256 amount) external;
+ function mint(address beneficiary, uint256 value) external;
}
-/// @notice Initializes the protocol by setting up the comptroller and creating some streams.
+/// @notice Initializes the protocol by creating some streams.
contract Init is BaseScript {
function run(
- ISablierV2Comptroller comptroller,
ISablierV2LockupLinear lockupLinear,
ISablierV2LockupDynamic lockupDynamic,
IERC20 asset
@@ -32,28 +30,16 @@ contract Init is BaseScript {
address sender = broadcaster;
address recipient = vm.addr(vm.deriveKey({ mnemonic: mnemonic, index: 1 }));
- /*//////////////////////////////////////////////////////////////////////////
- COMPTROLLER
- //////////////////////////////////////////////////////////////////////////*/
-
- // Enable the ERC-20 asset for flash loaning.
- if (!comptroller.isFlashAsset(asset)) {
- comptroller.toggleFlashAsset(asset);
- }
-
- // Set the flash fee to 0.05%.
- comptroller.setFlashFee({ newFlashFee: ud60x18(0.0005e18) });
-
/*//////////////////////////////////////////////////////////////////////////
LOCKUP-LINEAR
//////////////////////////////////////////////////////////////////////////*/
// Mint enough assets to the sender.
- IERC20Mint(address(asset)).mint({ beneficiary: sender, amount: 131_601.1e18 + 10_000e18 });
+ IERC20Mint(address(asset)).mint({ beneficiary: sender, value: 131_601.1e18 + 10_000e18 });
// Approve the Sablier contracts to transfer the ERC-20 assets from the sender.
- asset.approve({ spender: address(lockupLinear), amount: type(uint256).max });
- asset.approve({ spender: address(lockupDynamic), amount: type(uint256).max });
+ asset.approve({ spender: address(lockupLinear), value: type(uint256).max });
+ asset.approve({ spender: address(lockupDynamic), value: type(uint256).max });
// Create 7 Lockup Linear streams with various amounts and durations.
//
@@ -92,19 +78,21 @@ contract Init is BaseScript {
//////////////////////////////////////////////////////////////////////////*/
// Create the default lockupDynamic stream.
- LockupDynamic.SegmentWithDelta[] memory segments = new LockupDynamic.SegmentWithDelta[](2);
- segments[0] = LockupDynamic.SegmentWithDelta({ amount: 2500e18, exponent: ud2x18(3.14e18), delta: 1 hours });
- segments[1] = LockupDynamic.SegmentWithDelta({ amount: 7500e18, exponent: ud2x18(0.5e18), delta: 1 weeks });
- lockupDynamic.createWithDeltas(
- LockupDynamic.CreateWithDeltas({
+ LockupDynamic.SegmentWithDuration[] memory segments = new LockupDynamic.SegmentWithDuration[](2);
+ segments[0] =
+ LockupDynamic.SegmentWithDuration({ amount: 2500e18, exponent: ud2x18(3.14e18), duration: 1 hours });
+ segments[1] =
+ LockupDynamic.SegmentWithDuration({ amount: 7500e18, exponent: ud2x18(0.5e18), duration: 1 weeks });
+ lockupDynamic.createWithDurations(
+ LockupDynamic.CreateWithDurations({
+ sender: sender,
+ recipient: recipient,
+ totalAmount: 10_000e18,
asset: asset,
- broker: Broker(address(0), ud60x18(0)),
cancelable: true,
transferable: true,
- recipient: recipient,
- sender: sender,
segments: segments,
- totalAmount: 10_000e18
+ broker: Broker(address(0), ud60x18(0))
})
);
}
diff --git a/shell/deploy-multi-chain.sh b/shell/deploy-multi-chain.sh
new file mode 100755
index 000000000..c21ea7b6c
--- /dev/null
+++ b/shell/deploy-multi-chain.sh
@@ -0,0 +1,376 @@
+#!/usr/bin/env bash
+
+# Pre-requisites for running this script:
+#
+# - bash >=4.0.0
+# - foundry (https://getfoundry.sh)
+
+# Usage: ./shell/deploy-multi-chain.sh [options] [[chain1 chain2 ...]]
+# Enters interactive mode if no `.env.deployment` file is found
+#
+# Options:
+# --all Deploy on all chains.
+# --broadcast Broadcast the deployment and verify on Etherscan.
+# --deterministic Deploy using the deterministic script.
+# -h, --help Show available command-line options and exit.
+# -i, --interactive Enters interactive mode and ignore .env.deployment.
+# --print Simulate and show the deployment command.
+# -s, --script Script to run from the `script` folder.
+# --with-gas-price Specify gas price for transaction.
+#
+# Example: ./shell/deploy-multi-chain.sh # By default, deploys to Sepolia only
+# Example: ./shell/deploy-multi-chain.sh --broadcast optimism polygon
+# Example: ./shell/deploy-multi-chain.sh --broadcast --deterministic --print optimism
+#
+# Make sure to set up your `.env.deployment` file first.
+
+# Strict mode: https://gist.github.com/vncsna/64825d5609c146e80de8b1fd623011ca
+set -euo pipefail
+
+# Color codes
+EC='\033[0;31m' # Error Color
+IC='\033[0;36m' # Info Color
+NC='\033[0m' # No Color
+SC='\033[0;32m' # Success Color
+WC='\033[0;33m' # Warn Color
+
+# Unicode characters for tick
+TICK="\xE2\x9C\x94"
+
+# Check: Bash >=4.0.0 is required for associative arrays
+if ((BASH_VERSINFO[0] < 4)); then
+ echo -e "${EC}Error:\nThis script requires Bash version 4.0.0 or higher.
+ \nYou are currently using Bash version ${BASH_VERSINFO[0]}.${BASH_VERSINFO[1]}.${BASH_VERSINFO[2]}.
+ \nPlease upgrade your Bash version and try again.${NC}"
+ exit 1
+fi
+
+# Define usage
+usage="\nUsage: ./shell/deploy-multi-chain.sh [-h] [--help] [--print] [-i] [--interactive] [-s] [--script]
+ [--broadcast] [--deterministic] [--with-gas-price] [--all]
+ [[chain1 chain2 ...]]
+Examples:
+ ./shell/deploy-multi-chain.sh # By default, deploys only to Sepolia
+ ./shell/deploy-multi-chain.sh --broadcast optimism polygon
+ ./shell/deploy-multi-chain.sh --broadcast --deterministic optimism
+"
+
+# Create deployments directory
+deployments=./deployments
+rm -rf ${deployments}
+mkdir ${deployments}
+
+# Addresses taken from https://docs.sablier.com/concepts/governance
+export ARBITRUM_ADMIN="0xF34E41a6f6Ce5A45559B1D3Ee92E141a3De96376"
+export ARBITRUM_SEPOLIA_ADMIN="0xb1bEF51ebCA01EB12001a639bDBbFF6eEcA12B9F"
+export AVALANCHE_ADMIN="0x4735517616373c5137dE8bcCDc887637B8ac85Ce"
+export BASE_ADMIN="0x83A6fA8c04420B3F9C7A4CF1c040b63Fbbc89B66"
+export BNB_ADMIN="0x6666cA940D2f4B65883b454b7Bc7EEB039f64fa3"
+export GNOSIS_ADMIN="0x72ACB57fa6a8fa768bE44Db453B1CDBa8B12A399"
+export MAINNET_ADMIN="0x79Fb3e81aAc012c08501f41296CCC145a1E15844"
+export OPTIMISM_ADMIN="0x43c76FE8Aec91F63EbEfb4f5d2a4ba88ef880350"
+export POLYGON_ADMIN="0x40A518C5B9c1d3D6d62Ba789501CE4D526C9d9C6"
+export SCROLL_ADMIN="0x0F7Ad835235Ede685180A5c611111610813457a9"
+export SEPOLIA_ADMIN="0xb1bEF51ebCA01EB12001a639bDBbFF6eEcA12B9F"
+
+# Flag for broadcast deployment
+BROADCAST_DEPLOYMENT=false
+
+# Flag for deterministic deployment
+DETERMINISTIC_DEPLOYMENT=false
+
+# Flags for gas price
+GAS_PRICE=0
+WITH_GAS_PRICE=false
+
+# Flag for all chains
+ON_ALL_CHAINS=false
+
+# Flag for displaying deployment command
+READ_ONLY=false
+
+# Flag to enter interactive mode in case .env.deployment not found or --interactive is provided
+INTERACTIVE=false
+
+# Provided chains
+provided_chains=()
+
+# Script to execute
+sol_script=""
+
+# Declare the chains array
+declare -A chains
+
+# define function to initialize all configurations
+function initialize {
+ chains["arbitrum"]="$ARBITRUM_RPC_URL $ARBISCAN_API_KEY $ARBITRUM_ADMIN"
+ chains["arbitrum_sepolia"]="$ARBITRUM_SEPOLIA_RPC_URL $ARBISCAN_API_KEY $ARBITRUM_SEPOLIA_ADMIN"
+ chains["avalanche"]="$AVALANCHE_RPC_URL $SNOWTRACE_API_KEY $AVALANCHE_ADMIN"
+ chains["base"]="$BASE_RPC_URL $BASESCAN_API_KEY $BASE_ADMIN"
+ chains["bnb_smart_chain"]="$BNB_RPC_URL $BSCSCAN_API_KEY $BNB_ADMIN"
+ chains["gnosis"]="$GNOSIS_RPC_URL $GNOSISSCAN_API_KEY $GNOSIS_ADMIN"
+ chains["mainnet"]="$MAINNET_RPC_URL $ETHERSCAN_API_KEY $MAINNET_ADMIN"
+ chains["optimism"]="$OPTIMISM_RPC_URL $OPTIMISTIC_API_KEY $OPTIMISM_ADMIN"
+ chains["polygon"]="$POLYGON_RPC_URL $POLYGONSCAN_API_KEY $POLYGON_ADMIN"
+ chains["sepolia"]="$SEPOLIA_RPC_URL $ETHERSCAN_API_KEY $SEPOLIA_ADMIN"
+ chains["scroll"]="$SCROLL_RPC_URL $SCROLLSCAN_API_KEY $SCROLL_ADMIN"
+}
+
+# define function to initialize limited configurations
+function initialize_interactive {
+ # load values from the terminal prompt
+ echo -e "1. Enter admin address: \c"
+ read admin
+
+ echo -e "2. Enter Etherscan API key: \c"
+ read api_key
+}
+
+if [ -f .env.deployment ]; then
+ # Source the .env.deployment file to load the variables
+ source .env.deployment
+
+ # initialize chains with all the configurations
+ initialize
+else
+ # Set bool to enter intaractive mode
+ INTERACTIVE=true
+
+ # load values from the terminal prompt
+ echo -e "${WC}Missing '.env.deployment'. Provide details below: ${NC}\n"
+
+ # initialize chains
+ initialize_interactive
+
+fi
+
+# Check for arguments passed to the script
+for ((i=1; i<=$#; i++)); do
+ # Convert the argument to lowercase
+ arg=${!i,,}
+
+ # Check if '--all' flag is provided in the arguments
+ if [[ ${arg} == "--all" ]]; then
+ ON_ALL_CHAINS=true
+ provided_chains=("${!chains[@]}")
+ fi
+
+ # Check if '--broadcast' flag is provided the arguments
+ if [[ ${arg} == "--broadcast" ]]; then
+ BROADCAST_DEPLOYMENT=true
+ fi
+
+ # Check if '--deterministic' flag is provided in the arguments
+ if [[ ${arg} == "--deterministic" ]]; then
+ DETERMINISTIC_DEPLOYMENT=true
+ fi
+
+ # Show usage of this command with --help option
+ if [[ ${arg} == "--help" || ${arg} == "-h" ]]; then
+ echo -e "${usage}"
+ # Get all chain names from the chains array
+ names=("${!chains[@]}")
+ # Sort the names
+ sorted_names=($(printf "%s\n" "${names[@]}" | sort))
+ # Print the header
+ printf "\nSupported chains: \n%-20s %-20s\n" "Chain Name"
+ printf "%-20s %-20s\n" "-----------"
+
+ # Print the supported chains
+ for chain in "${sorted_names[@]}"; do
+ IFS=' ' read -r rpc_url api_key admin <<< "${chains[$chain]}"
+
+ # Print the chain
+ printf "%-20s %-20s\n" "${chain}"
+ done
+ exit 0
+ fi
+
+ # Check if '--interactive' flag is provided in the arguments
+ if [[ ${arg} == "--interactive" || ${arg} == "-i" ]]; then
+ INTERACTIVE=true
+ echo -e "Interactive mode activated. Provide details below: \n"
+
+ initialize_interactive
+ fi
+
+ # Check if '--print' flag is provided in the arguments
+ if [[ ${arg} == "--print" ]]; then
+ READ_ONLY=true
+ fi
+
+ # Check if '--script' flag is provided in the arguments
+ if [[ ${arg} == "--script" || ${arg} == "-s" ]]; then
+ files=(script/*.s.sol)
+
+ # Present the list of available scripts
+ echo "Please select a script:"
+ select file in "${files[@]}"; do
+ if [[ -n ${file} ]]; then
+ echo -e "${SC}+${NC} You selected ${IC}${file}${NC}"
+ sol_script=${file}
+ break
+ else
+ echo -e "${EC}Invalid selection${NC}"
+ fi
+ done
+ fi
+
+ # Check if '--with-gas-price' flag is provided in the arguments
+ if [[ ${arg} == "--with-gas-price" ]]; then
+ WITH_GAS_PRICE=true
+
+ # Increment index to get the next argument, which should be the gas price
+ ((i++))
+ GAS_PRICE=${!i}
+ if ! [[ ${GAS_PRICE} =~ ^[0-9]+$ ]]; then
+ echo -e "${EC}Error: Invalid value for --with-gas-price, must be number${NC}"
+ exit 1
+ fi
+ fi
+
+ # Check for passed chains
+ if [[ ${arg} != "--all" &&
+ ${arg} != "--broadcast" &&
+ ${arg} != "--deterministic" &&
+ ${arg} != "--help" &&
+ ${arg} != "-h" &&
+ ${arg} != "-i" &&
+ ${arg} != "--interactive" &&
+ ${arg} != "--print" &&
+ ${arg} != "-s" &&
+ ${arg} != "--script" &&
+ ${arg} != "--with-gas-price" &&
+ ${ON_ALL_CHAINS} == false
+ ]]; then
+ # check for synonyms
+ if [[ ${arg} == "ethereum" ]]; then
+ arg="mainnet"
+ fi
+ provided_chains+=("${arg}")
+ fi
+done
+
+# Set the default chain to Sepolia if no chains are provided
+if [ ${#provided_chains[@]} -eq 0 ]; then
+ provided_chains=("sepolia")
+fi
+
+# Compile the contracts
+echo "Compiling the contracts..."
+
+# Deploy to the provided chains
+for chain in "${provided_chains[@]}"; do
+ # Check if the provided chain is defined
+ if [[ ! -v "chains[${chain}]" ]]; then
+ printf "\n${WC}Warning for '${chain}': Invalid command or chain name. Get the full list of supported chains: ${NC}"
+ printf "\n\n\t${IC}./shell/deploy-multi-chain.sh --help${NC}\n"
+ continue
+ fi
+
+ echo -e "\n${IC}Deployment on ${chain} started...${NC}"
+
+ if [[ ${INTERACTIVE} == true ]]; then
+ # load values from the terminal prompt
+ echo -e "Enter RPC URL for ${chain}: \c"
+ read rpc_url
+ else
+ # Split the configuration into RPC, API key, and admin
+ IFS=' ' read -r rpc_url api_key admin <<< "${chains[$chain]}"
+ fi
+
+ # Declare the deployment command
+ declare -a deployment_command
+
+ deployment_command=("forge")
+
+ # Construct the deployment command
+ if [[ ${DETERMINISTIC_DEPLOYMENT} == true ]]; then
+ echo -e "${SC}+${NC} Deterministic address"
+ if [[ ${sol_script} == "" ]]; then
+ deployment_command+=("script" "script/DeployDeterministicCore.s.sol" "--ffi")
+ else
+ deployment_command+=("script" "${sol_script}")
+ fi
+ deployment_command+=("--rpc-url" "${rpc_url}")
+
+ ####################################################################
+ # Distinct ways to construct command with string elements
+ # While execution adds single quotes around them while
+ # echo removes single quotes
+ ####################################################################
+ if [[ ${READ_ONLY} == true ]]; then
+ deployment_command+=("--sig" "'run(address)'")
+ else
+ deployment_command+=("--sig" "run(address)")
+ fi
+ else
+ # Construct the command
+ if [[ ${sol_script} == "" ]]; then
+ deployment_command+=("script" "script/DeployCore.s.sol")
+ else
+ deployment_command+=("script" "${sol_script}")
+ fi
+ deployment_command+=("--rpc-url" "${rpc_url}")
+
+ if [[ ${READ_ONLY} == true ]]; then
+ deployment_command+=("--sig" "'run(address)'")
+ else
+ deployment_command+=("--sig" "run(address)")
+ fi
+ fi
+
+ deployment_command+=("${admin}")
+ deployment_command+=("-vvv")
+
+ # Append additional options if gas price is enabled
+ if [[ ${WITH_GAS_PRICE} == true ]]; then
+ gas_price_in_gwei=$(echo "scale=2; ${GAS_PRICE} / 1000000000" | bc)
+ echo -e "${SC}+${NC} Max gas price: ${gas_price_in_gwei} gwei"
+ deployment_command+=("--with-gas-price" "${GAS_PRICE}")
+ fi
+
+ # Append additional options if broadcast is enabled
+ if [[ ${BROADCAST_DEPLOYMENT} == true ]]; then
+ echo -e "${SC}+${NC} Broadcasting on-chain"
+ deployment_command+=("--broadcast" "--verify" "--etherscan-api-key" "${api_key}")
+ else
+ echo -e "${SC}+${NC} Simulating on forked chain"
+ fi
+
+ if [[ ${READ_ONLY} == true ]]; then
+ # Print deployment_command
+ echo -e "${SC}+${NC} Printing command without action\n"
+ echo -e "FOUNDRY_PROFILE=optimized ${deployment_command[@]}"
+ else
+ # Execute the deployment command and print the logs in real-time
+ output=$(FOUNDRY_PROFILE=optimized "${deployment_command[@]}" |& tee /dev/fd/2) || true
+
+ # Check for error in output
+ if [[ ${output} == *"Error"* ]]; then
+ exit 1
+ fi
+
+ # Create a file for the chain
+ chain_file="${deployments}/${chain}.txt"
+ touch "${chain_file}"
+
+ # Extract and save contract addresses
+ lockupDynamic_address=$(echo "${output}" | awk '/lockupDynamic: contract/{print $NF}')
+ lockupLinear_address=$(echo "${output}" | awk '/lockupLinear: contract/{print $NF}')
+ lockupTranched_address=$(echo "${output}" | awk '/lockupTranched: contract/{print $NF}')
+ nftDescriptor_address=$(echo "${output}" | awk '/nftDescriptor: contract/{print $NF}')
+
+ # Save to the chain file
+ {
+ echo "SablierV2LockupDynamic = ${lockupDynamic_address}"
+ echo "SablierV2LockupLinear = ${lockupLinear_address}"
+ echo "SablierV2LockupTranched = ${lockupTranched_address}"
+ echo "SablierV2NFTDescriptor = ${nftDescriptor_address}"
+ } >> "$chain_file"
+
+ echo -e "${SC}${TICK} Deployed on ${chain}. You can find the addresses in ${chain_file}${NC}"
+ fi
+done
+
+echo -e "\nEnd of it."
diff --git a/shell/generate-svg.sh b/shell/generate-svg.sh
index 4f5a0d556..7748644d6 100755
--- a/shell/generate-svg.sh
+++ b/shell/generate-svg.sh
@@ -5,6 +5,7 @@
# Pre-requisites:
# - foundry (https://getfoundry.sh)
+# - sd (https://github.com/chmln/sd)
# Strict mode: https://gist.github.com/vncsna/64825d5609c146e80de8b1fd623011ca
set -euo pipefail
@@ -24,11 +25,16 @@ output=$(
"$arg_amount" \
"$arg_duration"
)
-svg=$(echo "$output" | awk -F "svg: string " '{print $2}' | awk 'NF > 0')
+
+# Forge adds 'svg: string ' as a prefix before the SVG
+# - The awk command records everything after the prefix, while filtering out empty lines
+# - `sd \\"` '"'` removes the escape backslashes
+# - `sd ^\"|\"$' ''` removes the starting and the ending double quotes
+svg=$(echo "$output" | awk -F "svg: string " '/svg: string /{print $2; exit}' | sd '\\"' '"' | sd '^"|"$' '')
# Generate the file name
name="nft-${arg_progress}-${arg_status}-${arg_amount}-${arg_duration}.svg"
-sanitized="$(echo "$name" | sed "s/ //g" )" # remove whitespaces
+sanitized="$(echo "$name" | sd ' ' '' )" # remove whitespaces
# Put the SVG in a file
mkdir -p "out-svg"
diff --git a/shell/prepare-artifacts.sh b/shell/prepare-artifacts.sh
index 06ab4fe97..5aa4f6ab5 100755
--- a/shell/prepare-artifacts.sh
+++ b/shell/prepare-artifacts.sh
@@ -2,7 +2,7 @@
# Pre-requisites:
# - foundry (https://getfoundry.sh)
-# - pnpm (https://pnpm.io)
+# - bun (https://bun.sh)
# Strict mode: https://gist.github.com/vncsna/64825d5609c146e80de8b1fd623011ca
set -euo pipefail
@@ -16,24 +16,23 @@ mkdir $artifacts \
"$artifacts/interfaces" \
"$artifacts/interfaces/erc20" \
"$artifacts/interfaces/erc721" \
- "$artifacts/interfaces/hooks" \
"$artifacts/libraries"
# Generate the artifacts with Forge
FOUNDRY_PROFILE=optimized forge build
# Copy the production artifacts
-cp out-optimized/SablierV2Comptroller.sol/SablierV2Comptroller.json $artifacts
cp out-optimized/SablierV2LockupDynamic.sol/SablierV2LockupDynamic.json $artifacts
cp out-optimized/SablierV2LockupLinear.sol/SablierV2LockupLinear.json $artifacts
+cp out-optimized/SablierV2LockupTranched.sol/SablierV2LockupTranched.json $artifacts
cp out-optimized/SablierV2NFTDescriptor.sol/SablierV2NFTDescriptor.json $artifacts
interfaces=./artifacts/interfaces
-cp out-optimized/ISablierV2Base.sol/ISablierV2Base.json $interfaces
-cp out-optimized/ISablierV2Comptroller.sol/ISablierV2Comptroller.json $interfaces
+cp out-optimized/ISablierLockupRecipient.sol/ISablierLockupRecipient.json $interfaces
cp out-optimized/ISablierV2Lockup.sol/ISablierV2Lockup.json $interfaces
cp out-optimized/ISablierV2LockupDynamic.sol/ISablierV2LockupDynamic.json $interfaces
cp out-optimized/ISablierV2LockupLinear.sol/ISablierV2LockupLinear.json $interfaces
+cp out-optimized/ISablierV2LockupTranched.sol/ISablierV2LockupTranched.json $interfaces
cp out-optimized/ISablierV2NFTDescriptor.sol/ISablierV2NFTDescriptor.json $interfaces
erc20=./artifacts/interfaces/erc20
@@ -43,11 +42,8 @@ erc721=./artifacts/interfaces/erc721
cp out-optimized/IERC721.sol/IERC721.json $erc721
cp out-optimized/IERC721Metadata.sol/IERC721Metadata.json $erc721
-hooks=./artifacts/interfaces/hooks
-cp out-optimized/ISablierV2LockupRecipient.sol/ISablierV2LockupRecipient.json $hooks
-
libraries=./artifacts/libraries
cp out-optimized/Errors.sol/Errors.json $libraries
# Format the artifacts with Prettier
-pnpm prettier --write ./artifacts
+bun prettier --write ./artifacts
diff --git a/shell/update-counts.sh b/shell/update-counts.sh
new file mode 100755
index 000000000..a865a3f4e
--- /dev/null
+++ b/shell/update-counts.sh
@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+# Pre-requisites for running this script:
+#
+# - bun (https://bun.sh)
+# - foundry (https://getfoundry.sh)
+
+# Strict mode
+set -euo pipefail
+
+# Path to the Base Script
+BASE_SCRIPT="script/Base.s.sol"
+
+# Compile the contracts with the optimized profile
+bun run build:optimized
+
+# Generalized function to update counts
+update_counts() {
+ local test_name=$1
+ local map_name=$2
+ echo -e "\nRunning forge test for estimating $test_name..."
+ local output=$(FOUNDRY_PROFILE=benchmark forge t --mt "test_Estimate${test_name}" -vv)
+ echo -e "\nParsing output for $test_name..."
+
+ # Define a table with headers. This table is not put in the Solidity script file,
+ # but is used to be displayed in the terminal.
+ local table="Category,Chain ID,New Max Count"
+
+ # Parse the output to extract counts and chain IDs
+ while IFS= read -r line; do
+ local count=$(echo $line | awk '{print $2}')
+ local chain_id=$(echo $line | awk '{print $8}')
+
+ # Add the data to the table
+ table+="\n$map_name,$chain_id,$count"
+
+ # Update the map for each chain ID using sd
+ sd "$map_name\[$chain_id\] = [0-9]+;" "$map_name[$chain_id] = $count;" $BASE_SCRIPT
+ done < <(echo "$output" | grep 'count:')
+
+ # Print the table using the column command
+ echo -e $table | column -t -s ','
+}
+
+# Call the function with specific parameters for segments and tranches
+update_counts "Segments" "segmentCountMap"
+update_counts "Tranches" "trancheCountMap"
+
+# Reformat the code with Forge
+forge fmt $BASE_SCRIPT
+
+printf "\n\nAll mappings updated."
diff --git a/shell/update-precompiles.sh b/shell/update-precompiles.sh
index dd2d205b0..008db274a 100755
--- a/shell/update-precompiles.sh
+++ b/shell/update-precompiles.sh
@@ -12,21 +12,21 @@ set -euo pipefail
FOUNDRY_PROFILE=optimized forge build
# Retrieve the raw bytecodes, removing the "0x" prefix
-comptroller=$(cat out-optimized/SablierV2Comptroller.sol/SablierV2Comptroller.json | jq -r '.bytecode.object' | cut -c 3-)
lockup_dynamic=$(cat out-optimized/SablierV2LockupDynamic.sol/SablierV2LockupDynamic.json | jq -r '.bytecode.object' | cut -c 3-)
lockup_linear=$(cat out-optimized/SablierV2LockupLinear.sol/SablierV2LockupLinear.json | jq -r '.bytecode.object' | cut -c 3-)
+lockup_tranched=$(cat out-optimized/SablierV2LockupTranched.sol/SablierV2LockupTranched.json | jq -r '.bytecode.object' | cut -c 3-)
nft_descriptor=$(cat out-optimized/SablierV2NFTDescriptor.sol/SablierV2NFTDescriptor.json | jq -r '.bytecode.object' | cut -c 3-)
-precompiles_path="test/utils/Precompiles.sol"
+precompiles_path="precompiles/Precompiles.sol"
if [ ! -f $precompiles_path ]; then
echo "Precompiles file does not exist"
exit 1
fi
# Replace the current bytecodes
-sd "(BYTECODE_COMPTROLLER =)[^;]+;" "\$1 hex\"$comptroller\";" $precompiles_path
sd "(BYTECODE_LOCKUP_DYNAMIC =)[^;]+;" "\$1 hex\"$lockup_dynamic\";" $precompiles_path
sd "(BYTECODE_LOCKUP_LINEAR =)[^;]+;" "\$1 hex\"$lockup_linear\";" $precompiles_path
+sd "(BYTECODE_LOCKUP_TRANCHED =)[^;]+;" "\$1 hex\"$lockup_tranched\";" $precompiles_path
sd "(BYTECODE_NFT_DESCRIPTOR =)[^;]+;" "\$1 hex\"$nft_descriptor\";" $precompiles_path
# Reformat the code with Forge
diff --git a/slither.config.json b/slither.config.json
index 16f73fce4..a42619ece 100644
--- a/slither.config.json
+++ b/slither.config.json
@@ -1,10 +1,9 @@
{
"detectors_to_exclude": "naming-convention,reentrancy-events,solc-version,timestamp",
- "filter_paths": "(test)",
+ "filter_paths": "(node_modules/,test/)",
"solc_remaps": [
"@openzeppelin/contracts/=node_modules/@openzeppelin/contracts/",
"@prb/math/=node_modules/@prb-math/",
- "@prb/test/=node_modules/@prb/test/",
"forge-std/=node_modules/forge-std/",
"solady/=node_modules/solady/",
"solarray/=node_modules/solarray/"
diff --git a/src/SablierV2Comptroller.sol b/src/SablierV2Comptroller.sol
deleted file mode 100644
index 2c7390980..000000000
--- a/src/SablierV2Comptroller.sol
+++ /dev/null
@@ -1,97 +0,0 @@
-// SPDX-License-Identifier: BUSL-1.1
-pragma solidity >=0.8.19;
-
-import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-import { UD60x18 } from "@prb/math/src/UD60x18.sol";
-
-import { Adminable } from "./abstracts/Adminable.sol";
-import { IAdminable } from "./interfaces/IAdminable.sol";
-import { ISablierV2Comptroller } from "./interfaces/ISablierV2Comptroller.sol";
-
-/*
-
-███████╗ █████╗ ██████╗ ██╗ ██╗███████╗██████╗ ██╗ ██╗██████╗
-██╔════╝██╔══██╗██╔══██╗██║ ██║██╔════╝██╔══██╗ ██║ ██║╚════██╗
-███████╗███████║██████╔╝██║ ██║█████╗ ██████╔╝ ██║ ██║ █████╔╝
-╚════██║██╔══██║██╔══██╗██║ ██║██╔══╝ ██╔══██╗ ╚██╗ ██╔╝██╔═══╝
-███████║██║ ██║██████╔╝███████╗██║███████╗██║ ██║ ╚████╔╝ ███████╗
-╚══════╝╚═╝ ╚═╝╚═════╝ ╚══════╝╚═╝╚══════╝╚═╝ ╚═╝ ╚═══╝ ╚══════╝
-
- ██████╗ ██████╗ ███╗ ███╗██████╗ ████████╗██████╗ ██████╗ ██╗ ██╗ ███████╗██████╗
-██╔════╝██╔═══██╗████╗ ████║██╔══██╗╚══██╔══╝██╔══██╗██╔═══██╗██║ ██║ ██╔════╝██╔══██╗
-██║ ██║ ██║██╔████╔██║██████╔╝ ██║ ██████╔╝██║ ██║██║ ██║ █████╗ ██████╔╝
-██║ ██║ ██║██║╚██╔╝██║██╔═══╝ ██║ ██╔══██╗██║ ██║██║ ██║ ██╔══╝ ██╔══██╗
-╚██████╗╚██████╔╝██║ ╚═╝ ██║██║ ██║ ██║ ██║╚██████╔╝███████╗███████╗███████╗██║ ██║
- ╚═════╝ ╚═════╝ ╚═╝ ╚═╝╚═╝ ╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚══════╝╚══════╝╚══════╝╚═╝ ╚═╝
-
-*/
-
-/// @title SablierV2Comptroller
-/// @notice See the documentation in {ISablierV2Comptroller}.
-contract SablierV2Comptroller is
- ISablierV2Comptroller, // 1 inherited component
- Adminable // 1 inherited component
-{
- /*//////////////////////////////////////////////////////////////////////////
- PUBLIC STORAGE
- //////////////////////////////////////////////////////////////////////////*/
-
- /// @inheritdoc ISablierV2Comptroller
- UD60x18 public override flashFee;
-
- /// @inheritdoc ISablierV2Comptroller
- mapping(IERC20 asset => bool supported) public override isFlashAsset;
-
- /// @inheritdoc ISablierV2Comptroller
- mapping(IERC20 asset => UD60x18 fee) public override protocolFees;
-
- /*//////////////////////////////////////////////////////////////////////////
- CONSTRUCTOR
- //////////////////////////////////////////////////////////////////////////*/
-
- /// @dev Emits a {TransferAdmin} event.
- /// @param initialAdmin The address of the initial contract admin.
- constructor(address initialAdmin) {
- admin = initialAdmin;
- emit IAdminable.TransferAdmin({ oldAdmin: address(0), newAdmin: initialAdmin });
- }
-
- /*//////////////////////////////////////////////////////////////////////////
- USER-FACING NON-CONSTANT FUNCTIONS
- //////////////////////////////////////////////////////////////////////////*/
-
- /// @inheritdoc ISablierV2Comptroller
- function setFlashFee(UD60x18 newFlashFee) external override onlyAdmin {
- // Effects: set the new flash fee.
- UD60x18 oldFlashFee = flashFee;
- flashFee = newFlashFee;
-
- // Log the change of the flash fee.
- emit ISablierV2Comptroller.SetFlashFee({ admin: msg.sender, oldFlashFee: oldFlashFee, newFlashFee: newFlashFee });
- }
-
- /// @inheritdoc ISablierV2Comptroller
- function setProtocolFee(IERC20 asset, UD60x18 newProtocolFee) external override onlyAdmin {
- // Effects: set the new global fee.
- UD60x18 oldProtocolFee = protocolFees[asset];
- protocolFees[asset] = newProtocolFee;
-
- // Log the change of the protocol fee.
- emit ISablierV2Comptroller.SetProtocolFee({
- admin: msg.sender,
- asset: asset,
- oldProtocolFee: oldProtocolFee,
- newProtocolFee: newProtocolFee
- });
- }
-
- /// @inheritdoc ISablierV2Comptroller
- function toggleFlashAsset(IERC20 asset) external override onlyAdmin {
- // Effects: enable the ERC-20 asset for flash loaning.
- bool oldFlag = isFlashAsset[asset];
- isFlashAsset[asset] = !oldFlag;
-
- // Log the change of the flash asset flag.
- emit ISablierV2Comptroller.ToggleFlashAsset({ admin: msg.sender, asset: asset, newFlag: !oldFlag });
- }
-}
diff --git a/src/SablierV2LockupDynamic.sol b/src/SablierV2LockupDynamic.sol
index e8a15a4cb..b06b15c64 100644
--- a/src/SablierV2LockupDynamic.sol
+++ b/src/SablierV2LockupDynamic.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: BUSL-1.1
-pragma solidity >=0.8.19;
+pragma solidity >=0.8.22;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
@@ -7,15 +7,10 @@ import { ERC721 } from "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import { PRBMathCastingUint128 as CastingUint128 } from "@prb/math/src/casting/Uint128.sol";
import { PRBMathCastingUint40 as CastingUint40 } from "@prb/math/src/casting/Uint40.sol";
import { SD59x18 } from "@prb/math/src/SD59x18.sol";
-import { UD60x18 } from "@prb/math/src/UD60x18.sol";
import { SablierV2Lockup } from "./abstracts/SablierV2Lockup.sol";
-import { ISablierV2Comptroller } from "./interfaces/ISablierV2Comptroller.sol";
-import { ISablierV2Lockup } from "./interfaces/ISablierV2Lockup.sol";
import { ISablierV2LockupDynamic } from "./interfaces/ISablierV2LockupDynamic.sol";
-import { ISablierV2LockupRecipient } from "./interfaces/hooks/ISablierV2LockupRecipient.sol";
import { ISablierV2NFTDescriptor } from "./interfaces/ISablierV2NFTDescriptor.sol";
-import { Errors } from "./libraries/Errors.sol";
import { Helpers } from "./libraries/Helpers.sol";
import { Lockup, LockupDynamic } from "./types/DataTypes.sol";
@@ -40,7 +35,7 @@ import { Lockup, LockupDynamic } from "./types/DataTypes.sol";
/// @title SablierV2LockupDynamic
/// @notice See the documentation in {ISablierV2LockupDynamic}.
contract SablierV2LockupDynamic is
- ISablierV2LockupDynamic, // 1 inherited component
+ ISablierV2LockupDynamic, // 5 inherited components
SablierV2Lockup // 14 inherited components
{
using CastingUint128 for uint128;
@@ -48,18 +43,14 @@ contract SablierV2LockupDynamic is
using SafeERC20 for IERC20;
/*//////////////////////////////////////////////////////////////////////////
- PUBLIC CONSTANTS
+ STATE VARIABLES
//////////////////////////////////////////////////////////////////////////*/
/// @inheritdoc ISablierV2LockupDynamic
uint256 public immutable override MAX_SEGMENT_COUNT;
- /*//////////////////////////////////////////////////////////////////////////
- PRIVATE STORAGE
- //////////////////////////////////////////////////////////////////////////*/
-
- /// @dev Sablier V2 Lockup Dynamic streams mapped by unsigned integer ids.
- mapping(uint256 id => LockupDynamic.Stream stream) private _streams;
+ /// @dev Stream segments mapped by stream IDs. This complements the `_streams` mapping in {SablierV2Lockup}.
+ mapping(uint256 id => LockupDynamic.Segment[] segments) internal _segments;
/*//////////////////////////////////////////////////////////////////////////
CONSTRUCTOR
@@ -67,17 +58,15 @@ contract SablierV2LockupDynamic is
/// @dev Emits a {TransferAdmin} event.
/// @param initialAdmin The address of the initial contract admin.
- /// @param initialComptroller The address of the initial comptroller.
/// @param initialNFTDescriptor The address of the NFT descriptor contract.
/// @param maxSegmentCount The maximum number of segments allowed in a stream.
constructor(
address initialAdmin,
- ISablierV2Comptroller initialComptroller,
ISablierV2NFTDescriptor initialNFTDescriptor,
uint256 maxSegmentCount
)
ERC721("Sablier V2 Lockup Dynamic NFT", "SAB-V2-LOCKUP-DYN")
- SablierV2Lockup(initialAdmin, initialComptroller, initialNFTDescriptor)
+ SablierV2Lockup(initialAdmin, initialNFTDescriptor)
{
MAX_SEGMENT_COUNT = maxSegmentCount;
nextStreamId = 1;
@@ -87,49 +76,6 @@ contract SablierV2LockupDynamic is
USER-FACING CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
- /// @inheritdoc ISablierV2Lockup
- function getAsset(uint256 streamId) external view override notNull(streamId) returns (IERC20 asset) {
- asset = _streams[streamId].asset;
- }
-
- /// @inheritdoc ISablierV2Lockup
- function getDepositedAmount(uint256 streamId)
- external
- view
- override
- notNull(streamId)
- returns (uint128 depositedAmount)
- {
- depositedAmount = _streams[streamId].amounts.deposited;
- }
-
- /// @inheritdoc ISablierV2Lockup
- function getEndTime(uint256 streamId) external view override notNull(streamId) returns (uint40 endTime) {
- endTime = _streams[streamId].endTime;
- }
-
- /// @inheritdoc ISablierV2LockupDynamic
- function getRange(uint256 streamId)
- external
- view
- override
- notNull(streamId)
- returns (LockupDynamic.Range memory range)
- {
- range = LockupDynamic.Range({ start: _streams[streamId].startTime, end: _streams[streamId].endTime });
- }
-
- /// @inheritdoc ISablierV2Lockup
- function getRefundedAmount(uint256 streamId)
- external
- view
- override
- notNull(streamId)
- returns (uint128 refundedAmount)
- {
- refundedAmount = _streams[streamId].amounts.refunded;
- }
-
/// @inheritdoc ISablierV2LockupDynamic
function getSegments(uint256 streamId)
external
@@ -138,17 +84,7 @@ contract SablierV2LockupDynamic is
notNull(streamId)
returns (LockupDynamic.Segment[] memory segments)
{
- segments = _streams[streamId].segments;
- }
-
- /// @inheritdoc ISablierV2Lockup
- function getSender(uint256 streamId) external view override notNull(streamId) returns (address sender) {
- sender = _streams[streamId].sender;
- }
-
- /// @inheritdoc ISablierV2Lockup
- function getStartTime(uint256 streamId) external view override notNull(streamId) returns (uint40 startTime) {
- startTime = _streams[streamId].startTime;
+ segments = _segments[streamId];
}
/// @inheritdoc ISablierV2LockupDynamic
@@ -157,103 +93,41 @@ contract SablierV2LockupDynamic is
view
override
notNull(streamId)
- returns (LockupDynamic.Stream memory stream)
+ returns (LockupDynamic.StreamLD memory stream)
{
- stream = _streams[streamId];
+ // Retrieve the Lockup stream from storage.
+ Lockup.Stream memory lockupStream = _streams[streamId];
// Settled streams cannot be canceled.
if (_statusOf(streamId) == Lockup.Status.SETTLED) {
- stream.isCancelable = false;
+ lockupStream.isCancelable = false;
}
- }
- /// @inheritdoc ISablierV2Lockup
- function getWithdrawnAmount(uint256 streamId)
- external
- view
- override
- notNull(streamId)
- returns (uint128 withdrawnAmount)
- {
- withdrawnAmount = _streams[streamId].amounts.withdrawn;
- }
-
- /// @inheritdoc ISablierV2Lockup
- function isCancelable(uint256 streamId) external view override notNull(streamId) returns (bool result) {
- if (_statusOf(streamId) != Lockup.Status.SETTLED) {
- result = _streams[streamId].isCancelable;
- }
- }
-
- /// @inheritdoc SablierV2Lockup
- function isTransferable(uint256 streamId)
- public
- view
- override(ISablierV2Lockup, SablierV2Lockup)
- notNull(streamId)
- returns (bool result)
- {
- result = _streams[streamId].isTransferable;
- }
-
- /// @inheritdoc ISablierV2Lockup
- function isDepleted(uint256 streamId)
- public
- view
- override(ISablierV2Lockup, SablierV2Lockup)
- notNull(streamId)
- returns (bool result)
- {
- result = _streams[streamId].isDepleted;
- }
-
- /// @inheritdoc ISablierV2Lockup
- function isStream(uint256 streamId) public view override(ISablierV2Lockup, SablierV2Lockup) returns (bool result) {
- result = _streams[streamId].isStream;
+ stream = LockupDynamic.StreamLD({
+ amounts: lockupStream.amounts,
+ asset: lockupStream.asset,
+ endTime: lockupStream.endTime,
+ isCancelable: lockupStream.isCancelable,
+ isDepleted: lockupStream.isDepleted,
+ isStream: lockupStream.isStream,
+ isTransferable: lockupStream.isTransferable,
+ recipient: _ownerOf(streamId),
+ segments: _segments[streamId],
+ sender: lockupStream.sender,
+ startTime: lockupStream.startTime,
+ wasCanceled: lockupStream.wasCanceled
+ });
}
- /// @inheritdoc ISablierV2Lockup
- function refundableAmountOf(uint256 streamId)
+ /// @inheritdoc ISablierV2LockupDynamic
+ function getTimestamps(uint256 streamId)
external
view
override
notNull(streamId)
- returns (uint128 refundableAmount)
- {
- // These checks are needed because {_calculateStreamedAmount} does not look up the stream's status. Note that
- // checking for `isCancelable` also checks if the stream `wasCanceled` thanks to the protocol invariant that
- // canceled streams are not cancelable anymore.
- if (_streams[streamId].isCancelable && !_streams[streamId].isDepleted) {
- refundableAmount = _streams[streamId].amounts.deposited - _calculateStreamedAmount(streamId);
- }
- // Otherwise, the result is implicitly zero.
- }
-
- /// @inheritdoc ISablierV2Lockup
- function statusOf(uint256 streamId) external view override notNull(streamId) returns (Lockup.Status status) {
- status = _statusOf(streamId);
- }
-
- /// @inheritdoc ISablierV2LockupDynamic
- function streamedAmountOf(uint256 streamId)
- public
- view
- override(ISablierV2Lockup, ISablierV2LockupDynamic)
- notNull(streamId)
- returns (uint128 streamedAmount)
+ returns (LockupDynamic.Timestamps memory timestamps)
{
- streamedAmount = _streamedAmountOf(streamId);
- }
-
- /// @inheritdoc ISablierV2Lockup
- function wasCanceled(uint256 streamId)
- public
- view
- override(ISablierV2Lockup, SablierV2Lockup)
- notNull(streamId)
- returns (bool result)
- {
- result = _streams[streamId].wasCanceled;
+ timestamps = LockupDynamic.Timestamps({ start: _streams[streamId].startTime, end: _streams[streamId].endTime });
}
/*//////////////////////////////////////////////////////////////////////////
@@ -261,62 +135,74 @@ contract SablierV2LockupDynamic is
//////////////////////////////////////////////////////////////////////////*/
/// @inheritdoc ISablierV2LockupDynamic
- function createWithDeltas(LockupDynamic.CreateWithDeltas calldata params)
+ function createWithDurations(LockupDynamic.CreateWithDurations calldata params)
external
override
noDelegateCall
returns (uint256 streamId)
{
- // Checks: check the deltas and generate the canonical segments.
- LockupDynamic.Segment[] memory segments = Helpers.checkDeltasAndCalculateMilestones(params.segments);
+ // Generate the canonical segments.
+ LockupDynamic.Segment[] memory segments = Helpers.calculateSegmentTimestamps(params.segments);
// Checks, Effects and Interactions: create the stream.
- streamId = _createWithMilestones(
- LockupDynamic.CreateWithMilestones({
+ streamId = _create(
+ LockupDynamic.CreateWithTimestamps({
+ sender: params.sender,
+ recipient: params.recipient,
+ totalAmount: params.totalAmount,
asset: params.asset,
- broker: params.broker,
cancelable: params.cancelable,
transferable: params.transferable,
- recipient: params.recipient,
- segments: segments,
- sender: params.sender,
startTime: uint40(block.timestamp),
- totalAmount: params.totalAmount
+ segments: segments,
+ broker: params.broker
})
);
}
/// @inheritdoc ISablierV2LockupDynamic
- function createWithMilestones(LockupDynamic.CreateWithMilestones calldata params)
+ function createWithTimestamps(LockupDynamic.CreateWithTimestamps calldata params)
external
override
noDelegateCall
returns (uint256 streamId)
{
// Checks, Effects and Interactions: create the stream.
- streamId = _createWithMilestones(params);
+ streamId = _create(params);
}
/*//////////////////////////////////////////////////////////////////////////
INTERNAL CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
- /// @dev Calculates the streamed amount without looking up the stream's status.
- function _calculateStreamedAmount(uint256 streamId) internal view returns (uint128) {
+ /// @inheritdoc SablierV2Lockup
+ /// @dev The distribution function is:
+ ///
+ /// $$
+ /// f(x) = x^{exp} * csa + \Sigma(esa)
+ /// $$
+ ///
+ /// Where:
+ ///
+ /// - $x$ is the elapsed time divided by the total duration of the current segment.
+ /// - $exp$ is the current segment exponent.
+ /// - $csa$ is the current segment amount.
+ /// - $\Sigma(esa)$ is the sum of all vested segments' amounts.
+ function _calculateStreamedAmount(uint256 streamId) internal view override returns (uint128) {
// If the start time is in the future, return zero.
- uint40 currentTime = uint40(block.timestamp);
- if (_streams[streamId].startTime >= currentTime) {
+ uint40 blockTimestamp = uint40(block.timestamp);
+ if (_streams[streamId].startTime >= blockTimestamp) {
return 0;
}
// If the end time is not in the future, return the deposited amount.
uint40 endTime = _streams[streamId].endTime;
- if (endTime <= currentTime) {
+ if (endTime <= blockTimestamp) {
return _streams[streamId].amounts.deposited;
}
- if (_streams[streamId].segments.length > 1) {
- // If there is more than one segment, it may be necessary to iterate over all of them.
+ if (_segments[streamId].length > 1) {
+ // If there is more than one segment, it may be required to iterate over all of them.
return _calculateStreamedAmountForMultipleSegments(streamId);
} else {
// Otherwise, there is only one segment, and the calculation is simpler.
@@ -334,47 +220,49 @@ contract SablierV2LockupDynamic is
/// bounds" error.
function _calculateStreamedAmountForMultipleSegments(uint256 streamId) internal view returns (uint128) {
unchecked {
- uint40 currentTime = uint40(block.timestamp);
- LockupDynamic.Stream memory stream = _streams[streamId];
+ uint40 blockTimestamp = uint40(block.timestamp);
+ Lockup.Stream memory stream = _streams[streamId];
+ LockupDynamic.Segment[] memory segments = _segments[streamId];
- // Sum the amounts in all segments that precede the current time.
+ // Sum the amounts in all segments that precede the block timestamp.
uint128 previousSegmentAmounts;
- uint40 currentSegmentMilestone = stream.segments[0].milestone;
+ uint40 currentSegmentTimestamp = segments[0].timestamp;
uint256 index = 0;
- while (currentSegmentMilestone < currentTime) {
- previousSegmentAmounts += stream.segments[index].amount;
+ while (currentSegmentTimestamp < blockTimestamp) {
+ previousSegmentAmounts += segments[index].amount;
index += 1;
- currentSegmentMilestone = stream.segments[index].milestone;
+ currentSegmentTimestamp = segments[index].timestamp;
}
// After exiting the loop, the current segment is at `index`.
- SD59x18 currentSegmentAmount = stream.segments[index].amount.intoSD59x18();
- SD59x18 currentSegmentExponent = stream.segments[index].exponent.intoSD59x18();
- currentSegmentMilestone = stream.segments[index].milestone;
-
- uint40 previousMilestone;
- if (index > 0) {
- // When the current segment's index is greater than or equal to 1, it implies that the segment is not
- // the first. In this case, use the previous segment's milestone.
- previousMilestone = stream.segments[index - 1].milestone;
+ SD59x18 currentSegmentAmount = segments[index].amount.intoSD59x18();
+ SD59x18 currentSegmentExponent = segments[index].exponent.intoSD59x18();
+ currentSegmentTimestamp = segments[index].timestamp;
+
+ uint40 previousTimestamp;
+ if (index == 0) {
+ // When the current segment's index is equal to 0, the current segment is the first, so use the start
+ // time as the previous timestamp.
+ previousTimestamp = stream.startTime;
} else {
- // Otherwise, the current segment is the first, so use the start time as the previous milestone.
- previousMilestone = stream.startTime;
+ // Otherwise, when the current segment's index is greater than zero, it means that the segment is not
+ // the first. In this case, use the previous segment's timestamp.
+ previousTimestamp = segments[index - 1].timestamp;
}
- // Calculate how much time has passed since the segment started, and the total time of the segment.
- SD59x18 elapsedSegmentTime = (currentTime - previousMilestone).intoSD59x18();
- SD59x18 totalSegmentTime = (currentSegmentMilestone - previousMilestone).intoSD59x18();
+ // Calculate how much time has passed since the segment started, and the total duration of the segment.
+ SD59x18 elapsedTime = (blockTimestamp - previousTimestamp).intoSD59x18();
+ SD59x18 segmentDuration = (currentSegmentTimestamp - previousTimestamp).intoSD59x18();
- // Divide the elapsed segment time by the total duration of the segment.
- SD59x18 elapsedSegmentTimePercentage = elapsedSegmentTime.div(totalSegmentTime);
+ // Divide the elapsed time by the total duration of the segment.
+ SD59x18 elapsedTimePercentage = elapsedTime.div(segmentDuration);
// Calculate the streamed amount using the special formula.
- SD59x18 multiplier = elapsedSegmentTimePercentage.pow(currentSegmentExponent);
+ SD59x18 multiplier = elapsedTimePercentage.pow(currentSegmentExponent);
SD59x18 segmentStreamedAmount = multiplier.mul(currentSegmentAmount);
// Although the segment streamed amount should never exceed the total segment amount, this condition is
- // checked without asserting to avoid locking funds in case of a bug. If this situation occurs, the
+ // checked without asserting to avoid locking assets in case of a bug. If this situation occurs, the
// amount streamed in the segment is considered zero (except for past withdrawals), and the segment is
// effectively voided.
if (segmentStreamedAmount.gt(currentSegmentAmount)) {
@@ -389,19 +277,19 @@ contract SablierV2LockupDynamic is
}
}
- /// @dev Calculates the streamed amount for a a stream with one segment. Normalization to 18 decimals is not
+ /// @dev Calculates the streamed amount for a stream with one segment. Normalization to 18 decimals is not
/// needed because there is no mix of amounts with different decimals.
function _calculateStreamedAmountForOneSegment(uint256 streamId) internal view returns (uint128) {
unchecked {
// Calculate how much time has passed since the stream started, and the stream's total duration.
SD59x18 elapsedTime = (uint40(block.timestamp) - _streams[streamId].startTime).intoSD59x18();
- SD59x18 totalTime = (_streams[streamId].endTime - _streams[streamId].startTime).intoSD59x18();
+ SD59x18 totalDuration = (_streams[streamId].endTime - _streams[streamId].startTime).intoSD59x18();
// Divide the elapsed time by the stream's total duration.
- SD59x18 elapsedTimePercentage = elapsedTime.div(totalTime);
+ SD59x18 elapsedTimePercentage = elapsedTime.div(totalDuration);
// Cast the stream parameters to SD59x18.
- SD59x18 exponent = _streams[streamId].segments[0].exponent.intoSD59x18();
+ SD59x18 exponent = _segments[streamId][0].exponent.intoSD59x18();
SD59x18 depositedAmount = _streams[streamId].amounts.deposited.intoSD59x18();
// Calculate the streamed amount using the special formula.
@@ -409,7 +297,7 @@ contract SablierV2LockupDynamic is
SD59x18 streamedAmount = multiplier.mul(depositedAmount);
// Although the streamed amount should never exceed the deposited amount, this condition is checked
- // without asserting to avoid locking funds in case of a bug. If this situation occurs, the withdrawn
+ // without asserting to avoid locking assets in case of a bug. If this situation occurs, the withdrawn
// amount is considered to be the streamed amount, and the stream is effectively frozen.
if (streamedAmount.gt(depositedAmount)) {
return _streams[streamId].amounts.withdrawn;
@@ -420,176 +308,55 @@ contract SablierV2LockupDynamic is
}
}
- /// @inheritdoc SablierV2Lockup
- function _isCallerStreamSender(uint256 streamId) internal view override returns (bool) {
- return msg.sender == _streams[streamId].sender;
- }
-
- /// @inheritdoc SablierV2Lockup
- function _statusOf(uint256 streamId) internal view override returns (Lockup.Status) {
- if (_streams[streamId].isDepleted) {
- return Lockup.Status.DEPLETED;
- } else if (_streams[streamId].wasCanceled) {
- return Lockup.Status.CANCELED;
- }
-
- if (block.timestamp < _streams[streamId].startTime) {
- return Lockup.Status.PENDING;
- }
-
- if (_calculateStreamedAmount(streamId) < _streams[streamId].amounts.deposited) {
- return Lockup.Status.STREAMING;
- } else {
- return Lockup.Status.SETTLED;
- }
- }
-
- /// @dev See the documentation for the user-facing functions that call this internal function.
- function _streamedAmountOf(uint256 streamId) internal view returns (uint128) {
- Lockup.Amounts memory amounts = _streams[streamId].amounts;
-
- if (_streams[streamId].isDepleted) {
- return amounts.withdrawn;
- } else if (_streams[streamId].wasCanceled) {
- return amounts.deposited - amounts.refunded;
- }
-
- return _calculateStreamedAmount(streamId);
- }
-
- /// @dev See the documentation for the user-facing functions that call this internal function.
- function _withdrawableAmountOf(uint256 streamId) internal view override returns (uint128) {
- return _streamedAmountOf(streamId) - _streams[streamId].amounts.withdrawn;
- }
-
/*//////////////////////////////////////////////////////////////////////////
INTERNAL NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @dev See the documentation for the user-facing functions that call this internal function.
- function _cancel(uint256 streamId) internal override {
- // Calculate the streamed amount.
- uint128 streamedAmount = _calculateStreamedAmount(streamId);
-
- // Retrieve the amounts from storage.
- Lockup.Amounts memory amounts = _streams[streamId].amounts;
-
- // Checks: the stream is not settled.
- if (streamedAmount >= amounts.deposited) {
- revert Errors.SablierV2Lockup_StreamSettled(streamId);
- }
-
- // Checks: the stream is cancelable.
- if (!_streams[streamId].isCancelable) {
- revert Errors.SablierV2Lockup_StreamNotCancelable(streamId);
- }
-
- // Calculate the sender's and the recipient's amount.
- uint128 senderAmount = amounts.deposited - streamedAmount;
- uint128 recipientAmount = streamedAmount - amounts.withdrawn;
-
- // Effects: mark the stream as canceled.
- _streams[streamId].wasCanceled = true;
-
- // Effects: make the stream not cancelable anymore, because a stream can only be canceled once.
- _streams[streamId].isCancelable = false;
-
- // Effects: If there are no assets left for the recipient to withdraw, mark the stream as depleted.
- if (recipientAmount == 0) {
- _streams[streamId].isDepleted = true;
- }
-
- // Effects: set the refunded amount.
- _streams[streamId].amounts.refunded = senderAmount;
-
- // Retrieve the sender and the recipient from storage.
- address sender = _streams[streamId].sender;
- address recipient = _ownerOf(streamId);
-
- // Retrieve the ERC-20 asset from storage.
- IERC20 asset = _streams[streamId].asset;
-
- // Interactions: refund the sender.
- asset.safeTransfer({ to: sender, value: senderAmount });
-
- // Log the cancellation.
- emit ISablierV2Lockup.CancelLockupStream(streamId, sender, recipient, asset, senderAmount, recipientAmount);
-
- // Emits an ERC-4906 event to trigger an update of the NFT metadata.
- emit MetadataUpdate({ _tokenId: streamId });
-
- // Interactions: if the recipient is a contract, try to invoke the cancel hook on the recipient without
- // reverting if the hook is not implemented, and without bubbling up any potential revert.
- if (recipient.code.length > 0) {
- try ISablierV2LockupRecipient(recipient).onStreamCanceled({
- streamId: streamId,
- sender: sender,
- senderAmount: senderAmount,
- recipientAmount: recipientAmount
- }) { } catch { }
- }
- }
-
- /// @dev See the documentation for the user-facing functions that call this internal function.
- function _createWithMilestones(LockupDynamic.CreateWithMilestones memory params)
- internal
- returns (uint256 streamId)
- {
- // Safe Interactions: query the protocol fee. This is safe because it's a known Sablier contract that does
- // not call other unknown contracts.
- UD60x18 protocolFee = comptroller.protocolFees(params.asset);
-
- // Checks: check the fees and calculate the fee amounts.
+ function _create(LockupDynamic.CreateWithTimestamps memory params) internal returns (uint256 streamId) {
+ // Check: verify the broker fee and calculate the amounts.
Lockup.CreateAmounts memory createAmounts =
- Helpers.checkAndCalculateFees(params.totalAmount, protocolFee, params.broker.fee, MAX_FEE);
+ Helpers.checkAndCalculateBrokerFee(params.totalAmount, params.broker.fee, MAX_BROKER_FEE);
- // Checks: validate the user-provided parameters.
- Helpers.checkCreateWithMilestones(createAmounts.deposit, params.segments, MAX_SEGMENT_COUNT, params.startTime);
+ // Check: validate the user-provided parameters.
+ Helpers.checkCreateLockupDynamic(createAmounts.deposit, params.segments, MAX_SEGMENT_COUNT, params.startTime);
- // Load the stream id in a variable.
+ // Load the stream ID in a variable.
streamId = nextStreamId;
- // Effects: create the stream.
- LockupDynamic.Stream storage stream = _streams[streamId];
+ // Effect: create the stream.
+ Lockup.Stream storage stream = _streams[streamId];
stream.amounts.deposited = createAmounts.deposit;
stream.asset = params.asset;
stream.isCancelable = params.cancelable;
- stream.isTransferable = params.transferable;
stream.isStream = true;
+ stream.isTransferable = params.transferable;
stream.sender = params.sender;
+ stream.startTime = params.startTime;
unchecked {
// The segment count cannot be zero at this point.
uint256 segmentCount = params.segments.length;
- stream.endTime = params.segments[segmentCount - 1].milestone;
- stream.startTime = params.startTime;
+ stream.endTime = params.segments[segmentCount - 1].timestamp;
- // Effects: store the segments. Since Solidity lacks a syntax for copying arrays directly from
+ // Effect: store the segments. Since Solidity lacks a syntax for copying arrays of structs directly from
// memory to storage, a manual approach is necessary. See https://github.com/ethereum/solidity/issues/12783.
for (uint256 i = 0; i < segmentCount; ++i) {
- stream.segments.push(params.segments[i]);
+ _segments[streamId].push(params.segments[i]);
}
- // Effects: bump the next stream id and record the protocol fee.
+ // Effect: bump the next stream ID.
// Using unchecked arithmetic because these calculations cannot realistically overflow, ever.
nextStreamId = streamId + 1;
- protocolRevenues[params.asset] = protocolRevenues[params.asset] + createAmounts.protocolFee;
}
- // Effects: mint the NFT to the recipient.
+ // Effect: mint the NFT to the recipient.
_mint({ to: params.recipient, tokenId: streamId });
- // Interactions: transfer the deposit and the protocol fee.
- // Using unchecked arithmetic because the deposit and the protocol fee are bounded by the total amount.
- unchecked {
- params.asset.safeTransferFrom({
- from: msg.sender,
- to: address(this),
- value: createAmounts.deposit + createAmounts.protocolFee
- });
- }
+ // Interaction: transfer the deposit amount.
+ params.asset.safeTransferFrom({ from: msg.sender, to: address(this), value: createAmounts.deposit });
- // Interactions: pay the broker fee, if not zero.
+ // Interaction: pay the broker fee, if not zero.
if (createAmounts.brokerFee > 0) {
params.asset.safeTransferFrom({ from: msg.sender, to: params.broker.account, value: createAmounts.brokerFee });
}
@@ -605,47 +372,8 @@ contract SablierV2LockupDynamic is
cancelable: params.cancelable,
transferable: params.transferable,
segments: params.segments,
- range: LockupDynamic.Range({ start: stream.startTime, end: stream.endTime }),
+ timestamps: LockupDynamic.Timestamps({ start: stream.startTime, end: stream.endTime }),
broker: params.broker.account
});
}
-
- /// @dev See the documentation for the user-facing functions that call this internal function.
- function _renounce(uint256 streamId) internal override {
- // Checks: the stream is cancelable.
- if (!_streams[streamId].isCancelable) {
- revert Errors.SablierV2Lockup_StreamNotCancelable(streamId);
- }
-
- // Effects: renounce the stream by making it not cancelable.
- _streams[streamId].isCancelable = false;
- }
-
- /// @dev See the documentation for the user-facing functions that call this internal function.
- function _withdraw(uint256 streamId, address to, uint128 amount) internal override {
- // Effects: update the withdrawn amount.
- _streams[streamId].amounts.withdrawn = _streams[streamId].amounts.withdrawn + amount;
-
- // Retrieve the amounts from storage.
- Lockup.Amounts memory amounts = _streams[streamId].amounts;
-
- // Using ">=" instead of "==" for additional safety reasons. In the event of an unforeseen increase in the
- // withdrawn amount, the stream will still be marked as depleted.
- if (amounts.withdrawn >= amounts.deposited - amounts.refunded) {
- // Effects: mark the stream as depleted.
- _streams[streamId].isDepleted = true;
-
- // Effects: make the stream not cancelable anymore, because a depleted stream cannot be canceled.
- _streams[streamId].isCancelable = false;
- }
-
- // Retrieve the ERC-20 asset from storage.
- IERC20 asset = _streams[streamId].asset;
-
- // Interactions: perform the ERC-20 transfer.
- asset.safeTransfer({ to: to, value: amount });
-
- // Log the withdrawal.
- emit ISablierV2Lockup.WithdrawFromLockupStream(streamId, to, asset, amount);
- }
}
diff --git a/src/SablierV2LockupLinear.sol b/src/SablierV2LockupLinear.sol
index 1f0c4da75..d8380cc93 100644
--- a/src/SablierV2LockupLinear.sol
+++ b/src/SablierV2LockupLinear.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: BUSL-1.1
-pragma solidity >=0.8.19;
+pragma solidity >=0.8.22;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
@@ -7,12 +7,9 @@ import { ERC721 } from "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import { UD60x18, ud } from "@prb/math/src/UD60x18.sol";
import { SablierV2Lockup } from "./abstracts/SablierV2Lockup.sol";
-import { ISablierV2Comptroller } from "./interfaces/ISablierV2Comptroller.sol";
-import { ISablierV2Lockup } from "./interfaces/ISablierV2Lockup.sol";
+import { SablierV2Lockup } from "./abstracts/SablierV2Lockup.sol";
import { ISablierV2LockupLinear } from "./interfaces/ISablierV2LockupLinear.sol";
import { ISablierV2NFTDescriptor } from "./interfaces/ISablierV2NFTDescriptor.sol";
-import { ISablierV2LockupRecipient } from "./interfaces/hooks/ISablierV2LockupRecipient.sol";
-import { Errors } from "./libraries/Errors.sol";
import { Helpers } from "./libraries/Helpers.sol";
import { Lockup, LockupLinear } from "./types/DataTypes.sol";
@@ -43,11 +40,11 @@ contract SablierV2LockupLinear is
using SafeERC20 for IERC20;
/*//////////////////////////////////////////////////////////////////////////
- PRIVATE STORAGE
+ STATE VARIABLES
//////////////////////////////////////////////////////////////////////////*/
- /// @dev Sablier V2 Lockup Linear streams mapped by unsigned integers.
- mapping(uint256 id => LockupLinear.Stream stream) private _streams;
+ /// @dev Cliff times mapped by stream IDs. This complements the `_streams` mapping in {SablierV2Lockup}.
+ mapping(uint256 id => uint40 cliff) internal _cliffs;
/*//////////////////////////////////////////////////////////////////////////
CONSTRUCTOR
@@ -55,15 +52,13 @@ contract SablierV2LockupLinear is
/// @dev Emits a {TransferAdmin} event.
/// @param initialAdmin The address of the initial contract admin.
- /// @param initialComptroller The address of the initial comptroller.
/// @param initialNFTDescriptor The address of the initial NFT descriptor.
constructor(
address initialAdmin,
- ISablierV2Comptroller initialComptroller,
ISablierV2NFTDescriptor initialNFTDescriptor
)
ERC721("Sablier V2 Lockup Linear NFT", "SAB-V2-LOCKUP-LIN")
- SablierV2Lockup(initialAdmin, initialComptroller, initialNFTDescriptor)
+ SablierV2Lockup(initialAdmin, initialNFTDescriptor)
{
nextStreamId = 1;
}
@@ -72,66 +67,9 @@ contract SablierV2LockupLinear is
USER-FACING CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
- /// @inheritdoc ISablierV2Lockup
- function getAsset(uint256 streamId) external view override notNull(streamId) returns (IERC20 asset) {
- asset = _streams[streamId].asset;
- }
-
/// @inheritdoc ISablierV2LockupLinear
function getCliffTime(uint256 streamId) external view override notNull(streamId) returns (uint40 cliffTime) {
- cliffTime = _streams[streamId].cliffTime;
- }
-
- /// @inheritdoc ISablierV2Lockup
- function getDepositedAmount(uint256 streamId)
- external
- view
- override
- notNull(streamId)
- returns (uint128 depositedAmount)
- {
- depositedAmount = _streams[streamId].amounts.deposited;
- }
-
- /// @inheritdoc ISablierV2Lockup
- function getEndTime(uint256 streamId) external view override notNull(streamId) returns (uint40 endTime) {
- endTime = _streams[streamId].endTime;
- }
-
- /// @inheritdoc ISablierV2LockupLinear
- function getRange(uint256 streamId)
- external
- view
- override
- notNull(streamId)
- returns (LockupLinear.Range memory range)
- {
- range = LockupLinear.Range({
- start: _streams[streamId].startTime,
- cliff: _streams[streamId].cliffTime,
- end: _streams[streamId].endTime
- });
- }
-
- /// @inheritdoc ISablierV2Lockup
- function getRefundedAmount(uint256 streamId)
- external
- view
- override
- notNull(streamId)
- returns (uint128 refundedAmount)
- {
- refundedAmount = _streams[streamId].amounts.refunded;
- }
-
- /// @inheritdoc ISablierV2Lockup
- function getSender(uint256 streamId) external view override notNull(streamId) returns (address sender) {
- sender = _streams[streamId].sender;
- }
-
- /// @inheritdoc ISablierV2Lockup
- function getStartTime(uint256 streamId) external view override notNull(streamId) returns (uint40 startTime) {
- startTime = _streams[streamId].startTime;
+ cliffTime = _cliffs[streamId];
}
/// @inheritdoc ISablierV2LockupLinear
@@ -140,103 +78,45 @@ contract SablierV2LockupLinear is
view
override
notNull(streamId)
- returns (LockupLinear.Stream memory stream)
+ returns (LockupLinear.StreamLL memory stream)
{
- stream = _streams[streamId];
+ // Retrieve the Lockup stream from storage.
+ Lockup.Stream memory lockupStream = _streams[streamId];
// Settled streams cannot be canceled.
if (_statusOf(streamId) == Lockup.Status.SETTLED) {
- stream.isCancelable = false;
+ lockupStream.isCancelable = false;
}
- }
- /// @inheritdoc ISablierV2Lockup
- function getWithdrawnAmount(uint256 streamId)
- external
- view
- override
- notNull(streamId)
- returns (uint128 withdrawnAmount)
- {
- withdrawnAmount = _streams[streamId].amounts.withdrawn;
- }
-
- /// @inheritdoc ISablierV2Lockup
- function isCancelable(uint256 streamId) external view override notNull(streamId) returns (bool result) {
- if (_statusOf(streamId) != Lockup.Status.SETTLED) {
- result = _streams[streamId].isCancelable;
- }
- }
-
- /// @inheritdoc SablierV2Lockup
- function isTransferable(uint256 streamId)
- public
- view
- override(ISablierV2Lockup, SablierV2Lockup)
- notNull(streamId)
- returns (bool result)
- {
- result = _streams[streamId].isTransferable;
- }
-
- /// @inheritdoc ISablierV2Lockup
- function isDepleted(uint256 streamId)
- public
- view
- override(ISablierV2Lockup, SablierV2Lockup)
- notNull(streamId)
- returns (bool result)
- {
- result = _streams[streamId].isDepleted;
- }
-
- /// @inheritdoc ISablierV2Lockup
- function isStream(uint256 streamId) public view override(ISablierV2Lockup, SablierV2Lockup) returns (bool result) {
- result = _streams[streamId].isStream;
+ stream = LockupLinear.StreamLL({
+ amounts: lockupStream.amounts,
+ asset: lockupStream.asset,
+ cliffTime: _cliffs[streamId],
+ endTime: lockupStream.endTime,
+ isCancelable: lockupStream.isCancelable,
+ isTransferable: lockupStream.isTransferable,
+ isDepleted: lockupStream.isDepleted,
+ isStream: lockupStream.isStream,
+ recipient: _ownerOf(streamId),
+ sender: lockupStream.sender,
+ startTime: lockupStream.startTime,
+ wasCanceled: lockupStream.wasCanceled
+ });
}
- /// @inheritdoc ISablierV2Lockup
- function refundableAmountOf(uint256 streamId)
+ /// @inheritdoc ISablierV2LockupLinear
+ function getTimestamps(uint256 streamId)
external
view
override
notNull(streamId)
- returns (uint128 refundableAmount)
- {
- // These checks are needed because {_calculateStreamedAmount} does not look up the stream's status. Note that
- // checking for `isCancelable` also checks if the stream `wasCanceled` thanks to the protocol invariant that
- // canceled streams are not cancelable anymore.
- if (_streams[streamId].isCancelable && !_streams[streamId].isDepleted) {
- refundableAmount = _streams[streamId].amounts.deposited - _calculateStreamedAmount(streamId);
- }
- // Otherwise, the result is implicitly zero.
- }
-
- /// @inheritdoc ISablierV2Lockup
- function statusOf(uint256 streamId) external view override notNull(streamId) returns (Lockup.Status status) {
- status = _statusOf(streamId);
- }
-
- /// @inheritdoc ISablierV2LockupLinear
- function streamedAmountOf(uint256 streamId)
- public
- view
- override(ISablierV2Lockup, ISablierV2LockupLinear)
- notNull(streamId)
- returns (uint128 streamedAmount)
+ returns (LockupLinear.Timestamps memory timestamps)
{
- streamedAmount = _streamedAmountOf(streamId);
- }
-
- /// @inheritdoc ISablierV2Lockup
- function wasCanceled(uint256 streamId)
- public
- view
- override(ISablierV2Lockup, SablierV2Lockup)
- notNull(streamId)
- returns (bool result)
- {
- result = _streams[streamId].wasCanceled;
+ timestamps = LockupLinear.Timestamps({
+ start: _streams[streamId].startTime,
+ cliff: _cliffs[streamId],
+ end: _streams[streamId].endTime
+ });
}
/*//////////////////////////////////////////////////////////////////////////
@@ -251,58 +131,74 @@ contract SablierV2LockupLinear is
returns (uint256 streamId)
{
// Set the current block timestamp as the stream's start time.
- LockupLinear.Range memory range;
- range.start = uint40(block.timestamp);
+ LockupLinear.Timestamps memory timestamps;
+ timestamps.start = uint40(block.timestamp);
- // Calculate the cliff time and the end time. It is safe to use unchecked arithmetic because
- // {_createWithRange} will nonetheless check that the end time is greater than the cliff time,
- // and also that the cliff time is greater than or equal to the start time.
+ // Calculate the cliff time and the end time. It is safe to use unchecked arithmetic because {_create} will
+ // nonetheless check that the end time is greater than the cliff time, and also that the cliff time, if set,
+ // is greater than or equal to the start time.
unchecked {
- range.cliff = range.start + params.durations.cliff;
- range.end = range.start + params.durations.total;
+ if (params.durations.cliff > 0) {
+ timestamps.cliff = timestamps.start + params.durations.cliff;
+ }
+ timestamps.end = timestamps.start + params.durations.total;
}
+
// Checks, Effects and Interactions: create the stream.
- streamId = _createWithRange(
- LockupLinear.CreateWithRange({
+ streamId = _create(
+ LockupLinear.CreateWithTimestamps({
+ sender: params.sender,
+ recipient: params.recipient,
+ totalAmount: params.totalAmount,
asset: params.asset,
- broker: params.broker,
cancelable: params.cancelable,
transferable: params.transferable,
- range: range,
- recipient: params.recipient,
- sender: params.sender,
- totalAmount: params.totalAmount
+ timestamps: timestamps,
+ broker: params.broker
})
);
}
/// @inheritdoc ISablierV2LockupLinear
- function createWithRange(LockupLinear.CreateWithRange calldata params)
+ function createWithTimestamps(LockupLinear.CreateWithTimestamps calldata params)
external
override
noDelegateCall
returns (uint256 streamId)
{
// Checks, Effects and Interactions: create the stream.
- streamId = _createWithRange(params);
+ streamId = _create(params);
}
/*//////////////////////////////////////////////////////////////////////////
INTERNAL CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
- /// @dev Calculates the streamed amount without looking up the stream's status.
- function _calculateStreamedAmount(uint256 streamId) internal view returns (uint128) {
- // If the cliff time is in the future, return zero.
- uint256 cliffTime = uint256(_streams[streamId].cliffTime);
- uint256 currentTime = block.timestamp;
- if (cliffTime > currentTime) {
+ /// @inheritdoc SablierV2Lockup
+ /// @dev The distribution function is:
+ ///
+ /// $$
+ /// f(x) = x * d + c
+ /// $$
+ ///
+ /// Where:
+ ///
+ /// - $x$ is the elapsed time divided by the stream's total duration.
+ /// - $d$ is the deposited amount.
+ /// - $c$ is the cliff amount.
+ function _calculateStreamedAmount(uint256 streamId) internal view override returns (uint128) {
+ uint256 cliffTime = uint256(_cliffs[streamId]);
+ uint256 startTime = uint256(_streams[streamId].startTime);
+ uint256 blockTimestamp = block.timestamp;
+
+ // If the cliff time or the start time is in the future, return zero.
+ if (cliffTime > blockTimestamp || startTime >= blockTimestamp) {
return 0;
}
// If the end time is not in the future, return the deposited amount.
uint256 endTime = uint256(_streams[streamId].endTime);
- if (currentTime >= endTime) {
+ if (blockTimestamp >= endTime) {
return _streams[streamId].amounts.deposited;
}
@@ -310,12 +206,11 @@ contract SablierV2LockupLinear is
// because there is no mix of amounts with different decimals.
unchecked {
// Calculate how much time has passed since the stream started, and the stream's total duration.
- uint256 startTime = uint256(_streams[streamId].startTime);
- UD60x18 elapsedTime = ud(currentTime - startTime);
- UD60x18 totalTime = ud(endTime - startTime);
+ UD60x18 elapsedTime = ud(blockTimestamp - startTime);
+ UD60x18 totalDuration = ud(endTime - startTime);
// Divide the elapsed time by the stream's total duration.
- UD60x18 elapsedTimePercentage = elapsedTime.div(totalTime);
+ UD60x18 elapsedTimePercentage = elapsedTime.div(totalDuration);
// Cast the deposited amount to UD60x18.
UD60x18 depositedAmount = ud(_streams[streamId].amounts.deposited);
@@ -324,7 +219,7 @@ contract SablierV2LockupLinear is
UD60x18 streamedAmount = elapsedTimePercentage.mul(depositedAmount);
// Although the streamed amount should never exceed the deposited amount, this condition is checked
- // without asserting to avoid locking funds in case of a bug. If this situation occurs, the withdrawn
+ // without asserting to avoid locking assets in case of a bug. If this situation occurs, the withdrawn
// amount is considered to be the streamed amount, and the stream is effectively frozen.
if (streamedAmount.gt(depositedAmount)) {
return _streams[streamId].amounts.withdrawn;
@@ -335,168 +230,54 @@ contract SablierV2LockupLinear is
}
}
- /// @inheritdoc SablierV2Lockup
- function _isCallerStreamSender(uint256 streamId) internal view override returns (bool) {
- return msg.sender == _streams[streamId].sender;
- }
-
- /// @inheritdoc SablierV2Lockup
- function _statusOf(uint256 streamId) internal view override returns (Lockup.Status) {
- if (_streams[streamId].isDepleted) {
- return Lockup.Status.DEPLETED;
- } else if (_streams[streamId].wasCanceled) {
- return Lockup.Status.CANCELED;
- }
-
- if (block.timestamp < _streams[streamId].startTime) {
- return Lockup.Status.PENDING;
- }
-
- if (_calculateStreamedAmount(streamId) < _streams[streamId].amounts.deposited) {
- return Lockup.Status.STREAMING;
- } else {
- return Lockup.Status.SETTLED;
- }
- }
-
- /// @dev See the documentation for the user-facing functions that call this internal function.
- function _streamedAmountOf(uint256 streamId) internal view returns (uint128) {
- Lockup.Amounts memory amounts = _streams[streamId].amounts;
-
- if (_streams[streamId].isDepleted) {
- return amounts.withdrawn;
- } else if (_streams[streamId].wasCanceled) {
- return amounts.deposited - amounts.refunded;
- }
-
- return _calculateStreamedAmount(streamId);
- }
-
- /// @dev See the documentation for the user-facing functions that call this internal function.
- function _withdrawableAmountOf(uint256 streamId) internal view override returns (uint128) {
- return _streamedAmountOf(streamId) - _streams[streamId].amounts.withdrawn;
- }
-
/*//////////////////////////////////////////////////////////////////////////
INTERNAL NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @dev See the documentation for the user-facing functions that call this internal function.
- function _cancel(uint256 streamId) internal override {
- // Calculate the streamed amount.
- uint128 streamedAmount = _calculateStreamedAmount(streamId);
-
- // Retrieve the amounts from storage.
- Lockup.Amounts memory amounts = _streams[streamId].amounts;
-
- // Checks: the stream is not settled.
- if (streamedAmount >= amounts.deposited) {
- revert Errors.SablierV2Lockup_StreamSettled(streamId);
- }
-
- // Checks: the stream is cancelable.
- if (!_streams[streamId].isCancelable) {
- revert Errors.SablierV2Lockup_StreamNotCancelable(streamId);
- }
-
- // Calculate the sender's and the recipient's amount.
- uint128 senderAmount = amounts.deposited - streamedAmount;
- uint128 recipientAmount = streamedAmount - amounts.withdrawn;
-
- // Effects: mark the stream as canceled.
- _streams[streamId].wasCanceled = true;
-
- // Effects: make the stream not cancelable anymore, because a stream can only be canceled once.
- _streams[streamId].isCancelable = false;
-
- // Effects: If there are no assets left for the recipient to withdraw, mark the stream as depleted.
- if (recipientAmount == 0) {
- _streams[streamId].isDepleted = true;
- }
-
- // Effects: set the refunded amount.
- _streams[streamId].amounts.refunded = senderAmount;
-
- // Retrieve the sender and the recipient from storage.
- address sender = _streams[streamId].sender;
- address recipient = _ownerOf(streamId);
-
- // Retrieve the ERC-20 asset from storage.
- IERC20 asset = _streams[streamId].asset;
-
- // Interactions: refund the sender.
- asset.safeTransfer({ to: sender, value: senderAmount });
-
- // Log the cancellation.
- emit ISablierV2Lockup.CancelLockupStream(streamId, sender, recipient, asset, senderAmount, recipientAmount);
-
- // Emits an ERC-4906 event to trigger an update of the NFT metadata.
- emit MetadataUpdate({ _tokenId: streamId });
-
- // Interactions: if the recipient is a contract, try to invoke the cancel hook on the recipient without
- // reverting if the hook is not implemented, and without bubbling up any potential revert.
- if (recipient.code.length > 0) {
- try ISablierV2LockupRecipient(recipient).onStreamCanceled({
- streamId: streamId,
- sender: sender,
- senderAmount: senderAmount,
- recipientAmount: recipientAmount
- }) { } catch { }
- }
- }
-
- /// @dev See the documentation for the user-facing functions that call this internal function.
- function _createWithRange(LockupLinear.CreateWithRange memory params) internal returns (uint256 streamId) {
- // Safe Interactions: query the protocol fee. This is safe because it's a known Sablier contract that does
- // not call other unknown contracts.
- UD60x18 protocolFee = comptroller.protocolFees(params.asset);
-
- // Checks: check the fees and calculate the fee amounts.
+ function _create(LockupLinear.CreateWithTimestamps memory params) internal returns (uint256 streamId) {
+ // Check: verify the broker fee and calculate the amounts.
Lockup.CreateAmounts memory createAmounts =
- Helpers.checkAndCalculateFees(params.totalAmount, protocolFee, params.broker.fee, MAX_FEE);
+ Helpers.checkAndCalculateBrokerFee(params.totalAmount, params.broker.fee, MAX_BROKER_FEE);
- // Checks: validate the user-provided parameters.
- Helpers.checkCreateWithRange(createAmounts.deposit, params.range);
+ // Check: validate the user-provided parameters.
+ Helpers.checkCreateLockupLinear(createAmounts.deposit, params.timestamps);
- // Load the stream id.
+ // Load the stream ID.
streamId = nextStreamId;
- // Effects: create the stream.
- _streams[streamId] = LockupLinear.Stream({
+ // Effect: create the stream.
+ _streams[streamId] = Lockup.Stream({
amounts: Lockup.Amounts({ deposited: createAmounts.deposit, refunded: 0, withdrawn: 0 }),
asset: params.asset,
- cliffTime: params.range.cliff,
- endTime: params.range.end,
+ endTime: params.timestamps.end,
isCancelable: params.cancelable,
- isTransferable: params.transferable,
isDepleted: false,
isStream: true,
+ isTransferable: params.transferable,
sender: params.sender,
- startTime: params.range.start,
+ startTime: params.timestamps.start,
wasCanceled: false
});
- // Effects: bump the next stream id and record the protocol fee.
+ // Effect: set the cliff time if it is greater than zero.
+ if (params.timestamps.cliff > 0) {
+ _cliffs[streamId] = params.timestamps.cliff;
+ }
+
+ // Effect: bump the next stream ID.
// Using unchecked arithmetic because these calculations cannot realistically overflow, ever.
unchecked {
nextStreamId = streamId + 1;
- protocolRevenues[params.asset] = protocolRevenues[params.asset] + createAmounts.protocolFee;
}
- // Effects: mint the NFT to the recipient.
+ // Effect: mint the NFT to the recipient.
_mint({ to: params.recipient, tokenId: streamId });
- // Interactions: transfer the deposit and the protocol fee.
- // Using unchecked arithmetic because the deposit and the protocol fee are bounded by the total amount.
- unchecked {
- params.asset.safeTransferFrom({
- from: msg.sender,
- to: address(this),
- value: createAmounts.deposit + createAmounts.protocolFee
- });
- }
+ // Interaction: transfer the deposit amount.
+ params.asset.safeTransferFrom({ from: msg.sender, to: address(this), value: createAmounts.deposit });
- // Interactions: pay the broker fee, if not zero.
+ // Interaction: pay the broker fee, if not zero.
if (createAmounts.brokerFee > 0) {
params.asset.safeTransferFrom({ from: msg.sender, to: params.broker.account, value: createAmounts.brokerFee });
}
@@ -511,47 +292,8 @@ contract SablierV2LockupLinear is
asset: params.asset,
cancelable: params.cancelable,
transferable: params.transferable,
- range: params.range,
+ timestamps: params.timestamps,
broker: params.broker.account
});
}
-
- /// @dev See the documentation for the user-facing functions that call this internal function.
- function _renounce(uint256 streamId) internal override {
- // Checks: the stream is cancelable.
- if (!_streams[streamId].isCancelable) {
- revert Errors.SablierV2Lockup_StreamNotCancelable(streamId);
- }
-
- // Effects: renounce the stream by making it not cancelable.
- _streams[streamId].isCancelable = false;
- }
-
- /// @dev See the documentation for the user-facing functions that call this internal function.
- function _withdraw(uint256 streamId, address to, uint128 amount) internal override {
- // Effects: update the withdrawn amount.
- _streams[streamId].amounts.withdrawn = _streams[streamId].amounts.withdrawn + amount;
-
- // Retrieve the amounts from storage.
- Lockup.Amounts memory amounts = _streams[streamId].amounts;
-
- // Using ">=" instead of "==" for additional safety reasons. In the event of an unforeseen increase in the
- // withdrawn amount, the stream will still be marked as depleted.
- if (amounts.withdrawn >= amounts.deposited - amounts.refunded) {
- // Effects: mark the stream as depleted.
- _streams[streamId].isDepleted = true;
-
- // Effects: make the stream not cancelable anymore, because a depleted stream cannot be canceled.
- _streams[streamId].isCancelable = false;
- }
-
- // Retrieve the ERC-20 asset from storage.
- IERC20 asset = _streams[streamId].asset;
-
- // Interactions: perform the ERC-20 transfer.
- asset.safeTransfer({ to: to, value: amount });
-
- // Log the withdrawal.
- emit ISablierV2Lockup.WithdrawFromLockupStream(streamId, to, asset, amount);
- }
}
diff --git a/src/SablierV2LockupTranched.sol b/src/SablierV2LockupTranched.sol
new file mode 100644
index 000000000..aaf0105a1
--- /dev/null
+++ b/src/SablierV2LockupTranched.sol
@@ -0,0 +1,283 @@
+// SPDX-License-Identifier: BUSL-1.1
+pragma solidity >=0.8.22;
+
+import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+import { ERC721 } from "@openzeppelin/contracts/token/ERC721/ERC721.sol";
+
+import { SablierV2Lockup } from "./abstracts/SablierV2Lockup.sol";
+import { ISablierV2LockupTranched } from "./interfaces/ISablierV2LockupTranched.sol";
+import { ISablierV2NFTDescriptor } from "./interfaces/ISablierV2NFTDescriptor.sol";
+import { Helpers } from "./libraries/Helpers.sol";
+import { Lockup, LockupTranched } from "./types/DataTypes.sol";
+
+/*
+
+███████╗ █████╗ ██████╗ ██╗ ██╗███████╗██████╗ ██╗ ██╗██████╗
+██╔════╝██╔══██╗██╔══██╗██║ ██║██╔════╝██╔══██╗ ██║ ██║╚════██╗
+███████╗███████║██████╔╝██║ ██║█████╗ ██████╔╝ ██║ ██║ █████╔╝
+╚════██║██╔══██║██╔══██╗██║ ██║██╔══╝ ██╔══██╗ ╚██╗ ██╔╝██╔═══╝
+███████║██║ ██║██████╔╝███████╗██║███████╗██║ ██║ ╚████╔╝ ███████╗
+╚══════╝╚═╝ ╚═╝╚═════╝ ╚══════╝╚═╝╚══════╝╚═╝ ╚═╝ ╚═══╝ ╚══════╝
+
+██╗ ██████╗ ██████╗██╗ ██╗██╗ ██╗██████╗ ████████╗██████╗ █████╗ ███╗ ██╗ ██████╗██╗ ██╗███████╗██████╗
+██║ ██╔═══██╗██╔════╝██║ ██╔╝██║ ██║██╔══██╗ ╚══██╔══╝██╔══██╗██╔══██╗████╗ ██║██╔════╝██║ ██║██╔════╝██╔══██╗
+██║ ██║ ██║██║ █████╔╝ ██║ ██║██████╔╝ ██║ ██████╔╝███████║██╔██╗ ██║██║ ███████║█████╗ ██║ ██║
+██║ ██║ ██║██║ ██╔═██╗ ██║ ██║██╔═══╝ ██║ ██╔══██╗██╔══██║██║╚██╗██║██║ ██╔══██║██╔══╝ ██║ ██║
+███████╗╚██████╔╝╚██████╗██║ ██╗╚██████╔╝██║ ██║ ██║ ██║██║ ██║██║ ╚████║╚██████╗██║ ██║███████╗██████╔╝
+╚══════╝ ╚═════╝ ╚═════╝╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝ ╚═╝ ╚═╝╚═╝ ╚═╝╚═╝ ╚═══╝ ╚═════╝╚═╝ ╚═╝╚══════╝╚═════╝
+
+*/
+
+/// @title SablierV2LockupTranched
+/// @notice See the documentation in {ISablierV2LockupTranched}.
+contract SablierV2LockupTranched is
+ ISablierV2LockupTranched, // 5 inherited components
+ SablierV2Lockup // 14 inherited components
+{
+ using SafeERC20 for IERC20;
+
+ /*//////////////////////////////////////////////////////////////////////////
+ STATE VARIABLES
+ //////////////////////////////////////////////////////////////////////////*/
+
+ /// @inheritdoc ISablierV2LockupTranched
+ uint256 public immutable override MAX_TRANCHE_COUNT;
+
+ /// @dev Stream tranches mapped by stream IDs. This complements the `_streams` mapping in {SablierV2Lockup}.
+ mapping(uint256 id => LockupTranched.Tranche[] tranches) internal _tranches;
+
+ /*//////////////////////////////////////////////////////////////////////////
+ CONSTRUCTOR
+ //////////////////////////////////////////////////////////////////////////*/
+
+ /// @dev Emits a {TransferAdmin} event.
+ /// @param initialAdmin The address of the initial contract admin.
+ /// @param initialNFTDescriptor The address of the NFT descriptor contract.
+ /// @param maxTrancheCount The maximum number of tranches allowed in a stream.
+ constructor(
+ address initialAdmin,
+ ISablierV2NFTDescriptor initialNFTDescriptor,
+ uint256 maxTrancheCount
+ )
+ ERC721("Sablier V2 Lockup Tranched NFT", "SAB-V2-LOCKUP-TRA")
+ SablierV2Lockup(initialAdmin, initialNFTDescriptor)
+ {
+ MAX_TRANCHE_COUNT = maxTrancheCount;
+ nextStreamId = 1;
+ }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ USER-FACING CONSTANT FUNCTIONS
+ //////////////////////////////////////////////////////////////////////////*/
+
+ /// @inheritdoc ISablierV2LockupTranched
+ function getStream(uint256 streamId)
+ external
+ view
+ override
+ notNull(streamId)
+ returns (LockupTranched.StreamLT memory stream)
+ {
+ // Retrieve the Lockup stream from storage.
+ Lockup.Stream memory lockupStream = _streams[streamId];
+
+ // Settled streams cannot be canceled.
+ if (_statusOf(streamId) == Lockup.Status.SETTLED) {
+ lockupStream.isCancelable = false;
+ }
+
+ stream = LockupTranched.StreamLT({
+ amounts: lockupStream.amounts,
+ asset: lockupStream.asset,
+ endTime: lockupStream.endTime,
+ isCancelable: lockupStream.isCancelable,
+ isDepleted: lockupStream.isDepleted,
+ isStream: lockupStream.isStream,
+ isTransferable: lockupStream.isTransferable,
+ recipient: _ownerOf(streamId),
+ sender: lockupStream.sender,
+ startTime: lockupStream.startTime,
+ tranches: _tranches[streamId],
+ wasCanceled: lockupStream.wasCanceled
+ });
+ }
+
+ /// @inheritdoc ISablierV2LockupTranched
+ function getTimestamps(uint256 streamId)
+ external
+ view
+ override
+ notNull(streamId)
+ returns (LockupTranched.Timestamps memory timestamps)
+ {
+ timestamps = LockupTranched.Timestamps({ start: _streams[streamId].startTime, end: _streams[streamId].endTime });
+ }
+
+ /// @inheritdoc ISablierV2LockupTranched
+ function getTranches(uint256 streamId)
+ external
+ view
+ override
+ notNull(streamId)
+ returns (LockupTranched.Tranche[] memory tranches)
+ {
+ tranches = _tranches[streamId];
+ }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ USER-FACING NON-CONSTANT FUNCTIONS
+ //////////////////////////////////////////////////////////////////////////*/
+
+ /// @inheritdoc ISablierV2LockupTranched
+ function createWithDurations(LockupTranched.CreateWithDurations calldata params)
+ external
+ override
+ noDelegateCall
+ returns (uint256 streamId)
+ {
+ // Generate the canonical tranches.
+ LockupTranched.Tranche[] memory tranches = Helpers.calculateTrancheTimestamps(params.tranches);
+
+ // Checks, Effects and Interactions: create the stream.
+ streamId = _create(
+ LockupTranched.CreateWithTimestamps({
+ sender: params.sender,
+ recipient: params.recipient,
+ totalAmount: params.totalAmount,
+ asset: params.asset,
+ cancelable: params.cancelable,
+ transferable: params.transferable,
+ startTime: uint40(block.timestamp),
+ tranches: tranches,
+ broker: params.broker
+ })
+ );
+ }
+
+ /// @inheritdoc ISablierV2LockupTranched
+ function createWithTimestamps(LockupTranched.CreateWithTimestamps calldata params)
+ external
+ override
+ noDelegateCall
+ returns (uint256 streamId)
+ {
+ // Checks, Effects and Interactions: create the stream.
+ streamId = _create(params);
+ }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ INTERNAL CONSTANT FUNCTIONS
+ //////////////////////////////////////////////////////////////////////////*/
+
+ /// @inheritdoc SablierV2Lockup
+ /// @dev The distribution function is:
+ ///
+ /// $$
+ /// f(x) = \Sigma(eta)
+ /// $$
+ ///
+ /// Where:
+ ///
+ /// - $\Sigma(eta)$ is the sum of all vested tranches' amounts.
+ function _calculateStreamedAmount(uint256 streamId) internal view override returns (uint128) {
+ uint40 blockTimestamp = uint40(block.timestamp);
+ LockupTranched.Tranche[] memory tranches = _tranches[streamId];
+
+ // If the first tranche's timestamp is in the future, return zero.
+ if (tranches[0].timestamp > blockTimestamp) {
+ return 0;
+ }
+
+ // If the end time is not in the future, return the deposited amount.
+ if (_streams[streamId].endTime <= blockTimestamp) {
+ return _streams[streamId].amounts.deposited;
+ }
+
+ // Sum the amounts in all tranches that have already been vested.
+ // Using unchecked arithmetic is safe because the sum of the tranche amounts is equal to the total amount
+ // at this point.
+ uint128 streamedAmount = tranches[0].amount;
+ for (uint256 i = 1; i < tranches.length; ++i) {
+ // The loop breaks at the first tranche with a timestamp in the future. A tranche is considered vested if
+ // its timestamp is less than or equal to the block timestamp.
+ if (tranches[i].timestamp > blockTimestamp) {
+ break;
+ }
+ unchecked {
+ streamedAmount += tranches[i].amount;
+ }
+ }
+
+ return streamedAmount;
+ }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ INTERNAL NON-CONSTANT FUNCTIONS
+ //////////////////////////////////////////////////////////////////////////*/
+
+ /// @dev See the documentation for the user-facing functions that call this internal function.
+ function _create(LockupTranched.CreateWithTimestamps memory params) internal returns (uint256 streamId) {
+ // Check: verify the broker fee and calculate the amounts.
+ Lockup.CreateAmounts memory createAmounts =
+ Helpers.checkAndCalculateBrokerFee(params.totalAmount, params.broker.fee, MAX_BROKER_FEE);
+
+ // Check: validate the user-provided parameters.
+ Helpers.checkCreateLockupTranched(createAmounts.deposit, params.tranches, MAX_TRANCHE_COUNT, params.startTime);
+
+ // Load the stream ID in a variable.
+ streamId = nextStreamId;
+
+ // Effect: create the stream.
+ Lockup.Stream storage stream = _streams[streamId];
+ stream.amounts.deposited = createAmounts.deposit;
+ stream.asset = params.asset;
+ stream.isCancelable = params.cancelable;
+ stream.isStream = true;
+ stream.isTransferable = params.transferable;
+ stream.sender = params.sender;
+ stream.startTime = params.startTime;
+
+ unchecked {
+ // The tranche count cannot be zero at this point.
+ uint256 trancheCount = params.tranches.length;
+ stream.endTime = params.tranches[trancheCount - 1].timestamp;
+
+ // Effect: store the tranches. Since Solidity lacks a syntax for copying arrays of structs directly from
+ // memory to storage, a manual approach is necessary. See https://github.com/ethereum/solidity/issues/12783.
+ for (uint256 i = 0; i < trancheCount; ++i) {
+ _tranches[streamId].push(params.tranches[i]);
+ }
+
+ // Effect: bump the next stream ID.
+ // Using unchecked arithmetic because these calculations cannot realistically overflow, ever.
+ nextStreamId = streamId + 1;
+ }
+
+ // Effect: mint the NFT to the recipient.
+ _mint({ to: params.recipient, tokenId: streamId });
+
+ // Interaction: transfer the deposit amount.
+ params.asset.safeTransferFrom({ from: msg.sender, to: address(this), value: createAmounts.deposit });
+
+ // Interaction: pay the broker fee, if not zero.
+ if (createAmounts.brokerFee > 0) {
+ params.asset.safeTransferFrom({ from: msg.sender, to: params.broker.account, value: createAmounts.brokerFee });
+ }
+
+ // Log the newly created stream.
+ emit ISablierV2LockupTranched.CreateLockupTranchedStream({
+ streamId: streamId,
+ funder: msg.sender,
+ sender: params.sender,
+ recipient: params.recipient,
+ amounts: createAmounts,
+ asset: params.asset,
+ cancelable: params.cancelable,
+ transferable: params.transferable,
+ tranches: params.tranches,
+ timestamps: LockupTranched.Timestamps({ start: stream.startTime, end: stream.endTime }),
+ broker: params.broker.account
+ });
+ }
+}
diff --git a/src/SablierV2NFTDescriptor.sol b/src/SablierV2NFTDescriptor.sol
index 741bb51ce..171dc4878 100644
--- a/src/SablierV2NFTDescriptor.sol
+++ b/src/SablierV2NFTDescriptor.sol
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: GPL-3.0-or-later
// solhint-disable max-line-length,quotes
-pragma solidity >=0.8.19;
+pragma solidity >=0.8.22;
import { IERC20Metadata } from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
import { IERC721Metadata } from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol";
@@ -15,6 +15,24 @@ import { Errors } from "./libraries/Errors.sol";
import { NFTSVG } from "./libraries/NFTSVG.sol";
import { SVGElements } from "./libraries/SVGElements.sol";
+/*
+
+███████╗ █████╗ ██████╗ ██╗ ██╗███████╗██████╗ ██╗ ██╗██████╗
+██╔════╝██╔══██╗██╔══██╗██║ ██║██╔════╝██╔══██╗ ██║ ██║╚════██╗
+███████╗███████║██████╔╝██║ ██║█████╗ ██████╔╝ ██║ ██║ █████╔╝
+╚════██║██╔══██║██╔══██╗██║ ██║██╔══╝ ██╔══██╗ ╚██╗ ██╔╝██╔═══╝
+███████║██║ ██║██████╔╝███████╗██║███████╗██║ ██║ ╚████╔╝ ███████╗
+╚══════╝╚═╝ ╚═╝╚═════╝ ╚══════╝╚═╝╚══════╝╚═╝ ╚═╝ ╚═══╝ ╚══════╝
+
+███╗ ██╗███████╗████████╗ ██████╗ ███████╗███████╗ ██████╗██████╗ ██╗██████╗ ████████╗ ██████╗ ██████╗
+████╗ ██║██╔════╝╚══██╔══╝ ██╔══██╗██╔════╝██╔════╝██╔════╝██╔══██╗██║██╔══██╗╚══██╔══╝██╔═══██╗██╔══██╗
+██╔██╗ ██║█████╗ ██║ ██║ ██║█████╗ ███████╗██║ ██████╔╝██║██████╔╝ ██║ ██║ ██║██████╔╝
+██║╚██╗██║██╔══╝ ██║ ██║ ██║██╔══╝ ╚════██║██║ ██╔══██╗██║██╔═══╝ ██║ ██║ ██║██╔══██╗
+██║ ╚████║██║ ██║ ██████╔╝███████╗███████║╚██████╗██║ ██║██║██║ ██║ ╚██████╔╝██║ ██║
+╚═╝ ╚═══╝╚═╝ ╚═╝ ╚═════╝ ╚══════╝╚══════╝ ╚═════╝╚═╝ ╚═╝╚═╝╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝
+
+*/
+
/// @title SablierV2NFTDescriptor
/// @notice See the documentation in {ISablierV2NFTDescriptor}.
contract SablierV2NFTDescriptor is ISablierV2NFTDescriptor {
@@ -31,13 +49,16 @@ contract SablierV2NFTDescriptor is ISablierV2NFTDescriptor {
address asset;
string assetSymbol;
uint128 depositedAmount;
+ bool isTransferable;
string json;
+ bytes returnData;
ISablierV2Lockup sablier;
- string sablierAddress;
+ string sablierModel;
+ string sablierStringified;
string status;
string svg;
uint256 streamedPercentage;
- string streamingModel;
+ bool success;
}
/// @inheritdoc ISablierV2NFTDescriptor
@@ -46,7 +67,8 @@ contract SablierV2NFTDescriptor is ISablierV2NFTDescriptor {
// Load the contracts.
vars.sablier = ISablierV2Lockup(address(sablier));
- vars.sablierAddress = address(sablier).toHexString();
+ vars.sablierModel = mapSymbol(sablier);
+ vars.sablierStringified = address(sablier).toHexString();
vars.asset = address(vars.sablier.getAsset(streamId));
vars.assetSymbol = safeAssetSymbol(vars.asset);
vars.depositedAmount = vars.sablier.getDepositedAmount(streamId);
@@ -57,7 +79,6 @@ contract SablierV2NFTDescriptor is ISablierV2NFTDescriptor {
streamedAmount: vars.sablier.streamedAmountOf(streamId),
depositedAmount: vars.depositedAmount
});
- vars.streamingModel = mapSymbol(sablier);
// Generate the SVG.
vars.svg = NFTSVG.generateSVG(
@@ -70,14 +91,21 @@ contract SablierV2NFTDescriptor is ISablierV2NFTDescriptor {
startTime: vars.sablier.getStartTime(streamId),
endTime: vars.sablier.getEndTime(streamId)
}),
- sablierAddress: vars.sablierAddress,
+ sablierAddress: vars.sablierStringified,
progress: stringifyPercentage(vars.streamedPercentage),
progressNumerical: vars.streamedPercentage,
status: vars.status,
- streamingModel: vars.streamingModel
+ sablierModel: vars.sablierModel
})
);
+ // Performs a low-level call to handle older deployments that miss the `isTransferable` function.
+ (vars.success, vars.returnData) =
+ address(vars.sablier).staticcall(abi.encodeCall(ISablierV2Lockup.isTransferable, (streamId)));
+
+ // When the call has failed, the stream NFT is assumed to be transferable.
+ vars.isTransferable = vars.success ? abi.decode(vars.returnData, (bool)) : true;
+
// Generate the JSON metadata.
vars.json = string.concat(
'{"attributes":',
@@ -88,14 +116,15 @@ contract SablierV2NFTDescriptor is ISablierV2NFTDescriptor {
}),
',"description":"',
generateDescription({
- streamingModel: vars.streamingModel,
+ sablierModel: vars.sablierModel,
assetSymbol: vars.assetSymbol,
+ sablierStringified: vars.sablierStringified,
+ assetAddress: vars.asset.toHexString(),
streamId: streamId.toString(),
- sablierAddress: vars.sablierAddress,
- assetAddress: vars.asset.toHexString()
+ isTransferable: vars.isTransferable
}),
'","external_url":"https://sablier.com","name":"',
- generateName({ streamingModel: vars.streamingModel, streamId: streamId.toString() }),
+ generateName({ sablierModel: vars.sablierModel, streamId: streamId.toString() }),
'","image":"data:image/svg+xml;base64,',
Base64.encode(bytes(vars.svg)),
'"}'
@@ -193,7 +222,7 @@ contract SablierV2NFTDescriptor is ISablierV2NFTDescriptor {
/// @notice Generates a pseudo-random HSL color by hashing together the `chainid`, the `sablier` address,
/// and the `streamId`. This will be used as the accent color for the SVG.
function generateAccentColor(address sablier, uint256 streamId) internal view returns (string memory) {
- // The chain id is part of the hash so that the generated color is different across chains.
+ // The chain ID is part of the hash so that the generated color is different across chains.
uint256 chainId = block.chainid;
// Hash the parameters to generate a pseudo-random bit field, which will be used as entropy.
@@ -248,43 +277,73 @@ contract SablierV2NFTDescriptor is ISablierV2NFTDescriptor {
/// @notice Generates a string with the NFT's JSON metadata description, which provides a high-level overview.
function generateDescription(
- string memory streamingModel,
+ string memory sablierModel,
string memory assetSymbol,
+ string memory sablierStringified,
+ string memory assetAddress,
string memory streamId,
- string memory sablierAddress,
- string memory assetAddress
+ bool isTransferable
)
internal
pure
returns (string memory)
{
+ // Depending on the transferability of the NFT, declare the relevant information.
+ string memory info = isTransferable
+ ?
+ unicode"⚠️ WARNING: Transferring the NFT makes the new owner the recipient of the stream. The funds are not automatically withdrawn for the previous recipient."
+ : unicode"❕INFO: This NFT is non-transferable. It cannot be sold or transferred to another account.";
+
return string.concat(
"This NFT represents a payment stream in a Sablier V2 ",
- streamingModel,
+ sablierModel,
" contract. The owner of this NFT can withdraw the streamed assets, which are denominated in ",
assetSymbol,
".\\n\\n- Stream ID: ",
streamId,
"\\n- ",
- streamingModel,
+ sablierModel,
" Address: ",
- sablierAddress,
+ sablierStringified,
"\\n- ",
assetSymbol,
" Address: ",
assetAddress,
"\\n\\n",
- unicode"⚠️ WARNING: Transferring the NFT makes the new owner the recipient of the stream. The funds are not automatically withdrawn for the previous recipient."
+ info
);
}
/// @notice Generates a string with the NFT's JSON metadata name, which is unique for each stream.
/// @dev The `streamId` is equivalent to the ERC-721 `tokenId`.
- function generateName(string memory streamingModel, string memory streamId) internal pure returns (string memory) {
- return string.concat("Sablier V2 ", streamingModel, " #", streamId);
+ function generateName(string memory sablierModel, string memory streamId) internal pure returns (string memory) {
+ return string.concat("Sablier V2 ", sablierModel, " #", streamId);
}
- /// @notice Maps ERC-721 symbols to human-readable streaming models.
+ /// @notice Checks whether the provided string contains only alphanumeric characters, spaces, and dashes.
+ /// @dev Note that this returns true for empty strings.
+ function isAllowedCharacter(string memory str) internal pure returns (bool) {
+ // Convert the string to bytes to iterate over its characters.
+ bytes memory b = bytes(str);
+
+ uint256 length = b.length;
+ for (uint256 i = 0; i < length; ++i) {
+ bytes1 char = b[i];
+
+ // Check if it's a space, dash, or an alphanumeric character.
+ bool isSpace = char == 0x20; // space
+ bool isDash = char == 0x2D; // dash
+ bool isDigit = char >= 0x30 && char <= 0x39; // 0-9
+ bool isUppercaseLetter = char >= 0x41 && char <= 0x5A; // A-Z
+ bool isLowercaseLetter = char >= 0x61 && char <= 0x7A; // a-z
+ if (!(isSpace || isDash || isDigit || isUppercaseLetter || isLowercaseLetter)) {
+ return false;
+ }
+ }
+ return true;
+ }
+
+ /// @notice Maps ERC-721 symbols to human-readable model names.
/// @dev Reverts if the symbol is unknown.
function mapSymbol(IERC721Metadata sablier) internal view returns (string memory) {
string memory symbol = sablier.symbol();
@@ -292,6 +351,8 @@ contract SablierV2NFTDescriptor is ISablierV2NFTDescriptor {
return "Lockup Linear";
} else if (symbol.equal("SAB-V2-LOCKUP-DYN")) {
return "Lockup Dynamic";
+ } else if (symbol.equal("SAB-V2-LOCKUP-TRA")) {
+ return "Lockup Tranched";
} else {
revert Errors.SablierV2NFTDescriptor_UnknownNFT(sablier, symbol);
}
@@ -321,11 +382,14 @@ contract SablierV2NFTDescriptor is ISablierV2NFTDescriptor {
string memory symbol = abi.decode(returnData, (string));
- // The length check is a precautionary measure to help mitigate potential security threats from malicious assets
- // injecting scripts in the symbol string.
+ // Check if the symbol is too long or contains disallowed characters. This measure helps mitigate potential
+ // security threats from malicious assets injecting scripts in the symbol string.
if (bytes(symbol).length > 30) {
return "Long Symbol";
} else {
+ if (!isAllowedCharacter(symbol)) {
+ return "Unsupported Symbol";
+ }
return symbol;
}
}
diff --git a/src/abstracts/Adminable.sol b/src/abstracts/Adminable.sol
index 6cbd952c0..add9799a0 100644
--- a/src/abstracts/Adminable.sol
+++ b/src/abstracts/Adminable.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19;
+pragma solidity >=0.8.22;
import { IAdminable } from "../interfaces/IAdminable.sol";
import { Errors } from "../libraries/Errors.sol";
@@ -8,7 +8,7 @@ import { Errors } from "../libraries/Errors.sol";
/// @notice See the documentation in {IAdminable}.
abstract contract Adminable is IAdminable {
/*//////////////////////////////////////////////////////////////////////////
- STORAGE
+ STATE VARIABLES
//////////////////////////////////////////////////////////////////////////*/
/// @inheritdoc IAdminable
@@ -32,7 +32,7 @@ abstract contract Adminable is IAdminable {
/// @inheritdoc IAdminable
function transferAdmin(address newAdmin) public virtual override onlyAdmin {
- // Effects: update the admin.
+ // Effect: update the admin.
admin = newAdmin;
// Log the transfer of the admin.
diff --git a/src/abstracts/NoDelegateCall.sol b/src/abstracts/NoDelegateCall.sol
index c01be8734..615297067 100644
--- a/src/abstracts/NoDelegateCall.sol
+++ b/src/abstracts/NoDelegateCall.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19;
+pragma solidity >=0.8.22;
import { Errors } from "../libraries/Errors.sol";
diff --git a/src/abstracts/SablierV2Base.sol b/src/abstracts/SablierV2Base.sol
deleted file mode 100644
index 356777840..000000000
--- a/src/abstracts/SablierV2Base.sol
+++ /dev/null
@@ -1,89 +0,0 @@
-// SPDX-License-Identifier: BUSL-1.1
-pragma solidity >=0.8.19;
-
-import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
-import { UD60x18 } from "@prb/math/src/UD60x18.sol";
-
-import { IAdminable } from "../interfaces/IAdminable.sol";
-import { ISablierV2Base } from "../interfaces/ISablierV2Base.sol";
-import { ISablierV2Comptroller } from "../interfaces/ISablierV2Comptroller.sol";
-import { Errors } from "../libraries/Errors.sol";
-import { Adminable } from "./Adminable.sol";
-import { NoDelegateCall } from "./NoDelegateCall.sol";
-
-/// @title SablierV2Base
-/// @notice See the documentation in {ISablierV2Base}.
-abstract contract SablierV2Base is
- NoDelegateCall, // 0 inherited components
- ISablierV2Base, // 1 inherited component
- Adminable // 1 inherited component
-{
- using SafeERC20 for IERC20;
-
- /*//////////////////////////////////////////////////////////////////////////
- PUBLIC CONSTANTS
- //////////////////////////////////////////////////////////////////////////*/
-
- /// @inheritdoc ISablierV2Base
- UD60x18 public constant override MAX_FEE = UD60x18.wrap(0.1e18);
-
- /*//////////////////////////////////////////////////////////////////////////
- PUBLIC STORAGE
- //////////////////////////////////////////////////////////////////////////*/
-
- /// @inheritdoc ISablierV2Base
- ISablierV2Comptroller public override comptroller;
-
- /// @inheritdoc ISablierV2Base
- mapping(IERC20 asset => uint128 revenues) public override protocolRevenues;
-
- /*//////////////////////////////////////////////////////////////////////////
- CONSTRUCTOR
- //////////////////////////////////////////////////////////////////////////*/
-
- /// @dev Emits a {TransferAdmin} event.
- /// @param initialAdmin The address of the initial contract admin.
- /// @param initialComptroller The address of the initial comptroller.
- constructor(address initialAdmin, ISablierV2Comptroller initialComptroller) {
- admin = initialAdmin;
- comptroller = initialComptroller;
- emit IAdminable.TransferAdmin({ oldAdmin: address(0), newAdmin: initialAdmin });
- }
-
- /*//////////////////////////////////////////////////////////////////////////
- USER-FACING NON-CONSTANT FUNCTIONS
- //////////////////////////////////////////////////////////////////////////*/
-
- /// @inheritdoc ISablierV2Base
- function claimProtocolRevenues(IERC20 asset) external override onlyAdmin {
- // Checks: the protocol revenues are not zero.
- uint128 revenues = protocolRevenues[asset];
- if (revenues == 0) {
- revert Errors.SablierV2Base_NoProtocolRevenues(asset);
- }
-
- // Effects: set the protocol revenues to zero.
- protocolRevenues[asset] = 0;
-
- // Interactions: perform the ERC-20 transfer to pay the protocol revenues.
- asset.safeTransfer({ to: msg.sender, value: revenues });
-
- // Log the claim of the protocol revenues.
- emit ISablierV2Base.ClaimProtocolRevenues({ admin: msg.sender, asset: asset, protocolRevenues: revenues });
- }
-
- /// @inheritdoc ISablierV2Base
- function setComptroller(ISablierV2Comptroller newComptroller) external override onlyAdmin {
- // Effects: set the new comptroller.
- ISablierV2Comptroller oldComptroller = comptroller;
- comptroller = newComptroller;
-
- // Log the change of the comptroller.
- emit ISablierV2Base.SetComptroller({
- admin: msg.sender,
- oldComptroller: oldComptroller,
- newComptroller: newComptroller
- });
- }
-}
diff --git a/src/abstracts/SablierV2FlashLoan.sol b/src/abstracts/SablierV2FlashLoan.sol
deleted file mode 100644
index 2b2002f74..000000000
--- a/src/abstracts/SablierV2FlashLoan.sol
+++ /dev/null
@@ -1,174 +0,0 @@
-// SPDX-License-Identifier: BUSL-1.1
-pragma solidity >=0.8.19;
-
-import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
-import { ud } from "@prb/math/src/UD60x18.sol";
-
-import { IERC3156FlashBorrower } from "../interfaces/erc3156/IERC3156FlashBorrower.sol";
-import { IERC3156FlashLender } from "../interfaces/erc3156/IERC3156FlashLender.sol";
-import { Errors } from "../libraries/Errors.sol";
-import { SablierV2Base } from "./SablierV2Base.sol";
-
-/// @title SablierV2FlashLoan
-/// @notice This contract implements the ERC-3156 standard to enable flash loans.
-/// @dev See https://eips.ethereum.org/EIPS/eip-3156.
-abstract contract SablierV2FlashLoan is
- IERC3156FlashLender, // 0 inherited components
- SablierV2Base // 4 inherited components
-{
- using SafeERC20 for IERC20;
-
- /*//////////////////////////////////////////////////////////////////////////
- EVENTS
- //////////////////////////////////////////////////////////////////////////*/
-
- /// @notice Emitted when a flash loan is executed.
- /// @param initiator The address of the flash loan initiator.
- /// @param receiver The address of the flash borrower.
- /// @param asset The address of the ERC-20 asset that has been flash loaned.
- /// @param amount The amount of `asset` flash loaned.
- /// @param feeAmount The fee amount of `asset` charged by the protocol.
- /// @param data The data passed to the flash borrower.
- event FlashLoan(
- address indexed initiator,
- IERC3156FlashBorrower indexed receiver,
- IERC20 indexed asset,
- uint256 amount,
- uint256 feeAmount,
- bytes data
- );
-
- /*//////////////////////////////////////////////////////////////////////////
- INTERNAL CONSTANTS
- //////////////////////////////////////////////////////////////////////////*/
-
- bytes32 internal constant CALLBACK_SUCCESS = keccak256("ERC3156FlashBorrower.onFlashLoan");
-
- /*//////////////////////////////////////////////////////////////////////////
- CONSTANT FUNCTIONS
- //////////////////////////////////////////////////////////////////////////*/
-
- /// @notice The amount of fees to charge for a hypothetical flash loan amount.
- ///
- /// @dev You might notice a bit of a terminology clash here, since the ERC-3156 standard refers to the "flash fee"
- /// as an amount, whereas the flash fee retrieved from the comptroller is a percentage. Throughout the code base,
- /// the "amount" suffix is typically appended to variables that represent amounts, but, in this context, the name
- /// must be kept unchanged to comply with the ERC.
- ///
- /// Requirements:
- /// - The ERC-20 asset must be flash loanable.
- ///
- /// @param asset The ERC-20 asset to flash loan.
- /// @param amount The amount of `asset` flash loaned.
- /// @return fee The amount of `asset` to charge for the loan on top of the returned principal.
- function flashFee(address asset, uint256 amount) public view override returns (uint256 fee) {
- // Checks: the ERC-20 asset is flash loanable.
- if (!comptroller.isFlashAsset(IERC20(asset))) {
- revert Errors.SablierV2FlashLoan_AssetNotFlashLoanable(IERC20(asset));
- }
-
- // Calculate the flash fee.
- fee = ud(amount).mul(comptroller.flashFee()).intoUint256();
- }
-
- /// @notice The amount of ERC-20 assets available for flash loan.
- /// @dev If the ERC-20 asset is not flash loanable, this function returns zero.
- /// @param asset The address of the ERC-20 asset to query.
- /// @return amount The amount of `asset` that can be flash loaned.
- function maxFlashLoan(address asset) external view override returns (uint256 amount) {
- // The default value is zero, so it doesn't have to be explicitly set.
- if (comptroller.isFlashAsset(IERC20(asset))) {
- amount = IERC20(asset).balanceOf(address(this));
- }
- }
-
- /*//////////////////////////////////////////////////////////////////////////
- NON-CONSTANT FUNCTIONS
- //////////////////////////////////////////////////////////////////////////*/
-
- /// @notice Allows smart contracts to access the entire liquidity of the Sablier V2 contract within one
- /// transaction as long as the principal plus a flash fee is returned.
- ///
- /// @dev Emits a {FlashLoan} event.
- ///
- /// Requirements:
- /// - Must not be delegate called.
- /// - Refer to the requirements in {flashFee}.
- /// - `amount` must be less than 2^128.
- /// - `fee` must be less than 2^128.
- /// - `amount` must not exceed the liquidity available for `asset`.
- /// - `msg.sender` must allow this contract to spend at least `amount + fee` assets.
- /// - `receiver` implementation of {IERC3156FlashBorrower.onFlashLoan} must return `CALLBACK_SUCCESS`.
- ///
- /// @param receiver The receiver of the flash loaned assets, and the receiver of the callback.
- /// @param asset The address of the ERC-20 asset to use for flash borrowing.
- /// @param amount The amount of `asset` to flash loan.
- /// @param data Arbitrary data structure, intended to contain user-defined parameters.
- /// @return success `true` on success.
- function flashLoan(
- IERC3156FlashBorrower receiver,
- address asset,
- uint256 amount,
- bytes calldata data
- )
- external
- override
- noDelegateCall
- returns (bool success)
- {
- // Checks: the amount is less than 2^128. This prevents the below calculations from overflowing.
- if (amount > type(uint128).max) {
- revert Errors.SablierV2FlashLoan_AmountTooHigh(amount);
- }
-
- // Calculate the flash fee. This also checks that the ERC-20 asset is flash loanable.
- uint256 fee = flashFee(asset, amount);
-
- // Checks: the calculated fee is less than 2^128. This check can fail only when the comptroller flash fee
- // is set to an abnormally high value.
- if (fee > type(uint128).max) {
- revert Errors.SablierV2FlashLoan_CalculatedFeeTooHigh(fee);
- }
-
- // Interactions: perform the ERC-20 transfer to flash loan the assets to the borrower.
- IERC20(asset).safeTransfer({ to: address(receiver), value: amount });
-
- // Interactions: perform the borrower callback.
- bytes32 response =
- receiver.onFlashLoan({ initiator: msg.sender, asset: asset, amount: amount, fee: fee, data: data });
-
- // Checks: the response matches the expected callback success hash.
- if (response != CALLBACK_SUCCESS) {
- revert Errors.SablierV2FlashLoan_FlashBorrowFail();
- }
-
- uint256 returnAmount;
-
- // Using unchecked arithmetic because the checks above prevent these calculations from overflowing.
- unchecked {
- // Effects: record the flash fee amount in the protocol revenues. The casting to uint128 is safe due
- // to the check at the start of the function.
- protocolRevenues[IERC20(asset)] = protocolRevenues[IERC20(asset)] + uint128(fee);
-
- // Calculate the amount that the borrower must return.
- returnAmount = amount + fee;
- }
-
- // Interactions: perform the ERC-20 transfer to get the principal back plus the fee.
- IERC20(asset).safeTransferFrom({ from: address(receiver), to: address(this), value: returnAmount });
-
- // Log the flash loan.
- emit FlashLoan({
- initiator: msg.sender,
- receiver: receiver,
- asset: IERC20(asset),
- amount: amount,
- feeAmount: fee,
- data: data
- });
-
- // Set the success flag.
- success = true;
- }
-}
diff --git a/src/abstracts/SablierV2Lockup.sol b/src/abstracts/SablierV2Lockup.sol
index a3a323f3e..95166bd86 100644
--- a/src/abstracts/SablierV2Lockup.sol
+++ b/src/abstracts/SablierV2Lockup.sol
@@ -1,55 +1,61 @@
// SPDX-License-Identifier: BUSL-1.1
-pragma solidity >=0.8.19;
+pragma solidity >=0.8.22;
-import { IERC4906 } from "@openzeppelin/contracts/interfaces/IERC4906.sol";
+import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import { ERC721 } from "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import { IERC721Metadata } from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol";
+import { IERC165 } from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import { UD60x18 } from "@prb/math/src/UD60x18.sol";
-import { ISablierV2Comptroller } from "../interfaces/ISablierV2Comptroller.sol";
+import { ISablierLockupRecipient } from "../interfaces/ISablierLockupRecipient.sol";
import { ISablierV2Lockup } from "../interfaces/ISablierV2Lockup.sol";
import { ISablierV2NFTDescriptor } from "../interfaces/ISablierV2NFTDescriptor.sol";
-import { ISablierV2LockupRecipient } from "../interfaces/hooks/ISablierV2LockupRecipient.sol";
import { Errors } from "../libraries/Errors.sol";
import { Lockup } from "../types/DataTypes.sol";
-import { SablierV2Base } from "./SablierV2Base.sol";
+import { Adminable } from "./Adminable.sol";
+import { NoDelegateCall } from "./NoDelegateCall.sol";
/// @title SablierV2Lockup
/// @notice See the documentation in {ISablierV2Lockup}.
abstract contract SablierV2Lockup is
- IERC4906, // 2 inherited components
- SablierV2Base, // 4 inherited components
- ISablierV2Lockup, // 4 inherited components
+ NoDelegateCall, // 0 inherited components
+ Adminable, // 1 inherited components
+ ISablierV2Lockup, // 7 inherited components
ERC721 // 6 inherited components
{
+ using SafeERC20 for IERC20;
+
/*//////////////////////////////////////////////////////////////////////////
- USER-FACING STORAGE
+ STATE VARIABLES
//////////////////////////////////////////////////////////////////////////*/
+ /// @inheritdoc ISablierV2Lockup
+ UD60x18 public constant override MAX_BROKER_FEE = UD60x18.wrap(0.1e18);
+
/// @inheritdoc ISablierV2Lockup
uint256 public override nextStreamId;
- /*//////////////////////////////////////////////////////////////////////////
- INTERNAL STORAGE
- //////////////////////////////////////////////////////////////////////////*/
+ /// @inheritdoc ISablierV2Lockup
+ ISablierV2NFTDescriptor public override nftDescriptor;
+
+ /// @dev Mapping of contracts allowed to hook to Sablier when a stream is canceled or when assets are withdrawn.
+ mapping(address recipient => bool allowed) internal _allowedToHook;
- /// @dev Contract that generates the non-fungible token URI.
- ISablierV2NFTDescriptor internal _nftDescriptor;
+ /// @dev Sablier V2 Lockup streams mapped by unsigned integers.
+ mapping(uint256 id => Lockup.Stream stream) internal _streams;
/*//////////////////////////////////////////////////////////////////////////
CONSTRUCTOR
//////////////////////////////////////////////////////////////////////////*/
+ /// @dev Emits a {TransferAdmin} event.
/// @param initialAdmin The address of the initial contract admin.
- /// @param initialComptroller The address of the initial comptroller.
/// @param initialNFTDescriptor The address of the initial NFT descriptor.
- constructor(
- address initialAdmin,
- ISablierV2Comptroller initialComptroller,
- ISablierV2NFTDescriptor initialNFTDescriptor
- )
- SablierV2Base(initialAdmin, initialComptroller)
- {
- _nftDescriptor = initialNFTDescriptor;
+ constructor(address initialAdmin, ISablierV2NFTDescriptor initialNFTDescriptor) {
+ admin = initialAdmin;
+ nftDescriptor = initialNFTDescriptor;
+ emit TransferAdmin({ oldAdmin: address(0), newAdmin: initialAdmin });
}
/*//////////////////////////////////////////////////////////////////////////
@@ -58,29 +64,85 @@ abstract contract SablierV2Lockup is
/// @dev Checks that `streamId` does not reference a null stream.
modifier notNull(uint256 streamId) {
- if (!isStream(streamId)) {
+ if (!_streams[streamId].isStream) {
revert Errors.SablierV2Lockup_Null(streamId);
}
_;
}
- /// @dev Emits an ERC-4906 event to trigger an update of the NFT metadata.
- modifier updateMetadata(uint256 streamId) {
- _;
- emit MetadataUpdate({ _tokenId: streamId });
- }
-
/*//////////////////////////////////////////////////////////////////////////
USER-FACING CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
+ /// @inheritdoc ISablierV2Lockup
+ function getAsset(uint256 streamId) external view override notNull(streamId) returns (IERC20 asset) {
+ asset = _streams[streamId].asset;
+ }
+
+ /// @inheritdoc ISablierV2Lockup
+ function getDepositedAmount(uint256 streamId)
+ external
+ view
+ override
+ notNull(streamId)
+ returns (uint128 depositedAmount)
+ {
+ depositedAmount = _streams[streamId].amounts.deposited;
+ }
+
+ /// @inheritdoc ISablierV2Lockup
+ function getEndTime(uint256 streamId) external view override notNull(streamId) returns (uint40 endTime) {
+ endTime = _streams[streamId].endTime;
+ }
+
/// @inheritdoc ISablierV2Lockup
function getRecipient(uint256 streamId) external view override returns (address recipient) {
- // Checks: the stream NFT exists.
- _requireMinted({ tokenId: streamId });
+ // Check the stream NFT exists and return the owner, which is the stream's recipient.
+ recipient = _requireOwned({ tokenId: streamId });
+ }
+
+ /// @inheritdoc ISablierV2Lockup
+ function getRefundedAmount(uint256 streamId)
+ external
+ view
+ override
+ notNull(streamId)
+ returns (uint128 refundedAmount)
+ {
+ refundedAmount = _streams[streamId].amounts.refunded;
+ }
+
+ /// @inheritdoc ISablierV2Lockup
+ function getSender(uint256 streamId) external view override notNull(streamId) returns (address sender) {
+ sender = _streams[streamId].sender;
+ }
+
+ /// @inheritdoc ISablierV2Lockup
+ function getStartTime(uint256 streamId) external view override notNull(streamId) returns (uint40 startTime) {
+ startTime = _streams[streamId].startTime;
+ }
+
+ /// @inheritdoc ISablierV2Lockup
+ function getWithdrawnAmount(uint256 streamId)
+ external
+ view
+ override
+ notNull(streamId)
+ returns (uint128 withdrawnAmount)
+ {
+ withdrawnAmount = _streams[streamId].amounts.withdrawn;
+ }
- // The NFT owner is the stream's recipient.
- recipient = _ownerOf(streamId);
+ /// @inheritdoc ISablierV2Lockup
+ function isAllowedToHook(address recipient) external view returns (bool result) {
+ result = _allowedToHook[recipient];
+ }
+
+ /// @inheritdoc ISablierV2Lockup
+ function isCancelable(uint256 streamId) external view override notNull(streamId) returns (bool result) {
+ if (_statusOf(streamId) != Lockup.Status.SETTLED) {
+ result = _streams[streamId].isCancelable;
+ }
}
/// @inheritdoc ISablierV2Lockup
@@ -90,10 +152,19 @@ abstract contract SablierV2Lockup is
}
/// @inheritdoc ISablierV2Lockup
- function isDepleted(uint256 streamId) public view virtual override returns (bool result);
+ function isDepleted(uint256 streamId) external view override notNull(streamId) returns (bool result) {
+ result = _streams[streamId].isDepleted;
+ }
/// @inheritdoc ISablierV2Lockup
- function isStream(uint256 streamId) public view virtual override returns (bool result);
+ function isStream(uint256 streamId) external view override returns (bool result) {
+ result = _streams[streamId].isStream;
+ }
+
+ /// @inheritdoc ISablierV2Lockup
+ function isTransferable(uint256 streamId) external view override notNull(streamId) returns (bool result) {
+ result = _streams[streamId].isTransferable;
+ }
/// @inheritdoc ISablierV2Lockup
function isWarm(uint256 streamId) external view override notNull(streamId) returns (bool result) {
@@ -101,17 +172,58 @@ abstract contract SablierV2Lockup is
result = status == Lockup.Status.PENDING || status == Lockup.Status.STREAMING;
}
+ /// @inheritdoc ISablierV2Lockup
+ function refundableAmountOf(uint256 streamId)
+ external
+ view
+ override
+ notNull(streamId)
+ returns (uint128 refundableAmount)
+ {
+ // These checks are needed because {_calculateStreamedAmount} does not look up the stream's status. Note that
+ // checking for `isCancelable` also checks if the stream `wasCanceled` thanks to the protocol invariant that
+ // canceled streams are not cancelable anymore.
+ if (_streams[streamId].isCancelable && !_streams[streamId].isDepleted) {
+ refundableAmount = _streams[streamId].amounts.deposited - _calculateStreamedAmount(streamId);
+ }
+ // Otherwise, the result is implicitly zero.
+ }
+
+ /// @inheritdoc ISablierV2Lockup
+ function statusOf(uint256 streamId) external view override notNull(streamId) returns (Lockup.Status status) {
+ status = _statusOf(streamId);
+ }
+
+ /// @inheritdoc ISablierV2Lockup
+ function streamedAmountOf(uint256 streamId)
+ public
+ view
+ override
+ notNull(streamId)
+ returns (uint128 streamedAmount)
+ {
+ streamedAmount = _streamedAmountOf(streamId);
+ }
+
+ /// @inheritdoc ERC721
+ function supportsInterface(bytes4 interfaceId) public view override(IERC165, ERC721) returns (bool) {
+ // 0x49064906 is the ERC-165 interface ID required by ERC-4906
+ return interfaceId == 0x49064906 || super.supportsInterface(interfaceId);
+ }
+
/// @inheritdoc ERC721
function tokenURI(uint256 streamId) public view override(IERC721Metadata, ERC721) returns (string memory uri) {
- // Checks: the stream NFT exists.
- _requireMinted({ tokenId: streamId });
+ // Check: the stream NFT exists.
+ _requireOwned({ tokenId: streamId });
// Generate the URI describing the stream NFT.
- uri = _nftDescriptor.tokenURI({ sablier: this, streamId: streamId });
+ uri = nftDescriptor.tokenURI({ sablier: this, streamId: streamId });
}
/// @inheritdoc ISablierV2Lockup
- function wasCanceled(uint256 streamId) public view virtual override returns (bool result);
+ function wasCanceled(uint256 streamId) external view override notNull(streamId) returns (bool result) {
+ result = _streams[streamId].wasCanceled;
+ }
/// @inheritdoc ISablierV2Lockup
function withdrawableAmountOf(uint256 streamId)
@@ -124,41 +236,58 @@ abstract contract SablierV2Lockup is
withdrawableAmount = _withdrawableAmountOf(streamId);
}
- /// @inheritdoc ISablierV2Lockup
- function isTransferable(uint256 streamId) public view virtual returns (bool);
-
/*//////////////////////////////////////////////////////////////////////////
USER-FACING NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @inheritdoc ISablierV2Lockup
- function burn(uint256 streamId) external override noDelegateCall {
- // Checks: only depleted streams can be burned. This also checks that the stream is not null.
- if (!isDepleted(streamId)) {
+ function allowToHook(address recipient) external override onlyAdmin {
+ // Check: non-zero code size.
+ if (recipient.code.length == 0) {
+ revert Errors.SablierV2Lockup_AllowToHookZeroCodeSize(recipient);
+ }
+
+ // Check: recipients implements the ERC-165 interface ID required by {ISablierLockupRecipient}.
+ bytes4 interfaceId = type(ISablierLockupRecipient).interfaceId;
+ if (!ISablierLockupRecipient(recipient).supportsInterface(interfaceId)) {
+ revert Errors.SablierV2Lockup_AllowToHookUnsupportedInterface(recipient);
+ }
+
+ // Effect: put the recipient on the allowlist.
+ _allowedToHook[recipient] = true;
+
+ // Log the allowlist addition.
+ emit ISablierV2Lockup.AllowToHook({ admin: msg.sender, recipient: recipient });
+ }
+
+ /// @inheritdoc ISablierV2Lockup
+ function burn(uint256 streamId) external override noDelegateCall notNull(streamId) {
+ // Check: only depleted streams can be burned.
+ if (!_streams[streamId].isDepleted) {
revert Errors.SablierV2Lockup_StreamNotDepleted(streamId);
}
- // Checks:
+ // Check:
// 1. NFT exists (see {IERC721.getApproved}).
// 2. `msg.sender` is either the owner of the NFT or an approved third party.
if (!_isCallerStreamRecipientOrApproved(streamId)) {
revert Errors.SablierV2Lockup_Unauthorized(streamId, msg.sender);
}
- // Effects: burn the NFT.
+ // Effect: burn the NFT.
_burn({ tokenId: streamId });
}
/// @inheritdoc ISablierV2Lockup
- function cancel(uint256 streamId) public override noDelegateCall {
- // Checks: the stream is neither depleted nor canceled. This also checks that the stream is not null.
- if (isDepleted(streamId)) {
+ function cancel(uint256 streamId) public override noDelegateCall notNull(streamId) {
+ // Check: the stream is neither depleted nor canceled.
+ if (_streams[streamId].isDepleted) {
revert Errors.SablierV2Lockup_StreamDepleted(streamId);
- } else if (wasCanceled(streamId)) {
+ } else if (_streams[streamId].wasCanceled) {
revert Errors.SablierV2Lockup_StreamCanceled(streamId);
}
- // Checks: `msg.sender` is the stream's sender.
+ // Check: `msg.sender` is the stream's sender.
if (!_isCallerStreamSender(streamId)) {
revert Errors.SablierV2Lockup_Unauthorized(streamId, msg.sender);
}
@@ -169,22 +298,17 @@ abstract contract SablierV2Lockup is
/// @inheritdoc ISablierV2Lockup
function cancelMultiple(uint256[] calldata streamIds) external override noDelegateCall {
- // Iterate over the provided array of stream ids and cancel each stream.
+ // Iterate over the provided array of stream IDs and cancel each stream.
uint256 count = streamIds.length;
- for (uint256 i = 0; i < count;) {
+ for (uint256 i = 0; i < count; ++i) {
// Effects and Interactions: cancel the stream.
cancel(streamIds[i]);
-
- // Increment the loop iterator.
- unchecked {
- i += 1;
- }
}
}
/// @inheritdoc ISablierV2Lockup
- function renounce(uint256 streamId) external override noDelegateCall notNull(streamId) updateMetadata(streamId) {
- // Checks: the stream is not cold.
+ function renounce(uint256 streamId) external override noDelegateCall notNull(streamId) {
+ // Check: the stream is not cold.
Lockup.Status status = _statusOf(streamId);
if (status == Lockup.Status.DEPLETED) {
revert Errors.SablierV2Lockup_StreamDepleted(streamId);
@@ -194,7 +318,7 @@ abstract contract SablierV2Lockup is
revert Errors.SablierV2Lockup_StreamSettled(streamId);
}
- // Checks: `msg.sender` is the stream's sender.
+ // Check: `msg.sender` is the stream's sender.
if (!_isCallerStreamSender(streamId)) {
revert Errors.SablierV2Lockup_Unauthorized(streamId, msg.sender);
}
@@ -205,19 +329,15 @@ abstract contract SablierV2Lockup is
// Log the renouncement.
emit ISablierV2Lockup.RenounceLockupStream(streamId);
- // Interactions: if the recipient is a contract, try to invoke the renounce hook on the recipient without
- // reverting if the hook is not implemented, and also without bubbling up any potential revert.
- address recipient = _ownerOf(streamId);
- if (recipient.code.length > 0) {
- try ISablierV2LockupRecipient(recipient).onStreamRenounced(streamId) { } catch { }
- }
+ // Emit an ERC-4906 event to trigger an update of the NFT metadata.
+ emit MetadataUpdate({ _tokenId: streamId });
}
/// @inheritdoc ISablierV2Lockup
function setNFTDescriptor(ISablierV2NFTDescriptor newNFTDescriptor) external override onlyAdmin {
- // Effects: set the NFT descriptor.
- ISablierV2NFTDescriptor oldNftDescriptor = _nftDescriptor;
- _nftDescriptor = newNFTDescriptor;
+ // Effect: set the NFT descriptor.
+ ISablierV2NFTDescriptor oldNftDescriptor = nftDescriptor;
+ nftDescriptor = newNFTDescriptor;
// Log the change of the NFT descriptor.
emit ISablierV2Lockup.SetNFTDescriptor({
@@ -231,47 +351,32 @@ abstract contract SablierV2Lockup is
}
/// @inheritdoc ISablierV2Lockup
- function withdraw(
- uint256 streamId,
- address to,
- uint128 amount
- )
- public
- override
- noDelegateCall
- updateMetadata(streamId)
- {
- // Checks: the stream is not depleted. This also checks that the stream is not null.
- if (isDepleted(streamId)) {
+ function withdraw(uint256 streamId, address to, uint128 amount) public override noDelegateCall notNull(streamId) {
+ // Check: the stream is not depleted.
+ if (_streams[streamId].isDepleted) {
revert Errors.SablierV2Lockup_StreamDepleted(streamId);
}
- bool isCallerStreamSender = _isCallerStreamSender(streamId);
+ // Check: the withdrawal address is not zero.
+ if (to == address(0)) {
+ revert Errors.SablierV2Lockup_WithdrawToZeroAddress(streamId);
+ }
- // Checks: `msg.sender` is the stream's sender, the stream's recipient, or an approved third party.
- if (!isCallerStreamSender && !_isCallerStreamRecipientOrApproved(streamId)) {
- revert Errors.SablierV2Lockup_Unauthorized(streamId, msg.sender);
+ // Check: the withdraw amount is not zero.
+ if (amount == 0) {
+ revert Errors.SablierV2Lockup_WithdrawAmountZero(streamId);
}
// Retrieve the recipient from storage.
address recipient = _ownerOf(streamId);
- // Checks: if `msg.sender` is the stream's sender, the withdrawal address must be the recipient.
- if (isCallerStreamSender && to != recipient) {
- revert Errors.SablierV2Lockup_InvalidSenderWithdrawal(streamId, msg.sender, to);
+ // Check: if `msg.sender` is neither the stream's recipient nor an approved third party, the withdrawal address
+ // must be the recipient.
+ if (to != recipient && !_isCallerStreamRecipientOrApproved(streamId)) {
+ revert Errors.SablierV2Lockup_WithdrawalAddressNotRecipient(streamId, msg.sender, to);
}
- // Checks: the withdrawal address is not zero.
- if (to == address(0)) {
- revert Errors.SablierV2Lockup_WithdrawToZeroAddress();
- }
-
- // Checks: the withdraw amount is not zero.
- if (amount == 0) {
- revert Errors.SablierV2Lockup_WithdrawAmountZero(streamId);
- }
-
- // Checks: the withdraw amount is not greater than the withdrawable amount.
+ // Check: the withdraw amount is not greater than the withdrawable amount.
uint128 withdrawableAmount = _withdrawableAmountOf(streamId);
if (amount > withdrawableAmount) {
revert Errors.SablierV2Lockup_Overdraw(streamId, amount, withdrawableAmount);
@@ -280,22 +385,29 @@ abstract contract SablierV2Lockup is
// Effects and Interactions: make the withdrawal.
_withdraw(streamId, to, amount);
- // Interactions: if `msg.sender` is not the recipient and the recipient is a contract, try to invoke the
- // withdraw hook on it without reverting if the hook is not implemented, and also without bubbling up
- // any potential revert.
- if (msg.sender != recipient && recipient.code.length > 0) {
- try ISablierV2LockupRecipient(recipient).onStreamWithdrawn({
+ // Emit an ERC-4906 event to trigger an update of the NFT metadata.
+ emit MetadataUpdate({ _tokenId: streamId });
+
+ // Interaction: if `msg.sender` is not the recipient and the recipient is on the allowlist, run the hook.
+ if (msg.sender != recipient && _allowedToHook[recipient]) {
+ bytes4 selector = ISablierLockupRecipient(recipient).onSablierLockupWithdraw({
streamId: streamId,
caller: msg.sender,
to: to,
amount: amount
- }) { } catch { }
+ });
+
+ // Check: the recipient's hook returned the correct selector.
+ if (selector != ISablierLockupRecipient.onSablierLockupWithdraw.selector) {
+ revert Errors.SablierV2Lockup_InvalidHookSelector(recipient);
+ }
}
}
/// @inheritdoc ISablierV2Lockup
- function withdrawMax(uint256 streamId, address to) external override {
- withdraw({ streamId: streamId, to: to, amount: _withdrawableAmountOf(streamId) });
+ function withdrawMax(uint256 streamId, address to) external override returns (uint128 withdrawnAmount) {
+ withdrawnAmount = _withdrawableAmountOf(streamId);
+ withdraw({ streamId: streamId, to: to, amount: withdrawnAmount });
}
/// @inheritdoc ISablierV2Lockup
@@ -307,17 +419,18 @@ abstract contract SablierV2Lockup is
override
noDelegateCall
notNull(streamId)
+ returns (uint128 withdrawnAmount)
{
- // Checks: the caller is the current recipient. This also checks that the NFT was not burned.
+ // Check: the caller is the current recipient. This also checks that the NFT was not burned.
address currentRecipient = _ownerOf(streamId);
if (msg.sender != currentRecipient) {
revert Errors.SablierV2Lockup_Unauthorized(streamId, msg.sender);
}
// Skip the withdrawal if the withdrawable amount is zero.
- uint128 withdrawableAmount = _withdrawableAmountOf(streamId);
- if (withdrawableAmount > 0) {
- withdraw({ streamId: streamId, to: currentRecipient, amount: withdrawableAmount });
+ withdrawnAmount = _withdrawableAmountOf(streamId);
+ if (withdrawnAmount > 0) {
+ withdraw({ streamId: streamId, to: currentRecipient, amount: withdrawnAmount });
}
// Checks and Effects: transfer the NFT.
@@ -327,29 +440,23 @@ abstract contract SablierV2Lockup is
/// @inheritdoc ISablierV2Lockup
function withdrawMultiple(
uint256[] calldata streamIds,
- address to,
uint128[] calldata amounts
)
external
override
noDelegateCall
{
- // Checks: there is an equal number of `streamIds` and `amounts`.
+ // Check: there is an equal number of `streamIds` and `amounts`.
uint256 streamIdsCount = streamIds.length;
uint256 amountsCount = amounts.length;
if (streamIdsCount != amountsCount) {
revert Errors.SablierV2Lockup_WithdrawArrayCountsNotEqual(streamIdsCount, amountsCount);
}
- // Iterate over the provided array of stream ids and withdraw from each stream.
- for (uint256 i = 0; i < streamIdsCount;) {
+ // Iterate over the provided array of stream IDs, and withdraw from each stream to the recipient.
+ for (uint256 i = 0; i < streamIdsCount; ++i) {
// Checks, Effects and Interactions: check the parameters and make the withdrawal.
- withdraw(streamIds[i], to, amounts[i]);
-
- // Increment the loop iterator.
- unchecked {
- i += 1;
- }
+ withdraw({ streamId: streamIds[i], to: _ownerOf(streamIds[i]), amount: amounts[i] });
}
}
@@ -357,41 +464,12 @@ abstract contract SablierV2Lockup is
INTERNAL CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
- /// @notice Overrides the internal ERC-721 transfer function to emit an ERC-4906 event upon transfer. The goal is to
- /// refresh the NFT metadata on external platforms.
- /// @dev This event is also emitted when the NFT is minted or burned.
- function _afterTokenTransfer(
- address, /* from */
- address, /* to */
- uint256 streamId,
- uint256 /* batchSize */
- )
- internal
- override
- updateMetadata(streamId)
- { }
-
- /// @notice Overrides the internal ERC-721 transfer function to check that the stream is transferable.
- /// @dev There are two cases when the transferable flag is ignored:
- /// - If `from` is 0, then the transfer is a mint and is allowed.
- /// - If `to` is 0, then the transfer is a burn and is also allowed.
- function _beforeTokenTransfer(
- address from,
- address to,
- uint256 streamId,
- uint256 /* batchSize */
- )
- internal
- view
- override
- {
- if (!isTransferable(streamId) && to != address(0) && from != address(0)) {
- revert Errors.SablierV2Lockup_NotTransferable(streamId);
- }
- }
+ /// @notice Calculates the streamed amount of the stream without looking up the stream's status.
+ /// @dev This function is implemented by child contracts, so the logic varies depending on the model.
+ function _calculateStreamedAmount(uint256 streamId) internal view virtual returns (uint128);
/// @notice Checks whether `msg.sender` is the stream's recipient or an approved third party.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function _isCallerStreamRecipientOrApproved(uint256 streamId) internal view returns (bool) {
address recipient = _ownerOf(streamId);
return msg.sender == recipient || isApprovedForAll({ owner: recipient, operator: msg.sender })
@@ -399,25 +477,184 @@ abstract contract SablierV2Lockup is
}
/// @notice Checks whether `msg.sender` is the stream's sender.
- /// @param streamId The stream id for the query.
- function _isCallerStreamSender(uint256 streamId) internal view virtual returns (bool);
+ /// @param streamId The stream ID for the query.
+ function _isCallerStreamSender(uint256 streamId) internal view returns (bool) {
+ return msg.sender == _streams[streamId].sender;
+ }
/// @dev Retrieves the stream's status without performing a null check.
- function _statusOf(uint256 streamId) internal view virtual returns (Lockup.Status);
+ function _statusOf(uint256 streamId) internal view returns (Lockup.Status) {
+ if (_streams[streamId].isDepleted) {
+ return Lockup.Status.DEPLETED;
+ } else if (_streams[streamId].wasCanceled) {
+ return Lockup.Status.CANCELED;
+ }
+
+ if (block.timestamp < _streams[streamId].startTime) {
+ return Lockup.Status.PENDING;
+ }
+
+ if (_calculateStreamedAmount(streamId) < _streams[streamId].amounts.deposited) {
+ return Lockup.Status.STREAMING;
+ } else {
+ return Lockup.Status.SETTLED;
+ }
+ }
+
+ /// @dev See the documentation for the user-facing functions that call this internal function.
+ function _streamedAmountOf(uint256 streamId) internal view returns (uint128) {
+ Lockup.Amounts memory amounts = _streams[streamId].amounts;
+
+ if (_streams[streamId].isDepleted) {
+ return amounts.withdrawn;
+ } else if (_streams[streamId].wasCanceled) {
+ return amounts.deposited - amounts.refunded;
+ }
+
+ return _calculateStreamedAmount(streamId);
+ }
/// @dev See the documentation for the user-facing functions that call this internal function.
- function _withdrawableAmountOf(uint256 streamId) internal view virtual returns (uint128);
+ function _withdrawableAmountOf(uint256 streamId) internal view returns (uint128) {
+ return _streamedAmountOf(streamId) - _streams[streamId].amounts.withdrawn;
+ }
/*//////////////////////////////////////////////////////////////////////////
INTERNAL NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @dev See the documentation for the user-facing functions that call this internal function.
- function _cancel(uint256 tokenId) internal virtual;
+ function _cancel(uint256 streamId) internal {
+ // Calculate the streamed amount.
+ uint128 streamedAmount = _calculateStreamedAmount(streamId);
+
+ // Retrieve the amounts from storage.
+ Lockup.Amounts memory amounts = _streams[streamId].amounts;
+
+ // Check: the stream is not settled.
+ if (streamedAmount >= amounts.deposited) {
+ revert Errors.SablierV2Lockup_StreamSettled(streamId);
+ }
+
+ // Check: the stream is cancelable.
+ if (!_streams[streamId].isCancelable) {
+ revert Errors.SablierV2Lockup_StreamNotCancelable(streamId);
+ }
+
+ // Calculate the sender's amount.
+ uint128 senderAmount;
+ unchecked {
+ senderAmount = amounts.deposited - streamedAmount;
+ }
+
+ // Calculate the recipient's amount.
+ uint128 recipientAmount = streamedAmount - amounts.withdrawn;
+
+ // Effect: mark the stream as canceled.
+ _streams[streamId].wasCanceled = true;
+
+ // Effect: make the stream not cancelable anymore, because a stream can only be canceled once.
+ _streams[streamId].isCancelable = false;
+
+ // Effect: if there are no assets left for the recipient to withdraw, mark the stream as depleted.
+ if (recipientAmount == 0) {
+ _streams[streamId].isDepleted = true;
+ }
+
+ // Effect: set the refunded amount.
+ _streams[streamId].amounts.refunded = senderAmount;
+
+ // Retrieve the sender and the recipient from storage.
+ address sender = _streams[streamId].sender;
+ address recipient = _ownerOf(streamId);
+
+ // Retrieve the ERC-20 asset from storage.
+ IERC20 asset = _streams[streamId].asset;
+
+ // Interaction: refund the sender.
+ asset.safeTransfer({ to: sender, value: senderAmount });
+
+ // Log the cancellation.
+ emit ISablierV2Lockup.CancelLockupStream(streamId, sender, recipient, asset, senderAmount, recipientAmount);
+
+ // Emit an ERC-4906 event to trigger an update of the NFT metadata.
+ emit MetadataUpdate({ _tokenId: streamId });
+
+ // Interaction: if the recipient is on the allowlist, run the hook.
+ if (_allowedToHook[recipient]) {
+ bytes4 selector = ISablierLockupRecipient(recipient).onSablierLockupCancel({
+ streamId: streamId,
+ sender: sender,
+ senderAmount: senderAmount,
+ recipientAmount: recipientAmount
+ });
+
+ // Check: the recipient's hook returned the correct selector.
+ if (selector != ISablierLockupRecipient.onSablierLockupCancel.selector) {
+ revert Errors.SablierV2Lockup_InvalidHookSelector(recipient);
+ }
+ }
+ }
/// @dev See the documentation for the user-facing functions that call this internal function.
- function _renounce(uint256 streamId) internal virtual;
+ function _renounce(uint256 streamId) internal {
+ // Check: the stream is cancelable.
+ if (!_streams[streamId].isCancelable) {
+ revert Errors.SablierV2Lockup_StreamNotCancelable(streamId);
+ }
+
+ // Effect: renounce the stream by making it not cancelable.
+ _streams[streamId].isCancelable = false;
+ }
+
+ /// @notice Overrides the {ERC-721._update} function to check that the stream is transferable, and emits an
+ /// ERC-4906 event.
+ /// @dev There are two cases when the transferable flag is ignored:
+ /// - If the current owner is 0, then the update is a mint and is allowed.
+ /// - If `to` is 0, then the update is a burn and is also allowed.
+ /// @param to The address of the new recipient of the stream.
+ /// @param streamId ID of the stream to update.
+ /// @param auth Optional parameter. If the value is not zero, the overridden implementation will check that
+ /// `auth` is either the recipient of the stream, or an approved third party.
+ /// @return The original recipient of the `streamId` before the update.
+ function _update(address to, uint256 streamId, address auth) internal override returns (address) {
+ address from = _ownerOf(streamId);
+
+ if (from != address(0) && to != address(0) && !_streams[streamId].isTransferable) {
+ revert Errors.SablierV2Lockup_NotTransferable(streamId);
+ }
+
+ // Emit an ERC-4906 event to trigger an update of the NFT metadata.
+ emit MetadataUpdate({ _tokenId: streamId });
+
+ return super._update(to, streamId, auth);
+ }
/// @dev See the documentation for the user-facing functions that call this internal function.
- function _withdraw(uint256 streamId, address to, uint128 amount) internal virtual;
+ function _withdraw(uint256 streamId, address to, uint128 amount) internal {
+ // Effect: update the withdrawn amount.
+ _streams[streamId].amounts.withdrawn = _streams[streamId].amounts.withdrawn + amount;
+
+ // Retrieve the amounts from storage.
+ Lockup.Amounts memory amounts = _streams[streamId].amounts;
+
+ // Using ">=" instead of "==" for additional safety reasons. In the event of an unforeseen increase in the
+ // withdrawn amount, the stream will still be marked as depleted.
+ if (amounts.withdrawn >= amounts.deposited - amounts.refunded) {
+ // Effect: mark the stream as depleted.
+ _streams[streamId].isDepleted = true;
+
+ // Effect: make the stream not cancelable anymore, because a depleted stream cannot be canceled.
+ _streams[streamId].isCancelable = false;
+ }
+
+ // Retrieve the ERC-20 asset from storage.
+ IERC20 asset = _streams[streamId].asset;
+
+ // Interaction: perform the ERC-20 transfer.
+ asset.safeTransfer({ to: to, value: amount });
+
+ // Log the withdrawal.
+ emit ISablierV2Lockup.WithdrawFromLockupStream(streamId, to, asset, amount);
+ }
}
diff --git a/src/interfaces/IAdminable.sol b/src/interfaces/IAdminable.sol
index e5ee09561..62a13d1a7 100644
--- a/src/interfaces/IAdminable.sol
+++ b/src/interfaces/IAdminable.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19;
+pragma solidity >=0.8.22;
/// @title IAdminable
/// @notice Contract module that provides a basic access control mechanism, with an admin that can be
diff --git a/src/interfaces/ISablierLockupRecipient.sol b/src/interfaces/ISablierLockupRecipient.sol
new file mode 100644
index 000000000..cf6c80cb3
--- /dev/null
+++ b/src/interfaces/ISablierLockupRecipient.sol
@@ -0,0 +1,57 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity >=0.8.22;
+
+import { IERC165 } from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+
+/// @title ISablierLockupRecipient
+/// @notice Interface for recipient contracts capable of reacting to cancellations and withdrawals. For this to be able
+/// to hook into Sablier, it must fully implement this interface and it must have been allowlisted by the Lockup
+/// contract's admin.
+/// @dev See {IERC165-supportsInterface}.
+/// The implementation MUST implement the {IERC165-supportsInterface} method, which MUST return `true` when called with
+/// `0xf8ee98d3`, i.e. `type(ISablierLockupRecipient).interfaceId`.
+interface ISablierLockupRecipient is IERC165 {
+ /// @notice Responds to cancellations.
+ ///
+ /// @dev Notes:
+ /// - The function MUST return the selector `ISablierLockupRecipient.onSablierLockupCancel.selector`.
+ /// - If this function reverts, the execution in the Lockup contract will revert as well.
+ ///
+ /// @param streamId The ID of the canceled stream.
+ /// @param sender The stream's sender, who canceled the stream.
+ /// @param senderAmount The amount of assets refunded to the stream's sender, denoted in units of the asset's
+ /// decimals.
+ /// @param recipientAmount The amount of assets left for the stream's recipient to withdraw, denoted in units of
+ /// the asset's decimals.
+ ///
+ /// @return selector The selector of this function needed to validate the hook.
+ function onSablierLockupCancel(
+ uint256 streamId,
+ address sender,
+ uint128 senderAmount,
+ uint128 recipientAmount
+ )
+ external
+ returns (bytes4 selector);
+
+ /// @notice Responds to withdrawals triggered by any address except the contract implementing this interface.
+ ///
+ /// @dev Notes:
+ /// - The function MUST return the selector `ISablierLockupRecipient.onSablierLockupWithdraw.selector`.
+ /// - If this function reverts, the execution in the Lockup contract will revert as well.
+ ///
+ /// @param streamId The ID of the stream being withdrawn from.
+ /// @param caller The original `msg.sender` address that triggered the withdrawal.
+ /// @param to The address receiving the withdrawn assets.
+ /// @param amount The amount of assets withdrawn, denoted in units of the asset's decimals.
+ ///
+ /// @return selector The selector of this function needed to validate the hook.
+ function onSablierLockupWithdraw(
+ uint256 streamId,
+ address caller,
+ address to,
+ uint128 amount
+ )
+ external
+ returns (bytes4 selector);
+}
diff --git a/src/interfaces/ISablierV2Base.sol b/src/interfaces/ISablierV2Base.sol
deleted file mode 100644
index ec7bcdbaf..000000000
--- a/src/interfaces/ISablierV2Base.sol
+++ /dev/null
@@ -1,75 +0,0 @@
-// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19;
-
-import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-import { UD60x18 } from "@prb/math/src/UD60x18.sol";
-
-import { IAdminable } from "./IAdminable.sol";
-import { ISablierV2Comptroller } from "./ISablierV2Comptroller.sol";
-
-/// @title ISablierV2Base
-/// @notice Base logic for all Sablier V2 streaming contracts.
-interface ISablierV2Base is IAdminable {
- /*//////////////////////////////////////////////////////////////////////////
- EVENTS
- //////////////////////////////////////////////////////////////////////////*/
-
- /// @notice Emitted when the admin claims all protocol revenues accrued for a particular ERC-20 asset.
- /// @param admin The address of the contract admin.
- /// @param asset The contract address of the ERC-20 asset the protocol revenues have been claimed for.
- /// @param protocolRevenues The amount of protocol revenues claimed, denoted in units of the asset's decimals.
- event ClaimProtocolRevenues(address indexed admin, IERC20 indexed asset, uint128 protocolRevenues);
-
- /// @notice Emitted when the admin sets a new comptroller contract.
- /// @param admin The address of the contract admin.
- /// @param oldComptroller The address of the old comptroller contract.
- /// @param newComptroller The address of the new comptroller contract.
- event SetComptroller(
- address indexed admin, ISablierV2Comptroller oldComptroller, ISablierV2Comptroller newComptroller
- );
-
- /*//////////////////////////////////////////////////////////////////////////
- CONSTANT FUNCTIONS
- //////////////////////////////////////////////////////////////////////////*/
-
- /// @notice Retrieves the maximum fee that can be charged by the protocol or a broker, denoted as a fixed-point
- /// number where 1e18 is 100%.
- /// @dev This value is hard coded as a constant.
- function MAX_FEE() external view returns (UD60x18);
-
- /// @notice Retrieves the address of the comptroller contract, responsible for the Sablier V2 protocol
- /// configuration.
- function comptroller() external view returns (ISablierV2Comptroller);
-
- /// @notice Retrieves the protocol revenues accrued for the provided ERC-20 asset, in units of the asset's
- /// decimals.
- /// @param asset The contract address of the ERC-20 asset to query.
- function protocolRevenues(IERC20 asset) external view returns (uint128 revenues);
-
- /*//////////////////////////////////////////////////////////////////////////
- NON-CONSTANT FUNCTIONS
- //////////////////////////////////////////////////////////////////////////*/
-
- /// @notice Claims all accumulated protocol revenues for the provided ERC-20 asset.
- ///
- /// @dev Emits a {ClaimProtocolRevenues} event.
- ///
- /// Requirements:
- /// - `msg.sender` must be the contract admin.
- ///
- /// @param asset The contract address of the ERC-20 asset for which to claim protocol revenues.
- function claimProtocolRevenues(IERC20 asset) external;
-
- /// @notice Assigns a new comptroller contract responsible for the protocol configuration.
- ///
- /// @dev Emits a {SetComptroller} event.
- ///
- /// Notes:
- /// - Does not revert if the comptroller is the same.
- ///
- /// Requirements:
- /// - `msg.sender` must be the contract admin.
- ///
- /// @param newComptroller The address of the new comptroller contract.
- function setComptroller(ISablierV2Comptroller newComptroller) external;
-}
diff --git a/src/interfaces/ISablierV2Comptroller.sol b/src/interfaces/ISablierV2Comptroller.sol
deleted file mode 100644
index a6a471530..000000000
--- a/src/interfaces/ISablierV2Comptroller.sol
+++ /dev/null
@@ -1,99 +0,0 @@
-// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19;
-
-import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-import { UD60x18 } from "@prb/math/src/UD60x18.sol";
-
-import { IAdminable } from "./IAdminable.sol";
-
-/// @title ISablierV2Controller
-/// @notice This contract is in charge of the Sablier V2 protocol configuration, handling such values as the
-/// protocol fees.
-interface ISablierV2Comptroller is IAdminable {
- /*//////////////////////////////////////////////////////////////////////////
- EVENTS
- //////////////////////////////////////////////////////////////////////////*/
-
- /// @notice Emitted when the admin sets a new flash fee.
- /// @param admin The address of the contract admin.
- /// @param oldFlashFee The old flash fee, denoted as a fixed-point number.
- /// @param newFlashFee The new flash fee, denoted as a fixed-point number.
- event SetFlashFee(address indexed admin, UD60x18 oldFlashFee, UD60x18 newFlashFee);
-
- /// @notice Emitted when the admin sets a new protocol fee for the provided ERC-20 asset.
- /// @param admin The address of the contract admin.
- /// @param asset The contract address of the ERC-20 asset the new protocol fee has been set for.
- /// @param oldProtocolFee The old protocol fee, denoted as a fixed-point number.
- /// @param newProtocolFee The new protocol fee, denoted as a fixed-point number.
- event SetProtocolFee(address indexed admin, IERC20 indexed asset, UD60x18 oldProtocolFee, UD60x18 newProtocolFee);
-
- /// @notice Emitted when the admin enables or disables an ERC-20 asset for flash loaning.
- /// @param admin The address of the contract admin.
- /// @param asset The contract address of the ERC-20 asset to toggle.
- /// @param newFlag Whether the ERC-20 asset can be flash loaned.
- event ToggleFlashAsset(address indexed admin, IERC20 indexed asset, bool newFlag);
-
- /*//////////////////////////////////////////////////////////////////////////
- CONSTANT FUNCTIONS
- //////////////////////////////////////////////////////////////////////////*/
-
- /// @notice Retrieves the global flash fee, denoted as a fixed-point number where 1e18 is 100%.
- ///
- /// @dev Notes:
- /// - This fee represents a percentage, not an amount. Do not confuse it with {IERC3156FlashLender.flashFee},
- /// which calculates the fee amount for a specified flash loan amount.
- /// - Unlike the protocol fee, this is a global fee applied to all flash loans, not a per-asset fee.
- function flashFee() external view returns (UD60x18 fee);
-
- /// @notice Retrieves a flag indicating whether the provided ERC-20 asset can be flash loaned.
- /// @param token The contract address of the ERC-20 asset to check.
- function isFlashAsset(IERC20 token) external view returns (bool result);
-
- /// @notice Retrieves the protocol fee for all streams created with the provided ERC-20 asset.
- /// @param asset The contract address of the ERC-20 asset to query.
- /// @return fee The protocol fee denoted as a fixed-point number where 1e18 is 100%.
- function protocolFees(IERC20 asset) external view returns (UD60x18 fee);
-
- /*//////////////////////////////////////////////////////////////////////////
- NON-CONSTANT FUNCTIONS
- //////////////////////////////////////////////////////////////////////////*/
-
- /// @notice Updates the flash fee charged on all flash loans made with any ERC-20 asset.
- ///
- /// @dev Emits a {SetFlashFee} event.
- ///
- /// Notes:
- /// - Does not revert if the fee is the same.
- ///
- /// Requirements:
- /// - `msg.sender` must be the contract admin.
- ///
- /// @param newFlashFee The new flash fee to set, denoted as a fixed-point number where 1e18 is 100%.
- function setFlashFee(UD60x18 newFlashFee) external;
-
- /// @notice Sets a new protocol fee that will be charged on all streams created with the provided ERC-20 asset.
- ///
- /// @dev Emits a {SetProtocolFee} event.
- ///
- /// Notes:
- /// - The fee is not denoted in units of the asset's decimals; it is a fixed-point number. Refer to the
- /// PRBMath documentation for more detail on the logic of UD60x18.
- /// - Does not revert if the fee is the same.
- ///
- /// Requirements:
- /// - `msg.sender` must be the contract admin.
- ///
- /// @param asset The contract address of the ERC-20 asset to update the fee for.
- /// @param newProtocolFee The new protocol fee, denoted as a fixed-point number where 1e18 is 100%.
- function setProtocolFee(IERC20 asset, UD60x18 newProtocolFee) external;
-
- /// @notice Toggles the flash loanability of an ERC-20 asset.
- ///
- /// @dev Emits a {ToggleFlashAsset} event.
- ///
- /// Requirements:
- /// - `msg.sender` must be the admin.
- ///
- /// @param asset The address of the ERC-20 asset to toggle.
- function toggleFlashAsset(IERC20 asset) external;
-}
diff --git a/src/interfaces/ISablierV2Lockup.sol b/src/interfaces/ISablierV2Lockup.sol
index 15ab4f511..72c6fcf48 100644
--- a/src/interfaces/ISablierV2Lockup.sol
+++ b/src/interfaces/ISablierV2Lockup.sol
@@ -1,28 +1,36 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19;
+pragma solidity >=0.8.22;
+import { IERC4906 } from "@openzeppelin/contracts/interfaces/IERC4906.sol";
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { IERC721Metadata } from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol";
+import { UD60x18 } from "@prb/math/src/UD60x18.sol";
import { Lockup } from "../types/DataTypes.sol";
-import { ISablierV2Base } from "./ISablierV2Base.sol";
+import { IAdminable } from "./IAdminable.sol";
import { ISablierV2NFTDescriptor } from "./ISablierV2NFTDescriptor.sol";
/// @title ISablierV2Lockup
-/// @notice Common logic between all Sablier V2 Lockup streaming contracts.
+/// @notice Common logic between all Sablier V2 Lockup contracts.
interface ISablierV2Lockup is
- ISablierV2Base, // 1 inherited component
+ IAdminable, // 0 inherited components
+ IERC4906, // 2 inherited components
IERC721Metadata // 2 inherited components
{
/*//////////////////////////////////////////////////////////////////////////
EVENTS
//////////////////////////////////////////////////////////////////////////*/
+ /// @notice Emitted when the admin allows a new recipient contract to hook to Sablier.
+ /// @param admin The address of the current contract admin.
+ /// @param recipient The address of the recipient contract put on the allowlist.
+ event AllowToHook(address indexed admin, address recipient);
+
/// @notice Emitted when a stream is canceled.
- /// @param streamId The id of the stream.
+ /// @param streamId The ID of the stream.
/// @param sender The address of the stream's sender.
/// @param recipient The address of the stream's recipient.
- /// @param asset The contract address of the ERC-20 asset used for streaming.
+ /// @param asset The contract address of the ERC-20 asset to be distributed.
/// @param senderAmount The amount of assets refunded to the stream's sender, denoted in units of the asset's
/// decimals.
/// @param recipientAmount The amount of assets left for the stream's recipient to withdraw, denoted in units of the
@@ -37,7 +45,7 @@ interface ISablierV2Lockup is
);
/// @notice Emitted when a sender gives up the right to cancel a stream.
- /// @param streamId The id of the stream.
+ /// @param streamId The ID of the stream.
event RenounceLockupStream(uint256 indexed streamId);
/// @notice Emitted when the admin sets a new NFT descriptor contract.
@@ -49,9 +57,9 @@ interface ISablierV2Lockup is
);
/// @notice Emitted when assets are withdrawn from a stream.
- /// @param streamId The id of the stream.
+ /// @param streamId The ID of the stream.
/// @param to The address that has received the withdrawn assets.
- /// @param asset The contract address of the ERC-20 asset used for streaming.
+ /// @param asset The contract address of the ERC-20 asset to be distributed.
/// @param amount The amount of assets withdrawn, denoted in units of the asset's decimals.
event WithdrawFromLockupStream(uint256 indexed streamId, address indexed to, IERC20 indexed asset, uint128 amount);
@@ -59,111 +67,148 @@ interface ISablierV2Lockup is
CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
- /// @notice Retrieves the address of the ERC-20 asset used for streaming.
+ /// @notice Retrieves the address of the ERC-20 asset to be distributed.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function getAsset(uint256 streamId) external view returns (IERC20 asset);
/// @notice Retrieves the amount deposited in the stream, denoted in units of the asset's decimals.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function getDepositedAmount(uint256 streamId) external view returns (uint128 depositedAmount);
/// @notice Retrieves the stream's end time, which is a Unix timestamp.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function getEndTime(uint256 streamId) external view returns (uint40 endTime);
/// @notice Retrieves the stream's recipient.
/// @dev Reverts if the NFT has been burned.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function getRecipient(uint256 streamId) external view returns (address recipient);
/// @notice Retrieves the amount refunded to the sender after a cancellation, denoted in units of the asset's
/// decimals. This amount is always zero unless the stream was canceled.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function getRefundedAmount(uint256 streamId) external view returns (uint128 refundedAmount);
/// @notice Retrieves the stream's sender.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function getSender(uint256 streamId) external view returns (address sender);
/// @notice Retrieves the stream's start time, which is a Unix timestamp.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function getStartTime(uint256 streamId) external view returns (uint40 startTime);
/// @notice Retrieves the amount withdrawn from the stream, denoted in units of the asset's decimals.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function getWithdrawnAmount(uint256 streamId) external view returns (uint128 withdrawnAmount);
+ /// @notice Retrieves a flag indicating whether the provided address is a contract allowed to hook to Sablier
+ /// when a stream is canceled or when assets are withdrawn.
+ /// @dev See {ISablierLockupRecipient} for more information.
+ function isAllowedToHook(address recipient) external view returns (bool result);
+
/// @notice Retrieves a flag indicating whether the stream can be canceled. When the stream is cold, this
/// flag is always `false`.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function isCancelable(uint256 streamId) external view returns (bool result);
/// @notice Retrieves a flag indicating whether the stream is cold, i.e. settled, canceled, or depleted.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function isCold(uint256 streamId) external view returns (bool result);
/// @notice Retrieves a flag indicating whether the stream is depleted.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function isDepleted(uint256 streamId) external view returns (bool result);
/// @notice Retrieves a flag indicating whether the stream exists.
/// @dev Does not revert if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function isStream(uint256 streamId) external view returns (bool result);
/// @notice Retrieves a flag indicating whether the stream NFT can be transferred.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function isTransferable(uint256 streamId) external view returns (bool result);
/// @notice Retrieves a flag indicating whether the stream is warm, i.e. either pending or streaming.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function isWarm(uint256 streamId) external view returns (bool result);
- /// @notice Counter for stream ids, used in the create functions.
+ /// @notice Retrieves the maximum broker fee that can be charged by the broker, denoted as a fixed-point
+ /// number where 1e18 is 100%.
+ /// @dev This value is hard coded as a constant.
+ function MAX_BROKER_FEE() external view returns (UD60x18);
+
+ /// @notice Counter for stream IDs, used in the create functions.
function nextStreamId() external view returns (uint256);
+ /// @notice Contract that generates the non-fungible token URI.
+ function nftDescriptor() external view returns (ISablierV2NFTDescriptor);
+
/// @notice Calculates the amount that the sender would be refunded if the stream were canceled, denoted in units
/// of the asset's decimals.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function refundableAmountOf(uint256 streamId) external view returns (uint128 refundableAmount);
/// @notice Retrieves the stream's status.
- /// @param streamId The stream id for the query.
+ /// @dev Reverts if `streamId` references a null stream.
+ /// @param streamId The stream ID for the query.
function statusOf(uint256 streamId) external view returns (Lockup.Status status);
/// @notice Calculates the amount streamed to the recipient, denoted in units of the asset's decimals.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
+ ///
+ /// Notes:
+ /// - Upon cancellation of the stream, the amount streamed is calculated as the difference between the deposited
+ /// amount and the refunded amount. Ultimately, when the stream becomes depleted, the streamed amount is equivalent
+ /// to the total amount withdrawn.
+ ///
+ /// @param streamId The stream ID for the query.
function streamedAmountOf(uint256 streamId) external view returns (uint128 streamedAmount);
/// @notice Retrieves a flag indicating whether the stream was canceled.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function wasCanceled(uint256 streamId) external view returns (bool result);
/// @notice Calculates the amount that the recipient can withdraw from the stream, denoted in units of the asset's
/// decimals.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function withdrawableAmountOf(uint256 streamId) external view returns (uint128 withdrawableAmount);
/*//////////////////////////////////////////////////////////////////////////
NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
+ /// @notice Allows a recipient contract to hook to Sablier when a stream is canceled or when assets are withdrawn.
+ /// Useful for implementing contracts that hold streams on behalf of users, such as vaults or staking contracts.
+ ///
+ /// @dev Emits an {AllowToHook} event.
+ ///
+ /// Notes:
+ /// - Does not revert if the contract is already on the allowlist.
+ /// - This is an irreversible operation. The contract cannot be removed from the allowlist.
+ ///
+ /// Requirements:
+ /// - `msg.sender` must be the contract admin.
+ /// - `recipient` must have a non-zero code size.
+ /// - `recipient` must implement {ISablierLockupRecipient}.
+ ///
+ /// @param recipient The address of the contract to allow for hooks.
+ function allowToHook(address recipient) external;
+
/// @notice Burns the NFT associated with the stream.
///
/// @dev Emits a {Transfer} event.
@@ -174,7 +219,7 @@ interface ISablierV2Lockup is
/// - The NFT must exist.
/// - `msg.sender` must be either the NFT owner or an approved third party.
///
- /// @param streamId The id of the stream NFT to burn.
+ /// @param streamId The ID of the stream NFT to burn.
function burn(uint256 streamId) external;
/// @notice Cancels the stream and refunds any remaining assets to the sender.
@@ -191,7 +236,7 @@ interface ISablierV2Lockup is
/// - The stream must be warm and cancelable.
/// - `msg.sender` must be the stream's sender.
///
- /// @param streamId The id of the stream to cancel.
+ /// @param streamId The ID of the stream to cancel.
function cancel(uint256 streamId) external;
/// @notice Cancels multiple streams and refunds any remaining assets to the sender.
@@ -204,7 +249,7 @@ interface ISablierV2Lockup is
/// Requirements:
/// - All requirements from {cancel} must be met for each stream.
///
- /// @param streamIds The ids of the streams to cancel.
+ /// @param streamIds The IDs of the streams to cancel.
function cancelMultiple(uint256[] calldata streamIds) external;
/// @notice Removes the right of the stream's sender to cancel the stream.
@@ -213,7 +258,6 @@ interface ISablierV2Lockup is
///
/// Notes:
/// - This is an irreversible operation.
- /// - This function attempts to invoke a hook on the stream's recipient, provided that the recipient is a contract.
///
/// Requirements:
/// - Must not be delegate called.
@@ -221,7 +265,7 @@ interface ISablierV2Lockup is
/// - `msg.sender` must be the stream's sender.
/// - The stream must be cancelable.
///
- /// @param streamId The id of the stream to renounce.
+ /// @param streamId The ID of the stream to renounce.
function renounce(uint256 streamId) external;
/// @notice Sets a new NFT descriptor contract, which produces the URI describing the Sablier stream NFTs.
@@ -242,18 +286,16 @@ interface ISablierV2Lockup is
/// @dev Emits a {Transfer}, {WithdrawFromLockupStream}, and {MetadataUpdate} event.
///
/// Notes:
- /// - This function attempts to invoke a hook on the stream's recipient, provided that the recipient is a contract
- /// and `msg.sender` is either the sender or an approved operator.
+ /// - This function attempts to call a hook on the recipient of the stream, unless `msg.sender` is the recipient.
///
/// Requirements:
/// - Must not be delegate called.
/// - `streamId` must not reference a null or depleted stream.
- /// - `msg.sender` must be the stream's sender, the stream's recipient or an approved third party.
- /// - `to` must be the recipient if `msg.sender` is the stream's sender.
/// - `to` must not be the zero address.
/// - `amount` must be greater than zero and must not exceed the withdrawable amount.
+ /// - `to` must be the recipient if `msg.sender` is not the stream's recipient or an approved third party.
///
- /// @param streamId The id of the stream to withdraw from.
+ /// @param streamId The ID of the stream to withdraw from.
/// @param to The address receiving the withdrawn assets.
/// @param amount The amount to withdraw, denoted in units of the asset's decimals.
function withdraw(uint256 streamId, address to, uint128 amount) external;
@@ -268,9 +310,10 @@ interface ISablierV2Lockup is
/// Requirements:
/// - Refer to the requirements in {withdraw}.
///
- /// @param streamId The id of the stream to withdraw from.
+ /// @param streamId The ID of the stream to withdraw from.
/// @param to The address receiving the withdrawn assets.
- function withdrawMax(uint256 streamId, address to) external;
+ /// @return withdrawnAmount The amount withdrawn, denoted in units of the asset's decimals.
+ function withdrawMax(uint256 streamId, address to) external returns (uint128 withdrawnAmount);
/// @notice Withdraws the maximum withdrawable amount from the stream to the current recipient, and transfers the
/// NFT to `newRecipient`.
@@ -286,11 +329,17 @@ interface ISablierV2Lockup is
/// - Refer to the requirements in {withdraw}.
/// - Refer to the requirements in {IERC721.transferFrom}.
///
- /// @param streamId The id of the stream NFT to transfer.
+ /// @param streamId The ID of the stream NFT to transfer.
/// @param newRecipient The address of the new owner of the stream NFT.
- function withdrawMaxAndTransfer(uint256 streamId, address newRecipient) external;
+ /// @return withdrawnAmount The amount withdrawn, denoted in units of the asset's decimals.
+ function withdrawMaxAndTransfer(
+ uint256 streamId,
+ address newRecipient
+ )
+ external
+ returns (uint128 withdrawnAmount);
- /// @notice Withdraws assets from streams to the provided address `to`.
+ /// @notice Withdraws assets from streams to the recipient of each stream.
///
/// @dev Emits multiple {Transfer}, {WithdrawFromLockupStream}, and {MetadataUpdate} events.
///
@@ -298,11 +347,12 @@ interface ISablierV2Lockup is
/// - This function attempts to call a hook on the recipient of each stream, unless `msg.sender` is the recipient.
///
/// Requirements:
- /// - All requirements from {withdraw} must be met for each stream.
+ /// - Must not be delegate called.
/// - There must be an equal number of `streamIds` and `amounts`.
+ /// - Each stream ID in the array must not reference a null or depleted stream.
+ /// - Each amount in the array must be greater than zero and must not exceed the withdrawable amount.
///
- /// @param streamIds The ids of the streams to withdraw from.
- /// @param to The address receiving the withdrawn assets.
+ /// @param streamIds The IDs of the streams to withdraw from.
/// @param amounts The amounts to withdraw, denoted in units of the asset's decimals.
- function withdrawMultiple(uint256[] calldata streamIds, address to, uint128[] calldata amounts) external;
+ function withdrawMultiple(uint256[] calldata streamIds, uint128[] calldata amounts) external;
}
diff --git a/src/interfaces/ISablierV2LockupDynamic.sol b/src/interfaces/ISablierV2LockupDynamic.sol
index d117d9c8a..df77c8f84 100644
--- a/src/interfaces/ISablierV2LockupDynamic.sol
+++ b/src/interfaces/ISablierV2LockupDynamic.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19;
+pragma solidity >=0.8.22;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
@@ -7,24 +7,24 @@ import { Lockup, LockupDynamic } from "../types/DataTypes.sol";
import { ISablierV2Lockup } from "./ISablierV2Lockup.sol";
/// @title ISablierV2LockupDynamic
-/// @notice Creates and manages Lockup streams with dynamic streaming functions.
+/// @notice Creates and manages Lockup streams with a dynamic distribution function.
interface ISablierV2LockupDynamic is ISablierV2Lockup {
/*//////////////////////////////////////////////////////////////////////////
EVENTS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Emitted when a stream is created.
- /// @param streamId The id of the newly created stream.
+ /// @param streamId The ID of the newly created stream.
/// @param funder The address which has funded the stream.
- /// @param sender The address from which to stream the assets, who will have the ability to cancel the stream.
+ /// @param sender The address distributing the assets, which will have the ability to cancel the stream.
/// @param recipient The address toward which to stream the assets.
- /// @param amounts Struct containing (i) the deposit amount, (ii) the protocol fee amount, and (iii) the
- /// broker fee amount, all denoted in units of the asset's decimals.
- /// @param asset The contract address of the ERC-20 asset used for streaming.
+ /// @param amounts Struct containing (i) the deposit amount, and (ii) the broker fee amount, both denoted
+ /// in units of the asset's decimals.
+ /// @param asset The contract address of the ERC-20 asset to be distributed.
/// @param cancelable Boolean indicating whether the stream will be cancelable or not.
/// @param transferable Boolean indicating whether the stream NFT is transferable or not.
- /// @param segments The segments the protocol uses to compose the custom streaming curve.
- /// @param range Struct containing (i) the stream's start time and (ii) end time, both as Unix timestamps.
+ /// @param segments The segments the protocol uses to compose the dynamic distribution function.
+ /// @param timestamps Struct containing (i) the stream's start time and (ii) end time, both as Unix timestamps.
/// @param broker The address of the broker who has helped create the stream, e.g. a front-end website.
event CreateLockupDynamicStream(
uint256 streamId,
@@ -36,7 +36,7 @@ interface ISablierV2LockupDynamic is ISablierV2Lockup {
bool cancelable,
bool transferable,
LockupDynamic.Segment[] segments,
- LockupDynamic.Range range,
+ LockupDynamic.Timestamps timestamps,
address broker
);
@@ -44,90 +44,70 @@ interface ISablierV2LockupDynamic is ISablierV2Lockup {
CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
- /// @notice The maximum number of segments allowed in a stream.
- /// @dev This is initialized at construction time and cannot be changed later.
- function MAX_SEGMENT_COUNT() external view returns (uint256);
-
- /// @notice Retrieves the stream's range, which is a struct containing (i) the stream's start time and (ii) end
- /// time, both as Unix timestamps.
+ /// @notice Retrieves the segments used to compose the dynamic distribution function.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
- function getRange(uint256 streamId) external view returns (LockupDynamic.Range memory range);
-
- /// @notice Retrieves the segments the protocol uses to compose the custom streaming curve.
- /// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function getSegments(uint256 streamId) external view returns (LockupDynamic.Segment[] memory segments);
- /// @notice Retrieves the stream entity.
+ /// @notice Retrieves the full stream details.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
- function getStream(uint256 streamId) external view returns (LockupDynamic.Stream memory stream);
+ /// @param streamId The stream ID for the query.
+ /// @return stream See the documentation in {DataTypes}.
+ function getStream(uint256 streamId) external view returns (LockupDynamic.StreamLD memory stream);
- /// @notice Calculates the amount streamed to the recipient, denoted in units of the asset's decimals.
- ///
- /// When the stream is warm, the streaming function is:
- ///
- /// $$
- /// f(x) = x^{exp} * csa + \Sigma(esa)
- /// $$
- ///
- /// Where:
- ///
- /// - $x$ is the elapsed time divided by the total time in the current segment.
- /// - $exp$ is the current segment exponent.
- /// - $csa$ is the current segment amount.
- /// - $\Sigma(esa)$ is the sum of all elapsed segments' amounts.
- ///
- /// Upon cancellation of the stream, the amount streamed is calculated as the difference between the deposited
- /// amount and the refunded amount. Ultimately, when the stream becomes depleted, the streamed amount is equivalent
- /// to the total amount withdrawn.
- ///
+ /// @notice Retrieves the stream's start and end timestamps.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
- function streamedAmountOf(uint256 streamId) external view returns (uint128 streamedAmount);
+ /// @param streamId The stream ID for the query.
+ /// @return timestamps See the documentation in {DataTypes}.
+ function getTimestamps(uint256 streamId) external view returns (LockupDynamic.Timestamps memory timestamps);
+
+ /// @notice The maximum number of segments allowed in a stream.
+ /// @dev This is initialized at construction time and cannot be changed later.
+ function MAX_SEGMENT_COUNT() external view returns (uint256);
/*//////////////////////////////////////////////////////////////////////////
NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Creates a stream by setting the start time to `block.timestamp`, and the end time to the sum of
- /// `block.timestamp` and all specified time deltas. The segment milestones are derived from these
- /// deltas. The stream is funded by `msg.sender` and is wrapped in an ERC-721 NFT.
+ /// `block.timestamp` and all specified time durations. The segment timestamps are derived from these
+ /// durations. The stream is funded by `msg.sender` and is wrapped in an ERC-721 NFT.
///
/// @dev Emits a {Transfer} and {CreateLockupDynamicStream} event.
///
/// Requirements:
- /// - All requirements in {createWithMilestones} must be met for the calculated parameters.
+ /// - All requirements in {createWithTimestamps} must be met for the calculated parameters.
///
/// @param params Struct encapsulating the function parameters, which are documented in {DataTypes}.
- /// @return streamId The id of the newly created stream.
- function createWithDeltas(LockupDynamic.CreateWithDeltas calldata params) external returns (uint256 streamId);
+ /// @return streamId The ID of the newly created stream.
+ function createWithDurations(LockupDynamic.CreateWithDurations calldata params)
+ external
+ returns (uint256 streamId);
- /// @notice Creates a stream with the provided segment milestones, implying the end time from the last milestone.
+ /// @notice Creates a stream with the provided segment timestamps, implying the end time from the last timestamp.
/// The stream is funded by `msg.sender` and is wrapped in an ERC-721 NFT.
///
/// @dev Emits a {Transfer} and {CreateLockupDynamicStream} event.
///
/// Notes:
- /// - As long as the segment milestones are arranged in ascending order, it is not an error for some
+ /// - As long as the segment timestamps are arranged in ascending order, it is not an error for some
/// of them to be in the past.
///
/// Requirements:
/// - Must not be delegate called.
/// - `params.totalAmount` must be greater than zero.
- /// - If set, `params.broker.fee` must not be greater than `MAX_FEE`.
+ /// - If set, `params.broker.fee` must not be greater than `MAX_BROKER_FEE`.
+ /// - `params.startTime` must be greater than zero and less than the first segment's timestamp.
/// - `params.segments` must have at least one segment, but not more than `MAX_SEGMENT_COUNT`.
- /// - `params.startTime` must be less than the first segment's milestone.
- /// - The segment milestones must be arranged in ascending order.
- /// - The last segment milestone (i.e. the stream's end time) must be in the future.
+ /// - The segment timestamps must be arranged in ascending order.
+ /// - The last segment timestamp (i.e. the stream's end time) must be in the future.
/// - The sum of the segment amounts must equal the deposit amount.
/// - `params.recipient` must not be the zero address.
/// - `msg.sender` must have allowed this contract to spend at least `params.totalAmount` assets.
///
/// @param params Struct encapsulating the function parameters, which are documented in {DataTypes}.
- /// @return streamId The id of the newly created stream.
- function createWithMilestones(LockupDynamic.CreateWithMilestones calldata params)
+ /// @return streamId The ID of the newly created stream.
+ function createWithTimestamps(LockupDynamic.CreateWithTimestamps calldata params)
external
returns (uint256 streamId);
}
diff --git a/src/interfaces/ISablierV2LockupLinear.sol b/src/interfaces/ISablierV2LockupLinear.sol
index be1edebd3..425514c09 100644
--- a/src/interfaces/ISablierV2LockupLinear.sol
+++ b/src/interfaces/ISablierV2LockupLinear.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19;
+pragma solidity >=0.8.22;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
@@ -7,24 +7,24 @@ import { Lockup, LockupLinear } from "../types/DataTypes.sol";
import { ISablierV2Lockup } from "./ISablierV2Lockup.sol";
/// @title ISablierV2LockupLinear
-/// @notice Creates and manages Lockup streams with linear streaming functions.
+/// @notice Creates and manages Lockup streams with a linear distribution function.
interface ISablierV2LockupLinear is ISablierV2Lockup {
/*//////////////////////////////////////////////////////////////////////////
EVENTS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Emitted when a stream is created.
- /// @param streamId The id of the newly created stream.
+ /// @param streamId The ID of the newly created stream.
/// @param funder The address which funded the stream.
- /// @param sender The address streaming the assets, with the ability to cancel the stream.
+ /// @param sender The address distributing the assets, which will have the ability to cancel the stream.
/// @param recipient The address receiving the assets.
- /// @param amounts Struct containing (i) the deposit amount, (ii) the protocol fee amount, and (iii) the
- /// broker fee amount, all denoted in units of the asset's decimals.
- /// @param asset The contract address of the ERC-20 asset used for streaming.
+ /// @param amounts Struct containing (i) the deposit amount, and (ii) the broker fee amount, both denoted
+ /// in units of the asset's decimals.
+ /// @param asset The contract address of the ERC-20 asset to be distributed.
/// @param cancelable Boolean indicating whether the stream will be cancelable or not.
/// @param transferable Boolean indicating whether the stream NFT is transferable or not.
- /// @param range Struct containing (i) the stream's start time, (ii) cliff time, and (iii) end time, all as Unix
- /// timestamps.
+ /// @param timestamps Struct containing (i) the stream's start time, (ii) cliff time, and (iii) end time, all as
+ /// Unix timestamps.
/// @param broker The address of the broker who has helped create the stream, e.g. a front-end website.
event CreateLockupLinearStream(
uint256 streamId,
@@ -35,7 +35,7 @@ interface ISablierV2LockupLinear is ISablierV2Lockup {
IERC20 indexed asset,
bool cancelable,
bool transferable,
- LockupLinear.Range range,
+ LockupLinear.Timestamps timestamps,
address broker
);
@@ -43,43 +43,23 @@ interface ISablierV2LockupLinear is ISablierV2Lockup {
CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
- /// @notice Retrieves the stream's cliff time, which is a Unix timestamp.
+ /// @notice Retrieves the stream's cliff time, which is a Unix timestamp. A value of zero means there
+ /// is no cliff.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
+ /// @param streamId The stream ID for the query.
function getCliffTime(uint256 streamId) external view returns (uint40 cliffTime);
- /// @notice Retrieves the stream's range, which is a struct containing (i) the stream's start time, (ii) cliff
- /// time, and (iii) end time, all as Unix timestamps.
+ /// @notice Retrieves the full stream details.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
- function getRange(uint256 streamId) external view returns (LockupLinear.Range memory range);
+ /// @param streamId The stream ID for the query.
+ /// @return stream See the documentation in {DataTypes}.
+ function getStream(uint256 streamId) external view returns (LockupLinear.StreamLL memory stream);
- /// @notice Retrieves the stream entity.
+ /// @notice Retrieves the stream's start, cliff and end timestamps.
/// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
- function getStream(uint256 streamId) external view returns (LockupLinear.Stream memory stream);
-
- /// @notice Calculates the amount streamed to the recipient, denoted in units of the asset's decimals.
- ///
- /// When the stream is warm, the streaming function is:
- ///
- /// $$
- /// f(x) = x * d + c
- /// $$
- ///
- /// Where:
- ///
- /// - $x$ is the elapsed time divided by the stream's total duration.
- /// - $d$ is the deposited amount.
- /// - $c$ is the cliff amount.
- ///
- /// Upon cancellation of the stream, the amount streamed is calculated as the difference between the deposited
- /// amount and the refunded amount. Ultimately, when the stream becomes depleted, the streamed amount is equivalent
- /// to the total amount withdrawn.
- ///
- /// @dev Reverts if `streamId` references a null stream.
- /// @param streamId The stream id for the query.
- function streamedAmountOf(uint256 streamId) external view returns (uint128 streamedAmount);
+ /// @param streamId The stream ID for the query.
+ /// @return timestamps See the documentation in {DataTypes}.
+ function getTimestamps(uint256 streamId) external view returns (LockupLinear.Timestamps memory timestamps);
/*//////////////////////////////////////////////////////////////////////////
NON-CONSTANT FUNCTIONS
@@ -92,33 +72,37 @@ interface ISablierV2LockupLinear is ISablierV2Lockup {
/// @dev Emits a {Transfer} and {CreateLockupLinearStream} event.
///
/// Requirements:
- /// - All requirements in {createWithRange} must be met for the calculated parameters.
+ /// - All requirements in {createWithTimestamps} must be met for the calculated parameters.
///
/// @param params Struct encapsulating the function parameters, which are documented in {DataTypes}.
- /// @return streamId The id of the newly created stream.
+ /// @return streamId The ID of the newly created stream.
function createWithDurations(LockupLinear.CreateWithDurations calldata params)
external
returns (uint256 streamId);
- /// @notice Creates a stream with the provided start time and end time as the range. The stream is
- /// funded by `msg.sender` and is wrapped in an ERC-721 NFT.
+ /// @notice Creates a stream with the provided start time and end time. The stream is funded by `msg.sender` and is
+ /// wrapped in an ERC-721 NFT.
///
/// @dev Emits a {Transfer} and {CreateLockupLinearStream} event.
///
/// Notes:
+ /// - A cliff time of zero means there is no cliff.
/// - As long as the times are ordered, it is not an error for the start or the cliff time to be in the past.
///
/// Requirements:
/// - Must not be delegate called.
/// - `params.totalAmount` must be greater than zero.
- /// - If set, `params.broker.fee` must not be greater than `MAX_FEE`.
- /// - `params.range.start` must be less than or equal to `params.range.cliff`.
- /// - `params.range.cliff` must be less than `params.range.end`.
- /// - `params.range.end` must be in the future.
+ /// - If set, `params.broker.fee` must not be greater than `MAX_BROKER_FEE`.
+ /// - `params.timestamps.start` must be greater than zero and less than `params.timestamps.end`.
+ /// - If set, `params.timestamps.cliff` must be greater than `params.timestamps.start` and less than
+ /// `params.timestamps.end`.
+ /// - `params.timestamps.end` must be in the future.
/// - `params.recipient` must not be the zero address.
/// - `msg.sender` must have allowed this contract to spend at least `params.totalAmount` assets.
///
/// @param params Struct encapsulating the function parameters, which are documented in {DataTypes}.
- /// @return streamId The id of the newly created stream.
- function createWithRange(LockupLinear.CreateWithRange calldata params) external returns (uint256 streamId);
+ /// @return streamId The ID of the newly created stream.
+ function createWithTimestamps(LockupLinear.CreateWithTimestamps calldata params)
+ external
+ returns (uint256 streamId);
}
diff --git a/src/interfaces/ISablierV2LockupTranched.sol b/src/interfaces/ISablierV2LockupTranched.sol
new file mode 100644
index 000000000..836925ccc
--- /dev/null
+++ b/src/interfaces/ISablierV2LockupTranched.sol
@@ -0,0 +1,113 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity >=0.8.22;
+
+import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+
+import { Lockup, LockupTranched } from "../types/DataTypes.sol";
+import { ISablierV2Lockup } from "./ISablierV2Lockup.sol";
+
+/// @title ISablierV2LockupTranched
+/// @notice Creates and manages Lockup streams with a tranched distribution function.
+interface ISablierV2LockupTranched is ISablierV2Lockup {
+ /*//////////////////////////////////////////////////////////////////////////
+ EVENTS
+ //////////////////////////////////////////////////////////////////////////*/
+
+ /// @notice Emitted when a stream is created.
+ /// @param streamId The ID of the newly created stream.
+ /// @param funder The address which has funded the stream.
+ /// @param sender The address distributing the assets, which will have the ability to cancel the stream.
+ /// @param recipient The address toward which to stream the assets.
+ /// @param amounts Struct containing (i) the deposit amount, and (ii) the broker fee amount, both denoted
+ /// in units of the asset's decimals.
+ /// @param asset The contract address of the ERC-20 asset to be distributed.
+ /// @param cancelable Boolean indicating whether the stream will be cancelable or not.
+ /// @param transferable Boolean indicating whether the stream NFT is transferable or not.
+ /// @param tranches The tranches the protocol uses to compose the tranched distribution function.
+ /// @param timestamps Struct containing (i) the stream's start time and (ii) end time, both as Unix timestamps.
+ /// @param broker The address of the broker who has helped create the stream, e.g. a front-end website.
+ event CreateLockupTranchedStream(
+ uint256 streamId,
+ address funder,
+ address indexed sender,
+ address indexed recipient,
+ Lockup.CreateAmounts amounts,
+ IERC20 indexed asset,
+ bool cancelable,
+ bool transferable,
+ LockupTranched.Tranche[] tranches,
+ LockupTranched.Timestamps timestamps,
+ address broker
+ );
+
+ /*//////////////////////////////////////////////////////////////////////////
+ CONSTANT FUNCTIONS
+ //////////////////////////////////////////////////////////////////////////*/
+
+ /// @notice Retrieves the full stream details.
+ /// @dev Reverts if `streamId` references a null stream.
+ /// @param streamId The stream ID for the query.
+ /// @return stream See the documentation in {DataTypes}.
+ function getStream(uint256 streamId) external view returns (LockupTranched.StreamLT memory stream);
+
+ /// @notice Retrieves the stream's start and end timestamps.
+ /// @dev Reverts if `streamId` references a null stream.
+ /// @param streamId The stream ID for the query.
+ /// @return timestamps See the documentation in {DataTypes}.
+ function getTimestamps(uint256 streamId) external view returns (LockupTranched.Timestamps memory timestamps);
+
+ /// @notice Retrieves the tranches used to compose the tranched distribution function.
+ /// @dev Reverts if `streamId` references a null stream.
+ /// @param streamId The stream ID for the query.
+ function getTranches(uint256 streamId) external view returns (LockupTranched.Tranche[] memory tranches);
+
+ /// @notice The maximum number of tranches allowed in a stream.
+ /// @dev This is initialized at construction time and cannot be changed later.
+ function MAX_TRANCHE_COUNT() external view returns (uint256);
+
+ /*//////////////////////////////////////////////////////////////////////////
+ NON-CONSTANT FUNCTIONS
+ //////////////////////////////////////////////////////////////////////////*/
+
+ /// @notice Creates a stream by setting the start time to `block.timestamp`, and the end time to the sum of
+ /// `block.timestamp` and all specified time durations. The tranche timestamps are derived from these
+ /// durations. The stream is funded by `msg.sender` and is wrapped in an ERC-721 NFT.
+ ///
+ /// @dev Emits a {Transfer} and {CreateLockupTrancheStream} event.
+ ///
+ /// Requirements:
+ /// - All requirements in {createWithTimestamps} must be met for the calculated parameters.
+ ///
+ /// @param params Struct encapsulating the function parameters, which are documented in {DataTypes}.
+ /// @return streamId The ID of the newly created stream.
+ function createWithDurations(LockupTranched.CreateWithDurations calldata params)
+ external
+ returns (uint256 streamId);
+
+ /// @notice Creates a stream with the provided tranche timestamps, implying the end time from the last timestamp.
+ /// The stream is funded by `msg.sender` and is wrapped in an ERC-721 NFT.
+ ///
+ /// @dev Emits a {Transfer} and {CreateLockupTrancheStream} event.
+ ///
+ /// Notes:
+ /// - As long as the tranche timestamps are arranged in ascending order, it is not an error for some
+ /// of them to be in the past.
+ ///
+ /// Requirements:
+ /// - Must not be delegate called.
+ /// - `params.totalAmount` must be greater than zero.
+ /// - If set, `params.broker.fee` must not be greater than `MAX_BROKER_FEE`.
+ /// - `params.startTime` must be greater than zero and less than the first tranche's timestamp.
+ /// - `params.tranches` must have at least one tranche, but not more than `MAX_TRANCHE_COUNT`.
+ /// - The tranche timestamps must be arranged in ascending order.
+ /// - The last tranche timestamp (i.e. the stream's end time) must be in the future.
+ /// - The sum of the tranche amounts must equal the deposit amount.
+ /// - `params.recipient` must not be the zero address.
+ /// - `msg.sender` must have allowed this contract to spend at least `params.totalAmount` assets.
+ ///
+ /// @param params Struct encapsulating the function parameters, which are documented in {DataTypes}.
+ /// @return streamId The ID of the newly created stream.
+ function createWithTimestamps(LockupTranched.CreateWithTimestamps calldata params)
+ external
+ returns (uint256 streamId);
+}
diff --git a/src/interfaces/ISablierV2NFTDescriptor.sol b/src/interfaces/ISablierV2NFTDescriptor.sol
index b3bb98864..f0d134cb8 100644
--- a/src/interfaces/ISablierV2NFTDescriptor.sol
+++ b/src/interfaces/ISablierV2NFTDescriptor.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19;
+pragma solidity >=0.8.22;
import { IERC721Metadata } from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol";
@@ -10,7 +10,7 @@ interface ISablierV2NFTDescriptor {
/// @notice Produces the URI describing a particular stream NFT.
/// @dev This is a data URI with the JSON contents directly inlined.
/// @param sablier The address of the Sablier contract the stream was created in.
- /// @param streamId The id of the stream for which to produce a description.
+ /// @param streamId The ID of the stream for which to produce a description.
/// @return uri The URI of the ERC721-compliant metadata.
function tokenURI(IERC721Metadata sablier, uint256 streamId) external view returns (string memory uri);
}
diff --git a/src/interfaces/erc3156/IERC3156FlashBorrower.sol b/src/interfaces/erc3156/IERC3156FlashBorrower.sol
deleted file mode 100644
index d065ba3c3..000000000
--- a/src/interfaces/erc3156/IERC3156FlashBorrower.sol
+++ /dev/null
@@ -1,17 +0,0 @@
-// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19;
-
-/// @title IERC3156FlashBorrower
-/// @notice Interface for ERC-3156 flash borrowers.
-/// @dev See https://eips.ethereum.org/EIPS/eip-3156.
-interface IERC3156FlashBorrower {
- function onFlashLoan(
- address initiator,
- address asset,
- uint256 amount,
- uint256 fee,
- bytes calldata data
- )
- external
- returns (bytes32);
-}
diff --git a/src/interfaces/erc3156/IERC3156FlashLender.sol b/src/interfaces/erc3156/IERC3156FlashLender.sol
deleted file mode 100644
index bfecc2757..000000000
--- a/src/interfaces/erc3156/IERC3156FlashLender.sol
+++ /dev/null
@@ -1,22 +0,0 @@
-// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19;
-
-import { IERC3156FlashBorrower } from "./IERC3156FlashBorrower.sol";
-
-/// @title IERC3156FlashLender
-/// @notice Interface for ERC-3156 flash lenders.
-/// @dev See https://eips.ethereum.org/EIPS/eip-3156.
-interface IERC3156FlashLender {
- function maxFlashLoan(address asset) external view returns (uint256);
-
- function flashFee(address asset, uint256 amount) external view returns (uint256);
-
- function flashLoan(
- IERC3156FlashBorrower receiver,
- address asset,
- uint256 amount,
- bytes calldata data
- )
- external
- returns (bool);
-}
diff --git a/src/interfaces/hooks/ISablierV2LockupRecipient.sol b/src/interfaces/hooks/ISablierV2LockupRecipient.sol
deleted file mode 100644
index 2e5e3c04b..000000000
--- a/src/interfaces/hooks/ISablierV2LockupRecipient.sol
+++ /dev/null
@@ -1,46 +0,0 @@
-// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19;
-
-/// @title ISablierV2LockupRecipient
-/// @notice Interface for recipient contracts capable of reacting to cancellations, renouncements, and withdrawals.
-/// @dev Implementation of this interface is optional. If a recipient contract doesn't implement this
-/// interface or implements it partially, function execution will not revert.
-interface ISablierV2LockupRecipient {
- /// @notice Responds to sender-triggered cancellations.
- ///
- /// @dev Notes:
- /// - This function may revert, but the Sablier contract will ignore the revert.
- ///
- /// @param streamId The id of the canceled stream.
- /// @param sender The stream's sender, who canceled the stream.
- /// @param senderAmount The amount of assets refunded to the stream's sender, denoted in units of the asset's
- /// decimals.
- /// @param recipientAmount The amount of assets left for the stream's recipient to withdraw, denoted in units of
- /// the asset's decimals.
- function onStreamCanceled(
- uint256 streamId,
- address sender,
- uint128 senderAmount,
- uint128 recipientAmount
- )
- external;
-
- /// @notice Responds to renouncements.
- ///
- /// @dev Notes:
- /// - This function may revert, but the Sablier contract will ignore the revert.
- ///
- /// @param streamId The id of the renounced stream.
- function onStreamRenounced(uint256 streamId) external;
-
- /// @notice Responds to withdrawals triggered by either the stream's sender or an approved third party.
- ///
- /// @dev Notes:
- /// - This function may revert, but the Sablier contract will ignore the revert.
- ///
- /// @param streamId The id of the stream being withdrawn from.
- /// @param caller The original `msg.sender` address that triggered the withdrawal.
- /// @param to The address receiving the withdrawn assets.
- /// @param amount The amount of assets withdrawn, denoted in units of the asset's decimals.
- function onStreamWithdrawn(uint256 streamId, address caller, address to, uint128 amount) external;
-}
diff --git a/src/libraries/Errors.sol b/src/libraries/Errors.sol
index 147cf9d1a..03e6c8e05 100644
--- a/src/libraries/Errors.sol
+++ b/src/libraries/Errors.sol
@@ -1,7 +1,6 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19;
+pragma solidity >=0.8.22;
-import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { IERC721Metadata } from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol";
import { UD60x18 } from "@prb/math/src/UD60x18.sol";
@@ -19,55 +18,38 @@ library Errors {
error DelegateCall();
/*//////////////////////////////////////////////////////////////////////////
- SABLIER-V2-BASE
- //////////////////////////////////////////////////////////////////////////*/
-
- /// @notice Thrown when trying to claim protocol revenues for an asset with no accrued revenues.
- error SablierV2Base_NoProtocolRevenues(IERC20 asset);
-
- /*//////////////////////////////////////////////////////////////////////////
- SABLIER-V2-FLASH-LOAN
+ SABLIER-V2-LOCKUP
//////////////////////////////////////////////////////////////////////////*/
- /// @notice Thrown when trying to flash loan an unsupported asset.
- error SablierV2FlashLoan_AssetNotFlashLoanable(IERC20 asset);
-
- /// @notice Thrown when trying to flash loan an amount greater than or equal to 2^128.
- error SablierV2FlashLoan_AmountTooHigh(uint256 amount);
-
- /// @notice Thrown when the calculated fee during a flash loan is greater than or equal to 2^128.
- error SablierV2FlashLoan_CalculatedFeeTooHigh(uint256 amount);
+ /// @notice Thrown when trying to allow to hook a contract that doesn't implement the interface correctly.
+ error SablierV2Lockup_AllowToHookUnsupportedInterface(address recipient);
- /// @notice Thrown when the callback to the flash borrower fails.
- error SablierV2FlashLoan_FlashBorrowFail();
-
- /*//////////////////////////////////////////////////////////////////////////
- SABLIER-V2-LOCKUP
- //////////////////////////////////////////////////////////////////////////*/
+ /// @notice Thrown when trying to allow to hook an address with no code.
+ error SablierV2Lockup_AllowToHookZeroCodeSize(address recipient);
/// @notice Thrown when the broker fee exceeds the maximum allowed fee.
- error SablierV2Lockup_BrokerFeeTooHigh(UD60x18 brokerFee, UD60x18 maxFee);
+ error SablierV2Lockup_BrokerFeeTooHigh(UD60x18 brokerFee, UD60x18 maxBrokerFee);
/// @notice Thrown when trying to create a stream with a zero deposit amount.
error SablierV2Lockup_DepositAmountZero();
/// @notice Thrown when trying to create a stream with an end time not in the future.
- error SablierV2Lockup_EndTimeNotInTheFuture(uint40 currentTime, uint40 endTime);
+ error SablierV2Lockup_EndTimeNotInTheFuture(uint40 blockTimestamp, uint40 endTime);
- /// @notice Thrown when the stream's sender tries to withdraw to an address other than the recipient's.
- error SablierV2Lockup_InvalidSenderWithdrawal(uint256 streamId, address sender, address to);
+ /// @notice Thrown when the hook does not return the correct selector.
+ error SablierV2Lockup_InvalidHookSelector(address recipient);
/// @notice Thrown when trying to transfer Stream NFT when transferability is disabled.
error SablierV2Lockup_NotTransferable(uint256 tokenId);
- /// @notice Thrown when the id references a null stream.
+ /// @notice Thrown when the ID references a null stream.
error SablierV2Lockup_Null(uint256 streamId);
/// @notice Thrown when trying to withdraw an amount greater than the withdrawable amount.
error SablierV2Lockup_Overdraw(uint256 streamId, uint128 amount, uint128 withdrawableAmount);
- /// @notice Thrown when the protocol fee exceeds the maximum allowed fee.
- error SablierV2Lockup_ProtocolFeeTooHigh(UD60x18 protocolFee, UD60x18 maxFee);
+ /// @notice Thrown when trying to create a stream with a zero start time.
+ error SablierV2Lockup_StartTimeZero();
/// @notice Thrown when trying to cancel or renounce a canceled stream.
error SablierV2Lockup_StreamCanceled(uint256 streamId);
@@ -87,15 +69,18 @@ library Errors {
/// @notice Thrown when `msg.sender` lacks authorization to perform an action.
error SablierV2Lockup_Unauthorized(uint256 streamId, address caller);
+ /// @notice Thrown when trying to withdraw to an address other than the recipient's.
+ error SablierV2Lockup_WithdrawalAddressNotRecipient(uint256 streamId, address caller, address to);
+
/// @notice Thrown when trying to withdraw zero assets from a stream.
error SablierV2Lockup_WithdrawAmountZero(uint256 streamId);
- /// @notice Thrown when trying to withdraw from multiple streams and the number of stream ids does
+ /// @notice Thrown when trying to withdraw from multiple streams and the number of stream IDs does
/// not match the number of withdraw amounts.
error SablierV2Lockup_WithdrawArrayCountsNotEqual(uint256 streamIdsCount, uint256 amountsCount);
/// @notice Thrown when trying to withdraw to the zero address.
- error SablierV2Lockup_WithdrawToZeroAddress();
+ error SablierV2Lockup_WithdrawToZeroAddress(uint256 streamId);
/*//////////////////////////////////////////////////////////////////////////
SABLIER-V2-LOCKUP-DYNAMIC
@@ -113,15 +98,15 @@ library Errors {
/// @notice Thrown when trying to create a stream with no segments.
error SablierV2LockupDynamic_SegmentCountZero();
- /// @notice Thrown when trying to create a stream with unordered segment milestones.
- error SablierV2LockupDynamic_SegmentMilestonesNotOrdered(
- uint256 index, uint40 previousMilestone, uint40 currentMilestone
+ /// @notice Thrown when trying to create a stream with unordered segment timestamps.
+ error SablierV2LockupDynamic_SegmentTimestampsNotOrdered(
+ uint256 index, uint40 previousTimestamp, uint40 currentTimestamp
);
/// @notice Thrown when trying to create a stream with a start time not strictly less than the first
- /// segment milestone.
- error SablierV2LockupDynamic_StartTimeNotLessThanFirstSegmentMilestone(
- uint40 startTime, uint40 firstSegmentMilestone
+ /// segment timestamp.
+ error SablierV2LockupDynamic_StartTimeNotLessThanFirstSegmentTimestamp(
+ uint40 startTime, uint40 firstSegmentTimestamp
);
/*//////////////////////////////////////////////////////////////////////////
@@ -131,8 +116,12 @@ library Errors {
/// @notice Thrown when trying to create a stream with a cliff time not strictly less than the end time.
error SablierV2LockupLinear_CliffTimeNotLessThanEndTime(uint40 cliffTime, uint40 endTime);
- /// @notice Thrown when trying to create a stream with a start time greater than the cliff time.
- error SablierV2LockupLinear_StartTimeGreaterThanCliffTime(uint40 startTime, uint40 cliffTime);
+ /// @notice Thrown when trying to create a stream with a start time not strictly less than the cliff time, when the
+ /// cliff time does not have a zero value.
+ error SablierV2LockupLinear_StartTimeNotLessThanCliffTime(uint40 startTime, uint40 cliffTime);
+
+ /// @notice Thrown when trying to create a stream with a start time not strictly less than the end time.
+ error SablierV2LockupLinear_StartTimeNotLessThanEndTime(uint40 startTime, uint40 endTime);
/*//////////////////////////////////////////////////////////////////////////
SABLIER-V2-NFT-DESCRIPTOR
@@ -140,4 +129,31 @@ library Errors {
/// @notice Thrown when trying to generate the token URI for an unknown ERC-721 NFT contract.
error SablierV2NFTDescriptor_UnknownNFT(IERC721Metadata nft, string symbol);
+
+ /*//////////////////////////////////////////////////////////////////////////
+ SABLIER-V2-LOCKUP-TRANCHE
+ //////////////////////////////////////////////////////////////////////////*/
+
+ /// @notice Thrown when trying to create a stream with a deposit amount not equal to the sum of the
+ /// tranche amounts.
+ error SablierV2LockupTranched_DepositAmountNotEqualToTrancheAmountsSum(
+ uint128 depositAmount, uint128 trancheAmountsSum
+ );
+
+ /// @notice Thrown when trying to create a stream with a start time not strictly less than the first
+ /// tranche timestamp.
+ error SablierV2LockupTranched_StartTimeNotLessThanFirstTrancheTimestamp(
+ uint40 startTime, uint40 firstTrancheTimestamp
+ );
+
+ /// @notice Thrown when trying to create a stream with more tranches than the maximum allowed.
+ error SablierV2LockupTranched_TrancheCountTooHigh(uint256 count);
+
+ /// @notice Thrown when trying to create a stream with no tranches.
+ error SablierV2LockupTranched_TrancheCountZero();
+
+ /// @notice Thrown when trying to create a stream with unordered tranche timestamps.
+ error SablierV2LockupTranched_TrancheTimestampsNotOrdered(
+ uint256 index, uint40 previousTimestamp, uint40 currentTimestamp
+ );
}
diff --git a/src/libraries/Helpers.sol b/src/libraries/Helpers.sol
index a0c195fb5..d4bd40b48 100644
--- a/src/libraries/Helpers.sol
+++ b/src/libraries/Helpers.sol
@@ -1,9 +1,9 @@
// SPDX-License-Identifier: BUSL-1.1
-pragma solidity >=0.8.19;
+pragma solidity >=0.8.22;
import { UD60x18, ud } from "@prb/math/src/UD60x18.sol";
-import { Lockup, LockupDynamic, LockupLinear } from "../types/DataTypes.sol";
+import { Lockup, LockupDynamic, LockupLinear, LockupTranched } from "../types/DataTypes.sol";
import { Errors } from "./Errors.sol";
/// @title Helpers
@@ -13,50 +13,102 @@ library Helpers {
INTERNAL CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
- /// @dev Checks that neither fee is greater than `maxFee`, and then calculates the protocol fee amount, the
- /// broker fee amount, and the deposit amount from the total amount.
- function checkAndCalculateFees(
+ /// @dev Calculate the timestamps and return the segments.
+ function calculateSegmentTimestamps(LockupDynamic.SegmentWithDuration[] memory segments)
+ internal
+ view
+ returns (LockupDynamic.Segment[] memory segmentsWithTimestamps)
+ {
+ uint256 segmentCount = segments.length;
+ segmentsWithTimestamps = new LockupDynamic.Segment[](segmentCount);
+
+ // Make the block timestamp the stream's start time.
+ uint40 startTime = uint40(block.timestamp);
+
+ // It is safe to use unchecked arithmetic because {SablierV2LockupDynamic-_create} will nonetheless check the
+ // correctness of the calculated segment timestamps.
+ unchecked {
+ // The first segment is precomputed because it is needed in the for loop below.
+ segmentsWithTimestamps[0] = LockupDynamic.Segment({
+ amount: segments[0].amount,
+ exponent: segments[0].exponent,
+ timestamp: startTime + segments[0].duration
+ });
+
+ // Copy the segment amounts and exponents, and calculate the segment timestamps.
+ for (uint256 i = 1; i < segmentCount; ++i) {
+ segmentsWithTimestamps[i] = LockupDynamic.Segment({
+ amount: segments[i].amount,
+ exponent: segments[i].exponent,
+ timestamp: segmentsWithTimestamps[i - 1].timestamp + segments[i].duration
+ });
+ }
+ }
+ }
+
+ /// @dev Calculate the timestamps and return the tranches.
+ function calculateTrancheTimestamps(LockupTranched.TrancheWithDuration[] memory tranches)
+ internal
+ view
+ returns (LockupTranched.Tranche[] memory tranchesWithTimestamps)
+ {
+ uint256 trancheCount = tranches.length;
+ tranchesWithTimestamps = new LockupTranched.Tranche[](trancheCount);
+
+ // Make the block timestamp the stream's start time.
+ uint40 startTime = uint40(block.timestamp);
+
+ // It is safe to use unchecked arithmetic because {SablierV2LockupTranched-_create} will nonetheless check the
+ // correctness of the calculated tranche timestamps.
+ unchecked {
+ // The first tranche is precomputed because it is needed in the for loop below.
+ tranchesWithTimestamps[0] =
+ LockupTranched.Tranche({ amount: tranches[0].amount, timestamp: startTime + tranches[0].duration });
+
+ // Copy the tranche amounts and calculate the tranche timestamps.
+ for (uint256 i = 1; i < trancheCount; ++i) {
+ tranchesWithTimestamps[i] = LockupTranched.Tranche({
+ amount: tranches[i].amount,
+ timestamp: tranchesWithTimestamps[i - 1].timestamp + tranches[i].duration
+ });
+ }
+ }
+ }
+
+ /// @dev Checks the broker fee is not greater than `maxBrokerFee`, and then calculates the broker fee amount and the
+ /// deposit amount from the total amount.
+ function checkAndCalculateBrokerFee(
uint128 totalAmount,
- UD60x18 protocolFee,
UD60x18 brokerFee,
- UD60x18 maxFee
+ UD60x18 maxBrokerFee
)
internal
pure
returns (Lockup.CreateAmounts memory amounts)
{
- // When the total amount is zero, the fees are also zero.
+ // When the total amount is zero, the broker fee is also zero.
if (totalAmount == 0) {
- return Lockup.CreateAmounts(0, 0, 0);
+ return Lockup.CreateAmounts(0, 0);
}
- // Checks: the protocol fee is not greater than `maxFee`.
- if (protocolFee.gt(maxFee)) {
- revert Errors.SablierV2Lockup_ProtocolFeeTooHigh(protocolFee, maxFee);
- }
- // Checks: the broker fee is not greater than `maxFee`.
- if (brokerFee.gt(maxFee)) {
- revert Errors.SablierV2Lockup_BrokerFeeTooHigh(brokerFee, maxFee);
+ // Check: the broker fee is not greater than `maxBrokerFee`.
+ if (brokerFee.gt(maxBrokerFee)) {
+ revert Errors.SablierV2Lockup_BrokerFeeTooHigh(brokerFee, maxBrokerFee);
}
- // Calculate the protocol fee amount.
- // The cast to uint128 is safe because the maximum fee is hard coded.
- amounts.protocolFee = uint128(ud(totalAmount).mul(protocolFee).intoUint256());
-
// Calculate the broker fee amount.
// The cast to uint128 is safe because the maximum fee is hard coded.
amounts.brokerFee = uint128(ud(totalAmount).mul(brokerFee).intoUint256());
- // Assert that the total amount is strictly greater than the sum of the protocol fee amount and the
- // broker fee amount.
- assert(totalAmount > amounts.protocolFee + amounts.brokerFee);
+ // Assert that the total amount is strictly greater than the broker fee amount.
+ assert(totalAmount > amounts.brokerFee);
- // Calculate the deposit amount (the amount to stream, net of fees).
- amounts.deposit = totalAmount - amounts.protocolFee - amounts.brokerFee;
+ // Calculate the deposit amount (the amount to stream, net of the broker fee).
+ amounts.deposit = totalAmount - amounts.brokerFee;
}
- /// @dev Checks the parameters of the {SablierV2LockupDynamic-_createWithMilestones} function.
- function checkCreateWithMilestones(
+ /// @dev Checks the parameters of the {SablierV2LockupDynamic-_create} function.
+ function checkCreateLockupDynamic(
uint128 depositAmount,
LockupDynamic.Segment[] memory segments,
uint256 maxSegmentCount,
@@ -65,81 +117,101 @@ library Helpers {
internal
view
{
- // Checks: the deposit amount is not zero.
+ // Check: the deposit amount is not zero.
if (depositAmount == 0) {
revert Errors.SablierV2Lockup_DepositAmountZero();
}
- // Checks: the segment count is not zero.
+ // Check: the start time is not zero.
+ if (startTime == 0) {
+ revert Errors.SablierV2Lockup_StartTimeZero();
+ }
+
+ // Check: the segment count is not zero.
uint256 segmentCount = segments.length;
if (segmentCount == 0) {
revert Errors.SablierV2LockupDynamic_SegmentCountZero();
}
- // Checks: the segment count is not greater than the maximum allowed.
+ // Check: the segment count is not greater than the maximum allowed.
if (segmentCount > maxSegmentCount) {
revert Errors.SablierV2LockupDynamic_SegmentCountTooHigh(segmentCount);
}
- // Checks: requirements of segments variables.
+ // Check: requirements of segments.
_checkSegments(segments, depositAmount, startTime);
}
- /// @dev Checks the parameters of the {SablierV2LockupLinear-_createWithRange} function.
- function checkCreateWithRange(uint128 depositAmount, LockupLinear.Range memory range) internal view {
- // Checks: the deposit amount is not zero.
+ /// @dev Checks the parameters of the {SablierV2LockupLinear-_create} function.
+ function checkCreateLockupLinear(uint128 depositAmount, LockupLinear.Timestamps memory timestamps) internal view {
+ // Check: the deposit amount is not zero.
if (depositAmount == 0) {
revert Errors.SablierV2Lockup_DepositAmountZero();
}
- // Checks: the start time is less than or equal to the cliff time.
- if (range.start > range.cliff) {
- revert Errors.SablierV2LockupLinear_StartTimeGreaterThanCliffTime(range.start, range.cliff);
+ // Check: the start time is not zero.
+ if (timestamps.start == 0) {
+ revert Errors.SablierV2Lockup_StartTimeZero();
}
- // Checks: the cliff time is strictly less than the end time.
- if (range.cliff >= range.end) {
- revert Errors.SablierV2LockupLinear_CliffTimeNotLessThanEndTime(range.cliff, range.end);
+ // Since a cliff time of zero means there is no cliff, the following checks are performed only if it's not zero.
+ if (timestamps.cliff > 0) {
+ // Check: the start time is strictly less than the cliff time.
+ if (timestamps.start >= timestamps.cliff) {
+ revert Errors.SablierV2LockupLinear_StartTimeNotLessThanCliffTime(timestamps.start, timestamps.cliff);
+ }
+
+ // Check: the cliff time is strictly less than the end time.
+ if (timestamps.cliff >= timestamps.end) {
+ revert Errors.SablierV2LockupLinear_CliffTimeNotLessThanEndTime(timestamps.cliff, timestamps.end);
+ }
}
- // Checks: the end time is in the future.
- uint40 currentTime = uint40(block.timestamp);
- if (currentTime >= range.end) {
- revert Errors.SablierV2Lockup_EndTimeNotInTheFuture(currentTime, range.end);
+ // Check: the start time is strictly less than the end time.
+ if (timestamps.start >= timestamps.end) {
+ revert Errors.SablierV2LockupLinear_StartTimeNotLessThanEndTime(timestamps.start, timestamps.end);
+ }
+
+ // Check: the end time is in the future.
+ uint40 blockTimestamp = uint40(block.timestamp);
+ if (blockTimestamp >= timestamps.end) {
+ revert Errors.SablierV2Lockup_EndTimeNotInTheFuture(blockTimestamp, timestamps.end);
}
}
- /// @dev Checks that the segment array counts match, and then adjusts the segments by calculating the milestones.
- function checkDeltasAndCalculateMilestones(LockupDynamic.SegmentWithDelta[] memory segments)
+ /// @dev Checks the parameters of the {SablierV2LockupTranched-_create} function.
+ function checkCreateLockupTranched(
+ uint128 depositAmount,
+ LockupTranched.Tranche[] memory tranches,
+ uint256 maxTrancheCount,
+ uint40 startTime
+ )
internal
view
- returns (LockupDynamic.Segment[] memory segmentsWithMilestones)
{
- uint256 segmentCount = segments.length;
- segmentsWithMilestones = new LockupDynamic.Segment[](segmentCount);
+ // Check: the deposit amount is not zero.
+ if (depositAmount == 0) {
+ revert Errors.SablierV2Lockup_DepositAmountZero();
+ }
- // Make the current time the stream's start time.
- uint40 startTime = uint40(block.timestamp);
+ // Check: the start time is not zero.
+ if (startTime == 0) {
+ revert Errors.SablierV2Lockup_StartTimeZero();
+ }
- // It is safe to use unchecked arithmetic because {_createWithMilestone} will nonetheless check the soundness
- // of the calculated segment milestones.
- unchecked {
- // Precompute the first segment because of the need to add the start time to the first segment delta.
- segmentsWithMilestones[0] = LockupDynamic.Segment({
- amount: segments[0].amount,
- exponent: segments[0].exponent,
- milestone: startTime + segments[0].delta
- });
+ // Check: the tranche count is not zero.
+ uint256 trancheCount = tranches.length;
+ if (trancheCount == 0) {
+ revert Errors.SablierV2LockupTranched_TrancheCountZero();
+ }
- // Copy the segment amounts and exponents, and calculate the segment milestones.
- for (uint256 i = 1; i < segmentCount; ++i) {
- segmentsWithMilestones[i] = LockupDynamic.Segment({
- amount: segments[i].amount,
- exponent: segments[i].exponent,
- milestone: segmentsWithMilestones[i - 1].milestone + segments[i].delta
- });
- }
+ // Check: the tranche count is not greater than the maximum allowed.
+ if (trancheCount > maxTrancheCount) {
+ revert Errors.SablierV2LockupTranched_TrancheCountTooHigh(trancheCount);
}
+
+ // Check: requirements of tranches.
+ _checkTranches(tranches, depositAmount, startTime);
}
/*//////////////////////////////////////////////////////////////////////////
@@ -148,9 +220,9 @@ library Helpers {
/// @dev Checks that:
///
- /// 1. The first milestone is strictly greater than the start time.
- /// 2. The milestones are ordered chronologically.
- /// 3. There are no duplicate milestones.
+ /// 1. The first timestamp is strictly greater than the start time.
+ /// 2. The timestamps are ordered chronologically.
+ /// 3. There are no duplicate timestamps.
/// 4. The deposit amount is equal to the sum of all segment amounts.
function _checkSegments(
LockupDynamic.Segment[] memory segments,
@@ -160,56 +232,115 @@ library Helpers {
private
view
{
- // Checks: the start time is strictly less than the first segment milestone.
- if (startTime >= segments[0].milestone) {
- revert Errors.SablierV2LockupDynamic_StartTimeNotLessThanFirstSegmentMilestone(
- startTime, segments[0].milestone
+ // Check: the start time is strictly less than the first segment timestamp.
+ if (startTime >= segments[0].timestamp) {
+ revert Errors.SablierV2LockupDynamic_StartTimeNotLessThanFirstSegmentTimestamp(
+ startTime, segments[0].timestamp
);
}
// Pre-declare the variables needed in the for loop.
uint128 segmentAmountsSum;
- uint40 currentMilestone;
- uint40 previousMilestone;
+ uint40 currentSegmentTimestamp;
+ uint40 previousSegmentTimestamp;
// Iterate over the segments to:
//
// 1. Calculate the sum of all segment amounts.
- // 2. Check that the milestones are ordered.
+ // 2. Check that the timestamps are ordered.
uint256 count = segments.length;
- for (uint256 index = 0; index < count;) {
+ for (uint256 index = 0; index < count; ++index) {
// Add the current segment amount to the sum.
segmentAmountsSum += segments[index].amount;
- // Checks: the current milestone is strictly greater than the previous milestone.
- currentMilestone = segments[index].milestone;
- if (currentMilestone <= previousMilestone) {
- revert Errors.SablierV2LockupDynamic_SegmentMilestonesNotOrdered(
- index, previousMilestone, currentMilestone
+ // Check: the current timestamp is strictly greater than the previous timestamp.
+ currentSegmentTimestamp = segments[index].timestamp;
+ if (currentSegmentTimestamp <= previousSegmentTimestamp) {
+ revert Errors.SablierV2LockupDynamic_SegmentTimestampsNotOrdered(
+ index, previousSegmentTimestamp, currentSegmentTimestamp
);
}
- // Make the current milestone the previous milestone of the next loop iteration.
- previousMilestone = currentMilestone;
-
- // Increment the loop iterator.
- unchecked {
- index += 1;
- }
+ // Make the current timestamp the previous timestamp of the next loop iteration.
+ previousSegmentTimestamp = currentSegmentTimestamp;
}
- // Checks: the last milestone is in the future.
- // When the loop exits, the current milestone is the last milestone, i.e. the stream's end time.
- uint40 currentTime = uint40(block.timestamp);
- if (currentTime >= currentMilestone) {
- revert Errors.SablierV2Lockup_EndTimeNotInTheFuture(currentTime, currentMilestone);
+ // Check: the last timestamp is in the future.
+ // When the loop exits, the current segment's timestamp is the last segment's timestamp, i.e. the stream's end
+ // time. The variable is not renamed for gas efficiency purposes.
+ uint40 blockTimestamp = uint40(block.timestamp);
+ if (blockTimestamp >= currentSegmentTimestamp) {
+ revert Errors.SablierV2Lockup_EndTimeNotInTheFuture(blockTimestamp, currentSegmentTimestamp);
}
- // Checks: the deposit amount is equal to the segment amounts sum.
+ // Check: the deposit amount is equal to the segment amounts sum.
if (depositAmount != segmentAmountsSum) {
revert Errors.SablierV2LockupDynamic_DepositAmountNotEqualToSegmentAmountsSum(
depositAmount, segmentAmountsSum
);
}
}
+
+ /// @dev Checks that:
+ ///
+ /// 1. The first timestamp is strictly greater than the start time.
+ /// 2. The timestamps are ordered chronologically.
+ /// 3. There are no duplicate timestamps.
+ /// 4. The deposit amount is equal to the sum of all tranche amounts.
+ function _checkTranches(
+ LockupTranched.Tranche[] memory tranches,
+ uint128 depositAmount,
+ uint40 startTime
+ )
+ private
+ view
+ {
+ // Check: the start time is strictly less than the first tranche timestamp.
+ if (startTime >= tranches[0].timestamp) {
+ revert Errors.SablierV2LockupTranched_StartTimeNotLessThanFirstTrancheTimestamp(
+ startTime, tranches[0].timestamp
+ );
+ }
+
+ // Pre-declare the variables needed in the for loop.
+ uint128 trancheAmountsSum;
+ uint40 currentTrancheTimestamp;
+ uint40 previousTrancheTimestamp;
+
+ // Iterate over the tranches to:
+ //
+ // 1. Calculate the sum of all tranche amounts.
+ // 2. Check that the timestamps are ordered.
+ uint256 count = tranches.length;
+ for (uint256 index = 0; index < count; ++index) {
+ // Add the current tranche amount to the sum.
+ trancheAmountsSum += tranches[index].amount;
+
+ // Check: the current timestamp is strictly greater than the previous timestamp.
+ currentTrancheTimestamp = tranches[index].timestamp;
+ if (currentTrancheTimestamp <= previousTrancheTimestamp) {
+ revert Errors.SablierV2LockupTranched_TrancheTimestampsNotOrdered(
+ index, previousTrancheTimestamp, currentTrancheTimestamp
+ );
+ }
+
+ // Make the current timestamp the previous timestamp of the next loop iteration.
+ previousTrancheTimestamp = currentTrancheTimestamp;
+ }
+
+ // Check: the last timestamp is in the future.
+ // When the loop exits, the current tranche's timestamp is the last tranche's timestamp, i.e. the stream's end
+ // time. The variable is not renamed for gas efficiency purposes.
+ uint40 blockTimestamp = uint40(block.timestamp);
+ if (blockTimestamp >= currentTrancheTimestamp) {
+ revert Errors.SablierV2Lockup_EndTimeNotInTheFuture(blockTimestamp, currentTrancheTimestamp);
+ }
+
+ // Check: the deposit amount is equal to the tranche amounts sum.
+ if (depositAmount != trancheAmountsSum) {
+ revert Errors.SablierV2LockupTranched_DepositAmountNotEqualToTrancheAmountsSum(
+ depositAmount, trancheAmountsSum
+ );
+ }
+ }
}
diff --git a/src/libraries/NFTSVG.sol b/src/libraries/NFTSVG.sol
index 807b03e3b..0cfa05c0f 100644
--- a/src/libraries/NFTSVG.sol
+++ b/src/libraries/NFTSVG.sol
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: GPL-3.0-or-later
// solhint-disable quotes
-pragma solidity >=0.8.19;
+pragma solidity >=0.8.22;
import { Strings } from "@openzeppelin/contracts/utils/Strings.sol";
@@ -20,8 +20,8 @@ library NFTSVG {
string progress;
uint256 progressNumerical;
string sablierAddress;
+ string sablierModel;
string status;
- string streamingModel;
}
struct SVGVars {
@@ -89,7 +89,7 @@ library NFTSVG {
'"
);
@@ -119,7 +119,7 @@ library NFTSVG {
function generateFloatingText(
string memory sablierAddress,
- string memory streamingModel,
+ string memory sablierModel,
string memory assetAddress,
string memory assetSymbol
)
@@ -131,11 +131,11 @@ library NFTSVG {
'',
SVGElements.floatingText({
offset: "-100%",
- text: string.concat(sablierAddress, unicode" • ", "Sablier V2 ", streamingModel)
+ text: string.concat(sablierAddress, unicode" • ", "Sablier V2 ", sablierModel)
}),
SVGElements.floatingText({
offset: "0%",
- text: string.concat(sablierAddress, unicode" • ", "Sablier V2 ", streamingModel)
+ text: string.concat(sablierAddress, unicode" • ", "Sablier V2 ", sablierModel)
}),
SVGElements.floatingText({ offset: "-50%", text: string.concat(assetAddress, unicode" • ", assetSymbol) }),
SVGElements.floatingText({ offset: "50%", text: string.concat(assetAddress, unicode" • ", assetSymbol) }),
diff --git a/src/libraries/SVGElements.sol b/src/libraries/SVGElements.sol
index 0c8461dbe..92f1bbdd0 100644
--- a/src/libraries/SVGElements.sol
+++ b/src/libraries/SVGElements.sol
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: GPL-3.0-or-later
// solhint-disable max-line-length,quotes
-pragma solidity >=0.8.19;
+pragma solidity >=0.8.22;
import { Math } from "@openzeppelin/contracts/utils/math/Math.sol";
import { Strings } from "@openzeppelin/contracts/utils/Strings.sol";
@@ -239,12 +239,11 @@ library SVGElements {
unchecked {
uint256 charWidth = largeFont ? 16 : 13;
uint256 semicolonIndex;
- for (uint256 i = 0; i < length;) {
+ for (uint256 i = 0; i < length; ++i) {
if (bytes(text)[i] == ";") {
semicolonIndex = i;
}
width += charWidth;
- i += 1;
}
// Account for escaped characters (such as ≥).
diff --git a/src/types/DataTypes.sol b/src/types/DataTypes.sol
index 48a899c75..c73b01b93 100644
--- a/src/types/DataTypes.sol
+++ b/src/types/DataTypes.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity >=0.8.19;
+pragma solidity >=0.8.22;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { UD2x18 } from "@prb/math/src/UD2x18.sol";
@@ -12,6 +12,7 @@ import { UD60x18 } from "@prb/math/src/UD60x18.sol";
// - Lockup
// - LockupDynamic
// - LockupLinear
+// - LockupTranched
//
// You will notice that some structs contain "slot" annotations - they are used to indicate the
// storage layout of the struct. It is more gas efficient to group small data types together so
@@ -27,11 +28,11 @@ struct Broker {
/// @notice Namespace for the structs used in both {SablierV2LockupLinear} and {SablierV2LockupDynamic}.
library Lockup {
- /// @notice Struct encapsulating the deposit, withdrawn, and refunded amounts, all denoted in units
- /// of the asset's decimals.
- /// @dev Because the deposited and the withdrawn amount are often read together, declaring them in
- /// the same slot saves gas.
- /// @param deposited The initial amount deposited in the stream, net of fees.
+ /// @notice Struct encapsulating the deposit, withdrawn, and refunded amounts, both denoted in units of the asset's
+ /// decimals.
+ /// @dev Because the deposited and the withdrawn amount are often read together, declaring them in the same slot
+ /// saves gas.
+ /// @param deposited The initial amount deposited in the stream, net of broker fee.
/// @param withdrawn The cumulative amount withdrawn from the stream.
/// @param refunded The amount refunded to the sender. Unless the stream was canceled, this is always zero.
struct Amounts {
@@ -42,155 +43,166 @@ library Lockup {
uint128 refunded;
}
- /// @notice Struct encapsulating the deposit amount, the protocol fee amount, and the broker fee amount,
- /// all denoted in units of the asset's decimals.
+ /// @notice Struct encapsulating the deposit amount and the broker fee amount, both denoted in units of the asset's
+ /// decimals.
/// @param deposit The amount to deposit in the stream.
- /// @param protocolFee The protocol fee amount.
/// @param brokerFee The broker fee amount.
struct CreateAmounts {
uint128 deposit;
- uint128 protocolFee;
uint128 brokerFee;
}
/// @notice Enum representing the different statuses of a stream.
- /// @custom:value PENDING Stream created but not started; assets are in a pending state.
- /// @custom:value STREAMING Active stream where assets are currently being streamed.
- /// @custom:value SETTLED All assets have been streamed; recipient is due to withdraw them.
- /// @custom:value CANCELED Canceled stream; remaining assets await recipient's withdrawal.
- /// @custom:value DEPLETED Depleted stream; all assets have been withdrawn and/or refunded.
+ /// @custom:value0 PENDING Stream created but not started; assets are in a pending state.
+ /// @custom:value1 STREAMING Active stream where assets are currently being streamed.
+ /// @custom:value2 SETTLED All assets have been streamed; recipient is due to withdraw them.
+ /// @custom:value3 CANCELED Canceled stream; remaining assets await recipient's withdrawal.
+ /// @custom:value4 DEPLETED Depleted stream; all assets have been withdrawn and/or refunded.
enum Status {
- PENDING, // value 0
- STREAMING, // value 1
- SETTLED, // value 2
- CANCELED, // value 3
- DEPLETED // value 4
+ PENDING,
+ STREAMING,
+ SETTLED,
+ CANCELED,
+ DEPLETED
+ }
+
+ /// @notice A common data structure to be stored in all {SablierV2Lockup} models.
+ /// @dev The fields are arranged like this to save gas via tight variable packing.
+ /// @param sender The address distributing the assets, with the ability to cancel the stream.
+ /// @param startTime The Unix timestamp indicating the stream's start.
+ /// @param endTime The Unix timestamp indicating the stream's end.
+ /// @param isCancelable Boolean indicating if the stream is cancelable.
+ /// @param wasCanceled Boolean indicating if the stream was canceled.
+ /// @param asset The contract address of the ERC-20 asset to be distributed.
+ /// @param isDepleted Boolean indicating if the stream is depleted.
+ /// @param isStream Boolean indicating if the struct entity exists.
+ /// @param isTransferable Boolean indicating if the stream NFT is transferable.
+ /// @param amounts Struct containing the deposit, withdrawn, and refunded amounts, both denoted in units of the
+ /// asset's decimals.
+ struct Stream {
+ // slot 0
+ address sender;
+ uint40 startTime;
+ uint40 endTime;
+ bool isCancelable;
+ bool wasCanceled;
+ // slot 1
+ IERC20 asset;
+ bool isDepleted;
+ bool isStream;
+ bool isTransferable;
+ // slot 2 and 3
+ Lockup.Amounts amounts;
}
}
/// @notice Namespace for the structs used in {SablierV2LockupDynamic}.
library LockupDynamic {
- /// @notice Struct encapsulating the parameters for the {SablierV2LockupDynamic.createWithDeltas} function.
- /// @param sender The address streaming the assets, with the ability to cancel the stream. It doesn't have to be the
- /// same as `msg.sender`.
+ /// @notice Struct encapsulating the parameters of the {SablierV2LockupDynamic.createWithDurations} function.
+ /// @param sender The address distributing the assets, with the ability to cancel the stream. It doesn't have to be
+ /// the same as `msg.sender`.
/// @param recipient The address receiving the assets.
- /// @param totalAmount The total amount of ERC-20 assets to be paid, including the stream deposit and any potential
- /// fees, all denoted in units of the asset's decimals.
- /// @param asset The contract address of the ERC-20 asset used for streaming.
+ /// @param totalAmount The total amount of ERC-20 assets to be distributed, including the stream deposit and any
+ /// broker fee, both denoted in units of the asset's decimals.
+ /// @param asset The contract address of the ERC-20 asset to be distributed.
/// @param cancelable Indicates if the stream is cancelable.
/// @param transferable Indicates if the stream NFT is transferable.
+ /// @param segments Segments with durations used to compose the dynamic distribution function. Timestamps are
+ /// calculated by starting from `block.timestamp` and adding each duration to the previous timestamp.
/// @param broker Struct containing (i) the address of the broker assisting in creating the stream, and (ii) the
/// percentage fee paid to the broker from `totalAmount`, denoted as a fixed-point number. Both can be set to zero.
- /// @param segments Segments with deltas used to compose the custom streaming curve. Milestones are calculated by
- /// starting from `block.timestamp` and adding each delta to the previous milestone.
- struct CreateWithDeltas {
+ struct CreateWithDurations {
address sender;
- bool cancelable;
- bool transferable;
address recipient;
uint128 totalAmount;
IERC20 asset;
+ bool cancelable;
+ bool transferable;
+ SegmentWithDuration[] segments;
Broker broker;
- SegmentWithDelta[] segments;
}
- /// @notice Struct encapsulating the parameters for the {SablierV2LockupDynamic.createWithMilestones}
- /// function.
- /// @param sender The address streaming the assets, with the ability to cancel the stream. It doesn't have to be the
- /// same as `msg.sender`.
- /// @param startTime The Unix timestamp indicating the stream's start.
+ /// @notice Struct encapsulating the parameters of the {SablierV2LockupDynamic.createWithTimestamps} function.
+ /// @param sender The address distributing the assets, with the ability to cancel the stream. It doesn't have to be
+ /// the same as `msg.sender`.
+ /// @param recipient The address receiving the assets.
+ /// @param totalAmount The total amount of ERC-20 assets to be distributed, including the stream deposit and any
+ /// broker fee, both denoted in units of the asset's decimals.
+ /// @param asset The contract address of the ERC-20 asset to be distributed.
/// @param cancelable Indicates if the stream is cancelable.
/// @param transferable Indicates if the stream NFT is transferable.
- /// @param recipient The address receiving the assets.
- /// @param totalAmount The total amount of ERC-20 assets to be paid, including the stream deposit and any potential
- /// fees, all denoted in units of the asset's decimals.
- /// @param asset The contract address of the ERC-20 asset used for streaming.
+ /// @param startTime The Unix timestamp indicating the stream's start.
+ /// @param segments Segments used to compose the dynamic distribution function.
/// @param broker Struct containing (i) the address of the broker assisting in creating the stream, and (ii) the
/// percentage fee paid to the broker from `totalAmount`, denoted as a fixed-point number. Both can be set to zero.
- /// @param segments Segments used to compose the custom streaming curve.
- struct CreateWithMilestones {
+ struct CreateWithTimestamps {
address sender;
- uint40 startTime;
- bool cancelable;
- bool transferable;
address recipient;
uint128 totalAmount;
IERC20 asset;
- Broker broker;
+ bool cancelable;
+ bool transferable;
+ uint40 startTime;
Segment[] segments;
- }
-
- /// @notice Struct encapsulating the time range.
- /// @param start The Unix timestamp indicating the stream's start.
- /// @param end The Unix timestamp indicating the stream's end.
- struct Range {
- uint40 start;
- uint40 end;
+ Broker broker;
}
/// @notice Segment struct used in the Lockup Dynamic stream.
- /// @param amount The amount of assets to be streamed in this segment, denoted in units of the asset's decimals.
- /// @param exponent The exponent of this segment, denoted as a fixed-point number.
- /// @param milestone The Unix timestamp indicating this segment's end.
+ /// @param amount The amount of assets to be streamed in the segment, denoted in units of the asset's decimals.
+ /// @param exponent The exponent of the segment, denoted as a fixed-point number.
+ /// @param timestamp The Unix timestamp indicating the segment's end.
struct Segment {
// slot 0
uint128 amount;
UD2x18 exponent;
- uint40 milestone;
+ uint40 timestamp;
}
- /// @notice Segment struct used at runtime in {SablierV2LockupDynamic.createWithDeltas}.
- /// @param amount The amount of assets to be streamed in this segment, denoted in units of the asset's decimals.
- /// @param exponent The exponent of this segment, denoted as a fixed-point number.
- /// @param delta The time difference in seconds between this segment and the previous one.
- struct SegmentWithDelta {
+ /// @notice Segment struct used at runtime in {SablierV2LockupDynamic.createWithDurations}.
+ /// @param amount The amount of assets to be streamed in the segment, denoted in units of the asset's decimals.
+ /// @param exponent The exponent of the segment, denoted as a fixed-point number.
+ /// @param duration The time difference in seconds between the segment and the previous one.
+ struct SegmentWithDuration {
uint128 amount;
UD2x18 exponent;
- uint40 delta;
+ uint40 duration;
}
- /// @notice Lockup Dynamic stream.
- /// @dev The fields are arranged like this to save gas via tight variable packing.
- /// @param sender The address streaming the assets, with the ability to cancel the stream.
- /// @param startTime The Unix timestamp indicating the stream's start.
- /// @param endTime The Unix timestamp indicating the stream's end.
- /// @param isCancelable Boolean indicating if the stream is cancelable.
- /// @param wasCanceled Boolean indicating if the stream was canceled.
- /// @param asset The contract address of the ERC-20 asset used for streaming.
- /// @param isDepleted Boolean indicating if the stream is depleted.
- /// @param isStream Boolean indicating if the struct entity exists.
- /// @param isTransferable Boolean indicating if the stream NFT is transferable.
- /// @param amounts Struct containing the deposit, withdrawn, and refunded amounts, all denoted in units of the
- /// asset's decimals.
- /// @param segments Segments used to compose the custom streaming curve.
- struct Stream {
- // slot 0
+ /// @notice Struct encapsulating the full details of a stream.
+ /// @dev Extends `Lockup.Stream` by including the recipient and the segments.
+ struct StreamLD {
address sender;
+ address recipient;
uint40 startTime;
uint40 endTime;
bool isCancelable;
bool wasCanceled;
- // slot 1
IERC20 asset;
bool isDepleted;
bool isStream;
bool isTransferable;
- // slot 2 and 3
Lockup.Amounts amounts;
- // slots [4..n]
Segment[] segments;
}
+
+ /// @notice Struct encapsulating the LockupDynamic timestamps.
+ /// @param start The Unix timestamp indicating the stream's start.
+ /// @param end The Unix timestamp indicating the stream's end.
+ struct Timestamps {
+ uint40 start;
+ uint40 end;
+ }
}
/// @notice Namespace for the structs used in {SablierV2LockupLinear}.
library LockupLinear {
- /// @notice Struct encapsulating the parameters for the {SablierV2LockupLinear.createWithDurations} function.
- /// @param sender The address streaming the assets, with the ability to cancel the stream. It doesn't have to be the
- /// same as `msg.sender`.
+ /// @notice Struct encapsulating the parameters of the {SablierV2LockupLinear.createWithDurations} function.
+ /// @param sender The address distributing the assets, with the ability to cancel the stream. It doesn't have to be
+ /// the same as `msg.sender`.
/// @param recipient The address receiving the assets.
- /// @param totalAmount The total amount of ERC-20 assets to be paid, including the stream deposit and any potential
- /// fees, all denoted in units of the asset's decimals.
- /// @param asset The contract address of the ERC-20 asset used for streaming.
+ /// @param totalAmount The total amount of ERC-20 assets to be distributed, including the stream deposit and any
+ /// broker fee, both denoted in units of the asset's decimals.
+ /// @param asset The contract address of the ERC-20 asset to be distributed.
/// @param cancelable Indicates if the stream is cancelable.
/// @param transferable Indicates if the stream NFT is transferable.
/// @param durations Struct containing (i) cliff period duration and (ii) total stream duration, both in seconds.
@@ -207,27 +219,27 @@ library LockupLinear {
Broker broker;
}
- /// @notice Struct encapsulating the parameters for the {SablierV2LockupLinear.createWithRange} function.
- /// @param sender The address streaming the assets, with the ability to cancel the stream. It doesn't have to be the
- /// same as `msg.sender`.
+ /// @notice Struct encapsulating the parameters of the {SablierV2LockupLinear.createWithTimestamps} function.
+ /// @param sender The address distributing the assets, with the ability to cancel the stream. It doesn't have to be
+ /// the same as `msg.sender`.
/// @param recipient The address receiving the assets.
- /// @param totalAmount The total amount of ERC-20 assets to be paid, including the stream deposit and any potential
- /// fees, all denoted in units of the asset's decimals.
- /// @param asset The contract address of the ERC-20 asset used for streaming.
+ /// @param totalAmount The total amount of ERC-20 assets to be distributed, including the stream deposit and any
+ /// broker fee, both denoted in units of the asset's decimals.
+ /// @param asset The contract address of the ERC-20 asset to be distributed.
/// @param cancelable Indicates if the stream is cancelable.
/// @param transferable Indicates if the stream NFT is transferable.
- /// @param range Struct containing (i) the stream's start time, (ii) cliff time, and (iii) end time, all as Unix
- /// timestamps.
+ /// @param timestamps Struct containing (i) the stream's start time, (ii) cliff time, and (iii) end time, all as
+ /// Unix timestamps.
/// @param broker Struct containing (i) the address of the broker assisting in creating the stream, and (ii) the
/// percentage fee paid to the broker from `totalAmount`, denoted as a fixed-point number. Both can be set to zero.
- struct CreateWithRange {
+ struct CreateWithTimestamps {
address sender;
address recipient;
uint128 totalAmount;
IERC20 asset;
bool cancelable;
bool transferable;
- Range range;
+ Timestamps timestamps;
Broker broker;
}
@@ -239,44 +251,124 @@ library LockupLinear {
uint40 total;
}
- /// @notice Struct encapsulating the time range.
+ /// @notice Struct encapsulating the full details of a stream.
+ /// @dev Extends `Lockup.Stream` by including the recipient and the cliff time.
+ struct StreamLL {
+ address sender;
+ address recipient;
+ uint40 startTime;
+ bool isCancelable;
+ bool wasCanceled;
+ IERC20 asset;
+ uint40 endTime;
+ bool isDepleted;
+ bool isStream;
+ bool isTransferable;
+ Lockup.Amounts amounts;
+ uint40 cliffTime;
+ }
+
+ /// @notice Struct encapsulating the LockupLinear timestamps.
/// @param start The Unix timestamp for the stream's start.
- /// @param cliff The Unix timestamp for the cliff period's end.
+ /// @param cliff The Unix timestamp for the cliff period's end. A value of zero means there is no cliff.
/// @param end The Unix timestamp for the stream's end.
- struct Range {
+ struct Timestamps {
uint40 start;
uint40 cliff;
uint40 end;
}
+}
- /// @notice Lockup Linear stream.
- /// @dev The fields are arranged like this to save gas via tight variable packing.
- /// @param sender The address streaming the assets, with the ability to cancel the stream.
+/// @notice Namespace for the structs used in {SablierV2LockupTranched}.
+library LockupTranched {
+ /// @notice Struct encapsulating the parameters of the {SablierV2LockupTranched.createWithDurations} function.
+ /// @param sender The address distributing the assets, with the ability to cancel the stream. It doesn't have to be
+ /// the same as `msg.sender`.
+ /// @param recipient The address receiving the assets.
+ /// @param totalAmount The total amount of ERC-20 assets to be distributed, including the stream deposit and any
+ /// broker fee, both denoted in units of the asset's decimals.
+ /// @param asset The contract address of the ERC-20 asset to be distributed.
+ /// @param cancelable Indicates if the stream is cancelable.
+ /// @param transferable Indicates if the stream NFT is transferable.
+ /// @param tranches Tranches with durations used to compose the tranched distribution function. Timestamps are
+ /// calculated by starting from `block.timestamp` and adding each duration to the previous timestamp.
+ /// @param broker Struct containing (i) the address of the broker assisting in creating the stream, and (ii) the
+ /// percentage fee paid to the broker from `totalAmount`, denoted as a fixed-point number. Both can be set to zero.
+ struct CreateWithDurations {
+ address sender;
+ address recipient;
+ uint128 totalAmount;
+ IERC20 asset;
+ bool cancelable;
+ bool transferable;
+ TrancheWithDuration[] tranches;
+ Broker broker;
+ }
+
+ /// @notice Struct encapsulating the parameters of the {SablierV2LockupTranched.createWithTimestamps} function.
+ /// @param sender The address distributing the assets, with the ability to cancel the stream. It doesn't have to be
+ /// the same as `msg.sender`.
+ /// @param recipient The address receiving the assets.
+ /// @param totalAmount The total amount of ERC-20 assets to be distributed, including the stream deposit and any
+ /// broker fee, both denoted in units of the asset's decimals.
+ /// @param asset The contract address of the ERC-20 asset to be distributed.
+ /// @param cancelable Indicates if the stream is cancelable.
+ /// @param transferable Indicates if the stream NFT is transferable.
/// @param startTime The Unix timestamp indicating the stream's start.
- /// @param cliffTime The Unix timestamp indicating the cliff period's end.
- /// @param isCancelable Boolean indicating if the stream is cancelable.
- /// @param wasCanceled Boolean indicating if the stream was canceled.
- /// @param asset The contract address of the ERC-20 asset used for streaming.
- /// @param endTime The Unix timestamp indicating the stream's end.
- /// @param isDepleted Boolean indicating if the stream is depleted.
- /// @param isStream Boolean indicating if the struct entity exists.
- /// @param isTransferable Boolean indicating if the stream NFT is transferable.
- /// @param amounts Struct containing the deposit, withdrawn, and refunded amounts, all denoted in units of the
- /// asset's decimals.
- struct Stream {
- // slot 0
+ /// @param tranches Tranches used to compose the tranched distribution function.
+ /// @param broker Struct containing (i) the address of the broker assisting in creating the stream, and (ii) the
+ /// percentage fee paid to the broker from `totalAmount`, denoted as a fixed-point number. Both can be set to zero.
+ struct CreateWithTimestamps {
+ address sender;
+ address recipient;
+ uint128 totalAmount;
+ IERC20 asset;
+ bool cancelable;
+ bool transferable;
+ uint40 startTime;
+ Tranche[] tranches;
+ Broker broker;
+ }
+
+ /// @notice Struct encapsulating the full details of a stream.
+ /// @dev Extends `Lockup.Stream` by including the recipient and the tranches.
+ struct StreamLT {
address sender;
+ address recipient;
uint40 startTime;
- uint40 cliffTime;
+ uint40 endTime;
bool isCancelable;
bool wasCanceled;
- // slot 1
IERC20 asset;
- uint40 endTime;
bool isDepleted;
bool isStream;
bool isTransferable;
- // slot 2 and 3
Lockup.Amounts amounts;
+ Tranche[] tranches;
+ }
+
+ /// @notice Struct encapsulating the LockupTranched timestamps.
+ /// @param start The Unix timestamp indicating the stream's start.
+ /// @param end The Unix timestamp indicating the stream's end.
+ struct Timestamps {
+ uint40 start;
+ uint40 end;
+ }
+
+ /// @notice Tranche struct used in the Lockup Tranched stream.
+ /// @param amount The amount of assets to be unlocked in the tranche, denoted in units of the asset's decimals.
+ /// @param timestamp The Unix timestamp indicating the tranche's end.
+ struct Tranche {
+ // slot 0
+ uint128 amount;
+ uint40 timestamp;
+ }
+
+ /// @notice Tranche struct used at runtime in {SablierV2LockupTranched.createWithDurations}.
+ /// @param amount The amount of assets to be unlocked in the tranche, denoted in units of the asset's decimals.
+ /// @param duration The time difference in seconds between the tranche and the previous one.
+ struct TrancheWithDuration {
+ uint128 amount;
+ uint40 duration;
}
}
diff --git a/test/Base.t.sol b/test/Base.t.sol
index b735e2f5f..f11fc8ca3 100644
--- a/test/Base.t.sol
+++ b/test/Base.t.sol
@@ -1,22 +1,21 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
-import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-import { ISablierV2Comptroller } from "../src/interfaces/ISablierV2Comptroller.sol";
import { ISablierV2LockupDynamic } from "../src/interfaces/ISablierV2LockupDynamic.sol";
import { ISablierV2LockupLinear } from "../src/interfaces/ISablierV2LockupLinear.sol";
+import { ISablierV2LockupTranched } from "../src/interfaces/ISablierV2LockupTranched.sol";
import { ISablierV2NFTDescriptor } from "../src/interfaces/ISablierV2NFTDescriptor.sol";
-import { SablierV2Comptroller } from "../src/SablierV2Comptroller.sol";
import { SablierV2LockupDynamic } from "../src/SablierV2LockupDynamic.sol";
import { SablierV2LockupLinear } from "../src/SablierV2LockupLinear.sol";
+import { SablierV2LockupTranched } from "../src/SablierV2LockupTranched.sol";
import { SablierV2NFTDescriptor } from "../src/SablierV2NFTDescriptor.sol";
+import { ERC20Mock } from "./mocks/erc20/ERC20Mock.sol";
import { ERC20MissingReturn } from "./mocks/erc20/ERC20MissingReturn.sol";
-import { GoodFlashLoanReceiver } from "./mocks/flash-loan/GoodFlashLoanReceiver.sol";
import { Noop } from "./mocks/Noop.sol";
-import { GoodRecipient } from "./mocks/hooks/GoodRecipient.sol";
+import { RecipientGood } from "./mocks/Hooks.sol";
import { Assertions } from "./utils/Assertions.sol";
import { Calculations } from "./utils/Calculations.sol";
import { Constants } from "./utils/Constants.sol";
@@ -38,13 +37,12 @@ abstract contract Base_Test is Assertions, Calculations, Constants, DeployOptimi
TEST CONTRACTS
//////////////////////////////////////////////////////////////////////////*/
- ISablierV2Comptroller internal comptroller;
- ERC20 internal dai;
+ ERC20Mock internal dai;
Defaults internal defaults;
- GoodFlashLoanReceiver internal goodFlashLoanReceiver;
- GoodRecipient internal goodRecipient;
+ RecipientGood internal recipientGood;
ISablierV2LockupDynamic internal lockupDynamic;
ISablierV2LockupLinear internal lockupLinear;
+ ISablierV2LockupTranched internal lockupTranched;
ISablierV2NFTDescriptor internal nftDescriptor;
Noop internal noop;
ERC20MissingReturn internal usdt;
@@ -55,80 +53,64 @@ abstract contract Base_Test is Assertions, Calculations, Constants, DeployOptimi
function setUp() public virtual {
// Deploy the base test contracts.
- dai = new ERC20("Dai Stablecoin", "DAI");
- goodFlashLoanReceiver = new GoodFlashLoanReceiver();
- goodRecipient = new GoodRecipient();
+ dai = new ERC20Mock("Dai Stablecoin", "DAI");
+ recipientGood = new RecipientGood();
noop = new Noop();
usdt = new ERC20MissingReturn("Tether USD", "USDT", 6);
// Label the base test contracts.
vm.label({ account: address(dai), newLabel: "DAI" });
- vm.label({ account: address(goodFlashLoanReceiver), newLabel: "Good Flash Loan Receiver" });
- vm.label({ account: address(goodRecipient), newLabel: "Good Recipient" });
- vm.label({ account: address(nftDescriptor), newLabel: "NFT Descriptor" });
+ vm.label({ account: address(recipientGood), newLabel: "Good Recipient" });
vm.label({ account: address(noop), newLabel: "Noop" });
vm.label({ account: address(usdt), newLabel: "USDT" });
- // Create users for testing.
- users = Users({
- admin: createUser("Admin"),
- alice: createUser("Alice"),
- broker: createUser("Broker"),
- eve: createUser("Eve"),
- operator: createUser("Operator"),
- recipient: createUser("Recipient"),
- sender: createUser("Sender")
- });
-
// Deploy the defaults contract.
defaults = new Defaults();
defaults.setAsset(dai);
+
+ // Create the protocol admin.
+ users.admin = payable(makeAddr({ name: "Admin" }));
+ vm.startPrank({ msgSender: users.admin });
+
+ // Deploy the V2 Core contracts.
+ deployCoreConditionally();
+
+ // Create users for testing.
+ users.alice = createUser("Alice");
+ users.broker = createUser("Broker");
+ users.eve = createUser("Eve");
+ users.operator = createUser("Operator");
+ users.recipient = createUser("Recipient");
+ users.sender = createUser("Sender");
+
defaults.setUsers(users);
- // Warp to May 1, 2023 at 00:00 GMT to provide a more realistic testing environment.
- vm.warp({ timestamp: MAY_1_2023 });
+ // Warp to May 1, 2024 at 00:00 GMT to provide a more realistic testing environment.
+ vm.warp({ newTimestamp: MAY_1_2024 });
}
/*//////////////////////////////////////////////////////////////////////////
HELPERS
//////////////////////////////////////////////////////////////////////////*/
- /// @dev Approves all V2 Core contracts to spend assets from the Sender, Recipient, Alice and Eve.
- function approveProtocol() internal {
- changePrank({ msgSender: users.sender });
- dai.approve({ spender: address(lockupLinear), amount: MAX_UINT256 });
- dai.approve({ spender: address(lockupDynamic), amount: MAX_UINT256 });
+ /// @dev Approves all V2 Core contracts to spend assets from the address passed.
+ function approveProtocol(address from) internal {
+ resetPrank({ msgSender: from });
+ dai.approve({ spender: address(lockupLinear), value: MAX_UINT256 });
+ dai.approve({ spender: address(lockupDynamic), value: MAX_UINT256 });
+ dai.approve({ spender: address(lockupTranched), value: MAX_UINT256 });
usdt.approve({ spender: address(lockupLinear), value: MAX_UINT256 });
usdt.approve({ spender: address(lockupDynamic), value: MAX_UINT256 });
-
- changePrank({ msgSender: users.recipient });
- dai.approve({ spender: address(lockupLinear), amount: MAX_UINT256 });
- dai.approve({ spender: address(lockupDynamic), amount: MAX_UINT256 });
- usdt.approve({ spender: address(lockupLinear), value: MAX_UINT256 });
- usdt.approve({ spender: address(lockupDynamic), value: MAX_UINT256 });
-
- changePrank({ msgSender: users.alice });
- dai.approve({ spender: address(lockupLinear), amount: MAX_UINT256 });
- dai.approve({ spender: address(lockupDynamic), amount: MAX_UINT256 });
- usdt.approve({ spender: address(lockupLinear), value: MAX_UINT256 });
- usdt.approve({ spender: address(lockupDynamic), value: MAX_UINT256 });
-
- changePrank({ msgSender: users.eve });
- dai.approve({ spender: address(lockupLinear), amount: MAX_UINT256 });
- dai.approve({ spender: address(lockupDynamic), amount: MAX_UINT256 });
- usdt.approve({ spender: address(lockupLinear), value: MAX_UINT256 });
- usdt.approve({ spender: address(lockupDynamic), value: MAX_UINT256 });
-
- // Finally, change the active prank back to the Admin.
- changePrank({ msgSender: users.admin });
+ usdt.approve({ spender: address(lockupTranched), value: MAX_UINT256 });
}
- /// @dev Generates a user, labels its address, and funds it with test assets.
+ /// @dev Generates a user, labels its address, funds it with test assets, and approves the protocol contracts.
function createUser(string memory name) internal returns (address payable) {
address payable user = payable(makeAddr(name));
vm.deal({ account: user, newBalance: 100 ether });
deal({ token: address(dai), to: user, give: 1_000_000e18 });
deal({ token: address(usdt), to: user, give: 1_000_000e18 });
+ approveProtocol({ from: user });
return user;
}
@@ -138,20 +120,19 @@ abstract contract Base_Test is Assertions, Calculations, Constants, DeployOptimi
/// deployer's nonce, which would in turn lead to different addresses (recall that the addresses
/// for contracts deployed via `CREATE` are based on the caller-and-nonce-hash).
function deployCoreConditionally() internal {
- if (!isTestOptimizedProfile()) {
- comptroller = new SablierV2Comptroller(users.admin);
+ if (!isBenchmarkProfile() && !isTestOptimizedProfile()) {
nftDescriptor = new SablierV2NFTDescriptor();
- lockupDynamic =
- new SablierV2LockupDynamic(users.admin, comptroller, nftDescriptor, defaults.MAX_SEGMENT_COUNT());
- lockupLinear = new SablierV2LockupLinear(users.admin, comptroller, nftDescriptor);
+ lockupDynamic = new SablierV2LockupDynamic(users.admin, nftDescriptor, defaults.MAX_SEGMENT_COUNT());
+ lockupLinear = new SablierV2LockupLinear(users.admin, nftDescriptor);
+ lockupTranched = new SablierV2LockupTranched(users.admin, nftDescriptor, defaults.MAX_TRANCHE_COUNT());
} else {
- (comptroller, lockupDynamic, lockupLinear, nftDescriptor) =
- deployOptimizedCore(users.admin, defaults.MAX_SEGMENT_COUNT());
+ (lockupDynamic, lockupLinear, lockupTranched, nftDescriptor) =
+ deployOptimizedCore(users.admin, defaults.MAX_SEGMENT_COUNT(), defaults.MAX_TRANCHE_COUNT());
}
- vm.label({ account: address(comptroller), newLabel: "Comptroller" });
vm.label({ account: address(lockupDynamic), newLabel: "LockupDynamic" });
vm.label({ account: address(lockupLinear), newLabel: "LockupLinear" });
+ vm.label({ account: address(lockupTranched), newLabel: "LockupTranched" });
vm.label({ account: address(nftDescriptor), newLabel: "NFTDescriptor" });
}
@@ -160,22 +141,22 @@ abstract contract Base_Test is Assertions, Calculations, Constants, DeployOptimi
//////////////////////////////////////////////////////////////////////////*/
/// @dev Expects a call to {IERC20.transfer}.
- function expectCallToTransfer(address to, uint256 amount) internal {
- vm.expectCall({ callee: address(dai), data: abi.encodeCall(IERC20.transfer, (to, amount)) });
+ function expectCallToTransfer(address to, uint256 value) internal {
+ vm.expectCall({ callee: address(dai), data: abi.encodeCall(IERC20.transfer, (to, value)) });
}
/// @dev Expects a call to {IERC20.transfer}.
- function expectCallToTransfer(IERC20 asset, address to, uint256 amount) internal {
- vm.expectCall({ callee: address(asset), data: abi.encodeCall(IERC20.transfer, (to, amount)) });
+ function expectCallToTransfer(IERC20 asset, address to, uint256 value) internal {
+ vm.expectCall({ callee: address(asset), data: abi.encodeCall(IERC20.transfer, (to, value)) });
}
/// @dev Expects a call to {IERC20.transferFrom}.
- function expectCallToTransferFrom(address from, address to, uint256 amount) internal {
- vm.expectCall({ callee: address(dai), data: abi.encodeCall(IERC20.transferFrom, (from, to, amount)) });
+ function expectCallToTransferFrom(address from, address to, uint256 value) internal {
+ vm.expectCall({ callee: address(dai), data: abi.encodeCall(IERC20.transferFrom, (from, to, value)) });
}
/// @dev Expects a call to {IERC20.transferFrom}.
- function expectCallToTransferFrom(IERC20 asset, address from, address to, uint256 amount) internal {
- vm.expectCall({ callee: address(asset), data: abi.encodeCall(IERC20.transferFrom, (from, to, amount)) });
+ function expectCallToTransferFrom(IERC20 asset, address from, address to, uint256 value) internal {
+ vm.expectCall({ callee: address(asset), data: abi.encodeCall(IERC20.transferFrom, (from, to, value)) });
}
}
diff --git a/test/fork/Fork.t.sol b/test/fork/Fork.t.sol
index 257f93aaf..770219d1d 100644
--- a/test/fork/Fork.t.sol
+++ b/test/fork/Fork.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { IERC20Metadata } from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
@@ -9,16 +9,11 @@ import { Base_Test } from "../Base.t.sol";
/// @notice Common logic needed by all fork tests.
abstract contract Fork_Test is Base_Test {
/*//////////////////////////////////////////////////////////////////////////
- CONSTANTS
+ STATE VARIABLES
//////////////////////////////////////////////////////////////////////////*/
IERC20 internal immutable ASSET;
address internal immutable HOLDER;
-
- /*//////////////////////////////////////////////////////////////////////////
- VARIABLES
- //////////////////////////////////////////////////////////////////////////*/
-
uint256 internal initialHolderBalance;
/*//////////////////////////////////////////////////////////////////////////
@@ -36,19 +31,16 @@ abstract contract Fork_Test is Base_Test {
function setUp() public virtual override {
// Fork Ethereum Mainnet at a specific block number.
- vm.createSelectFork({ blockNumber: 16_126_000, urlOrAlias: "mainnet" });
+ vm.createSelectFork({ blockNumber: 19_000_000, urlOrAlias: "mainnet" });
// The base is set up after the fork is selected so that the base test contracts are deployed on the fork.
Base_Test.setUp();
- // Deploy V2 Core.
- deployCoreConditionally();
-
// Label the contracts.
labelContracts();
// Make the ASSET HOLDER the caller in this test suite.
- vm.startPrank({ msgSender: HOLDER });
+ resetPrank({ msgSender: HOLDER });
// Query the initial balance of the ASSET HOLDER.
initialHolderBalance = ASSET.balanceOf(HOLDER);
diff --git a/test/fork/LockupDynamic.t.sol b/test/fork/LockupDynamic.t.sol
index 54c671cb4..67ccc5e4e 100644
--- a/test/fork/LockupDynamic.t.sol
+++ b/test/fork/LockupDynamic.t.sol
@@ -1,8 +1,7 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-import { UD60x18 } from "@prb/math/src/UD60x18.sol";
import { Solarray } from "solarray/src/Solarray.sol";
import { Broker, Lockup, LockupDynamic } from "src/types/DataTypes.sol";
@@ -34,15 +33,13 @@ abstract contract LockupDynamic_Fork_Test is Fork_Test {
//////////////////////////////////////////////////////////////////////////*/
struct Params {
- Broker broker;
- UD60x18 protocolFee;
- address recipient;
address sender;
+ address recipient;
+ uint128 withdrawAmount;
uint40 startTime;
uint40 warpTimestamp;
LockupDynamic.Segment[] segments;
- uint128 withdrawAmount;
- bool transferable;
+ Broker broker;
}
struct Vars {
@@ -61,20 +58,17 @@ abstract contract LockupDynamic_Fork_Test is Fork_Test {
bool isCancelable;
bool isDepleted;
bool isSettled;
- LockupDynamic.Range range;
uint256 streamId;
+ LockupDynamic.Timestamps timestamps;
// Create vars
uint256 actualBrokerBalance;
uint256 actualHolderBalance;
uint256 actualNextStreamId;
- uint256 actualProtocolRevenues;
Lockup.CreateAmounts createAmounts;
uint256 expectedBrokerBalance;
uint256 expectedHolderBalance;
- uint256 expectedProtocolRevenues;
uint256 expectedNextStreamId;
uint256 initialBrokerBalance;
- uint256 initialProtocolRevenues;
uint128 totalAmount;
// Withdraw vars
uint128 actualWithdrawnAmount;
@@ -92,8 +86,7 @@ abstract contract LockupDynamic_Fork_Test is Fork_Test {
///
/// - It should perform all expected ERC-20 transfers.
/// - It should create the stream.
- /// - It should bump the next stream id.
- /// - It should record the protocol fee.
+ /// - It should bump the next stream ID.
/// - It should mint the NFT.
/// - It should emit a {CreateLockupDynamicStream} event.
/// - It may make a withdrawal.
@@ -109,45 +102,34 @@ abstract contract LockupDynamic_Fork_Test is Fork_Test {
/// - Start time in the past
/// - Start time in the present
/// - Start time in the future
- /// - Start time equal and not equal to the first segment milestone
+ /// - Start time equal and not equal to the first segment timestamp
/// - Multiple values for the broker fee, including zero
- /// - Multiple values for the protocol fee, including zero
/// - Multiple values for the withdraw amount, including zero
/// - The whole gamut of stream statuses
function testForkFuzz_LockupDynamic_CreateWithdrawCancel(Params memory params) external {
checkUsers(params.sender, params.recipient, params.broker.account, address(lockupDynamic));
vm.assume(params.segments.length != 0);
- params.broker.fee = _bound(params.broker.fee, 0, MAX_FEE);
- params.protocolFee = _bound(params.protocolFee, 0, MAX_FEE);
- params.startTime = boundUint40(params.startTime, 0, defaults.START_TIME());
- params.transferable = true;
+ params.broker.fee = _bound(params.broker.fee, 0, MAX_BROKER_FEE);
+ params.startTime = boundUint40(params.startTime, 1, defaults.START_TIME());
- // Fuzz the segment milestones.
- fuzzSegmentMilestones(params.segments, params.startTime);
+ // Fuzz the segment timestamps.
+ fuzzSegmentTimestamps(params.segments, params.startTime);
- // Fuzz the segment amounts and calculate the create amounts (total, deposit, protocol fee, and broker fee).
+ // Fuzz the segment amounts and calculate the total and create amounts (deposit and broker fee).
Vars memory vars;
(vars.totalAmount, vars.createAmounts) = fuzzDynamicStreamAmounts({
upperBound: uint128(initialHolderBalance),
segments: params.segments,
- protocolFee: params.protocolFee,
brokerFee: params.broker.fee
});
- // Set the fuzzed protocol fee.
- changePrank({ msgSender: users.admin });
- comptroller.setProtocolFee({ asset: ASSET, newProtocolFee: params.protocolFee });
-
// Make the holder the caller.
- changePrank(HOLDER);
+ resetPrank(HOLDER);
/*//////////////////////////////////////////////////////////////////////////
CREATE
//////////////////////////////////////////////////////////////////////////*/
- // Load the pre-create protocol revenues.
- vars.initialProtocolRevenues = lockupDynamic.protocolRevenues(ASSET);
-
// Load the pre-create asset balances.
vars.balances =
getTokenBalances(address(ASSET), Solarray.addresses(address(lockupDynamic), params.broker.account));
@@ -155,8 +137,10 @@ abstract contract LockupDynamic_Fork_Test is Fork_Test {
vars.initialBrokerBalance = vars.balances[1];
vars.streamId = lockupDynamic.nextStreamId();
- vars.range =
- LockupDynamic.Range({ start: params.startTime, end: params.segments[params.segments.length - 1].milestone });
+ vars.timestamps = LockupDynamic.Timestamps({
+ start: params.startTime,
+ end: params.segments[params.segments.length - 1].timestamp
+ });
// Expect the relevant events to be emitted.
vm.expectEmit({ emitter: address(lockupDynamic) });
@@ -170,41 +154,42 @@ abstract contract LockupDynamic_Fork_Test is Fork_Test {
amounts: vars.createAmounts,
asset: ASSET,
cancelable: true,
- transferable: params.transferable,
+ transferable: true,
segments: params.segments,
- range: vars.range,
+ timestamps: vars.timestamps,
broker: params.broker.account
});
// Create the stream.
- lockupDynamic.createWithMilestones(
- LockupDynamic.CreateWithMilestones({
+ lockupDynamic.createWithTimestamps(
+ LockupDynamic.CreateWithTimestamps({
+ sender: params.sender,
+ recipient: params.recipient,
+ totalAmount: vars.totalAmount,
asset: ASSET,
- broker: params.broker,
cancelable: true,
- transferable: params.transferable,
- recipient: params.recipient,
- segments: params.segments,
- sender: params.sender,
+ transferable: true,
startTime: params.startTime,
- totalAmount: vars.totalAmount
+ segments: params.segments,
+ broker: params.broker
})
);
- // Check if the stream is settled. It is possible for a lockupDynamic stream to settle at the time of creation
+ // Check if the stream is settled. It is possible for a Lockup Dynamic stream to settle at the time of creation
// because some segment amounts can be zero.
vars.isSettled = lockupDynamic.refundableAmountOf(vars.streamId) == 0;
vars.isCancelable = vars.isSettled ? false : true;
// Assert that the stream has been created.
- LockupDynamic.Stream memory actualStream = lockupDynamic.getStream(vars.streamId);
+ LockupDynamic.StreamLD memory actualStream = lockupDynamic.getStream(vars.streamId);
assertEq(actualStream.amounts, Lockup.Amounts(vars.createAmounts.deposit, 0, 0));
assertEq(actualStream.asset, ASSET, "asset");
- assertEq(actualStream.endTime, vars.range.end, "endTime");
+ assertEq(actualStream.endTime, vars.timestamps.end, "endTime");
assertEq(actualStream.isCancelable, vars.isCancelable, "isCancelable");
assertEq(actualStream.isDepleted, false, "isDepleted");
- assertEq(actualStream.isTransferable, true, "isTransferable");
assertEq(actualStream.isStream, true, "isStream");
+ assertEq(actualStream.isTransferable, true, "isTransferable");
+ assertEq(actualStream.recipient, params.recipient, "recipient");
assertEq(actualStream.segments, params.segments, "segments");
assertEq(actualStream.sender, params.sender, "sender");
assertEq(actualStream.startTime, params.startTime, "startTime");
@@ -221,16 +206,11 @@ abstract contract LockupDynamic_Fork_Test is Fork_Test {
}
assertEq(vars.actualStatus, vars.expectedStatus, "post-create stream status");
- // Assert that the next stream id has been bumped.
+ // Assert that the next stream ID has been bumped.
vars.actualNextStreamId = lockupDynamic.nextStreamId();
vars.expectedNextStreamId = vars.streamId + 1;
assertEq(vars.actualNextStreamId, vars.expectedNextStreamId, "post-create nextStreamId");
- // Assert that the protocol fee has been recorded.
- vars.actualProtocolRevenues = lockupDynamic.protocolRevenues(ASSET);
- vars.expectedProtocolRevenues = vars.initialProtocolRevenues + vars.createAmounts.protocolFee;
- assertEq(vars.actualProtocolRevenues, vars.expectedProtocolRevenues, "post-create protocolRevenues");
-
// Assert that the NFT has been minted.
vars.actualNFTOwner = lockupDynamic.ownerOf({ tokenId: vars.streamId });
vars.expectedNFTOwner = params.recipient;
@@ -244,12 +224,11 @@ abstract contract LockupDynamic_Fork_Test is Fork_Test {
vars.actualBrokerBalance = vars.balances[2];
// Assert that the contract's balance has been updated.
- vars.expectedLockupDynamicBalance =
- vars.initialLockupDynamicBalance + vars.createAmounts.deposit + vars.createAmounts.protocolFee;
+ vars.expectedLockupDynamicBalance = vars.initialLockupDynamicBalance + vars.createAmounts.deposit;
assertEq(
vars.actualLockupDynamicBalance,
vars.expectedLockupDynamicBalance,
- "post-create lockupDynamic contract balance"
+ "post-create LockupDynamic contract balance"
);
// Assert that the holder's balance has been updated.
@@ -265,8 +244,9 @@ abstract contract LockupDynamic_Fork_Test is Fork_Test {
//////////////////////////////////////////////////////////////////////////*/
// Simulate the passage of time.
- params.warpTimestamp = boundUint40(params.warpTimestamp, vars.range.start, vars.range.end + 100 seconds);
- vm.warp({ timestamp: params.warpTimestamp });
+ params.warpTimestamp =
+ boundUint40(params.warpTimestamp, vars.timestamps.start, vars.timestamps.end + 100 seconds);
+ vm.warp({ newTimestamp: params.warpTimestamp });
// Bound the withdraw amount.
vars.withdrawableAmount = lockupDynamic.withdrawableAmountOf(vars.streamId);
@@ -295,7 +275,7 @@ abstract contract LockupDynamic_Fork_Test is Fork_Test {
emit MetadataUpdate({ _tokenId: vars.streamId });
// Make the withdrawal.
- changePrank({ msgSender: params.recipient });
+ resetPrank({ msgSender: params.recipient });
lockupDynamic.withdraw({ streamId: vars.streamId, to: params.recipient, amount: params.withdrawAmount });
// Assert that the stream's status is correct.
@@ -358,7 +338,7 @@ abstract contract LockupDynamic_Fork_Test is Fork_Test {
emit MetadataUpdate({ _tokenId: vars.streamId });
// Cancel the stream.
- changePrank({ msgSender: params.sender });
+ resetPrank({ msgSender: params.sender });
lockupDynamic.cancel(vars.streamId);
// Assert that the stream's status is correct.
diff --git a/test/fork/LockupLinear.t.sol b/test/fork/LockupLinear.t.sol
index e0fa7c6a6..46fac970d 100644
--- a/test/fork/LockupLinear.t.sol
+++ b/test/fork/LockupLinear.t.sol
@@ -1,8 +1,8 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-import { UD60x18, ud } from "@prb/math/src/UD60x18.sol";
+import { ud } from "@prb/math/src/UD60x18.sol";
import { Solarray } from "solarray/src/Solarray.sol";
import { Broker, Lockup, LockupLinear } from "src/types/DataTypes.sol";
@@ -34,15 +34,13 @@ abstract contract LockupLinear_Fork_Test is Fork_Test {
//////////////////////////////////////////////////////////////////////////*/
struct Params {
- Broker broker;
- UD60x18 protocolFee;
- LockupLinear.Range range;
- address recipient;
address sender;
+ address recipient;
uint128 totalAmount;
- uint40 warpTimestamp;
uint128 withdrawAmount;
- bool transferable;
+ uint40 warpTimestamp;
+ LockupLinear.Timestamps timestamps;
+ Broker broker;
}
struct Vars {
@@ -53,11 +51,14 @@ abstract contract LockupLinear_Fork_Test is Fork_Test {
uint256 actualRecipientBalance;
Lockup.Status actualStatus;
uint256[] balances;
+ uint40 blockTimestamp;
+ uint40 endTimeLowerBound;
uint256 expectedLockupLinearBalance;
uint256 expectedHolderBalance;
address expectedNFTOwner;
uint256 expectedRecipientBalance;
Lockup.Status expectedStatus;
+ bool hasCliff;
uint256 initialLockupLinearBalance;
uint256 initialRecipientBalance;
bool isDepleted;
@@ -66,13 +67,10 @@ abstract contract LockupLinear_Fork_Test is Fork_Test {
// Create vars
uint256 actualBrokerBalance;
uint256 actualNextStreamId;
- uint256 actualProtocolRevenues;
Lockup.CreateAmounts createAmounts;
uint256 expectedBrokerBalance;
uint256 expectedNextStreamId;
- uint256 expectedProtocolRevenues;
uint256 initialBrokerBalance;
- uint256 initialProtocolRevenues;
// Withdraw vars
uint128 actualWithdrawnAmount;
uint128 expectedWithdrawnAmount;
@@ -89,8 +87,7 @@ abstract contract LockupLinear_Fork_Test is Fork_Test {
///
/// - It should perform all expected ERC-20 transfers.
/// - It should create the stream.
- /// - It should bump the next stream id.
- /// - It should record the protocol fee.
+ /// - It should bump the next stream ID.
/// - It should mint the NFT.
/// - It should emit a {MetadataUpdate} event
/// - It should emit a {CreateLockupLinearStream} event.
@@ -104,60 +101,54 @@ abstract contract LockupLinear_Fork_Test is Fork_Test {
///
/// - Multiple values for the sender, recipient, and broker
/// - Multiple values for the total amount
- /// - Multiple values for the cliff time and the end time
- /// - Multiple values for the broker fee, including zero
- /// - Multiple values for the protocol fee, including zero
/// - Multiple values for the withdraw amount, including zero
/// - Start time in the past
/// - Start time in the present
/// - Start time in the future
- /// - Start time lower than and equal to cliff time
+ /// - Multiple values for the cliff time and the end time
+ /// - Cliff time zero and not zero
+ /// - Multiple values for the broker fee, including zero
/// - The whole gamut of stream statuses
function testForkFuzz_LockupLinear_CreateWithdrawCancel(Params memory params) external {
checkUsers(params.sender, params.recipient, params.broker.account, address(lockupLinear));
// Bound the parameters.
- uint40 currentTime = getBlockTimestamp();
- params.broker.fee = _bound(params.broker.fee, 0, MAX_FEE);
- params.protocolFee = _bound(params.protocolFee, 0, MAX_FEE);
- params.range.start = boundUint40(params.range.start, currentTime - 1000 seconds, currentTime + 10_000 seconds);
- params.range.cliff = boundUint40(params.range.cliff, params.range.start, params.range.start + 52 weeks);
- params.totalAmount = boundUint128(params.totalAmount, 1, uint128(initialHolderBalance));
- params.transferable = true;
-
- // Bound the end time so that it is always greater than both the current time and the cliff time (this is
- // a requirement of the protocol).
- params.range.end = boundUint40(
- params.range.end,
- (params.range.cliff <= currentTime ? currentTime : params.range.cliff) + 1,
- MAX_UNIX_TIMESTAMP
+ Vars memory vars;
+ vars.blockTimestamp = getBlockTimestamp();
+ params.broker.fee = _bound(params.broker.fee, 0, MAX_BROKER_FEE);
+ params.timestamps.start = boundUint40(
+ params.timestamps.start, vars.blockTimestamp - 1000 seconds, vars.blockTimestamp + 10_000 seconds
);
+ params.totalAmount = boundUint128(params.totalAmount, 1, uint128(initialHolderBalance));
- // Set the fuzzed protocol fee.
- changePrank({ msgSender: users.admin });
- comptroller.setProtocolFee({ asset: ASSET, newProtocolFee: params.protocolFee });
+ // The cliff time must be either zero or greater than the start time.
+ vars.hasCliff = params.timestamps.cliff > 0;
+ if (vars.hasCliff) {
+ params.timestamps.cliff = boundUint40(
+ params.timestamps.cliff, params.timestamps.start + 1 seconds, params.timestamps.start + 52 weeks
+ );
+ }
+ // Bound the end time so that it is always greater than the block timestamp, the start time, and the cliff time.
+ vars.endTimeLowerBound = maxOfThree(params.timestamps.start, params.timestamps.cliff, vars.blockTimestamp);
+ params.timestamps.end =
+ boundUint40(params.timestamps.end, vars.endTimeLowerBound + 1 seconds, MAX_UNIX_TIMESTAMP);
// Make the holder the caller.
- changePrank(HOLDER);
+ resetPrank(HOLDER);
/*//////////////////////////////////////////////////////////////////////////
CREATE
//////////////////////////////////////////////////////////////////////////*/
- // Load the pre-create protocol revenues.
- Vars memory vars;
- vars.initialProtocolRevenues = lockupLinear.protocolRevenues(ASSET);
-
// Load the pre-create asset balances.
vars.balances =
getTokenBalances(address(ASSET), Solarray.addresses(address(lockupLinear), params.broker.account));
vars.initialLockupLinearBalance = vars.balances[0];
vars.initialBrokerBalance = vars.balances[1];
- // Calculate the fee amounts and the deposit amount.
- vars.createAmounts.protocolFee = ud(params.totalAmount).mul(params.protocolFee).intoUint128();
+ // Calculate the broker fee amount and the deposit amount.
vars.createAmounts.brokerFee = ud(params.totalAmount).mul(params.broker.fee).intoUint128();
- vars.createAmounts.deposit = params.totalAmount - vars.createAmounts.protocolFee - vars.createAmounts.brokerFee;
+ vars.createAmounts.deposit = params.totalAmount - vars.createAmounts.brokerFee;
vars.streamId = lockupLinear.nextStreamId();
@@ -173,54 +164,51 @@ abstract contract LockupLinear_Fork_Test is Fork_Test {
amounts: vars.createAmounts,
asset: ASSET,
cancelable: true,
- transferable: params.transferable,
- range: params.range,
+ transferable: true,
+ timestamps: params.timestamps,
broker: params.broker.account
});
// Create the stream.
- lockupLinear.createWithRange(
- LockupLinear.CreateWithRange({
+ lockupLinear.createWithTimestamps(
+ LockupLinear.CreateWithTimestamps({
+ sender: params.sender,
+ recipient: params.recipient,
+ totalAmount: params.totalAmount,
asset: ASSET,
- broker: params.broker,
cancelable: true,
- transferable: params.transferable,
- range: params.range,
- recipient: params.recipient,
- sender: params.sender,
- totalAmount: params.totalAmount
+ transferable: true,
+ timestamps: params.timestamps,
+ broker: params.broker
})
);
// Assert that the stream has been created.
- LockupLinear.Stream memory actualStream = lockupLinear.getStream(vars.streamId);
+ LockupLinear.StreamLL memory actualStream = lockupLinear.getStream(vars.streamId);
assertEq(actualStream.amounts, Lockup.Amounts(vars.createAmounts.deposit, 0, 0));
assertEq(actualStream.asset, ASSET, "asset");
- assertEq(actualStream.cliffTime, params.range.cliff, "cliffTime");
- assertEq(actualStream.endTime, params.range.end, "endTime");
+ assertEq(actualStream.cliffTime, params.timestamps.cliff, "cliffTime");
+ assertEq(actualStream.endTime, params.timestamps.end, "endTime");
assertEq(actualStream.isCancelable, true, "isCancelable");
assertEq(actualStream.isDepleted, false, "isDepleted");
- assertEq(actualStream.isTransferable, true, "isTransferable");
assertEq(actualStream.isStream, true, "isStream");
+ assertEq(actualStream.isTransferable, true, "isTransferable");
+ assertEq(actualStream.recipient, params.recipient, "recipient");
assertEq(actualStream.sender, params.sender, "sender");
- assertEq(actualStream.startTime, params.range.start, "startTime");
+ assertEq(actualStream.startTime, params.timestamps.start, "startTime");
assertEq(actualStream.wasCanceled, false, "wasCanceled");
// Assert that the stream's status is correct.
vars.actualStatus = lockupLinear.statusOf(vars.streamId);
- vars.expectedStatus = params.range.start > currentTime ? Lockup.Status.PENDING : Lockup.Status.STREAMING;
+ vars.expectedStatus =
+ params.timestamps.start > vars.blockTimestamp ? Lockup.Status.PENDING : Lockup.Status.STREAMING;
assertEq(vars.actualStatus, vars.expectedStatus, "post-create stream status");
- // Assert that the next stream id has been bumped.
+ // Assert that the next stream ID has been bumped.
vars.actualNextStreamId = lockupLinear.nextStreamId();
vars.expectedNextStreamId = vars.streamId + 1;
assertEq(vars.actualNextStreamId, vars.expectedNextStreamId, "post-create nextStreamId");
- // Assert that the protocol fee has been recorded.
- vars.actualProtocolRevenues = lockupLinear.protocolRevenues(ASSET);
- vars.expectedProtocolRevenues = vars.initialProtocolRevenues + vars.createAmounts.protocolFee;
- assertEq(vars.actualProtocolRevenues, vars.expectedProtocolRevenues, "post-create protocolRevenues");
-
// Assert that the NFT has been minted.
vars.actualNFTOwner = lockupLinear.ownerOf({ tokenId: vars.streamId });
vars.expectedNFTOwner = params.recipient;
@@ -234,8 +222,7 @@ abstract contract LockupLinear_Fork_Test is Fork_Test {
vars.actualBrokerBalance = vars.balances[2];
// Assert that the LockupLinear contract's balance has been updated.
- vars.expectedLockupLinearBalance =
- vars.initialLockupLinearBalance + vars.createAmounts.deposit + vars.createAmounts.protocolFee;
+ vars.expectedLockupLinearBalance = vars.initialLockupLinearBalance + vars.createAmounts.deposit;
assertEq(vars.actualLockupLinearBalance, vars.expectedLockupLinearBalance, "post-create LockupLinear balance");
// Assert that the holder's balance has been updated.
@@ -251,8 +238,12 @@ abstract contract LockupLinear_Fork_Test is Fork_Test {
//////////////////////////////////////////////////////////////////////////*/
// Simulate the passage of time.
- params.warpTimestamp = boundUint40(params.warpTimestamp, params.range.cliff, params.range.end + 100 seconds);
- vm.warp({ timestamp: params.warpTimestamp });
+ params.warpTimestamp = boundUint40(
+ params.warpTimestamp,
+ vars.hasCliff ? params.timestamps.cliff : params.timestamps.start + 1 seconds,
+ params.timestamps.end + 100 seconds
+ );
+ vm.warp({ newTimestamp: params.warpTimestamp });
// Bound the withdraw amount.
vars.withdrawableAmount = lockupLinear.withdrawableAmountOf(vars.streamId);
@@ -281,7 +272,7 @@ abstract contract LockupLinear_Fork_Test is Fork_Test {
emit MetadataUpdate({ _tokenId: vars.streamId });
// Make the withdrawal.
- changePrank({ msgSender: params.recipient });
+ resetPrank({ msgSender: params.recipient });
lockupLinear.withdraw({ streamId: vars.streamId, to: params.recipient, amount: params.withdrawAmount });
// Assert that the stream's status is correct.
@@ -342,7 +333,7 @@ abstract contract LockupLinear_Fork_Test is Fork_Test {
emit MetadataUpdate({ _tokenId: vars.streamId });
// Cancel the stream.
- changePrank({ msgSender: params.sender });
+ resetPrank({ msgSender: params.sender });
lockupLinear.cancel(vars.streamId);
// Assert that the stream's status is correct.
diff --git a/test/fork/LockupTranched.t.sol b/test/fork/LockupTranched.t.sol
new file mode 100644
index 000000000..e39f0423d
--- /dev/null
+++ b/test/fork/LockupTranched.t.sol
@@ -0,0 +1,379 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22 <0.9.0;
+
+import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import { Solarray } from "solarray/src/Solarray.sol";
+
+import { Broker, Lockup, LockupTranched } from "src/types/DataTypes.sol";
+
+import { Fork_Test } from "./Fork.t.sol";
+
+abstract contract LockupTranched_Fork_Test is Fork_Test {
+ /*//////////////////////////////////////////////////////////////////////////
+ CONSTRUCTOR
+ //////////////////////////////////////////////////////////////////////////*/
+
+ constructor(IERC20 asset, address holder) Fork_Test(asset, holder) { }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ SET-UP FUNCTION
+ //////////////////////////////////////////////////////////////////////////*/
+
+ function setUp() public virtual override {
+ Fork_Test.setUp();
+
+ // Approve {SablierV2LockupTranched} to transfer the holder's assets.
+ // We use a low-level call to ignore reverts because the asset can have the missing return value bug.
+ (bool success,) = address(ASSET).call(abi.encodeCall(IERC20.approve, (address(lockupTranched), MAX_UINT256)));
+ success;
+ }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ TEST FUNCTIONS
+ //////////////////////////////////////////////////////////////////////////*/
+
+ struct Params {
+ address sender;
+ address recipient;
+ uint128 withdrawAmount;
+ uint40 startTime;
+ uint40 warpTimestamp;
+ LockupTranched.Tranche[] tranches;
+ Broker broker;
+ }
+
+ struct Vars {
+ // Generic vars
+ address actualNFTOwner;
+ uint256 actualLockupTranchedBalance;
+ uint256 actualRecipientBalance;
+ Lockup.Status actualStatus;
+ uint256[] balances;
+ address expectedNFTOwner;
+ uint256 expectedLockupTranchedBalance;
+ uint256 expectedRecipientBalance;
+ Lockup.Status expectedStatus;
+ uint256 initialLockupTranchedBalance;
+ uint256 initialRecipientBalance;
+ bool isCancelable;
+ bool isDepleted;
+ bool isSettled;
+ uint256 streamId;
+ LockupTranched.Timestamps timestamps;
+ // Create vars
+ uint256 actualBrokerBalance;
+ uint256 actualHolderBalance;
+ uint256 actualNextStreamId;
+ Lockup.CreateAmounts createAmounts;
+ uint256 expectedBrokerBalance;
+ uint256 expectedHolderBalance;
+ uint256 expectedNextStreamId;
+ uint256 initialBrokerBalance;
+ uint128 totalAmount;
+ // Withdraw vars
+ uint128 actualWithdrawnAmount;
+ uint128 expectedWithdrawnAmount;
+ uint128 withdrawableAmount;
+ // Cancel vars
+ uint256 actualSenderBalance;
+ uint256 expectedSenderBalance;
+ uint256 initialSenderBalance;
+ uint128 recipientAmount;
+ uint128 senderAmount;
+ }
+
+ /// @dev Checklist:
+ ///
+ /// - It should perform all expected ERC-20 transfers.
+ /// - It should create the stream.
+ /// - It should bump the next stream ID.
+ /// - It should mint the NFT.
+ /// - It should emit a {CreateLockupTranchedStream} event.
+ /// - It may make a withdrawal.
+ /// - It may update the withdrawn amounts.
+ /// - It may emit a {WithdrawFromLockupStream} event.
+ /// - It may cancel the stream
+ /// - It may emit a {CancelLockupStream} event
+ ///
+ /// Given enough fuzz runs, all of the following scenarios will be fuzzed:
+ ///
+ /// - Multiple values for the funder, recipient, sender, and broker
+ /// - Multiple values for the total amount
+ /// - Start time in the past
+ /// - Start time in the present
+ /// - Start time in the future
+ /// - Start time equal and not equal to the first tranche timestamp
+ /// - Multiple values for the broker fee, including zero.
+ /// - Multiple values for the withdraw amount, including zero
+ /// - The whole gamut of stream statuses
+ function testForkFuzz_LockupTranched_CreateWithdrawCancel(Params memory params) external {
+ checkUsers(params.sender, params.recipient, params.broker.account, address(lockupTranched));
+ vm.assume(params.tranches.length != 0);
+ params.broker.fee = _bound(params.broker.fee, 0, MAX_BROKER_FEE);
+ params.startTime = boundUint40(params.startTime, 1, defaults.START_TIME());
+
+ // Fuzz the tranche timestamps.
+ fuzzTrancheTimestamps(params.tranches, params.startTime);
+
+ // Fuzz the tranche amounts and calculate the total and create amounts (deposit and broker fee).
+ Vars memory vars;
+ (vars.totalAmount, vars.createAmounts) = fuzzTranchedStreamAmounts({
+ upperBound: uint128(initialHolderBalance),
+ tranches: params.tranches,
+ brokerFee: params.broker.fee
+ });
+
+ // Make the holder the caller.
+ resetPrank(HOLDER);
+
+ /*//////////////////////////////////////////////////////////////////////////
+ CREATE
+ //////////////////////////////////////////////////////////////////////////*/
+
+ // Load the pre-create asset balances.
+ vars.balances =
+ getTokenBalances(address(ASSET), Solarray.addresses(address(lockupTranched), params.broker.account));
+ vars.initialLockupTranchedBalance = vars.balances[0];
+ vars.initialBrokerBalance = vars.balances[1];
+
+ vars.streamId = lockupTranched.nextStreamId();
+ vars.timestamps = LockupTranched.Timestamps({
+ start: params.startTime,
+ end: params.tranches[params.tranches.length - 1].timestamp
+ });
+
+ // Expect the relevant events to be emitted.
+ vm.expectEmit({ emitter: address(lockupTranched) });
+ emit MetadataUpdate({ _tokenId: vars.streamId });
+ vm.expectEmit({ emitter: address(lockupTranched) });
+ emit CreateLockupTranchedStream({
+ streamId: vars.streamId,
+ funder: HOLDER,
+ sender: params.sender,
+ recipient: params.recipient,
+ amounts: vars.createAmounts,
+ asset: ASSET,
+ cancelable: true,
+ transferable: true,
+ tranches: params.tranches,
+ timestamps: vars.timestamps,
+ broker: params.broker.account
+ });
+
+ // Create the stream.
+ lockupTranched.createWithTimestamps(
+ LockupTranched.CreateWithTimestamps({
+ sender: params.sender,
+ recipient: params.recipient,
+ totalAmount: vars.totalAmount,
+ asset: ASSET,
+ cancelable: true,
+ transferable: true,
+ startTime: params.startTime,
+ tranches: params.tranches,
+ broker: params.broker
+ })
+ );
+
+ // Check if the stream is settled. It is possible for a Lockup Tranched stream to settle at the time of creation
+ // because some tranche amounts can be zero.
+ vars.isSettled = lockupTranched.refundableAmountOf(vars.streamId) == 0;
+ vars.isCancelable = vars.isSettled ? false : true;
+
+ // Assert that the stream has been created.
+ LockupTranched.StreamLT memory actualStream = lockupTranched.getStream(vars.streamId);
+ assertEq(actualStream.amounts, Lockup.Amounts(vars.createAmounts.deposit, 0, 0));
+ assertEq(actualStream.asset, ASSET, "asset");
+ assertEq(actualStream.endTime, vars.timestamps.end, "endTime");
+ assertEq(actualStream.isCancelable, vars.isCancelable, "isCancelable");
+ assertEq(actualStream.isDepleted, false, "isDepleted");
+ assertEq(actualStream.isStream, true, "isStream");
+ assertEq(actualStream.isTransferable, true, "isTransferable");
+ assertEq(actualStream.recipient, params.recipient, "recipient");
+ assertEq(actualStream.tranches, params.tranches, "tranches");
+ assertEq(actualStream.sender, params.sender, "sender");
+ assertEq(actualStream.startTime, params.startTime, "startTime");
+ assertEq(actualStream.wasCanceled, false, "wasCanceled");
+
+ // Assert that the stream's status is correct.
+ vars.actualStatus = lockupTranched.statusOf(vars.streamId);
+ if (params.startTime > getBlockTimestamp()) {
+ vars.expectedStatus = Lockup.Status.PENDING;
+ } else if (vars.isSettled) {
+ vars.expectedStatus = Lockup.Status.SETTLED;
+ } else {
+ vars.expectedStatus = Lockup.Status.STREAMING;
+ }
+ assertEq(vars.actualStatus, vars.expectedStatus, "post-create stream status");
+
+ // Assert that the next stream ID has been bumped.
+ vars.actualNextStreamId = lockupTranched.nextStreamId();
+ vars.expectedNextStreamId = vars.streamId + 1;
+ assertEq(vars.actualNextStreamId, vars.expectedNextStreamId, "post-create nextStreamId");
+
+ // Assert that the NFT has been minted.
+ vars.actualNFTOwner = lockupTranched.ownerOf({ tokenId: vars.streamId });
+ vars.expectedNFTOwner = params.recipient;
+ assertEq(vars.actualNFTOwner, vars.expectedNFTOwner, "post-create NFT owner");
+
+ // Load the post-create asset balances.
+ vars.balances =
+ getTokenBalances(address(ASSET), Solarray.addresses(address(lockupTranched), HOLDER, params.broker.account));
+ vars.actualLockupTranchedBalance = vars.balances[0];
+ vars.actualHolderBalance = vars.balances[1];
+ vars.actualBrokerBalance = vars.balances[2];
+
+ // Assert that the contract's balance has been updated.
+ vars.expectedLockupTranchedBalance = vars.initialLockupTranchedBalance + vars.createAmounts.deposit;
+ assertEq(
+ vars.actualLockupTranchedBalance,
+ vars.expectedLockupTranchedBalance,
+ "post-create LockupTranched contract balance"
+ );
+
+ // Assert that the holder's balance has been updated.
+ vars.expectedHolderBalance = initialHolderBalance - vars.totalAmount;
+ assertEq(vars.actualHolderBalance, vars.expectedHolderBalance, "post-create Holder balance");
+
+ // Assert that the broker's balance has been updated.
+ vars.expectedBrokerBalance = vars.initialBrokerBalance + vars.createAmounts.brokerFee;
+ assertEq(vars.actualBrokerBalance, vars.expectedBrokerBalance, "post-create Broker balance");
+
+ /*//////////////////////////////////////////////////////////////////////////
+ WITHDRAW
+ //////////////////////////////////////////////////////////////////////////*/
+
+ // Simulate the passage of time.
+ params.warpTimestamp =
+ boundUint40(params.warpTimestamp, vars.timestamps.start, vars.timestamps.end + 100 seconds);
+ vm.warp({ newTimestamp: params.warpTimestamp });
+
+ // Bound the withdraw amount.
+ vars.withdrawableAmount = lockupTranched.withdrawableAmountOf(vars.streamId);
+ params.withdrawAmount = boundUint128(params.withdrawAmount, 0, vars.withdrawableAmount);
+
+ // Check if the stream has settled or will get depleted. It is possible for the stream to be just settled
+ // and not depleted because the withdraw amount is fuzzed.
+ vars.isDepleted = params.withdrawAmount == vars.createAmounts.deposit;
+ vars.isSettled = lockupTranched.refundableAmountOf(vars.streamId) == 0;
+
+ // Only run the withdraw tests if the withdraw amount is not zero.
+ if (params.withdrawAmount > 0) {
+ // Load the pre-withdraw asset balances.
+ vars.initialLockupTranchedBalance = vars.actualLockupTranchedBalance;
+ vars.initialRecipientBalance = ASSET.balanceOf(params.recipient);
+
+ // Expect the relevant events to be emitted.
+ vm.expectEmit({ emitter: address(lockupTranched) });
+ emit WithdrawFromLockupStream({
+ streamId: vars.streamId,
+ to: params.recipient,
+ asset: ASSET,
+ amount: params.withdrawAmount
+ });
+ vm.expectEmit({ emitter: address(lockupTranched) });
+ emit MetadataUpdate({ _tokenId: vars.streamId });
+
+ // Make the withdrawal.
+ resetPrank({ msgSender: params.recipient });
+ lockupTranched.withdraw({ streamId: vars.streamId, to: params.recipient, amount: params.withdrawAmount });
+
+ // Assert that the stream's status is correct.
+ vars.actualStatus = lockupTranched.statusOf(vars.streamId);
+ if (vars.isDepleted) {
+ vars.expectedStatus = Lockup.Status.DEPLETED;
+ } else if (vars.isSettled) {
+ vars.expectedStatus = Lockup.Status.SETTLED;
+ } else {
+ vars.expectedStatus = Lockup.Status.STREAMING;
+ }
+ assertEq(vars.actualStatus, vars.expectedStatus, "post-withdraw stream status");
+
+ // Assert that the withdrawn amount has been updated.
+ vars.actualWithdrawnAmount = lockupTranched.getWithdrawnAmount(vars.streamId);
+ vars.expectedWithdrawnAmount = params.withdrawAmount;
+ assertEq(vars.actualWithdrawnAmount, vars.expectedWithdrawnAmount, "post-withdraw withdrawnAmount");
+
+ // Load the post-withdraw asset balances.
+ vars.balances =
+ getTokenBalances(address(ASSET), Solarray.addresses(address(lockupTranched), params.recipient));
+ vars.actualLockupTranchedBalance = vars.balances[0];
+ vars.actualRecipientBalance = vars.balances[1];
+
+ // Assert that the contract's balance has been updated.
+ vars.expectedLockupTranchedBalance = vars.initialLockupTranchedBalance - uint256(params.withdrawAmount);
+ assertEq(
+ vars.actualLockupTranchedBalance,
+ vars.expectedLockupTranchedBalance,
+ "post-withdraw lockupTranched contract balance"
+ );
+
+ // Assert that the Recipient's balance has been updated.
+ vars.expectedRecipientBalance = vars.initialRecipientBalance + uint256(params.withdrawAmount);
+ assertEq(vars.actualRecipientBalance, vars.expectedRecipientBalance, "post-withdraw Recipient balance");
+ }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ CANCEL
+ //////////////////////////////////////////////////////////////////////////*/
+
+ // Only run the cancel tests if the stream is neither depleted nor settled.
+ if (!vars.isDepleted && !vars.isSettled) {
+ // Load the pre-cancel asset balances.
+ vars.balances = getTokenBalances(
+ address(ASSET), Solarray.addresses(address(lockupTranched), params.sender, params.recipient)
+ );
+ vars.initialLockupTranchedBalance = vars.balances[0];
+ vars.initialSenderBalance = vars.balances[1];
+ vars.initialRecipientBalance = vars.balances[2];
+
+ // Expect the relevant events to be emitted.
+ vm.expectEmit({ emitter: address(lockupTranched) });
+ vars.senderAmount = lockupTranched.refundableAmountOf(vars.streamId);
+ vars.recipientAmount = lockupTranched.withdrawableAmountOf(vars.streamId);
+ emit CancelLockupStream(
+ vars.streamId, params.sender, params.recipient, ASSET, vars.senderAmount, vars.recipientAmount
+ );
+ vm.expectEmit({ emitter: address(lockupTranched) });
+ emit MetadataUpdate({ _tokenId: vars.streamId });
+
+ // Cancel the stream.
+ resetPrank({ msgSender: params.sender });
+ lockupTranched.cancel(vars.streamId);
+
+ // Assert that the stream's status is correct.
+ vars.actualStatus = lockupTranched.statusOf(vars.streamId);
+ vars.expectedStatus = vars.recipientAmount > 0 ? Lockup.Status.CANCELED : Lockup.Status.DEPLETED;
+ assertEq(vars.actualStatus, vars.expectedStatus, "post-cancel stream status");
+
+ // Load the post-cancel asset balances.
+ vars.balances = getTokenBalances(
+ address(ASSET), Solarray.addresses(address(lockupTranched), params.sender, params.recipient)
+ );
+ vars.actualLockupTranchedBalance = vars.balances[0];
+ vars.actualSenderBalance = vars.balances[1];
+ vars.actualRecipientBalance = vars.balances[2];
+
+ // Assert that the contract's balance has been updated.
+ vars.expectedLockupTranchedBalance = vars.initialLockupTranchedBalance - uint256(vars.senderAmount);
+ assertEq(
+ vars.actualLockupTranchedBalance,
+ vars.expectedLockupTranchedBalance,
+ "post-cancel lockupTranched contract balance"
+ );
+
+ // Assert that the Sender's balance has been updated.
+ vars.expectedSenderBalance = vars.initialSenderBalance + uint256(vars.senderAmount);
+ assertEq(vars.actualSenderBalance, vars.expectedSenderBalance, "post-cancel Sender balance");
+
+ // Assert that the Recipient's balance has not changed.
+ vars.expectedRecipientBalance = vars.initialRecipientBalance;
+ assertEq(vars.actualRecipientBalance, vars.expectedRecipientBalance, "post-cancel Recipient balance");
+ }
+
+ // Assert that the NFT has not been burned.
+ vars.actualNFTOwner = lockupTranched.ownerOf({ tokenId: vars.streamId });
+ vars.expectedNFTOwner = params.recipient;
+ assertEq(vars.actualNFTOwner, vars.expectedNFTOwner, "post-cancel NFT owner");
+ }
+}
diff --git a/test/fork/NFTDescriptor.t.sol b/test/fork/NFTDescriptor.t.sol
new file mode 100644
index 000000000..89912d632
--- /dev/null
+++ b/test/fork/NFTDescriptor.t.sol
@@ -0,0 +1,158 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22 <0.9.0;
+
+import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+
+import { ISablierV2LockupDynamic } from "src/interfaces/ISablierV2LockupDynamic.sol";
+import { ISablierV2LockupLinear } from "src/interfaces/ISablierV2LockupLinear.sol";
+
+import { Fork_Test } from "./Fork.t.sol";
+
+contract NFTDescriptor_Fork_Test is Fork_Test {
+ /*//////////////////////////////////////////////////////////////////////////
+ STATE VARIABLES
+ //////////////////////////////////////////////////////////////////////////*/
+
+ IERC20 internal constant DAI = IERC20(0x6B175474E89094C44Da98b954EedeAC495271d0F);
+ address internal constant DAI_HOLDER = 0x66F62574ab04989737228D18C3624f7FC1edAe14;
+
+ /*//////////////////////////////////////////////////////////////////////////
+ CONSTRUCTOR
+ //////////////////////////////////////////////////////////////////////////*/
+
+ constructor() Fork_Test(DAI, DAI_HOLDER) { }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ MODIFIERS
+ //////////////////////////////////////////////////////////////////////////*/
+
+ /// @dev Loads the Lockup V2.0 contracts pre-deployed on Mainnet.
+ modifier loadDeployments_V2_0() {
+ lockupDynamic = ISablierV2LockupDynamic(0x39EFdC3dbB57B2388CcC4bb40aC4CB1226Bc9E44);
+ lockupLinear = ISablierV2LockupLinear(0xB10daee1FCF62243aE27776D7a92D39dC8740f95);
+ _;
+ }
+
+ /// @dev Loads the Lockup V2.1 contracts pre-deployed on Mainnet.
+ modifier loadDeployments_V2_1() {
+ lockupDynamic = ISablierV2LockupDynamic(0x7CC7e125d83A581ff438608490Cc0f7bDff79127);
+ lockupLinear = ISablierV2LockupLinear(0xAFb979d9afAd1aD27C5eFf4E27226E3AB9e5dCC9);
+ _;
+ }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ SET-UP FUNCTION
+ //////////////////////////////////////////////////////////////////////////*/
+
+ function setUp() public virtual override {
+ Fork_Test.setUp();
+ }
+
+ /*//////////////////////////////////////////////////////////////////////////
+ TEST FUNCTIONS
+ //////////////////////////////////////////////////////////////////////////*/
+
+ /// @dev The following test checks whether the new NFT descriptor is compatible with Lockup Dynamic v2.0.
+ ///
+ /// Checklist:
+ /// - It should expect a call to {ISablierV2LockupDynamic.tokenURI}.
+ /// - The test would fail if the call to {ISablierV2LockupDynamic.tokenURI} reverts.
+ ///
+ /// Given enough fuzz runs, all the following scenarios will be fuzzed:
+ /// - Multiple values of streamId.
+ function testForkFuzz_TokenURI_LockupDynamic_V2_0(uint256 streamId) external loadDeployments_V2_0 {
+ streamId = _bound(streamId, 1, lockupDynamic.nextStreamId() - 1);
+
+ // Set the new NFT descriptor for the previous version of Lockup Dynamic.
+ resetPrank({ msgSender: lockupDynamic.admin() });
+ lockupDynamic.setNFTDescriptor(nftDescriptor);
+
+ // Expects a successful call to the new NFT Descriptor.
+ vm.expectCall({
+ callee: address(nftDescriptor),
+ data: abi.encodeCall(nftDescriptor.tokenURI, (lockupDynamic, streamId)),
+ count: 1
+ });
+
+ // Generate the token URI using the new NFT Descriptor.
+ lockupDynamic.tokenURI(streamId);
+ }
+
+ /// @dev The following test checks whether the new NFT descriptor is compatible with Lockup Dynamic v2.1.
+ ///
+ /// Checklist:
+ /// - It should expect a call to {ISablierV2LockupDynamic.tokenURI}.
+ /// - The test would fail if the call to {ISablierV2LockupDynamic.tokenURI} reverts.
+ ///
+ /// Given enough fuzz runs, all the following scenarios will be fuzzed:
+ /// - Multiple values of streamId.
+ function testForkFuzz_TokenURI_LockupDynamic_V2_1(uint256 streamId) external loadDeployments_V2_1 {
+ streamId = _bound(streamId, 1, lockupDynamic.nextStreamId() - 1);
+
+ // Set the new NFT descriptor for the previous version of Lockup Dynamic.
+ resetPrank({ msgSender: lockupDynamic.admin() });
+ lockupDynamic.setNFTDescriptor(nftDescriptor);
+
+ // Expects a successful call to the new NFT Descriptor.
+ vm.expectCall({
+ callee: address(nftDescriptor),
+ data: abi.encodeCall(nftDescriptor.tokenURI, (lockupDynamic, streamId)),
+ count: 1
+ });
+
+ // Generate the token URI using the new NFT Descriptor.
+ lockupDynamic.tokenURI(streamId);
+ }
+
+ /// @dev The following test checks whether the new NFT descriptor is compatible with Lockup Linear v2.0.
+ ///
+ /// Checklist:
+ /// - It should expect a call to {ISablierV2LockupLinear.tokenURI}.
+ /// - The test would fail if the call to {ISablierV2LockupLinear.tokenURI} reverts.
+ ///
+ /// Given enough fuzz runs, all the following scenarios will be fuzzed:
+ /// - Multiple values of streamId.
+ function testForkFuzz_TokenURI_LockupLinear_V2_0(uint256 streamId) external loadDeployments_V2_0 {
+ streamId = _bound(streamId, 1, lockupLinear.nextStreamId() - 1);
+
+ // Set the new NFT descriptor for the previous version of Lockup Linear.
+ resetPrank({ msgSender: lockupLinear.admin() });
+ lockupLinear.setNFTDescriptor(nftDescriptor);
+
+ // Expects a successful call to the new NFT Descriptor.
+ vm.expectCall({
+ callee: address(nftDescriptor),
+ data: abi.encodeCall(nftDescriptor.tokenURI, (lockupLinear, streamId)),
+ count: 1
+ });
+
+ // Generate the token URI using the new NFT Descriptor.
+ lockupLinear.tokenURI(streamId);
+ }
+
+ /// @dev The following test checks whether the new NFT descriptor is compatible with Lockup Linear v2.1.
+ ///
+ /// Checklist:
+ /// - It should expect a call to {ISablierV2LockupLinear.tokenURI}.
+ /// - The test would fail if the call to {ISablierV2LockupLinear.tokenURI} reverts.
+ ///
+ /// Given enough fuzz runs, all the following scenarios will be fuzzed:
+ /// - Multiple values of streamId.
+ function testForkFuzz_TokenURI_LockupLinear_V2_1(uint256 streamId) external loadDeployments_V2_1 {
+ streamId = _bound(streamId, 1, lockupLinear.nextStreamId() - 1);
+
+ // Set the new NFT descriptor for the previous version of Lockup Linear.
+ resetPrank({ msgSender: lockupLinear.admin() });
+ lockupLinear.setNFTDescriptor(nftDescriptor);
+
+ // Expects a successful call to the new NFT Descriptor.
+ vm.expectCall({
+ callee: address(nftDescriptor),
+ data: abi.encodeCall(nftDescriptor.tokenURI, (lockupLinear, streamId)),
+ count: 1
+ });
+
+ // Generate the token URI using the new NFT Descriptor.
+ lockupLinear.tokenURI(streamId);
+ }
+}
diff --git a/test/fork/assets/DAI.t.sol b/test/fork/assets/DAI.t.sol
index 3fdb579c3..6bf507732 100644
--- a/test/fork/assets/DAI.t.sol
+++ b/test/fork/assets/DAI.t.sol
@@ -1,10 +1,11 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { LockupDynamic_Fork_Test } from "../LockupDynamic.t.sol";
import { LockupLinear_Fork_Test } from "../LockupLinear.t.sol";
+import { LockupTranched_Fork_Test } from "../LockupTranched.t.sol";
/// @dev A typical 18-decimal ERC-20 asset with a normal total supply.
IERC20 constant ASSET = IERC20(0x6B175474E89094C44Da98b954EedeAC495271d0F);
@@ -13,3 +14,5 @@ address constant HOLDER = 0x66F62574ab04989737228D18C3624f7FC1edAe14;
contract DAI_LockupDynamic_Fork_Test is LockupDynamic_Fork_Test(ASSET, HOLDER) { }
contract DAI_LockupLinear_Fork_Test is LockupLinear_Fork_Test(ASSET, HOLDER) { }
+
+contract DAI_LockupTranched_Fork_Test is LockupTranched_Fork_Test(ASSET, HOLDER) { }
diff --git a/test/fork/assets/EURS.t.sol b/test/fork/assets/EURS.t.sol
index 969daa1bc..c27504e63 100644
--- a/test/fork/assets/EURS.t.sol
+++ b/test/fork/assets/EURS.t.sol
@@ -1,15 +1,18 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { LockupDynamic_Fork_Test } from "../LockupDynamic.t.sol";
import { LockupLinear_Fork_Test } from "../LockupLinear.t.sol";
+import { LockupTranched_Fork_Test } from "../LockupTranched.t.sol";
/// @dev An ERC-20 asset with 2 decimals.
IERC20 constant ASSET = IERC20(0xdB25f211AB05b1c97D595516F45794528a807ad8);
-address constant HOLDER = 0x9712c160925403A9458BfC6bBD7D8a1E694C984a;
+address constant HOLDER = 0x1bee4F735062CD00841d6997964F187f5f5F5Ac9;
contract EURS_LockupDynamic_Fork_Test is LockupDynamic_Fork_Test(ASSET, HOLDER) { }
contract EURS_LockupLinear_Fork_Test is LockupLinear_Fork_Test(ASSET, HOLDER) { }
+
+contract EURS_LockupTranched_Fork_Test is LockupTranched_Fork_Test(ASSET, HOLDER) { }
diff --git a/test/fork/assets/SHIB.t.sol b/test/fork/assets/SHIB.t.sol
index e8d321a03..6d2f9dcbd 100644
--- a/test/fork/assets/SHIB.t.sol
+++ b/test/fork/assets/SHIB.t.sol
@@ -1,10 +1,11 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { LockupDynamic_Fork_Test } from "../LockupDynamic.t.sol";
import { LockupLinear_Fork_Test } from "../LockupLinear.t.sol";
+import { LockupTranched_Fork_Test } from "../LockupTranched.t.sol";
/// @dev An ERC-20 asset with a large total supply.
IERC20 constant ASSET = IERC20(0x95aD61b0a150d79219dCF64E1E6Cc01f0B64C4cE);
@@ -13,3 +14,5 @@ address constant HOLDER = 0x73AF3bcf944a6559933396c1577B257e2054D935;
contract SHIB_LockupDynamic_Fork_Test is LockupDynamic_Fork_Test(ASSET, HOLDER) { }
contract SHIB_LockupLinear_Fork_Test is LockupLinear_Fork_Test(ASSET, HOLDER) { }
+
+contract SHIB_LockupTranched_Fork_Test is LockupTranched_Fork_Test(ASSET, HOLDER) { }
diff --git a/test/fork/assets/USDC.t.sol b/test/fork/assets/USDC.t.sol
index ea79ae380..f253f779a 100644
--- a/test/fork/assets/USDC.t.sol
+++ b/test/fork/assets/USDC.t.sol
@@ -1,10 +1,11 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { LockupDynamic_Fork_Test } from "../LockupDynamic.t.sol";
import { LockupLinear_Fork_Test } from "../LockupLinear.t.sol";
+import { LockupTranched_Fork_Test } from "../LockupTranched.t.sol";
/// @dev An ERC-20 asset with 6 decimals.
IERC20 constant ASSET = IERC20(0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48);
@@ -13,3 +14,5 @@ address constant HOLDER = 0x09528d637deb5857dc059dddE6316D465a8b3b69;
contract USDC_LockupDynamic_Fork_Test is LockupDynamic_Fork_Test(ASSET, HOLDER) { }
contract USDC_LockupLinear_Fork_Test is LockupLinear_Fork_Test(ASSET, HOLDER) { }
+
+contract USDC_LockupTranched_Fork_Test is LockupTranched_Fork_Test(ASSET, HOLDER) { }
diff --git a/test/fork/assets/USDT.t.sol b/test/fork/assets/USDT.t.sol
index 421144ca1..d2d803eec 100644
--- a/test/fork/assets/USDT.t.sol
+++ b/test/fork/assets/USDT.t.sol
@@ -1,10 +1,11 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { LockupDynamic_Fork_Test } from "../LockupDynamic.t.sol";
import { LockupLinear_Fork_Test } from "../LockupLinear.t.sol";
+import { LockupTranched_Fork_Test } from "../LockupTranched.t.sol";
/// @dev An ERC-20 asset that suffers from the missing return value bug.
IERC20 constant ASSET = IERC20(0xdAC17F958D2ee523a2206206994597C13D831ec7);
@@ -13,3 +14,5 @@ address constant HOLDER = 0xee5B5B923fFcE93A870B3104b7CA09c3db80047A;
contract USDT_LockupDynamic_Fork_Test is LockupDynamic_Fork_Test(ASSET, HOLDER) { }
contract USDT_LockupLinear_Fork_Test is LockupLinear_Fork_Test(ASSET, HOLDER) { }
+
+contract USDT_LockupTranched_Fork_Test is LockupTranched_Fork_Test(ASSET, HOLDER) { }
diff --git a/test/integration/Integration.t.sol b/test/integration/Integration.t.sol
index 2e0c62ab9..316657fef 100644
--- a/test/integration/Integration.t.sol
+++ b/test/integration/Integration.t.sol
@@ -1,24 +1,29 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
import { Base_Test } from "../Base.t.sol";
-import { FaultyFlashLoanReceiver } from "../mocks/flash-loan/FaultyFlashLoanReceiver.sol";
-import { ReentrantFlashLoanReceiver } from "../mocks/flash-loan/ReentrantFlashLoanReceiver.sol";
-import { ReentrantRecipient } from "../mocks/hooks/ReentrantRecipient.sol";
-import { RevertingRecipient } from "../mocks/hooks/RevertingRecipient.sol";
+import {
+ RecipientInterfaceIDIncorrect,
+ RecipientInterfaceIDMissing,
+ RecipientInvalidSelector,
+ RecipientReentrant,
+ RecipientReverting
+} from "../mocks/Hooks.sol";
/// @notice Common logic needed by all integration tests, both concrete and fuzz tests.
+
abstract contract Integration_Test is Base_Test {
/*//////////////////////////////////////////////////////////////////////////
TEST CONTRACTS
//////////////////////////////////////////////////////////////////////////*/
- FaultyFlashLoanReceiver internal faultyFlashLoanReceiver = new FaultyFlashLoanReceiver();
- ReentrantFlashLoanReceiver internal reentrantFlashLoanReceiver = new ReentrantFlashLoanReceiver();
- ReentrantRecipient internal reentrantRecipient = new ReentrantRecipient();
- RevertingRecipient internal revertingRecipient = new RevertingRecipient();
+ RecipientInterfaceIDIncorrect internal recipientInterfaceIDIncorrect = new RecipientInterfaceIDIncorrect();
+ RecipientInterfaceIDMissing internal recipientInterfaceIDMissing = new RecipientInterfaceIDMissing();
+ RecipientInvalidSelector internal recipientInvalidSelector = new RecipientInvalidSelector();
+ RecipientReentrant internal recipientReentrant = new RecipientReentrant();
+ RecipientReverting internal recipientReverting = new RecipientReverting();
/*//////////////////////////////////////////////////////////////////////////
SET-UP FUNCTION
@@ -27,17 +32,11 @@ abstract contract Integration_Test is Base_Test {
function setUp() public virtual override {
Base_Test.setUp();
- // Deploy V2 Core.
- deployCoreConditionally();
-
// Label the contracts.
labelContracts();
// Make the Admin the default caller in this test suite.
- vm.startPrank({ msgSender: users.admin });
-
- // Approve V2 Core to spend assets from the users.
- approveProtocol();
+ resetPrank({ msgSender: users.admin });
}
/*//////////////////////////////////////////////////////////////////////////
@@ -46,10 +45,11 @@ abstract contract Integration_Test is Base_Test {
/// @dev Labels the most relevant contracts.
function labelContracts() internal {
- vm.label({ account: address(faultyFlashLoanReceiver), newLabel: "Faulty Flash Loan Receiver" });
- vm.label({ account: address(reentrantFlashLoanReceiver), newLabel: "Reentrant Flash Loan Receiver" });
- vm.label({ account: address(reentrantRecipient), newLabel: "Reentrant Lockup Recipient" });
- vm.label({ account: address(revertingRecipient), newLabel: "Reverting Lockup Recipient" });
+ vm.label({ account: address(recipientInterfaceIDIncorrect), newLabel: "Recipient Interface ID Incorrect" });
+ vm.label({ account: address(recipientInterfaceIDMissing), newLabel: "Recipient Interface ID Missing" });
+ vm.label({ account: address(recipientInvalidSelector), newLabel: "Recipient Invalid Selector" });
+ vm.label({ account: address(recipientReentrant), newLabel: "Recipient Reentrant" });
+ vm.label({ account: address(recipientReverting), newLabel: "Recipient Reverting" });
}
/*//////////////////////////////////////////////////////////////////////////
@@ -57,7 +57,7 @@ abstract contract Integration_Test is Base_Test {
//////////////////////////////////////////////////////////////////////////*/
/// @dev Expects a delegate call error.
- function expectRevertDueToDelegateCall(bool success, bytes memory returnData) internal {
+ function expectRevertDueToDelegateCall(bool success, bytes memory returnData) internal pure {
assertFalse(success, "delegatecall success");
assertEq(returnData, abi.encodeWithSelector(Errors.DelegateCall.selector), "delegatecall return data");
}
diff --git a/test/integration/concrete/comptroller/protocol-fees/protocolFees.t.sol b/test/integration/concrete/comptroller/protocol-fees/protocolFees.t.sol
deleted file mode 100644
index d7af61c96..000000000
--- a/test/integration/concrete/comptroller/protocol-fees/protocolFees.t.sol
+++ /dev/null
@@ -1,32 +0,0 @@
-// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
-
-import { UD60x18, ZERO } from "@prb/math/src/UD60x18.sol";
-
-import { Integration_Test } from "../../../Integration.t.sol";
-
-contract ProtocolFees_Integration_Concrete_Test is Integration_Test {
- function setUp() public override {
- Integration_Test.setUp();
-
- // Make the Admin the caller in this test suite.
- changePrank({ msgSender: users.admin });
- }
-
- function test_ProtocolFees_ProtocolFeeNotSet() external {
- UD60x18 actualProtocolFee = comptroller.protocolFees(dai);
- UD60x18 expectedProtocolFee = ZERO;
- assertEq(actualProtocolFee, expectedProtocolFee, "protocolFees");
- }
-
- modifier givenProtocolFeeSet() {
- comptroller.setProtocolFee({ asset: dai, newProtocolFee: defaults.PROTOCOL_FEE() });
- _;
- }
-
- function test_ProtocolFees() external givenProtocolFeeSet {
- UD60x18 actualProtocolFee = comptroller.protocolFees(dai);
- UD60x18 expectedProtocolFee = defaults.PROTOCOL_FEE();
- assertEq(actualProtocolFee, expectedProtocolFee, "protocolFees");
- }
-}
diff --git a/test/integration/concrete/comptroller/protocol-fees/protocolFees.tree b/test/integration/concrete/comptroller/protocol-fees/protocolFees.tree
deleted file mode 100644
index c2e81b8d8..000000000
--- a/test/integration/concrete/comptroller/protocol-fees/protocolFees.tree
+++ /dev/null
@@ -1,5 +0,0 @@
-protocolFees.t.sol
-├── given the protocol fee has not been set
-│ └── it should return zero
-└── given the protocol fee has been set
- └── it should return the correct protocol fee
diff --git a/test/integration/concrete/comptroller/set-protocol-fee/setProtocolFee.t.sol b/test/integration/concrete/comptroller/set-protocol-fee/setProtocolFee.t.sol
deleted file mode 100644
index 91944a606..000000000
--- a/test/integration/concrete/comptroller/set-protocol-fee/setProtocolFee.t.sol
+++ /dev/null
@@ -1,58 +0,0 @@
-// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
-
-import { UD60x18, ZERO } from "@prb/math/src/UD60x18.sol";
-
-import { Errors } from "src/libraries/Errors.sol";
-
-import { Integration_Test } from "../../../Integration.t.sol";
-
-contract SetProtocolFee_Integration_Concrete_Test is Integration_Test {
- function test_RevertWhen_CallerNotAdmin() external {
- // Make Eve the caller in this test.
- changePrank({ msgSender: users.eve });
-
- // Run the test.
- vm.expectRevert(abi.encodeWithSelector(Errors.CallerNotAdmin.selector, users.admin, users.eve));
- comptroller.setProtocolFee({ asset: dai, newProtocolFee: MAX_FEE });
- }
-
- /// @dev The Admin is the default caller in the comptroller tests.
- modifier whenCallerAdmin() {
- _;
- }
-
- function test_SetProtocolFee_SameFee() external whenCallerAdmin {
- // Expect the relevant event to be emitted.
- vm.expectEmit({ emitter: address(comptroller) });
- emit SetProtocolFee({ admin: users.admin, asset: dai, oldProtocolFee: ZERO, newProtocolFee: ZERO });
-
- // Set the same protocol fee.
- comptroller.setProtocolFee({ asset: dai, newProtocolFee: ZERO });
-
- // Assert that the protocol fee has not changed.
- UD60x18 actualProtocolFee = comptroller.protocolFees(dai);
- UD60x18 expectedProtocolFee = ZERO;
- assertEq(actualProtocolFee, expectedProtocolFee, "protocolFee");
- }
-
- modifier whenNewFee() {
- _;
- }
-
- function test_SetProtocolFee() external whenCallerAdmin whenNewFee {
- UD60x18 newProtocolFee = defaults.FLASH_FEE();
-
- // Expect the relevant event to be emitted.
- vm.expectEmit({ emitter: address(comptroller) });
- emit SetProtocolFee({ admin: users.admin, asset: dai, oldProtocolFee: ZERO, newProtocolFee: newProtocolFee });
-
- // Set the new protocol fee.
- comptroller.setProtocolFee({ asset: dai, newProtocolFee: newProtocolFee });
-
- // Assert that the protocol fee has been updated.
- UD60x18 actualProtocolFee = comptroller.protocolFees(dai);
- UD60x18 expectedProtocolFee = newProtocolFee;
- assertEq(actualProtocolFee, expectedProtocolFee, "protocolFee");
- }
-}
diff --git a/test/integration/concrete/comptroller/set-protocol-fee/setProtocolFee.tree b/test/integration/concrete/comptroller/set-protocol-fee/setProtocolFee.tree
deleted file mode 100644
index 7bd610ee8..000000000
--- a/test/integration/concrete/comptroller/set-protocol-fee/setProtocolFee.tree
+++ /dev/null
@@ -1,11 +0,0 @@
-setProtocolFee.t.sol
-├── when the caller is not the admin
-│ └── it should revert
-└── when the caller is the admin
- ├── when the new protocol fee is the same as the current protocol fee
- │ ├── it should re-set the protocol fee
- │ └── it should emit a {SetProtocolFee} event
- └── when the new protocol fee is not the same as the current protocol fee
- ├── it should set the new protocol fee
- └── it should emit a {SetProtocolFee} event
-
diff --git a/test/integration/concrete/comptroller/toggle-flash-asset/toggleFlashAsset.t.sol b/test/integration/concrete/comptroller/toggle-flash-asset/toggleFlashAsset.t.sol
deleted file mode 100644
index 98ede2015..000000000
--- a/test/integration/concrete/comptroller/toggle-flash-asset/toggleFlashAsset.t.sol
+++ /dev/null
@@ -1,53 +0,0 @@
-// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
-
-import { Errors } from "src/libraries/Errors.sol";
-
-import { Integration_Test } from "../../../Integration.t.sol";
-
-contract ToggleFlashAsset_Integration_Concrete_Test is Integration_Test {
- function test_RevertWhen_CallerNotAdmin() external {
- // Make Eve the caller in this test.
- changePrank({ msgSender: users.eve });
-
- // Run the test.
- vm.expectRevert(abi.encodeWithSelector(Errors.CallerNotAdmin.selector, users.admin, users.eve));
- comptroller.toggleFlashAsset(dai);
- }
-
- /// @dev The admin is the default caller in the comptroller tests.
- modifier whenCallerAdmin() {
- _;
- }
-
- function test_ToggleFlashAsset_FlagNotEnabled() external whenCallerAdmin {
- // Expect the relevant event to be emitted.
- vm.expectEmit({ emitter: address(comptroller) });
- emit ToggleFlashAsset({ admin: users.admin, asset: dai, newFlag: true });
-
- // Toggle the flash asset.
- comptroller.toggleFlashAsset(dai);
-
- // Assert that the flash asset has been toggled.
- bool isFlashAsset = comptroller.isFlashAsset(dai);
- assertTrue(isFlashAsset, "isFlashAsset");
- }
-
- modifier givenFlagEnabled() {
- comptroller.toggleFlashAsset(dai);
- _;
- }
-
- function test_ToggleFlashAsset() external whenCallerAdmin givenFlagEnabled {
- // Expect the relevant event to be emitted.
- vm.expectEmit({ emitter: address(comptroller) });
- emit ToggleFlashAsset({ admin: users.admin, asset: dai, newFlag: false });
-
- // Toggle the flash asset.
- comptroller.toggleFlashAsset(dai);
-
- // Assert that the flash asset has been toggled.
- bool isFlashAsset = comptroller.isFlashAsset(dai);
- assertFalse(isFlashAsset, "isFlashAsset");
- }
-}
diff --git a/test/integration/concrete/comptroller/toggle-flash-asset/toggleFlashAsset.tree b/test/integration/concrete/comptroller/toggle-flash-asset/toggleFlashAsset.tree
deleted file mode 100644
index e6184a843..000000000
--- a/test/integration/concrete/comptroller/toggle-flash-asset/toggleFlashAsset.tree
+++ /dev/null
@@ -1,10 +0,0 @@
-toggleFlashAsset.t.sol
-├── when the caller is not the admin
-│ └── it should revert
-└── when the caller is the admin
- ├── given the flag is not enabled
- │ ├── it should toggle the flash asset
- │ └── it should emit a {ToggleFlashAsset} event
- └── given the flag is enabled
- ├── it should toggle the flash asset
- └── it should emit a {ToggleFlashAsset} event
diff --git a/test/integration/concrete/flash-loan/flash-fee/flashFee.t.sol b/test/integration/concrete/flash-loan/flash-fee/flashFee.t.sol
deleted file mode 100644
index f7eaf9f79..000000000
--- a/test/integration/concrete/flash-loan/flash-fee/flashFee.t.sol
+++ /dev/null
@@ -1,27 +0,0 @@
-// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
-
-import { ud } from "@prb/math/src/UD60x18.sol";
-
-import { Errors } from "src/libraries/Errors.sol";
-
-import { FlashLoan_Integration_Shared_Test } from "../../../shared/flash-loan/FlashLoan.t.sol";
-
-contract FlashFee_Integration_Concrete_Test is FlashLoan_Integration_Shared_Test {
- function test_RevertGiven_AssetNotFlashLoanable() external {
- vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2FlashLoan_AssetNotFlashLoanable.selector, dai));
- flashLoan.flashFee({ asset: address(dai), amount: 0 });
- }
-
- modifier givenAssetFlashLoanable() {
- comptroller.toggleFlashAsset(dai);
- _;
- }
-
- function test_FlashFee() external givenAssetFlashLoanable {
- uint256 amount = 782.23e18;
- uint256 actualFlashFee = flashLoan.flashFee({ asset: address(dai), amount: amount });
- uint256 expectedFlashFee = ud(amount).mul(defaults.FLASH_FEE()).intoUint256();
- assertEq(actualFlashFee, expectedFlashFee, "flashFee");
- }
-}
diff --git a/test/integration/concrete/flash-loan/flash-fee/flashFee.tree b/test/integration/concrete/flash-loan/flash-fee/flashFee.tree
deleted file mode 100644
index 106525e37..000000000
--- a/test/integration/concrete/flash-loan/flash-fee/flashFee.tree
+++ /dev/null
@@ -1,5 +0,0 @@
-flashFee.t.sol
-├── given the asset is not flash loanable
-│ └── it should revert
-└── given the asset is flash loanable
- └── it should return the correct flash fee
diff --git a/test/integration/concrete/flash-loan/flash-loan/flashLoan.t.sol b/test/integration/concrete/flash-loan/flash-loan/flashLoan.t.sol
deleted file mode 100644
index 6f67dcf6b..000000000
--- a/test/integration/concrete/flash-loan/flash-loan/flashLoan.t.sol
+++ /dev/null
@@ -1,145 +0,0 @@
-// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19;
-
-import { ud } from "@prb/math/src/UD60x18.sol";
-
-import { IERC3156FlashLender } from "src/interfaces/erc3156/IERC3156FlashLender.sol";
-import { Errors } from "src/libraries/Errors.sol";
-
-import { FlashLoanFunction_Integration_Shared_Test } from "../../../shared/flash-loan/flashLoanFunction.t.sol";
-
-contract FlashLoanFunction_Integration_Concrete_Test is FlashLoanFunction_Integration_Shared_Test {
- function setUp() public virtual override {
- FlashLoanFunction_Integration_Shared_Test.setUp();
- }
-
- function test_RevertWhen_DelegateCalled() external {
- bytes memory callData =
- abi.encodeCall(IERC3156FlashLender.flashLoan, (goodFlashLoanReceiver, address(dai), 0, bytes("")));
- (bool success, bytes memory returnData) = address(flashLoan).delegatecall(callData);
- expectRevertDueToDelegateCall(success, returnData);
- }
-
- function test_RevertWhen_AmountTooHigh() external whenNotDelegateCalled {
- uint256 amount = uint256(MAX_UINT128) + 1;
- vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2FlashLoan_AmountTooHigh.selector, amount));
- flashLoan.flashLoan({ receiver: goodFlashLoanReceiver, asset: address(dai), amount: amount, data: bytes("") });
- }
-
- function test_RevertGiven_AssetNotFlashLoanable() external whenNotDelegateCalled whenAmountNotTooHigh {
- vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2FlashLoan_AssetNotFlashLoanable.selector, dai));
- flashLoan.flashLoan({ receiver: goodFlashLoanReceiver, asset: address(dai), amount: 0, data: bytes("") });
- }
-
- function test_RevertWhen_CalculatedFeeTooHigh()
- external
- whenNotDelegateCalled
- whenAmountNotTooHigh
- givenAssetFlashLoanable
- {
- // Set the comptroller flash fee so that the calculated fee ends up being greater than 2^128.
- comptroller.setFlashFee({ newFlashFee: ud(1.1e18) });
-
- uint256 fee = flashLoan.flashFee({ asset: address(dai), amount: MAX_UINT128 });
- vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2FlashLoan_CalculatedFeeTooHigh.selector, fee));
- flashLoan.flashLoan({
- receiver: goodFlashLoanReceiver,
- asset: address(dai),
- amount: MAX_UINT128,
- data: bytes("")
- });
- }
-
- function test_RevertWhen_BorrowFailed()
- external
- whenNotDelegateCalled
- whenAmountNotTooHigh
- givenAssetFlashLoanable
- whenCalculatedFeeNotTooHigh
- {
- deal({ token: address(dai), to: address(flashLoan), give: LIQUIDITY_AMOUNT });
- vm.expectRevert(Errors.SablierV2FlashLoan_FlashBorrowFail.selector);
- flashLoan.flashLoan({
- receiver: faultyFlashLoanReceiver,
- asset: address(dai),
- amount: LIQUIDITY_AMOUNT,
- data: bytes("")
- });
- }
-
- function test_RevertWhen_Reentrancy()
- external
- whenNotDelegateCalled
- whenAmountNotTooHigh
- givenAssetFlashLoanable
- whenCalculatedFeeNotTooHigh
- whenBorrowDoesNotFail
- {
- uint256 amount = 100e18;
- deal({ token: address(dai), to: address(flashLoan), give: amount * 2 });
- vm.expectRevert("ERC20: transfer amount exceeds balance");
- flashLoan.flashLoan({
- receiver: reentrantFlashLoanReceiver,
- asset: address(dai),
- amount: LIQUIDITY_AMOUNT / 4,
- data: bytes("")
- });
- }
-
- function test_FlashLoan()
- external
- whenNotDelegateCalled
- whenAmountNotTooHigh
- givenAssetFlashLoanable
- whenCalculatedFeeNotTooHigh
- whenBorrowDoesNotFail
- whenNoReentrancy
- {
- // Mint the liquidity amount to the contract.
- deal({ token: address(dai), to: address(flashLoan), give: LIQUIDITY_AMOUNT });
-
- // Load the initial protocol revenues.
- uint128 initialProtocolRevenues = flashLoan.protocolRevenues(dai);
-
- // Load the flash fee.
- uint256 fee = flashLoan.flashFee({ asset: address(dai), amount: LIQUIDITY_AMOUNT });
-
- // Mint the flash fee to the receiver so that they can repay the flash loan.
- deal({ token: address(dai), to: address(goodFlashLoanReceiver), give: fee });
-
- // Expect `amount` of assets to be transferred to the receiver.
- expectCallToTransfer({ to: address(goodFlashLoanReceiver), amount: LIQUIDITY_AMOUNT });
-
- // Expect `amount+fee` of assets to be transferred back from the receiver.
- uint256 returnAmount = LIQUIDITY_AMOUNT + fee;
- expectCallToTransferFrom({ from: address(goodFlashLoanReceiver), to: address(flashLoan), amount: returnAmount });
-
- // Expect the relevant event to be emitted.
- vm.expectEmit({ emitter: address(flashLoan) });
- bytes memory data = bytes("Hello World");
- emit FlashLoan({
- initiator: users.admin,
- receiver: goodFlashLoanReceiver,
- asset: dai,
- amount: LIQUIDITY_AMOUNT,
- feeAmount: fee,
- data: data
- });
-
- // Execute the flash loan.
- bool response = flashLoan.flashLoan({
- receiver: goodFlashLoanReceiver,
- asset: address(dai),
- amount: LIQUIDITY_AMOUNT,
- data: data
- });
-
- // Assert that the returned response is `true`.
- assertTrue(response, "flashLoan response");
-
- // Assert that the protocol fee has been recorded.
- uint128 actualProtocolRevenues = flashLoan.protocolRevenues(dai);
- uint128 expectedProtocolRevenues = initialProtocolRevenues + uint128(fee);
- assertEq(actualProtocolRevenues, expectedProtocolRevenues, "protocolRevenues");
- }
-}
diff --git a/test/integration/concrete/flash-loan/flash-loan/flashLoan.tree b/test/integration/concrete/flash-loan/flash-loan/flashLoan.tree
deleted file mode 100644
index f2af3ec8b..000000000
--- a/test/integration/concrete/flash-loan/flash-loan/flashLoan.tree
+++ /dev/null
@@ -1,26 +0,0 @@
-flashLoan.t.sol
-├── when delegate called
-│ └── it should revert
-└── when not delegate called
- ├── when the flash loan amount is too high
- │ └── it should revert
- └── when the flash loan amount is not too high
- ├── given the asset is not flash loanable
- │ └── it should revert
- └── given the asset is flash loanable
- ├── when the calculated fee is too high
- │ └── it should revert
- └── when the calculated fee is not too high
- ├── when the flash loan amount is greater than the available liquidity
- │ └── it should revert
- └── when the flash loan amount is less than or equal to the available liquidity
- ├── when the receiver does not return the correct response
- │ └── it should revert
- └── when the receiver returns the correct response
- ├── when there is reentrancy
- │ └── it should revert
- └── when there is no reentrancy
- ├── it should execute the flash loan
- ├── it should make the ERC-20 transfers
- ├── it should update the protocol revenues
- └── it should emit a {FlashLoan} event
diff --git a/test/integration/concrete/flash-loan/max-flash-loan/maxFlashLoan.t.sol b/test/integration/concrete/flash-loan/max-flash-loan/maxFlashLoan.t.sol
deleted file mode 100644
index 2f52a376c..000000000
--- a/test/integration/concrete/flash-loan/max-flash-loan/maxFlashLoan.t.sol
+++ /dev/null
@@ -1,25 +0,0 @@
-// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
-
-import { FlashLoan_Integration_Shared_Test } from "../../../shared/flash-loan/FlashLoan.t.sol";
-
-contract MaxFlashLoan_Integration_Concrete_Test is FlashLoan_Integration_Shared_Test {
- function test_MaxFlashLoan_AssetNotFlashLoanable() external {
- uint256 actualAmount = flashLoan.maxFlashLoan(address(dai));
- uint256 expectedAmount = 0;
- assertEq(actualAmount, expectedAmount, "maxFlashLoan amount");
- }
-
- modifier givenAssetFlashLoanable() {
- comptroller.toggleFlashAsset(dai);
- _;
- }
-
- function test_MaxFlashLoan() external givenAssetFlashLoanable {
- uint256 dealAmount = 14_607_904e18;
- deal({ token: address(dai), to: address(flashLoan), give: dealAmount });
- uint256 actualAmount = flashLoan.maxFlashLoan(address(dai));
- uint256 expectedAmount = dealAmount;
- assertEq(actualAmount, expectedAmount, "maxFlashLoan amount");
- }
-}
diff --git a/test/integration/concrete/flash-loan/max-flash-loan/maxFlashLoan.tree b/test/integration/concrete/flash-loan/max-flash-loan/maxFlashLoan.tree
deleted file mode 100644
index 7eedfcdd9..000000000
--- a/test/integration/concrete/flash-loan/max-flash-loan/maxFlashLoan.tree
+++ /dev/null
@@ -1,5 +0,0 @@
-maxFlashLoan.t.sol
-├── given the asset is not flash loanable
-│ └── it should revert
-└── given the asset is flash loanable
- └── it should return the correct max flash loan
diff --git a/test/integration/concrete/lockup-dynamic/LockupDynamic.t.sol b/test/integration/concrete/lockup-dynamic/LockupDynamic.t.sol
index c5ff9c6e7..cca53bda0 100644
--- a/test/integration/concrete/lockup-dynamic/LockupDynamic.t.sol
+++ b/test/integration/concrete/lockup-dynamic/LockupDynamic.t.sol
@@ -1,15 +1,14 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { ISablierV2Lockup } from "src/interfaces/ISablierV2Lockup.sol";
import { LockupDynamic_Integration_Shared_Test } from "../../shared/lockup-dynamic/LockupDynamic.t.sol";
import { Integration_Test } from "../../Integration.t.sol";
+import { AllowToHook_Integration_Concrete_Test } from "../lockup/allow-to-hook/allowToHook.t.sol";
import { Burn_Integration_Concrete_Test } from "../lockup/burn/burn.t.sol";
import { Cancel_Integration_Concrete_Test } from "../lockup/cancel/cancel.t.sol";
import { CancelMultiple_Integration_Concrete_Test } from "../lockup/cancel-multiple/cancelMultiple.t.sol";
-import { ClaimProtocolRevenues_Integration_Concrete_Test } from
- "../lockup/claim-protocol-revenues/claimProtocolRevenues.t.sol";
import { GetAsset_Integration_Concrete_Test } from "../lockup/get-asset/getAsset.t.sol";
import { GetDepositedAmount_Integration_Concrete_Test } from "../lockup/get-deposited-amount/getDepositedAmount.t.sol";
import { GetEndTime_Integration_Concrete_Test } from "../lockup/get-end-time/getEndTime.t.sol";
@@ -18,21 +17,21 @@ import { GetRefundedAmount_Integration_Concrete_Test } from "../lockup/get-refun
import { GetSender_Integration_Concrete_Test } from "../lockup/get-sender/getSender.t.sol";
import { GetStartTime_Integration_Concrete_Test } from "../lockup/get-start-time/getStartTime.t.sol";
import { GetWithdrawnAmount_Integration_Concrete_Test } from "../lockup/get-withdrawn-amount/getWithdrawnAmount.t.sol";
+import { IsAllowedToHook_Integration_Concrete_Test } from "../lockup/is-allowed-to-hook/isAllowedToHook.t.sol";
import { IsCancelable_Integration_Concrete_Test } from "../lockup/is-cancelable/isCancelable.t.sol";
import { IsCold_Integration_Concrete_Test } from "../lockup/is-cold/isCold.t.sol";
import { IsDepleted_Integration_Concrete_Test } from "../lockup/is-depleted/isDepleted.t.sol";
import { IsStream_Integration_Concrete_Test } from "../lockup/is-stream/isStream.t.sol";
import { IsTransferable_Integration_Concrete_Test } from "../lockup/is-transferable/isTransferable.t.sol";
import { IsWarm_Integration_Concrete_Test } from "../lockup/is-warm/isWarm.t.sol";
-import { ProtocolRevenues_Integration_Concrete_Test } from "../lockup/protocol-revenues/protocolRevenues.t.sol";
import { RefundableAmountOf_Integration_Concrete_Test } from "../lockup/refundable-amount-of/refundableAmountOf.t.sol";
import { Renounce_Integration_Concrete_Test } from "../lockup/renounce/renounce.t.sol";
-import { SetComptroller_Integration_Concrete_Test } from "../lockup/set-comptroller/setComptroller.t.sol";
import { SetNFTDescriptor_Integration_Concrete_Test } from "../lockup/set-nft-descriptor/setNFTDescriptor.t.sol";
import { StatusOf_Integration_Concrete_Test } from "../lockup/status-of/statusOf.t.sol";
import { TransferFrom_Integration_Concrete_Test } from "../lockup/transfer-from/transferFrom.t.sol";
-import { Withdraw_Integration_Concrete_Test } from "../lockup/withdraw/withdraw.t.sol";
import { WasCanceled_Integration_Concrete_Test } from "../lockup/was-canceled/wasCanceled.t.sol";
+import { Withdraw_Integration_Concrete_Test } from "../lockup/withdraw/withdraw.t.sol";
+import { WithdrawHooks_Integration_Concrete_Test } from "../lockup/withdraw-hooks/withdrawHooks.t.sol";
import { WithdrawMax_Integration_Concrete_Test } from "../lockup/withdraw-max/withdrawMax.t.sol";
import { WithdrawMaxAndTransfer_Integration_Concrete_Test } from
"../lockup/withdraw-max-and-transfer/withdrawMaxAndTransfer.t.sol";
@@ -50,8 +49,7 @@ abstract contract LockupDynamic_Integration_Concrete_Test is Integration_Test, L
Integration_Test.setUp();
LockupDynamic_Integration_Shared_Test.setUp();
- // Cast the LockupDynamic contract as {ISablierV2Base} and {ISablierV2Lockup}.
- base = ISablierV2Lockup(lockupDynamic);
+ // Cast the {LockupDynamic} contract as {ISablierV2Lockup}.
lockup = ISablierV2Lockup(lockupDynamic);
}
}
@@ -60,6 +58,20 @@ abstract contract LockupDynamic_Integration_Concrete_Test is Integration_Test, L
SHARED TESTS
//////////////////////////////////////////////////////////////////////////*/
+contract AllowToHook_LockupDynamic_Integration_Concrete_Test is
+ LockupDynamic_Integration_Concrete_Test,
+ AllowToHook_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupDynamic_Integration_Concrete_Test, AllowToHook_Integration_Concrete_Test)
+ {
+ LockupDynamic_Integration_Concrete_Test.setUp();
+ AllowToHook_Integration_Concrete_Test.setUp();
+ }
+}
+
contract Burn_LockupDynamic_Integration_Concrete_Test is
LockupDynamic_Integration_Concrete_Test,
Burn_Integration_Concrete_Test
@@ -98,20 +110,6 @@ contract CancelMultiple_LockupDynamic_Integration_Concrete_Test is
}
}
-contract ClaimProtocolRevenues_LockupDynamic_Integration_Concrete_Test is
- LockupDynamic_Integration_Concrete_Test,
- ClaimProtocolRevenues_Integration_Concrete_Test
-{
- function setUp()
- public
- virtual
- override(LockupDynamic_Integration_Concrete_Test, ClaimProtocolRevenues_Integration_Concrete_Test)
- {
- LockupDynamic_Integration_Concrete_Test.setUp();
- ClaimProtocolRevenues_Integration_Concrete_Test.setUp();
- }
-}
-
contract GetAsset_LockupDynamic_Integration_Concrete_Test is
LockupDynamic_Integration_Concrete_Test,
GetAsset_Integration_Concrete_Test
@@ -224,6 +222,20 @@ contract GetWithdrawnAmount_LockupDynamic_Integration_Concrete_Test is
}
}
+contract IsAllowedToHook_LockupDynamic_Integration_Concrete_Test is
+ LockupDynamic_Integration_Concrete_Test,
+ IsAllowedToHook_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupDynamic_Integration_Concrete_Test, IsAllowedToHook_Integration_Concrete_Test)
+ {
+ LockupDynamic_Integration_Concrete_Test.setUp();
+ IsAllowedToHook_Integration_Concrete_Test.setUp();
+ }
+}
+
contract IsCancelable_LockupDynamic_Integration_Concrete_Test is
LockupDynamic_Integration_Concrete_Test,
IsCancelable_Integration_Concrete_Test
@@ -308,20 +320,6 @@ contract IsWarm_LockupDynamic_Integration_Concrete_Test is
}
}
-contract ProtocolRevenues_LockupDynamic_Integration_Concrete_Test is
- LockupDynamic_Integration_Concrete_Test,
- ProtocolRevenues_Integration_Concrete_Test
-{
- function setUp()
- public
- virtual
- override(LockupDynamic_Integration_Concrete_Test, ProtocolRevenues_Integration_Concrete_Test)
- {
- LockupDynamic_Integration_Concrete_Test.setUp();
- ProtocolRevenues_Integration_Concrete_Test.setUp();
- }
-}
-
contract RefundableAmountOf_LockupDynamic_Integration_Concrete_Test is
LockupDynamic_Integration_Concrete_Test,
RefundableAmountOf_Integration_Concrete_Test
@@ -350,20 +348,6 @@ contract Renounce_LockupDynamic_Integration_Concrete_Test is
}
}
-contract SetComptroller_LockupDynamic_Integration_Concrete_Test is
- LockupDynamic_Integration_Concrete_Test,
- SetComptroller_Integration_Concrete_Test
-{
- function setUp()
- public
- virtual
- override(LockupDynamic_Integration_Concrete_Test, SetComptroller_Integration_Concrete_Test)
- {
- LockupDynamic_Integration_Concrete_Test.setUp();
- SetComptroller_Integration_Concrete_Test.setUp();
- }
-}
-
contract SetNFTDescriptor_LockupDynamic_Integration_Concrete_Test is
LockupDynamic_Integration_Concrete_Test,
SetNFTDescriptor_Integration_Concrete_Test
@@ -434,6 +418,20 @@ contract Withdraw_LockupDynamic_Integration_Concrete_Test is
}
}
+contract WithdrawHooks_LockupDynamic_Integration_Concrete_Test is
+ LockupDynamic_Integration_Concrete_Test,
+ WithdrawHooks_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupDynamic_Integration_Concrete_Test, WithdrawHooks_Integration_Concrete_Test)
+ {
+ LockupDynamic_Integration_Concrete_Test.setUp();
+ WithdrawHooks_Integration_Concrete_Test.setUp();
+ }
+}
+
contract WithdrawMax_LockupDynamic_Integration_Concrete_Test is
LockupDynamic_Integration_Concrete_Test,
WithdrawMax_Integration_Concrete_Test
diff --git a/test/integration/concrete/lockup-dynamic/constructor.t.sol b/test/integration/concrete/lockup-dynamic/constructor.t.sol
index 01cb03c8b..89bb8c07f 100644
--- a/test/integration/concrete/lockup-dynamic/constructor.t.sol
+++ b/test/integration/concrete/lockup-dynamic/constructor.t.sol
@@ -1,6 +1,7 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
+import { UD60x18 } from "@prb/math/src/UD60x18.sol";
import { SablierV2LockupDynamic } from "src/SablierV2LockupDynamic.sol";
import { LockupDynamic_Integration_Concrete_Test } from "./LockupDynamic.t.sol";
@@ -14,25 +15,31 @@ contract Constructor_LockupDynamic_Integration_Concrete_Test is LockupDynamic_In
// Construct the contract.
SablierV2LockupDynamic constructedLockupDynamic = new SablierV2LockupDynamic({
initialAdmin: users.admin,
- initialComptroller: comptroller,
initialNFTDescriptor: nftDescriptor,
maxSegmentCount: defaults.MAX_SEGMENT_COUNT()
});
- // {SablierV2Base.constructor}
+ // {SablierV2Lockup.constant}
+ UD60x18 actualMaxBrokerFee = constructedLockupDynamic.MAX_BROKER_FEE();
+ UD60x18 expectedMaxBrokerFee = UD60x18.wrap(0.1e18);
+ assertEq(actualMaxBrokerFee, expectedMaxBrokerFee, "MAX_BROKER_FEE");
+
+ // {SablierV2Lockup.constructor}
address actualAdmin = constructedLockupDynamic.admin();
address expectedAdmin = users.admin;
assertEq(actualAdmin, expectedAdmin, "admin");
- address actualComptroller = address(constructedLockupDynamic.comptroller());
- address expectedComptroller = address(comptroller);
- assertEq(actualComptroller, expectedComptroller, "comptroller");
-
- // {SablierV2Lockup.constructor}
uint256 actualStreamId = constructedLockupDynamic.nextStreamId();
uint256 expectedStreamId = 1;
assertEq(actualStreamId, expectedStreamId, "nextStreamId");
+ address actualNFTDescriptor = address(constructedLockupDynamic.nftDescriptor());
+ address expectedNFTDescriptor = address(nftDescriptor);
+ assertEq(actualNFTDescriptor, expectedNFTDescriptor, "nftDescriptor");
+
+ // {SablierV2Lockup.supportsInterface}
+ assertTrue(constructedLockupDynamic.supportsInterface(0x49064906), "ERC-4906 interface ID");
+
// {SablierV2LockupDynamic.constructor}
uint256 actualMaxSegmentCount = constructedLockupDynamic.MAX_SEGMENT_COUNT();
uint256 expectedMaxSegmentCount = defaults.MAX_SEGMENT_COUNT();
diff --git a/test/integration/concrete/lockup-dynamic/create-with-deltas/createWithDeltas.t.sol b/test/integration/concrete/lockup-dynamic/create-with-deltas/createWithDeltas.t.sol
deleted file mode 100644
index cd79d99a4..000000000
--- a/test/integration/concrete/lockup-dynamic/create-with-deltas/createWithDeltas.t.sol
+++ /dev/null
@@ -1,197 +0,0 @@
-// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
-
-import { ud2x18 } from "@prb/math/src/UD2x18.sol";
-
-import { ISablierV2LockupDynamic } from "src/interfaces/ISablierV2LockupDynamic.sol";
-import { Errors } from "src/libraries/Errors.sol";
-import { Lockup, LockupDynamic } from "src/types/DataTypes.sol";
-
-import { CreateWithDeltas_Integration_Shared_Test } from "../../../shared/lockup-dynamic/createWithDeltas.t.sol";
-import { LockupDynamic_Integration_Concrete_Test } from "../LockupDynamic.t.sol";
-
-contract CreateWithDeltas_LockupDynamic_Integration_Concrete_Test is
- LockupDynamic_Integration_Concrete_Test,
- CreateWithDeltas_Integration_Shared_Test
-{
- function setUp()
- public
- virtual
- override(LockupDynamic_Integration_Concrete_Test, CreateWithDeltas_Integration_Shared_Test)
- {
- LockupDynamic_Integration_Concrete_Test.setUp();
- CreateWithDeltas_Integration_Shared_Test.setUp();
- streamId = lockupDynamic.nextStreamId();
- }
-
- /// @dev it should revert.
- function test_RevertWhen_DelegateCalled() external {
- bytes memory callData = abi.encodeCall(ISablierV2LockupDynamic.createWithDeltas, defaults.createWithDeltas());
- (bool success, bytes memory returnData) = address(lockupDynamic).delegatecall(callData);
- expectRevertDueToDelegateCall(success, returnData);
- }
-
- /// @dev it should revert.
- function test_RevertWhen_LoopCalculationOverflowsBlockGasLimit() external whenNotDelegateCalled {
- LockupDynamic.SegmentWithDelta[] memory segments = new LockupDynamic.SegmentWithDelta[](250_000);
- vm.expectRevert(bytes(""));
- createDefaultStreamWithDeltas(segments);
- }
-
- function test_RevertWhen_DeltasZero()
- external
- whenNotDelegateCalled
- whenLoopCalculationsDoNotOverflowBlockGasLimit
- {
- uint40 startTime = getBlockTimestamp();
- LockupDynamic.SegmentWithDelta[] memory segments = defaults.createWithDeltas().segments;
- segments[1].delta = 0;
- uint256 index = 1;
- vm.expectRevert(
- abi.encodeWithSelector(
- Errors.SablierV2LockupDynamic_SegmentMilestonesNotOrdered.selector,
- index,
- startTime + segments[0].delta,
- startTime + segments[0].delta
- )
- );
- createDefaultStreamWithDeltas(segments);
- }
-
- function test_RevertWhen_MilestonesCalculationsOverflows_StartTimeNotLessThanFirstSegmentMilestone()
- external
- whenNotDelegateCalled
- whenLoopCalculationsDoNotOverflowBlockGasLimit
- whenDeltasNotZero
- {
- unchecked {
- uint40 startTime = getBlockTimestamp();
- LockupDynamic.SegmentWithDelta[] memory segments = defaults.createWithDeltas().segments;
- segments[0].delta = MAX_UINT40;
- vm.expectRevert(
- abi.encodeWithSelector(
- Errors.SablierV2LockupDynamic_StartTimeNotLessThanFirstSegmentMilestone.selector,
- startTime,
- startTime + segments[0].delta
- )
- );
- createDefaultStreamWithDeltas(segments);
- }
- }
-
- function test_RevertWhen_MilestonesCalculationsOverflows_SegmentMilestonesNotOrdered()
- external
- whenNotDelegateCalled
- whenLoopCalculationsDoNotOverflowBlockGasLimit
- whenDeltasNotZero
- {
- unchecked {
- uint40 startTime = getBlockTimestamp();
-
- // Create new segments that overflow when the milestones are eventually calculated.
- LockupDynamic.SegmentWithDelta[] memory segments = new LockupDynamic.SegmentWithDelta[](2);
- segments[0] =
- LockupDynamic.SegmentWithDelta({ amount: 0, exponent: ud2x18(1e18), delta: startTime + 1 seconds });
- segments[1] = defaults.segmentsWithDeltas()[0];
- segments[1].delta = MAX_UINT40;
-
- // Expect the relevant error to be thrown.
- uint256 index = 1;
- vm.expectRevert(
- abi.encodeWithSelector(
- Errors.SablierV2LockupDynamic_SegmentMilestonesNotOrdered.selector,
- index,
- startTime + segments[0].delta,
- startTime + segments[0].delta + segments[1].delta
- )
- );
-
- // Create the stream.
- createDefaultStreamWithDeltas(segments);
- }
- }
-
- function test_CreateWithDeltas()
- external
- whenNotDelegateCalled
- whenLoopCalculationsDoNotOverflowBlockGasLimit
- whenDeltasNotZero
- whenMilestonesCalculationsDoNotOverflow
- {
- // Make the Sender the stream's funder
- address funder = users.sender;
-
- // Load the initial protocol revenues.
- uint128 initialProtocolRevenues = lockupDynamic.protocolRevenues(dai);
-
- // Declare the range.
- uint40 currentTime = getBlockTimestamp();
- LockupDynamic.Range memory range =
- LockupDynamic.Range({ start: currentTime, end: currentTime + defaults.TOTAL_DURATION() });
-
- // Adjust the segments.
- LockupDynamic.SegmentWithDelta[] memory segmentsWithDeltas = defaults.segmentsWithDeltas();
- LockupDynamic.Segment[] memory segments = defaults.segments();
- segments[0].milestone = range.start + segmentsWithDeltas[0].delta;
- segments[1].milestone = segments[0].milestone + segmentsWithDeltas[1].delta;
-
- // Expect the assets to be transferred from the funder to {SablierV2LockupDynamic}.
- expectCallToTransferFrom({
- from: funder,
- to: address(lockupDynamic),
- amount: defaults.DEPOSIT_AMOUNT() + defaults.PROTOCOL_FEE_AMOUNT()
- });
-
- // Expect the broker fee to be paid to the broker.
- expectCallToTransferFrom({ from: funder, to: users.broker, amount: defaults.BROKER_FEE_AMOUNT() });
-
- // Expect the relevant events to be emitted.
- vm.expectEmit({ emitter: address(lockupDynamic) });
- emit MetadataUpdate({ _tokenId: streamId });
- vm.expectEmit({ emitter: address(lockupDynamic) });
- emit CreateLockupDynamicStream({
- streamId: streamId,
- funder: funder,
- sender: users.sender,
- recipient: users.recipient,
- amounts: defaults.lockupCreateAmounts(),
- asset: dai,
- cancelable: true,
- transferable: true,
- segments: segments,
- range: range,
- broker: users.broker
- });
-
- // Create the stream.
- createDefaultStreamWithDeltas();
-
- // Assert that the stream has been created.
- LockupDynamic.Stream memory actualStream = lockupDynamic.getStream(streamId);
- LockupDynamic.Stream memory expectedStream = defaults.lockupDynamicStream();
- expectedStream.endTime = range.end;
- expectedStream.segments = segments;
- expectedStream.startTime = range.start;
- assertEq(actualStream, expectedStream);
-
- // Assert that the stream's status is "STREAMING".
- Lockup.Status actualStatus = lockupDynamic.statusOf(streamId);
- Lockup.Status expectedStatus = Lockup.Status.STREAMING;
- assertEq(actualStatus, expectedStatus);
-
- // Assert that the next stream id has been bumped.
- uint256 actualNextStreamId = lockupDynamic.nextStreamId();
- uint256 expectedNextStreamId = streamId + 1;
- assertEq(actualNextStreamId, expectedNextStreamId, "nextStreamId");
-
- // Assert that the protocol fee has been recorded.
- uint128 actualProtocolRevenues = lockupDynamic.protocolRevenues(dai);
- uint128 expectedProtocolRevenues = initialProtocolRevenues + defaults.PROTOCOL_FEE_AMOUNT();
- assertEq(actualProtocolRevenues, expectedProtocolRevenues, "protocolRevenues");
-
- // Assert that the NFT has been minted.
- address actualNFTOwner = lockupDynamic.ownerOf({ tokenId: streamId });
- address expectedNFTOwner = users.recipient;
- assertEq(actualNFTOwner, expectedNFTOwner, "NFT owner");
- }
-}
diff --git a/test/integration/concrete/lockup-dynamic/create-with-durations/createWithDurations.t.sol b/test/integration/concrete/lockup-dynamic/create-with-durations/createWithDurations.t.sol
new file mode 100644
index 000000000..4edb555f3
--- /dev/null
+++ b/test/integration/concrete/lockup-dynamic/create-with-durations/createWithDurations.t.sol
@@ -0,0 +1,185 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22 <0.9.0;
+
+import { ud2x18 } from "@prb/math/src/UD2x18.sol";
+
+import { ISablierV2LockupDynamic } from "src/interfaces/ISablierV2LockupDynamic.sol";
+import { Errors } from "src/libraries/Errors.sol";
+import { Lockup, LockupDynamic } from "src/types/DataTypes.sol";
+
+import { CreateWithDurations_Integration_Shared_Test } from "../../../shared/lockup/createWithDurations.t.sol";
+import { LockupDynamic_Integration_Concrete_Test } from "../LockupDynamic.t.sol";
+
+contract CreateWithDurations_LockupDynamic_Integration_Concrete_Test is
+ LockupDynamic_Integration_Concrete_Test,
+ CreateWithDurations_Integration_Shared_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupDynamic_Integration_Concrete_Test, CreateWithDurations_Integration_Shared_Test)
+ {
+ LockupDynamic_Integration_Concrete_Test.setUp();
+ CreateWithDurations_Integration_Shared_Test.setUp();
+ streamId = lockupDynamic.nextStreamId();
+ }
+
+ /// @dev it should revert.
+ function test_RevertWhen_DelegateCalled() external {
+ bytes memory callData =
+ abi.encodeCall(ISablierV2LockupDynamic.createWithDurations, defaults.createWithDurationsLD());
+ (bool success, bytes memory returnData) = address(lockupDynamic).delegatecall(callData);
+ expectRevertDueToDelegateCall(success, returnData);
+ }
+
+ /// @dev it should revert.
+ function test_RevertWhen_SegmentCountTooHigh() external whenNotDelegateCalled {
+ LockupDynamic.SegmentWithDuration[] memory segments = new LockupDynamic.SegmentWithDuration[](25_000);
+ vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2LockupDynamic_SegmentCountTooHigh.selector, 25_000));
+ createDefaultStreamWithDurations(segments);
+ }
+
+ function test_RevertWhen_DurationsZero() external whenNotDelegateCalled whenSegmentCountNotTooHigh {
+ uint40 startTime = getBlockTimestamp();
+ LockupDynamic.SegmentWithDuration[] memory segments = defaults.createWithDurationsLD().segments;
+ segments[1].duration = 0;
+ uint256 index = 1;
+ vm.expectRevert(
+ abi.encodeWithSelector(
+ Errors.SablierV2LockupDynamic_SegmentTimestampsNotOrdered.selector,
+ index,
+ startTime + segments[0].duration,
+ startTime + segments[0].duration
+ )
+ );
+ createDefaultStreamWithDurations(segments);
+ }
+
+ function test_RevertWhen_TimestampsCalculationsOverflows_StartTimeNotLessThanFirstSegmentTimestamp()
+ external
+ whenNotDelegateCalled
+ whenSegmentCountNotTooHigh
+ whenDurationsNotZero
+ {
+ unchecked {
+ uint40 startTime = getBlockTimestamp();
+ LockupDynamic.SegmentWithDuration[] memory segments = defaults.segmentsWithDurations();
+ segments[0].duration = MAX_UINT40;
+ vm.expectRevert(
+ abi.encodeWithSelector(
+ Errors.SablierV2LockupDynamic_StartTimeNotLessThanFirstSegmentTimestamp.selector,
+ startTime,
+ startTime + segments[0].duration
+ )
+ );
+ createDefaultStreamWithDurations(segments);
+ }
+ }
+
+ function test_RevertWhen_TimestampsCalculationsOverflows_SegmentTimestampsNotOrdered()
+ external
+ whenNotDelegateCalled
+ whenSegmentCountNotTooHigh
+ whenDurationsNotZero
+ {
+ unchecked {
+ uint40 startTime = getBlockTimestamp();
+
+ // Create new segments that overflow when the timestamps are eventually calculated.
+ LockupDynamic.SegmentWithDuration[] memory segments = new LockupDynamic.SegmentWithDuration[](2);
+ segments[0] = LockupDynamic.SegmentWithDuration({
+ amount: 0,
+ exponent: ud2x18(1e18),
+ duration: startTime + 1 seconds
+ });
+ segments[1] = defaults.segmentsWithDurations()[0];
+ segments[1].duration = MAX_UINT40;
+
+ // Expect the relevant error to be thrown.
+ uint256 index = 1;
+ vm.expectRevert(
+ abi.encodeWithSelector(
+ Errors.SablierV2LockupDynamic_SegmentTimestampsNotOrdered.selector,
+ index,
+ startTime + segments[0].duration,
+ startTime + segments[0].duration + segments[1].duration
+ )
+ );
+
+ // Create the stream.
+ createDefaultStreamWithDurations(segments);
+ }
+ }
+
+ function test_CreateWithDurations()
+ external
+ whenNotDelegateCalled
+ whenSegmentCountNotTooHigh
+ whenDurationsNotZero
+ whenTimestampsCalculationsDoNotOverflow
+ {
+ // Make the Sender the stream's funder
+ address funder = users.sender;
+
+ // Declare the timestamps.
+ uint40 blockTimestamp = getBlockTimestamp();
+ LockupDynamic.Timestamps memory timestamps =
+ LockupDynamic.Timestamps({ start: blockTimestamp, end: blockTimestamp + defaults.TOTAL_DURATION() });
+
+ // Adjust the segments.
+ LockupDynamic.SegmentWithDuration[] memory segmentsWithDurations = defaults.segmentsWithDurations();
+ LockupDynamic.Segment[] memory segments = defaults.segments();
+ segments[0].timestamp = timestamps.start + segmentsWithDurations[0].duration;
+ segments[1].timestamp = segments[0].timestamp + segmentsWithDurations[1].duration;
+
+ // Expect the assets to be transferred from the funder to {SablierV2LockupDynamic}.
+ expectCallToTransferFrom({ from: funder, to: address(lockupDynamic), value: defaults.DEPOSIT_AMOUNT() });
+
+ // Expect the broker fee to be paid to the broker.
+ expectCallToTransferFrom({ from: funder, to: users.broker, value: defaults.BROKER_FEE_AMOUNT() });
+
+ // Expect the relevant events to be emitted.
+ vm.expectEmit({ emitter: address(lockupDynamic) });
+ emit MetadataUpdate({ _tokenId: streamId });
+ vm.expectEmit({ emitter: address(lockupDynamic) });
+ emit CreateLockupDynamicStream({
+ streamId: streamId,
+ funder: funder,
+ sender: users.sender,
+ recipient: users.recipient,
+ amounts: defaults.lockupCreateAmounts(),
+ asset: dai,
+ cancelable: true,
+ transferable: true,
+ segments: segments,
+ timestamps: timestamps,
+ broker: users.broker
+ });
+
+ // Create the stream.
+ createDefaultStreamWithDurations();
+
+ // Assert that the stream has been created.
+ LockupDynamic.StreamLD memory actualStream = lockupDynamic.getStream(streamId);
+ LockupDynamic.StreamLD memory expectedStream = defaults.lockupDynamicStream();
+ expectedStream.endTime = timestamps.end;
+ expectedStream.segments = segments;
+ expectedStream.startTime = timestamps.start;
+ assertEq(actualStream, expectedStream);
+
+ // Assert that the stream's status is "STREAMING".
+ Lockup.Status actualStatus = lockupDynamic.statusOf(streamId);
+ Lockup.Status expectedStatus = Lockup.Status.STREAMING;
+ assertEq(actualStatus, expectedStatus);
+
+ // Assert that the next stream ID has been bumped.
+ uint256 actualNextStreamId = lockupDynamic.nextStreamId();
+ uint256 expectedNextStreamId = streamId + 1;
+ assertEq(actualNextStreamId, expectedNextStreamId, "nextStreamId");
+
+ // Assert that the NFT has been minted.
+ address actualNFTOwner = lockupDynamic.ownerOf({ tokenId: streamId });
+ address expectedNFTOwner = users.recipient;
+ assertEq(actualNFTOwner, expectedNFTOwner, "NFT owner");
+ }
+}
diff --git a/test/integration/concrete/lockup-dynamic/create-with-deltas/createWithDeltas.tree b/test/integration/concrete/lockup-dynamic/create-with-durations/createWithDurations.tree
similarity index 51%
rename from test/integration/concrete/lockup-dynamic/create-with-deltas/createWithDeltas.tree
rename to test/integration/concrete/lockup-dynamic/create-with-durations/createWithDurations.tree
index 3824747f3..fa917579a 100644
--- a/test/integration/concrete/lockup-dynamic/create-with-deltas/createWithDeltas.tree
+++ b/test/integration/concrete/lockup-dynamic/create-with-durations/createWithDurations.tree
@@ -1,22 +1,21 @@
-createWithDeltas.t.sol
+createWithDurations.t.sol
├── when delegate called
│ └── it should revert
└── when not delegate called
- ├── when the loop calculations overflow the block gas limit
+ ├── when the segment count is too high
│ └── it should revert
- └── when the loop calculations do not overflow the block gas limit
- ├── when at least one of the deltas at index one or greater is zero
+ └── when the segment count is not too high
+ ├── when at least one of the durations at index one or greater is zero
│ └── it should revert
- └── when none of the deltas is zero
- ├── when the segment milestone calculations overflow uint256
- │ ├── when the start time is not less than the first segment milestone
+ └── when none of the durations is zero
+ ├── when the segment timestamp calculations overflow uint256
+ │ ├── when the start time is not less than the first segment timestamp
│ │ └── it should revert
- │ └── when the segment milestones are not ordered
+ │ └── when the segment timestamps are not ordered
│ └── it should revert
- └── when the segment milestone calculations do not overflow uint256
+ └── when the segment timestamp calculations do not overflow uint256
├── it should create the stream
- ├── it should bump the next stream id
- ├── it should record the protocol fee
+ ├── it should bump the next stream ID
├── it should mint the NFT
├── it should emit a {MetadataUpdate} event
├── it should perform the ERC-20 transfers
diff --git a/test/integration/concrete/lockup-dynamic/create-with-milestones/createWithMilestones.t.sol b/test/integration/concrete/lockup-dynamic/create-with-timestamps/createWithTimestamps.t.sol
similarity index 68%
rename from test/integration/concrete/lockup-dynamic/create-with-milestones/createWithMilestones.t.sol
rename to test/integration/concrete/lockup-dynamic/create-with-timestamps/createWithTimestamps.t.sol
index 46e62461a..c804413cf 100644
--- a/test/integration/concrete/lockup-dynamic/create-with-milestones/createWithMilestones.t.sol
+++ b/test/integration/concrete/lockup-dynamic/create-with-timestamps/createWithTimestamps.t.sol
@@ -1,6 +1,8 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
+import { Address } from "@openzeppelin/contracts/utils/Address.sol";
+import { IERC721Errors } from "@openzeppelin/contracts/interfaces/draft-IERC6093.sol";
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { UD60x18, ud, ZERO } from "@prb/math/src/UD60x18.sol";
import { stdError } from "forge-std/src/StdError.sol";
@@ -9,48 +11,59 @@ import { ISablierV2LockupDynamic } from "src/interfaces/ISablierV2LockupDynamic.
import { Errors } from "src/libraries/Errors.sol";
import { Broker, Lockup, LockupDynamic } from "src/types/DataTypes.sol";
-import { CreateWithMilestones_Integration_Shared_Test } from "../../../shared/lockup-dynamic/createWithMilestones.t.sol";
+import { CreateWithTimestamps_Integration_Shared_Test } from "../../../shared/lockup/createWithTimestamps.t.sol";
import { LockupDynamic_Integration_Concrete_Test } from "../LockupDynamic.t.sol";
-contract CreateWithMilestones_LockupDynamic_Integration_Concrete_Test is
+contract CreateWithTimestamps_LockupDynamic_Integration_Concrete_Test is
LockupDynamic_Integration_Concrete_Test,
- CreateWithMilestones_Integration_Shared_Test
+ CreateWithTimestamps_Integration_Shared_Test
{
function setUp()
public
virtual
- override(LockupDynamic_Integration_Concrete_Test, CreateWithMilestones_Integration_Shared_Test)
+ override(LockupDynamic_Integration_Concrete_Test, CreateWithTimestamps_Integration_Shared_Test)
{
LockupDynamic_Integration_Concrete_Test.setUp();
- CreateWithMilestones_Integration_Shared_Test.setUp();
+ CreateWithTimestamps_Integration_Shared_Test.setUp();
}
function test_RevertWhen_DelegateCalled() external {
bytes memory callData =
- abi.encodeCall(ISablierV2LockupDynamic.createWithMilestones, defaults.createWithMilestones());
+ abi.encodeCall(ISablierV2LockupDynamic.createWithTimestamps, defaults.createWithTimestampsLD());
(bool success, bytes memory returnData) = address(lockupDynamic).delegatecall(callData);
expectRevertDueToDelegateCall(success, returnData);
}
function test_RevertWhen_RecipientZeroAddress() external whenNotDelegateCalled {
- vm.expectRevert("ERC721: mint to the zero address");
address recipient = address(0);
+ vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721InvalidReceiver.selector, recipient));
createDefaultStreamWithRecipient(recipient);
}
function test_RevertWhen_DepositAmountZero() external whenNotDelegateCalled whenRecipientNonZeroAddress {
- // It is not possible to obtain a zero deposit amount from a non-zero total amount, because the `MAX_FEE`
+ // It is not possible to obtain a zero deposit amount from a non-zero total amount, because the `MAX_BROKER_FEE`
// is hard coded to 10%.
vm.expectRevert(Errors.SablierV2Lockup_DepositAmountZero.selector);
uint128 totalAmount = 0;
createDefaultStreamWithTotalAmount(totalAmount);
}
+ function test_RevertWhen_StartTimeZero()
+ external
+ whenNotDelegateCalled
+ whenRecipientNonZeroAddress
+ whenDepositAmountNotZero
+ {
+ vm.expectRevert(Errors.SablierV2Lockup_StartTimeZero.selector);
+ createDefaultStreamWithStartTime(0);
+ }
+
function test_RevertWhen_SegmentCountZero()
external
whenNotDelegateCalled
whenRecipientNonZeroAddress
whenDepositAmountNotZero
+ whenStartTimeNotZero
{
LockupDynamic.Segment[] memory segments;
vm.expectRevert(Errors.SablierV2LockupDynamic_SegmentCountZero.selector);
@@ -62,6 +75,7 @@ contract CreateWithMilestones_LockupDynamic_Integration_Concrete_Test is
whenNotDelegateCalled
whenRecipientNonZeroAddress
whenDepositAmountNotZero
+ whenStartTimeNotZero
whenSegmentCountNotZero
{
uint256 segmentCount = defaults.MAX_SEGMENT_COUNT() + 1;
@@ -77,6 +91,7 @@ contract CreateWithMilestones_LockupDynamic_Integration_Concrete_Test is
whenNotDelegateCalled
whenRecipientNonZeroAddress
whenDepositAmountNotZero
+ whenStartTimeNotZero
whenSegmentCountNotZero
whenSegmentCountNotTooHigh
{
@@ -87,25 +102,26 @@ contract CreateWithMilestones_LockupDynamic_Integration_Concrete_Test is
createDefaultStreamWithSegments(segments);
}
- function test_RevertWhen_StartTimeGreaterThanFirstSegmentMilestone()
+ function test_RevertWhen_StartTimeGreaterThanFirstSegmentTimestamp()
external
whenNotDelegateCalled
whenRecipientNonZeroAddress
whenDepositAmountNotZero
+ whenStartTimeNotZero
whenSegmentCountNotZero
whenSegmentCountNotTooHigh
whenSegmentAmountsSumDoesNotOverflow
{
- // Change the milestone of the first segment.
+ // Change the timestamp of the first segment.
LockupDynamic.Segment[] memory segments = defaults.segments();
- segments[0].milestone = defaults.START_TIME() - 1 seconds;
+ segments[0].timestamp = defaults.START_TIME() - 1 seconds;
// Expect the relevant error to be thrown.
vm.expectRevert(
abi.encodeWithSelector(
- Errors.SablierV2LockupDynamic_StartTimeNotLessThanFirstSegmentMilestone.selector,
+ Errors.SablierV2LockupDynamic_StartTimeNotLessThanFirstSegmentTimestamp.selector,
defaults.START_TIME(),
- segments[0].milestone
+ segments[0].timestamp
)
);
@@ -113,25 +129,26 @@ contract CreateWithMilestones_LockupDynamic_Integration_Concrete_Test is
createDefaultStreamWithSegments(segments);
}
- function test_RevertWhen_StartTimeEqualToFirstSegmentMilestone()
+ function test_RevertWhen_StartTimeEqualToFirstSegmentTimestamp()
external
whenNotDelegateCalled
whenRecipientNonZeroAddress
whenDepositAmountNotZero
+ whenStartTimeNotZero
whenSegmentCountNotZero
whenSegmentCountNotTooHigh
whenSegmentAmountsSumDoesNotOverflow
{
- // Change the milestone of the first segment.
+ // Change the timestamp of the first segment.
LockupDynamic.Segment[] memory segments = defaults.segments();
- segments[0].milestone = defaults.START_TIME();
+ segments[0].timestamp = defaults.START_TIME();
// Expect the relevant error to be thrown.
vm.expectRevert(
abi.encodeWithSelector(
- Errors.SablierV2LockupDynamic_StartTimeNotLessThanFirstSegmentMilestone.selector,
+ Errors.SablierV2LockupDynamic_StartTimeNotLessThanFirstSegmentTimestamp.selector,
defaults.START_TIME(),
- segments[0].milestone
+ segments[0].timestamp
)
);
@@ -139,28 +156,29 @@ contract CreateWithMilestones_LockupDynamic_Integration_Concrete_Test is
createDefaultStreamWithSegments(segments);
}
- function test_RevertWhen_SegmentMilestonesNotOrdered()
+ function test_RevertWhen_SegmentTimestampsNotOrdered()
external
whenNotDelegateCalled
whenRecipientNonZeroAddress
whenDepositAmountNotZero
+ whenStartTimeNotZero
whenSegmentCountNotZero
whenSegmentCountNotTooHigh
whenSegmentAmountsSumDoesNotOverflow
- whenStartTimeLessThanFirstSegmentMilestone
+ whenStartTimeLessThanFirstSegmentTimestamp
{
- // Swap the segment milestones.
+ // Swap the segment timestamps.
LockupDynamic.Segment[] memory segments = defaults.segments();
- (segments[0].milestone, segments[1].milestone) = (segments[1].milestone, segments[0].milestone);
+ (segments[0].timestamp, segments[1].timestamp) = (segments[1].timestamp, segments[0].timestamp);
// Expect the relevant error to be thrown.
uint256 index = 1;
vm.expectRevert(
abi.encodeWithSelector(
- Errors.SablierV2LockupDynamic_SegmentMilestonesNotOrdered.selector,
+ Errors.SablierV2LockupDynamic_SegmentTimestampsNotOrdered.selector,
index,
- segments[0].milestone,
- segments[1].milestone
+ segments[0].timestamp,
+ segments[1].timestamp
)
);
@@ -173,14 +191,15 @@ contract CreateWithMilestones_LockupDynamic_Integration_Concrete_Test is
whenNotDelegateCalled
whenRecipientNonZeroAddress
whenDepositAmountNotZero
+ whenStartTimeNotZero
whenSegmentCountNotZero
whenSegmentCountNotTooHigh
whenSegmentAmountsSumDoesNotOverflow
- whenStartTimeLessThanFirstSegmentMilestone
- whenSegmentMilestonesOrdered
+ whenStartTimeLessThanFirstSegmentTimestamp
+ whenSegmentTimestampsOrdered
{
uint40 endTime = defaults.END_TIME();
- vm.warp({ timestamp: endTime });
+ vm.warp({ newTimestamp: endTime });
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_EndTimeNotInTheFuture.selector, endTime, endTime));
createDefaultStream();
}
@@ -190,25 +209,23 @@ contract CreateWithMilestones_LockupDynamic_Integration_Concrete_Test is
whenNotDelegateCalled
whenRecipientNonZeroAddress
whenDepositAmountNotZero
+ whenStartTimeNotZero
whenSegmentCountNotZero
whenSegmentCountNotTooHigh
whenSegmentAmountsSumDoesNotOverflow
- whenStartTimeLessThanFirstSegmentMilestone
- whenSegmentMilestonesOrdered
+ whenStartTimeLessThanFirstSegmentTimestamp
+ whenSegmentTimestampsOrdered
whenEndTimeInTheFuture
{
- // Disable both the protocol and the broker fee so that they don't interfere with the calculations.
- changePrank({ msgSender: users.admin });
- comptroller.setProtocolFee({ asset: dai, newProtocolFee: ZERO });
UD60x18 brokerFee = ZERO;
- changePrank({ msgSender: users.sender });
+ resetPrank({ msgSender: users.sender });
// Adjust the default deposit amount.
uint128 defaultDepositAmount = defaults.DEPOSIT_AMOUNT();
uint128 depositAmount = defaultDepositAmount + 100;
// Prepare the params.
- LockupDynamic.CreateWithMilestones memory params = defaults.createWithMilestones();
+ LockupDynamic.CreateWithTimestamps memory params = defaults.createWithTimestampsLD();
params.broker = Broker({ account: address(0), fee: brokerFee });
params.totalAmount = depositAmount;
@@ -222,52 +239,27 @@ contract CreateWithMilestones_LockupDynamic_Integration_Concrete_Test is
);
// Create the stream.
- lockupDynamic.createWithMilestones(params);
+ lockupDynamic.createWithTimestamps(params);
}
- function test_RevertGiven_ProtocolFeeTooHigh()
+ function test_RevertWhen_BrokerFeeTooHigh()
external
whenNotDelegateCalled
whenRecipientNonZeroAddress
whenDepositAmountNotZero
+ whenStartTimeNotZero
whenSegmentCountNotZero
whenSegmentCountNotTooHigh
whenSegmentAmountsSumDoesNotOverflow
- whenStartTimeLessThanFirstSegmentMilestone
- whenSegmentMilestonesOrdered
+ whenStartTimeLessThanFirstSegmentTimestamp
+ whenSegmentTimestampsOrdered
whenEndTimeInTheFuture
whenDepositAmountEqualToSegmentAmountsSum
{
- UD60x18 protocolFee = MAX_FEE + ud(1);
-
- // Set the protocol fee.
- changePrank({ msgSender: users.admin });
- comptroller.setProtocolFee({ asset: dai, newProtocolFee: protocolFee });
- changePrank({ msgSender: users.sender });
-
- // Run the test.
+ UD60x18 brokerFee = MAX_BROKER_FEE + ud(1);
vm.expectRevert(
- abi.encodeWithSelector(Errors.SablierV2Lockup_ProtocolFeeTooHigh.selector, protocolFee, MAX_FEE)
+ abi.encodeWithSelector(Errors.SablierV2Lockup_BrokerFeeTooHigh.selector, brokerFee, MAX_BROKER_FEE)
);
- createDefaultStream();
- }
-
- function test_RevertWhen_BrokerFeeTooHigh()
- external
- whenNotDelegateCalled
- whenRecipientNonZeroAddress
- whenDepositAmountNotZero
- whenSegmentCountNotZero
- whenSegmentCountNotTooHigh
- whenSegmentAmountsSumDoesNotOverflow
- whenStartTimeLessThanFirstSegmentMilestone
- whenSegmentMilestonesOrdered
- whenEndTimeInTheFuture
- whenDepositAmountEqualToSegmentAmountsSum
- givenProtocolFeeNotTooHigh
- {
- UD60x18 brokerFee = MAX_FEE + ud(1);
- vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_BrokerFeeTooHigh.selector, brokerFee, MAX_FEE));
createDefaultStreamWithBroker(Broker({ account: users.broker, fee: brokerFee }));
}
@@ -276,70 +268,66 @@ contract CreateWithMilestones_LockupDynamic_Integration_Concrete_Test is
whenNotDelegateCalled
whenRecipientNonZeroAddress
whenDepositAmountNotZero
+ whenStartTimeNotZero
whenSegmentCountNotZero
whenSegmentCountNotTooHigh
whenSegmentAmountsSumDoesNotOverflow
- whenStartTimeLessThanFirstSegmentMilestone
- whenSegmentMilestonesOrdered
+ whenStartTimeLessThanFirstSegmentTimestamp
+ whenSegmentTimestampsOrdered
whenEndTimeInTheFuture
whenDepositAmountEqualToSegmentAmountsSum
- givenProtocolFeeNotTooHigh
whenBrokerFeeNotTooHigh
{
address nonContract = address(8128);
- // Set the default protocol fee so that the test does not revert due to the deposit amount not being
- // equal to the sum of the segment amounts.
- changePrank({ msgSender: users.admin });
- comptroller.setProtocolFee(IERC20(nonContract), defaults.PROTOCOL_FEE());
- changePrank({ msgSender: users.sender });
+ resetPrank({ msgSender: users.sender });
// Run the test.
- vm.expectRevert("Address: call to non-contract");
+ vm.expectRevert(abi.encodeWithSelector(Address.AddressEmptyCode.selector, nonContract));
createDefaultStreamWithAsset(IERC20(nonContract));
}
- function test_CreateWithMilestones_AssetMissingReturnValue()
+ function test_CreateWithTimestamps_AssetMissingReturnValue()
external
whenNotDelegateCalled
whenRecipientNonZeroAddress
whenDepositAmountNotZero
+ whenStartTimeNotZero
whenSegmentCountNotZero
whenSegmentCountNotTooHigh
whenSegmentAmountsSumDoesNotOverflow
- whenStartTimeLessThanFirstSegmentMilestone
- whenSegmentMilestonesOrdered
+ whenStartTimeLessThanFirstSegmentTimestamp
+ whenSegmentTimestampsOrdered
whenEndTimeInTheFuture
whenDepositAmountEqualToSegmentAmountsSum
- givenProtocolFeeNotTooHigh
whenBrokerFeeNotTooHigh
whenAssetContract
{
- testCreateWithMilestones(address(usdt));
+ testCreateWithTimestamps(address(usdt));
}
- function test_CreateWithMilestones()
+ function test_CreateWithTimestamps()
external
whenNotDelegateCalled
whenRecipientNonZeroAddress
whenDepositAmountNotZero
+ whenStartTimeNotZero
whenSegmentCountNotZero
whenSegmentCountNotTooHigh
whenSegmentAmountsSumDoesNotOverflow
- whenStartTimeLessThanFirstSegmentMilestone
- whenSegmentMilestonesOrdered
+ whenStartTimeLessThanFirstSegmentTimestamp
+ whenSegmentTimestampsOrdered
whenEndTimeInTheFuture
whenDepositAmountEqualToSegmentAmountsSum
- givenProtocolFeeNotTooHigh
whenBrokerFeeNotTooHigh
whenAssetContract
whenAssetERC20
{
- testCreateWithMilestones(address(dai));
+ testCreateWithTimestamps(address(dai));
}
- /// @dev Shared logic between {test_CreateWithMilestones_AssetMissingReturnValue} and {test_CreateWithMilestones}.
- function testCreateWithMilestones(address asset) internal {
+ /// @dev Shared logic between {test_CreateWithTimestamps_AssetMissingReturnValue} and {test_CreateWithTimestamps}.
+ function testCreateWithTimestamps(address asset) internal {
// Make the Sender the stream's funder.
address funder = users.sender;
@@ -348,7 +336,7 @@ contract CreateWithMilestones_LockupDynamic_Integration_Concrete_Test is
asset: IERC20(asset),
from: funder,
to: address(lockupDynamic),
- amount: defaults.DEPOSIT_AMOUNT() + defaults.PROTOCOL_FEE_AMOUNT()
+ value: defaults.DEPOSIT_AMOUNT()
});
// Expect the broker fee to be paid to the broker.
@@ -356,7 +344,7 @@ contract CreateWithMilestones_LockupDynamic_Integration_Concrete_Test is
asset: IERC20(asset),
from: funder,
to: users.broker,
- amount: defaults.BROKER_FEE_AMOUNT()
+ value: defaults.BROKER_FEE_AMOUNT()
});
// Expect the relevant events to be emitted.
@@ -373,7 +361,7 @@ contract CreateWithMilestones_LockupDynamic_Integration_Concrete_Test is
asset: IERC20(asset),
cancelable: true,
transferable: true,
- range: defaults.lockupDynamicRange(),
+ timestamps: defaults.lockupDynamicTimestamps(),
broker: users.broker
});
@@ -381,8 +369,8 @@ contract CreateWithMilestones_LockupDynamic_Integration_Concrete_Test is
streamId = createDefaultStreamWithAsset(IERC20(asset));
// Assert that the stream has been created.
- LockupDynamic.Stream memory actualStream = lockupDynamic.getStream(streamId);
- LockupDynamic.Stream memory expectedStream = defaults.lockupDynamicStream();
+ LockupDynamic.StreamLD memory actualStream = lockupDynamic.getStream(streamId);
+ LockupDynamic.StreamLD memory expectedStream = defaults.lockupDynamicStream();
expectedStream.asset = IERC20(asset);
assertEq(actualStream, expectedStream);
@@ -391,7 +379,7 @@ contract CreateWithMilestones_LockupDynamic_Integration_Concrete_Test is
Lockup.Status expectedStatus = Lockup.Status.PENDING;
assertEq(actualStatus, expectedStatus);
- // Assert that the next stream id has been bumped.
+ // Assert that the next stream ID has been bumped.
uint256 actualNextStreamId = lockupDynamic.nextStreamId();
uint256 expectedNextStreamId = streamId + 1;
assertEq(actualNextStreamId, expectedNextStreamId, "nextStreamId");
diff --git a/test/integration/concrete/lockup-dynamic/create-with-milestones/createWithMilestones.tree b/test/integration/concrete/lockup-dynamic/create-with-timestamps/createWithTimestamps.tree
similarity index 61%
rename from test/integration/concrete/lockup-dynamic/create-with-milestones/createWithMilestones.tree
rename to test/integration/concrete/lockup-dynamic/create-with-timestamps/createWithTimestamps.tree
index c90aecfc5..8105493e3 100644
--- a/test/integration/concrete/lockup-dynamic/create-with-milestones/createWithMilestones.tree
+++ b/test/integration/concrete/lockup-dynamic/create-with-timestamps/createWithTimestamps.tree
@@ -1,4 +1,4 @@
-createWithMilestones.t.sol
+createWithTimestamps.t.sol
├── when delegate called
│ └── it should revert
└── when not delegate called
@@ -8,32 +8,32 @@ createWithMilestones.t.sol
├── when the deposit amount is zero
│ └── it should revert
└── when the deposit amount is not zero
- ├── when the segment count is zero
+ ├── when the start time is zero
│ └── it should revert
- └── when the segment count is not zero
- ├── when the segment count is too high
+ └── when the start time is not zero
+ ├── when the segment count is zero
│ └── it should revert
- └── when the segment count is not too high
- ├── when the segment amounts sum overflows
+ └── when the segment count is not zero
+ ├── when the segment count is too high
│ └── it should revert
- └── when the segment amounts sum does not overflow
- ├── when the start time is greater than the first segment milestone
+ └── when the segment count is not too high
+ ├── when the segment amounts sum overflows
│ └── it should revert
- ├── when the start time is equal to the first segment milestone
- │ └── it should revert
- └── when the start time is less than the first segment milestone
- ├── when the segment milestones are not ordered
+ └── when the segment amounts sum does not overflow
+ ├── when the start time is greater than the first segment timestamp
+ │ └── it should revert
+ ├── when the start time is equal to the first segment timestamp
│ └── it should revert
- └── when the segment milestones are ordered
- ├── when the end time is not in the future
+ └── when the start time is less than the first segment timestamp
+ ├── when the segment timestamps are not ordered
│ └── it should revert
- └── when the end time is in the future
- ├── when the deposit amount is not equal to the segment amounts sum
+ └── when the segment timestamps are ordered
+ ├── when the end time is not in the future
│ └── it should revert
- └── when the deposit amount is equal to the segment amounts sum
- ├── given the protocol fee is too high
+ └── when the end time is in the future
+ ├── when the deposit amount is not equal to the segment amounts sum
│ └── it should revert
- └── given the protocol fee is not too high
+ └── when the deposit amount is equal to the segment amounts sum
├── when the broker fee is too high
│ └── it should revert
└── when the broker fee is not too high
@@ -42,16 +42,14 @@ createWithMilestones.t.sol
└── when the asset is a contract
├── when the asset misses the ERC-20 return value
│ ├── it should create the stream
- │ ├── it should bump the next stream id
- │ ├── it should record the protocol fee
+ │ ├── it should bump the next stream ID
│ ├── it should mint the NFT
│ ├── it should emit a {MetadataUpdate} event
│ ├── it should perform the ERC-20 transfers
│ └── it should emit a {CreateLockupDynamicStream} event
└── when the asset does not miss the ERC-20 return value
├── it should create the stream
- ├── it should bump the next stream id
- ├── it should record the protocol fee
+ ├── it should bump the next stream ID
├── it should mint the NFT
├── it should emit a {MetadataUpdate} event
├── it should perform the ERC-20 transfers
diff --git a/test/integration/concrete/lockup-dynamic/get-range/getRange.tree b/test/integration/concrete/lockup-dynamic/get-range/getRange.tree
deleted file mode 100644
index 88dcc9707..000000000
--- a/test/integration/concrete/lockup-dynamic/get-range/getRange.tree
+++ /dev/null
@@ -1,5 +0,0 @@
-getRange.t.sol
-├── given the id references a null stream
-│ └── it should revert
-└── given the id does not reference a null stream
- └── it should return the correct range
diff --git a/test/integration/concrete/lockup-dynamic/get-segments/getSegments.t.sol b/test/integration/concrete/lockup-dynamic/get-segments/getSegments.t.sol
index f46eee599..b94535d00 100644
--- a/test/integration/concrete/lockup-dynamic/get-segments/getSegments.t.sol
+++ b/test/integration/concrete/lockup-dynamic/get-segments/getSegments.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
import { LockupDynamic } from "src/types/DataTypes.sol";
diff --git a/test/integration/concrete/lockup-dynamic/get-segments/getSegments.tree b/test/integration/concrete/lockup-dynamic/get-segments/getSegments.tree
index b7032eba6..6ac298106 100644
--- a/test/integration/concrete/lockup-dynamic/get-segments/getSegments.tree
+++ b/test/integration/concrete/lockup-dynamic/get-segments/getSegments.tree
@@ -1,5 +1,5 @@
getSegments.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
└── it should return the correct segments
diff --git a/test/integration/concrete/lockup-dynamic/get-stream/getStream.t.sol b/test/integration/concrete/lockup-dynamic/get-stream/getStream.t.sol
index 5c01e7898..c079a3a0e 100644
--- a/test/integration/concrete/lockup-dynamic/get-stream/getStream.t.sol
+++ b/test/integration/concrete/lockup-dynamic/get-stream/getStream.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
import { LockupDynamic } from "src/types/DataTypes.sol";
@@ -25,9 +25,9 @@ contract GetStream_LockupDynamic_Integration_Concrete_Test is LockupDynamic_Inte
}
function test_GetStream_StatusSettled() external givenNotNull {
- vm.warp({ timestamp: defaults.END_TIME() });
- LockupDynamic.Stream memory actualStream = lockupDynamic.getStream(defaultStreamId);
- LockupDynamic.Stream memory expectedStream = defaults.lockupDynamicStream();
+ vm.warp({ newTimestamp: defaults.END_TIME() });
+ LockupDynamic.StreamLD memory actualStream = lockupDynamic.getStream(defaultStreamId);
+ LockupDynamic.StreamLD memory expectedStream = defaults.lockupDynamicStream();
expectedStream.isCancelable = false;
assertEq(actualStream, expectedStream);
}
@@ -38,8 +38,8 @@ contract GetStream_LockupDynamic_Integration_Concrete_Test is LockupDynamic_Inte
function test_GetStream() external givenNotNull givenStatusNotSettled {
uint256 streamId = createDefaultStream();
- LockupDynamic.Stream memory actualStream = lockupDynamic.getStream(streamId);
- LockupDynamic.Stream memory expectedStream = defaults.lockupDynamicStream();
+ LockupDynamic.StreamLD memory actualStream = lockupDynamic.getStream(streamId);
+ LockupDynamic.StreamLD memory expectedStream = defaults.lockupDynamicStream();
assertEq(actualStream, expectedStream);
}
}
diff --git a/test/integration/concrete/lockup-dynamic/get-stream/getStream.tree b/test/integration/concrete/lockup-dynamic/get-stream/getStream.tree
index c3278db89..bde21f7b4 100644
--- a/test/integration/concrete/lockup-dynamic/get-stream/getStream.tree
+++ b/test/integration/concrete/lockup-dynamic/get-stream/getStream.tree
@@ -1,7 +1,7 @@
getStream.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
├── given the stream is settled
│ └── it should adjust the `isCancelable` flag and return the stream
└── given the stream is not settled
diff --git a/test/integration/concrete/lockup-dynamic/get-range/getRange.t.sol b/test/integration/concrete/lockup-dynamic/get-timestamps/getTimestamps.t.sol
similarity index 51%
rename from test/integration/concrete/lockup-dynamic/get-range/getRange.t.sol
rename to test/integration/concrete/lockup-dynamic/get-timestamps/getTimestamps.t.sol
index 892864707..889c0cf50 100644
--- a/test/integration/concrete/lockup-dynamic/get-range/getRange.t.sol
+++ b/test/integration/concrete/lockup-dynamic/get-timestamps/getTimestamps.t.sol
@@ -1,26 +1,26 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
import { LockupDynamic } from "src/types/DataTypes.sol";
import { LockupDynamic_Integration_Concrete_Test } from "../LockupDynamic.t.sol";
-contract GetRange_LockupDynamic_Integration_Concrete_Test is LockupDynamic_Integration_Concrete_Test {
+contract GetTimestamps_LockupDynamic_Integration_Concrete_Test is LockupDynamic_Integration_Concrete_Test {
function test_RevertGiven_Null() external {
uint256 nullStreamId = 1729;
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_Null.selector, nullStreamId));
- lockupDynamic.getRange(nullStreamId);
+ lockupDynamic.getTimestamps(nullStreamId);
}
modifier givenNotNull() {
_;
}
- function test_GetRange() external givenNotNull {
+ function test_GetTimestamps() external givenNotNull {
uint256 streamId = createDefaultStream();
- LockupDynamic.Range memory actualRange = lockupDynamic.getRange(streamId);
- LockupDynamic.Range memory expectedRange = defaults.lockupDynamicRange();
- assertEq(actualRange, expectedRange);
+ LockupDynamic.Timestamps memory actualTimestamps = lockupDynamic.getTimestamps(streamId);
+ LockupDynamic.Timestamps memory expectedTimestamps = defaults.lockupDynamicTimestamps();
+ assertEq(actualTimestamps, expectedTimestamps);
}
}
diff --git a/test/integration/concrete/lockup-dynamic/get-timestamps/getTimestamps.tree b/test/integration/concrete/lockup-dynamic/get-timestamps/getTimestamps.tree
new file mode 100644
index 000000000..49e6bf2a0
--- /dev/null
+++ b/test/integration/concrete/lockup-dynamic/get-timestamps/getTimestamps.tree
@@ -0,0 +1,5 @@
+getTimestamps.t.sol
+├── given the ID references a null stream
+│ └── it should revert
+└── given the ID does not reference a null stream
+ └── it should return the correct timestamps
diff --git a/test/integration/concrete/lockup-dynamic/streamed-amount-of/streamedAmountOf.t.sol b/test/integration/concrete/lockup-dynamic/streamed-amount-of/streamedAmountOf.t.sol
index 922cf3fc7..8682ce12b 100644
--- a/test/integration/concrete/lockup-dynamic/streamed-amount-of/streamedAmountOf.t.sol
+++ b/test/integration/concrete/lockup-dynamic/streamed-amount-of/streamedAmountOf.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { LockupDynamic } from "src/types/DataTypes.sol";
@@ -25,7 +25,7 @@ contract StreamedAmountOf_LockupDynamic_Integration_Concrete_Test is
givenStreamHasNotBeenCanceled
givenStatusStreaming
{
- vm.warp({ timestamp: 0 });
+ vm.warp({ newTimestamp: 0 });
uint128 actualStreamedAmount = lockupDynamic.streamedAmountOf(defaultStreamId);
uint128 expectedStreamedAmount = 0;
assertEq(actualStreamedAmount, expectedStreamedAmount, "streamedAmount");
@@ -37,7 +37,7 @@ contract StreamedAmountOf_LockupDynamic_Integration_Concrete_Test is
givenStreamHasNotBeenCanceled
givenStatusStreaming
{
- vm.warp({ timestamp: defaults.START_TIME() });
+ vm.warp({ newTimestamp: defaults.START_TIME() });
uint128 actualStreamedAmount = lockupDynamic.streamedAmountOf(defaultStreamId);
uint128 expectedStreamedAmount = 0;
assertEq(actualStreamedAmount, expectedStreamedAmount, "streamedAmount");
@@ -51,14 +51,14 @@ contract StreamedAmountOf_LockupDynamic_Integration_Concrete_Test is
whenStartTimeInThePast
{
// Simulate the passage of time.
- vm.warp({ timestamp: defaults.START_TIME() + 2000 seconds });
+ vm.warp({ newTimestamp: defaults.START_TIME() + 2000 seconds });
// Create an array with one segment.
LockupDynamic.Segment[] memory segments = new LockupDynamic.Segment[](1);
segments[0] = LockupDynamic.Segment({
amount: defaults.DEPOSIT_AMOUNT(),
exponent: defaults.segments()[1].exponent,
- milestone: defaults.END_TIME()
+ timestamp: defaults.END_TIME()
});
// Create the stream.
@@ -74,7 +74,7 @@ contract StreamedAmountOf_LockupDynamic_Integration_Concrete_Test is
_;
}
- function test_StreamedAmountOf_CurrentMilestone1st()
+ function test_StreamedAmountOf_CurrentTimestamp1st()
external
givenNotNull
givenStreamHasNotBeenCanceled
@@ -83,7 +83,7 @@ contract StreamedAmountOf_LockupDynamic_Integration_Concrete_Test is
whenStartTimeInThePast
{
// Warp 1 second to the future.
- vm.warp({ timestamp: defaults.START_TIME() + 1 seconds });
+ vm.warp({ newTimestamp: defaults.START_TIME() + 1 seconds });
// Run the test.
uint128 actualStreamedAmount = lockupDynamic.streamedAmountOf(defaultStreamId);
@@ -91,21 +91,21 @@ contract StreamedAmountOf_LockupDynamic_Integration_Concrete_Test is
assertEq(actualStreamedAmount, expectedStreamedAmount, "streamedAmount");
}
- modifier givenCurrentMilestoneNot1st() {
+ modifier givenCurrentTimestampNot1st() {
_;
}
- function test_StreamedAmountOf_CurrentMilestoneNot1st()
+ function test_StreamedAmountOf_CurrentTimestampNot1st()
external
givenNotNull
givenStreamHasNotBeenCanceled
givenStatusStreaming
whenStartTimeInThePast
givenMultipleSegments
- givenCurrentMilestoneNot1st
+ givenCurrentTimestampNot1st
{
// Simulate the passage of time. 750 seconds is ~10% of the way in the second segment.
- vm.warp({ timestamp: defaults.START_TIME() + defaults.CLIFF_DURATION() + 750 seconds });
+ vm.warp({ newTimestamp: defaults.START_TIME() + defaults.CLIFF_DURATION() + 750 seconds });
// Run the test.
uint128 actualStreamedAmount = lockupDynamic.streamedAmountOf(defaultStreamId);
diff --git a/test/integration/concrete/lockup-dynamic/streamed-amount-of/streamedAmountOf.tree b/test/integration/concrete/lockup-dynamic/streamed-amount-of/streamedAmountOf.tree
index 50815136d..8a231f4a0 100644
--- a/test/integration/concrete/lockup-dynamic/streamed-amount-of/streamedAmountOf.tree
+++ b/test/integration/concrete/lockup-dynamic/streamed-amount-of/streamedAmountOf.tree
@@ -8,7 +8,7 @@ streamedAmountOf.t.sol
├── given there is one segment
│ └── it should return the correct streamed amount
└── given there are multiple segments
- ├── given the current milestone is the 1st in the array
+ ├── given the current timestamp is the 1st in the array
│ └── it should return the correct streamed amount
- └── given the current milestone is not the 1st in the array
+ └── given the current timestamp is not the 1st in the array
└── it should return the correct streamed amount
diff --git a/test/integration/concrete/lockup-dynamic/token-uri/tokenURI.t.sol b/test/integration/concrete/lockup-dynamic/token-uri/tokenURI.t.sol
index 80f06f345..4c4e4ad9a 100644
--- a/test/integration/concrete/lockup-dynamic/token-uri/tokenURI.t.sol
+++ b/test/integration/concrete/lockup-dynamic/token-uri/tokenURI.t.sol
@@ -1,24 +1,22 @@
// SPDX-License-Identifier: UNLICENSED
// solhint-disable max-line-length,no-console,quotes
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
+import { IERC721Errors } from "@openzeppelin/contracts/interfaces/draft-IERC6093.sol";
import { console2 } from "forge-std/src/console2.sol";
-import { LibString } from "solady/src/utils/LibString.sol";
import { StdStyle } from "forge-std/src/StdStyle.sol";
import { Base64 } from "solady/src/utils/Base64.sol";
import { LockupDynamic_Integration_Concrete_Test } from "../LockupDynamic.t.sol";
/// @dev Requirements for these tests to work:
-/// - The stream id must be 1
+/// - The stream ID must be 1
/// - The stream's sender must be `0x6332e7b1deb1f1a0b77b2bb18b144330c7291bca`, i.e. `makeAddr("Sender")`
/// - The stream asset must have the DAI symbol
/// - The contract deployer, i.e. the `sender` config option in `foundry.toml`, must have the default value
/// 0x1804c8AB1F12E6bbf3894d4083f33e07309d1f38 so that the deployed contracts have the same addresses as
/// the values hard coded in the tests below
contract TokenURI_LockupDynamic_Integration_Concrete_Test is LockupDynamic_Integration_Concrete_Test {
- using LibString for string;
-
address internal constant LOCKUP_DYNAMIC = 0xDB25A7b768311dE128BBDa7B8426c3f9C74f3240;
uint256 internal defaultStreamId;
@@ -33,13 +31,13 @@ contract TokenURI_LockupDynamic_Integration_Concrete_Test is LockupDynamic_Integ
function test_RevertGiven_NFTDoesNotExist() external {
uint256 nullStreamId = 1729;
- vm.expectRevert("ERC721: invalid token ID");
+ vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721NonexistentToken.selector, nullStreamId));
lockupDynamic.tokenURI({ tokenId: nullStreamId });
}
modifier givenNFTExists() {
defaultStreamId = createDefaultStream();
- vm.warp({ timestamp: defaults.START_TIME() + defaults.TOTAL_DURATION() / 4 });
+ vm.warp({ newTimestamp: defaults.START_TIME() + defaults.TOTAL_DURATION() / 4 });
_;
}
@@ -48,7 +46,7 @@ contract TokenURI_LockupDynamic_Integration_Concrete_Test is LockupDynamic_Integ
/// 2. Remember to escape the EOL character \n with \\n.
function test_TokenURI_Decoded() external skipOnMismatch givenNFTExists {
string memory tokenURI = lockupDynamic.tokenURI(defaultStreamId);
- tokenURI = tokenURI.replace({ search: "data:application/json;base64,", replacement: "" });
+ tokenURI = vm.replace({ input: tokenURI, from: "data:application/json;base64,", to: "" });
string memory actualDecodedTokenURI = string(Base64.decode(tokenURI));
string memory expectedDecodedTokenURI =
unicode'{"attributes":[{"trait_type":"Asset","value":"DAI"},{"trait_type":"Sender","value":"0x6332e7b1deb1f1a0b77b2bb18b144330c7291bca"},{"trait_type":"Status","value":"Streaming"}],"description":"This NFT represents a payment stream in a Sablier V2 Lockup Dynamic contract. The owner of this NFT can withdraw the streamed assets, which are denominated in DAI.\\n\\n- Stream ID: 1\\n- Lockup Dynamic Address: 0xdb25a7b768311de128bbda7b8426c3f9c74f3240\\n- DAI Address: 0x03a6a84cd762d9707a21605b548aaab891562aab\\n\\n⚠️ WARNING: Transferring the NFT makes the new owner the recipient of the stream. The funds are not automatically withdrawn for the previous recipient.","external_url":"https://sablier.com","name":"Sablier V2 Lockup Dynamic #1","image":"data:image/svg+xml;base64,<svg xmlns="http://www.w3.org/2000/svg" width="1000" height="1000" viewBox="0 0 1000 1000"><rect width="100%" height="100%" filter="url(#Noise)"/><rect x="70" y="70" width="860" height="860" fill="#fff" fill-opacity=".03" rx="45" ry="45" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><defs><circle id="Glow" r="500" fill="url(#RadialGlow)"/><filter id="Noise"><feFlood x="0" y="0" width="100%" height="100%" flood-color="hsl(230,21%,11%)" flood-opacity="1" result="floodFill"/><feTurbulence baseFrequency=".4" numOctaves="3" result="Noise" type="fractalNoise"/><feBlend in="Noise" in2="floodFill" mode="soft-light"/></filter><path id="Logo" fill="#fff" fill-opacity=".1" d="m133.559,124.034c-.013,2.412-1.059,4.848-2.923,6.402-2.558,1.819-5.168,3.439-7.888,4.996-14.44,8.262-31.047,12.565-47.674,12.569-8.858.036-17.838-1.272-26.328-3.663-9.806-2.766-19.087-7.113-27.562-12.778-13.842-8.025,9.468-28.606,16.153-35.265h0c2.035-1.838,4.252-3.546,6.463-5.224h0c6.429-5.655,16.218-2.835,20.358,4.17,4.143,5.057,8.816,9.649,13.92,13.734h.037c5.736,6.461,15.357-2.253,9.38-8.48,0,0-3.515-3.515-3.515-3.515-11.49-11.478-52.656-52.664-64.837-64.837l.049-.037c-1.725-1.606-2.719-3.847-2.751-6.204h0c-.046-2.375,1.062-4.582,2.726-6.229h0l.185-.148h0c.099-.062,.222-.148,.37-.259h0c2.06-1.362,3.951-2.621,6.044-3.842C57.763-3.473,97.76-2.341,128.637,18.332c16.671,9.946-26.344,54.813-38.651,40.199-6.299-6.096-18.063-17.743-19.668-18.811-6.016-4.047-13.061,4.776-7.752,9.751l68.254,68.371c1.724,1.601,2.714,3.84,2.738,6.192Z"/><path id="FloatingText" fill="none" d="M125 45h750s80 0 80 80v750s0 80 -80 80h-750s-80 0 -80 -80v-750s0 -80 80 -80"/><radialGradient id="RadialGlow"><stop offset="0%" stop-color="hsl(61,88%,40%)" stop-opacity=".6"/><stop offset="100%" stop-color="hsl(230,21%,11%)" stop-opacity="0"/></radialGradient><linearGradient id="SandTop" x1="0%" y1="0%"><stop offset="0%" stop-color="hsl(61,88%,40%)"/><stop offset="100%" stop-color="hsl(230,21%,11%)"/></linearGradient><linearGradient id="SandBottom" x1="100%" y1="100%"><stop offset="10%" stop-color="hsl(230,21%,11%)"/><stop offset="100%" stop-color="hsl(61,88%,40%)"/><animate attributeName="x1" dur="6s" repeatCount="indefinite" values="30%;60%;120%;60%;30%;"/></linearGradient><linearGradient id="HourglassStroke" gradientTransform="rotate(90)" gradientUnits="userSpaceOnUse"><stop offset="50%" stop-color="hsl(61,88%,40%)"/><stop offset="80%" stop-color="hsl(230,21%,11%)"/></linearGradient><g id="Hourglass"><path d="M 50,360 a 300,300 0 1,1 600,0 a 300,300 0 1,1 -600,0" fill="#fff" fill-opacity=".02" stroke="url(#HourglassStroke)" stroke-width="4"/><path d="m566,161.201v-53.924c0-19.382-22.513-37.563-63.398-51.198-40.756-13.592-94.946-21.079-152.587-21.079s-111.838,7.487-152.602,21.079c-40.893,13.636-63.413,31.816-63.413,51.198v53.924c0,17.181,17.704,33.427,50.223,46.394v284.809c-32.519,12.96-50.223,29.206-50.223,46.394v53.924c0,19.382,22.52,37.563,63.413,51.198,40.763,13.592,94.954,21.079,152.602,21.079s111.831-7.487,152.587-21.079c40.886-13.636,63.398-31.816,63.398-51.198v-53.924c0-17.196-17.704-33.435-50.223-46.401V207.603c32.519-12.967,50.223-29.206,50.223-46.401Zm-347.462,57.793l130.959,131.027-130.959,131.013V218.994Zm262.924.022v262.018l-130.937-131.006,130.937-131.013Z" fill="#161822"></path><polygon points="350 350.026 415.03 284.978 285 284.978 350 350.026" fill="url(#SandBottom)"/><path d="m416.341,281.975c0,.914-.354,1.809-1.035,2.68-5.542,7.076-32.661,12.45-65.28,12.45-32.624,0-59.738-5.374-65.28-12.45-.681-.872-1.035-1.767-1.035-2.68,0-.914.354-1.808,1.035-2.676,5.542-7.076,32.656-12.45,65.28-12.45,32.619,0,59.738,5.374,65.28,12.45.681.867,1.035,1.762,1.035,2.676Z" fill="url(#SandTop)"/><path d="m481.46,504.101v58.449c-2.35.77-4.82,1.51-7.39,2.23-30.3,8.54-74.65,13.92-124.06,13.92-53.6,0-101.24-6.33-131.47-16.16v-58.439h262.92Z" fill="url(#SandBottom)"/><ellipse cx="350" cy="504.101" rx="131.462" ry="28.108" fill="url(#SandTop)"/><g fill="none" stroke="url(#HourglassStroke)" stroke-linecap="round" stroke-miterlimit="10" stroke-width="4"><path d="m565.641,107.28c0,9.537-5.56,18.629-15.676,26.973h-.023c-9.204,7.596-22.194,14.562-38.197,20.592-39.504,14.936-97.325,24.355-161.733,24.355-90.48,0-167.948-18.582-199.953-44.948h-.023c-10.115-8.344-15.676-17.437-15.676-26.973,0-39.735,96.554-71.921,215.652-71.921s215.629,32.185,215.629,71.921Z"/><path d="m134.36,161.203c0,39.735,96.554,71.921,215.652,71.921s215.629-32.186,215.629-71.921"/><line x1="134.36" y1="161.203" x2="134.36" y2="107.28"/><line x1="565.64" y1="161.203" x2="565.64" y2="107.28"/><line x1="184.584" y1="206.823" x2="184.585" y2="537.579"/><line x1="218.181" y1="218.118" x2="218.181" y2="562.537"/><line x1="481.818" y1="218.142" x2="481.819" y2="562.428"/><line x1="515.415" y1="207.352" x2="515.416" y2="537.579"/><path d="m184.58,537.58c0,5.45,4.27,10.65,12.03,15.42h.02c5.51,3.39,12.79,6.55,21.55,9.42,30.21,9.9,78.02,16.28,131.83,16.28,49.41,0,93.76-5.38,124.06-13.92,2.7-.76,5.29-1.54,7.75-2.35,8.77-2.87,16.05-6.04,21.56-9.43h0c7.76-4.77,12.04-9.97,12.04-15.42"/><path d="m184.582,492.656c-31.354,12.485-50.223,28.58-50.223,46.142,0,9.536,5.564,18.627,15.677,26.969h.022c8.503,7.005,20.213,13.463,34.524,19.159,9.999,3.991,21.269,7.609,33.597,10.788,36.45,9.407,82.181,15.002,131.835,15.002s95.363-5.595,131.807-15.002c10.847-2.79,20.867-5.926,29.924-9.349,1.244-.467,2.473-.942,3.673-1.424,14.326-5.696,26.035-12.161,34.524-19.173h.022c10.114-8.342,15.677-17.433,15.677-26.969,0-17.562-18.869-33.665-50.223-46.15"/><path d="m134.36,592.72c0,39.735,96.554,71.921,215.652,71.921s215.629-32.186,215.629-71.921"/><line x1="134.36" y1="592.72" x2="134.36" y2="538.797"/><line x1="565.64" y1="592.72" x2="565.64" y2="538.797"/><polyline points="481.822 481.901 481.798 481.877 481.775 481.854 350.015 350.026 218.185 218.129"/><polyline points="218.185 481.901 218.231 481.854 350.015 350.026 481.822 218.152"/></g></g><g id="Progress" fill="#fff"><rect width="208" height="100" fill-opacity=".03" rx="15" ry="15" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><text x="20" y="34" font-family="'Courier New',Arial,monospace" font-size="22px">Progress</text><text x="20" y="72" font-family="'Courier New',Arial,monospace" font-size="26px">25%</text><g fill="none"><circle cx="166" cy="50" r="22" stroke="hsl(230,21%,11%)" stroke-width="10"/><circle cx="166" cy="50" pathLength="10000" r="22" stroke="hsl(61,88%,40%)" stroke-dasharray="10000" stroke-dashoffset="7500" stroke-linecap="round" stroke-width="5" transform="rotate(-90)" transform-origin="166 50"/></g></g><g id="Status" fill="#fff"><rect width="184" height="100" fill-opacity=".03" rx="15" ry="15" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><text x="20" y="34" font-family="'Courier New',Arial,monospace" font-size="22px">Status</text><text x="20" y="72" font-family="'Courier New',Arial,monospace" font-size="26px">Streaming</text></g><g id="Amount" fill="#fff"><rect width="120" height="100" fill-opacity=".03" rx="15" ry="15" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><text x="20" y="34" font-family="'Courier New',Arial,monospace" font-size="22px">Amount</text><text x="20" y="72" font-family="'Courier New',Arial,monospace" font-size="26px">&#8805; 10K</text></g><g id="Duration" fill="#fff"><rect width="152" height="100" fill-opacity=".03" rx="15" ry="15" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><text x="20" y="34" font-family="'Courier New',Arial,monospace" font-size="22px">Duration</text><text x="20" y="72" font-family="'Courier New',Arial,monospace" font-size="26px">&lt; 1 Day</text></g></defs><text text-rendering="optimizeSpeed"><textPath startOffset="-100%" href="#FloatingText" fill="#fff" font-family="'Courier New',Arial,monospace" fill-opacity=".8" font-size="26px"><animate additive="sum" attributeName="startOffset" begin="0s" dur="50s" from="0%" repeatCount="indefinite" to="100%"/>0xdb25a7b768311de128bbda7b8426c3f9c74f3240 • Sablier V2 Lockup Dynamic</textPath><textPath startOffset="0%" href="#FloatingText" fill="#fff" font-family="'Courier New',Arial,monospace" fill-opacity=".8" font-size="26px"><animate additive="sum" attributeName="startOffset" begin="0s" dur="50s" from="0%" repeatCount="indefinite" to="100%"/>0xdb25a7b768311de128bbda7b8426c3f9c74f3240 • Sablier V2 Lockup Dynamic</textPath><textPath startOffset="-50%" href="#FloatingText" fill="#fff" font-family="'Courier New',Arial,monospace" fill-opacity=".8" font-size="26px"><animate additive="sum" attributeName="startOffset" begin="0s" dur="50s" from="0%" repeatCount="indefinite" to="100%"/>0x03a6a84cd762d9707a21605b548aaab891562aab • DAI</textPath><textPath startOffset="50%" href="#FloatingText" fill="#fff" font-family="'Courier New',Arial,monospace" fill-opacity=".8" font-size="26px"><animate additive="sum" attributeName="startOffset" begin="0s" dur="50s" from="0%" repeatCount="indefinite" to="100%"/>0x03a6a84cd762d9707a21605b548aaab891562aab • DAI</textPath></text><use href="#Glow" fill-opacity=".9"/><use href="#Glow" x="1000" y="1000" fill-opacity=".9"/><use href="#Logo" x="170" y="170" transform="scale(.6)"/><use href="#Hourglass" x="150" y="90" transform="rotate(10)" transform-origin="500 500"/><use href="#Progress" x="144" y="790"/><use href="#Status" x="368" y="790"/><use href="#Amount" x="568" y="790"/><use href="#Duration" x="704" y="790"/></svg>"}';
diff --git a/test/integration/concrete/lockup-dynamic/withdrawable-amount-of/withdrawableAmountOf.t.sol b/test/integration/concrete/lockup-dynamic/withdrawable-amount-of/withdrawableAmountOf.t.sol
index f6532410a..2362e29d9 100644
--- a/test/integration/concrete/lockup-dynamic/withdrawable-amount-of/withdrawableAmountOf.t.sol
+++ b/test/integration/concrete/lockup-dynamic/withdrawable-amount-of/withdrawableAmountOf.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { LockupDynamic_Integration_Concrete_Test } from "../LockupDynamic.t.sol";
import { WithdrawableAmountOf_Integration_Concrete_Test } from
@@ -24,7 +24,7 @@ contract WithdrawableAmountOf_LockupDynamic_Integration_Concrete_Test is
givenStreamHasNotBeenCanceled
givenStatusStreaming
{
- vm.warp({ timestamp: defaults.START_TIME() });
+ vm.warp({ newTimestamp: defaults.START_TIME() });
uint128 actualWithdrawableAmount = lockupDynamic.withdrawableAmountOf(defaultStreamId);
uint128 expectedWithdrawableAmount = 0;
assertEq(actualWithdrawableAmount, expectedWithdrawableAmount, "withdrawableAmount");
@@ -42,7 +42,7 @@ contract WithdrawableAmountOf_LockupDynamic_Integration_Concrete_Test is
givenStartTimeInThePast
{
// Simulate the passage of time.
- vm.warp({ timestamp: defaults.START_TIME() + defaults.CLIFF_DURATION() + 3750 seconds });
+ vm.warp({ newTimestamp: defaults.START_TIME() + defaults.CLIFF_DURATION() + 3750 seconds });
// Run the test.
uint128 actualWithdrawableAmount = lockupDynamic.withdrawableAmountOf(defaultStreamId);
@@ -64,7 +64,7 @@ contract WithdrawableAmountOf_LockupDynamic_Integration_Concrete_Test is
whenWithWithdrawals
{
// Simulate the passage of time.
- vm.warp({ timestamp: defaults.START_TIME() + defaults.CLIFF_DURATION() + 3750 seconds });
+ vm.warp({ newTimestamp: defaults.START_TIME() + defaults.CLIFF_DURATION() + 3750 seconds });
// Make the withdrawal.
lockupDynamic.withdraw({ streamId: defaultStreamId, to: users.recipient, amount: defaults.WITHDRAW_AMOUNT() });
diff --git a/test/integration/concrete/lockup-linear/LockupLinear.t.sol b/test/integration/concrete/lockup-linear/LockupLinear.t.sol
index e347f38a7..5f6a3b246 100644
--- a/test/integration/concrete/lockup-linear/LockupLinear.t.sol
+++ b/test/integration/concrete/lockup-linear/LockupLinear.t.sol
@@ -1,16 +1,14 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
-import { ISablierV2Base } from "src/interfaces/ISablierV2Base.sol";
import { ISablierV2Lockup } from "src/interfaces/ISablierV2Lockup.sol";
import { LockupLinear_Integration_Shared_Test } from "../../shared/lockup-linear/LockupLinear.t.sol";
import { Integration_Test } from "../../Integration.t.sol";
+import { AllowToHook_Integration_Concrete_Test } from "../lockup/allow-to-hook/allowToHook.t.sol";
import { Burn_Integration_Concrete_Test } from "../lockup/burn/burn.t.sol";
import { Cancel_Integration_Concrete_Test } from "../lockup/cancel/cancel.t.sol";
import { CancelMultiple_Integration_Concrete_Test } from "../lockup/cancel-multiple/cancelMultiple.t.sol";
-import { ClaimProtocolRevenues_Integration_Concrete_Test } from
- "../lockup/claim-protocol-revenues/claimProtocolRevenues.t.sol";
import { GetAsset_Integration_Concrete_Test } from "../lockup/get-asset/getAsset.t.sol";
import { GetDepositedAmount_Integration_Concrete_Test } from "../lockup/get-deposited-amount/getDepositedAmount.t.sol";
import { GetEndTime_Integration_Concrete_Test } from "../lockup/get-end-time/getEndTime.t.sol";
@@ -19,21 +17,21 @@ import { GetRecipient_Integration_Concrete_Test } from "../lockup/get-recipient/
import { GetSender_Integration_Concrete_Test } from "../lockup/get-sender/getSender.t.sol";
import { GetStartTime_Integration_Concrete_Test } from "../lockup/get-start-time/getStartTime.t.sol";
import { GetWithdrawnAmount_Integration_Concrete_Test } from "../lockup/get-withdrawn-amount/getWithdrawnAmount.t.sol";
+import { IsAllowedToHook_Integration_Concrete_Test } from "../lockup/is-allowed-to-hook/isAllowedToHook.t.sol";
import { IsCancelable_Integration_Concrete_Test } from "../lockup/is-cancelable/isCancelable.t.sol";
import { IsCold_Integration_Concrete_Test } from "../lockup/is-cold/isCold.t.sol";
import { IsDepleted_Integration_Concrete_Test } from "../lockup/is-depleted/isDepleted.t.sol";
import { IsStream_Integration_Concrete_Test } from "../lockup/is-stream/isStream.t.sol";
import { IsTransferable_Integration_Concrete_Test } from "../lockup/is-transferable/isTransferable.t.sol";
import { IsWarm_Integration_Concrete_Test } from "../lockup/is-warm/isWarm.t.sol";
-import { ProtocolRevenues_Integration_Concrete_Test } from "../lockup/protocol-revenues/protocolRevenues.t.sol";
import { RefundableAmountOf_Integration_Concrete_Test } from "../lockup/refundable-amount-of/refundableAmountOf.t.sol";
import { Renounce_Integration_Concrete_Test } from "../lockup/renounce/renounce.t.sol";
-import { SetComptroller_Integration_Concrete_Test } from "../lockup/set-comptroller/setComptroller.t.sol";
import { SetNFTDescriptor_Integration_Concrete_Test } from "../lockup/set-nft-descriptor/setNFTDescriptor.t.sol";
import { StatusOf_Integration_Concrete_Test } from "../lockup/status-of/statusOf.t.sol";
import { TransferFrom_Integration_Concrete_Test } from "../lockup/transfer-from/transferFrom.t.sol";
import { WasCanceled_Integration_Concrete_Test } from "../lockup/was-canceled/wasCanceled.t.sol";
import { Withdraw_Integration_Concrete_Test } from "../lockup/withdraw/withdraw.t.sol";
+import { WithdrawHooks_Integration_Concrete_Test } from "../lockup/withdraw-hooks/withdrawHooks.t.sol";
import { WithdrawMax_Integration_Concrete_Test } from "../lockup/withdraw-max/withdrawMax.t.sol";
import { WithdrawMaxAndTransfer_Integration_Concrete_Test } from
"../lockup/withdraw-max-and-transfer/withdrawMaxAndTransfer.t.sol";
@@ -51,8 +49,7 @@ abstract contract LockupLinear_Integration_Concrete_Test is Integration_Test, Lo
Integration_Test.setUp();
LockupLinear_Integration_Shared_Test.setUp();
- // Cast the LockupLinear contract as {ISablierV2Base} and {ISablierV2Lockup}.
- base = ISablierV2Base(lockupLinear);
+ // Cast the {LockupLinear} contract as {ISablierV2Lockup}.
lockup = ISablierV2Lockup(lockupLinear);
}
}
@@ -61,6 +58,20 @@ abstract contract LockupLinear_Integration_Concrete_Test is Integration_Test, Lo
SHARED TESTS
//////////////////////////////////////////////////////////////////////////*/
+contract AllowToHook_LockupLinear_Integration_Concrete_Test is
+ LockupLinear_Integration_Concrete_Test,
+ AllowToHook_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupLinear_Integration_Concrete_Test, AllowToHook_Integration_Concrete_Test)
+ {
+ LockupLinear_Integration_Concrete_Test.setUp();
+ AllowToHook_Integration_Concrete_Test.setUp();
+ }
+}
+
contract Burn_LockupLinear_Integration_Concrete_Test is
LockupLinear_Integration_Concrete_Test,
Burn_Integration_Concrete_Test
@@ -99,20 +110,6 @@ contract CancelMultiple_LockupLinear_Integration_Concrete_Test is
}
}
-contract ClaimProtocolRevenues_LockupLinear_Integration_Concrete_Test is
- LockupLinear_Integration_Concrete_Test,
- ClaimProtocolRevenues_Integration_Concrete_Test
-{
- function setUp()
- public
- virtual
- override(LockupLinear_Integration_Concrete_Test, ClaimProtocolRevenues_Integration_Concrete_Test)
- {
- LockupLinear_Integration_Concrete_Test.setUp();
- ClaimProtocolRevenues_Integration_Concrete_Test.setUp();
- }
-}
-
contract GetAsset_LockupLinear_Integration_Concrete_Test is
LockupLinear_Integration_Concrete_Test,
GetAsset_Integration_Concrete_Test
@@ -225,6 +222,20 @@ contract GetWithdrawnAmount_LockupLinear_Integration_Concrete_Test is
}
}
+contract IsAllowedToHook_LockupLinear_Integration_Concrete_Test is
+ LockupLinear_Integration_Concrete_Test,
+ IsAllowedToHook_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupLinear_Integration_Concrete_Test, IsAllowedToHook_Integration_Concrete_Test)
+ {
+ LockupLinear_Integration_Concrete_Test.setUp();
+ IsAllowedToHook_Integration_Concrete_Test.setUp();
+ }
+}
+
contract IsCancelable_LockupLinear_Integration_Concrete_Test is
LockupLinear_Integration_Concrete_Test,
IsCancelable_Integration_Concrete_Test
@@ -309,20 +320,6 @@ contract IsWarm_LockupLinear_Integration_Concrete_Test is
}
}
-contract ProtocolRevenues_LockupLinear_Integration_Concrete_Test is
- LockupLinear_Integration_Concrete_Test,
- ProtocolRevenues_Integration_Concrete_Test
-{
- function setUp()
- public
- virtual
- override(LockupLinear_Integration_Concrete_Test, ProtocolRevenues_Integration_Concrete_Test)
- {
- LockupLinear_Integration_Concrete_Test.setUp();
- ProtocolRevenues_Integration_Concrete_Test.setUp();
- }
-}
-
contract Renounce_LockupLinear_Integration_Concrete_Test is
LockupLinear_Integration_Concrete_Test,
Renounce_Integration_Concrete_Test
@@ -351,20 +348,6 @@ contract RefundableAmountOf_LockupLinear_Integration_Concrete_Test is
}
}
-contract SetComptroller_LockupLinear_Integration_Concrete_Test is
- LockupLinear_Integration_Concrete_Test,
- SetComptroller_Integration_Concrete_Test
-{
- function setUp()
- public
- virtual
- override(LockupLinear_Integration_Concrete_Test, SetComptroller_Integration_Concrete_Test)
- {
- LockupLinear_Integration_Concrete_Test.setUp();
- SetComptroller_Integration_Concrete_Test.setUp();
- }
-}
-
contract SetNFTDescriptor_LockupLinear_Integration_Concrete_Test is
LockupLinear_Integration_Concrete_Test,
SetNFTDescriptor_Integration_Concrete_Test
@@ -435,6 +418,20 @@ contract Withdraw_LockupLinear_Integration_Concrete_Test is
}
}
+contract WithdrawHooks_LockupLinear_Integration_Concrete_Test is
+ LockupLinear_Integration_Concrete_Test,
+ WithdrawHooks_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupLinear_Integration_Concrete_Test, WithdrawHooks_Integration_Concrete_Test)
+ {
+ LockupLinear_Integration_Concrete_Test.setUp();
+ WithdrawHooks_Integration_Concrete_Test.setUp();
+ }
+}
+
contract WithdrawMax_LockupLinear_Integration_Concrete_Test is
LockupLinear_Integration_Concrete_Test,
WithdrawMax_Integration_Concrete_Test
diff --git a/test/integration/concrete/lockup-linear/constructor.t.sol b/test/integration/concrete/lockup-linear/constructor.t.sol
index 12e7fb8f7..323f5fb60 100644
--- a/test/integration/concrete/lockup-linear/constructor.t.sol
+++ b/test/integration/concrete/lockup-linear/constructor.t.sol
@@ -1,6 +1,7 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
+import { UD60x18 } from "@prb/math/src/UD60x18.sol";
import { SablierV2LockupLinear } from "src/SablierV2LockupLinear.sol";
import { LockupLinear_Integration_Concrete_Test } from "./LockupLinear.t.sol";
@@ -12,24 +13,28 @@ contract Constructor_LockupLinear_Integration_Concrete_Test is LockupLinear_Inte
emit TransferAdmin({ oldAdmin: address(0), newAdmin: users.admin });
// Construct the contract.
- SablierV2LockupLinear constructedLockupLinear = new SablierV2LockupLinear({
- initialAdmin: users.admin,
- initialComptroller: comptroller,
- initialNFTDescriptor: nftDescriptor
- });
+ SablierV2LockupLinear constructedLockupLinear =
+ new SablierV2LockupLinear({ initialAdmin: users.admin, initialNFTDescriptor: nftDescriptor });
- // {SablierV2Base.constructor}
+ // {SablierV2Lockup.constant}
+ UD60x18 actualMaxBrokerFee = constructedLockupLinear.MAX_BROKER_FEE();
+ UD60x18 expectedMaxBrokerFee = UD60x18.wrap(0.1e18);
+ assertEq(actualMaxBrokerFee, expectedMaxBrokerFee, "MAX_BROKER_FEE");
+
+ // {SablierV2Lockup.constructor}
address actualAdmin = constructedLockupLinear.admin();
address expectedAdmin = users.admin;
assertEq(actualAdmin, expectedAdmin, "admin");
- address actualComptroller = address(constructedLockupLinear.comptroller());
- address expectedComptroller = address(comptroller);
- assertEq(actualComptroller, expectedComptroller, "comptroller");
-
- // {SablierV2Lockup.constructor}
uint256 actualStreamId = constructedLockupLinear.nextStreamId();
uint256 expectedStreamId = 1;
assertEq(actualStreamId, expectedStreamId, "nextStreamId");
+
+ address actualNFTDescriptor = address(constructedLockupLinear.nftDescriptor());
+ address expectedNFTDescriptor = address(nftDescriptor);
+ assertEq(actualNFTDescriptor, expectedNFTDescriptor, "nftDescriptor");
+
+ // {SablierV2Lockup.supportsInterface}
+ assertTrue(constructedLockupLinear.supportsInterface(0x49064906), "ERC-4906 interface ID");
}
}
diff --git a/test/integration/concrete/lockup-linear/create-with-durations/createWithDurations.t.sol b/test/integration/concrete/lockup-linear/create-with-durations/createWithDurations.t.sol
index 02f9c53ab..38fd9daae 100644
--- a/test/integration/concrete/lockup-linear/create-with-durations/createWithDurations.t.sol
+++ b/test/integration/concrete/lockup-linear/create-with-durations/createWithDurations.t.sol
@@ -1,11 +1,11 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { ISablierV2LockupLinear } from "src/interfaces/ISablierV2LockupLinear.sol";
import { Errors } from "src/libraries/Errors.sol";
import { Lockup, LockupLinear } from "src/types/DataTypes.sol";
-import { CreateWithDurations_Integration_Shared_Test } from "../../../shared/lockup-linear/createWithDurations.t.sol";
+import { CreateWithDurations_Integration_Shared_Test } from "../../../shared/lockup/createWithDurations.t.sol";
import { LockupLinear_Integration_Concrete_Test } from "../LockupLinear.t.sol";
contract CreateWithDurations_LockupLinear_Integration_Concrete_Test is
@@ -23,14 +23,15 @@ contract CreateWithDurations_LockupLinear_Integration_Concrete_Test is
function test_RevertWhen_DelegateCalled() external {
bytes memory callData =
- abi.encodeCall(ISablierV2LockupLinear.createWithDurations, defaults.createWithDurations());
+ abi.encodeCall(ISablierV2LockupLinear.createWithDurations, defaults.createWithDurationsLL());
(bool success, bytes memory returnData) = address(lockupLinear).delegatecall(callData);
expectRevertDueToDelegateCall(success, returnData);
}
function test_RevertWhen_CliffDurationCalculationOverflows() external whenNotDelegateCalled {
uint40 startTime = getBlockTimestamp();
- uint40 cliffDuration = MAX_UINT40 - startTime + 1 seconds;
+ uint40 cliffDuration = MAX_UINT40 - startTime + 2 seconds;
+ uint40 totalDuration = defaults.TOTAL_DURATION();
// Calculate the end time. Needs to be "unchecked" to avoid an overflow.
uint40 cliffTime;
@@ -41,13 +42,10 @@ contract CreateWithDurations_LockupLinear_Integration_Concrete_Test is
// Expect the relevant error to be thrown.
vm.expectRevert(
abi.encodeWithSelector(
- Errors.SablierV2LockupLinear_StartTimeGreaterThanCliffTime.selector, startTime, cliffTime
+ Errors.SablierV2LockupLinear_StartTimeNotLessThanCliffTime.selector, startTime, cliffTime
)
);
- // Set the total duration to be the same as the cliff duration.
- uint40 totalDuration = cliffDuration;
-
// Create the stream.
createDefaultStreamWithDurations(LockupLinear.Durations({ cliff: cliffDuration, total: totalDuration }));
}
@@ -61,7 +59,7 @@ contract CreateWithDurations_LockupLinear_Integration_Concrete_Test is
LockupLinear.Durations memory durations =
LockupLinear.Durations({ cliff: 0, total: MAX_UINT40 - startTime + 1 seconds });
- // Calculate the cliff time and the end time. Needs to be "unchecked" to avoid an overflow.
+ // Calculate the cliff time and the end time. Needs to be "unchecked" to allow an overflow.
uint40 cliffTime;
uint40 endTime;
unchecked {
@@ -72,7 +70,7 @@ contract CreateWithDurations_LockupLinear_Integration_Concrete_Test is
// Expect the relevant error to be thrown.
vm.expectRevert(
abi.encodeWithSelector(
- Errors.SablierV2LockupLinear_CliffTimeNotLessThanEndTime.selector, cliffTime, endTime
+ Errors.SablierV2LockupLinear_StartTimeNotLessThanEndTime.selector, startTime, endTime
)
);
@@ -89,26 +87,19 @@ contract CreateWithDurations_LockupLinear_Integration_Concrete_Test is
// Make the Sender the stream's funder
address funder = users.sender;
- // Load the initial protocol revenues.
- uint128 initialProtocolRevenues = lockupLinear.protocolRevenues(dai);
-
- // Declare the range.
- uint40 currentTime = getBlockTimestamp();
- LockupLinear.Range memory range = LockupLinear.Range({
- start: currentTime,
- cliff: currentTime + defaults.CLIFF_DURATION(),
- end: currentTime + defaults.TOTAL_DURATION()
+ // Declare the timestamps.
+ uint40 blockTimestamp = getBlockTimestamp();
+ LockupLinear.Timestamps memory timestamps = LockupLinear.Timestamps({
+ start: blockTimestamp,
+ cliff: blockTimestamp + defaults.CLIFF_DURATION(),
+ end: blockTimestamp + defaults.TOTAL_DURATION()
});
// Expect the assets to be transferred from the funder to {SablierV2LockupLinear}.
- expectCallToTransferFrom({
- from: funder,
- to: address(lockupLinear),
- amount: defaults.DEPOSIT_AMOUNT() + defaults.PROTOCOL_FEE_AMOUNT()
- });
+ expectCallToTransferFrom({ from: funder, to: address(lockupLinear), value: defaults.DEPOSIT_AMOUNT() });
// Expect the broker fee to be paid to the broker.
- expectCallToTransferFrom({ from: funder, to: users.broker, amount: defaults.BROKER_FEE_AMOUNT() });
+ expectCallToTransferFrom({ from: funder, to: users.broker, value: defaults.BROKER_FEE_AMOUNT() });
// Expect the relevant events to be emitted.
vm.expectEmit({ emitter: address(lockupLinear) });
@@ -123,7 +114,7 @@ contract CreateWithDurations_LockupLinear_Integration_Concrete_Test is
asset: dai,
cancelable: true,
transferable: true,
- range: range,
+ timestamps: timestamps,
broker: users.broker
});
@@ -131,11 +122,11 @@ contract CreateWithDurations_LockupLinear_Integration_Concrete_Test is
createDefaultStreamWithDurations();
// Assert that the stream has been created.
- LockupLinear.Stream memory actualStream = lockupLinear.getStream(streamId);
- LockupLinear.Stream memory expectedStream = defaults.lockupLinearStream();
- expectedStream.startTime = range.start;
- expectedStream.cliffTime = range.cliff;
- expectedStream.endTime = range.end;
+ LockupLinear.StreamLL memory actualStream = lockupLinear.getStream(streamId);
+ LockupLinear.StreamLL memory expectedStream = defaults.lockupLinearStream();
+ expectedStream.startTime = timestamps.start;
+ expectedStream.cliffTime = timestamps.cliff;
+ expectedStream.endTime = timestamps.end;
assertEq(actualStream, expectedStream);
// Assert that the stream's status is "STREAMING".
@@ -143,16 +134,11 @@ contract CreateWithDurations_LockupLinear_Integration_Concrete_Test is
Lockup.Status expectedStatus = Lockup.Status.STREAMING;
assertEq(actualStatus, expectedStatus);
- // Assert that the next stream id has been bumped.
+ // Assert that the next stream ID has been bumped.
uint256 actualNextStreamId = lockupLinear.nextStreamId();
uint256 expectedNextStreamId = streamId + 1;
assertEq(actualNextStreamId, expectedNextStreamId, "nextStreamId");
- // Assert that the protocol fee has been recorded.
- uint128 actualProtocolRevenues = lockupLinear.protocolRevenues(dai);
- uint128 expectedProtocolRevenues = initialProtocolRevenues + defaults.PROTOCOL_FEE_AMOUNT();
- assertEq(actualProtocolRevenues, expectedProtocolRevenues, "protocolRevenues");
-
// Assert that the NFT has been minted.
address actualNFTOwner = lockupLinear.ownerOf({ tokenId: streamId });
address expectedNFTOwner = users.recipient;
diff --git a/test/integration/concrete/lockup-linear/create-with-durations/createWithDurations.tree b/test/integration/concrete/lockup-linear/create-with-durations/createWithDurations.tree
index ca9a10630..e769f8a06 100644
--- a/test/integration/concrete/lockup-linear/create-with-durations/createWithDurations.tree
+++ b/test/integration/concrete/lockup-linear/create-with-durations/createWithDurations.tree
@@ -6,11 +6,10 @@ createWithDurations.t.sol
│ └── it should revert due to the start time being greater than the cliff time
└── when the cliff duration calculation does not overflow uint256
├── when the total duration calculation overflows uint256
- │ └── it should revert
+ │ └── it should revert
└── when the total duration calculation does not overflow uint256
- ├── it should create the stream
- ├── it should bump the next stream id
- ├── it should record the protocol fee
- ├── it should mint the NFT
- ├── it should perform the ERC-20 transfers
- └── it should emit a {CreateLockupLinearStream} event
+ ├── it should create the stream
+ ├── it should bump the next stream ID
+ ├── it should mint the NFT
+ ├── it should perform the ERC-20 transfers
+ └── it should emit a {CreateLockupLinearStream} event
diff --git a/test/integration/concrete/lockup-linear/create-with-range/createWithRange.tree b/test/integration/concrete/lockup-linear/create-with-range/createWithRange.tree
deleted file mode 100644
index 6d810042a..000000000
--- a/test/integration/concrete/lockup-linear/create-with-range/createWithRange.tree
+++ /dev/null
@@ -1,45 +0,0 @@
-createWithRange.t.sol
-├── when delegate called
-│ └── it should revert
-└── when not delegate called
- ├── when the recipient is the zero address
- │ └── it should revert
- └── when the recipient is not the zero address
- ├── when the deposit amount is zero
- │ └── it should revert
- └── when the deposit amount is not zero
- ├── when the start time is greater than the cliff time
- │ └── it should revert
- └── when the start time is not greater than the cliff time
- ├── when the cliff time is not less than the end time
- │ └── it should revert
- └── when the cliff time is less than the end time
- ├── when the end time is not in the future
- │ └── it should revert
- └── when the end time is in the future
- ├── given the protocol fee is too high
- │ └── it should revert
- └── given the protocol fee is not too high
- ├── when the broker fee is too high
- │ └── it should revert
- └── when the broker fee is not too high
- ├── when the asset is not a contract
- │ └── it should revert
- └── when the asset is a contract
- ├── when the asset misses the ERC-20 return value
- │ ├── it should create the stream
- │ ├── it should bump the next stream id
- │ ├── it should record the protocol fee
- │ ├── it should mint the NFT
- │ ├── it should emit a {MetadataUpdate} event
- │ ├── it should perform the ERC-20 transfers
- │ └── it should emit a {CreateLockupLinearStream} event
- └── when the asset does not miss the ERC-20 return value
- ├── it should create the stream
- ├── it should bump the next stream id
- ├── it should record the protocol fee
- ├── it should mint the NFT
- ├── it should emit a {MetadataUpdate} event
- ├── it should perform the ERC-20 transfers
- └── it should emit a {CreateLockupLinearStream} event
-
diff --git a/test/integration/concrete/lockup-linear/create-with-range/createWithRange.t.sol b/test/integration/concrete/lockup-linear/create-with-timestamps/createWithTimestamps.t.sol
similarity index 54%
rename from test/integration/concrete/lockup-linear/create-with-range/createWithRange.t.sol
rename to test/integration/concrete/lockup-linear/create-with-timestamps/createWithTimestamps.t.sol
index 65a988b08..5ce293a85 100644
--- a/test/integration/concrete/lockup-linear/create-with-range/createWithRange.t.sol
+++ b/test/integration/concrete/lockup-linear/create-with-timestamps/createWithTimestamps.t.sol
@@ -1,6 +1,8 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
+import { Address } from "@openzeppelin/contracts/utils/Address.sol";
+import { IERC721Errors } from "@openzeppelin/contracts/interfaces/draft-IERC6093.sol";
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { UD60x18, ud } from "@prb/math/src/UD60x18.sol";
@@ -8,55 +10,121 @@ import { ISablierV2LockupLinear } from "src/interfaces/ISablierV2LockupLinear.so
import { Errors } from "src/libraries/Errors.sol";
import { Broker, Lockup, LockupLinear } from "src/types/DataTypes.sol";
-import { CreateWithRange_Integration_Shared_Test } from "../../../shared/lockup-linear/createWithRange.t.sol";
+import { CreateWithTimestamps_Integration_Shared_Test } from "../../../shared/lockup/createWithTimestamps.t.sol";
import { LockupLinear_Integration_Concrete_Test } from "../LockupLinear.t.sol";
-contract CreateWithRange_LockupLinear_Integration_Concrete_Test is
+contract CreateWithTimestamps_LockupLinear_Integration_Concrete_Test is
LockupLinear_Integration_Concrete_Test,
- CreateWithRange_Integration_Shared_Test
+ CreateWithTimestamps_Integration_Shared_Test
{
function setUp()
public
virtual
- override(LockupLinear_Integration_Concrete_Test, CreateWithRange_Integration_Shared_Test)
+ override(LockupLinear_Integration_Concrete_Test, CreateWithTimestamps_Integration_Shared_Test)
{
LockupLinear_Integration_Concrete_Test.setUp();
- CreateWithRange_Integration_Shared_Test.setUp();
+ CreateWithTimestamps_Integration_Shared_Test.setUp();
}
function test_RevertWhen_DelegateCalled() external {
- bytes memory callData = abi.encodeCall(ISablierV2LockupLinear.createWithRange, defaults.createWithRange());
+ bytes memory callData =
+ abi.encodeCall(ISablierV2LockupLinear.createWithTimestamps, defaults.createWithTimestampsLL());
(bool success, bytes memory returnData) = address(lockupLinear).delegatecall(callData);
expectRevertDueToDelegateCall(success, returnData);
}
function test_RevertWhen_RecipientZeroAddress() external whenNotDelegateCalled {
- vm.expectRevert("ERC721: mint to the zero address");
- createDefaultStreamWithRecipient({ recipient: address(0) });
+ address recipient = address(0);
+ vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721InvalidReceiver.selector, recipient));
+ createDefaultStreamWithRecipient(recipient);
}
/// @dev It is not possible to obtain a zero deposit amount from a non-zero total amount, because the
- /// `MAX_FEE` is hard coded to 10%.
+ /// `MAX_BROKER_FEE` is hard coded to 10%.
function test_RevertWhen_DepositAmountZero() external whenNotDelegateCalled whenRecipientNonZeroAddress {
vm.expectRevert(Errors.SablierV2Lockup_DepositAmountZero.selector);
createDefaultStreamWithTotalAmount(0);
}
+ function test_RevertWhen_StartTimeZero()
+ external
+ whenNotDelegateCalled
+ whenRecipientNonZeroAddress
+ whenDepositAmountNotZero
+ {
+ uint40 cliffTime = defaults.CLIFF_TIME();
+ uint40 endTime = defaults.END_TIME();
+
+ vm.expectRevert(Errors.SablierV2Lockup_StartTimeZero.selector);
+ createDefaultStreamWithTimestamps(LockupLinear.Timestamps({ start: 0, cliff: cliffTime, end: endTime }));
+ }
+
+ function test_RevertWhen_StartTimeNotLessThanEndTime()
+ external
+ whenNotDelegateCalled
+ whenRecipientNonZeroAddress
+ whenDepositAmountNotZero
+ whenStartTimeNotZero
+ whenCliffTimeZero
+ {
+ uint40 startTime = defaults.END_TIME();
+ uint40 endTime = defaults.START_TIME();
+
+ vm.expectRevert(
+ abi.encodeWithSelector(
+ Errors.SablierV2LockupLinear_StartTimeNotLessThanEndTime.selector, startTime, endTime
+ )
+ );
+ createDefaultStreamWithTimestamps(LockupLinear.Timestamps({ start: startTime, cliff: 0, end: endTime }));
+ }
+
+ function test_CreateWithTimestamps_StartTimeLessThanEndTime()
+ external
+ whenNotDelegateCalled
+ whenRecipientNonZeroAddress
+ whenDepositAmountNotZero
+ whenStartTimeNotZero
+ whenCliffTimeZero
+ {
+ createDefaultStreamWithTimestamps(
+ LockupLinear.Timestamps({ start: defaults.START_TIME(), cliff: 0, end: defaults.END_TIME() })
+ );
+
+ // Assert that the stream has been created.
+ LockupLinear.StreamLL memory actualStream = lockupLinear.getStream(streamId);
+ LockupLinear.StreamLL memory expectedStream = defaults.lockupLinearStream();
+ expectedStream.cliffTime = 0;
+ assertEq(actualStream, expectedStream);
+
+ // Assert that the next stream ID has been bumped.
+ uint256 actualNextStreamId = lockupLinear.nextStreamId();
+ uint256 expectedNextStreamId = streamId + 1;
+ assertEq(actualNextStreamId, expectedNextStreamId, "nextStreamId");
+
+ // Assert that the NFT has been minted.
+ address actualNFTOwner = lockupLinear.ownerOf({ tokenId: streamId });
+ address expectedNFTOwner = users.recipient;
+ assertEq(actualNFTOwner, expectedNFTOwner, "NFT owner");
+ }
+
function test_RevertWhen_StartTimeGreaterThanCliffTime()
external
whenNotDelegateCalled
whenRecipientNonZeroAddress
whenDepositAmountNotZero
+ whenStartTimeNotZero
+ whenCliffTimeGreaterThanZero
+ whenStartTimeLessThanEndTime
{
uint40 startTime = defaults.CLIFF_TIME();
uint40 cliffTime = defaults.START_TIME();
uint40 endTime = defaults.END_TIME();
vm.expectRevert(
abi.encodeWithSelector(
- Errors.SablierV2LockupLinear_StartTimeGreaterThanCliffTime.selector, startTime, cliffTime
+ Errors.SablierV2LockupLinear_StartTimeNotLessThanCliffTime.selector, startTime, cliffTime
)
);
- createDefaultStreamWithRange(LockupLinear.Range({ start: startTime, cliff: cliffTime, end: endTime }));
+ createDefaultStreamWithTimestamps(LockupLinear.Timestamps({ start: startTime, cliff: cliffTime, end: endTime }));
}
function test_RevertWhen_CliffTimeNotLessThanEndTime()
@@ -64,7 +132,9 @@ contract CreateWithRange_LockupLinear_Integration_Concrete_Test is
whenNotDelegateCalled
whenRecipientNonZeroAddress
whenDepositAmountNotZero
- whenStartTimeNotGreaterThanCliffTime
+ whenStartTimeNotZero
+ whenCliffTimeGreaterThanZero
+ whenStartTimeLessThanEndTime
{
uint40 startTime = defaults.START_TIME();
uint40 cliffTime = defaults.END_TIME();
@@ -74,7 +144,7 @@ contract CreateWithRange_LockupLinear_Integration_Concrete_Test is
Errors.SablierV2LockupLinear_CliffTimeNotLessThanEndTime.selector, cliffTime, endTime
)
);
- createDefaultStreamWithRange(LockupLinear.Range({ start: startTime, cliff: cliffTime, end: endTime }));
+ createDefaultStreamWithTimestamps(LockupLinear.Timestamps({ start: startTime, cliff: cliffTime, end: endTime }));
}
function test_RevertGiven_EndTimeNotInTheFuture()
@@ -82,51 +152,33 @@ contract CreateWithRange_LockupLinear_Integration_Concrete_Test is
whenNotDelegateCalled
whenRecipientNonZeroAddress
whenDepositAmountNotZero
- whenStartTimeNotGreaterThanCliffTime
+ whenStartTimeNotZero
+ whenCliffTimeGreaterThanZero
+ whenStartTimeLessThanEndTime
whenCliffTimeLessThanEndTime
whenEndTimeInTheFuture
{
uint40 endTime = defaults.END_TIME();
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_EndTimeNotInTheFuture.selector, endTime, endTime));
createDefaultStream();
}
- function test_RevertGiven_ProtocolFeeTooHigh()
+ function test_RevertWhen_BrokerFeeTooHigh()
external
whenNotDelegateCalled
whenRecipientNonZeroAddress
whenDepositAmountNotZero
- whenStartTimeNotGreaterThanCliffTime
+ whenStartTimeNotZero
+ whenCliffTimeGreaterThanZero
+ whenStartTimeLessThanEndTime
whenCliffTimeLessThanEndTime
whenEndTimeInTheFuture
{
- UD60x18 protocolFee = MAX_FEE + ud(1);
-
- // Set the protocol fee.
- changePrank({ msgSender: users.admin });
- comptroller.setProtocolFee({ asset: dai, newProtocolFee: protocolFee });
- changePrank({ msgSender: users.sender });
-
- // Run the test.
+ UD60x18 brokerFee = MAX_BROKER_FEE + ud(1);
vm.expectRevert(
- abi.encodeWithSelector(Errors.SablierV2Lockup_ProtocolFeeTooHigh.selector, protocolFee, MAX_FEE)
+ abi.encodeWithSelector(Errors.SablierV2Lockup_BrokerFeeTooHigh.selector, brokerFee, MAX_BROKER_FEE)
);
- createDefaultStream();
- }
-
- function test_RevertWhen_BrokerFeeTooHigh()
- external
- whenNotDelegateCalled
- whenRecipientNonZeroAddress
- whenDepositAmountNotZero
- whenStartTimeNotGreaterThanCliffTime
- whenCliffTimeLessThanEndTime
- whenEndTimeInTheFuture
- givenProtocolFeeNotTooHigh
- {
- UD60x18 brokerFee = MAX_FEE + ud(1);
- vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_BrokerFeeTooHigh.selector, brokerFee, MAX_FEE));
createDefaultStreamWithBroker(Broker({ account: users.broker, fee: brokerFee }));
}
@@ -135,49 +187,52 @@ contract CreateWithRange_LockupLinear_Integration_Concrete_Test is
whenNotDelegateCalled
whenRecipientNonZeroAddress
whenDepositAmountNotZero
- whenStartTimeNotGreaterThanCliffTime
+ whenStartTimeNotZero
+ whenCliffTimeGreaterThanZero
+ whenStartTimeLessThanEndTime
whenCliffTimeLessThanEndTime
whenEndTimeInTheFuture
- givenProtocolFeeNotTooHigh
whenBrokerFeeNotTooHigh
{
address nonContract = address(8128);
- vm.expectRevert("Address: call to non-contract");
+ vm.expectRevert(abi.encodeWithSelector(Address.AddressEmptyCode.selector, nonContract));
createDefaultStreamWithAsset(IERC20(nonContract));
}
- function test_CreateWithRange_AssetMissingReturnValue()
+ function test_CreateWithTimestamps_AssetMissingReturnValue()
external
whenNotDelegateCalled
whenRecipientNonZeroAddress
whenDepositAmountNotZero
- whenStartTimeNotGreaterThanCliffTime
+ whenStartTimeNotZero
+ whenCliffTimeGreaterThanZero
+ whenStartTimeLessThanEndTime
whenCliffTimeLessThanEndTime
whenEndTimeInTheFuture
- givenProtocolFeeNotTooHigh
whenBrokerFeeNotTooHigh
whenAssetContract
{
- testCreateWithRange(address(usdt));
+ testCreateWithTimestamps(address(usdt));
}
- function test_CreateWithRange()
+ function test_CreateWithTimestamps()
external
whenNotDelegateCalled
whenDepositAmountNotZero
- whenStartTimeNotGreaterThanCliffTime
+ whenStartTimeNotZero
+ whenCliffTimeGreaterThanZero
+ whenStartTimeLessThanEndTime
whenCliffTimeLessThanEndTime
whenEndTimeInTheFuture
- givenProtocolFeeNotTooHigh
whenBrokerFeeNotTooHigh
whenAssetContract
whenAssetERC20
{
- testCreateWithRange(address(dai));
+ testCreateWithTimestamps(address(dai));
}
- /// @dev Shared logic between {test_CreateWithRange_AssetMissingReturnValue} and {test_CreateWithRange}.
- function testCreateWithRange(address asset) internal {
+ /// @dev Shared logic between {test_CreateWithTimestamps_AssetMissingReturnValue} and {test_CreateWithTimestamps}.
+ function testCreateWithTimestamps(address asset) internal {
// Make the Sender the stream's funder.
address funder = users.sender;
@@ -186,7 +241,7 @@ contract CreateWithRange_LockupLinear_Integration_Concrete_Test is
asset: IERC20(asset),
from: funder,
to: address(lockupLinear),
- amount: defaults.DEPOSIT_AMOUNT() + defaults.PROTOCOL_FEE_AMOUNT()
+ value: defaults.DEPOSIT_AMOUNT()
});
// Expect the broker fee to be paid to the broker.
@@ -194,7 +249,7 @@ contract CreateWithRange_LockupLinear_Integration_Concrete_Test is
asset: IERC20(asset),
from: funder,
to: users.broker,
- amount: defaults.BROKER_FEE_AMOUNT()
+ value: defaults.BROKER_FEE_AMOUNT()
});
// Expect the relevant events to be emitted.
@@ -210,7 +265,7 @@ contract CreateWithRange_LockupLinear_Integration_Concrete_Test is
asset: IERC20(asset),
cancelable: true,
transferable: true,
- range: defaults.lockupLinearRange(),
+ timestamps: defaults.lockupLinearTimestamps(),
broker: users.broker
});
@@ -218,8 +273,8 @@ contract CreateWithRange_LockupLinear_Integration_Concrete_Test is
createDefaultStreamWithAsset(IERC20(asset));
// Assert that the stream has been created.
- LockupLinear.Stream memory actualStream = lockupLinear.getStream(streamId);
- LockupLinear.Stream memory expectedStream = defaults.lockupLinearStream();
+ LockupLinear.StreamLL memory actualStream = lockupLinear.getStream(streamId);
+ LockupLinear.StreamLL memory expectedStream = defaults.lockupLinearStream();
expectedStream.asset = IERC20(asset);
assertEq(actualStream, expectedStream);
@@ -228,7 +283,7 @@ contract CreateWithRange_LockupLinear_Integration_Concrete_Test is
Lockup.Status expectedStatus = Lockup.Status.PENDING;
assertEq(actualStatus, expectedStatus);
- // Assert that the next stream id has been bumped.
+ // Assert that the next stream ID has been bumped.
uint256 actualNextStreamId = lockupLinear.nextStreamId();
uint256 expectedNextStreamId = streamId + 1;
assertEq(actualNextStreamId, expectedNextStreamId, "nextStreamId");
diff --git a/test/integration/concrete/lockup-linear/create-with-timestamps/createWithTimestamps.tree b/test/integration/concrete/lockup-linear/create-with-timestamps/createWithTimestamps.tree
new file mode 100644
index 000000000..6729ea211
--- /dev/null
+++ b/test/integration/concrete/lockup-linear/create-with-timestamps/createWithTimestamps.tree
@@ -0,0 +1,48 @@
+createWithTimestamps.t.sol
+├── when delegate called
+│ └── it should revert
+└── when not delegate called
+ ├── when the recipient is the zero address
+ │ └── it should revert
+ └── when the recipient is not the zero address
+ ├── when the deposit amount is zero
+ │ └── it should revert
+ └── when the deposit amount is not zero
+ ├── when the start time is zero
+ │ └── it should revert
+ └── when the start time is not zero
+ ├── when the cliff time is zero
+ │ ├── when the start time is not less than the end time
+ │ │ └── it should revert
+ │ └── when the start time is less than the end time
+ │ └── it should create the stream
+ └── when the cliff time is greater than zero
+ ├── when the start time is not less than the cliff time
+ │ └── it should revert
+ └── when the start time is less than the cliff time
+ ├── when the cliff time is not less than the end time
+ │ └── it should revert
+ └── when the cliff time is less than the end time
+ ├── when the end time is not in the future
+ │ └── it should revert
+ └── when the end time is in the future
+ ├── when the broker fee is too high
+ │ └── it should revert
+ └── when the broker fee is not too high
+ ├── when the asset is not a contract
+ │ └── it should revert
+ └── when the asset is a contract
+ ├── when the asset misses the ERC-20 return value
+ │ ├── it should create the stream
+ │ ├── it should bump the next stream ID
+ │ ├── it should mint the NFT
+ │ ├── it should emit a {MetadataUpdate} event
+ │ ├── it should perform the ERC-20 transfers
+ │ └── it should emit a {CreateLockupLinearStream} event
+ └── when the asset does not miss the ERC-20 return value
+ ├── it should create the stream
+ ├── it should bump the next stream ID
+ ├── it should mint the NFT
+ ├── it should emit a {MetadataUpdate} event
+ ├── it should perform the ERC-20 transfers
+ └── it should emit a {CreateLockupLinearStream} event
diff --git a/test/integration/concrete/lockup-linear/get-cliff-time/getCliffTime.t.sol b/test/integration/concrete/lockup-linear/get-cliff-time/getCliffTime.t.sol
index 2a22e894b..3207a55f2 100644
--- a/test/integration/concrete/lockup-linear/get-cliff-time/getCliffTime.t.sol
+++ b/test/integration/concrete/lockup-linear/get-cliff-time/getCliffTime.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
diff --git a/test/integration/concrete/lockup-linear/get-cliff-time/getCliffTime.tree b/test/integration/concrete/lockup-linear/get-cliff-time/getCliffTime.tree
index afa854032..d588c8587 100644
--- a/test/integration/concrete/lockup-linear/get-cliff-time/getCliffTime.tree
+++ b/test/integration/concrete/lockup-linear/get-cliff-time/getCliffTime.tree
@@ -1,5 +1,5 @@
getCliffTime.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
└── it should return the correct cliff time
diff --git a/test/integration/concrete/lockup-linear/get-range/getRange.tree b/test/integration/concrete/lockup-linear/get-range/getRange.tree
deleted file mode 100644
index 88dcc9707..000000000
--- a/test/integration/concrete/lockup-linear/get-range/getRange.tree
+++ /dev/null
@@ -1,5 +0,0 @@
-getRange.t.sol
-├── given the id references a null stream
-│ └── it should revert
-└── given the id does not reference a null stream
- └── it should return the correct range
diff --git a/test/integration/concrete/lockup-linear/get-stream/getStream.t.sol b/test/integration/concrete/lockup-linear/get-stream/getStream.t.sol
index d182bbf03..6c4b0a5fb 100644
--- a/test/integration/concrete/lockup-linear/get-stream/getStream.t.sol
+++ b/test/integration/concrete/lockup-linear/get-stream/getStream.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
import { LockupLinear } from "src/types/DataTypes.sol";
@@ -25,9 +25,9 @@ contract GetStream_LockupLinear_Integration_Concrete_Test is LockupLinear_Integr
}
function test_GetStream_StatusSettled() external givenNotNull {
- vm.warp({ timestamp: defaults.END_TIME() });
- LockupLinear.Stream memory actualStream = lockupLinear.getStream(defaultStreamId);
- LockupLinear.Stream memory expectedStream = defaults.lockupLinearStream();
+ vm.warp({ newTimestamp: defaults.END_TIME() });
+ LockupLinear.StreamLL memory actualStream = lockupLinear.getStream(defaultStreamId);
+ LockupLinear.StreamLL memory expectedStream = defaults.lockupLinearStream();
expectedStream.isCancelable = false;
assertEq(actualStream, expectedStream);
}
@@ -37,8 +37,8 @@ contract GetStream_LockupLinear_Integration_Concrete_Test is LockupLinear_Integr
}
function test_GetStream() external givenNotNull givenStatusNotSettled {
- LockupLinear.Stream memory actualStream = lockupLinear.getStream(defaultStreamId);
- LockupLinear.Stream memory expectedStream = defaults.lockupLinearStream();
+ LockupLinear.StreamLL memory actualStream = lockupLinear.getStream(defaultStreamId);
+ LockupLinear.StreamLL memory expectedStream = defaults.lockupLinearStream();
assertEq(actualStream, expectedStream);
}
}
diff --git a/test/integration/concrete/lockup-linear/get-stream/getStream.tree b/test/integration/concrete/lockup-linear/get-stream/getStream.tree
index c3278db89..bde21f7b4 100644
--- a/test/integration/concrete/lockup-linear/get-stream/getStream.tree
+++ b/test/integration/concrete/lockup-linear/get-stream/getStream.tree
@@ -1,7 +1,7 @@
getStream.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
├── given the stream is settled
│ └── it should adjust the `isCancelable` flag and return the stream
└── given the stream is not settled
diff --git a/test/integration/concrete/lockup-linear/get-range/getRange.t.sol b/test/integration/concrete/lockup-linear/get-timestamps/getTimestamps.t.sol
similarity index 51%
rename from test/integration/concrete/lockup-linear/get-range/getRange.t.sol
rename to test/integration/concrete/lockup-linear/get-timestamps/getTimestamps.t.sol
index de45282ca..a0de39a5e 100644
--- a/test/integration/concrete/lockup-linear/get-range/getRange.t.sol
+++ b/test/integration/concrete/lockup-linear/get-timestamps/getTimestamps.t.sol
@@ -1,26 +1,26 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
import { LockupLinear } from "src/types/DataTypes.sol";
import { LockupLinear_Integration_Concrete_Test } from "../LockupLinear.t.sol";
-contract GetRange_LockupLinear_Integration_Concrete_Test is LockupLinear_Integration_Concrete_Test {
+contract GetTimestamps_LockupLinear_Integration_Concrete_Test is LockupLinear_Integration_Concrete_Test {
function test_RevertGiven_Null() external {
uint256 nullStreamId = 1729;
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_Null.selector, nullStreamId));
- lockupLinear.getRange(nullStreamId);
+ lockupLinear.getTimestamps(nullStreamId);
}
modifier givenNotNull() {
_;
}
- function test_GetRange() external givenNotNull {
+ function test_GetTimestamps() external givenNotNull {
uint256 streamId = createDefaultStream();
- LockupLinear.Range memory actualRange = lockupLinear.getRange(streamId);
- LockupLinear.Range memory expectedRange = defaults.lockupLinearRange();
- assertEq(actualRange, expectedRange);
+ LockupLinear.Timestamps memory actualTimestamps = lockupLinear.getTimestamps(streamId);
+ LockupLinear.Timestamps memory expectedTimestamps = defaults.lockupLinearTimestamps();
+ assertEq(actualTimestamps, expectedTimestamps);
}
}
diff --git a/test/integration/concrete/lockup-linear/get-timestamps/getTimestamps.tree b/test/integration/concrete/lockup-linear/get-timestamps/getTimestamps.tree
new file mode 100644
index 000000000..49e6bf2a0
--- /dev/null
+++ b/test/integration/concrete/lockup-linear/get-timestamps/getTimestamps.tree
@@ -0,0 +1,5 @@
+getTimestamps.t.sol
+├── given the ID references a null stream
+│ └── it should revert
+└── given the ID does not reference a null stream
+ └── it should return the correct timestamps
diff --git a/test/integration/concrete/lockup-linear/streamed-amount-of/streamedAmountOf.t.sol b/test/integration/concrete/lockup-linear/streamed-amount-of/streamedAmountOf.t.sol
index 4320a4aac..beda0bc05 100644
--- a/test/integration/concrete/lockup-linear/streamed-amount-of/streamedAmountOf.t.sol
+++ b/test/integration/concrete/lockup-linear/streamed-amount-of/streamedAmountOf.t.sol
@@ -1,5 +1,7 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
+
+import { LockupLinear } from "src/types/DataTypes.sol";
import { LockupLinear_Integration_Concrete_Test } from "../LockupLinear.t.sol";
import { StreamedAmountOf_Integration_Concrete_Test } from "../../lockup/streamed-amount-of/streamedAmountOf.t.sol";
@@ -17,10 +19,32 @@ contract StreamedAmountOf_LockupLinear_Integration_Concrete_Test is
StreamedAmountOf_Integration_Concrete_Test.setUp();
}
- function test_StreamedAmountOf_CliffTimeInThePast()
+ modifier givenStatusPending() {
+ _;
+ }
+
+ function test_StreamedAmountOf_CliffTimeZero()
external
givenNotNull
givenStreamHasNotBeenCanceled
+ givenStatusPending
+ {
+ vm.warp({ newTimestamp: defaults.START_TIME() - 1 });
+
+ LockupLinear.Timestamps memory timestamps = defaults.lockupLinearTimestamps();
+ timestamps.cliff = 0;
+ uint256 streamId = createDefaultStreamWithTimestamps(timestamps);
+
+ uint128 actualStreamedAmount = lockupLinear.streamedAmountOf(streamId);
+ uint128 expectedStreamedAmount = 0;
+ assertEq(actualStreamedAmount, expectedStreamedAmount, "streamedAmount");
+ }
+
+ function test_StreamedAmountOf_CliffTimeInTheFuture()
+ external
+ view
+ givenNotNull
+ givenStreamHasNotBeenCanceled
givenStatusStreaming
{
uint128 actualStreamedAmount = lockupLinear.streamedAmountOf(defaultStreamId);
@@ -34,19 +58,19 @@ contract StreamedAmountOf_LockupLinear_Integration_Concrete_Test is
givenStreamHasNotBeenCanceled
givenStatusStreaming
{
- vm.warp({ timestamp: defaults.CLIFF_TIME() });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() });
uint128 actualStreamedAmount = lockupLinear.streamedAmountOf(defaultStreamId);
uint128 expectedStreamedAmount = defaults.CLIFF_AMOUNT();
assertEq(actualStreamedAmount, expectedStreamedAmount, "streamedAmount");
}
- function test_StreamedAmountOf_CliffTimeInTheFuture()
+ function test_StreamedAmountOf_CliffTimeInThePast()
external
givenNotNull
givenStreamHasNotBeenCanceled
givenStatusStreaming
{
- vm.warp({ timestamp: defaults.WARP_26_PERCENT() });
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
uint128 actualStreamedAmount = lockupLinear.streamedAmountOf(defaultStreamId);
uint128 expectedStreamedAmount = 2600e18;
assertEq(actualStreamedAmount, expectedStreamedAmount, "streamedAmount");
diff --git a/test/integration/concrete/lockup-linear/streamed-amount-of/streamedAmountOf.tree b/test/integration/concrete/lockup-linear/streamed-amount-of/streamedAmountOf.tree
index 9c23e5349..e87b5df2f 100644
--- a/test/integration/concrete/lockup-linear/streamed-amount-of/streamedAmountOf.tree
+++ b/test/integration/concrete/lockup-linear/streamed-amount-of/streamedAmountOf.tree
@@ -1,8 +1,11 @@
streamedAmountOf.t.sol
+├── given the stream's status is "PENDING"
+│ └── given the cliff time is zero
+│ └── it should return zero
└── given the stream's status is "STREAMING"
- ├── given the cliff time is in the past
+ ├── given the cliff time is in the future
│ └── it should return zero
├── given the cliff time is in the present
│ └── it should return the correct streamed amount
- └── given the cliff time is not in the future
+ └── given the cliff time is in the past
└── it should return the correct streamed amount
diff --git a/test/integration/concrete/lockup-linear/token-uri/tokenURI.t.sol b/test/integration/concrete/lockup-linear/token-uri/tokenURI.t.sol
index 2f1d12906..2ce92568e 100644
--- a/test/integration/concrete/lockup-linear/token-uri/tokenURI.t.sol
+++ b/test/integration/concrete/lockup-linear/token-uri/tokenURI.t.sol
@@ -1,24 +1,22 @@
// SPDX-License-Identifier: UNLICENSED
// solhint-disable max-line-length,no-console,quotes
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
+import { IERC721Errors } from "@openzeppelin/contracts/interfaces/draft-IERC6093.sol";
import { console2 } from "forge-std/src/console2.sol";
-import { LibString } from "solady/src/utils/LibString.sol";
import { StdStyle } from "forge-std/src/StdStyle.sol";
import { Base64 } from "solady/src/utils/Base64.sol";
import { LockupLinear_Integration_Concrete_Test } from "../LockupLinear.t.sol";
/// @dev Requirements for these tests to work:
-/// - The stream id must be 1
+/// - The stream ID must be 1
/// - The stream's sender must be `0x6332e7b1deb1f1a0b77b2bb18b144330c7291bca`, i.e. `makeAddr("Sender")`
/// - The stream asset must have the DAI symbol
/// - The contract deployer, i.e. the `sender` config option in `foundry.toml`, must have the default value
/// 0x1804c8AB1F12E6bbf3894d4083f33e07309d1f38 so that the deployed contracts have the same addresses as
/// the values hard coded in the tests below
contract TokenURI_LockupLinear_Integration_Concrete_Test is LockupLinear_Integration_Concrete_Test {
- using LibString for string;
-
address internal constant LOCKUP_LINEAR = 0x3381cD18e2Fb4dB236BF0525938AB6E43Db0440f;
uint256 internal defaultStreamId;
@@ -33,13 +31,13 @@ contract TokenURI_LockupLinear_Integration_Concrete_Test is LockupLinear_Integra
function test_RevertGiven_NFTDoesNotExist() external {
uint256 nullStreamId = 1729;
- vm.expectRevert("ERC721: invalid token ID");
+ vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721NonexistentToken.selector, nullStreamId));
lockupLinear.tokenURI({ tokenId: nullStreamId });
}
modifier givenNFTExists() {
defaultStreamId = createDefaultStream();
- vm.warp({ timestamp: defaults.START_TIME() + defaults.TOTAL_DURATION() / 4 });
+ vm.warp({ newTimestamp: defaults.START_TIME() + defaults.TOTAL_DURATION() / 4 });
_;
}
@@ -48,7 +46,7 @@ contract TokenURI_LockupLinear_Integration_Concrete_Test is LockupLinear_Integra
/// 2. Remember to escape the EOL character \n with \\n.
function test_TokenURI_Decoded() external skipOnMismatch givenNFTExists {
string memory tokenURI = lockupLinear.tokenURI(defaultStreamId);
- tokenURI = tokenURI.replace({ search: "data:application/json;base64,", replacement: "" });
+ tokenURI = vm.replace({ input: tokenURI, from: "data:application/json;base64,", to: "" });
string memory actualDecodedTokenURI = string(Base64.decode(tokenURI));
string memory expectedDecodedTokenURI =
unicode'{"attributes":[{"trait_type":"Asset","value":"DAI"},{"trait_type":"Sender","value":"0x6332e7b1deb1f1a0b77b2bb18b144330c7291bca"},{"trait_type":"Status","value":"Streaming"}],"description":"This NFT represents a payment stream in a Sablier V2 Lockup Linear contract. The owner of this NFT can withdraw the streamed assets, which are denominated in DAI.\\n\\n- Stream ID: 1\\n- Lockup Linear Address: 0x3381cd18e2fb4db236bf0525938ab6e43db0440f\\n- DAI Address: 0x03a6a84cd762d9707a21605b548aaab891562aab\\n\\n⚠️ WARNING: Transferring the NFT makes the new owner the recipient of the stream. The funds are not automatically withdrawn for the previous recipient.","external_url":"https://sablier.com","name":"Sablier V2 Lockup Linear #1","image":"data:image/svg+xml;base64,<svg xmlns="http://www.w3.org/2000/svg" width="1000" height="1000" viewBox="0 0 1000 1000"><rect width="100%" height="100%" filter="url(#Noise)"/><rect x="70" y="70" width="860" height="860" fill="#fff" fill-opacity=".03" rx="45" ry="45" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><defs><circle id="Glow" r="500" fill="url(#RadialGlow)"/><filter id="Noise"><feFlood x="0" y="0" width="100%" height="100%" flood-color="hsl(230,21%,11%)" flood-opacity="1" result="floodFill"/><feTurbulence baseFrequency=".4" numOctaves="3" result="Noise" type="fractalNoise"/><feBlend in="Noise" in2="floodFill" mode="soft-light"/></filter><path id="Logo" fill="#fff" fill-opacity=".1" d="m133.559,124.034c-.013,2.412-1.059,4.848-2.923,6.402-2.558,1.819-5.168,3.439-7.888,4.996-14.44,8.262-31.047,12.565-47.674,12.569-8.858.036-17.838-1.272-26.328-3.663-9.806-2.766-19.087-7.113-27.562-12.778-13.842-8.025,9.468-28.606,16.153-35.265h0c2.035-1.838,4.252-3.546,6.463-5.224h0c6.429-5.655,16.218-2.835,20.358,4.17,4.143,5.057,8.816,9.649,13.92,13.734h.037c5.736,6.461,15.357-2.253,9.38-8.48,0,0-3.515-3.515-3.515-3.515-11.49-11.478-52.656-52.664-64.837-64.837l.049-.037c-1.725-1.606-2.719-3.847-2.751-6.204h0c-.046-2.375,1.062-4.582,2.726-6.229h0l.185-.148h0c.099-.062,.222-.148,.37-.259h0c2.06-1.362,3.951-2.621,6.044-3.842C57.763-3.473,97.76-2.341,128.637,18.332c16.671,9.946-26.344,54.813-38.651,40.199-6.299-6.096-18.063-17.743-19.668-18.811-6.016-4.047-13.061,4.776-7.752,9.751l68.254,68.371c1.724,1.601,2.714,3.84,2.738,6.192Z"/><path id="FloatingText" fill="none" d="M125 45h750s80 0 80 80v750s0 80 -80 80h-750s-80 0 -80 -80v-750s0 -80 80 -80"/><radialGradient id="RadialGlow"><stop offset="0%" stop-color="hsl(19,22%,63%)" stop-opacity=".6"/><stop offset="100%" stop-color="hsl(230,21%,11%)" stop-opacity="0"/></radialGradient><linearGradient id="SandTop" x1="0%" y1="0%"><stop offset="0%" stop-color="hsl(19,22%,63%)"/><stop offset="100%" stop-color="hsl(230,21%,11%)"/></linearGradient><linearGradient id="SandBottom" x1="100%" y1="100%"><stop offset="10%" stop-color="hsl(230,21%,11%)"/><stop offset="100%" stop-color="hsl(19,22%,63%)"/><animate attributeName="x1" dur="6s" repeatCount="indefinite" values="30%;60%;120%;60%;30%;"/></linearGradient><linearGradient id="HourglassStroke" gradientTransform="rotate(90)" gradientUnits="userSpaceOnUse"><stop offset="50%" stop-color="hsl(19,22%,63%)"/><stop offset="80%" stop-color="hsl(230,21%,11%)"/></linearGradient><g id="Hourglass"><path d="M 50,360 a 300,300 0 1,1 600,0 a 300,300 0 1,1 -600,0" fill="#fff" fill-opacity=".02" stroke="url(#HourglassStroke)" stroke-width="4"/><path d="m566,161.201v-53.924c0-19.382-22.513-37.563-63.398-51.198-40.756-13.592-94.946-21.079-152.587-21.079s-111.838,7.487-152.602,21.079c-40.893,13.636-63.413,31.816-63.413,51.198v53.924c0,17.181,17.704,33.427,50.223,46.394v284.809c-32.519,12.96-50.223,29.206-50.223,46.394v53.924c0,19.382,22.52,37.563,63.413,51.198,40.763,13.592,94.954,21.079,152.602,21.079s111.831-7.487,152.587-21.079c40.886-13.636,63.398-31.816,63.398-51.198v-53.924c0-17.196-17.704-33.435-50.223-46.401V207.603c32.519-12.967,50.223-29.206,50.223-46.401Zm-347.462,57.793l130.959,131.027-130.959,131.013V218.994Zm262.924.022v262.018l-130.937-131.006,130.937-131.013Z" fill="#161822"></path><polygon points="350 350.026 415.03 284.978 285 284.978 350 350.026" fill="url(#SandBottom)"/><path d="m416.341,281.975c0,.914-.354,1.809-1.035,2.68-5.542,7.076-32.661,12.45-65.28,12.45-32.624,0-59.738-5.374-65.28-12.45-.681-.872-1.035-1.767-1.035-2.68,0-.914.354-1.808,1.035-2.676,5.542-7.076,32.656-12.45,65.28-12.45,32.619,0,59.738,5.374,65.28,12.45.681.867,1.035,1.762,1.035,2.676Z" fill="url(#SandTop)"/><path d="m481.46,504.101v58.449c-2.35.77-4.82,1.51-7.39,2.23-30.3,8.54-74.65,13.92-124.06,13.92-53.6,0-101.24-6.33-131.47-16.16v-58.439h262.92Z" fill="url(#SandBottom)"/><ellipse cx="350" cy="504.101" rx="131.462" ry="28.108" fill="url(#SandTop)"/><g fill="none" stroke="url(#HourglassStroke)" stroke-linecap="round" stroke-miterlimit="10" stroke-width="4"><path d="m565.641,107.28c0,9.537-5.56,18.629-15.676,26.973h-.023c-9.204,7.596-22.194,14.562-38.197,20.592-39.504,14.936-97.325,24.355-161.733,24.355-90.48,0-167.948-18.582-199.953-44.948h-.023c-10.115-8.344-15.676-17.437-15.676-26.973,0-39.735,96.554-71.921,215.652-71.921s215.629,32.185,215.629,71.921Z"/><path d="m134.36,161.203c0,39.735,96.554,71.921,215.652,71.921s215.629-32.186,215.629-71.921"/><line x1="134.36" y1="161.203" x2="134.36" y2="107.28"/><line x1="565.64" y1="161.203" x2="565.64" y2="107.28"/><line x1="184.584" y1="206.823" x2="184.585" y2="537.579"/><line x1="218.181" y1="218.118" x2="218.181" y2="562.537"/><line x1="481.818" y1="218.142" x2="481.819" y2="562.428"/><line x1="515.415" y1="207.352" x2="515.416" y2="537.579"/><path d="m184.58,537.58c0,5.45,4.27,10.65,12.03,15.42h.02c5.51,3.39,12.79,6.55,21.55,9.42,30.21,9.9,78.02,16.28,131.83,16.28,49.41,0,93.76-5.38,124.06-13.92,2.7-.76,5.29-1.54,7.75-2.35,8.77-2.87,16.05-6.04,21.56-9.43h0c7.76-4.77,12.04-9.97,12.04-15.42"/><path d="m184.582,492.656c-31.354,12.485-50.223,28.58-50.223,46.142,0,9.536,5.564,18.627,15.677,26.969h.022c8.503,7.005,20.213,13.463,34.524,19.159,9.999,3.991,21.269,7.609,33.597,10.788,36.45,9.407,82.181,15.002,131.835,15.002s95.363-5.595,131.807-15.002c10.847-2.79,20.867-5.926,29.924-9.349,1.244-.467,2.473-.942,3.673-1.424,14.326-5.696,26.035-12.161,34.524-19.173h.022c10.114-8.342,15.677-17.433,15.677-26.969,0-17.562-18.869-33.665-50.223-46.15"/><path d="m134.36,592.72c0,39.735,96.554,71.921,215.652,71.921s215.629-32.186,215.629-71.921"/><line x1="134.36" y1="592.72" x2="134.36" y2="538.797"/><line x1="565.64" y1="592.72" x2="565.64" y2="538.797"/><polyline points="481.822 481.901 481.798 481.877 481.775 481.854 350.015 350.026 218.185 218.129"/><polyline points="218.185 481.901 218.231 481.854 350.015 350.026 481.822 218.152"/></g></g><g id="Progress" fill="#fff"><rect width="208" height="100" fill-opacity=".03" rx="15" ry="15" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><text x="20" y="34" font-family="'Courier New',Arial,monospace" font-size="22px">Progress</text><text x="20" y="72" font-family="'Courier New',Arial,monospace" font-size="26px">25%</text><g fill="none"><circle cx="166" cy="50" r="22" stroke="hsl(230,21%,11%)" stroke-width="10"/><circle cx="166" cy="50" pathLength="10000" r="22" stroke="hsl(19,22%,63%)" stroke-dasharray="10000" stroke-dashoffset="7500" stroke-linecap="round" stroke-width="5" transform="rotate(-90)" transform-origin="166 50"/></g></g><g id="Status" fill="#fff"><rect width="184" height="100" fill-opacity=".03" rx="15" ry="15" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><text x="20" y="34" font-family="'Courier New',Arial,monospace" font-size="22px">Status</text><text x="20" y="72" font-family="'Courier New',Arial,monospace" font-size="26px">Streaming</text></g><g id="Amount" fill="#fff"><rect width="120" height="100" fill-opacity=".03" rx="15" ry="15" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><text x="20" y="34" font-family="'Courier New',Arial,monospace" font-size="22px">Amount</text><text x="20" y="72" font-family="'Courier New',Arial,monospace" font-size="26px">&#8805; 10K</text></g><g id="Duration" fill="#fff"><rect width="152" height="100" fill-opacity=".03" rx="15" ry="15" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><text x="20" y="34" font-family="'Courier New',Arial,monospace" font-size="22px">Duration</text><text x="20" y="72" font-family="'Courier New',Arial,monospace" font-size="26px">&lt; 1 Day</text></g></defs><text text-rendering="optimizeSpeed"><textPath startOffset="-100%" href="#FloatingText" fill="#fff" font-family="'Courier New',Arial,monospace" fill-opacity=".8" font-size="26px"><animate additive="sum" attributeName="startOffset" begin="0s" dur="50s" from="0%" repeatCount="indefinite" to="100%"/>0x3381cd18e2fb4db236bf0525938ab6e43db0440f • Sablier V2 Lockup Linear</textPath><textPath startOffset="0%" href="#FloatingText" fill="#fff" font-family="'Courier New',Arial,monospace" fill-opacity=".8" font-size="26px"><animate additive="sum" attributeName="startOffset" begin="0s" dur="50s" from="0%" repeatCount="indefinite" to="100%"/>0x3381cd18e2fb4db236bf0525938ab6e43db0440f • Sablier V2 Lockup Linear</textPath><textPath startOffset="-50%" href="#FloatingText" fill="#fff" font-family="'Courier New',Arial,monospace" fill-opacity=".8" font-size="26px"><animate additive="sum" attributeName="startOffset" begin="0s" dur="50s" from="0%" repeatCount="indefinite" to="100%"/>0x03a6a84cd762d9707a21605b548aaab891562aab • DAI</textPath><textPath startOffset="50%" href="#FloatingText" fill="#fff" font-family="'Courier New',Arial,monospace" fill-opacity=".8" font-size="26px"><animate additive="sum" attributeName="startOffset" begin="0s" dur="50s" from="0%" repeatCount="indefinite" to="100%"/>0x03a6a84cd762d9707a21605b548aaab891562aab • DAI</textPath></text><use href="#Glow" fill-opacity=".9"/><use href="#Glow" x="1000" y="1000" fill-opacity=".9"/><use href="#Logo" x="170" y="170" transform="scale(.6)"/><use href="#Hourglass" x="150" y="90" transform="rotate(10)" transform-origin="500 500"/><use href="#Progress" x="144" y="790"/><use href="#Status" x="368" y="790"/><use href="#Amount" x="568" y="790"/><use href="#Duration" x="704" y="790"/></svg>"}';
diff --git a/test/integration/concrete/lockup-linear/withdrawable-amount-of/withdrawableAmountOf.t.sol b/test/integration/concrete/lockup-linear/withdrawable-amount-of/withdrawableAmountOf.t.sol
index d193126c9..c5a6d9d44 100644
--- a/test/integration/concrete/lockup-linear/withdrawable-amount-of/withdrawableAmountOf.t.sol
+++ b/test/integration/concrete/lockup-linear/withdrawable-amount-of/withdrawableAmountOf.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { LockupLinear_Integration_Concrete_Test } from "../LockupLinear.t.sol";
import { WithdrawableAmountOf_Integration_Concrete_Test } from
@@ -30,7 +30,7 @@ contract WithdrawableAmountOf_LockupLinear_Integration_Concrete_Test is
}
modifier givenCliffTimeNotInTheFuture() {
- vm.warp({ timestamp: defaults.WARP_26_PERCENT() });
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
_;
}
diff --git a/test/integration/concrete/lockup-tranched/LockupTranched.t.sol b/test/integration/concrete/lockup-tranched/LockupTranched.t.sol
new file mode 100644
index 000000000..b19b02ffc
--- /dev/null
+++ b/test/integration/concrete/lockup-tranched/LockupTranched.t.sol
@@ -0,0 +1,482 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22 <0.9.0;
+
+import { ISablierV2Lockup } from "src/interfaces/ISablierV2Lockup.sol";
+
+import { LockupTranched_Integration_Shared_Test } from "../../shared/lockup-tranched/LockupTranched.t.sol";
+import { Integration_Test } from "../../Integration.t.sol";
+import { AllowToHook_Integration_Concrete_Test } from "../lockup/allow-to-hook/allowToHook.t.sol";
+import { Burn_Integration_Concrete_Test } from "../lockup/burn/burn.t.sol";
+import { Cancel_Integration_Concrete_Test } from "../lockup/cancel/cancel.t.sol";
+import { CancelMultiple_Integration_Concrete_Test } from "../lockup/cancel-multiple/cancelMultiple.t.sol";
+import { GetAsset_Integration_Concrete_Test } from "../lockup/get-asset/getAsset.t.sol";
+import { GetDepositedAmount_Integration_Concrete_Test } from "../lockup/get-deposited-amount/getDepositedAmount.t.sol";
+import { GetEndTime_Integration_Concrete_Test } from "../lockup/get-end-time/getEndTime.t.sol";
+import { GetRecipient_Integration_Concrete_Test } from "../lockup/get-recipient/getRecipient.t.sol";
+import { GetRefundedAmount_Integration_Concrete_Test } from "../lockup/get-refunded-amount/getRefundedAmount.t.sol";
+import { GetSender_Integration_Concrete_Test } from "../lockup/get-sender/getSender.t.sol";
+import { GetStartTime_Integration_Concrete_Test } from "../lockup/get-start-time/getStartTime.t.sol";
+import { GetWithdrawnAmount_Integration_Concrete_Test } from "../lockup/get-withdrawn-amount/getWithdrawnAmount.t.sol";
+import { IsAllowedToHook_Integration_Concrete_Test } from "../lockup/is-allowed-to-hook/isAllowedToHook.t.sol";
+import { IsCancelable_Integration_Concrete_Test } from "../lockup/is-cancelable/isCancelable.t.sol";
+import { IsCold_Integration_Concrete_Test } from "../lockup/is-cold/isCold.t.sol";
+import { IsDepleted_Integration_Concrete_Test } from "../lockup/is-depleted/isDepleted.t.sol";
+import { IsStream_Integration_Concrete_Test } from "../lockup/is-stream/isStream.t.sol";
+import { IsTransferable_Integration_Concrete_Test } from "../lockup/is-transferable/isTransferable.t.sol";
+import { IsWarm_Integration_Concrete_Test } from "../lockup/is-warm/isWarm.t.sol";
+import { RefundableAmountOf_Integration_Concrete_Test } from "../lockup/refundable-amount-of/refundableAmountOf.t.sol";
+import { Renounce_Integration_Concrete_Test } from "../lockup/renounce/renounce.t.sol";
+import { SetNFTDescriptor_Integration_Concrete_Test } from "../lockup/set-nft-descriptor/setNFTDescriptor.t.sol";
+import { StatusOf_Integration_Concrete_Test } from "../lockup/status-of/statusOf.t.sol";
+import { TransferFrom_Integration_Concrete_Test } from "../lockup/transfer-from/transferFrom.t.sol";
+import { WasCanceled_Integration_Concrete_Test } from "../lockup/was-canceled/wasCanceled.t.sol";
+import { Withdraw_Integration_Concrete_Test } from "../lockup/withdraw/withdraw.t.sol";
+import { WithdrawHooks_Integration_Concrete_Test } from "../lockup/withdraw-hooks/withdrawHooks.t.sol";
+import { WithdrawMax_Integration_Concrete_Test } from "../lockup/withdraw-max/withdrawMax.t.sol";
+import { WithdrawMaxAndTransfer_Integration_Concrete_Test } from
+ "../lockup/withdraw-max-and-transfer/withdrawMaxAndTransfer.t.sol";
+import { WithdrawMultiple_Integration_Concrete_Test } from "../lockup/withdraw-multiple/withdrawMultiple.t.sol";
+
+/*//////////////////////////////////////////////////////////////////////////
+ NON-SHARED ABSTRACT TEST
+//////////////////////////////////////////////////////////////////////////*/
+
+/// @notice Common testing logic needed across {SablierV2LockupTranched} integration concrete tests.
+abstract contract LockupTranched_Integration_Concrete_Test is
+ Integration_Test,
+ LockupTranched_Integration_Shared_Test
+{
+ function setUp() public virtual override(Integration_Test, LockupTranched_Integration_Shared_Test) {
+ // Both of these contracts inherit from {Base_Test}, which is fine because multiple inheritance is
+ // allowed in Solidity, and {Base_Test-setUp} will only be called once.
+ Integration_Test.setUp();
+ LockupTranched_Integration_Shared_Test.setUp();
+
+ // Cast the {LockupTranched} contract as {ISablierV2Lockup}.
+ lockup = ISablierV2Lockup(lockupTranched);
+ }
+}
+
+/*//////////////////////////////////////////////////////////////////////////
+ SHARED TESTS
+//////////////////////////////////////////////////////////////////////////*/
+
+contract AllowToHook_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ AllowToHook_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, AllowToHook_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ AllowToHook_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract Burn_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ Burn_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, Burn_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ Burn_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract Cancel_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ Cancel_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, Cancel_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ Cancel_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract CancelMultiple_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ CancelMultiple_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, CancelMultiple_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ CancelMultiple_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract GetAsset_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ GetAsset_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, GetAsset_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ GetAsset_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract GetDepositedAmount_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ GetDepositedAmount_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, GetDepositedAmount_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ GetDepositedAmount_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract GetEndTime_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ GetEndTime_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, GetEndTime_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ GetEndTime_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract GetRecipient_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ GetRecipient_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, GetRecipient_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ GetRecipient_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract GetRefundedAmount_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ GetRefundedAmount_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, GetRefundedAmount_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ GetRefundedAmount_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract GetSender_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ GetSender_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, GetSender_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ GetSender_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract GetStartTime_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ GetStartTime_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, GetStartTime_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ GetStartTime_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract GetWithdrawnAmount_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ GetWithdrawnAmount_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, GetWithdrawnAmount_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ GetWithdrawnAmount_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract IsAllowedToHook_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ IsAllowedToHook_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, IsAllowedToHook_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ IsAllowedToHook_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract IsCancelable_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ IsCancelable_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, IsCancelable_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ IsCancelable_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract IsCold_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ IsCold_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, IsCold_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ IsCold_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract IsDepleted_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ IsDepleted_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, IsDepleted_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ IsDepleted_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract IsStream_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ IsStream_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, IsStream_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ IsStream_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract IsTransferable_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ IsTransferable_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, IsTransferable_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ IsTransferable_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract IsWarm_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ IsWarm_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, IsWarm_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ IsWarm_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract RefundableAmountOf_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ RefundableAmountOf_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, RefundableAmountOf_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ RefundableAmountOf_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract Renounce_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ Renounce_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, Renounce_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ Renounce_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract SetNFTDescriptor_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ SetNFTDescriptor_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, SetNFTDescriptor_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ SetNFTDescriptor_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract StatusOf_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ StatusOf_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, StatusOf_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ StatusOf_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract TransferFrom_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ TransferFrom_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, TransferFrom_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ TransferFrom_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract WasCanceled_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ WasCanceled_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, WasCanceled_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ WasCanceled_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract Withdraw_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ Withdraw_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, Withdraw_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ Withdraw_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract WithdrawHooks_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ WithdrawHooks_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, WithdrawHooks_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ WithdrawHooks_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract WithdrawMax_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ WithdrawMax_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, WithdrawMax_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ WithdrawMax_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract WithdrawMaxAndTransfer_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ WithdrawMaxAndTransfer_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, WithdrawMaxAndTransfer_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ WithdrawMaxAndTransfer_Integration_Concrete_Test.setUp();
+ }
+}
+
+contract WithdrawMultiple_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ WithdrawMultiple_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, WithdrawMultiple_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ WithdrawMultiple_Integration_Concrete_Test.setUp();
+ }
+}
diff --git a/test/integration/concrete/lockup-tranched/constructor.t.sol b/test/integration/concrete/lockup-tranched/constructor.t.sol
new file mode 100644
index 000000000..5bf824fb5
--- /dev/null
+++ b/test/integration/concrete/lockup-tranched/constructor.t.sol
@@ -0,0 +1,48 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22 <0.9.0;
+
+import { UD60x18 } from "@prb/math/src/UD60x18.sol";
+import { SablierV2LockupTranched } from "src/SablierV2LockupTranched.sol";
+
+import { LockupTranched_Integration_Concrete_Test } from "./LockupTranched.t.sol";
+
+contract Constructor_LockupTranched_Integration_Concrete_Test is LockupTranched_Integration_Concrete_Test {
+ function test_Constructor() external {
+ // Expect the relevant event to be emitted.
+ vm.expectEmit();
+ emit TransferAdmin({ oldAdmin: address(0), newAdmin: users.admin });
+
+ // Construct the contract.
+ SablierV2LockupTranched constructedLockupTranched = new SablierV2LockupTranched({
+ initialAdmin: users.admin,
+ initialNFTDescriptor: nftDescriptor,
+ maxTrancheCount: defaults.MAX_TRANCHE_COUNT()
+ });
+
+ // {SablierV2Lockup.constant}
+ UD60x18 actualMaxBrokerFee = constructedLockupTranched.MAX_BROKER_FEE();
+ UD60x18 expectedMaxBrokerFee = UD60x18.wrap(0.1e18);
+ assertEq(actualMaxBrokerFee, expectedMaxBrokerFee, "MAX_BROKER_FEE");
+
+ // {SablierV2Lockup.constructor}
+ address actualAdmin = constructedLockupTranched.admin();
+ address expectedAdmin = users.admin;
+ assertEq(actualAdmin, expectedAdmin, "admin");
+
+ uint256 actualStreamId = constructedLockupTranched.nextStreamId();
+ uint256 expectedStreamId = 1;
+ assertEq(actualStreamId, expectedStreamId, "nextStreamId");
+
+ address actualNFTDescriptor = address(constructedLockupTranched.nftDescriptor());
+ address expectedNFTDescriptor = address(nftDescriptor);
+ assertEq(actualNFTDescriptor, expectedNFTDescriptor, "nftDescriptor");
+
+ // {SablierV2Lockup.supportsInterface}
+ assertTrue(constructedLockupTranched.supportsInterface(0x49064906), "ERC-4906 interface ID");
+
+ // {SablierV2LockupTranched.constructor}
+ uint256 actualMaxTrancheCount = constructedLockupTranched.MAX_TRANCHE_COUNT();
+ uint256 expectedMaxTrancheCount = defaults.MAX_TRANCHE_COUNT();
+ assertEq(actualMaxTrancheCount, expectedMaxTrancheCount, "MAX_TRANCHE_COUNT");
+ }
+}
diff --git a/test/integration/concrete/lockup-tranched/create-with-durations/createWithDurations.t.sol b/test/integration/concrete/lockup-tranched/create-with-durations/createWithDurations.t.sol
new file mode 100644
index 000000000..9db841bb2
--- /dev/null
+++ b/test/integration/concrete/lockup-tranched/create-with-durations/createWithDurations.t.sol
@@ -0,0 +1,179 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22 <0.9.0;
+
+import { ISablierV2LockupTranched } from "src/interfaces/ISablierV2LockupTranched.sol";
+import { Errors } from "src/libraries/Errors.sol";
+import { Lockup, LockupTranched } from "src/types/DataTypes.sol";
+
+import { CreateWithDurations_Integration_Shared_Test } from "../../../shared/lockup/createWithDurations.t.sol";
+import { LockupTranched_Integration_Concrete_Test } from "../LockupTranched.t.sol";
+
+contract CreateWithDurations_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ CreateWithDurations_Integration_Shared_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, CreateWithDurations_Integration_Shared_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ CreateWithDurations_Integration_Shared_Test.setUp();
+ streamId = lockupTranched.nextStreamId();
+ }
+
+ /// @dev it should revert.
+ function test_RevertWhen_DelegateCalled() external {
+ bytes memory callData =
+ abi.encodeCall(ISablierV2LockupTranched.createWithDurations, defaults.createWithDurationsLT());
+ (bool success, bytes memory returnData) = address(lockupTranched).delegatecall(callData);
+ expectRevertDueToDelegateCall(success, returnData);
+ }
+
+ /// @dev it should revert.
+ function test_RevertWhen_TrancheCountTooHigh() external whenNotDelegateCalled {
+ LockupTranched.TrancheWithDuration[] memory tranches = new LockupTranched.TrancheWithDuration[](25_000);
+ vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2LockupTranched_TrancheCountTooHigh.selector, 25_000));
+ createDefaultStreamWithDurations(tranches);
+ }
+
+ function test_RevertWhen_DurationsZero() external whenNotDelegateCalled whenTrancheCountNotTooHigh {
+ uint40 startTime = getBlockTimestamp();
+ LockupTranched.TrancheWithDuration[] memory tranches = defaults.createWithDurationsLT().tranches;
+ tranches[2].duration = 0;
+ uint256 index = 2;
+ vm.expectRevert(
+ abi.encodeWithSelector(
+ Errors.SablierV2LockupTranched_TrancheTimestampsNotOrdered.selector,
+ index,
+ startTime + tranches[0].duration + tranches[1].duration,
+ startTime + tranches[0].duration + tranches[1].duration
+ )
+ );
+ createDefaultStreamWithDurations(tranches);
+ }
+
+ function test_RevertWhen_TimestampsCalculationsOverflows_StartTimeNotLessThanFirstTrancheTimestamp()
+ external
+ whenNotDelegateCalled
+ whenTrancheCountNotTooHigh
+ whenDurationsNotZero
+ {
+ unchecked {
+ uint40 startTime = getBlockTimestamp();
+ LockupTranched.TrancheWithDuration[] memory tranches = defaults.tranchesWithDurations();
+ tranches[0].duration = MAX_UINT40;
+ vm.expectRevert(
+ abi.encodeWithSelector(
+ Errors.SablierV2LockupTranched_StartTimeNotLessThanFirstTrancheTimestamp.selector,
+ startTime,
+ startTime + tranches[0].duration
+ )
+ );
+ createDefaultStreamWithDurations(tranches);
+ }
+ }
+
+ function test_RevertWhen_TimestampsCalculationsOverflows_TrancheTimestampsNotOrdered()
+ external
+ whenNotDelegateCalled
+ whenTrancheCountNotTooHigh
+ whenDurationsNotZero
+ {
+ unchecked {
+ uint40 startTime = getBlockTimestamp();
+
+ // Create new tranches that overflow when the timestamps are eventually calculated.
+ LockupTranched.TrancheWithDuration[] memory tranches = new LockupTranched.TrancheWithDuration[](2);
+ tranches[0] = LockupTranched.TrancheWithDuration({ amount: 0, duration: startTime + 1 seconds });
+ tranches[1] = defaults.tranchesWithDurations()[0];
+ tranches[1].duration = MAX_UINT40;
+
+ // Expect the relevant error to be thrown.
+ uint256 index = 1;
+ vm.expectRevert(
+ abi.encodeWithSelector(
+ Errors.SablierV2LockupTranched_TrancheTimestampsNotOrdered.selector,
+ index,
+ startTime + tranches[0].duration,
+ startTime + tranches[0].duration + tranches[1].duration
+ )
+ );
+
+ // Create the stream.
+ createDefaultStreamWithDurations(tranches);
+ }
+ }
+
+ function test_CreateWithDurations()
+ external
+ whenNotDelegateCalled
+ whenTrancheCountNotTooHigh
+ whenDurationsNotZero
+ whenTimestampsCalculationsDoNotOverflow
+ {
+ // Make the Sender the stream's funder
+ address funder = users.sender;
+
+ // Declare the timestamps.
+ uint40 blockTimestamp = getBlockTimestamp();
+ LockupTranched.Timestamps memory timestamps =
+ LockupTranched.Timestamps({ start: blockTimestamp, end: blockTimestamp + defaults.TOTAL_DURATION() });
+
+ LockupTranched.TrancheWithDuration[] memory tranchesWithDurations = defaults.tranchesWithDurations();
+ LockupTranched.Tranche[] memory tranches = defaults.tranches();
+ tranches[0].timestamp = timestamps.start + tranchesWithDurations[0].duration;
+ tranches[1].timestamp = tranches[0].timestamp + tranchesWithDurations[1].duration;
+ tranches[2].timestamp = tranches[1].timestamp + tranchesWithDurations[2].duration;
+
+ // Expect the assets to be transferred from the funder to {SablierV2LockupTranched}.
+ expectCallToTransferFrom({ from: funder, to: address(lockupTranched), value: defaults.DEPOSIT_AMOUNT() });
+
+ // Expect the broker fee to be paid to the broker.
+ expectCallToTransferFrom({ from: funder, to: users.broker, value: defaults.BROKER_FEE_AMOUNT() });
+
+ // Expect the relevant events to be emitted.
+ vm.expectEmit({ emitter: address(lockupTranched) });
+ emit MetadataUpdate({ _tokenId: streamId });
+ vm.expectEmit({ emitter: address(lockupTranched) });
+ emit CreateLockupTranchedStream({
+ streamId: streamId,
+ funder: funder,
+ sender: users.sender,
+ recipient: users.recipient,
+ amounts: defaults.lockupCreateAmounts(),
+ asset: dai,
+ cancelable: true,
+ transferable: true,
+ tranches: tranches,
+ timestamps: timestamps,
+ broker: users.broker
+ });
+
+ // Create the stream.
+ createDefaultStreamWithDurations();
+
+ // Assert that the stream has been created.
+ LockupTranched.StreamLT memory actualStream = lockupTranched.getStream(streamId);
+ LockupTranched.StreamLT memory expectedStream = defaults.lockupTranchedStream();
+ expectedStream.endTime = timestamps.end;
+ expectedStream.startTime = timestamps.start;
+ expectedStream.tranches = tranches;
+ assertEq(actualStream, expectedStream);
+
+ // Assert that the stream's status is "STREAMING".
+ Lockup.Status actualStatus = lockupTranched.statusOf(streamId);
+ Lockup.Status expectedStatus = Lockup.Status.STREAMING;
+ assertEq(actualStatus, expectedStatus);
+
+ // Assert that the next stream ID has been bumped.
+ uint256 actualNextStreamId = lockupTranched.nextStreamId();
+ uint256 expectedNextStreamId = streamId + 1;
+ assertEq(actualNextStreamId, expectedNextStreamId, "nextStreamId");
+
+ // Assert that the NFT has been minted.
+ address actualNFTOwner = lockupTranched.ownerOf({ tokenId: streamId });
+ address expectedNFTOwner = users.recipient;
+ assertEq(actualNFTOwner, expectedNFTOwner, "NFT owner");
+ }
+}
diff --git a/test/integration/concrete/lockup-tranched/create-with-durations/createWithDurations.tree b/test/integration/concrete/lockup-tranched/create-with-durations/createWithDurations.tree
new file mode 100644
index 000000000..d3f633068
--- /dev/null
+++ b/test/integration/concrete/lockup-tranched/create-with-durations/createWithDurations.tree
@@ -0,0 +1,22 @@
+createWithDurations.t.sol
+├── when delegate called
+│ └── it should revert
+└── when not delegate called
+ ├── when the tranche count is too high
+ │ └── it should revert
+ └── when the tranche count is not too high
+ ├── when at least one of the durations at index one or greater is zero
+ │ └── it should revert
+ └── when none of the durations is zero
+ ├── when the tranche timestamp calculations overflow uint256
+ │ ├── when the start time is not less than the first tranche timestamp
+ │ │ └── it should revert
+ │ └── when the tranche timestamps are not ordered
+ │ └── it should revert
+ └── when the tranche timestamp calculations do not overflow uint256
+ ├── it should create the stream
+ ├── it should bump the next stream ID
+ ├── it should mint the NFT
+ ├── it should emit a {MetadataUpdate} event
+ ├── it should perform the ERC-20 transfers
+ └── it should emit a {CreateLockupTranchedStream} event
diff --git a/test/integration/concrete/lockup-tranched/create-with-timestamps/createWithTimestamps.t.sol b/test/integration/concrete/lockup-tranched/create-with-timestamps/createWithTimestamps.t.sol
new file mode 100644
index 000000000..cb1ce9a56
--- /dev/null
+++ b/test/integration/concrete/lockup-tranched/create-with-timestamps/createWithTimestamps.t.sol
@@ -0,0 +1,392 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22 <0.9.0;
+
+import { Address } from "@openzeppelin/contracts/utils/Address.sol";
+import { IERC721Errors } from "@openzeppelin/contracts/interfaces/draft-IERC6093.sol";
+import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import { UD60x18, ud, ZERO } from "@prb/math/src/UD60x18.sol";
+import { stdError } from "forge-std/src/StdError.sol";
+
+import { ISablierV2LockupTranched } from "src/interfaces/ISablierV2LockupTranched.sol";
+import { Errors } from "src/libraries/Errors.sol";
+import { Broker, Lockup, LockupTranched } from "src/types/DataTypes.sol";
+
+import { CreateWithTimestamps_Integration_Shared_Test } from "../../../shared/lockup/createWithTimestamps.t.sol";
+import { LockupTranched_Integration_Concrete_Test } from "../LockupTranched.t.sol";
+
+contract CreateWithTimestamps_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ CreateWithTimestamps_Integration_Shared_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, CreateWithTimestamps_Integration_Shared_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ CreateWithTimestamps_Integration_Shared_Test.setUp();
+ }
+
+ function test_RevertWhen_DelegateCalled() external {
+ bytes memory callData =
+ abi.encodeCall(ISablierV2LockupTranched.createWithTimestamps, defaults.createWithTimestampsLT());
+ (bool success, bytes memory returnData) = address(lockupTranched).delegatecall(callData);
+ expectRevertDueToDelegateCall(success, returnData);
+ }
+
+ function test_RevertWhen_RecipientZeroAddress() external whenNotDelegateCalled {
+ address recipient = address(0);
+ vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721InvalidReceiver.selector, recipient));
+ createDefaultStreamWithRecipient(recipient);
+ }
+
+ function test_RevertWhen_DepositAmountZero() external whenNotDelegateCalled whenRecipientNonZeroAddress {
+ // It is not possible to obtain a zero deposit amount from a non-zero total amount, because the `MAX_BROKER_FEE`
+ // is hard coded to 10%.
+ vm.expectRevert(Errors.SablierV2Lockup_DepositAmountZero.selector);
+ uint128 totalAmount = 0;
+ createDefaultStreamWithTotalAmount(totalAmount);
+ }
+
+ function test_RevertWhen_StartTimeZero()
+ external
+ whenNotDelegateCalled
+ whenRecipientNonZeroAddress
+ whenDepositAmountNotZero
+ {
+ vm.expectRevert(Errors.SablierV2Lockup_StartTimeZero.selector);
+ createDefaultStreamWithStartTime(0);
+ }
+
+ function test_RevertWhen_TrancheCountZero()
+ external
+ whenNotDelegateCalled
+ whenRecipientNonZeroAddress
+ whenDepositAmountNotZero
+ whenStartTimeNotZero
+ {
+ LockupTranched.Tranche[] memory tranches;
+ vm.expectRevert(Errors.SablierV2LockupTranched_TrancheCountZero.selector);
+ createDefaultStreamWithTranches(tranches);
+ }
+
+ function test_RevertWhen_TrancheCountTooHigh()
+ external
+ whenNotDelegateCalled
+ whenRecipientNonZeroAddress
+ whenDepositAmountNotZero
+ whenStartTimeNotZero
+ whenTrancheCountNotZero
+ {
+ uint256 trancheCount = defaults.MAX_TRANCHE_COUNT() + 1;
+ LockupTranched.Tranche[] memory tranches = new LockupTranched.Tranche[](trancheCount);
+ vm.expectRevert(
+ abi.encodeWithSelector(Errors.SablierV2LockupTranched_TrancheCountTooHigh.selector, trancheCount)
+ );
+ createDefaultStreamWithTranches(tranches);
+ }
+
+ function test_RevertWhen_TrancheAmountsSumOverflows()
+ external
+ whenNotDelegateCalled
+ whenRecipientNonZeroAddress
+ whenDepositAmountNotZero
+ whenStartTimeNotZero
+ whenTrancheCountNotZero
+ whenTrancheCountNotTooHigh
+ {
+ LockupTranched.Tranche[] memory tranches = defaults.tranches();
+ tranches[0].amount = MAX_UINT128;
+ tranches[1].amount = 1;
+ vm.expectRevert(stdError.arithmeticError);
+ createDefaultStreamWithTranches(tranches);
+ }
+
+ function test_RevertWhen_StartTimeGreaterThanFirstTrancheTimestamp()
+ external
+ whenNotDelegateCalled
+ whenRecipientNonZeroAddress
+ whenDepositAmountNotZero
+ whenStartTimeNotZero
+ whenTrancheCountNotZero
+ whenTrancheCountNotTooHigh
+ whenTrancheAmountsSumDoesNotOverflow
+ {
+ // Change the timestamp of the first tranche.
+ LockupTranched.Tranche[] memory tranches = defaults.tranches();
+ tranches[0].timestamp = defaults.START_TIME() - 1 seconds;
+
+ // Expect the relevant error to be thrown.
+ vm.expectRevert(
+ abi.encodeWithSelector(
+ Errors.SablierV2LockupTranched_StartTimeNotLessThanFirstTrancheTimestamp.selector,
+ defaults.START_TIME(),
+ tranches[0].timestamp
+ )
+ );
+
+ // Create the stream.
+ createDefaultStreamWithTranches(tranches);
+ }
+
+ function test_RevertWhen_StartTimeEqualToFirstTrancheTimestamp()
+ external
+ whenNotDelegateCalled
+ whenRecipientNonZeroAddress
+ whenDepositAmountNotZero
+ whenStartTimeNotZero
+ whenTrancheCountNotZero
+ whenTrancheCountNotTooHigh
+ whenTrancheAmountsSumDoesNotOverflow
+ {
+ // Change the timestamp of the first tranche.
+ LockupTranched.Tranche[] memory tranches = defaults.tranches();
+ tranches[0].timestamp = defaults.START_TIME();
+
+ // Expect the relevant error to be thrown.
+ vm.expectRevert(
+ abi.encodeWithSelector(
+ Errors.SablierV2LockupTranched_StartTimeNotLessThanFirstTrancheTimestamp.selector,
+ defaults.START_TIME(),
+ tranches[0].timestamp
+ )
+ );
+
+ // Create the stream.
+ createDefaultStreamWithTranches(tranches);
+ }
+
+ function test_RevertWhen_TrancheTimestampsNotOrdered()
+ external
+ whenNotDelegateCalled
+ whenRecipientNonZeroAddress
+ whenDepositAmountNotZero
+ whenStartTimeNotZero
+ whenTrancheCountNotZero
+ whenTrancheCountNotTooHigh
+ whenTrancheAmountsSumDoesNotOverflow
+ whenStartTimeLessThanFirstTrancheTimestamp
+ {
+ // Swap the tranche timestamps.
+ LockupTranched.Tranche[] memory tranches = defaults.tranches();
+ (tranches[0].timestamp, tranches[1].timestamp) = (tranches[1].timestamp, tranches[0].timestamp);
+
+ // Expect the relevant error to be thrown.
+ uint256 index = 1;
+ vm.expectRevert(
+ abi.encodeWithSelector(
+ Errors.SablierV2LockupTranched_TrancheTimestampsNotOrdered.selector,
+ index,
+ tranches[0].timestamp,
+ tranches[1].timestamp
+ )
+ );
+
+ // Create the stream.
+ createDefaultStreamWithTranches(tranches);
+ }
+
+ function test_RevertGiven_EndTimeNotInTheFuture()
+ external
+ whenNotDelegateCalled
+ whenRecipientNonZeroAddress
+ whenDepositAmountNotZero
+ whenStartTimeNotZero
+ whenTrancheCountNotZero
+ whenTrancheCountNotTooHigh
+ whenTrancheAmountsSumDoesNotOverflow
+ whenStartTimeLessThanFirstTrancheTimestamp
+ whenTrancheTimestampsOrdered
+ {
+ uint40 endTime = defaults.END_TIME();
+ vm.warp({ newTimestamp: endTime });
+ vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_EndTimeNotInTheFuture.selector, endTime, endTime));
+ createDefaultStream();
+ }
+
+ function test_RevertWhen_DepositAmountNotEqualToTrancheAmountsSum()
+ external
+ whenNotDelegateCalled
+ whenRecipientNonZeroAddress
+ whenDepositAmountNotZero
+ whenStartTimeNotZero
+ whenTrancheCountNotZero
+ whenTrancheCountNotTooHigh
+ whenTrancheAmountsSumDoesNotOverflow
+ whenStartTimeLessThanFirstTrancheTimestamp
+ whenTrancheTimestampsOrdered
+ whenEndTimeInTheFuture
+ {
+ UD60x18 brokerFee = ZERO;
+ resetPrank({ msgSender: users.sender });
+
+ // Adjust the default deposit amount.
+ uint128 defaultDepositAmount = defaults.DEPOSIT_AMOUNT();
+ uint128 depositAmount = defaultDepositAmount + 100;
+
+ // Prepare the params.
+ LockupTranched.CreateWithTimestamps memory params = defaults.createWithTimestampsLT();
+ params.broker = Broker({ account: address(0), fee: brokerFee });
+ params.totalAmount = depositAmount;
+
+ // Expect the relevant error to be thrown.
+ vm.expectRevert(
+ abi.encodeWithSelector(
+ Errors.SablierV2LockupTranched_DepositAmountNotEqualToTrancheAmountsSum.selector,
+ depositAmount,
+ defaultDepositAmount
+ )
+ );
+
+ // Create the stream.
+ lockupTranched.createWithTimestamps(params);
+ }
+
+ function test_RevertWhen_BrokerFeeTooHigh()
+ external
+ whenNotDelegateCalled
+ whenRecipientNonZeroAddress
+ whenDepositAmountNotZero
+ whenStartTimeNotZero
+ whenTrancheCountNotZero
+ whenTrancheCountNotTooHigh
+ whenTrancheAmountsSumDoesNotOverflow
+ whenStartTimeLessThanFirstTrancheTimestamp
+ whenTrancheTimestampsOrdered
+ whenEndTimeInTheFuture
+ whenDepositAmountEqualToTrancheAmountsSum
+ {
+ UD60x18 brokerFee = MAX_BROKER_FEE + ud(1);
+ vm.expectRevert(
+ abi.encodeWithSelector(Errors.SablierV2Lockup_BrokerFeeTooHigh.selector, brokerFee, MAX_BROKER_FEE)
+ );
+ createDefaultStreamWithBroker(Broker({ account: users.broker, fee: brokerFee }));
+ }
+
+ function test_RevertWhen_AssetNotContract()
+ external
+ whenNotDelegateCalled
+ whenRecipientNonZeroAddress
+ whenDepositAmountNotZero
+ whenStartTimeNotZero
+ whenTrancheCountNotZero
+ whenTrancheCountNotTooHigh
+ whenTrancheAmountsSumDoesNotOverflow
+ whenStartTimeLessThanFirstTrancheTimestamp
+ whenTrancheTimestampsOrdered
+ whenEndTimeInTheFuture
+ whenDepositAmountEqualToTrancheAmountsSum
+ whenBrokerFeeNotTooHigh
+ {
+ address nonContract = address(8128);
+
+ resetPrank({ msgSender: users.sender });
+
+ // Run the test.
+ vm.expectRevert(abi.encodeWithSelector(Address.AddressEmptyCode.selector, nonContract));
+ createDefaultStreamWithAsset(IERC20(nonContract));
+ }
+
+ function test_CreateWithTimestamps_AssetMissingReturnValue()
+ external
+ whenNotDelegateCalled
+ whenRecipientNonZeroAddress
+ whenDepositAmountNotZero
+ whenStartTimeNotZero
+ whenTrancheCountNotZero
+ whenTrancheCountNotTooHigh
+ whenTrancheAmountsSumDoesNotOverflow
+ whenStartTimeLessThanFirstTrancheTimestamp
+ whenTrancheTimestampsOrdered
+ whenEndTimeInTheFuture
+ whenDepositAmountEqualToTrancheAmountsSum
+ whenBrokerFeeNotTooHigh
+ whenAssetContract
+ {
+ testCreateWithTimestamps(address(usdt));
+ }
+
+ function test_CreateWithTimestamps()
+ external
+ whenNotDelegateCalled
+ whenRecipientNonZeroAddress
+ whenDepositAmountNotZero
+ whenStartTimeNotZero
+ whenTrancheCountNotZero
+ whenTrancheCountNotTooHigh
+ whenTrancheAmountsSumDoesNotOverflow
+ whenStartTimeLessThanFirstTrancheTimestamp
+ whenTrancheTimestampsOrdered
+ whenEndTimeInTheFuture
+ whenDepositAmountEqualToTrancheAmountsSum
+ whenBrokerFeeNotTooHigh
+ whenAssetContract
+ whenAssetERC20
+ {
+ testCreateWithTimestamps(address(dai));
+ }
+
+ /// @dev Shared logic between {test_CreateWithTimestamps_AssetMissingReturnValue} and {test_CreateWithTimestamps}.
+ function testCreateWithTimestamps(address asset) internal {
+ // Make the Sender the stream's funder.
+ address funder = users.sender;
+
+ // Expect the assets to be transferred from the funder to {SablierV2LockupTranched}.
+ expectCallToTransferFrom({
+ asset: IERC20(asset),
+ from: funder,
+ to: address(lockupTranched),
+ value: defaults.DEPOSIT_AMOUNT()
+ });
+
+ // Expect the broker fee to be paid to the broker.
+ expectCallToTransferFrom({
+ asset: IERC20(asset),
+ from: funder,
+ to: users.broker,
+ value: defaults.BROKER_FEE_AMOUNT()
+ });
+
+ // Expect the relevant events to be emitted.
+ vm.expectEmit({ emitter: address(lockupTranched) });
+ emit MetadataUpdate({ _tokenId: streamId });
+ vm.expectEmit({ emitter: address(lockupTranched) });
+ emit CreateLockupTranchedStream({
+ streamId: streamId,
+ funder: funder,
+ sender: users.sender,
+ recipient: users.recipient,
+ amounts: defaults.lockupCreateAmounts(),
+ tranches: defaults.tranches(),
+ asset: IERC20(asset),
+ cancelable: true,
+ transferable: true,
+ timestamps: defaults.lockupTranchedTimestamps(),
+ broker: users.broker
+ });
+
+ // Create the stream.
+ streamId = createDefaultStreamWithAsset(IERC20(asset));
+
+ // Assert that the stream has been created.
+ LockupTranched.StreamLT memory actualStream = lockupTranched.getStream(streamId);
+ LockupTranched.StreamLT memory expectedStream = defaults.lockupTranchedStream();
+ expectedStream.asset = IERC20(asset);
+ assertEq(actualStream, expectedStream);
+
+ // Assert that the stream's status is "PENDING".
+ Lockup.Status actualStatus = lockupTranched.statusOf(streamId);
+ Lockup.Status expectedStatus = Lockup.Status.PENDING;
+ assertEq(actualStatus, expectedStatus);
+
+ // Assert that the next stream ID has been bumped.
+ uint256 actualNextStreamId = lockupTranched.nextStreamId();
+ uint256 expectedNextStreamId = streamId + 1;
+ assertEq(actualNextStreamId, expectedNextStreamId, "nextStreamId");
+
+ // Assert that the NFT has been minted.
+ address actualNFTOwner = lockupTranched.ownerOf({ tokenId: streamId });
+ address expectedNFTOwner = users.recipient;
+ assertEq(actualNFTOwner, expectedNFTOwner, "NFT owner");
+ }
+}
diff --git a/test/integration/concrete/lockup-tranched/create-with-timestamps/createWithTimestamps.tree b/test/integration/concrete/lockup-tranched/create-with-timestamps/createWithTimestamps.tree
new file mode 100644
index 000000000..3c4205768
--- /dev/null
+++ b/test/integration/concrete/lockup-tranched/create-with-timestamps/createWithTimestamps.tree
@@ -0,0 +1,56 @@
+createWithTimestamps.t.sol
+├── when delegate called
+│ └── it should revert
+└── when not delegate called
+ ├── when the recipient is the zero address
+ │ └── it should revert
+ └── when the recipient is not the zero address
+ ├── when the deposit amount is zero
+ │ └── it should revert
+ └── when the deposit amount is not zero
+ ├── when the start time is zero
+ │ └── it should revert
+ └── when the start time is not zero
+ ├── when the tranche count is zero
+ │ └── it should revert
+ └── when the tranche count is not zero
+ ├── when the tranche count is too high
+ │ └── it should revert
+ └── when the tranche count is not too high
+ ├── when the tranche amounts sum overflows
+ │ └── it should revert
+ └── when the tranche amounts sum does not overflow
+ ├── when the start time is greater than the first tranche timestamp
+ │ └── it should revert
+ ├── when the start time is equal to the first tranche timestamp
+ │ └── it should revert
+ └── when the start time is less than the first tranche timestamp
+ ├── when the tranche timestamps are not ordered
+ │ └── it should revert
+ └── when the tranche timestamps are ordered
+ ├── when the end time is not in the future
+ │ └── it should revert
+ └── when the end time is in the future
+ ├── when the deposit amount is not equal to the tranche amounts sum
+ │ └── it should revert
+ └── when the deposit amount is equal to the tranche amounts sum
+ ├── when the broker fee is too high
+ │ └── it should revert
+ └── when the broker fee is not too high
+ ├── when the asset is not a contract
+ │ └── it should revert
+ └── when the asset is a contract
+ ├── when the asset misses the ERC-20 return value
+ │ ├── it should create the stream
+ │ ├── it should bump the next stream ID
+ │ ├── it should mint the NFT
+ │ ├── it should emit a {MetadataUpdate} event
+ │ ├── it should perform the ERC-20 transfers
+ │ └── it should emit a {CreateLockupTranchedStream} event
+ └── when the asset does not miss the ERC-20 return value
+ ├── it should create the stream
+ ├── it should bump the next stream ID
+ ├── it should mint the NFT
+ ├── it should emit a {MetadataUpdate} event
+ ├── it should perform the ERC-20 transfers
+ └── it should emit a {CreateLockupTranchedStream} event
diff --git a/test/integration/concrete/lockup-tranched/get-stream/getStream.t.sol b/test/integration/concrete/lockup-tranched/get-stream/getStream.t.sol
new file mode 100644
index 000000000..3c9870943
--- /dev/null
+++ b/test/integration/concrete/lockup-tranched/get-stream/getStream.t.sol
@@ -0,0 +1,45 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22 <0.9.0;
+
+import { Errors } from "src/libraries/Errors.sol";
+import { LockupTranched } from "src/types/DataTypes.sol";
+
+import { LockupTranched_Integration_Concrete_Test } from "../LockupTranched.t.sol";
+
+contract GetStream_LockupTranched_Integration_Concrete_Test is LockupTranched_Integration_Concrete_Test {
+ uint256 internal defaultStreamId;
+
+ function setUp() public virtual override {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ defaultStreamId = createDefaultStream();
+ }
+
+ function test_RevertGiven_Null() external {
+ uint256 nullStreamId = 1729;
+ vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_Null.selector, nullStreamId));
+ lockupTranched.getStream(nullStreamId);
+ }
+
+ modifier givenNotNull() {
+ _;
+ }
+
+ function test_GetStream_StatusSettled() external givenNotNull {
+ vm.warp({ newTimestamp: defaults.END_TIME() });
+ LockupTranched.StreamLT memory actualStream = lockupTranched.getStream(defaultStreamId);
+ LockupTranched.StreamLT memory expectedStream = defaults.lockupTranchedStream();
+ expectedStream.isCancelable = false;
+ assertEq(actualStream, expectedStream);
+ }
+
+ modifier givenStatusNotSettled() {
+ _;
+ }
+
+ function test_GetStream() external givenNotNull givenStatusNotSettled {
+ uint256 streamId = createDefaultStream();
+ LockupTranched.StreamLT memory actualStream = lockupTranched.getStream(streamId);
+ LockupTranched.StreamLT memory expectedStream = defaults.lockupTranchedStream();
+ assertEq(actualStream, expectedStream);
+ }
+}
diff --git a/test/integration/concrete/lockup-tranched/get-stream/getStream.tree b/test/integration/concrete/lockup-tranched/get-stream/getStream.tree
new file mode 100644
index 000000000..bde21f7b4
--- /dev/null
+++ b/test/integration/concrete/lockup-tranched/get-stream/getStream.tree
@@ -0,0 +1,8 @@
+getStream.t.sol
+├── given the ID references a null stream
+│ └── it should revert
+└── given the ID does not reference a null stream
+ ├── given the stream is settled
+ │ └── it should adjust the `isCancelable` flag and return the stream
+ └── given the stream is not settled
+ └── it should return the stream
diff --git a/test/integration/concrete/lockup-tranched/get-timestamps/getTimestamps.t.sol b/test/integration/concrete/lockup-tranched/get-timestamps/getTimestamps.t.sol
new file mode 100644
index 000000000..3205fd3ed
--- /dev/null
+++ b/test/integration/concrete/lockup-tranched/get-timestamps/getTimestamps.t.sol
@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22 <0.9.0;
+
+import { Errors } from "src/libraries/Errors.sol";
+import { LockupTranched } from "src/types/DataTypes.sol";
+
+import { LockupTranched_Integration_Concrete_Test } from "../LockupTranched.t.sol";
+
+contract GetTimestamps_LockupTranched_Integration_Concrete_Test is LockupTranched_Integration_Concrete_Test {
+ function test_RevertGiven_Null() external {
+ uint256 nullStreamId = 1729;
+ vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_Null.selector, nullStreamId));
+ lockupTranched.getTimestamps(nullStreamId);
+ }
+
+ modifier givenNotNull() {
+ _;
+ }
+
+ function test_GetTimestamps() external givenNotNull {
+ uint256 streamId = createDefaultStream();
+ LockupTranched.Timestamps memory actualTimestamps = lockupTranched.getTimestamps(streamId);
+ LockupTranched.Timestamps memory expectedTimestamps = defaults.lockupTranchedTimestamps();
+ assertEq(actualTimestamps, expectedTimestamps);
+ }
+}
diff --git a/test/integration/concrete/lockup-tranched/get-timestamps/getTimestamps.tree b/test/integration/concrete/lockup-tranched/get-timestamps/getTimestamps.tree
new file mode 100644
index 000000000..49e6bf2a0
--- /dev/null
+++ b/test/integration/concrete/lockup-tranched/get-timestamps/getTimestamps.tree
@@ -0,0 +1,5 @@
+getTimestamps.t.sol
+├── given the ID references a null stream
+│ └── it should revert
+└── given the ID does not reference a null stream
+ └── it should return the correct timestamps
diff --git a/test/integration/concrete/lockup-tranched/get-tranches/getTranches.t.sol b/test/integration/concrete/lockup-tranched/get-tranches/getTranches.t.sol
new file mode 100644
index 000000000..eaad2a69b
--- /dev/null
+++ b/test/integration/concrete/lockup-tranched/get-tranches/getTranches.t.sol
@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22 <0.9.0;
+
+import { Errors } from "src/libraries/Errors.sol";
+import { LockupTranched } from "src/types/DataTypes.sol";
+
+import { LockupTranched_Integration_Concrete_Test } from "../LockupTranched.t.sol";
+
+contract GetTranches_LockupTranched_Integration_Concrete_Test is LockupTranched_Integration_Concrete_Test {
+ function test_RevertGiven_Null() external {
+ uint256 nullStreamId = 1729;
+ vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_Null.selector, nullStreamId));
+ lockupTranched.getTranches(nullStreamId);
+ }
+
+ modifier givenNotNull() {
+ _;
+ }
+
+ function test_GetTranches() external givenNotNull {
+ uint256 streamId = createDefaultStream();
+ LockupTranched.Tranche[] memory actualTranches = lockupTranched.getTranches(streamId);
+ LockupTranched.Tranche[] memory expectedTranches = defaults.tranches();
+ assertEq(actualTranches, expectedTranches, "tranches");
+ }
+}
diff --git a/test/integration/concrete/lockup-tranched/get-tranches/getTranches.tree b/test/integration/concrete/lockup-tranched/get-tranches/getTranches.tree
new file mode 100644
index 000000000..4a8884be1
--- /dev/null
+++ b/test/integration/concrete/lockup-tranched/get-tranches/getTranches.tree
@@ -0,0 +1,5 @@
+getTranches.t.sol
+├── given the ID references a null stream
+│ └── it should revert
+└── given the ID does not reference a null stream
+ └── it should return the correct tranches
diff --git a/test/integration/concrete/lockup-tranched/streamed-amount-of/streamedAmountOf.t.sol b/test/integration/concrete/lockup-tranched/streamed-amount-of/streamedAmountOf.t.sol
new file mode 100644
index 000000000..cd145d590
--- /dev/null
+++ b/test/integration/concrete/lockup-tranched/streamed-amount-of/streamedAmountOf.t.sol
@@ -0,0 +1,85 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22 <0.9.0;
+
+import { LockupTranched_Integration_Concrete_Test } from "../LockupTranched.t.sol";
+import { StreamedAmountOf_Integration_Concrete_Test } from "../../lockup/streamed-amount-of/streamedAmountOf.t.sol";
+
+contract StreamedAmountOf_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ StreamedAmountOf_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, StreamedAmountOf_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ StreamedAmountOf_Integration_Concrete_Test.setUp();
+ }
+
+ function test_StreamedAmountOf_StartTimeInTheFuture()
+ external
+ givenNotNull
+ givenStreamHasNotBeenCanceled
+ givenStatusStreaming
+ {
+ vm.warp({ newTimestamp: 0 });
+ uint128 actualStreamedAmount = lockupTranched.streamedAmountOf(defaultStreamId);
+ uint128 expectedStreamedAmount = 0;
+ assertEq(actualStreamedAmount, expectedStreamedAmount, "streamedAmount");
+ }
+
+ function test_StreamedAmountOf_StartTimeInThePresent()
+ external
+ givenNotNull
+ givenStreamHasNotBeenCanceled
+ givenStatusStreaming
+ {
+ vm.warp({ newTimestamp: defaults.START_TIME() });
+ uint128 actualStreamedAmount = lockupTranched.streamedAmountOf(defaultStreamId);
+ uint128 expectedStreamedAmount = 0;
+ assertEq(actualStreamedAmount, expectedStreamedAmount, "streamedAmount");
+ }
+
+ modifier givenMultipleTranches() {
+ _;
+ }
+
+ function test_StreamedAmountOf_CurrentTimestamp1st()
+ external
+ givenNotNull
+ givenStreamHasNotBeenCanceled
+ givenStatusStreaming
+ givenMultipleTranches
+ whenStartTimeInThePast
+ {
+ // Warp 1 second to the future.
+ vm.warp({ newTimestamp: defaults.START_TIME() + 1 seconds });
+
+ // Run the test.
+ uint128 actualStreamedAmount = lockupTranched.streamedAmountOf(defaultStreamId);
+ uint128 expectedStreamedAmount = 0;
+ assertEq(actualStreamedAmount, expectedStreamedAmount, "streamedAmount");
+ }
+
+ modifier givenCurrentTimestampNot1st() {
+ _;
+ }
+
+ function test_StreamedAmountOf()
+ external
+ givenNotNull
+ givenStreamHasNotBeenCanceled
+ givenStatusStreaming
+ whenStartTimeInThePast
+ givenMultipleTranches
+ givenCurrentTimestampNot1st
+ {
+ vm.warp({ newTimestamp: defaults.END_TIME() - 1 seconds });
+
+ // Run the test.
+ uint128 actualStreamedAmount = lockupTranched.streamedAmountOf(defaultStreamId);
+ uint128 expectedStreamedAmount = defaults.tranches()[0].amount + defaults.tranches()[1].amount;
+ assertEq(actualStreamedAmount, expectedStreamedAmount, "streamedAmount");
+ }
+}
diff --git a/test/integration/concrete/lockup-tranched/streamed-amount-of/streamedAmountOf.tree b/test/integration/concrete/lockup-tranched/streamed-amount-of/streamedAmountOf.tree
new file mode 100644
index 000000000..7c8644b98
--- /dev/null
+++ b/test/integration/concrete/lockup-tranched/streamed-amount-of/streamedAmountOf.tree
@@ -0,0 +1,11 @@
+streamedAmountOf.t.sol
+└── given the stream's status is "STREAMING"
+ ├── given the start time is in the future
+ │ └── it should return zero
+ ├── given the start time is in the present
+ │ └── it should return zero
+ └── given the start time is in the past
+ ├── given the current timestamp is the 1st in the array
+ │ └── it should return the correct streamed amount
+ └── given the current timestamp is not the 1st in the array
+ └── it should return the correct streamed amount
diff --git a/test/integration/concrete/lockup-tranched/token-uri/tokenURI.t.sol b/test/integration/concrete/lockup-tranched/token-uri/tokenURI.t.sol
new file mode 100644
index 000000000..04b8aeb06
--- /dev/null
+++ b/test/integration/concrete/lockup-tranched/token-uri/tokenURI.t.sol
@@ -0,0 +1,62 @@
+// SPDX-License-Identifier: UNLICENSED
+// solhint-disable max-line-length,no-console,quotes
+pragma solidity >=0.8.22 <0.9.0;
+
+import { IERC721Errors } from "@openzeppelin/contracts/interfaces/draft-IERC6093.sol";
+import { console2 } from "forge-std/src/console2.sol";
+import { StdStyle } from "forge-std/src/StdStyle.sol";
+import { Base64 } from "solady/src/utils/Base64.sol";
+
+import { LockupTranched_Integration_Concrete_Test } from "../LockupTranched.t.sol";
+
+/// @dev Requirements for these tests to work:
+/// - The stream ID must be 1
+/// - The stream's sender must be `0x6332e7b1deb1f1a0b77b2bb18b144330c7291bca`, i.e. `makeAddr("Sender")`
+/// - The stream asset must have the DAI symbol
+/// - The contract deployer, i.e. the `sender` config option in `foundry.toml`, must have the default value
+/// 0x1804c8AB1F12E6bbf3894d4083f33e07309d1f38 so that the deployed contracts have the same addresses as
+/// the values hard coded in the tests below
+contract TokenURI_LockupTranched_Integration_Concrete_Test is LockupTranched_Integration_Concrete_Test {
+ address internal constant LOCKUP_TRANCHED = 0xDB25A7b768311dE128BBDa7B8426c3f9C74f3240;
+ uint256 internal defaultStreamId;
+
+ /// @dev To make these tests noninvasive, they are run only when the contract address matches the hard coded value.
+ modifier skipOnMismatch() {
+ if (address(lockupTranched) == LOCKUP_TRANCHED) {
+ _;
+ } else {
+ console2.log(StdStyle.yellow('Warning: "lockupTranched.tokenURI" tests skipped due to address mismatch'));
+ }
+ }
+
+ function test_RevertGiven_NFTDoesNotExist() external {
+ uint256 nullStreamId = 1729;
+ vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721NonexistentToken.selector, nullStreamId));
+ lockupTranched.tokenURI({ tokenId: nullStreamId });
+ }
+
+ modifier givenNFTExists() {
+ defaultStreamId = createDefaultStream();
+ vm.warp({ newTimestamp: defaults.START_TIME() + defaults.TOTAL_DURATION() / 4 });
+ _;
+ }
+
+ /// @dev If you need to update the hard-coded token URI:
+ /// 1. Use "vm.writeFile" to log the strings to a file.
+ /// 2. Remember to escape the EOL character \n with \\n.
+ function test_TokenURI_Decoded() external skipOnMismatch givenNFTExists {
+ string memory tokenURI = lockupTranched.tokenURI(defaultStreamId);
+ tokenURI = vm.replace({ input: tokenURI, from: "data:application/json;base64,", to: "" });
+ string memory actualDecodedTokenURI = string(Base64.decode(tokenURI));
+ string memory expectedDecodedTokenURI =
+ unicode'{"attributes":[{"trait_type":"Asset","value":"DAI"},{"trait_type":"Sender","value":"0x6332e7b1deb1f1a0b77b2bb18b144330c7291bca"},{"trait_type":"Status","value":"Streaming"}],"description":"This NFT represents a payment stream in a Sablier V2 Lockup Tranched contract. The owner of this NFT can withdraw the streamed assets, which are denominated in DAI.\\n\\n- Stream ID: 1\\n- Lockup Tranched Address: 0xdb25a7b768311de128bbda7b8426c3f9c74f3240\\n- DAI Address: 0x03a6a84cd762d9707a21605b548aaab891562aab\\n\\n⚠️ WARNING: Transferring the NFT makes the new owner the recipient of the stream. The funds are not automatically withdrawn for the previous recipient.","external_url":"https://sablier.com","name":"Sablier V2 Lockup Tranched #1","image":"data:image/svg+xml;base64,<svg xmlns="http://www.w3.org/2000/svg" width="1000" height="1000" viewBox="0 0 1000 1000"><rect width="100%" height="100%" filter="url(#Noise)"/><rect x="70" y="70" width="860" height="860" fill="#fff" fill-opacity=".03" rx="45" ry="45" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><defs><circle id="Glow" r="500" fill="url(#RadialGlow)"/><filter id="Noise"><feFlood x="0" y="0" width="100%" height="100%" flood-color="hsl(230,21%,11%)" flood-opacity="1" result="floodFill"/><feTurbulence baseFrequency=".4" numOctaves="3" result="Noise" type="fractalNoise"/><feBlend in="Noise" in2="floodFill" mode="soft-light"/></filter><path id="Logo" fill="#fff" fill-opacity=".1" d="m133.559,124.034c-.013,2.412-1.059,4.848-2.923,6.402-2.558,1.819-5.168,3.439-7.888,4.996-14.44,8.262-31.047,12.565-47.674,12.569-8.858.036-17.838-1.272-26.328-3.663-9.806-2.766-19.087-7.113-27.562-12.778-13.842-8.025,9.468-28.606,16.153-35.265h0c2.035-1.838,4.252-3.546,6.463-5.224h0c6.429-5.655,16.218-2.835,20.358,4.17,4.143,5.057,8.816,9.649,13.92,13.734h.037c5.736,6.461,15.357-2.253,9.38-8.48,0,0-3.515-3.515-3.515-3.515-11.49-11.478-52.656-52.664-64.837-64.837l.049-.037c-1.725-1.606-2.719-3.847-2.751-6.204h0c-.046-2.375,1.062-4.582,2.726-6.229h0l.185-.148h0c.099-.062,.222-.148,.37-.259h0c2.06-1.362,3.951-2.621,6.044-3.842C57.763-3.473,97.76-2.341,128.637,18.332c16.671,9.946-26.344,54.813-38.651,40.199-6.299-6.096-18.063-17.743-19.668-18.811-6.016-4.047-13.061,4.776-7.752,9.751l68.254,68.371c1.724,1.601,2.714,3.84,2.738,6.192Z"/><path id="FloatingText" fill="none" d="M125 45h750s80 0 80 80v750s0 80 -80 80h-750s-80 0 -80 -80v-750s0 -80 80 -80"/><radialGradient id="RadialGlow"><stop offset="0%" stop-color="hsl(61,88%,40%)" stop-opacity=".6"/><stop offset="100%" stop-color="hsl(230,21%,11%)" stop-opacity="0"/></radialGradient><linearGradient id="SandTop" x1="0%" y1="0%"><stop offset="0%" stop-color="hsl(61,88%,40%)"/><stop offset="100%" stop-color="hsl(230,21%,11%)"/></linearGradient><linearGradient id="SandBottom" x1="100%" y1="100%"><stop offset="10%" stop-color="hsl(230,21%,11%)"/><stop offset="100%" stop-color="hsl(61,88%,40%)"/><animate attributeName="x1" dur="6s" repeatCount="indefinite" values="30%;60%;120%;60%;30%;"/></linearGradient><linearGradient id="HourglassStroke" gradientTransform="rotate(90)" gradientUnits="userSpaceOnUse"><stop offset="50%" stop-color="hsl(61,88%,40%)"/><stop offset="80%" stop-color="hsl(230,21%,11%)"/></linearGradient><g id="Hourglass"><path d="M 50,360 a 300,300 0 1,1 600,0 a 300,300 0 1,1 -600,0" fill="#fff" fill-opacity=".02" stroke="url(#HourglassStroke)" stroke-width="4"/><path d="m566,161.201v-53.924c0-19.382-22.513-37.563-63.398-51.198-40.756-13.592-94.946-21.079-152.587-21.079s-111.838,7.487-152.602,21.079c-40.893,13.636-63.413,31.816-63.413,51.198v53.924c0,17.181,17.704,33.427,50.223,46.394v284.809c-32.519,12.96-50.223,29.206-50.223,46.394v53.924c0,19.382,22.52,37.563,63.413,51.198,40.763,13.592,94.954,21.079,152.602,21.079s111.831-7.487,152.587-21.079c40.886-13.636,63.398-31.816,63.398-51.198v-53.924c0-17.196-17.704-33.435-50.223-46.401V207.603c32.519-12.967,50.223-29.206,50.223-46.401Zm-347.462,57.793l130.959,131.027-130.959,131.013V218.994Zm262.924.022v262.018l-130.937-131.006,130.937-131.013Z" fill="#161822"></path><polygon points="350 350.026 415.03 284.978 285 284.978 350 350.026" fill="url(#SandBottom)"/><path d="m416.341,281.975c0,.914-.354,1.809-1.035,2.68-5.542,7.076-32.661,12.45-65.28,12.45-32.624,0-59.738-5.374-65.28-12.45-.681-.872-1.035-1.767-1.035-2.68,0-.914.354-1.808,1.035-2.676,5.542-7.076,32.656-12.45,65.28-12.45,32.619,0,59.738,5.374,65.28,12.45.681.867,1.035,1.762,1.035,2.676Z" fill="url(#SandTop)"/><path d="m481.46,504.101v58.449c-2.35.77-4.82,1.51-7.39,2.23-30.3,8.54-74.65,13.92-124.06,13.92-53.6,0-101.24-6.33-131.47-16.16v-58.439h262.92Z" fill="url(#SandBottom)"/><ellipse cx="350" cy="504.101" rx="131.462" ry="28.108" fill="url(#SandTop)"/><g fill="none" stroke="url(#HourglassStroke)" stroke-linecap="round" stroke-miterlimit="10" stroke-width="4"><path d="m565.641,107.28c0,9.537-5.56,18.629-15.676,26.973h-.023c-9.204,7.596-22.194,14.562-38.197,20.592-39.504,14.936-97.325,24.355-161.733,24.355-90.48,0-167.948-18.582-199.953-44.948h-.023c-10.115-8.344-15.676-17.437-15.676-26.973,0-39.735,96.554-71.921,215.652-71.921s215.629,32.185,215.629,71.921Z"/><path d="m134.36,161.203c0,39.735,96.554,71.921,215.652,71.921s215.629-32.186,215.629-71.921"/><line x1="134.36" y1="161.203" x2="134.36" y2="107.28"/><line x1="565.64" y1="161.203" x2="565.64" y2="107.28"/><line x1="184.584" y1="206.823" x2="184.585" y2="537.579"/><line x1="218.181" y1="218.118" x2="218.181" y2="562.537"/><line x1="481.818" y1="218.142" x2="481.819" y2="562.428"/><line x1="515.415" y1="207.352" x2="515.416" y2="537.579"/><path d="m184.58,537.58c0,5.45,4.27,10.65,12.03,15.42h.02c5.51,3.39,12.79,6.55,21.55,9.42,30.21,9.9,78.02,16.28,131.83,16.28,49.41,0,93.76-5.38,124.06-13.92,2.7-.76,5.29-1.54,7.75-2.35,8.77-2.87,16.05-6.04,21.56-9.43h0c7.76-4.77,12.04-9.97,12.04-15.42"/><path d="m184.582,492.656c-31.354,12.485-50.223,28.58-50.223,46.142,0,9.536,5.564,18.627,15.677,26.969h.022c8.503,7.005,20.213,13.463,34.524,19.159,9.999,3.991,21.269,7.609,33.597,10.788,36.45,9.407,82.181,15.002,131.835,15.002s95.363-5.595,131.807-15.002c10.847-2.79,20.867-5.926,29.924-9.349,1.244-.467,2.473-.942,3.673-1.424,14.326-5.696,26.035-12.161,34.524-19.173h.022c10.114-8.342,15.677-17.433,15.677-26.969,0-17.562-18.869-33.665-50.223-46.15"/><path d="m134.36,592.72c0,39.735,96.554,71.921,215.652,71.921s215.629-32.186,215.629-71.921"/><line x1="134.36" y1="592.72" x2="134.36" y2="538.797"/><line x1="565.64" y1="592.72" x2="565.64" y2="538.797"/><polyline points="481.822 481.901 481.798 481.877 481.775 481.854 350.015 350.026 218.185 218.129"/><polyline points="218.185 481.901 218.231 481.854 350.015 350.026 481.822 218.152"/></g></g><g id="Progress" fill="#fff"><rect width="208" height="100" fill-opacity=".03" rx="15" ry="15" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><text x="20" y="34" font-family="'Courier New',Arial,monospace" font-size="22px">Progress</text><text x="20" y="72" font-family="'Courier New',Arial,monospace" font-size="26px">25%</text><g fill="none"><circle cx="166" cy="50" r="22" stroke="hsl(230,21%,11%)" stroke-width="10"/><circle cx="166" cy="50" pathLength="10000" r="22" stroke="hsl(61,88%,40%)" stroke-dasharray="10000" stroke-dashoffset="7500" stroke-linecap="round" stroke-width="5" transform="rotate(-90)" transform-origin="166 50"/></g></g><g id="Status" fill="#fff"><rect width="184" height="100" fill-opacity=".03" rx="15" ry="15" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><text x="20" y="34" font-family="'Courier New',Arial,monospace" font-size="22px">Status</text><text x="20" y="72" font-family="'Courier New',Arial,monospace" font-size="26px">Streaming</text></g><g id="Amount" fill="#fff"><rect width="120" height="100" fill-opacity=".03" rx="15" ry="15" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><text x="20" y="34" font-family="'Courier New',Arial,monospace" font-size="22px">Amount</text><text x="20" y="72" font-family="'Courier New',Arial,monospace" font-size="26px">&#8805; 10K</text></g><g id="Duration" fill="#fff"><rect width="152" height="100" fill-opacity=".03" rx="15" ry="15" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><text x="20" y="34" font-family="'Courier New',Arial,monospace" font-size="22px">Duration</text><text x="20" y="72" font-family="'Courier New',Arial,monospace" font-size="26px">&lt; 1 Day</text></g></defs><text text-rendering="optimizeSpeed"><textPath startOffset="-100%" href="#FloatingText" fill="#fff" font-family="'Courier New',Arial,monospace" fill-opacity=".8" font-size="26px"><animate additive="sum" attributeName="startOffset" begin="0s" dur="50s" from="0%" repeatCount="indefinite" to="100%"/>0xdb25a7b768311de128bbda7b8426c3f9c74f3240 • Sablier V2 Lockup Dynamic</textPath><textPath startOffset="0%" href="#FloatingText" fill="#fff" font-family="'Courier New',Arial,monospace" fill-opacity=".8" font-size="26px"><animate additive="sum" attributeName="startOffset" begin="0s" dur="50s" from="0%" repeatCount="indefinite" to="100%"/>0xdb25a7b768311de128bbda7b8426c3f9c74f3240 • Sablier V2 Lockup Dynamic</textPath><textPath startOffset="-50%" href="#FloatingText" fill="#fff" font-family="'Courier New',Arial,monospace" fill-opacity=".8" font-size="26px"><animate additive="sum" attributeName="startOffset" begin="0s" dur="50s" from="0%" repeatCount="indefinite" to="100%"/>0x03a6a84cd762d9707a21605b548aaab891562aab • DAI</textPath><textPath startOffset="50%" href="#FloatingText" fill="#fff" font-family="'Courier New',Arial,monospace" fill-opacity=".8" font-size="26px"><animate additive="sum" attributeName="startOffset" begin="0s" dur="50s" from="0%" repeatCount="indefinite" to="100%"/>0x03a6a84cd762d9707a21605b548aaab891562aab • DAI</textPath></text><use href="#Glow" fill-opacity=".9"/><use href="#Glow" x="1000" y="1000" fill-opacity=".9"/><use href="#Logo" x="170" y="170" transform="scale(.6)"/><use href="#Hourglass" x="150" y="90" transform="rotate(10)" transform-origin="500 500"/><use href="#Progress" x="144" y="790"/><use href="#Status" x="368" y="790"/><use href="#Amount" x="568" y="790"/><use href="#Duration" x="704" y="790"/></svg>"}';
+ assertEq(actualDecodedTokenURI, expectedDecodedTokenURI, "decoded token URI");
+ }
+
+ function test_TokenURI_Full() external skipOnMismatch givenNFTExists {
+ string memory actualTokenURI = lockupTranched.tokenURI(defaultStreamId);
+ string memory expectedTokenURI =
+ "data:application/json;base64,{"attributes":[{"trait_type":"Asset","value":"DAI"},{"trait_type":"Sender","value":"0x6332e7b1deb1f1a0b77b2bb18b144330c7291bca"},{"trait_type":"Status","value":"Streaming"}],"description":"This NFT represents a payment stream in a Sablier V2 Lockup Dynamic contract. The owner of this NFT can withdraw the streamed assets, which are denominated in DAI.\n\n- Stream ID: 1\n- Lockup Dynamic Address: 0xdb25a7b768311de128bbda7b8426c3f9c74f3240\n- DAI Address: 0x03a6a84cd762d9707a21605b548aaab891562aab\n\n⚠️ WARNING: Transferring the NFT makes the new owner the recipient of the stream. The funds are not automatically withdrawn for the previous recipient.","external_url":"https://sablier.com","name":"Sablier V2 Lockup Dynamic #1","image":"data:image/svg+xml;base64,<svg xmlns="http://www.w3.org/2000/svg" width="1000" height="1000" viewBox="0 0 1000 1000"><rect width="100%" height="100%" filter="url(#Noise)"/><rect x="70" y="70" width="860" height="860" fill="#fff" fill-opacity=".03" rx="45" ry="45" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><defs><circle id="Glow" r="500" fill="url(#RadialGlow)"/><filter id="Noise"><feFlood x="0" y="0" width="100%" height="100%" flood-color="hsl(230,21%,11%)" flood-opacity="1" result="floodFill"/><feTurbulence baseFrequency=".4" numOctaves="3" result="Noise" type="fractalNoise"/><feBlend in="Noise" in2="floodFill" mode="soft-light"/></filter><path id="Logo" fill="#fff" fill-opacity=".1" d="m133.559,124.034c-.013,2.412-1.059,4.848-2.923,6.402-2.558,1.819-5.168,3.439-7.888,4.996-14.44,8.262-31.047,12.565-47.674,12.569-8.858.036-17.838-1.272-26.328-3.663-9.806-2.766-19.087-7.113-27.562-12.778-13.842-8.025,9.468-28.606,16.153-35.265h0c2.035-1.838,4.252-3.546,6.463-5.224h0c6.429-5.655,16.218-2.835,20.358,4.17,4.143,5.057,8.816,9.649,13.92,13.734h.037c5.736,6.461,15.357-2.253,9.38-8.48,0,0-3.515-3.515-3.515-3.515-11.49-11.478-52.656-52.664-64.837-64.837l.049-.037c-1.725-1.606-2.719-3.847-2.751-6.204h0c-.046-2.375,1.062-4.582,2.726-6.229h0l.185-.148h0c.099-.062,.222-.148,.37-.259h0c2.06-1.362,3.951-2.621,6.044-3.842C57.763-3.473,97.76-2.341,128.637,18.332c16.671,9.946-26.344,54.813-38.651,40.199-6.299-6.096-18.063-17.743-19.668-18.811-6.016-4.047-13.061,4.776-7.752,9.751l68.254,68.371c1.724,1.601,2.714,3.84,2.738,6.192Z"/><path id="FloatingText" fill="none" d="M125 45h750s80 0 80 80v750s0 80 -80 80h-750s-80 0 -80 -80v-750s0 -80 80 -80"/><radialGradient id="RadialGlow"><stop offset="0%" stop-color="hsl(61,88%,40%)" stop-opacity=".6"/><stop offset="100%" stop-color="hsl(230,21%,11%)" stop-opacity="0"/></radialGradient><linearGradient id="SandTop" x1="0%" y1="0%"><stop offset="0%" stop-color="hsl(61,88%,40%)"/><stop offset="100%" stop-color="hsl(230,21%,11%)"/></linearGradient><linearGradient id="SandBottom" x1="100%" y1="100%"><stop offset="10%" stop-color="hsl(230,21%,11%)"/><stop offset="100%" stop-color="hsl(61,88%,40%)"/><animate attributeName="x1" dur="6s" repeatCount="indefinite" values="30%;60%;120%;60%;30%;"/></linearGradient><linearGradient id="HourglassStroke" gradientTransform="rotate(90)" gradientUnits="userSpaceOnUse"><stop offset="50%" stop-color="hsl(61,88%,40%)"/><stop offset="80%" stop-color="hsl(230,21%,11%)"/></linearGradient><g id="Hourglass"><path d="M 50,360 a 300,300 0 1,1 600,0 a 300,300 0 1,1 -600,0" fill="#fff" fill-opacity=".02" stroke="url(#HourglassStroke)" stroke-width="4"/><path d="m566,161.201v-53.924c0-19.382-22.513-37.563-63.398-51.198-40.756-13.592-94.946-21.079-152.587-21.079s-111.838,7.487-152.602,21.079c-40.893,13.636-63.413,31.816-63.413,51.198v53.924c0,17.181,17.704,33.427,50.223,46.394v284.809c-32.519,12.96-50.223,29.206-50.223,46.394v53.924c0,19.382,22.52,37.563,63.413,51.198,40.763,13.592,94.954,21.079,152.602,21.079s111.831-7.487,152.587-21.079c40.886-13.636,63.398-31.816,63.398-51.198v-53.924c0-17.196-17.704-33.435-50.223-46.401V207.603c32.519-12.967,50.223-29.206,50.223-46.401Zm-347.462,57.793l130.959,131.027-130.959,131.013V218.994Zm262.924.022v262.018l-130.937-131.006,130.937-131.013Z" fill="#161822"></path><polygon points="350 350.026 415.03 284.978 285 284.978 350 350.026" fill="url(#SandBottom)"/><path d="m416.341,281.975c0,.914-.354,1.809-1.035,2.68-5.542,7.076-32.661,12.45-65.28,12.45-32.624,0-59.738-5.374-65.28-12.45-.681-.872-1.035-1.767-1.035-2.68,0-.914.354-1.808,1.035-2.676,5.542-7.076,32.656-12.45,65.28-12.45,32.619,0,59.738,5.374,65.28,12.45.681.867,1.035,1.762,1.035,2.676Z" fill="url(#SandTop)"/><path d="m481.46,504.101v58.449c-2.35.77-4.82,1.51-7.39,2.23-30.3,8.54-74.65,13.92-124.06,13.92-53.6,0-101.24-6.33-131.47-16.16v-58.439h262.92Z" fill="url(#SandBottom)"/><ellipse cx="350" cy="504.101" rx="131.462" ry="28.108" fill="url(#SandTop)"/><g fill="none" stroke="url(#HourglassStroke)" stroke-linecap="round" stroke-miterlimit="10" stroke-width="4"><path d="m565.641,107.28c0,9.537-5.56,18.629-15.676,26.973h-.023c-9.204,7.596-22.194,14.562-38.197,20.592-39.504,14.936-97.325,24.355-161.733,24.355-90.48,0-167.948-18.582-199.953-44.948h-.023c-10.115-8.344-15.676-17.437-15.676-26.973,0-39.735,96.554-71.921,215.652-71.921s215.629,32.185,215.629,71.921Z"/><path d="m134.36,161.203c0,39.735,96.554,71.921,215.652,71.921s215.629-32.186,215.629-71.921"/><line x1="134.36" y1="161.203" x2="134.36" y2="107.28"/><line x1="565.64" y1="161.203" x2="565.64" y2="107.28"/><line x1="184.584" y1="206.823" x2="184.585" y2="537.579"/><line x1="218.181" y1="218.118" x2="218.181" y2="562.537"/><line x1="481.818" y1="218.142" x2="481.819" y2="562.428"/><line x1="515.415" y1="207.352" x2="515.416" y2="537.579"/><path d="m184.58,537.58c0,5.45,4.27,10.65,12.03,15.42h.02c5.51,3.39,12.79,6.55,21.55,9.42,30.21,9.9,78.02,16.28,131.83,16.28,49.41,0,93.76-5.38,124.06-13.92,2.7-.76,5.29-1.54,7.75-2.35,8.77-2.87,16.05-6.04,21.56-9.43h0c7.76-4.77,12.04-9.97,12.04-15.42"/><path d="m184.582,492.656c-31.354,12.485-50.223,28.58-50.223,46.142,0,9.536,5.564,18.627,15.677,26.969h.022c8.503,7.005,20.213,13.463,34.524,19.159,9.999,3.991,21.269,7.609,33.597,10.788,36.45,9.407,82.181,15.002,131.835,15.002s95.363-5.595,131.807-15.002c10.847-2.79,20.867-5.926,29.924-9.349,1.244-.467,2.473-.942,3.673-1.424,14.326-5.696,26.035-12.161,34.524-19.173h.022c10.114-8.342,15.677-17.433,15.677-26.969,0-17.562-18.869-33.665-50.223-46.15"/><path d="m134.36,592.72c0,39.735,96.554,71.921,215.652,71.921s215.629-32.186,215.629-71.921"/><line x1="134.36" y1="592.72" x2="134.36" y2="538.797"/><line x1="565.64" y1="592.72" x2="565.64" y2="538.797"/><polyline points="481.822 481.901 481.798 481.877 481.775 481.854 350.015 350.026 218.185 218.129"/><polyline points="218.185 481.901 218.231 481.854 350.015 350.026 481.822 218.152"/></g></g><g id="Progress" fill="#fff"><rect width="208" height="100" fill-opacity=".03" rx="15" ry="15" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><text x="20" y="34" font-family="'Courier New',Arial,monospace" font-size="22px">Progress</text><text x="20" y="72" font-family="'Courier New',Arial,monospace" font-size="26px">25%</text><g fill="none"><circle cx="166" cy="50" r="22" stroke="hsl(230,21%,11%)" stroke-width="10"/><circle cx="166" cy="50" pathLength="10000" r="22" stroke="hsl(61,88%,40%)" stroke-dasharray="10000" stroke-dashoffset="7500" stroke-linecap="round" stroke-width="5" transform="rotate(-90)" transform-origin="166 50"/></g></g><g id="Status" fill="#fff"><rect width="184" height="100" fill-opacity=".03" rx="15" ry="15" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><text x="20" y="34" font-family="'Courier New',Arial,monospace" font-size="22px">Status</text><text x="20" y="72" font-family="'Courier New',Arial,monospace" font-size="26px">Streaming</text></g><g id="Amount" fill="#fff"><rect width="120" height="100" fill-opacity=".03" rx="15" ry="15" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><text x="20" y="34" font-family="'Courier New',Arial,monospace" font-size="22px">Amount</text><text x="20" y="72" font-family="'Courier New',Arial,monospace" font-size="26px">&#8805; 10K</text></g><g id="Duration" fill="#fff"><rect width="152" height="100" fill-opacity=".03" rx="15" ry="15" stroke="#fff" stroke-opacity=".1" stroke-width="4"/><text x="20" y="34" font-family="'Courier New',Arial,monospace" font-size="22px">Duration</text><text x="20" y="72" font-family="'Courier New',Arial,monospace" font-size="26px">&lt; 1 Day</text></g></defs><text text-rendering="optimizeSpeed"><textPath startOffset="-100%" href="#FloatingText" fill="#fff" font-family="'Courier New',Arial,monospace" fill-opacity=".8" font-size="26px"><animate additive="sum" attributeName="startOffset" begin="0s" dur="50s" from="0%" repeatCount="indefinite" to="100%"/>0xdb25a7b768311de128bbda7b8426c3f9c74f3240 • Sablier V2 Lockup Dynamic</textPath><textPath startOffset="0%" href="#FloatingText" fill="#fff" font-family="'Courier New',Arial,monospace" fill-opacity=".8" font-size="26px"><animate additive="sum" attributeName="startOffset" begin="0s" dur="50s" from="0%" repeatCount="indefinite" to="100%"/>0xdb25a7b768311de128bbda7b8426c3f9c74f3240 • Sablier V2 Lockup Dynamic</textPath><textPath startOffset="-50%" href="#FloatingText" fill="#fff" font-family="'Courier New',Arial,monospace" fill-opacity=".8" font-size="26px"><animate additive="sum" attributeName="startOffset" begin="0s" dur="50s" from="0%" repeatCount="indefinite" to="100%"/>0x03a6a84cd762d9707a21605b548aaab891562aab • DAI</textPath><textPath startOffset="50%" href="#FloatingText" fill="#fff" font-family="'Courier New',Arial,monospace" fill-opacity=".8" font-size="26px"><animate additive="sum" attributeName="startOffset" begin="0s" dur="50s" from="0%" repeatCount="indefinite" to="100%"/>0x03a6a84cd762d9707a21605b548aaab891562aab • DAI</textPath></text><use href="#Glow" fill-opacity=".9"/><use href="#Glow" x="1000" y="1000" fill-opacity=".9"/><use href="#Logo" x="170" y="170" transform="scale(.6)"/><use href="#Hourglass" x="150" y="90" transform="rotate(10)" transform-origin="500 500"/><use href="#Progress" x="144" y="790"/><use href="#Status" x="368" y="790"/><use href="#Amount" x="568" y="790"/><use href="#Duration" x="704" y="790"/></svg>"}";
+ assertEq(actualTokenURI, expectedTokenURI, "token URI");
+ }
+}
diff --git a/test/integration/concrete/lockup-tranched/token-uri/tokenURI.tree b/test/integration/concrete/lockup-tranched/token-uri/tokenURI.tree
new file mode 100644
index 000000000..6a58d7e09
--- /dev/null
+++ b/test/integration/concrete/lockup-tranched/token-uri/tokenURI.tree
@@ -0,0 +1,5 @@
+tokenURI.t.sol
+├── given the NFT does not exist
+│ └── it should revert
+└── given the NFT exists
+ └── it should return the correct token URI
diff --git a/test/integration/concrete/lockup-tranched/withdrawable-amount-of/withdrawableAmountOf.t.sol b/test/integration/concrete/lockup-tranched/withdrawable-amount-of/withdrawableAmountOf.t.sol
new file mode 100644
index 000000000..0f1ea9bd2
--- /dev/null
+++ b/test/integration/concrete/lockup-tranched/withdrawable-amount-of/withdrawableAmountOf.t.sol
@@ -0,0 +1,77 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22 <0.9.0;
+
+import { LockupTranched_Integration_Concrete_Test } from "../LockupTranched.t.sol";
+import { WithdrawableAmountOf_Integration_Concrete_Test } from
+ "../../lockup/withdrawable-amount-of/withdrawableAmountOf.t.sol";
+
+contract WithdrawableAmountOf_LockupTranched_Integration_Concrete_Test is
+ LockupTranched_Integration_Concrete_Test,
+ WithdrawableAmountOf_Integration_Concrete_Test
+{
+ function setUp()
+ public
+ virtual
+ override(LockupTranched_Integration_Concrete_Test, WithdrawableAmountOf_Integration_Concrete_Test)
+ {
+ LockupTranched_Integration_Concrete_Test.setUp();
+ WithdrawableAmountOf_Integration_Concrete_Test.setUp();
+ }
+
+ function test_WithdrawableAmountOf_StartTimeInThePresent()
+ external
+ givenNotNull
+ givenStreamHasNotBeenCanceled
+ givenStatusStreaming
+ {
+ vm.warp({ newTimestamp: defaults.START_TIME() });
+ uint128 actualWithdrawableAmount = lockupTranched.withdrawableAmountOf(defaultStreamId);
+ uint128 expectedWithdrawableAmount = 0;
+ assertEq(actualWithdrawableAmount, expectedWithdrawableAmount, "withdrawableAmount");
+ }
+
+ modifier givenStartTimeInThePast() {
+ _;
+ }
+
+ function test_WithdrawableAmountOf_NoPreviousWithdrawals()
+ external
+ givenNotNull
+ givenStreamHasNotBeenCanceled
+ givenStatusStreaming
+ givenStartTimeInThePast
+ {
+ // Simulate the passage of time.
+ vm.warp({ newTimestamp: defaults.START_TIME() + defaults.CLIFF_DURATION() });
+
+ // Run the test.
+ uint128 actualWithdrawableAmount = lockupTranched.withdrawableAmountOf(defaultStreamId);
+ uint128 expectedWithdrawableAmount = defaults.tranches()[0].amount;
+ assertEq(actualWithdrawableAmount, expectedWithdrawableAmount, "withdrawableAmount");
+ }
+
+ modifier whenWithWithdrawals() {
+ _;
+ }
+
+ function test_WithdrawableAmountOf()
+ external
+ givenNotNull
+ givenStreamHasNotBeenCanceled
+ givenStatusStreaming
+ givenStartTimeInThePast
+ whenWithWithdrawals
+ {
+ // Simulate the passage of time.
+ vm.warp({ newTimestamp: defaults.START_TIME() + defaults.CLIFF_DURATION() });
+
+ // Make the withdrawal.
+ lockupTranched.withdraw({ streamId: defaultStreamId, to: users.recipient, amount: defaults.CLIFF_AMOUNT() });
+
+ // Run the test.
+ uint128 actualWithdrawableAmount = lockupTranched.withdrawableAmountOf(defaultStreamId);
+
+ uint128 expectedWithdrawableAmount = defaults.tranches()[0].amount - defaults.CLIFF_AMOUNT();
+ assertEq(actualWithdrawableAmount, expectedWithdrawableAmount, "withdrawableAmount");
+ }
+}
diff --git a/test/integration/concrete/lockup-tranched/withdrawable-amount-of/withdrawableAmountOf.tree b/test/integration/concrete/lockup-tranched/withdrawable-amount-of/withdrawableAmountOf.tree
new file mode 100644
index 000000000..fe3ff45ef
--- /dev/null
+++ b/test/integration/concrete/lockup-tranched/withdrawable-amount-of/withdrawableAmountOf.tree
@@ -0,0 +1,9 @@
+withdrawableAmountOf.t.sol
+└── given the stream's status is "STREAMING"
+ ├── given the start time is in the present
+ │ └── it should return zero
+ └── given the start time is in the past
+ ├── given there are no previous withdrawals
+ │ └── it should return the correct withdrawable amount
+ └── given there are previous withdrawals
+ └── it should return the correct withdrawable amount
diff --git a/test/integration/concrete/lockup/allow-to-hook/allowToHook.t.sol b/test/integration/concrete/lockup/allow-to-hook/allowToHook.t.sol
new file mode 100644
index 000000000..c30daca79
--- /dev/null
+++ b/test/integration/concrete/lockup/allow-to-hook/allowToHook.t.sol
@@ -0,0 +1,80 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22 <0.9.0;
+
+import { Errors } from "src/libraries/Errors.sol";
+
+import { Lockup_Integration_Shared_Test } from "../../../shared/lockup/Lockup.t.sol";
+import { Integration_Test } from "../../../Integration.t.sol";
+
+abstract contract AllowToHook_Integration_Concrete_Test is Integration_Test, Lockup_Integration_Shared_Test {
+ uint256 internal defaultStreamId;
+
+ function setUp() public virtual override(Integration_Test, Lockup_Integration_Shared_Test) {
+ defaultStreamId = createDefaultStream();
+ }
+
+ function test_RevertWhen_CallerNotAdmin() external {
+ // Make Eve the caller in this test.
+ resetPrank({ msgSender: users.eve });
+
+ // Run the test.
+ vm.expectRevert(abi.encodeWithSelector(Errors.CallerNotAdmin.selector, users.admin, users.eve));
+ lockup.allowToHook(users.eve);
+ }
+
+ modifier whenCallerAdmin() {
+ // Make the Admin the caller in the rest of this test suite.
+ resetPrank({ msgSender: users.admin });
+ _;
+ }
+
+ function test_RevertWhen_ProvidedAddressNoCode() external whenCallerAdmin {
+ address eoa = vm.addr({ privateKey: 1 });
+ vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_AllowToHookZeroCodeSize.selector, eoa));
+ lockup.allowToHook(eoa);
+ }
+
+ modifier whenProvidedAddressHasCode() {
+ _;
+ }
+
+ function test_RevertWhen_ProvidedAddressUnsupportedInterface()
+ external
+ whenCallerAdmin
+ whenProvidedAddressHasCode
+ {
+ // Incorrect interface ID.
+ address recipient = address(recipientInterfaceIDIncorrect);
+ vm.expectRevert(
+ abi.encodeWithSelector(Errors.SablierV2Lockup_AllowToHookUnsupportedInterface.selector, recipient)
+ );
+ lockup.allowToHook(recipient);
+
+ // Missing interface ID.
+ recipient = address(recipientInterfaceIDMissing);
+ vm.expectRevert(bytes(""));
+ lockup.allowToHook(recipient);
+ }
+
+ modifier whenProvidedAddressSupportsInterface() {
+ _;
+ }
+
+ function test_AllowToHook()
+ external
+ whenCallerAdmin
+ whenProvidedAddressHasCode
+ whenProvidedAddressSupportsInterface
+ {
+ // Expect the relevant event to be emitted.
+ vm.expectEmit({ emitter: address(lockup) });
+ emit AllowToHook(users.admin, address(recipientGood));
+
+ // Allow the provided address to hook.
+ lockup.allowToHook(address(recipientGood));
+
+ // Assert that the provided address has been put on the allowlist.
+ bool isAllowedToHook = lockup.isAllowedToHook(address(recipientGood));
+ assertTrue(isAllowedToHook, "address not put on the allowlist");
+ }
+}
diff --git a/test/integration/concrete/lockup/allow-to-hook/allowToHook.tree b/test/integration/concrete/lockup/allow-to-hook/allowToHook.tree
new file mode 100644
index 000000000..e8541e138
--- /dev/null
+++ b/test/integration/concrete/lockup/allow-to-hook/allowToHook.tree
@@ -0,0 +1,12 @@
+allowToHook.tree
+├── when the caller is not the admin
+│ └── it should revert
+└── when the caller is the admin
+ ├── when the provided address doesn't have any code
+ │ └── it should revert
+ └── when the provided address has code
+ ├── when the provided address does not support the recipient interface
+ │ └── it should revert
+ └── when the provided address supports the recipient interface
+ ├── it should put the address on the allowlist
+ └── it should emit a {AllowToHook} event
diff --git a/test/integration/concrete/lockup/burn/burn.t.sol b/test/integration/concrete/lockup/burn/burn.t.sol
index f73493e41..f16ffa248 100644
--- a/test/integration/concrete/lockup/burn/burn.t.sol
+++ b/test/integration/concrete/lockup/burn/burn.t.sol
@@ -1,5 +1,7 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
+
+import { IERC721Errors } from "@openzeppelin/contracts/interfaces/draft-IERC6093.sol";
import { ISablierV2Lockup } from "src/interfaces/ISablierV2Lockup.sol";
import { Errors } from "src/libraries/Errors.sol";
@@ -16,7 +18,7 @@ abstract contract Burn_Integration_Concrete_Test is Integration_Test, Lockup_Int
notTransferableStreamId = createDefaultStreamNotTransferable();
// Make the Recipient (owner of the NFT) the caller in this test suite.
- changePrank({ msgSender: users.recipient });
+ resetPrank({ msgSender: users.recipient });
}
function test_RevertWhen_DelegateCalled() external {
@@ -49,7 +51,7 @@ abstract contract Burn_Integration_Concrete_Test is Integration_Test, Lockup_Int
givenNotNull
givenStreamHasNotBeenDepleted
{
- vm.warp({ timestamp: getBlockTimestamp() - 1 seconds });
+ vm.warp({ newTimestamp: getBlockTimestamp() - 1 seconds });
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_StreamNotDepleted.selector, streamId));
lockup.burn(streamId);
}
@@ -60,7 +62,7 @@ abstract contract Burn_Integration_Concrete_Test is Integration_Test, Lockup_Int
givenNotNull
givenStreamHasNotBeenDepleted
{
- vm.warp({ timestamp: defaults.WARP_26_PERCENT() });
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_StreamNotDepleted.selector, streamId));
lockup.burn(streamId);
}
@@ -71,7 +73,7 @@ abstract contract Burn_Integration_Concrete_Test is Integration_Test, Lockup_Int
givenNotNull
givenStreamHasNotBeenDepleted
{
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_StreamNotDepleted.selector, streamId));
lockup.burn(streamId);
}
@@ -82,16 +84,16 @@ abstract contract Burn_Integration_Concrete_Test is Integration_Test, Lockup_Int
givenNotNull
givenStreamHasNotBeenDepleted
{
- vm.warp({ timestamp: defaults.CLIFF_TIME() });
- changePrank({ msgSender: users.sender });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() });
+ resetPrank({ msgSender: users.sender });
lockup.cancel(streamId);
- changePrank({ msgSender: users.recipient });
+ resetPrank({ msgSender: users.recipient });
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_StreamNotDepleted.selector, streamId));
lockup.burn(streamId);
}
modifier givenStreamHasBeenDepleted(uint256 streamId_) {
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
lockup.withdrawMax({ streamId: streamId_, to: users.recipient });
_;
}
@@ -102,7 +104,7 @@ abstract contract Burn_Integration_Concrete_Test is Integration_Test, Lockup_Int
givenNotNull
givenStreamHasBeenDepleted(streamId)
{
- changePrank({ msgSender: users.eve });
+ resetPrank({ msgSender: users.eve });
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_Unauthorized.selector, streamId, users.eve));
lockup.burn(streamId);
}
@@ -122,7 +124,7 @@ abstract contract Burn_Integration_Concrete_Test is Integration_Test, Lockup_Int
lockup.burn(streamId);
// Run the test.
- vm.expectRevert("ERC721: invalid token ID");
+ vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721NonexistentToken.selector, streamId));
lockup.burn(streamId);
}
@@ -142,7 +144,7 @@ abstract contract Burn_Integration_Concrete_Test is Integration_Test, Lockup_Int
vm.expectEmit({ emitter: address(lockup) });
emit MetadataUpdate({ _tokenId: notTransferableStreamId });
lockup.burn(notTransferableStreamId);
- vm.expectRevert("ERC721: invalid token ID");
+ vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721NonexistentToken.selector, notTransferableStreamId));
lockup.getRecipient(notTransferableStreamId);
}
@@ -163,7 +165,7 @@ abstract contract Burn_Integration_Concrete_Test is Integration_Test, Lockup_Int
lockup.approve({ to: users.operator, tokenId: streamId });
// Make the approved operator the caller in this test.
- changePrank({ msgSender: users.operator });
+ resetPrank({ msgSender: users.operator });
// Expect the relevant event to be emitted.
vm.expectEmit({ emitter: address(lockup) });
@@ -173,7 +175,7 @@ abstract contract Burn_Integration_Concrete_Test is Integration_Test, Lockup_Int
lockup.burn(streamId);
// Assert that the NFT has been burned.
- vm.expectRevert("ERC721: invalid token ID");
+ vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721NonexistentToken.selector, streamId));
lockup.getRecipient(streamId);
}
@@ -190,7 +192,7 @@ abstract contract Burn_Integration_Concrete_Test is Integration_Test, Lockup_Int
vm.expectEmit({ emitter: address(lockup) });
emit MetadataUpdate({ _tokenId: streamId });
lockup.burn(streamId);
- vm.expectRevert("ERC721: invalid token ID");
+ vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721NonexistentToken.selector, streamId));
lockup.getRecipient(streamId);
}
}
diff --git a/test/integration/concrete/lockup/burn/burn.tree b/test/integration/concrete/lockup/burn/burn.tree
index 90efa59eb..5ec96014b 100644
--- a/test/integration/concrete/lockup/burn/burn.tree
+++ b/test/integration/concrete/lockup/burn/burn.tree
@@ -2,9 +2,9 @@ burn.t.sol
├── when delegate called
│ └── it should revert
└── when not delegate called
- ├── given the id references a null stream
+ ├── given the ID references a null stream
│ └── it should revert
- └── given the id does not reference a null stream
+ └── given the ID does not reference a null stream
├── given the stream has not been depleted
│ ├── given the stream's status is "PENDING"
│ │ └── it should revert
diff --git a/test/integration/concrete/lockup/cancel-multiple/cancelMultiple.t.sol b/test/integration/concrete/lockup/cancel-multiple/cancelMultiple.t.sol
index 0e69e0b64..e0f601a1d 100644
--- a/test/integration/concrete/lockup/cancel-multiple/cancelMultiple.t.sol
+++ b/test/integration/concrete/lockup/cancel-multiple/cancelMultiple.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Solarray } from "solarray/src/Solarray.sol";
@@ -42,14 +42,14 @@ abstract contract CancelMultiple_Integration_Concrete_Test is
}
function test_RevertGiven_AllStreamsCold() external whenNotDelegateCalled whenArrayCountNotZero givenNoNull {
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_StreamSettled.selector, testStreamIds[0]));
lockup.cancelMultiple({ streamIds: testStreamIds });
}
function test_RevertGiven_SomeStreamsCold() external whenNotDelegateCalled whenArrayCountNotZero givenNoNull {
uint256 earlyStreamId = createDefaultStreamWithEndTime({ endTime: defaults.CLIFF_TIME() + 1 seconds });
- vm.warp({ timestamp: defaults.CLIFF_TIME() + 1 seconds });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() + 1 seconds });
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_StreamSettled.selector, earlyStreamId));
lockup.cancelMultiple({ streamIds: Solarray.uint256s(testStreamIds[0], earlyStreamId) });
}
@@ -63,7 +63,7 @@ abstract contract CancelMultiple_Integration_Concrete_Test is
whenCallerUnauthorized
{
// Make Eve the caller in this test.
- changePrank({ msgSender: users.eve });
+ resetPrank({ msgSender: users.eve });
// Run the test.
vm.expectRevert(
@@ -81,7 +81,7 @@ abstract contract CancelMultiple_Integration_Concrete_Test is
whenCallerUnauthorized
{
// Make the Recipient the caller in this test.
- changePrank({ msgSender: users.recipient });
+ resetPrank({ msgSender: users.recipient });
// Run the test.
vm.expectRevert(
@@ -98,7 +98,7 @@ abstract contract CancelMultiple_Integration_Concrete_Test is
givenAllStreamsWarm
whenCallerUnauthorized
{
- changePrank({ msgSender: users.eve });
+ resetPrank({ msgSender: users.eve });
// Create a stream with Eve as the stream's sender.
uint256 eveStreamId = createDefaultStreamWithSender(users.eve);
@@ -120,7 +120,7 @@ abstract contract CancelMultiple_Integration_Concrete_Test is
whenCallerUnauthorized
{
// Make the Recipient the caller in this test.
- changePrank({ msgSender: users.recipient });
+ resetPrank({ msgSender: users.recipient });
// Run the test.
vm.expectRevert(
@@ -168,13 +168,13 @@ abstract contract CancelMultiple_Integration_Concrete_Test is
givenAllStreamsCancelable
{
// Simulate the passage of time.
- vm.warp({ timestamp: defaults.WARP_26_PERCENT() });
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
// Expect the assets to be refunded to the stream's sender.
uint128 senderAmount0 = lockup.refundableAmountOf(testStreamIds[0]);
- expectCallToTransfer({ to: users.sender, amount: senderAmount0 });
+ expectCallToTransfer({ to: users.sender, value: senderAmount0 });
uint128 senderAmount1 = lockup.refundableAmountOf(testStreamIds[1]);
- expectCallToTransfer({ to: users.sender, amount: senderAmount1 });
+ expectCallToTransfer({ to: users.sender, value: senderAmount1 });
// Expect the relevant events to be emitted.
vm.expectEmit({ emitter: address(lockup) });
diff --git a/test/integration/concrete/lockup/cancel-multiple/cancelMultiple.tree b/test/integration/concrete/lockup/cancel-multiple/cancelMultiple.tree
index 2cd6a411f..b039e509f 100644
--- a/test/integration/concrete/lockup/cancel-multiple/cancelMultiple.tree
+++ b/test/integration/concrete/lockup/cancel-multiple/cancelMultiple.tree
@@ -5,11 +5,11 @@ cancelMultiple.t.sol
├── when the array count is zero
│ └── it should do nothing
└── when the array count is not zero
- ├── given the stream ids array references only null streams
+ ├── given the stream IDs array references only null streams
│ └── it should revert
- ├── given the stream ids array references some null streams
+ ├── given the stream IDs array references some null streams
│ └── it should revert
- └── given the stream ids array references only streams that are not null
+ └── given the stream IDs array references only streams that are not null
├── given all streams are cold
│ └── it should revert
├── given some streams are cold
diff --git a/test/integration/concrete/lockup/cancel/cancel.t.sol b/test/integration/concrete/lockup/cancel/cancel.t.sol
index 616e864ee..cca169686 100644
--- a/test/integration/concrete/lockup/cancel/cancel.t.sol
+++ b/test/integration/concrete/lockup/cancel/cancel.t.sol
@@ -1,8 +1,8 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
+import { ISablierLockupRecipient } from "src/interfaces/ISablierLockupRecipient.sol";
import { ISablierV2Lockup } from "src/interfaces/ISablierV2Lockup.sol";
-import { ISablierV2LockupRecipient } from "src/interfaces/hooks/ISablierV2LockupRecipient.sol";
import { Errors } from "src/libraries/Errors.sol";
import { Lockup } from "src/types/DataTypes.sol";
@@ -28,21 +28,21 @@ abstract contract Cancel_Integration_Concrete_Test is Integration_Test, Cancel_I
}
function test_RevertGiven_StatusDepleted() external whenNotDelegateCalled givenNotNull givenStreamCold {
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_StreamDepleted.selector, defaultStreamId));
lockup.cancel(defaultStreamId);
}
function test_RevertGiven_StatusCanceled() external whenNotDelegateCalled givenNotNull givenStreamCold {
- vm.warp({ timestamp: defaults.CLIFF_TIME() });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() });
lockup.cancel(defaultStreamId);
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_StreamCanceled.selector, defaultStreamId));
lockup.cancel(defaultStreamId);
}
function test_RevertGiven_StatusSettled() external whenNotDelegateCalled givenNotNull givenStreamCold {
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_StreamSettled.selector, defaultStreamId));
lockup.cancel(defaultStreamId);
}
@@ -55,7 +55,7 @@ abstract contract Cancel_Integration_Concrete_Test is Integration_Test, Cancel_I
whenCallerUnauthorized
{
// Make Eve the caller in this test.
- changePrank({ msgSender: users.eve });
+ resetPrank({ msgSender: users.eve });
// Run the test.
vm.expectRevert(
@@ -72,7 +72,7 @@ abstract contract Cancel_Integration_Concrete_Test is Integration_Test, Cancel_I
whenCallerUnauthorized
{
// Make the Recipient the caller in this test.
- changePrank({ msgSender: users.recipient });
+ resetPrank({ msgSender: users.recipient });
// Run the test.
vm.expectRevert(
@@ -95,7 +95,7 @@ abstract contract Cancel_Integration_Concrete_Test is Integration_Test, Cancel_I
function test_Cancel_StatusPending() external {
// Warp to the past.
- vm.warp({ timestamp: getBlockTimestamp() - 1 seconds });
+ vm.warp({ newTimestamp: getBlockTimestamp() - 1 seconds });
// Cancel the stream.
lockup.cancel(defaultStreamId);
@@ -110,7 +110,7 @@ abstract contract Cancel_Integration_Concrete_Test is Integration_Test, Cancel_I
assertFalse(isCancelable, "isCancelable");
}
- function test_Cancel_RecipientNotContract()
+ function test_Cancel_RecipientNotAllowedToHook()
external
whenNotDelegateCalled
givenNotNull
@@ -119,13 +119,30 @@ abstract contract Cancel_Integration_Concrete_Test is Integration_Test, Cancel_I
givenStreamCancelable
givenStatusStreaming
{
- lockup.cancel(defaultStreamId);
- Lockup.Status actualStatus = lockup.statusOf(defaultStreamId);
+ // Create the stream with a recipient contract that implements {ISablierLockupRecipient}.
+ uint256 streamId = createDefaultStreamWithRecipient(address(recipientGood));
+
+ // Expect Sablier to NOT run the recipient hook.
+ uint128 senderAmount = lockup.refundableAmountOf(streamId);
+ uint128 recipientAmount = lockup.withdrawableAmountOf(streamId);
+ vm.expectCall({
+ callee: address(recipientGood),
+ data: abi.encodeCall(
+ ISablierLockupRecipient.onSablierLockupCancel, (streamId, users.sender, senderAmount, recipientAmount)
+ ),
+ count: 0
+ });
+
+ // Cancel the stream.
+ lockup.cancel(streamId);
+
+ // Assert that the stream has been canceled.
+ Lockup.Status actualStatus = lockup.statusOf(streamId);
Lockup.Status expectedStatus = Lockup.Status.CANCELED;
assertEq(actualStatus, expectedStatus);
}
- function test_Cancel_RecipientDoesNotImplementHook()
+ function test_Cancel_RecipientReverting()
external
whenNotDelegateCalled
givenNotNull
@@ -133,31 +150,24 @@ abstract contract Cancel_Integration_Concrete_Test is Integration_Test, Cancel_I
whenCallerAuthorized
givenStreamCancelable
givenStatusStreaming
- givenRecipientContract
+ givenRecipientAllowedToHook
{
- // Create the stream with a no-op contract as the recipient.
- uint256 streamId = createDefaultStreamWithRecipient(address(noop));
+ // Allow the recipient to hook.
+ resetPrank({ msgSender: users.admin });
+ lockup.allowToHook(address(recipientReverting));
+ resetPrank({ msgSender: users.sender });
- // Expect a call to the hook.
- uint128 senderAmount = lockup.refundableAmountOf(streamId);
- uint128 recipientAmount = lockup.withdrawableAmountOf(streamId);
- vm.expectCall(
- address(noop),
- abi.encodeCall(
- ISablierV2LockupRecipient.onStreamCanceled, (streamId, users.sender, senderAmount, recipientAmount)
- )
- );
+ // Create the stream with a reverting contract as the stream's recipient.
+ uint256 streamId = createDefaultStreamWithRecipient(address(recipientReverting));
+
+ // Expect a revert.
+ vm.expectRevert("You shall not pass");
// Cancel the stream.
lockup.cancel(streamId);
-
- // Assert that the stream has been canceled.
- Lockup.Status actualStatus = lockup.statusOf(streamId);
- Lockup.Status expectedStatus = Lockup.Status.CANCELED;
- assertEq(actualStatus, expectedStatus);
}
- function test_Cancel_RecipientReverts()
+ function test_Cancel_RecipientReturnsInvalidSelector()
external
whenNotDelegateCalled
givenNotNull
@@ -165,32 +175,29 @@ abstract contract Cancel_Integration_Concrete_Test is Integration_Test, Cancel_I
whenCallerAuthorized
givenStreamCancelable
givenStatusStreaming
- givenRecipientContract
- givenRecipientImplementsHook
+ givenRecipientAllowedToHook
+ whenRecipientNotReverting
{
- // Create the stream with a reverting contract as the stream's recipient.
- uint256 streamId = createDefaultStreamWithRecipient(address(revertingRecipient));
+ // Allow the recipient to hook.
+ resetPrank({ msgSender: users.admin });
+ lockup.allowToHook(address(recipientInvalidSelector));
+ resetPrank({ msgSender: users.sender });
- // Expect a call to the hook.
- uint128 senderAmount = lockup.refundableAmountOf(streamId);
- uint128 recipientAmount = lockup.withdrawableAmountOf(streamId);
- vm.expectCall(
- address(revertingRecipient),
- abi.encodeCall(
- ISablierV2LockupRecipient.onStreamCanceled, (streamId, users.sender, senderAmount, recipientAmount)
+ // Create the stream with a recipient contract that returns invalid selector bytes on the hook call.
+ uint256 streamId = createDefaultStreamWithRecipient(address(recipientInvalidSelector));
+
+ // Expect a revert.
+ vm.expectRevert(
+ abi.encodeWithSelector(
+ Errors.SablierV2Lockup_InvalidHookSelector.selector, address(recipientInvalidSelector)
)
);
// Cancel the stream.
lockup.cancel(streamId);
-
- // Assert that the stream has been canceled.
- Lockup.Status actualStatus = lockup.statusOf(streamId);
- Lockup.Status expectedStatus = Lockup.Status.CANCELED;
- assertEq(actualStatus, expectedStatus);
}
- function test_Cancel_RecipientReentrancy()
+ function test_Cancel_RecipientReentrant()
external
whenNotDelegateCalled
givenNotNull
@@ -198,30 +205,45 @@ abstract contract Cancel_Integration_Concrete_Test is Integration_Test, Cancel_I
whenCallerAuthorized
givenStreamCancelable
givenStatusStreaming
- givenRecipientContract
- givenRecipientImplementsHook
- whenRecipientDoesNotRevert
+ givenRecipientAllowedToHook
+ whenRecipientNotReverting
+ whenRecipientReturnsSelector
{
+ // Allow the recipient to hook.
+ resetPrank({ msgSender: users.admin });
+ lockup.allowToHook(address(recipientReentrant));
+ resetPrank({ msgSender: users.sender });
+
// Create the stream with a reentrant contract as the recipient.
- uint256 streamId = createDefaultStreamWithRecipient(address(reentrantRecipient));
+ uint256 streamId = createDefaultStreamWithRecipient(address(recipientReentrant));
- // Expect a call to the hook.
+ // Expect Sablier to run the recipient hook.
uint128 senderAmount = lockup.refundableAmountOf(streamId);
uint128 recipientAmount = lockup.withdrawableAmountOf(streamId);
vm.expectCall(
- address(reentrantRecipient),
+ address(recipientReentrant),
abi.encodeCall(
- ISablierV2LockupRecipient.onStreamCanceled, (streamId, users.sender, senderAmount, recipientAmount)
+ ISablierLockupRecipient.onSablierLockupCancel, (streamId, users.sender, senderAmount, recipientAmount)
)
);
+ // Expect a reentrant call to the Lockup contract.
+ vm.expectCall(
+ address(lockup),
+ abi.encodeCall(ISablierV2Lockup.withdraw, (streamId, address(recipientReentrant), recipientAmount))
+ );
+
// Cancel the stream.
lockup.cancel(streamId);
- // Assert that the stream has been canceled.
+ // Assert that the stream has been depleted. The reentrant recipient withdrew all the funds.
Lockup.Status actualStatus = lockup.statusOf(streamId);
- Lockup.Status expectedStatus = Lockup.Status.CANCELED;
+ Lockup.Status expectedStatus = Lockup.Status.DEPLETED;
assertEq(actualStatus, expectedStatus);
+
+ // Assert that the withdrawn amount has been updated.
+ uint128 actualWithdrawnAmount = lockup.getWithdrawnAmount(streamId);
+ assertEq(actualWithdrawnAmount, recipientAmount, "withdrawnAmount");
}
function test_Cancel()
@@ -232,30 +254,35 @@ abstract contract Cancel_Integration_Concrete_Test is Integration_Test, Cancel_I
whenCallerAuthorized
givenStreamCancelable
givenStatusStreaming
- givenRecipientContract
- givenRecipientImplementsHook
- whenRecipientDoesNotRevert
- whenNoRecipientReentrancy
+ givenRecipientAllowedToHook
+ whenRecipientNotReverting
+ whenRecipientReturnsSelector
+ whenRecipientNotReentrant
{
+ // Allow the recipient to hook.
+ resetPrank({ msgSender: users.admin });
+ lockup.allowToHook(address(recipientGood));
+ resetPrank({ msgSender: users.sender });
+
// Create the stream.
- uint256 streamId = createDefaultStreamWithRecipient(address(goodRecipient));
+ uint256 streamId = createDefaultStreamWithRecipient(address(recipientGood));
// Expect the assets to be refunded to the Sender.
uint128 senderAmount = lockup.refundableAmountOf(streamId);
- expectCallToTransfer({ to: users.sender, amount: senderAmount });
+ expectCallToTransfer({ to: users.sender, value: senderAmount });
- // Expect a call to the hook.
+ // Expect Sablier to run the recipient hook.
uint128 recipientAmount = lockup.withdrawableAmountOf(streamId);
vm.expectCall(
- address(goodRecipient),
+ address(recipientGood),
abi.encodeCall(
- ISablierV2LockupRecipient.onStreamCanceled, (streamId, users.sender, senderAmount, recipientAmount)
+ ISablierLockupRecipient.onSablierLockupCancel, (streamId, users.sender, senderAmount, recipientAmount)
)
);
// Expect the relevant events to be emitted.
vm.expectEmit({ emitter: address(lockup) });
- emit CancelLockupStream(streamId, users.sender, address(goodRecipient), dai, senderAmount, recipientAmount);
+ emit CancelLockupStream(streamId, users.sender, address(recipientGood), dai, senderAmount, recipientAmount);
vm.expectEmit({ emitter: address(lockup) });
emit MetadataUpdate({ _tokenId: streamId });
@@ -278,7 +305,7 @@ abstract contract Cancel_Integration_Concrete_Test is Integration_Test, Cancel_I
// Assert that the NFT has not been burned.
address actualNFTOwner = lockup.ownerOf({ tokenId: streamId });
- address expectedNFTOwner = address(goodRecipient);
+ address expectedNFTOwner = address(recipientGood);
assertEq(actualNFTOwner, expectedNFTOwner, "NFT owner");
}
}
diff --git a/test/integration/concrete/lockup/cancel/cancel.tree b/test/integration/concrete/lockup/cancel/cancel.tree
index 491c3f2e3..dab8a48a2 100644
--- a/test/integration/concrete/lockup/cancel/cancel.tree
+++ b/test/integration/concrete/lockup/cancel/cancel.tree
@@ -2,9 +2,9 @@ cancel.t.sol
├── when delegate called
│ └── it should revert
└── when not delegate called
- ├── given the id references a null stream
+ ├── given the ID references a null stream
│ └── it should revert
- └── given the id does not reference a null stream
+ └── given the ID does not reference a null stream
├── given the stream is cold
│ ├── given the stream's status is "DEPLETED"
│ │ └── it should revert
@@ -27,34 +27,29 @@ cancel.t.sol
│ ├── it should mark the stream as depleted
│ └── it should make the stream not cancelable
└── given the stream's status is "STREAMING"
- ├── given the recipient is not a contract
+ ├── given the recipient is not allowed to hook
│ ├── it should cancel the stream
- │ └── it should mark the stream as canceled
- └── given the recipient is a contract
- ├── given the recipient does not implement the hook
- │ ├── it should cancel the stream
- │ ├── it should mark the stream as canceled
- │ ├── it should call the recipient hook
- │ └── it should ignore the revert
- └── given the recipient implements the hook
- ├── when the recipient reverts
+ │ ├── it should mark the stream as canceled
+ │ └── it should not make Sablier run the recipient hook
+ └── given the recipient is allowed to hook
+ ├── when the recipient reverts
+ │ └── it should revert the entire transaction
+ └── when the recipient does not revert
+ ├── when the recipient hook does not return a valid selector
+ │ └── it should revert
+ └── when the recipient hook returns a valid selector
+ ├── when there is reentrancy
│ ├── it should cancel the stream
│ ├── it should mark the stream as canceled
- │ ├── it should call the recipient hook
- │ └── it should ignore the revert
- └── when the recipient does not revert
- ├── when there is reentrancy
- │ ├── it should cancel the stream
- │ ├── it should mark the stream as canceled
- │ ├── it should call the recipient hook
- │ └── it should ignore the revert
- └── when there is no reentrancy
- ├── it should cancel the stream
- ├── it should mark the stream as canceled
- ├── it should make the stream not cancelable
- ├── it should update the refunded amount
- ├── it should refund the sender
- ├── it should call the recipient hook
- ├── it should emit a {MetadataUpdate} event
- └── it should emit a {CancelLockupStream} event
-
\ No newline at end of file
+ │ ├── it should make Sablier run the recipient hook
+ │ ├── it should perform a reentrancy call to the Lockup contract
+ │ └── it should make the withdrawal via the reentrancy
+ └── when there is no reentrancy
+ ├── it should cancel the stream
+ ├── it should mark the stream as canceled
+ ├── it should make the stream not cancelable
+ ├── it should update the refunded amount
+ ├── it should refund the sender
+ ├── it should make Sablier run the recipient hook
+ ├── it should emit a {MetadataUpdate} event
+ └── it should emit a {CancelLockupStream} event
diff --git a/test/integration/concrete/lockup/claim-protocol-revenues/claimProtocolRevenues.t.sol b/test/integration/concrete/lockup/claim-protocol-revenues/claimProtocolRevenues.t.sol
deleted file mode 100644
index 820ad51f9..000000000
--- a/test/integration/concrete/lockup/claim-protocol-revenues/claimProtocolRevenues.t.sol
+++ /dev/null
@@ -1,60 +0,0 @@
-// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
-
-import { Errors } from "src/libraries/Errors.sol";
-
-import { Lockup_Integration_Shared_Test } from "../../../shared/lockup/Lockup.t.sol";
-import { Integration_Test } from "../../../Integration.t.sol";
-
-abstract contract ClaimProtocolRevenues_Integration_Concrete_Test is
- Integration_Test,
- Lockup_Integration_Shared_Test
-{
- function setUp() public virtual override(Integration_Test, Lockup_Integration_Shared_Test) { }
-
- function test_RevertWhen_CallerNotAdmin() external {
- // Make Eve the caller in this test.
- changePrank({ msgSender: users.eve });
-
- // Run the test.
- vm.expectRevert(abi.encodeWithSelector(Errors.CallerNotAdmin.selector, users.admin, users.eve));
- base.claimProtocolRevenues(dai);
- }
-
- modifier whenCallerAdmin() {
- // Make the Admin the caller in the rest of this test suite.
- changePrank({ msgSender: users.admin });
- _;
- }
-
- function test_RevertGiven_ProtocolRevenuesZero() external whenCallerAdmin {
- vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Base_NoProtocolRevenues.selector, dai));
- base.claimProtocolRevenues(dai);
- }
-
- modifier givenProtocolRevenuesNotZero() {
- // Create the default stream, which will accrue revenues for the protocol.
- changePrank({ msgSender: users.sender });
- createDefaultStream();
- changePrank({ msgSender: users.admin });
- _;
- }
-
- function test_ClaimProtocolRevenues() external whenCallerAdmin givenProtocolRevenuesNotZero {
- // Expect the protocol revenues to be claimed.
- uint128 protocolRevenues = defaults.PROTOCOL_FEE_AMOUNT();
- expectCallToTransfer({ to: users.admin, amount: protocolRevenues });
-
- // Expect the relevant event to be emitted.
- vm.expectEmit({ emitter: address(base) });
- emit ClaimProtocolRevenues(users.admin, dai, protocolRevenues);
-
- // Claim the protocol revenues.
- base.claimProtocolRevenues(dai);
-
- // Assert that the protocol revenues have been set to zero.
- uint128 actualProtocolRevenues = base.protocolRevenues(dai);
- uint128 expectedProtocolRevenues = 0;
- assertEq(actualProtocolRevenues, expectedProtocolRevenues, "protocolRevenues");
- }
-}
diff --git a/test/integration/concrete/lockup/claim-protocol-revenues/claimProtocolRevenues.tree b/test/integration/concrete/lockup/claim-protocol-revenues/claimProtocolRevenues.tree
deleted file mode 100644
index 46d8c91c0..000000000
--- a/test/integration/concrete/lockup/claim-protocol-revenues/claimProtocolRevenues.tree
+++ /dev/null
@@ -1,10 +0,0 @@
-claimProtocolRevenues.t.sol
-├── when the caller is not the admin
-│ └── it should revert
-└── when the caller is the admin
- ├── given the protocol revenues are zero
- │ └── it should revert
- └── given the protocol revenues are not zero
- ├── it should claim the protocol revenues
- ├── it should update the protocol revenues
- └── it should emit a {ClaimProtocolRevenues} event
diff --git a/test/integration/concrete/lockup/get-asset/getAsset.t.sol b/test/integration/concrete/lockup/get-asset/getAsset.t.sol
index b43d23a58..082560891 100644
--- a/test/integration/concrete/lockup/get-asset/getAsset.t.sol
+++ b/test/integration/concrete/lockup/get-asset/getAsset.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
diff --git a/test/integration/concrete/lockup/get-asset/getAsset.tree b/test/integration/concrete/lockup/get-asset/getAsset.tree
index 01bde9485..fd072b636 100644
--- a/test/integration/concrete/lockup/get-asset/getAsset.tree
+++ b/test/integration/concrete/lockup/get-asset/getAsset.tree
@@ -1,5 +1,5 @@
getAsset.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
└── it should return the correct address of the asset
diff --git a/test/integration/concrete/lockup/get-deposited-amount/getDepositedAmount.t.sol b/test/integration/concrete/lockup/get-deposited-amount/getDepositedAmount.t.sol
index 97fcfd666..e418e69db 100644
--- a/test/integration/concrete/lockup/get-deposited-amount/getDepositedAmount.t.sol
+++ b/test/integration/concrete/lockup/get-deposited-amount/getDepositedAmount.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
diff --git a/test/integration/concrete/lockup/get-deposited-amount/getDepositedAmount.tree b/test/integration/concrete/lockup/get-deposited-amount/getDepositedAmount.tree
index 5254069e5..7aab0ae56 100644
--- a/test/integration/concrete/lockup/get-deposited-amount/getDepositedAmount.tree
+++ b/test/integration/concrete/lockup/get-deposited-amount/getDepositedAmount.tree
@@ -1,5 +1,5 @@
getDepositedAmount.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
└── it should return the correct deposited amount
diff --git a/test/integration/concrete/lockup/get-end-time/getEndTime.t.sol b/test/integration/concrete/lockup/get-end-time/getEndTime.t.sol
index f6c6090dc..ed3575642 100644
--- a/test/integration/concrete/lockup/get-end-time/getEndTime.t.sol
+++ b/test/integration/concrete/lockup/get-end-time/getEndTime.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
diff --git a/test/integration/concrete/lockup/get-end-time/getEndTime.tree b/test/integration/concrete/lockup/get-end-time/getEndTime.tree
index 20359c089..235fe5270 100644
--- a/test/integration/concrete/lockup/get-end-time/getEndTime.tree
+++ b/test/integration/concrete/lockup/get-end-time/getEndTime.tree
@@ -1,5 +1,5 @@
getEndTime.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
└── it should return the correct end time
diff --git a/test/integration/concrete/lockup/get-recipient/getRecipient.t.sol b/test/integration/concrete/lockup/get-recipient/getRecipient.t.sol
index 3e6c06d47..8bfcd06ae 100644
--- a/test/integration/concrete/lockup/get-recipient/getRecipient.t.sol
+++ b/test/integration/concrete/lockup/get-recipient/getRecipient.t.sol
@@ -1,5 +1,7 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
+
+import { IERC721Errors } from "@openzeppelin/contracts/interfaces/draft-IERC6093.sol";
import { Lockup_Integration_Shared_Test } from "../../../shared/lockup/Lockup.t.sol";
import { Integration_Test } from "../../../Integration.t.sol";
@@ -13,7 +15,7 @@ abstract contract GetRecipient_Integration_Concrete_Test is Integration_Test, Lo
function test_RevertGiven_Null() external {
uint256 nullStreamId = 1729;
- vm.expectRevert("ERC721: invalid token ID");
+ vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721NonexistentToken.selector, nullStreamId));
lockup.getRecipient(nullStreamId);
}
@@ -23,10 +25,10 @@ abstract contract GetRecipient_Integration_Concrete_Test is Integration_Test, Lo
function test_RevertGiven_NFTBurned() external {
// Simulate the passage of time.
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
// Make the Recipient the caller.
- changePrank({ msgSender: users.recipient });
+ resetPrank({ msgSender: users.recipient });
// Deplete the stream.
lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
@@ -35,7 +37,7 @@ abstract contract GetRecipient_Integration_Concrete_Test is Integration_Test, Lo
lockup.burn(defaultStreamId);
// Expect the relevant error when retrieving the recipient.
- vm.expectRevert("ERC721: invalid token ID");
+ vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721NonexistentToken.selector, defaultStreamId));
lockup.getRecipient(defaultStreamId);
}
@@ -43,7 +45,7 @@ abstract contract GetRecipient_Integration_Concrete_Test is Integration_Test, Lo
_;
}
- function test_GetRecipient() external givenNotNull givenNFTNotBurned {
+ function test_GetRecipient() external view givenNotNull givenNFTNotBurned {
address actualRecipient = lockup.getRecipient(defaultStreamId);
address expectedRecipient = users.recipient;
assertEq(actualRecipient, expectedRecipient, "recipient");
diff --git a/test/integration/concrete/lockup/get-recipient/getRecipient.tree b/test/integration/concrete/lockup/get-recipient/getRecipient.tree
index 5b33ed4a0..075fc23bd 100644
--- a/test/integration/concrete/lockup/get-recipient/getRecipient.tree
+++ b/test/integration/concrete/lockup/get-recipient/getRecipient.tree
@@ -1,7 +1,7 @@
getRecipient.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
├── given the NFT has been burned
│ └── it should revert
└── given the NFT has not been burned
diff --git a/test/integration/concrete/lockup/get-refunded-amount/getRefundedAmount.t.sol b/test/integration/concrete/lockup/get-refunded-amount/getRefundedAmount.t.sol
index 70951a7e8..c35abea37 100644
--- a/test/integration/concrete/lockup/get-refunded-amount/getRefundedAmount.t.sol
+++ b/test/integration/concrete/lockup/get-refunded-amount/getRefundedAmount.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
@@ -31,7 +31,7 @@ abstract contract GetRefundedAmount_Integration_Concrete_Test is Integration_Tes
givenNotNull
givenStreamHasBeenCanceled
{
- vm.warp({ timestamp: defaults.CLIFF_TIME() });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() });
lockup.cancel(defaultStreamId);
uint128 actualRefundedAmount = lockup.getRefundedAmount(defaultStreamId);
uint128 expectedRefundedAmount = defaults.REFUND_AMOUNT();
@@ -43,7 +43,7 @@ abstract contract GetRefundedAmount_Integration_Concrete_Test is Integration_Tes
givenNotNull
givenStreamHasBeenCanceled
{
- vm.warp({ timestamp: defaults.CLIFF_TIME() });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() });
lockup.cancel(defaultStreamId);
lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
uint128 actualRefundedAmount = lockup.getRefundedAmount(defaultStreamId);
@@ -56,28 +56,28 @@ abstract contract GetRefundedAmount_Integration_Concrete_Test is Integration_Tes
}
function test_GetRefundedAmount_StatusPending() external givenNotNull givenStreamHasNotBeenCanceled {
- vm.warp({ timestamp: getBlockTimestamp() - 1 seconds });
+ vm.warp({ newTimestamp: getBlockTimestamp() - 1 seconds });
uint128 actualRefundedAmount = lockup.getRefundedAmount(defaultStreamId);
uint128 expectedRefundedAmount = 0;
assertEq(actualRefundedAmount, expectedRefundedAmount, "refundedAmount");
}
function test_GetRefundedAmount_StatusStreaming() external givenNotNull givenStreamHasNotBeenCanceled {
- vm.warp({ timestamp: defaults.WARP_26_PERCENT() });
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
uint128 actualRefundedAmount = lockup.getRefundedAmount(defaultStreamId);
uint128 expectedRefundedAmount = 0;
assertEq(actualRefundedAmount, expectedRefundedAmount, "refundedAmount");
}
function test_GetRefundedAmount_StatusSettled() external givenNotNull givenStreamHasNotBeenCanceled {
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
uint128 actualRefundedAmount = lockup.getRefundedAmount(defaultStreamId);
uint128 expectedRefundedAmount = 0;
assertEq(actualRefundedAmount, expectedRefundedAmount, "refundedAmount");
}
function test_GetRefundedAmount_StatusDepleted() external givenNotNull givenStreamHasNotBeenCanceled {
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
uint128 actualRefundedAmount = lockup.getRefundedAmount(defaultStreamId);
uint128 expectedRefundedAmount = 0;
diff --git a/test/integration/concrete/lockup/get-refunded-amount/getRefundedAmount.tree b/test/integration/concrete/lockup/get-refunded-amount/getRefundedAmount.tree
index 3a8aa8645..0ab67e853 100644
--- a/test/integration/concrete/lockup/get-refunded-amount/getRefundedAmount.tree
+++ b/test/integration/concrete/lockup/get-refunded-amount/getRefundedAmount.tree
@@ -1,7 +1,7 @@
getRefundedAmount.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
├── given the stream has been canceled
│ ├── given the stream's status is "CANCELED"
│ │ └── it should return the correct refunded amount
diff --git a/test/integration/concrete/lockup/get-sender/getSender.t.sol b/test/integration/concrete/lockup/get-sender/getSender.t.sol
index f4a008439..713c4f1eb 100644
--- a/test/integration/concrete/lockup/get-sender/getSender.t.sol
+++ b/test/integration/concrete/lockup/get-sender/getSender.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
diff --git a/test/integration/concrete/lockup/get-sender/getSender.tree b/test/integration/concrete/lockup/get-sender/getSender.tree
index 50160b661..65b9b412a 100644
--- a/test/integration/concrete/lockup/get-sender/getSender.tree
+++ b/test/integration/concrete/lockup/get-sender/getSender.tree
@@ -1,5 +1,5 @@
getSender.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
└── it should return the correct sender
diff --git a/test/integration/concrete/lockup/get-start-time/getStartTime.t.sol b/test/integration/concrete/lockup/get-start-time/getStartTime.t.sol
index 910091a40..e31b8d734 100644
--- a/test/integration/concrete/lockup/get-start-time/getStartTime.t.sol
+++ b/test/integration/concrete/lockup/get-start-time/getStartTime.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
diff --git a/test/integration/concrete/lockup/get-start-time/getStartTime.tree b/test/integration/concrete/lockup/get-start-time/getStartTime.tree
index d65e107ab..a0c4f6da7 100644
--- a/test/integration/concrete/lockup/get-start-time/getStartTime.tree
+++ b/test/integration/concrete/lockup/get-start-time/getStartTime.tree
@@ -1,5 +1,5 @@
getStartTime.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
└── it should return the correct start time
diff --git a/test/integration/concrete/lockup/get-withdrawn-amount/getWithdrawnAmount.t.sol b/test/integration/concrete/lockup/get-withdrawn-amount/getWithdrawnAmount.t.sol
index a7d636336..d7cc37828 100644
--- a/test/integration/concrete/lockup/get-withdrawn-amount/getWithdrawnAmount.t.sol
+++ b/test/integration/concrete/lockup/get-withdrawn-amount/getWithdrawnAmount.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
@@ -22,7 +22,7 @@ abstract contract GetWithdrawnAmount_Integration_Concrete_Test is
function test_GetWithdrawnAmount_NoPreviousWithdrawals() external givenNotNull {
// Simulate the passage of time.
- vm.warp({ timestamp: defaults.WARP_26_PERCENT() });
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
// Assert that the withdrawn amount has been updated.
uint128 actualWithdrawnAmount = lockup.getWithdrawnAmount(defaultStreamId);
@@ -32,7 +32,7 @@ abstract contract GetWithdrawnAmount_Integration_Concrete_Test is
function test_GetWithdrawnAmount() external givenNotNull givenPreviousWithdrawals {
// Simulate the passage of time.
- vm.warp({ timestamp: defaults.WARP_26_PERCENT() });
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
// Set the withdraw amount to the streamed amount.
uint128 withdrawAmount = lockup.streamedAmountOf(defaultStreamId);
diff --git a/test/integration/concrete/lockup/get-withdrawn-amount/getWithdrawnAmount.tree b/test/integration/concrete/lockup/get-withdrawn-amount/getWithdrawnAmount.tree
index 2a88d73c9..ca78cb978 100644
--- a/test/integration/concrete/lockup/get-withdrawn-amount/getWithdrawnAmount.tree
+++ b/test/integration/concrete/lockup/get-withdrawn-amount/getWithdrawnAmount.tree
@@ -1,7 +1,7 @@
getWithdrawnAmount.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
├── given there are no previous withdrawals
│ └── it should return zero
└── given there are previous withdrawals
diff --git a/test/integration/concrete/lockup/is-allowed-to-hook/isAllowedToHook.t.sol b/test/integration/concrete/lockup/is-allowed-to-hook/isAllowedToHook.t.sol
new file mode 100644
index 000000000..ed92d5fcb
--- /dev/null
+++ b/test/integration/concrete/lockup/is-allowed-to-hook/isAllowedToHook.t.sol
@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22 <0.9.0;
+
+import { Lockup_Integration_Shared_Test } from "../../../shared/lockup/Lockup.t.sol";
+import { Integration_Test } from "../../../Integration.t.sol";
+
+abstract contract IsAllowedToHook_Integration_Concrete_Test is Integration_Test, Lockup_Integration_Shared_Test {
+ uint256 internal defaultStreamId;
+
+ function setUp() public virtual override(Integration_Test, Lockup_Integration_Shared_Test) {
+ defaultStreamId = createDefaultStream();
+ }
+
+ function test_IsAllowedToHook_GivenProvidedAddressIsNotAllowedToHook() external view {
+ bool result = lockup.isAllowedToHook(address(recipientGood));
+ assertFalse(result, "isAllowedToHook");
+ }
+
+ modifier givenProvidedAddressIsAllowedToHook() {
+ resetPrank({ msgSender: users.admin });
+ lockup.allowToHook(address(recipientGood));
+ _;
+ }
+
+ function test_IsAllowedToHook() external givenProvidedAddressIsAllowedToHook {
+ bool result = lockup.isAllowedToHook(address(recipientGood));
+ assertTrue(result, "isAllowedToHook");
+ }
+}
diff --git a/test/integration/concrete/lockup/is-allowed-to-hook/isAllowedToHook.tree b/test/integration/concrete/lockup/is-allowed-to-hook/isAllowedToHook.tree
new file mode 100644
index 000000000..9196064ef
--- /dev/null
+++ b/test/integration/concrete/lockup/is-allowed-to-hook/isAllowedToHook.tree
@@ -0,0 +1,5 @@
+isAllowedToHook.tree
+├── given the provided address is not allowed to hook
+│ └── it should return false
+└── given the provided address is allowed to hook
+ └── it should return true
diff --git a/test/integration/concrete/lockup/is-cancelable/isCancelable.t.sol b/test/integration/concrete/lockup/is-cancelable/isCancelable.t.sol
index b773ade31..5f0bf9c48 100644
--- a/test/integration/concrete/lockup/is-cancelable/isCancelable.t.sol
+++ b/test/integration/concrete/lockup/is-cancelable/isCancelable.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
@@ -23,7 +23,7 @@ abstract contract IsCancelable_Integration_Concrete_Test is Integration_Test, Lo
}
function test_IsCancelable_Cold() external givenNotNull {
- vm.warp({ timestamp: defaults.END_TIME() }); // settled status
+ vm.warp({ newTimestamp: defaults.END_TIME() }); // settled status
bool isCancelable = lockup.isCancelable(defaultStreamId);
assertFalse(isCancelable, "isCancelable");
}
diff --git a/test/integration/concrete/lockup/is-cancelable/isCancelable.tree b/test/integration/concrete/lockup/is-cancelable/isCancelable.tree
index 8a36d6dbe..c75cda4f3 100644
--- a/test/integration/concrete/lockup/is-cancelable/isCancelable.tree
+++ b/test/integration/concrete/lockup/is-cancelable/isCancelable.tree
@@ -1,7 +1,7 @@
isCancelable.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
├── given the stream is cold
│ └── it should return true
└── given the stream is not cold
diff --git a/test/integration/concrete/lockup/is-cold/isCold.t.sol b/test/integration/concrete/lockup/is-cold/isCold.t.sol
index 214512228..ebb99badb 100644
--- a/test/integration/concrete/lockup/is-cold/isCold.t.sol
+++ b/test/integration/concrete/lockup/is-cold/isCold.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
@@ -23,32 +23,32 @@ abstract contract IsCold_Integration_Concrete_Test is Integration_Test, Lockup_I
}
function test_IsCold_StatusPending() external givenNotNull {
- vm.warp({ timestamp: getBlockTimestamp() - 1 seconds });
+ vm.warp({ newTimestamp: getBlockTimestamp() - 1 seconds });
bool isCold = lockup.isCold(defaultStreamId);
assertFalse(isCold, "isCold");
}
function test_IsCold_StatusStreaming() external givenNotNull {
- vm.warp({ timestamp: defaults.WARP_26_PERCENT() });
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
bool isCold = lockup.isCold(defaultStreamId);
assertFalse(isCold, "isCold");
}
function test_IsCold_StatusSettled() external givenNotNull {
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
bool isCold = lockup.isCold(defaultStreamId);
assertTrue(isCold, "isCold");
}
function test_IsCold_StatusCanceled() external givenNotNull {
- vm.warp({ timestamp: defaults.CLIFF_TIME() });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() });
lockup.cancel(defaultStreamId);
bool isCold = lockup.isCold(defaultStreamId);
assertTrue(isCold, "isCold");
}
function test_IsCold_StatusDepleted() external givenNotNull {
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
bool isCold = lockup.isCold(defaultStreamId);
assertTrue(isCold, "isCold");
diff --git a/test/integration/concrete/lockup/is-cold/isCold.tree b/test/integration/concrete/lockup/is-cold/isCold.tree
index 15bfe3fdc..5902b8b9f 100644
--- a/test/integration/concrete/lockup/is-cold/isCold.tree
+++ b/test/integration/concrete/lockup/is-cold/isCold.tree
@@ -1,7 +1,7 @@
isCold.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
├── given the stream's status is pending
│ └── it should return false
├── given the stream's status is streaming
diff --git a/test/integration/concrete/lockup/is-depleted/isDepleted.t.sol b/test/integration/concrete/lockup/is-depleted/isDepleted.t.sol
index 6d969a5e8..0ba5d78c6 100644
--- a/test/integration/concrete/lockup/is-depleted/isDepleted.t.sol
+++ b/test/integration/concrete/lockup/is-depleted/isDepleted.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
@@ -28,7 +28,7 @@ abstract contract IsDepleted_Integration_Concrete_Test is Integration_Test, Lock
}
modifier givenStreamDepleted() {
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
_;
}
diff --git a/test/integration/concrete/lockup/is-depleted/isDepleted.tree b/test/integration/concrete/lockup/is-depleted/isDepleted.tree
index 43149d5aa..3b796bd0c 100644
--- a/test/integration/concrete/lockup/is-depleted/isDepleted.tree
+++ b/test/integration/concrete/lockup/is-depleted/isDepleted.tree
@@ -1,7 +1,7 @@
isDepleted.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
├── given the stream is not depleted
│ └── it should return false
└── given the stream is depleted
diff --git a/test/integration/concrete/lockup/is-stream/isStream.t.sol b/test/integration/concrete/lockup/is-stream/isStream.t.sol
index fd44ba2ce..ac4f349a2 100644
--- a/test/integration/concrete/lockup/is-stream/isStream.t.sol
+++ b/test/integration/concrete/lockup/is-stream/isStream.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Lockup_Integration_Shared_Test } from "../../../shared/lockup/Lockup.t.sol";
import { Integration_Test } from "../../../Integration.t.sol";
@@ -9,7 +9,7 @@ abstract contract IsStream_Integration_Concrete_Test is Integration_Test, Lockup
function setUp() public virtual override(Integration_Test, Lockup_Integration_Shared_Test) { }
- function test_IsStream_Null() external {
+ function test_IsStream_Null() external view {
uint256 nullStreamId = 1729;
bool isStream = lockup.isStream(nullStreamId);
assertFalse(isStream, "isStream");
diff --git a/test/integration/concrete/lockup/is-stream/isStream.tree b/test/integration/concrete/lockup/is-stream/isStream.tree
index 5846352f8..83ae45765 100644
--- a/test/integration/concrete/lockup/is-stream/isStream.tree
+++ b/test/integration/concrete/lockup/is-stream/isStream.tree
@@ -1,5 +1,5 @@
isStream.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should return false
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
└── it should return true
diff --git a/test/integration/concrete/lockup/is-transferable/isTransferable.t.sol b/test/integration/concrete/lockup/is-transferable/isTransferable.t.sol
index e36599786..e32d1f0f9 100644
--- a/test/integration/concrete/lockup/is-transferable/isTransferable.t.sol
+++ b/test/integration/concrete/lockup/is-transferable/isTransferable.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
diff --git a/test/integration/concrete/lockup/is-transferable/isTransferable.tree b/test/integration/concrete/lockup/is-transferable/isTransferable.tree
index 2fefdc265..aba57c19d 100644
--- a/test/integration/concrete/lockup/is-transferable/isTransferable.tree
+++ b/test/integration/concrete/lockup/is-transferable/isTransferable.tree
@@ -1,7 +1,7 @@
isTransferable.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
├── given the stream is not transferable
│ └── it should return false
└── given the stream is transferable
diff --git a/test/integration/concrete/lockup/is-warm/isWarm.t.sol b/test/integration/concrete/lockup/is-warm/isWarm.t.sol
index 91e2c934d..e784adc4c 100644
--- a/test/integration/concrete/lockup/is-warm/isWarm.t.sol
+++ b/test/integration/concrete/lockup/is-warm/isWarm.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
@@ -23,32 +23,32 @@ abstract contract IsWarm_Integration_Concrete_Test is Integration_Test, Lockup_I
}
function test_IsWarm_StatusPending() external givenNotNull {
- vm.warp({ timestamp: getBlockTimestamp() - 1 seconds });
+ vm.warp({ newTimestamp: getBlockTimestamp() - 1 seconds });
bool isWarm = lockup.isWarm(defaultStreamId);
assertTrue(isWarm, "isWarm");
}
function test_IsWarm_StatusStreaming() external givenNotNull {
- vm.warp({ timestamp: defaults.WARP_26_PERCENT() });
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
bool isWarm = lockup.isWarm(defaultStreamId);
assertTrue(isWarm, "isWarm");
}
function test_IsWarm_StatusSettled() external givenNotNull {
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
bool isWarm = lockup.isWarm(defaultStreamId);
assertFalse(isWarm, "isWarm");
}
function test_IsWarm_StatusCanceled() external givenNotNull {
- vm.warp({ timestamp: defaults.CLIFF_TIME() });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() });
lockup.cancel(defaultStreamId);
bool isWarm = lockup.isWarm(defaultStreamId);
assertFalse(isWarm, "isWarm");
}
function test_IsWarm_StatusDepleted() external givenNotNull {
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
bool isWarm = lockup.isWarm(defaultStreamId);
assertFalse(isWarm, "isWarm");
diff --git a/test/integration/concrete/lockup/is-warm/isWarm.tree b/test/integration/concrete/lockup/is-warm/isWarm.tree
index be21fe1d1..7044432bb 100644
--- a/test/integration/concrete/lockup/is-warm/isWarm.tree
+++ b/test/integration/concrete/lockup/is-warm/isWarm.tree
@@ -1,7 +1,7 @@
isWarm.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
├── given the stream's status is pending
│ └── it should return true
├── given the stream's status is streaming
diff --git a/test/integration/concrete/lockup/protocol-revenues/protocolRevenues.t.sol b/test/integration/concrete/lockup/protocol-revenues/protocolRevenues.t.sol
deleted file mode 100644
index b42cbe56b..000000000
--- a/test/integration/concrete/lockup/protocol-revenues/protocolRevenues.t.sol
+++ /dev/null
@@ -1,29 +0,0 @@
-// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
-
-import { Lockup_Integration_Shared_Test } from "../../../shared/lockup/Lockup.t.sol";
-import { Integration_Test } from "../../../Integration.t.sol";
-
-abstract contract ProtocolRevenues_Integration_Concrete_Test is Integration_Test, Lockup_Integration_Shared_Test {
- function setUp() public virtual override(Integration_Test, Lockup_Integration_Shared_Test) { }
-
- function test_ProtocolRevenues_ProtocolRevenuesZero() external {
- uint128 actualProtocolRevenues = base.protocolRevenues(dai);
- uint128 expectedProtocolRevenues = 0;
- assertEq(actualProtocolRevenues, expectedProtocolRevenues, "protocolRevenues");
- }
-
- modifier givenProtocolRevenuesNotZero() {
- // Create the default stream, which will accrue revenues for the protocol.
- changePrank({ msgSender: users.sender });
- createDefaultStream();
- changePrank({ msgSender: users.admin });
- _;
- }
-
- function test_ProtocolRevenues() external givenProtocolRevenuesNotZero {
- uint128 actualProtocolRevenues = base.protocolRevenues(dai);
- uint128 expectedProtocolRevenues = defaults.PROTOCOL_FEE_AMOUNT();
- assertEq(actualProtocolRevenues, expectedProtocolRevenues, "protocolRevenues");
- }
-}
diff --git a/test/integration/concrete/lockup/protocol-revenues/protocolRevenues.tree b/test/integration/concrete/lockup/protocol-revenues/protocolRevenues.tree
deleted file mode 100644
index 7c575e2f0..000000000
--- a/test/integration/concrete/lockup/protocol-revenues/protocolRevenues.tree
+++ /dev/null
@@ -1,5 +0,0 @@
-protocolRevenues.t.sol
-├── given the protocol revenues are zero
-│ └── it should return zero
-└── given the protocol revenues are not zero
- └── it should return the correct protocol revenues
diff --git a/test/integration/concrete/lockup/refundable-amount-of/refundableAmountOf.t.sol b/test/integration/concrete/lockup/refundable-amount-of/refundableAmountOf.t.sol
index df7d7381e..698e03894 100644
--- a/test/integration/concrete/lockup/refundable-amount-of/refundableAmountOf.t.sol
+++ b/test/integration/concrete/lockup/refundable-amount-of/refundableAmountOf.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
@@ -24,7 +24,7 @@ abstract contract RefundableAmountOf_Integration_Concrete_Test is Integration_Te
function test_RefundableAmountOf_StreamNotCancelable() external givenNotNull {
uint256 streamId = createDefaultStreamNotCancelable();
- vm.warp({ timestamp: defaults.CLIFF_TIME() });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() });
uint128 actualRefundableAmount = lockup.refundableAmountOf(streamId);
uint128 expectedRefundableAmount = 0;
assertEq(actualRefundableAmount, expectedRefundableAmount, "refundableAmount");
@@ -44,7 +44,7 @@ abstract contract RefundableAmountOf_Integration_Concrete_Test is Integration_Te
givenStreamIsCancelable
givenStreamHasBeenCanceled
{
- vm.warp({ timestamp: defaults.CLIFF_TIME() });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() });
lockup.cancel(defaultStreamId);
uint128 actualRefundableAmount = lockup.refundableAmountOf(defaultStreamId);
uint128 expectedRefundableAmount = 0;
@@ -58,10 +58,10 @@ abstract contract RefundableAmountOf_Integration_Concrete_Test is Integration_Te
givenStreamIsCancelable
givenStreamHasBeenCanceled
{
- vm.warp({ timestamp: defaults.CLIFF_TIME() });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() });
lockup.cancel(defaultStreamId);
lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
- vm.warp({ timestamp: defaults.CLIFF_TIME() + 10 seconds });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() + 10 seconds });
uint128 actualRefundableAmount = lockup.refundableAmountOf(defaultStreamId);
uint128 expectedRefundableAmount = 0;
assertEq(actualRefundableAmount, expectedRefundableAmount, "refundableAmount");
@@ -77,7 +77,7 @@ abstract contract RefundableAmountOf_Integration_Concrete_Test is Integration_Te
givenStreamIsCancelable
givenStreamHasNotBeenCanceled
{
- vm.warp({ timestamp: getBlockTimestamp() - 1 seconds });
+ vm.warp({ newTimestamp: getBlockTimestamp() - 1 seconds });
uint128 actualRefundableAmount = lockup.refundableAmountOf(defaultStreamId);
uint128 expectedReturnableAmount = defaults.DEPOSIT_AMOUNT();
assertEq(actualRefundableAmount, expectedReturnableAmount, "refundableAmount");
@@ -89,7 +89,7 @@ abstract contract RefundableAmountOf_Integration_Concrete_Test is Integration_Te
givenStreamIsCancelable
givenStreamHasNotBeenCanceled
{
- vm.warp({ timestamp: defaults.CLIFF_TIME() });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() });
uint128 actualRefundableAmount = lockup.refundableAmountOf(defaultStreamId);
uint128 expectedReturnableAmount = defaults.REFUND_AMOUNT();
assertEq(actualRefundableAmount, expectedReturnableAmount, "refundableAmount");
@@ -101,7 +101,7 @@ abstract contract RefundableAmountOf_Integration_Concrete_Test is Integration_Te
givenStreamIsCancelable
givenStreamHasNotBeenCanceled
{
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
uint128 actualRefundableAmount = lockup.refundableAmountOf(defaultStreamId);
uint128 expectedReturnableAmount = 0;
assertEq(actualRefundableAmount, expectedReturnableAmount, "refundableAmount");
@@ -113,7 +113,7 @@ abstract contract RefundableAmountOf_Integration_Concrete_Test is Integration_Te
givenStreamIsCancelable
givenStreamHasNotBeenCanceled
{
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
uint128 actualRefundableAmount = lockup.refundableAmountOf(defaultStreamId);
uint128 expectedReturnableAmount = 0;
diff --git a/test/integration/concrete/lockup/refundable-amount-of/refundableAmountOf.tree b/test/integration/concrete/lockup/refundable-amount-of/refundableAmountOf.tree
index ebfdbcdad..e46acad0d 100644
--- a/test/integration/concrete/lockup/refundable-amount-of/refundableAmountOf.tree
+++ b/test/integration/concrete/lockup/refundable-amount-of/refundableAmountOf.tree
@@ -1,7 +1,7 @@
refundableAmountOf.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
├── given the stream is not cancelable
│ └── it should return zero
└── given the stream is cancelable
diff --git a/test/integration/concrete/lockup/renounce/renounce.t.sol b/test/integration/concrete/lockup/renounce/renounce.t.sol
index 7340dc66b..b6b91fed1 100644
--- a/test/integration/concrete/lockup/renounce/renounce.t.sol
+++ b/test/integration/concrete/lockup/renounce/renounce.t.sol
@@ -1,8 +1,7 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { ISablierV2Lockup } from "src/interfaces/ISablierV2Lockup.sol";
-import { ISablierV2LockupRecipient } from "src/interfaces/hooks/ISablierV2LockupRecipient.sol";
import { Errors } from "src/libraries/Errors.sol";
import { Lockup_Integration_Shared_Test } from "../../../shared/lockup/Lockup.t.sol";
@@ -40,37 +39,37 @@ abstract contract Renounce_Integration_Concrete_Test is Integration_Test, Lockup
}
function test_RevertGiven_StatusDepleted() external whenNotDelegateCalled givenStreamCold {
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_StreamDepleted.selector, defaultStreamId));
lockup.renounce(defaultStreamId);
}
function test_RevertGiven_StatusCanceled() external whenNotDelegateCalled givenStreamCold {
- vm.warp({ timestamp: defaults.CLIFF_TIME() });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() });
lockup.cancel(defaultStreamId);
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_StreamCanceled.selector, defaultStreamId));
lockup.renounce(defaultStreamId);
}
function test_RevertGiven_StatusSettled() external whenNotDelegateCalled givenStreamCold {
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_StreamSettled.selector, defaultStreamId));
lockup.renounce(defaultStreamId);
}
/// @dev This modifier runs the test twice: once with a "PENDING" status, and once with a "STREAMING" status.
modifier givenStreamWarm() {
- vm.warp({ timestamp: getBlockTimestamp() - 1 seconds });
+ vm.warp({ newTimestamp: getBlockTimestamp() - 1 seconds });
_;
- vm.warp({ timestamp: defaults.START_TIME() });
+ vm.warp({ newTimestamp: defaults.START_TIME() });
defaultStreamId = createDefaultStream();
_;
}
function test_RevertWhen_CallerNotSender() external whenNotDelegateCalled givenStreamWarm {
// Make Eve the caller in this test.
- changePrank({ msgSender: users.eve });
+ resetPrank({ msgSender: users.eve });
// Run the test.
vm.expectRevert(
@@ -98,123 +97,9 @@ abstract contract Renounce_Integration_Concrete_Test is Integration_Test, Lockup
_;
}
- function test_Renounce_RecipientNotContract()
- external
- whenNotDelegateCalled
- givenStreamWarm
- whenCallerSender
- givenStreamCancelable
- {
- lockup.renounce(defaultStreamId);
- bool isCancelable = lockup.isCancelable(defaultStreamId);
- assertFalse(isCancelable, "isCancelable");
- }
-
- modifier givenRecipientContract() {
- _;
- }
-
- function test_Renounce_RecipientDoesNotImplementHook()
- external
- whenNotDelegateCalled
- givenStreamWarm
- whenCallerSender
- givenStreamCancelable
- givenRecipientContract
- {
- // Create the stream with a no-op contract as the stream's recipient.
- uint256 streamId = createDefaultStreamWithRecipient(address(noop));
-
- // Expect a call to the hook.
- vm.expectCall(address(noop), abi.encodeCall(ISablierV2LockupRecipient.onStreamRenounced, (streamId)));
-
- // Renounce the stream.
- lockup.renounce(streamId);
-
- // Assert that the stream is not cancelable anymore.
- bool isCancelable = lockup.isCancelable(streamId);
- assertFalse(isCancelable, "isCancelable");
- }
-
- modifier givenRecipientImplementsHook() {
- _;
- }
-
- function test_Renounce_RecipientReverts()
- external
- whenNotDelegateCalled
- givenStreamWarm
- whenCallerSender
- givenStreamCancelable
- givenRecipientContract
- givenRecipientImplementsHook
- {
- // Create the stream with a reverting contract as the stream's recipient.
- uint256 streamId = createDefaultStreamWithRecipient(address(revertingRecipient));
-
- // Expect a call to the hook.
- vm.expectCall(
- address(revertingRecipient), abi.encodeCall(ISablierV2LockupRecipient.onStreamRenounced, (streamId))
- );
-
- // Renounce the stream.
- lockup.renounce(streamId);
-
- // Assert that the stream is not cancelable anymore.
- bool isCancelable = lockup.isCancelable(streamId);
- assertFalse(isCancelable, "isCancelable");
- }
-
- modifier whenRecipientDoesNotRevert() {
- _;
- }
-
- function test_Renounce_RecipientReentrancy()
- external
- whenNotDelegateCalled
- givenStreamWarm
- whenCallerSender
- givenStreamCancelable
- givenRecipientContract
- givenRecipientImplementsHook
- whenRecipientDoesNotRevert
- {
- // Create the stream with a reentrant contract as the stream's recipient.
- uint256 streamId = createDefaultStreamWithRecipient(address(reentrantRecipient));
-
- // Expect a call to the hook.
- vm.expectCall(
- address(reentrantRecipient), abi.encodeCall(ISablierV2LockupRecipient.onStreamRenounced, (streamId))
- );
-
- // Renounce the stream.
- lockup.renounce(streamId);
-
- // Assert that the stream is not cancelable anymore.
- bool isCancelable = lockup.isCancelable(streamId);
- assertFalse(isCancelable, "isCancelable");
- }
-
- modifier whenNoRecipientReentrancy() {
- _;
- }
-
- function test_Renounce()
- external
- whenNotDelegateCalled
- givenStreamWarm
- whenCallerSender
- givenStreamCancelable
- givenRecipientContract
- givenRecipientImplementsHook
- whenRecipientDoesNotRevert
- whenNoRecipientReentrancy
- {
+ function test_Renounce() external whenNotDelegateCalled givenStreamWarm whenCallerSender givenStreamCancelable {
// Create the stream with a contract as the stream's recipient.
- uint256 streamId = createDefaultStreamWithRecipient(address(goodRecipient));
-
- // Expect a call to the hook.
- vm.expectCall(address(goodRecipient), abi.encodeCall(ISablierV2LockupRecipient.onStreamRenounced, (streamId)));
+ uint256 streamId = createDefaultStreamWithRecipient(address(recipientGood));
// Expect the relevant events to be emitted.
vm.expectEmit({ emitter: address(lockup) });
diff --git a/test/integration/concrete/lockup/renounce/renounce.tree b/test/integration/concrete/lockup/renounce/renounce.tree
index be03dbc40..f354e61c6 100644
--- a/test/integration/concrete/lockup/renounce/renounce.tree
+++ b/test/integration/concrete/lockup/renounce/renounce.tree
@@ -2,9 +2,9 @@ renounce.t.sol
├── when delegate called
│ └── it should revert
└── when not delegate called
- ├── given the id references a null stream
+ ├── given the ID references a null stream
│ └── it should revert
- └── given the id does not reference a null stream
+ └── given the ID does not reference a null stream
├── given the stream is cold
│ ├── given the stream's status is "DEPLETED"
│ │ └── it should revert
@@ -16,25 +16,9 @@ renounce.t.sol
├── when the caller is not the sender
│ └── it should revert
└── when the caller is the sender
- ├── given the recipient is not a contract
- │ └── it should renounce the stream
- └── given the recipient is a contract
- ├── given the recipient does not implement the hook
- │ ├── it should renounce the stream
- │ ├── it should call the recipient hook
- │ └── it should ignore the revert
- └── given the recipient implements the hook
- ├── when the recipient reverts
- │ ├── it should renounce the stream
- │ ├── it should call the recipient hook
- │ └── it should ignore the revert
- └── when the recipient does not revert
- ├── when there is reentrancy
- │ ├── it should renounce the stream
- │ ├── it should call the recipient hook
- │ └── it should ignore the revert
- └── when there is no reentrancy
- ├── it should renounce the stream
- ├── it should call the recipient hook
- ├── it should emit a {RenounceLockupStream} event
- └── it should emit a {MetadataUpdate} event
+ ├── given the stream is not cancelable
+ │ └── it should revert
+ └── given the stream is cancelable
+ ├── it should renounce the stream
+ ├── it should emit a {RenounceLockupStream} event
+ └── it should emit a {MetadataUpdate} event
diff --git a/test/integration/concrete/lockup/set-comptroller/setComptroller.t.sol b/test/integration/concrete/lockup/set-comptroller/setComptroller.t.sol
deleted file mode 100644
index 0773070bc..000000000
--- a/test/integration/concrete/lockup/set-comptroller/setComptroller.t.sol
+++ /dev/null
@@ -1,59 +0,0 @@
-// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
-
-import { ISablierV2Comptroller } from "src/interfaces/ISablierV2Comptroller.sol";
-import { Errors } from "src/libraries/Errors.sol";
-import { SablierV2Comptroller } from "src/SablierV2Comptroller.sol";
-
-import { Lockup_Integration_Shared_Test } from "../../../shared/lockup/Lockup.t.sol";
-import { Integration_Test } from "../../../Integration.t.sol";
-
-abstract contract SetComptroller_Integration_Concrete_Test is Integration_Test, Lockup_Integration_Shared_Test {
- function setUp() public virtual override(Integration_Test, Lockup_Integration_Shared_Test) { }
-
- function test_RevertWhen_CallerNotAdmin() external {
- // Make Eve the caller in this test.
- changePrank({ msgSender: users.eve });
-
- // Run the test.
- vm.expectRevert(abi.encodeWithSelector(Errors.CallerNotAdmin.selector, users.admin, users.eve));
- base.setComptroller(ISablierV2Comptroller(users.eve));
- }
-
- modifier whenCallerAdmin() {
- // Make the Admin the caller in the rest of this test suite.
- changePrank({ msgSender: users.admin });
- _;
- }
-
- function test_SetComptroller_SameComptroller() external whenCallerAdmin {
- // Expect the relevant event to be emitted.
- vm.expectEmit({ emitter: address(base) });
- emit SetComptroller(users.admin, comptroller, comptroller);
-
- // Re-set the comptroller.
- base.setComptroller(comptroller);
-
- // Assert that the comptroller has not been changed.
- address actualComptroller = address(base.comptroller());
- address expectedComptroller = address(comptroller);
- assertEq(actualComptroller, expectedComptroller, "comptroller");
- }
-
- function test_SetComptroller_NewComptroller() external whenCallerAdmin {
- // Deploy the new comptroller.
- ISablierV2Comptroller newComptroller = new SablierV2Comptroller({ initialAdmin: users.admin });
-
- // Expect the relevant event to be emitted.
- vm.expectEmit({ emitter: address(base) });
- emit SetComptroller(users.admin, comptroller, newComptroller);
-
- // Set the new comptroller.
- base.setComptroller(newComptroller);
-
- // Assert that the new comptroller has been set.
- address actualComptroller = address(base.comptroller());
- address expectedComptroller = address(newComptroller);
- assertEq(actualComptroller, expectedComptroller, "comptroller");
- }
-}
diff --git a/test/integration/concrete/lockup/set-comptroller/setComptroller.tree b/test/integration/concrete/lockup/set-comptroller/setComptroller.tree
deleted file mode 100644
index fae51fdb9..000000000
--- a/test/integration/concrete/lockup/set-comptroller/setComptroller.tree
+++ /dev/null
@@ -1,10 +0,0 @@
-setComptroller.t.sol
-├── when the caller is not the admin
-│ └── it should revert
-└── when the caller is the admin
- ├── when the new comptroller is the same as the current comptroller
- │ ├── it should re-set the comptroller
- │ └── it should emit a {SetComptroller} event
- └── when the new comptroller is not the same as the current comptroller
- ├── it should set the new comptroller
- └── it should emit a {SetComptroller} event
diff --git a/test/integration/concrete/lockup/set-nft-descriptor/setNFTDescriptor.t.sol b/test/integration/concrete/lockup/set-nft-descriptor/setNFTDescriptor.t.sol
index 1ca11acef..2b1c52cf6 100644
--- a/test/integration/concrete/lockup/set-nft-descriptor/setNFTDescriptor.t.sol
+++ b/test/integration/concrete/lockup/set-nft-descriptor/setNFTDescriptor.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { ISablierV2NFTDescriptor } from "src/interfaces/ISablierV2NFTDescriptor.sol";
import { Errors } from "src/libraries/Errors.sol";
@@ -17,7 +17,7 @@ abstract contract SetNFTDescriptor_Integration_Concrete_Test is Integration_Test
function test_RevertWhen_CallerNotAdmin() external {
// Make Eve the caller in this test.
- changePrank({ msgSender: users.eve });
+ resetPrank({ msgSender: users.eve });
// Run the test.
vm.expectRevert(abi.encodeWithSelector(Errors.CallerNotAdmin.selector, users.admin, users.eve));
@@ -26,7 +26,7 @@ abstract contract SetNFTDescriptor_Integration_Concrete_Test is Integration_Test
modifier whenCallerAdmin() {
// Make the Admin the caller in the rest of this test suite.
- changePrank({ msgSender: users.admin });
+ resetPrank({ msgSender: users.admin });
_;
}
diff --git a/test/integration/concrete/lockup/status-of/statusOf.t.sol b/test/integration/concrete/lockup/status-of/statusOf.t.sol
index 75775ebe3..43b275e39 100644
--- a/test/integration/concrete/lockup/status-of/statusOf.t.sol
+++ b/test/integration/concrete/lockup/status-of/statusOf.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
import { Lockup } from "src/types/DataTypes.sol";
@@ -24,7 +24,7 @@ abstract contract StatusOf_Integration_Concrete_Test is Integration_Test, Lockup
}
function test_StatusOf_AssetsFullyWithdrawn() external givenNotNull {
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
Lockup.Status actualStatus = lockup.statusOf(defaultStreamId);
Lockup.Status expectedStatus = Lockup.Status.DEPLETED;
@@ -36,7 +36,7 @@ abstract contract StatusOf_Integration_Concrete_Test is Integration_Test, Lockup
}
function test_StatusOf_StreamCanceled() external givenNotNull givenAssetsNotFullyWithdrawn {
- vm.warp({ timestamp: defaults.CLIFF_TIME() });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() });
lockup.cancel(defaultStreamId);
Lockup.Status actualStatus = lockup.statusOf(defaultStreamId);
Lockup.Status expectedStatus = Lockup.Status.CANCELED;
@@ -53,7 +53,7 @@ abstract contract StatusOf_Integration_Concrete_Test is Integration_Test, Lockup
givenAssetsNotFullyWithdrawn
givenStreamNotCanceled
{
- vm.warp({ timestamp: getBlockTimestamp() - 1 seconds });
+ vm.warp({ newTimestamp: getBlockTimestamp() - 1 seconds });
Lockup.Status actualStatus = lockup.statusOf(defaultStreamId);
Lockup.Status expectedStatus = Lockup.Status.PENDING;
assertEq(actualStatus, expectedStatus);
@@ -70,7 +70,7 @@ abstract contract StatusOf_Integration_Concrete_Test is Integration_Test, Lockup
givenStreamNotCanceled
givenStartTimeNotInTheFuture
{
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
Lockup.Status actualStatus = lockup.statusOf(defaultStreamId);
Lockup.Status expectedStatus = Lockup.Status.SETTLED;
assertEq(actualStatus, expectedStatus);
@@ -88,7 +88,7 @@ abstract contract StatusOf_Integration_Concrete_Test is Integration_Test, Lockup
givenStartTimeNotInTheFuture
givenRefundableAmountNotZero
{
- vm.warp({ timestamp: defaults.START_TIME() + 1 seconds });
+ vm.warp({ newTimestamp: defaults.START_TIME() + 1 seconds });
Lockup.Status actualStatus = lockup.statusOf(defaultStreamId);
Lockup.Status expectedStatus = Lockup.Status.STREAMING;
assertEq(actualStatus, expectedStatus);
diff --git a/test/integration/concrete/lockup/status-of/statusOf.tree b/test/integration/concrete/lockup/status-of/statusOf.tree
index 6d0bfda29..03c12a2ef 100644
--- a/test/integration/concrete/lockup/status-of/statusOf.tree
+++ b/test/integration/concrete/lockup/status-of/statusOf.tree
@@ -1,7 +1,7 @@
statusOf.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
├── given assets have been fully withdrawn
│ └── it should return DEPLETED
└── given assets have not been fully withdrawn
diff --git a/test/integration/concrete/lockup/streamed-amount-of/streamedAmountOf.t.sol b/test/integration/concrete/lockup/streamed-amount-of/streamedAmountOf.t.sol
index caaa72956..acf7d0f17 100644
--- a/test/integration/concrete/lockup/streamed-amount-of/streamedAmountOf.t.sol
+++ b/test/integration/concrete/lockup/streamed-amount-of/streamedAmountOf.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
@@ -25,7 +25,7 @@ abstract contract StreamedAmountOf_Integration_Concrete_Test is
givenNotNull
givenStreamHasBeenCanceled
{
- vm.warp({ timestamp: defaults.CLIFF_TIME() });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() });
lockup.cancel(defaultStreamId);
uint128 actualStreamedAmount = lockup.streamedAmountOf(defaultStreamId);
uint256 expectedStreamedAmount = defaults.CLIFF_AMOUNT();
@@ -38,31 +38,31 @@ abstract contract StreamedAmountOf_Integration_Concrete_Test is
givenNotNull
givenStreamHasBeenCanceled
{
- vm.warp({ timestamp: defaults.CLIFF_TIME() });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() });
lockup.cancel(defaultStreamId);
lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
- vm.warp({ timestamp: defaults.CLIFF_TIME() + 10 seconds });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() + 10 seconds });
uint128 actualStreamedAmount = lockup.streamedAmountOf(defaultStreamId);
uint128 expectedStreamedAmount = defaults.CLIFF_AMOUNT();
assertEq(actualStreamedAmount, expectedStreamedAmount, "streamedAmount");
}
function test_StreamedAmountOf_StatusPending() external givenNotNull givenStreamHasNotBeenCanceled {
- vm.warp({ timestamp: getBlockTimestamp() - 1 seconds });
+ vm.warp({ newTimestamp: getBlockTimestamp() - 1 seconds });
uint128 actualStreamedAmount = lockup.streamedAmountOf(defaultStreamId);
uint128 expectedStreamedAmount = 0;
assertEq(actualStreamedAmount, expectedStreamedAmount, "streamedAmount");
}
function test_StreamedAmountOf_StatusSettled() external givenNotNull givenStreamHasNotBeenCanceled {
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
uint128 actualStreamedAmount = lockup.streamedAmountOf(defaultStreamId);
uint128 expectedStreamedAmount = defaults.DEPOSIT_AMOUNT();
assertEq(actualStreamedAmount, expectedStreamedAmount, "streamedAmount");
}
function test_StreamedAmountOf_StatusDepleted() external givenNotNull givenStreamHasNotBeenCanceled {
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
uint128 actualStreamedAmount = lockup.streamedAmountOf(defaultStreamId);
uint128 expectedStreamedAmount = defaults.DEPOSIT_AMOUNT();
diff --git a/test/integration/concrete/lockup/streamed-amount-of/streamedAmountOf.tree b/test/integration/concrete/lockup/streamed-amount-of/streamedAmountOf.tree
index dbc0970ab..f0784e8ea 100644
--- a/test/integration/concrete/lockup/streamed-amount-of/streamedAmountOf.tree
+++ b/test/integration/concrete/lockup/streamed-amount-of/streamedAmountOf.tree
@@ -1,7 +1,7 @@
streamedAmountOf.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
├── given the stream has been canceled
│ ├── given the stream's status is "CANCELED"
│ │ └── it should return the correct streamed amount
diff --git a/test/integration/concrete/lockup/transfer-from/transferFrom.t.sol b/test/integration/concrete/lockup/transfer-from/transferFrom.t.sol
index 648ee00ce..31987fd0d 100644
--- a/test/integration/concrete/lockup/transfer-from/transferFrom.t.sol
+++ b/test/integration/concrete/lockup/transfer-from/transferFrom.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
@@ -8,7 +8,7 @@ import { Integration_Test } from "../../../Integration.t.sol";
abstract contract TransferFrom_Integration_Concrete_Test is Integration_Test, Lockup_Integration_Shared_Test {
function setUp() public virtual override(Integration_Test, Lockup_Integration_Shared_Test) {
- changePrank({ msgSender: users.recipient });
+ resetPrank({ msgSender: users.recipient });
}
function test_RevertGiven_StreamNotTransferable() external {
@@ -29,9 +29,9 @@ abstract contract TransferFrom_Integration_Concrete_Test is Integration_Test, Lo
// Expect the relevant events to be emitted.
vm.expectEmit({ emitter: address(lockup) });
- emit Transfer({ from: users.recipient, to: users.alice, tokenId: streamId });
- vm.expectEmit({ emitter: address(lockup) });
emit MetadataUpdate({ _tokenId: streamId });
+ vm.expectEmit({ emitter: address(lockup) });
+ emit Transfer({ from: users.recipient, to: users.alice, tokenId: streamId });
// Transfer the NFT.
lockup.transferFrom({ from: users.recipient, to: users.alice, tokenId: streamId });
diff --git a/test/integration/concrete/lockup/was-canceled/wasCanceled.t.sol b/test/integration/concrete/lockup/was-canceled/wasCanceled.t.sol
index 3eea3c362..fb532ea8b 100644
--- a/test/integration/concrete/lockup/was-canceled/wasCanceled.t.sol
+++ b/test/integration/concrete/lockup/was-canceled/wasCanceled.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
diff --git a/test/integration/concrete/lockup/was-canceled/wasCanceled.tree b/test/integration/concrete/lockup/was-canceled/wasCanceled.tree
index 5dd4e1e3a..0be9ecbda 100644
--- a/test/integration/concrete/lockup/was-canceled/wasCanceled.tree
+++ b/test/integration/concrete/lockup/was-canceled/wasCanceled.tree
@@ -1,7 +1,7 @@
wasCanceled.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
├── given the stream was not canceled
│ └── it should return false
└── given the stream was canceled
diff --git a/test/integration/concrete/lockup/withdraw-hooks/withdrawHooks.t.sol b/test/integration/concrete/lockup/withdraw-hooks/withdrawHooks.t.sol
new file mode 100644
index 000000000..a89bc2c07
--- /dev/null
+++ b/test/integration/concrete/lockup/withdraw-hooks/withdrawHooks.t.sol
@@ -0,0 +1,146 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22 <0.9.0;
+
+import { ISablierLockupRecipient } from "src/interfaces/ISablierLockupRecipient.sol";
+
+import { Integration_Test } from "../../../Integration.t.sol";
+import { Withdraw_Integration_Shared_Test } from "../../../shared/lockup/withdraw.t.sol";
+
+abstract contract WithdrawHooks_Integration_Concrete_Test is Integration_Test, Withdraw_Integration_Shared_Test {
+ uint128 internal withdrawAmount;
+
+ function setUp() public virtual override(Integration_Test, Withdraw_Integration_Shared_Test) {
+ Withdraw_Integration_Shared_Test.setUp();
+ withdrawAmount = defaults.WITHDRAW_AMOUNT();
+
+ // Allow the good recipient to hook.
+ resetPrank({ msgSender: users.admin });
+ lockup.allowToHook(address(recipientGood));
+ resetPrank({ msgSender: users.sender });
+ }
+
+ function test_WithdrawHooks_GivenSameSenderAndRecipient() external {
+ // Create a stream with identical sender and recipient.
+ uint256 streamId = createDefaultStreamWithIdenticalUsers(users.sender);
+
+ // Simulate the passage of time.
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
+
+ // Expect Sablier to NOT run the user hook.
+ vm.expectCall({
+ callee: users.sender,
+ data: abi.encodeCall(
+ ISablierLockupRecipient.onSablierLockupWithdraw, (streamId, users.sender, users.sender, withdrawAmount)
+ ),
+ count: 0
+ });
+
+ // Make the withdrawal.
+ lockup.withdraw({ streamId: streamId, to: users.sender, amount: withdrawAmount });
+ }
+
+ modifier givenDifferentSenderAndRecipient() {
+ _;
+ }
+
+ function test_WithdrawHooks_CallerUnknown() external givenDifferentSenderAndRecipient {
+ // Create the test stream.
+ uint256 streamId = createDefaultStreamWithUsers({ recipient: address(recipientGood), sender: users.sender });
+
+ // Make the unknown address the caller in this test.
+ address unknownCaller = address(0xCAFE);
+ resetPrank({ msgSender: unknownCaller });
+
+ // Simulate the passage of time.
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
+
+ // Expect Sablier to run the recipient hook.
+ vm.expectCall({
+ callee: address(recipientGood),
+ data: abi.encodeCall(
+ ISablierLockupRecipient.onSablierLockupWithdraw,
+ (streamId, unknownCaller, address(recipientGood), withdrawAmount)
+ ),
+ count: 1
+ });
+
+ // Make the withdrawal.
+ lockup.withdraw({ streamId: streamId, to: address(recipientGood), amount: withdrawAmount });
+ }
+
+ function test_WithdrawHooks_CallerApprovedOperator() external givenDifferentSenderAndRecipient {
+ // Create the test stream.
+ uint256 streamId = createDefaultStreamWithUsers({ recipient: address(recipientGood), sender: users.sender });
+
+ // Approve the operator to handle the stream.
+ resetPrank({ msgSender: address(recipientGood) });
+ lockup.approve({ to: users.operator, tokenId: streamId });
+
+ // Make the operator the caller in this test.
+ resetPrank({ msgSender: users.operator });
+
+ // Simulate the passage of time.
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
+
+ // Expect Sablier to run the recipient hook.
+ vm.expectCall({
+ callee: address(recipientGood),
+ data: abi.encodeCall(
+ ISablierLockupRecipient.onSablierLockupWithdraw,
+ (streamId, users.operator, address(recipientGood), withdrawAmount)
+ ),
+ count: 1
+ });
+
+ // Make the withdrawal.
+ lockup.withdraw({ streamId: streamId, to: address(recipientGood), amount: withdrawAmount });
+ }
+
+ function test_WithdrawHooks_CallerSender() external givenDifferentSenderAndRecipient {
+ // Create the test stream.
+ uint256 streamId = createDefaultStreamWithUsers({ recipient: address(recipientGood), sender: users.sender });
+
+ // Make the Sender the caller in this test.
+ resetPrank({ msgSender: users.sender });
+
+ // Simulate the passage of time.
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
+
+ // Expect Sablier to run the recipient hook.
+ vm.expectCall({
+ callee: address(recipientGood),
+ data: abi.encodeCall(
+ ISablierLockupRecipient.onSablierLockupWithdraw,
+ (streamId, users.sender, address(recipientGood), withdrawAmount)
+ ),
+ count: 1
+ });
+
+ // Make the withdrawal.
+ lockup.withdraw({ streamId: streamId, to: address(recipientGood), amount: withdrawAmount });
+ }
+
+ function test_WithdrawHooks_CallerRecipient() external givenDifferentSenderAndRecipient {
+ // Create the test stream.
+ uint256 streamId = createDefaultStreamWithUsers({ recipient: address(recipientGood), sender: users.sender });
+
+ // Make the recipient contract the caller in this test.
+ resetPrank({ msgSender: address(recipientGood) });
+
+ // Simulate the passage of time.
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
+
+ // Expect Sablier to NOT run the recipient hook.
+ vm.expectCall({
+ callee: address(recipientGood),
+ data: abi.encodeCall(
+ ISablierLockupRecipient.onSablierLockupWithdraw,
+ (streamId, address(recipientGood), address(recipientGood), withdrawAmount)
+ ),
+ count: 0
+ });
+
+ // Make the withdrawal.
+ lockup.withdraw({ streamId: streamId, to: address(recipientGood), amount: withdrawAmount });
+ }
+}
diff --git a/test/integration/concrete/lockup/withdraw-hooks/withdrawHooks.tree b/test/integration/concrete/lockup/withdraw-hooks/withdrawHooks.tree
new file mode 100644
index 000000000..dd552a01b
--- /dev/null
+++ b/test/integration/concrete/lockup/withdraw-hooks/withdrawHooks.tree
@@ -0,0 +1,12 @@
+withdrawHooks.t.sol
+├── given the recipient is the same as the sender
+│ └── it should not make Sablier run the user hook
+└── given the recipient is different than the sender
+ ├── when the caller is unknown
+ │ └── it should make Sablier run the recipient hook
+ ├── when the caller is an approved third party
+ │ └── it should make Sablier run the recipient hook
+ ├── when the caller is the sender
+ │ └── it should make Sablier run the recipient hook
+ └── when the caller is the recipient
+ └── it should not make Sablier run the recipient hook
diff --git a/test/integration/concrete/lockup/withdraw-max-and-transfer/withdrawMaxAndTransfer.t.sol b/test/integration/concrete/lockup/withdraw-max-and-transfer/withdrawMaxAndTransfer.t.sol
index 86bddab4f..98f62a5b4 100644
--- a/test/integration/concrete/lockup/withdraw-max-and-transfer/withdrawMaxAndTransfer.t.sol
+++ b/test/integration/concrete/lockup/withdraw-max-and-transfer/withdrawMaxAndTransfer.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { ISablierV2Lockup } from "src/interfaces/ISablierV2Lockup.sol";
import { Errors } from "src/libraries/Errors.sol";
@@ -29,7 +29,7 @@ abstract contract WithdrawMaxAndTransfer_Integration_Concrete_Test is
function test_RevertWhen_CallerNotCurrentRecipient() external whenNotDelegateCalled givenNotNull {
// Make Eve the caller in this test.
- changePrank({ msgSender: users.eve });
+ resetPrank({ msgSender: users.eve });
// Run the test.
vm.expectRevert(
@@ -40,7 +40,7 @@ abstract contract WithdrawMaxAndTransfer_Integration_Concrete_Test is
function test_RevertGiven_NFTBurned() external whenNotDelegateCalled givenNotNull whenCallerCurrentRecipient {
// Deplete the stream.
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
// Burn the NFT.
@@ -60,7 +60,7 @@ abstract contract WithdrawMaxAndTransfer_Integration_Concrete_Test is
whenCallerCurrentRecipient
givenNFTNotBurned
{
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
lockup.withdrawMaxAndTransfer({ streamId: defaultStreamId, newRecipient: users.alice });
}
@@ -90,33 +90,32 @@ abstract contract WithdrawMaxAndTransfer_Integration_Concrete_Test is
givenStreamTransferable
{
// Simulate the passage of time.
- vm.warp({ timestamp: defaults.WARP_26_PERCENT() });
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
// Get the withdraw amount.
- uint128 withdrawAmount = lockup.withdrawableAmountOf(defaultStreamId);
+ uint128 expectedWithdrawnAmount = lockup.withdrawableAmountOf(defaultStreamId);
// Expect the assets to be transferred to the Recipient.
- expectCallToTransfer({ to: users.recipient, amount: withdrawAmount });
+ expectCallToTransfer({ to: users.recipient, value: expectedWithdrawnAmount });
// Expect the relevant events to be emitted.
vm.expectEmit({ emitter: address(lockup) });
emit WithdrawFromLockupStream({
streamId: defaultStreamId,
to: users.recipient,
- amount: withdrawAmount,
+ amount: expectedWithdrawnAmount,
asset: dai
});
vm.expectEmit({ emitter: address(lockup) });
- emit Transfer({ from: users.recipient, to: users.alice, tokenId: defaultStreamId });
- vm.expectEmit({ emitter: address(lockup) });
emit MetadataUpdate({ _tokenId: defaultStreamId });
+ vm.expectEmit({ emitter: address(lockup) });
+ emit Transfer({ from: users.recipient, to: users.alice, tokenId: defaultStreamId });
// Make the max withdrawal and transfer the NFT.
- lockup.withdrawMaxAndTransfer({ streamId: defaultStreamId, newRecipient: users.alice });
+ uint128 actualWithdrawnAmount =
+ lockup.withdrawMaxAndTransfer({ streamId: defaultStreamId, newRecipient: users.alice });
// Assert that the withdrawn amount has been updated.
- uint128 actualWithdrawnAmount = lockup.getWithdrawnAmount(defaultStreamId);
- uint128 expectedWithdrawnAmount = withdrawAmount;
assertEq(actualWithdrawnAmount, expectedWithdrawnAmount, "withdrawnAmount");
// Assert that Alice is the new stream recipient (and NFT owner).
diff --git a/test/integration/concrete/lockup/withdraw-max-and-transfer/withdrawMaxAndTransfer.tree b/test/integration/concrete/lockup/withdraw-max-and-transfer/withdrawMaxAndTransfer.tree
index f53682e9e..91f754730 100644
--- a/test/integration/concrete/lockup/withdraw-max-and-transfer/withdrawMaxAndTransfer.tree
+++ b/test/integration/concrete/lockup/withdraw-max-and-transfer/withdrawMaxAndTransfer.tree
@@ -2,9 +2,9 @@ withdrawMaxAndTransfer.t.sol
├── when delegate called
│ └── it should revert
└── when not delegate called
- ├── given the id references a null stream
+ ├── given the ID references a null stream
│ └── it should revert
- └── given the id does not reference a null stream
+ └── given the ID does not reference a null stream
├── given the stream is not transferable
│ └── it should revert
└── given the stream is transferable
@@ -22,4 +22,5 @@ withdrawMaxAndTransfer.t.sol
├── it should transfer the NFT
├── it should emit a {WithdrawFromLockupStream} event
├── it should emit a {Transfer} event
- └── it should emit a {MetadataUpdate} event
+ ├── it should emit a {MetadataUpdate} event
+ └── it should return the withdrawable amount
diff --git a/test/integration/concrete/lockup/withdraw-max/withdrawMax.t.sol b/test/integration/concrete/lockup/withdraw-max/withdrawMax.t.sol
index 2721c5654..e0f6eab91 100644
--- a/test/integration/concrete/lockup/withdraw-max/withdrawMax.t.sol
+++ b/test/integration/concrete/lockup/withdraw-max/withdrawMax.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Lockup } from "src/types/DataTypes.sol";
@@ -13,10 +13,10 @@ abstract contract WithdrawMax_Integration_Concrete_Test is Integration_Test, Wit
function test_WithdrawMax_EndTimeNotInTheFuture() external {
// Warp to the stream's end.
- vm.warp({ timestamp: defaults.END_TIME() + 1 seconds });
+ vm.warp({ newTimestamp: defaults.END_TIME() + 1 seconds });
// Expect the ERC-20 assets to be transferred to the Recipient.
- expectCallToTransfer({ to: users.recipient, amount: defaults.DEPOSIT_AMOUNT() });
+ expectCallToTransfer({ to: users.recipient, value: defaults.DEPOSIT_AMOUNT() });
// Expect the relevant event to be emitted.
vm.expectEmit({ emitter: address(lockup) });
@@ -52,34 +52,32 @@ abstract contract WithdrawMax_Integration_Concrete_Test is Integration_Test, Wit
function test_WithdrawMax() external givenEndTimeInTheFuture {
// Simulate the passage of time.
- vm.warp({ timestamp: defaults.WARP_26_PERCENT() });
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
// Get the withdraw amount.
- uint128 withdrawAmount = lockup.withdrawableAmountOf(defaultStreamId);
+ uint128 expectedWithdrawnAmount = lockup.withdrawableAmountOf(defaultStreamId);
// Expect the assets to be transferred to the Recipient.
- expectCallToTransfer({ to: users.recipient, amount: withdrawAmount });
+ expectCallToTransfer({ to: users.recipient, value: expectedWithdrawnAmount });
// Expect the relevant event to be emitted.
vm.expectEmit({ emitter: address(lockup) });
emit WithdrawFromLockupStream({
streamId: defaultStreamId,
to: users.recipient,
- amount: withdrawAmount,
+ amount: expectedWithdrawnAmount,
asset: dai
});
// Make the max withdrawal.
- lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
+ uint128 actualWithdrawnAmount = lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
+
+ // Assert that the withdrawn amount has been updated.
+ assertEq(actualWithdrawnAmount, expectedWithdrawnAmount, "withdrawnAmount");
// Assert that the stream's status is still "STREAMING".
Lockup.Status actualStatus = lockup.statusOf(defaultStreamId);
Lockup.Status expectedStatus = Lockup.Status.STREAMING;
assertEq(actualStatus, expectedStatus);
-
- // Assert that the withdrawn amount has been updated.
- uint128 actualWithdrawnAmount = lockup.getWithdrawnAmount(defaultStreamId);
- uint128 expectedWithdrawnAmount = withdrawAmount;
- assertEq(actualWithdrawnAmount, expectedWithdrawnAmount, "withdrawnAmount");
}
}
diff --git a/test/integration/concrete/lockup/withdraw-max/withdrawMax.tree b/test/integration/concrete/lockup/withdraw-max/withdrawMax.tree
index 46b7d1190..866c7f09f 100644
--- a/test/integration/concrete/lockup/withdraw-max/withdrawMax.tree
+++ b/test/integration/concrete/lockup/withdraw-max/withdrawMax.tree
@@ -4,8 +4,10 @@ withdrawMax.t.sol
│ ├── it should update the withdrawn amount
│ ├── it should mark the stream as depleted
│ ├── it should make the stream not cancelable
-│ └── it should emit a {WithdrawFromLockupStream} event
+│ ├── it should emit a {WithdrawFromLockupStream} event
+│ └── it should return the withdrawn amount
└── given the end time is in the future
├── it should make the max withdrawal
├── it should update the withdrawn amount
- └── it should emit a {WithdrawFromLockupStream} event
+ ├── it should emit a {WithdrawFromLockupStream} event
+ └── it should return the withdrawable amount
diff --git a/test/integration/concrete/lockup/withdraw-multiple/withdrawMultiple.t.sol b/test/integration/concrete/lockup/withdraw-multiple/withdrawMultiple.t.sol
index 308fc2b3a..fdc0347de 100644
--- a/test/integration/concrete/lockup/withdraw-multiple/withdrawMultiple.t.sol
+++ b/test/integration/concrete/lockup/withdraw-multiple/withdrawMultiple.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Solarray } from "solarray/src/Solarray.sol";
@@ -19,8 +19,7 @@ abstract contract WithdrawMultiple_Integration_Concrete_Test is
}
function test_RevertWhen_DelegateCalled() external {
- bytes memory callData =
- abi.encodeCall(ISablierV2Lockup.withdrawMultiple, (testStreamIds, users.recipient, testAmounts));
+ bytes memory callData = abi.encodeCall(ISablierV2Lockup.withdrawMultiple, (testStreamIds, testAmounts));
(bool success, bytes memory returnData) = address(lockup).delegatecall(callData);
expectRevertDueToDelegateCall(success, returnData);
}
@@ -33,7 +32,7 @@ abstract contract WithdrawMultiple_Integration_Concrete_Test is
Errors.SablierV2Lockup_WithdrawArrayCountsNotEqual.selector, streamIds.length, amounts.length
)
);
- lockup.withdrawMultiple({ streamIds: streamIds, to: users.recipient, amounts: amounts });
+ lockup.withdrawMultiple(streamIds, amounts);
}
modifier whenArrayCountsAreEqual() {
@@ -43,7 +42,7 @@ abstract contract WithdrawMultiple_Integration_Concrete_Test is
function test_WithdrawMultiple_ArrayCountsZero() external whenNotDelegateCalled whenArrayCountsAreEqual {
uint256[] memory streamIds = new uint256[](0);
uint128[] memory amounts = new uint128[](0);
- lockup.withdrawMultiple({ streamIds: streamIds, to: users.recipient, amounts: amounts });
+ lockup.withdrawMultiple(streamIds, amounts);
}
modifier whenArrayCountsNotZero() {
@@ -61,7 +60,6 @@ abstract contract WithdrawMultiple_Integration_Concrete_Test is
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_Null.selector, nullStreamId));
lockup.withdrawMultiple({
streamIds: Solarray.uint256s(nullStreamId),
- to: users.recipient,
amounts: Solarray.uint128s(withdrawAmount)
});
}
@@ -76,13 +74,13 @@ abstract contract WithdrawMultiple_Integration_Concrete_Test is
uint256[] memory streamIds = Solarray.uint256s(testStreamIds[0], testStreamIds[1], nullStreamId);
// Simulate the passage of time.
- vm.warp({ timestamp: defaults.WARP_26_PERCENT() });
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
// Expect the relevant error to be thrown.
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_Null.selector, nullStreamId));
// Withdraw from multiple streams.
- lockup.withdrawMultiple({ streamIds: streamIds, to: users.recipient, amounts: testAmounts });
+ lockup.withdrawMultiple({ streamIds: streamIds, amounts: testAmounts });
}
function test_RevertGiven_AllStatusesDepleted()
@@ -96,7 +94,7 @@ abstract contract WithdrawMultiple_Integration_Concrete_Test is
uint128[] memory amounts = Solarray.uint128s(defaults.WITHDRAW_AMOUNT());
// Simulate the passage of time.
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
// Deplete the first test stream.
lockup.withdrawMax({ streamId: testStreamIds[0], to: users.recipient });
@@ -105,7 +103,7 @@ abstract contract WithdrawMultiple_Integration_Concrete_Test is
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_StreamDepleted.selector, testStreamIds[0]));
// Withdraw from multiple streams.
- lockup.withdrawMultiple({ streamIds: streamIds, to: users.recipient, amounts: amounts });
+ lockup.withdrawMultiple(streamIds, amounts);
}
function test_RevertGiven_SomeStatusesDepleted()
@@ -116,7 +114,7 @@ abstract contract WithdrawMultiple_Integration_Concrete_Test is
givenNoNull
{
// Simulate the passage of time.
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
// Deplete the first test stream.
lockup.withdrawMax({ streamId: testStreamIds[0], to: users.recipient });
@@ -125,113 +123,7 @@ abstract contract WithdrawMultiple_Integration_Concrete_Test is
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_StreamDepleted.selector, testStreamIds[0]));
// Withdraw from multiple streams.
- lockup.withdrawMultiple({ streamIds: testStreamIds, to: users.recipient, amounts: testAmounts });
- }
-
- function test_RevertWhen_CallerUnauthorizedAllStreams_MaliciousThirdParty()
- external
- whenNotDelegateCalled
- whenArrayCountsAreEqual
- whenArrayCountsNotZero
- givenNoNull
- givenNoDepletedStream
- whenCallerUnauthorized
- {
- // Make Eve the caller in this test.
- changePrank({ msgSender: users.eve });
-
- // Run the test.
- vm.expectRevert(
- abi.encodeWithSelector(Errors.SablierV2Lockup_Unauthorized.selector, testStreamIds[0], users.eve)
- );
- lockup.withdrawMultiple({ streamIds: testStreamIds, to: users.recipient, amounts: testAmounts });
- }
-
- function test_RevertWhen_CallerUnauthorizedAllStreams_FormerRecipient()
- external
- whenNotDelegateCalled
- whenArrayCountsAreEqual
- whenArrayCountsNotZero
- givenNoNull
- givenNoDepletedStream
- whenCallerUnauthorized
- {
- // Transfer all streams to Alice.
- changePrank({ msgSender: users.recipient });
- lockup.transferFrom({ from: users.recipient, to: users.alice, tokenId: testStreamIds[0] });
- lockup.transferFrom({ from: users.recipient, to: users.alice, tokenId: testStreamIds[1] });
- lockup.transferFrom({ from: users.recipient, to: users.alice, tokenId: testStreamIds[2] });
-
- // Run the test.
- vm.expectRevert(
- abi.encodeWithSelector(Errors.SablierV2Lockup_Unauthorized.selector, testStreamIds[0], users.recipient)
- );
- lockup.withdrawMultiple({ streamIds: testStreamIds, to: users.recipient, amounts: testAmounts });
- }
-
- function test_RevertWhen_CallerUnauthorizedSomeStreams_MaliciousThirdParty()
- external
- whenNotDelegateCalled
- whenArrayCountsAreEqual
- whenArrayCountsNotZero
- givenNoNull
- givenNoDepletedStream
- whenCallerUnauthorized
- {
- // Create a stream with Eve as the stream's recipient.
- uint256 eveStreamId = createDefaultStreamWithRecipient(users.eve);
-
- // Make Eve the caller in this test.
- changePrank({ msgSender: users.eve });
-
- // Simulate the passage of time.
- vm.warp({ timestamp: defaults.WARP_26_PERCENT() });
-
- // Run the test.
- uint256[] memory streamIds = Solarray.uint256s(eveStreamId, testStreamIds[0], testStreamIds[1]);
- vm.expectRevert(
- abi.encodeWithSelector(Errors.SablierV2Lockup_Unauthorized.selector, testStreamIds[0], users.eve)
- );
- lockup.withdrawMultiple({ streamIds: streamIds, to: users.recipient, amounts: testAmounts });
- }
-
- function test_RevertWhen_CallerUnauthorizedSomeStreams_FormerRecipient()
- external
- whenNotDelegateCalled
- whenArrayCountsAreEqual
- whenArrayCountsNotZero
- givenNoNull
- givenNoDepletedStream
- whenCallerUnauthorized
- {
- // Transfer one of the streams to Eve.
- changePrank({ msgSender: users.recipient });
- lockup.transferFrom({ from: users.recipient, to: users.alice, tokenId: testStreamIds[0] });
-
- // Simulate the passage of time.
- vm.warp({ timestamp: defaults.WARP_26_PERCENT() });
-
- // Run the test.
- vm.expectRevert(
- abi.encodeWithSelector(Errors.SablierV2Lockup_Unauthorized.selector, testStreamIds[0], users.recipient)
- );
- lockup.withdrawMultiple({ streamIds: testStreamIds, to: users.recipient, amounts: testAmounts });
- }
-
- function test_RevertWhen_ToZeroAddress()
- external
- whenNotDelegateCalled
- whenArrayCountsAreEqual
- whenArrayCountsNotZero
- givenNoNull
- givenNoDepletedStream
- whenCallerAuthorizedAllStreams
- {
- if (caller == users.sender) {
- return;
- }
- vm.expectRevert(Errors.SablierV2Lockup_WithdrawToZeroAddress.selector);
- lockup.withdrawMultiple({ streamIds: testStreamIds, to: address(0), amounts: testAmounts });
+ lockup.withdrawMultiple({ streamIds: testStreamIds, amounts: testAmounts });
}
function test_RevertWhen_SomeAmountsZero()
@@ -241,16 +133,15 @@ abstract contract WithdrawMultiple_Integration_Concrete_Test is
whenArrayCountsNotZero
givenNoNull
givenNoDepletedStream
- whenCallerAuthorizedAllStreams
whenToNonZeroAddress
{
// Simulate the passage of time.
- vm.warp({ timestamp: defaults.WARP_26_PERCENT() });
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
// Run the test.
uint128[] memory amounts = Solarray.uint128s(defaults.WITHDRAW_AMOUNT(), 0, 0);
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_WithdrawAmountZero.selector, testStreamIds[1]));
- lockup.withdrawMultiple({ streamIds: testStreamIds, to: users.recipient, amounts: amounts });
+ lockup.withdrawMultiple({ streamIds: testStreamIds, amounts: amounts });
}
function test_RevertWhen_SomeAmountsOverdraw()
@@ -260,12 +151,11 @@ abstract contract WithdrawMultiple_Integration_Concrete_Test is
whenArrayCountsNotZero
givenNoNull
givenNoDepletedStream
- whenCallerAuthorizedAllStreams
whenToNonZeroAddress
whenNoAmountZero
{
// Simulate the passage of time.
- vm.warp({ timestamp: defaults.WARP_26_PERCENT() });
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
// Run the test.
uint128 withdrawableAmount = lockup.withdrawableAmountOf(testStreamIds[2]);
@@ -275,7 +165,7 @@ abstract contract WithdrawMultiple_Integration_Concrete_Test is
Errors.SablierV2Lockup_Overdraw.selector, testStreamIds[2], MAX_UINT128, withdrawableAmount
)
);
- lockup.withdrawMultiple({ streamIds: testStreamIds, to: users.recipient, amounts: amounts });
+ lockup.withdrawMultiple({ streamIds: testStreamIds, amounts: amounts });
}
function test_WithdrawMultiple()
@@ -285,25 +175,24 @@ abstract contract WithdrawMultiple_Integration_Concrete_Test is
whenArrayCountsNotZero
givenNoNull
givenNoDepletedStream
- whenCallerAuthorizedAllStreams
whenToNonZeroAddress
whenNoAmountZero
whenNoAmountOverdraws
{
// Simulate the passage of time.
- vm.warp({ timestamp: earlyStopTime });
+ vm.warp({ newTimestamp: earlyStopTime });
// Cancel the 3rd stream.
- changePrank({ msgSender: users.sender });
+ resetPrank({ msgSender: users.sender });
lockup.cancel(testStreamIds[2]);
// Run the test with the caller provided in {whenCallerAuthorizedAllStreams}.
- changePrank({ msgSender: caller });
+ resetPrank({ msgSender: caller });
// Expect the withdrawals to be made.
- expectCallToTransfer({ to: users.recipient, amount: testAmounts[0] });
- expectCallToTransfer({ to: users.recipient, amount: testAmounts[1] });
- expectCallToTransfer({ to: users.recipient, amount: testAmounts[2] });
+ expectCallToTransfer({ to: users.recipient, value: testAmounts[0] });
+ expectCallToTransfer({ to: users.recipient, value: testAmounts[1] });
+ expectCallToTransfer({ to: users.recipient, value: testAmounts[2] });
// Expect the relevant events to be emitted.
vm.expectEmit({ emitter: address(lockup) });
@@ -329,7 +218,7 @@ abstract contract WithdrawMultiple_Integration_Concrete_Test is
});
// Make the withdrawals.
- lockup.withdrawMultiple({ streamIds: testStreamIds, to: users.recipient, amounts: testAmounts });
+ lockup.withdrawMultiple({ streamIds: testStreamIds, amounts: testAmounts });
// Assert that the statuses have been updated.
assertEq(lockup.statusOf(testStreamIds[0]), Lockup.Status.STREAMING, "status0");
diff --git a/test/integration/concrete/lockup/withdraw-multiple/withdrawMultiple.tree b/test/integration/concrete/lockup/withdraw-multiple/withdrawMultiple.tree
index 52ca2f9e7..c9fbb0d35 100644
--- a/test/integration/concrete/lockup/withdraw-multiple/withdrawMultiple.tree
+++ b/test/integration/concrete/lockup/withdraw-multiple/withdrawMultiple.tree
@@ -8,37 +8,23 @@ withdrawMultiple.t.sol
├── when the array counts are zero
│ └── it should do nothing
└── when the array counts are not zero
- ├── given the stream ids array references only null streams
+ ├── given the stream IDs array references only null streams
│ └── it should revert
- ├── given the stream ids array references some null streams
+ ├── given the stream IDs array references some null streams
│ └── it should revert
- └── given the stream ids array references only non-null streams
+ └── given the stream IDs array references only non-null streams
├── given all streams' statuses are "DEPLETED"
│ └── it should revert
├── given some streams' statuses are "DEPLETED"
│ └── it should revert
└── given no stream's status is "DEPLETED"
- ├── when the caller is unauthorized for all streams
- │ ├── when the caller is a malicious third party
- │ │ └── it should revert
- │ └── when the caller is a former recipient
- │ └── it should revert
- ├── when the caller is unauthorized for some streams
- │ ├── when the caller is a malicious third party
- │ │ └── it should revert
- │ └── when the caller is a former recipient
- │ └── it should revert
- └── when the caller is authorized for all streams
- ├── when the provided address is zero
+ ├── when some amounts are zero
+ │ └── it should revert
+ └── when none of the amounts are zero
+ ├── when some amounts overdraw
│ └── it should revert
- └── when the provided address is not zero
- ├── when some amounts are zero
- │ └── it should revert
- └── when none of the amounts are zero
- ├── when some amounts overdraw
- │ └── it should revert
- └── when no amount overdraws
- ├── it should make the withdrawals
- ├── it should update the statuses
- ├── it should update the withdrawn amounts
- └── it should emit multiple {WithdrawFromLockupStream} events
+ └── when no amount overdraws
+ ├── it should make the withdrawals
+ ├── it should update the statuses
+ ├── it should update the withdrawn amounts
+ └── it should emit multiple {WithdrawFromLockupStream} events
diff --git a/test/integration/concrete/lockup/withdraw/withdraw.t.sol b/test/integration/concrete/lockup/withdraw/withdraw.t.sol
index fbbeca2f6..66815be10 100644
--- a/test/integration/concrete/lockup/withdraw/withdraw.t.sol
+++ b/test/integration/concrete/lockup/withdraw/withdraw.t.sol
@@ -1,8 +1,8 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
+import { ISablierLockupRecipient } from "src/interfaces/ISablierLockupRecipient.sol";
import { ISablierV2Lockup } from "src/interfaces/ISablierV2Lockup.sol";
-import { ISablierV2LockupRecipient } from "src/interfaces/hooks/ISablierV2LockupRecipient.sol";
import { Errors } from "src/libraries/Errors.sol";
import { Lockup } from "src/types/DataTypes.sol";
@@ -15,6 +15,10 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
Withdraw_Integration_Shared_Test.setUp();
}
+ /*//////////////////////////////////////////////////////////////////////////
+ TESTS
+ //////////////////////////////////////////////////////////////////////////*/
+
function test_RevertWhen_DelegateCalled() external {
uint128 withdrawAmount = defaults.WITHDRAW_AMOUNT();
bytes memory callData =
@@ -31,7 +35,7 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
}
function test_RevertGiven_StreamDepleted() external whenNotDelegateCalled givenNotNull {
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
uint128 withdrawAmount = defaults.WITHDRAW_AMOUNT();
@@ -39,120 +43,197 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
lockup.withdraw({ streamId: defaultStreamId, to: users.recipient, amount: withdrawAmount });
}
- function test_RevertWhen_CallerUnauthorized_Sender()
+ function test_RevertWhen_ToZeroAddress() external whenNotDelegateCalled givenNotNull givenStreamNotDepleted {
+ uint128 withdrawAmount = defaults.WITHDRAW_AMOUNT();
+ vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_WithdrawToZeroAddress.selector, defaultStreamId));
+ lockup.withdraw({ streamId: defaultStreamId, to: address(0), amount: withdrawAmount });
+ }
+
+ function test_RevertWhen_WithdrawAmountZero()
external
whenNotDelegateCalled
givenNotNull
givenStreamNotDepleted
- whenCallerUnauthorized
+ whenToNonZeroAddress
{
- // Make the Sender the caller in this test.
- changePrank({ msgSender: users.sender });
+ vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_WithdrawAmountZero.selector, defaultStreamId));
+ lockup.withdraw({ streamId: defaultStreamId, to: users.recipient, amount: 0 });
+ }
- // Run the test.
- uint128 withdrawAmount = defaults.WITHDRAW_AMOUNT();
+ function test_RevertWhen_Overdraw()
+ external
+ whenNotDelegateCalled
+ givenNotNull
+ givenStreamNotDepleted
+ whenToNonZeroAddress
+ whenWithdrawAmountNotZero
+ {
+ uint128 withdrawableAmount = 0;
vm.expectRevert(
abi.encodeWithSelector(
- Errors.SablierV2Lockup_InvalidSenderWithdrawal.selector, defaultStreamId, users.sender, users.sender
+ Errors.SablierV2Lockup_Overdraw.selector, defaultStreamId, MAX_UINT128, withdrawableAmount
)
);
- lockup.withdraw({ streamId: defaultStreamId, to: users.sender, amount: withdrawAmount });
+ lockup.withdraw({ streamId: defaultStreamId, to: users.recipient, amount: MAX_UINT128 });
}
- function test_RevertWhen_CallerUnauthorized_MaliciousThirdParty()
+ function test_RevertWhen_CallerUnknown()
external
whenNotDelegateCalled
givenNotNull
givenStreamNotDepleted
- whenCallerUnauthorized
+ whenWithdrawAmountNotZero
+ whenNoOverdraw
+ whenWithdrawalAddressNotRecipient
{
+ address unknownCaller = address(0xCAFE);
+
// Make Eve the caller in this test.
- changePrank({ msgSender: users.eve });
+ resetPrank({ msgSender: unknownCaller });
// Run the test.
uint128 withdrawAmount = defaults.WITHDRAW_AMOUNT();
vm.expectRevert(
- abi.encodeWithSelector(Errors.SablierV2Lockup_Unauthorized.selector, defaultStreamId, users.eve)
+ abi.encodeWithSelector(
+ Errors.SablierV2Lockup_WithdrawalAddressNotRecipient.selector,
+ defaultStreamId,
+ unknownCaller,
+ unknownCaller
+ )
);
- lockup.withdraw({ streamId: defaultStreamId, to: users.recipient, amount: withdrawAmount });
+ lockup.withdraw({ streamId: defaultStreamId, to: unknownCaller, amount: withdrawAmount });
}
- function test_RevertWhen_FormerRecipient() external whenNotDelegateCalled givenNotNull givenStreamNotDepleted {
- // Transfer the stream to Alice.
- lockup.transferFrom(users.recipient, users.alice, defaultStreamId);
+ function test_RevertWhen_CallerSender()
+ external
+ whenNotDelegateCalled
+ givenNotNull
+ givenStreamNotDepleted
+ whenWithdrawAmountNotZero
+ whenNoOverdraw
+ whenWithdrawalAddressNotRecipient
+ {
+ // Make the Sender the caller in this test.
+ resetPrank({ msgSender: users.sender });
// Run the test.
uint128 withdrawAmount = defaults.WITHDRAW_AMOUNT();
vm.expectRevert(
- abi.encodeWithSelector(Errors.SablierV2Lockup_Unauthorized.selector, defaultStreamId, users.recipient)
+ abi.encodeWithSelector(
+ Errors.SablierV2Lockup_WithdrawalAddressNotRecipient.selector,
+ defaultStreamId,
+ users.sender,
+ users.sender
+ )
);
- lockup.withdraw({ streamId: defaultStreamId, to: users.recipient, amount: withdrawAmount });
+ lockup.withdraw({ streamId: defaultStreamId, to: users.sender, amount: withdrawAmount });
}
- function test_RevertWhen_ToZeroAddress()
+ function test_RevertWhen_CallerFormerRecipient()
external
whenNotDelegateCalled
givenNotNull
givenStreamNotDepleted
- whenCallerAuthorized
+ whenWithdrawAmountNotZero
+ whenNoOverdraw
+ whenWithdrawalAddressNotRecipient
{
+ // Transfer the stream to Alice.
+ lockup.transferFrom(users.recipient, users.alice, defaultStreamId);
+
+ // Run the test.
uint128 withdrawAmount = defaults.WITHDRAW_AMOUNT();
- vm.expectRevert(Errors.SablierV2Lockup_WithdrawToZeroAddress.selector);
- lockup.withdraw({ streamId: defaultStreamId, to: address(0), amount: withdrawAmount });
+ vm.expectRevert(
+ abi.encodeWithSelector(
+ Errors.SablierV2Lockup_WithdrawalAddressNotRecipient.selector,
+ defaultStreamId,
+ users.recipient,
+ users.recipient
+ )
+ );
+ lockup.withdraw({ streamId: defaultStreamId, to: users.recipient, amount: withdrawAmount });
}
- function test_RevertWhen_WithdrawAmountZero()
+ function test_Withdraw_CallerApprovedOperator()
external
whenNotDelegateCalled
givenNotNull
givenStreamNotDepleted
- whenCallerAuthorized
whenToNonZeroAddress
+ whenWithdrawAmountNotZero
+ whenNoOverdraw
+ whenWithdrawalAddressNotRecipient
{
- vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2Lockup_WithdrawAmountZero.selector, defaultStreamId));
- lockup.withdraw({ streamId: defaultStreamId, to: users.recipient, amount: 0 });
+ // Approve the operator to handle the stream.
+ lockup.approve({ to: users.operator, tokenId: defaultStreamId });
+
+ // Make the operator the caller in this test.
+ resetPrank({ msgSender: users.operator });
+
+ // Simulate the passage of time.
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
+
+ // Make the withdrawal.
+ lockup.withdraw({ streamId: defaultStreamId, to: users.operator, amount: defaults.WITHDRAW_AMOUNT() });
+
+ // Assert that the withdrawn amount has been updated.
+ uint128 actualWithdrawnAmount = lockup.getWithdrawnAmount(defaultStreamId);
+ uint128 expectedWithdrawnAmount = defaults.WITHDRAW_AMOUNT();
+ assertEq(actualWithdrawnAmount, expectedWithdrawnAmount, "withdrawnAmount");
}
- function test_RevertWhen_Overdraw()
+ function test_Withdraw_CallerRecipient1()
external
whenNotDelegateCalled
givenNotNull
givenStreamNotDepleted
- whenCallerAuthorized
whenToNonZeroAddress
whenWithdrawAmountNotZero
+ whenNoOverdraw
+ whenWithdrawalAddressNotRecipient
{
- uint128 withdrawableAmount = 0;
- vm.expectRevert(
- abi.encodeWithSelector(
- Errors.SablierV2Lockup_Overdraw.selector, defaultStreamId, MAX_UINT128, withdrawableAmount
- )
- );
- lockup.withdraw({ streamId: defaultStreamId, to: users.recipient, amount: MAX_UINT128 });
- }
+ // Simulate the passage of time.
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
+
+ // Set the withdraw amount to the default amount.
+ uint128 withdrawAmount = defaults.WITHDRAW_AMOUNT();
+
+ // Expect the assets to be transferred to Alice.
+ expectCallToTransfer({ to: users.alice, value: withdrawAmount });
+
+ // Expect the relevant events to be emitted.
+ vm.expectEmit({ emitter: address(lockup) });
+ emit WithdrawFromLockupStream({ streamId: defaultStreamId, to: users.alice, asset: dai, amount: withdrawAmount });
+ vm.expectEmit({ emitter: address(lockup) });
+ emit MetadataUpdate({ _tokenId: defaultStreamId });
+
+ // Make the withdrawal.
+ lockup.withdraw({ streamId: defaultStreamId, to: users.alice, amount: withdrawAmount });
- modifier whenNoOverdraw() {
- _;
+ // Assert that the withdrawn amount has been updated.
+ uint128 actualWithdrawnAmount = lockup.getWithdrawnAmount(defaultStreamId);
+ uint128 expectedWithdrawnAmount = withdrawAmount;
+ assertEq(actualWithdrawnAmount, expectedWithdrawnAmount, "withdrawnAmount");
}
- function test_Withdraw_CallerRecipient()
+ function test_Withdraw_CallerUnknown()
external
whenNotDelegateCalled
givenNotNull
givenStreamNotDepleted
- whenCallerAuthorized
whenToNonZeroAddress
whenWithdrawAmountNotZero
whenNoOverdraw
+ whenWithdrawalAddressIsRecipient
{
- // Simulate the passage of time.
- vm.warp({ timestamp: defaults.WARP_26_PERCENT() });
+ // Make the unknown address the caller in this test.
+ resetPrank({ msgSender: address(0xCAFE) });
- // Make Alice the `to` address in this test.
- address to = users.alice;
+ // Simulate the passage of time.
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
// Make the withdrawal.
- lockup.withdraw({ streamId: defaultStreamId, to: to, amount: defaults.WITHDRAW_AMOUNT() });
+ lockup.withdraw({ streamId: defaultStreamId, to: users.recipient, amount: defaults.WITHDRAW_AMOUNT() });
// Assert that the withdrawn amount has been updated.
uint128 actualWithdrawnAmount = lockup.getWithdrawnAmount(defaultStreamId);
@@ -160,24 +241,18 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
assertEq(actualWithdrawnAmount, expectedWithdrawnAmount, "withdrawnAmount");
}
- function test_Withdraw_CallerApprovedOperator()
+ function test_Withdraw_CallerRecipient2()
external
whenNotDelegateCalled
givenNotNull
givenStreamNotDepleted
- whenCallerAuthorized
whenToNonZeroAddress
whenWithdrawAmountNotZero
whenNoOverdraw
+ whenWithdrawalAddressIsRecipient
{
- // Approve the operator to handle the stream.
- lockup.approve({ to: users.operator, tokenId: defaultStreamId });
-
- // Make the operator the caller in this test.
- changePrank({ msgSender: users.operator });
-
// Simulate the passage of time.
- vm.warp({ timestamp: defaults.WARP_26_PERCENT() });
+ vm.warp({ newTimestamp: defaults.WARP_26_PERCENT() });
// Make the withdrawal.
lockup.withdraw({ streamId: defaultStreamId, to: users.recipient, amount: defaults.WITHDRAW_AMOUNT() });
@@ -188,24 +263,19 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
assertEq(actualWithdrawnAmount, expectedWithdrawnAmount, "withdrawnAmount");
}
- modifier whenCallerSender() {
- changePrank({ msgSender: users.sender });
- _;
- }
-
function test_Withdraw_EndTimeNotInTheFuture()
external
whenNotDelegateCalled
givenNotNull
givenStreamNotDepleted
- whenCallerAuthorized
whenToNonZeroAddress
whenWithdrawAmountNotZero
whenNoOverdraw
+ whenWithdrawalAddressIsRecipient
whenCallerSender
{
// Warp to the stream's end.
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
// Make the withdrawal.
lockup.withdraw({ streamId: defaultStreamId, to: users.recipient, amount: defaults.DEPOSIT_AMOUNT() });
@@ -225,224 +295,173 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
assertEq(actualNFTowner, expectedNFTOwner, "NFT owner");
}
- modifier givenEndTimeInTheFuture() {
- // Simulate the passage of time.
- vm.warp({ timestamp: defaults.WARP_26_PERCENT() });
- _;
- }
-
function test_Withdraw_StreamHasBeenCanceled()
external
whenNotDelegateCalled
givenNotNull
givenStreamNotDepleted
- whenCallerAuthorized
whenToNonZeroAddress
whenWithdrawAmountNotZero
whenNoOverdraw
+ whenWithdrawalAddressIsRecipient
whenCallerSender
givenEndTimeInTheFuture
- givenRecipientContract
- givenRecipientImplementsHook
- whenRecipientDoesNotRevert
- whenNoRecipientReentrancy
{
- // Create the stream with a contract as the stream's recipient.
- uint256 streamId = createDefaultStreamWithRecipient(address(goodRecipient));
-
// Cancel the stream.
- lockup.cancel(streamId);
+ lockup.cancel(defaultStreamId);
// Set the withdraw amount to the withdrawable amount.
- uint128 withdrawAmount = lockup.withdrawableAmountOf(streamId);
+ uint128 withdrawAmount = lockup.withdrawableAmountOf(defaultStreamId);
// Make the withdrawal.
- lockup.withdraw({ streamId: streamId, to: address(goodRecipient), amount: withdrawAmount });
+ lockup.withdraw({ streamId: defaultStreamId, to: users.recipient, amount: withdrawAmount });
// Assert that the stream's status is "DEPLETED".
- Lockup.Status actualStatus = lockup.statusOf(streamId);
+ Lockup.Status actualStatus = lockup.statusOf(defaultStreamId);
Lockup.Status expectedStatus = Lockup.Status.DEPLETED;
assertEq(actualStatus, expectedStatus);
// Assert that the withdrawn amount has been updated.
- uint128 actualWithdrawnAmount = lockup.getWithdrawnAmount(streamId);
+ uint128 actualWithdrawnAmount = lockup.getWithdrawnAmount(defaultStreamId);
uint128 expectedWithdrawnAmount = withdrawAmount;
assertEq(actualWithdrawnAmount, expectedWithdrawnAmount, "withdrawnAmount");
// Assert that the NFT has not been burned.
- address actualNFTowner = lockup.ownerOf({ tokenId: streamId });
- address expectedNFTOwner = address(goodRecipient);
+ address actualNFTowner = lockup.ownerOf({ tokenId: defaultStreamId });
+ address expectedNFTOwner = users.recipient;
assertEq(actualNFTowner, expectedNFTOwner, "NFT owner");
}
- function test_Withdraw_RecipientNotContract()
+ function test_Withdraw_RecipientNotAllowedToHook()
external
whenNotDelegateCalled
givenNotNull
givenStreamNotDepleted
- whenCallerAuthorized
whenToNonZeroAddress
whenWithdrawAmountNotZero
whenNoOverdraw
+ whenWithdrawalAddressIsRecipient
whenCallerSender
givenEndTimeInTheFuture
whenStreamHasNotBeenCanceled
{
- // Set the withdraw amount to the streamed amount.
- uint128 withdrawAmount = lockup.streamedAmountOf(defaultStreamId);
-
- // Expect the assets to be transferred to the Recipient.
- expectCallToTransfer({ to: users.recipient, amount: withdrawAmount });
+ // Create the stream with a recipient contract that implements {ISablierLockupRecipient}.
+ uint256 streamId = createDefaultStreamWithRecipient(address(recipientGood));
- // Expect the relevant event to be emitted.
- vm.expectEmit({ emitter: address(lockup) });
- emit WithdrawFromLockupStream({
- streamId: defaultStreamId,
- to: users.recipient,
- asset: dai,
- amount: withdrawAmount
+ // Expect Sablier to NOT run the recipient hook.
+ uint128 withdrawAmount = lockup.withdrawableAmountOf(streamId);
+ vm.expectCall({
+ callee: address(recipientGood),
+ data: abi.encodeCall(
+ ISablierLockupRecipient.onSablierLockupWithdraw,
+ (streamId, users.sender, address(recipientGood), withdrawAmount)
+ ),
+ count: 0
});
// Make the withdrawal.
- lockup.withdraw({ streamId: defaultStreamId, to: users.recipient, amount: withdrawAmount });
-
- // Assert that the stream's status is still "STREAMING".
- Lockup.Status actualStatus = lockup.statusOf(defaultStreamId);
- Lockup.Status expectedStatus = Lockup.Status.STREAMING;
- assertEq(actualStatus, expectedStatus);
+ lockup.withdraw({ streamId: streamId, to: address(recipientGood), amount: withdrawAmount });
// Assert that the withdrawn amount has been updated.
- uint128 actualWithdrawnAmount = lockup.getWithdrawnAmount(defaultStreamId);
+ uint128 actualWithdrawnAmount = lockup.getWithdrawnAmount(streamId);
uint128 expectedWithdrawnAmount = withdrawAmount;
assertEq(actualWithdrawnAmount, expectedWithdrawnAmount, "withdrawnAmount");
}
- modifier givenRecipientContract() {
- _;
- }
-
- function test_Withdraw_RecipientDoesNotImplementHook()
+ function test_Withdraw_RecipientReverting()
external
whenNotDelegateCalled
givenNotNull
givenStreamNotDepleted
- whenCallerAuthorized
whenToNonZeroAddress
whenWithdrawAmountNotZero
whenNoOverdraw
+ whenWithdrawalAddressIsRecipient
whenCallerSender
givenEndTimeInTheFuture
whenStreamHasNotBeenCanceled
- givenRecipientContract
+ givenRecipientAllowedToHook
{
- // Create the stream with a no-op contract as the stream's recipient.
- uint256 streamId = createDefaultStreamWithRecipient(address(noop));
+ // Allow the recipient to hook.
+ resetPrank({ msgSender: users.admin });
+ lockup.allowToHook(address(recipientReverting));
+ resetPrank({ msgSender: users.sender });
- // Expect a call to the hook.
- vm.expectCall(
- address(noop),
- abi.encodeCall(
- ISablierV2LockupRecipient.onStreamWithdrawn,
- (streamId, users.sender, address(noop), defaults.WITHDRAW_AMOUNT())
- )
- );
-
- // Make the withdrawal.
- lockup.withdraw({ streamId: streamId, to: address(noop), amount: defaults.WITHDRAW_AMOUNT() });
-
- // Assert that the stream's status is still "STREAMING".
- Lockup.Status actualStatus = lockup.statusOf(streamId);
- Lockup.Status expectedStatus = Lockup.Status.STREAMING;
- assertEq(actualStatus, expectedStatus);
+ // Create the stream with a reverting contract as the stream's recipient.
+ uint256 streamId = createDefaultStreamWithRecipient(address(recipientReverting));
- // Assert that the withdrawn amount has been updated.
- uint128 actualWithdrawnAmount = lockup.getWithdrawnAmount(streamId);
- uint128 expectedWithdrawnAmount = defaults.WITHDRAW_AMOUNT();
- assertEq(actualWithdrawnAmount, expectedWithdrawnAmount, "withdrawnAmount");
- }
+ // Expect a revert.
+ uint128 withdrawAmount = defaults.WITHDRAW_AMOUNT();
+ vm.expectRevert("You shall not pass");
- modifier givenRecipientImplementsHook() {
- _;
+ // Make the withdrawal.
+ lockup.withdraw({ streamId: streamId, to: address(recipientReverting), amount: withdrawAmount });
}
- function test_Withdraw_RecipientReverts()
+ function test_Cancel_RecipientReturnsInvalidSelector()
external
whenNotDelegateCalled
givenNotNull
givenStreamNotDepleted
- whenCallerAuthorized
whenToNonZeroAddress
whenWithdrawAmountNotZero
whenNoOverdraw
+ whenWithdrawalAddressIsRecipient
whenCallerSender
givenEndTimeInTheFuture
whenStreamHasNotBeenCanceled
- givenRecipientContract
- givenRecipientImplementsHook
+ givenRecipientAllowedToHook
+ whenRecipientNotReverting
{
- // Create the stream with a reverting contract as the stream's recipient.
- uint256 streamId = createDefaultStreamWithRecipient(address(revertingRecipient));
+ // Allow the recipient to hook.
+ resetPrank({ msgSender: users.admin });
+ lockup.allowToHook(address(recipientInvalidSelector));
+ resetPrank({ msgSender: users.sender });
- // Expect a call to the hook.
- vm.expectCall(
- address(revertingRecipient),
- abi.encodeCall(
- ISablierV2LockupRecipient.onStreamWithdrawn,
- (streamId, users.sender, address(revertingRecipient), defaults.WITHDRAW_AMOUNT())
+ // Create the stream with a recipient contract that returns invalid selector bytes on the hook call.
+ uint256 streamId = createDefaultStreamWithRecipient(address(recipientInvalidSelector));
+
+ // Expect a revert.
+ uint128 withdrawAmount = defaults.WITHDRAW_AMOUNT();
+ vm.expectRevert(
+ abi.encodeWithSelector(
+ Errors.SablierV2Lockup_InvalidHookSelector.selector, address(recipientInvalidSelector)
)
);
- // Make the withdrawal.
- lockup.withdraw({ streamId: streamId, to: address(revertingRecipient), amount: defaults.WITHDRAW_AMOUNT() });
-
- // Assert that the stream's status is still "STREAMING".
- Lockup.Status actualStatus = lockup.statusOf(streamId);
- Lockup.Status expectedStatus = Lockup.Status.STREAMING;
- assertEq(actualStatus, expectedStatus);
-
- // Assert that the withdrawn amount has been updated.
- uint128 actualWithdrawnAmount = lockup.getWithdrawnAmount(streamId);
- uint128 expectedWithdrawnAmount = defaults.WITHDRAW_AMOUNT();
- assertEq(actualWithdrawnAmount, expectedWithdrawnAmount, "withdrawnAmount");
- }
-
- modifier whenRecipientDoesNotRevert() {
- _;
+ // Cancel the stream.
+ lockup.withdraw({ streamId: streamId, to: address(recipientInvalidSelector), amount: withdrawAmount });
}
- function test_Withdraw_RecipientReentrancy()
+ function test_Withdraw_RecipientReentrant()
external
whenNotDelegateCalled
givenNotNull
givenStreamNotDepleted
- whenCallerAuthorized
whenToNonZeroAddress
whenWithdrawAmountNotZero
whenNoOverdraw
+ whenWithdrawalAddressIsRecipient
whenCallerSender
givenEndTimeInTheFuture
whenStreamHasNotBeenCanceled
- givenRecipientContract
- givenRecipientImplementsHook
- whenRecipientDoesNotRevert
+ givenRecipientAllowedToHook
+ whenRecipientNotReverting
+ whenRecipientReturnsSelector
{
+ // Allow the recipient to hook.
+ resetPrank({ msgSender: users.admin });
+ lockup.allowToHook(address(recipientReentrant));
+ resetPrank({ msgSender: users.sender });
+
// Create the stream with a reentrant contract as the stream's recipient.
- uint256 streamId = createDefaultStreamWithRecipient(address(reentrantRecipient));
+ uint256 streamId = createDefaultStreamWithRecipient(address(recipientReentrant));
// Halve the withdraw amount so that the recipient can re-entry and make another withdrawal.
uint128 withdrawAmount = defaults.WITHDRAW_AMOUNT() / 2;
- // Expect a call to the hook.
- vm.expectCall(
- address(reentrantRecipient),
- abi.encodeCall(
- ISablierV2LockupRecipient.onStreamWithdrawn,
- (streamId, users.sender, address(reentrantRecipient), withdrawAmount)
- )
- );
-
// Make the withdrawal.
- lockup.withdraw({ streamId: streamId, to: address(reentrantRecipient), amount: withdrawAmount });
+ lockup.withdraw({ streamId: streamId, to: address(recipientReentrant), amount: withdrawAmount });
// Assert that the stream's status is still "STREAMING".
Lockup.Status actualStatus = lockup.statusOf(streamId);
@@ -455,42 +474,43 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
assertEq(actualWithdrawnAmount, expectedWithdrawnAmount, "withdrawnAmount");
}
- modifier whenNoRecipientReentrancy() {
- _;
- }
-
function test_Withdraw()
external
whenNotDelegateCalled
givenNotNull
givenStreamNotDepleted
- whenCallerAuthorized
whenToNonZeroAddress
whenWithdrawAmountNotZero
whenNoOverdraw
+ whenWithdrawalAddressIsRecipient
whenCallerSender
givenEndTimeInTheFuture
whenStreamHasNotBeenCanceled
- givenRecipientContract
- givenRecipientImplementsHook
- whenRecipientDoesNotRevert
- whenNoRecipientReentrancy
+ givenRecipientAllowedToHook
+ whenRecipientNotReverting
+ whenRecipientReturnsSelector
+ whenRecipientNotReentrant
{
+ // Allow the recipient to hook.
+ resetPrank({ msgSender: users.admin });
+ lockup.allowToHook(address(recipientGood));
+ resetPrank({ msgSender: users.sender });
+
// Create the stream with a contract as the stream's recipient.
- uint256 streamId = createDefaultStreamWithRecipient(address(goodRecipient));
+ uint256 streamId = createDefaultStreamWithRecipient(address(recipientGood));
- // Set the withdraw amount to the streamed amount.
- uint128 withdrawAmount = lockup.streamedAmountOf(streamId);
+ // Set the withdraw amount to the default amount.
+ uint128 withdrawAmount = defaults.WITHDRAW_AMOUNT();
// Expect the assets to be transferred to the recipient contract.
- expectCallToTransfer({ to: address(goodRecipient), amount: withdrawAmount });
+ expectCallToTransfer({ to: address(recipientGood), value: withdrawAmount });
- // Expect a call to the hook.
+ // Expect a call to the hook if the recipient is a contract.
vm.expectCall(
- address(goodRecipient),
+ address(recipientGood),
abi.encodeCall(
- ISablierV2LockupRecipient.onStreamWithdrawn,
- (streamId, users.sender, address(goodRecipient), withdrawAmount)
+ ISablierLockupRecipient.onSablierLockupWithdraw,
+ (streamId, users.sender, address(recipientGood), withdrawAmount)
)
);
@@ -498,7 +518,7 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
vm.expectEmit({ emitter: address(lockup) });
emit WithdrawFromLockupStream({
streamId: streamId,
- to: address(goodRecipient),
+ to: address(recipientGood),
asset: dai,
amount: withdrawAmount
});
@@ -506,7 +526,7 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
emit MetadataUpdate({ _tokenId: streamId });
// Make the withdrawal.
- lockup.withdraw({ streamId: streamId, to: address(goodRecipient), amount: withdrawAmount });
+ lockup.withdraw({ streamId: streamId, to: address(recipientGood), amount: withdrawAmount });
// Assert that the stream's status is still "STREAMING".
Lockup.Status actualStatus = lockup.statusOf(streamId);
diff --git a/test/integration/concrete/lockup/withdraw/withdraw.tree b/test/integration/concrete/lockup/withdraw/withdraw.tree
index c36b88582..32a43c469 100644
--- a/test/integration/concrete/lockup/withdraw/withdraw.tree
+++ b/test/integration/concrete/lockup/withdraw/withdraw.tree
@@ -2,72 +2,75 @@ withdraw.t.sol
├── when delegate called
│ └── it should revert
└── when not delegate called
- ├── given the id references a null stream
- │ └── it should revert
- └── given the id does not reference a null stream
- ├── given the stream's status is "DEPLETED"
- │ └── it should revert
- └── given the stream's status is not "DEPLETED"
- ├── when the caller is unauthorized
- │ ├── when the caller is the sender
- │ │ └── it should revert
- │ ├── when the caller is a malicious third party
- │ │ └── it should revert
- │ └── when the caller is a former recipient
- │ └── it should revert
- └── when the caller is authorized
- ├── when the provided address is zero
- │ └── it should revert
- └── when the provided address is not zero
- ├── when the withdraw amount is zero
- │ └── it should revert
- └── when the withdraw amount is not zero
- ├── when the withdraw amount overdraws
- │ └── it should revert
- └── when the withdraw amount does not overdraw
- ├── when the caller is the recipient
- │ ├── it should make the withdrawal
- │ └── it should update the withdrawn amount
- ├── when the caller is an approved third party
- │ ├── it should make the withdrawal
- │ └── it should update the withdrawn amount
- └── when the caller is the sender
- ├── given the end time is not in the future
- │ ├── it should make the withdrawal
- │ ├── it should mark the stream as depleted
- │ └── it should make the stream not cancelable
- └── given the end time is in the future
- ├── given the stream has been canceled
- │ ├── it should make the withdrawal
- │ ├── it should mark the stream as depleted
- │ ├── it should update the withdrawn amount
- │ ├── it should call the recipient hook
- │ ├── it should emit a {MetadataUpdate} event
- │ └── it should emit a {WithdrawFromLockupStream} event
- └── given the stream has not been canceled
- ├── given the recipient is not a contract
- │ └── it should make the withdrawal
- │ └── it should update the withdrawn amount
- └── given the recipient is a contract
- ├── given the recipient does not implement the hook
- │ ├── it should make the withdrawal
- │ ├── it should update the withdrawn amount
- │ ├── it should call the recipient hook
- │ └── it should ignore the revert
- └── given the recipient implements the hook
- ├── when the recipient reverts
- │ ├── it should make the withdrawal
- │ ├── it should update the withdrawn amount
- │ ├── it should call the recipient hook
- │ └── it should ignore the revert
- └── when the recipient does not revert
- ├── when there is reentrancy
- │ ├── it should make multiple withdrawals
- │ ├── it should update the withdrawn amounts
- │ └── it should call the recipient hooks
- └── when there is no reentrancy
- ├── it should make the withdrawal
- ├── it should update the withdrawn amount
- ├── it should call the recipient hook
- ├── it should emit a {MetadataUpdate} event
- └── it should emit a {WithdrawFromLockupStream} event
+ ├── given the ID references a null stream
+ │ └── it should revert
+ └── given the ID does not reference a null stream
+ ├── given the stream's status is "DEPLETED"
+ │ └── it should revert
+ └── given the stream's status is not "DEPLETED"
+ ├── when the provided address is zero
+ │ └── it should revert
+ └── when the provided address is not zero
+ ├── when the withdraw amount is zero
+ │ └── it should revert
+ └── when the withdraw amount is not zero
+ ├── when the withdraw amount overdraws
+ │ └── it should revert
+ └── when the withdraw amount does not overdraw
+ ├── when the withdrawal address is not the stream recipient
+ │ ├── when the caller is unknown
+ │ │ └── it should revert
+ │ ├── when the caller is the sender
+ │ │ └── it should revert
+ │ ├── when the caller is a former recipient
+ │ │ └── it should revert
+ │ ├── when the caller is an approved third party
+ │ │ ├── it should make the withdrawal
+ │ │ └── it should update the withdrawn amount
+ │ └── when the caller is the recipient
+ │ ├── it should make the withdrawal
+ │ ├── it should update the withdrawn amount
+ │ ├── it should emit a {MetadataUpdate} event
+ │ └── it should emit a {WithdrawFromLockupStream} event
+ └── when the withdrawal address is the stream recipient
+ ├── when the caller is unknown
+ │ ├── it should make the withdrawal
+ │ └── it should update the withdrawn amount
+ ├── when the caller is the recipient
+ │ ├── it should make the withdrawal
+ │ └── it should update the withdrawn amount
+ └── when the caller is the sender
+ ├── given the end time is not in the future
+ │ ├── it should make the withdrawal
+ │ ├── it should mark the stream as depleted
+ │ └── it should make the stream not cancelable
+ └── given the end time is in the future
+ ├── given the stream has been canceled
+ │ ├── it should make the withdrawal
+ │ ├── it should mark the stream as depleted
+ │ ├── it should update the withdrawn amount
+ │ ├── it should make Sablier run the recipient hook
+ │ ├── it should emit a {MetadataUpdate} event
+ │ └── it should emit a {WithdrawFromLockupStream} event
+ └── given the stream has not been canceled
+ ├── given the recipient is not allowed to hook
+ │ ├── it should make the withdrawal
+ │ ├── it should update the withdrawn amount
+ │ └── it should not make Sablier run the recipient hook
+ └── given the recipient is allowed to hook
+ ├── when the recipient reverts
+ │ └── it should revert the entire transaction
+ └── when the recipient does not revert
+ ├── when the recipient hook does not return a valid selector
+ │ └── it should revert
+ └── when the recipient hook returns a valid selector
+ ├── when there is reentrancy
+ │ ├── it should make multiple withdrawals
+ │ ├── it should update the withdrawn amounts
+ │ └── it should make Sablier run the recipient hook
+ └── when there is no reentrancy
+ ├── it should make the withdrawal
+ ├── it should update the withdrawn amount
+ ├── it should make Sablier run the recipient hook
+ ├── it should emit a {MetadataUpdate} event
+ └── it should emit a {WithdrawFromLockupStream} event
diff --git a/test/integration/concrete/lockup/withdrawable-amount-of/withdrawableAmountOf.t.sol b/test/integration/concrete/lockup/withdrawable-amount-of/withdrawableAmountOf.t.sol
index 5f38eceb8..7677fd2b2 100644
--- a/test/integration/concrete/lockup/withdrawable-amount-of/withdrawableAmountOf.t.sol
+++ b/test/integration/concrete/lockup/withdrawable-amount-of/withdrawableAmountOf.t.sol
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
import { Errors } from "src/libraries/Errors.sol";
@@ -25,7 +25,7 @@ abstract contract WithdrawableAmountOf_Integration_Concrete_Test is
givenNotNull
givenStreamHasBeenCanceled
{
- vm.warp({ timestamp: defaults.CLIFF_TIME() });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() });
lockup.cancel(defaultStreamId);
uint128 actualWithdrawableAmount = lockup.withdrawableAmountOf(defaultStreamId);
uint256 expectedWithdrawableAmount = defaults.CLIFF_AMOUNT();
@@ -38,31 +38,31 @@ abstract contract WithdrawableAmountOf_Integration_Concrete_Test is
givenNotNull
givenStreamHasBeenCanceled
{
- vm.warp({ timestamp: defaults.CLIFF_TIME() });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() });
lockup.cancel(defaultStreamId);
lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
- vm.warp({ timestamp: defaults.CLIFF_TIME() + 10 seconds });
+ vm.warp({ newTimestamp: defaults.CLIFF_TIME() + 10 seconds });
uint128 actualWithdrawableAmount = lockup.withdrawableAmountOf(defaultStreamId);
uint128 expectedWithdrawableAmount = 0;
assertEq(actualWithdrawableAmount, expectedWithdrawableAmount, "withdrawableAmount");
}
function test_WithdrawableAmountOf_StatusPending() external givenNotNull givenStreamHasNotBeenCanceled {
- vm.warp({ timestamp: getBlockTimestamp() - 1 seconds });
+ vm.warp({ newTimestamp: getBlockTimestamp() - 1 seconds });
uint128 actualWithdrawableAmount = lockup.withdrawableAmountOf(defaultStreamId);
uint128 expectedWithdrawableAmount = 0;
assertEq(actualWithdrawableAmount, expectedWithdrawableAmount, "withdrawableAmount");
}
function test_WithdrawableAmountOf_StatusSettled() external givenNotNull givenStreamHasNotBeenCanceled {
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
uint128 actualWithdrawableAmount = lockup.withdrawableAmountOf(defaultStreamId);
uint128 expectedWithdrawableAmount = defaults.DEPOSIT_AMOUNT();
assertEq(actualWithdrawableAmount, expectedWithdrawableAmount, "withdrawableAmount");
}
function test_WithdrawableAmountOf_StatusDepleted() external givenNotNull givenStreamHasNotBeenCanceled {
- vm.warp({ timestamp: defaults.END_TIME() });
+ vm.warp({ newTimestamp: defaults.END_TIME() });
lockup.withdrawMax({ streamId: defaultStreamId, to: users.recipient });
uint128 actualWithdrawableAmount = lockup.withdrawableAmountOf(defaultStreamId);
uint128 expectedWithdrawableAmount = 0;
diff --git a/test/integration/concrete/lockup/withdrawable-amount-of/withdrawableAmountOf.tree b/test/integration/concrete/lockup/withdrawable-amount-of/withdrawableAmountOf.tree
index 27c4896ef..183bddf1b 100644
--- a/test/integration/concrete/lockup/withdrawable-amount-of/withdrawableAmountOf.tree
+++ b/test/integration/concrete/lockup/withdrawable-amount-of/withdrawableAmountOf.tree
@@ -1,7 +1,7 @@
withdrawableAmountOf.t.sol
-├── given the id references a null stream
+├── given the ID references a null stream
│ └── it should revert
-└── given the id does not reference a null stream
+└── given the ID does not reference a null stream
├── given the stream has been canceled
│ ├── given the stream's status is "CANCELED"
│ │ └── it should return the correct withdrawable amount
diff --git a/test/integration/concrete/nft-descriptor/generateAccentColor.t.sol b/test/integration/concrete/nft-descriptor/generateAccentColor.t.sol
index 4e956be9c..d064e9c3f 100644
--- a/test/integration/concrete/nft-descriptor/generateAccentColor.t.sol
+++ b/test/integration/concrete/nft-descriptor/generateAccentColor.t.sol
@@ -1,11 +1,12 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
-import { NFTDescriptor_Integration_Concrete_Test } from "./NFTDescriptor.t.sol";
+import { NFTDescriptor_Integration_Shared_Test } from "../../shared/nft-descriptor/NFTDescriptor.t.sol";
-contract GenerateAccentColor_Integration_Concrete_Test is NFTDescriptor_Integration_Concrete_Test {
- function test_GenerateAccentColor() external {
+contract GenerateAccentColor_Integration_Concrete_Test is NFTDescriptor_Integration_Shared_Test {
+ function test_GenerateAccentColor() external view {
// Passing a dummy contract instead of a real Sablier contract to make this test easy to maintain.
+ // Note: the address of `noop` depends on the order of the state variables in {Base_Test}.
string memory actualColor = nftDescriptorMock.generateAccentColor_({ sablier: address(noop), streamId: 1337 });
string memory expectedColor = "hsl(302,69%,44%)";
assertEq(actualColor, expectedColor, "accentColor");
diff --git a/test/integration/concrete/nft-descriptor/is-allowed-character/IsAllowedCharacter.t.sol b/test/integration/concrete/nft-descriptor/is-allowed-character/IsAllowedCharacter.t.sol
new file mode 100644
index 000000000..95c4ea4a8
--- /dev/null
+++ b/test/integration/concrete/nft-descriptor/is-allowed-character/IsAllowedCharacter.t.sol
@@ -0,0 +1,104 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22 <0.9.0;
+
+import { NFTDescriptor_Integration_Shared_Test } from "../../../shared/nft-descriptor/NFTDescriptor.t.sol";
+
+contract IsAllowedCharacter_Integration_Concrete_Test is NFTDescriptor_Integration_Shared_Test {
+ function test_IsAllowedCharacter_EmptyString() external view {
+ string memory symbol = "";
+ bool result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertTrue(result, "isAllowedCharacter");
+ }
+
+ modifier whenNotEmptyString() {
+ _;
+ }
+
+ function test_IsAllowedCharacter_ContainsUnsupportedCharacters() external view whenNotEmptyString {
+ string memory symbol = "";
+ bool result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertFalse(result, "isAllowedCharacter");
+
+ symbol = "foo/";
+ result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertFalse(result, "isAllowedCharacter");
+
+ symbol = "foo\\";
+ result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertFalse(result, "isAllowedCharacter");
+
+ symbol = "foo%";
+ result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertFalse(result, "isAllowedCharacter");
+
+ symbol = "foo&";
+ result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertFalse(result, "isAllowedCharacter");
+
+ symbol = "foo(";
+ result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertFalse(result, "isAllowedCharacter");
+
+ symbol = "foo)";
+ result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertFalse(result, "isAllowedCharacter");
+
+ symbol = "foo\"";
+ result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertFalse(result, "isAllowedCharacter");
+
+ symbol = "foo'";
+ result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertFalse(result, "isAllowedCharacter");
+
+ symbol = "foo`";
+ result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertFalse(result, "isAllowedCharacter");
+
+ symbol = "foo;";
+ result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertFalse(result, "isAllowedCharacter");
+
+ symbol = "foo%20"; // URL-encoded empty space
+ result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertFalse(result, "isAllowedCharacter");
+ }
+
+ modifier whenOnlySupportedCharacters() {
+ _;
+ }
+
+ function test_IsAllowedCharacter() external view whenNotEmptyString whenOnlySupportedCharacters {
+ string memory symbol = "foo";
+ bool result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertTrue(result, "isAllowedCharacter");
+
+ symbol = "Foo";
+ result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertTrue(result, "isAllowedCharacter");
+
+ symbol = "Foo ";
+ result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertTrue(result, "isAllowedCharacter");
+
+ symbol = "Foo Bar";
+ result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertTrue(result, "isAllowedCharacter");
+
+ symbol = "Bar-Foo";
+ result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertTrue(result, "isAllowedCharacter");
+
+ symbol = " ";
+ result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertTrue(result, "isAllowedCharacter");
+
+ symbol = "foo01234";
+ result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertTrue(result, "isAllowedCharacter");
+
+ symbol = "123456789";
+ result = nftDescriptorMock.isAllowedCharacter_(symbol);
+ assertTrue(result, "isAllowedCharacter");
+ }
+}
diff --git a/test/integration/concrete/nft-descriptor/is-allowed-character/IsAllowedCharacter.tree b/test/integration/concrete/nft-descriptor/is-allowed-character/IsAllowedCharacter.tree
new file mode 100644
index 000000000..924004a0a
--- /dev/null
+++ b/test/integration/concrete/nft-descriptor/is-allowed-character/IsAllowedCharacter.tree
@@ -0,0 +1,8 @@
+isAllowedCharacter.t.sol
+├── when the symbol is an empty string
+│ └── it should return true
+└── when the symbol is not an empty string
+ ├── given the symbol contain unsupported characters
+ │ └── it should return false
+ └── given the symbol contains only supported characters
+ └── it should return true
diff --git a/test/integration/concrete/nft-descriptor/map-symbol/mapSymbol.t.sol b/test/integration/concrete/nft-descriptor/map-symbol/mapSymbol.t.sol
index 16051f57d..e023c8e6b 100644
--- a/test/integration/concrete/nft-descriptor/map-symbol/mapSymbol.t.sol
+++ b/test/integration/concrete/nft-descriptor/map-symbol/mapSymbol.t.sol
@@ -1,32 +1,40 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
-import { ERC721 } from "@openzeppelin/contracts/token/ERC721/ERC721.sol";
+import { IERC721Metadata } from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol";
+import { MockERC721 } from "forge-std/src/mocks/MockERC721.sol";
import { Errors } from "src/libraries/Errors.sol";
-import { NFTDescriptor_Integration_Concrete_Test } from "../NFTDescriptor.t.sol";
+import { NFTDescriptor_Integration_Shared_Test } from "../../../shared/nft-descriptor/NFTDescriptor.t.sol";
-contract MapSymbol_Integration_Concrete_Test is NFTDescriptor_Integration_Concrete_Test {
+contract MapSymbol_Integration_Concrete_Test is NFTDescriptor_Integration_Shared_Test {
function test_RevertGiven_UnknownNFT() external {
- ERC721 nft = new ERC721("Foo NFT", "FOO");
+ MockERC721 nft = new MockERC721();
+ nft.initialize("Foo", "FOO");
vm.expectRevert(abi.encodeWithSelector(Errors.SablierV2NFTDescriptor_UnknownNFT.selector, nft, "FOO"));
- nftDescriptorMock.mapSymbol_(nft);
+ nftDescriptorMock.mapSymbol_(IERC721Metadata(address(nft)));
}
modifier givenKnownNFT() {
_;
}
- function test_MapSymbol_LockupDynamic() external givenKnownNFT {
- string memory actualStreamingModel = nftDescriptorMock.mapSymbol_(lockupDynamic);
- string memory expectedStreamingModel = "Lockup Dynamic";
- assertEq(actualStreamingModel, expectedStreamingModel, "streamingModel");
+ function test_MapSymbol_LockupDynamic() external view givenKnownNFT {
+ string memory actualSablierModel = nftDescriptorMock.mapSymbol_(lockupDynamic);
+ string memory expectedSablierModel = "Lockup Dynamic";
+ assertEq(actualSablierModel, expectedSablierModel, "sablierModel");
}
- function test_MapSymbol_LockupLinear() external givenKnownNFT {
- string memory actualStreamingModel = nftDescriptorMock.mapSymbol_(lockupLinear);
- string memory expectedStreamingModel = "Lockup Linear";
- assertEq(actualStreamingModel, expectedStreamingModel, "streamingModel");
+ function test_MapSymbol_LockupLinear() external view givenKnownNFT {
+ string memory actualSablierModel = nftDescriptorMock.mapSymbol_(lockupLinear);
+ string memory expectedSablierModel = "Lockup Linear";
+ assertEq(actualSablierModel, expectedSablierModel, "sablierModel");
+ }
+
+ function test_MapSymbol_LockupTranched() external view givenKnownNFT {
+ string memory actualSablierModel = nftDescriptorMock.mapSymbol_(lockupTranched);
+ string memory expectedSablierModel = "Lockup Tranched";
+ assertEq(actualSablierModel, expectedSablierModel, "sablierModel");
}
}
diff --git a/test/integration/concrete/nft-descriptor/safe-asset-decimals/safeAssetDecimals.t.sol b/test/integration/concrete/nft-descriptor/safe-asset-decimals/safeAssetDecimals.t.sol
index e22d505e9..70e4677a6 100644
--- a/test/integration/concrete/nft-descriptor/safe-asset-decimals/safeAssetDecimals.t.sol
+++ b/test/integration/concrete/nft-descriptor/safe-asset-decimals/safeAssetDecimals.t.sol
@@ -1,17 +1,17 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
+pragma solidity >=0.8.22 <0.9.0;
-import { NFTDescriptor_Integration_Concrete_Test } from "../NFTDescriptor.t.sol";
+import { NFTDescriptor_Integration_Shared_Test } from "../../../shared/nft-descriptor/NFTDescriptor.t.sol";
-contract SafeAssetDecimals_Integration_Concrete_Test is NFTDescriptor_Integration_Concrete_Test {
- function test_SafeAssetDecimals_EOA() external {
+contract SafeAssetDecimals_Integration_Concrete_Test is NFTDescriptor_Integration_Shared_Test {
+ function test_SafeAssetDecimals_EOA() external view {
address eoa = vm.addr({ privateKey: 1 });
uint8 actualDecimals = nftDescriptorMock.safeAssetDecimals_(address(eoa));
uint8 expectedDecimals = 0;
assertEq(actualDecimals, expectedDecimals, "decimals");
}
- function test_SafeAssetDecimals_DecimalsNotImplemented() external {
+ function test_SafeAssetDecimals_DecimalsNotImplemented() external view {
uint8 actualDecimals = nftDescriptorMock.safeAssetDecimals_(address(noop));
uint8 expectedDecimals = 0;
assertEq(actualDecimals, expectedDecimals, "decimals");
@@ -21,7 +21,7 @@ contract SafeAssetDecimals_Integration_Concrete_Test is NFTDescriptor_Integratio
_;
}
- function test_SafeAssetDecimals() external whenAssetDecimalsDefined {
+ function test_SafeAssetDecimals() external view whenAssetDecimalsDefined {
uint8 actualDecimals = nftDescriptorMock.safeAssetDecimals_(address(dai));
uint8 expectedDecimals = dai.decimals();
assertEq(actualDecimals, expectedDecimals, "decimals");
diff --git a/test/integration/concrete/nft-descriptor/safe-asset-symbol/safeAssetSymbol.t.sol b/test/integration/concrete/nft-descriptor/safe-asset-symbol/safeAssetSymbol.t.sol
index 74188c22a..f2e1e9a10 100644
--- a/test/integration/concrete/nft-descriptor/safe-asset-symbol/safeAssetSymbol.t.sol
+++ b/test/integration/concrete/nft-descriptor/safe-asset-symbol/safeAssetSymbol.t.sol
@@ -1,20 +1,19 @@
// SPDX-License-Identifier: UNLICENSED
-pragma solidity >=0.8.19 <0.9.0;
-
-import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
+pragma solidity >=0.8.22 <0.9.0;
+import { ERC20Mock } from "../../../../mocks/erc20/ERC20Mock.sol";
import { ERC20Bytes32 } from "../../../../mocks/erc20/ERC20Bytes32.sol";
-import { NFTDescriptor_Integration_Concrete_Test } from "../NFTDescriptor.t.sol";
+import { NFTDescriptor_Integration_Shared_Test } from "../../../shared/nft-descriptor/NFTDescriptor.t.sol";
-contract SafeAssetSymbol_Integration_Concrete_Test is NFTDescriptor_Integration_Concrete_Test {
- function test_SafeAssetSymbol_EOA() external {
+contract SafeAssetSymbol_Integration_Concrete_Test is NFTDescriptor_Integration_Shared_Test {
+ function test_SafeAssetSymbol_EOA() external view {
address eoa = vm.addr({ privateKey: 1 });
string memory actualSymbol = nftDescriptorMock.safeAssetSymbol_(address(eoa));
string memory expectedSymbol = "ERC20";
assertEq(actualSymbol, expectedSymbol, "symbol");
}
- function test_SafeAssetSymbol_SymbolNotImplemented() external {
+ function test_SafeAssetSymbol_SymbolNotImplemented() external view {
string memory actualSymbol = nftDescriptorMock.safeAssetSymbol_(address(noop));
string memory expectedSymbol = "ERC20";
assertEq(actualSymbol, expectedSymbol, "symbol");
@@ -36,9 +35,9 @@ contract SafeAssetSymbol_Integration_Concrete_Test is NFTDescriptor_Integration_
}
function test_SafeAssetSymbol_LongSymbol() external whenERC20Contract givenSymbolString {
- ERC20 asset = new ERC20({
- name_: "Token",
- symbol_: "This symbol is has more than 30 characters and it should be ignored"
+ ERC20Mock asset = new ERC20Mock({
+ name: "Token",
+ symbol: "This symbol is has more than 30 characters and it should be ignored"
});
string memory actualSymbol = nftDescriptorMock.safeAssetSymbol_(address(asset));
string memory expectedSymbol = "Long Symbol";
@@ -49,7 +48,25 @@ contract SafeAssetSymbol_Integration_Concrete_Test is NFTDescriptor_Integration_
_;
}
- function test_SafeAssetSymbol() external whenERC20Contract givenSymbolString givenSymbolNotLong {
+ function test_SafeAssetSymbol_NonAlphanumeric() external whenERC20Contract givenSymbolString givenSymbolNotLong {
+ ERC20Mock asset = new ERC20Mock({ name: "Token", symbol: "