Timeswap contest - delfin454000's results

Summary

Low risk findings

Non-critical findings

Low risk findings

CallbackParam.sol

https://github.com/code-423n4/2023-01-timeswap/blob/main/packages/v2-pool/src/structs/CallbackParam.sol

https://github.com/code-423n4/2023-01-timeswap/blob/main/packages/v2-token/src/structs/CallbackParam.sol

https://github.com/code-423n4/2023-01-timeswap/blob/main/packages/v2-option/src/structs/CallbackParam.sol

NoDelegateCall.sol

https://github.com/code-423n4/2023-01-timeswap/blob/main/packages/v2-pool/src/NoDelegateCall.sol

https://github.com/code-423n4/2023-01-timeswap/blob/main/packages/v2-option/src/NoDelegateCall.sol

Param.sol

https://github.com/code-423n4/2023-01-timeswap/blob/main/packages/v2-pool/src/structs/Param.sol

https://github.com/code-423n4/2023-01-timeswap/blob/main/packages/v2-option/src/structs/Param.sol

Position.sol

https://github.com/code-423n4/2023-01-timeswap/blob/main/packages/v2-token/src/structs/Position.sol

https://github.com/code-423n4/2023-01-timeswap/blob/main/packages/v2-option/src/enums/Position.sol

Transaction.sol

https://github.com/code-423n4/2023-01-timeswap/blob/main/packages/v2-pool/src/enums/Transaction.sol

https://github.com/code-423n4/2023-01-timeswap/blob/main/packages/v2-option/src/enums/Transaction.sol

---

---

Non-critical findings

---

IOwnableTwoSteps.sol: L5-7

    /// @dev Emits when the pending owner is chosen.
    /// @param pendingOwner The new pending owner.
    event SetOwner(address pendingOwner);

---

IOwnableTwoSteps.sol: L9-11

    /// @dev Emits when the pending owner accepted and become the new owner.
    /// @param owner The new owner.
    event AcceptOwner(address owner);

---

ITimeswapV2LiquidityToken.sol: L13

    event TransferFees(address from, address to, TimeswapV2LiquidityTokenPosition position, uint256 long0Fees, uint256 long1Fees, uint256 shortFees);

---

---

---

v2-option/src/structs/Param.sol: L62

/// @param amount If isLong0ToLong1 and transaction is GivenToken0AndLong0, this is the amount of token0 withdrawn, and the amount of long0 position burnt.

Suggestion:

/// @param amount If isLong0ToLong1 and transaction is GivenToken0AndLong0, this is the 
///    amount of token0 withdrawn, and the amount of long0 position burnt.

---

v2-option/src/structs/Param.sol: L63

/// If isLong1ToLong0 and transaction is GivenToken0AndLong0, this is the amount of token0 to be deposited, and the amount of long0 position minted.

Suggestion:

/// If isLong1ToLong0 and transaction is GivenToken0AndLong0, this is the amount of
///   token0 to be deposited, and the amount of long0 position minted.

---

ConstantProduct.sol: L57

    /// @dev Calculate the amount of liquidity positions and amount of short positions from given long positions in base denomination.

Suggestion:

    /// @dev Calculate the amount of liquidity positions and amount of long positions 
    ///   in base denomination or short position whichever is larger or smaller.

---

Pool.sol: L106

    /// @dev Move short positions to short fee growth due to duration of the pool decreasing as time moves forward.

Suggestion:

    /// @dev Move short positions to short fee growth due to duration of the
    ///   pool decreasing as time moves forward.

---

v2-pool/src/structs/Param.sol: L76

/// If transaction is  GivenSum, the sum amount of long position in base denomination to be deposited, and short position to be withdrawn.

Suggestion:

/// If transaction is  GivenSum, the sum amount of long position in base
///   denomination to be deposited, and short position to be withdrawn.

---

Similarly for the following extra-long (over 120 characters) comments:

StrikeConversion.sol

L7

ITimeswapV2Pool.sol

L170, L256, L265, L299, L300, L312

ITimeswapV2PoolBurnCallback.sol

L9

ITimeswapV2PoolLeverageCallback.sol

L9

ITimeswapV2PoolMintCallback.sol

L9

ITimeswapV2PoolDeleverageCallback.sol

L9

v2-pool/src/structs/Param.sol

L96

Pool.sol

L139, L212, L253, L370, L371

ConstantProduct.sol

L57, L61, L128, L191

L216, L224, L328, L341

DurationCalculation.sol

L38, L42

ITimeswapV2Option.sol

L72, L74

ITimeswapV2OptionSwapCallback.sol

L11

ITimeswapV2OptionMintCallback.sol

L11

ITimeswapV2OptionCollectCallback.sol

L11

ITimeswapV2OptionBurnCallback.sol

L10, L11

Option.sol

L19

v2-option/src/structs/Param.sol

L15, L16, L17, L18, L38, L39

L40, L41, L60, L64, L65

---

---

---

FullMath.sol: L40

    /// @param addendA0 The least signficant part of addendA.

Change signficant to significant

---

FullMath.sol: L250

            // correct result modulo 2**256. Since the precoditions guarantee

Change precoditions to preconditions

---

The same typo (have) occurs in both lines below:

Error.sol: L15

Error.sol: L81

    /// @dev Reverts when a pool already have liquidity.

Change have to has in both cases

---

StrikeConversion.sol: L22

    /// @param amount The amount ot be converted. Token0 amount when zeroToOne. Token1 amount when oneToZero.

Change ot to to

---

The same typo (overidden) occurs in all six lines below:

TimeswapV2Pool.sol: L81

ERC1155Enumerable.sol: L69

ERC1155Enumerable.sol: L74

ERC1155Enumerable.sol: L103

ERC1155Enumerable.sol: L108

TimeswapV2Option.sol: L69

    // Can be overidden for testing purposes.

Change overidden to overridden in all cases

---

v2-token/src/structs/CallbackParam.sol: L32

/// @param data Arbitrary data passed to the callback, initalize as empty if not required.

Change initalize to initialize

---

The same typo (receipients) occurs in all seven lines below:

TimeswapV2Pool.sol: L222

TimeswapV2Pool.sol: L332

TimeswapV2Pool.sol: L446

TimeswapV2Pool.sol: L486

ITimeswapV2OptionMintCallback.sol: L12

ITimeswapV2OptionCollectCallback.sol: L12

ITimeswapV2OptionBurnCallback.sol: L12

    /// @dev Transfer long0 positions, long1 positions, and/or short positions to the receipients.

Change receipients to recipients in all cases

---

The same typo (receipient) occurs in all 54 lines below:

TimeswapV2Pool.sol

L225, L226, L227, L399

IL32, IL33, IL34, IL76

IL87, IL88, IL89, IL111

IL121, IL122, IL132, IL234, IL242

ITimeswapV2PoolRebalanceCallback.sol

L10

ITimeswapV2PoolMintCallback.sol

L10

ITimeswapV2PoolDeleverageCallback.sol

L10

v2-pool/src/structs/Param.sol

L11, L12, L13, L31

L49, L50, L51, L71

L90, L91, L112

Pool.sol

L155, L168, L178

ITimeswapV2Option

L18, L27, L28, L29

L49, L50, L69, L70

L91, L92, L145

v2-option/src/structs/Param.sol

L11, L12, L13, L35, L36

L58, L59, L81, L82

    /// @param long0To The receipient of long0 positions.

Change receipient to recipient in all cases

---

The same typo (receipeint) occurs in all three lines below:

ITimeswapV2Pool.sol: L14

ITimeswapV2Pool.sol: L22

TimeswapV2Option.sol: L69

    /// @param to The receipeint of liquidity position.

Change receipeint to recipient in each case

---

ITimeswapV2Pool.sol: L132

    /// @param to If isLong0ToLong1 then receipient of long0 positions, ekse recipient of long1 positions.

Change ekse to else

---

The same typo (receipients) occurs in all six lines below:

ITimeswapV2Pool.sol

L243, L244, L245

Pool.sol

L179, L180, L181

    /// @dev Transfer long0 positions, long1 positions, and/or short positions to the receipients.

Change receipients to recipients in all cases

---

ITimeswapV2PoolMintCallback.sol: L10

    /// @dev The liquidity positionss will already be minted to the receipient.

Change positionss to positions

---

ConstantProduct.sol: L394

    /// @return sqrtDiscriminant The square root disriminant calculated.

Change disriminant to discriminant

---

The same typo (retreived) occurs in all four lines below:

PoolFactory.sol

L27, L28, L41, L42

    /// @return optionPair The retreived option pair address. Zero address if not deployed.

Change retreived to retrieved in all cases

---

PoolPair.sol: L19

    /// @dev Checks if the pool doesn not exist.

Change doesn to does

---

The same typo (postion) occurs in both lines below:

ITimeswapV2Token.sol: L27

ITimeswapV2Token.sol: L32

    /// @dev mints TimeswapV2Token as per postion and amount

Change postion to position in both cases

---

The same typo (liqudityAmount) occurs in both lines below:

ITimeswapV2LiquidityToken.sol: L44

ITimeswapV2LiquidityToken.sol: L49

    /// @dev mints TimeswapV2LiquidityToken as per the liqudityAmount

Change liqudityAmount to liquidityAmount in both cases

---

Process.sol: L4

/// @dev Processing information required for interacting multple options in a single contract.

Change multple to multiple

---

The same typo (calback) occurs in both lines below:

v2-option/src/structs/Param.sol: L43

v2-option/src/structs/Param.sol: L88

/// @notice If data length is zero, skips the calback.

Change calback to callback in both cases

---

The same typo (maturies) occurs in both lines below:

TimeswapV2Option.sol: L31

TimeswapV2Option.sol: L47

/// @notice Holds the option of all strikes and maturies.

Change maturies to maturities in both cases

---

---

---

TimeswapV2PoolFactory.sol: L52-54

    function numberOfPairs() external view override returns (uint256) {
        return getByIndex.length;
    }

---

ITimeswapV2PoolFactory.sol: L31

    function getByIndex(uint256 id) external view returns (address optionPair);

---

ITimeswapV2PoolFactory.sol: L33

    function numberOfPairs() external view returns (uint256);

---

IERC1155Enumerable.sol: L14-16

    /// @dev Returns a token ID owned by `owner` at a given `index` of its token list.
    /// Use along with {balanceOf} to enumerate all of ``owner``'s tokens.
    function tokenOfOwnerByIndex(address owner, uint256 index) external view returns (uint256);

Missing: @param and @return statements

---

IERC1155Enumerable.sol: L18-20

    /// @dev Returns a token ID at a given `index` of all the tokens stored by the contract.
    /// Use along with {totalSupply} to enumerate all tokens.
    function tokenByIndex(uint256 index) external view returns (uint256);

Missing: @param and @return statements

---

TimeswapV2Option.sol: L76-77

    function getByIndex(uint256 id) external view override returns (StrikeAndMaturity memory) {
        return listOfOptions[id];

---

TimeswapV2Option.sol: L80-81

    function numberOfOptions() external view override returns (uint256) {
        return listOfOptions.length;

---

TimeswapV2Option.sol: L246

    function collect(TimeswapV2OptionCollectParam calldata param) external override noDelegateCall returns (uint256 token0Amount, uint256 token1Amount, uint256 shortAmount, bytes memory data) {

---

---

Pool.sol: L96-104

    /// @dev Returns the amount of sum of long0 and long1 converted to base denomination in the pool.
    /// @dev Returns the amount of short positions in the pool.
    /// @param pool The state of the pool.
    /// @return longAmount The amount of sum of long0 and long1 converted to base denomination in the pool.
    /// @return shortAmount The amount of short in the pool.
    function totalPositions(Pool storage pool, uint256 maturity, uint96 blockTimestamp) external view returns (uint256 longAmount, uint256 shortAmount) {
        longAmount = ConstantProduct.getLong(pool.liquidity, pool.sqrtInterestRate, false);
        shortAmount = ConstantProduct.getShort(pool.liquidity, pool.sqrtInterestRate, DurationCalculation.unsafeDurationFromNowToMaturity(maturity, blockTimestamp), false);
    }

Missing: @param maturity and @param blockTimestamp

---

Pool.sol: L175-183

    /// @dev Transfer fees earned of the sender to another address.
    /// @notice Does not transfer the liquidity positions of the sender.
    /// @param pool The state of the pool.
    /// @param to The receipient of the transaction fees.
    /// @param long0Fees The amount of long0 position fees transferrred.
    /// @param long1Fees The amount of long1 position fees transferrred.
    /// @param shortFees The amount of short position fees transferrred.
    /// @param blockTimestamp The current block timestamp.
    function transferFees(Pool storage pool, uint256 maturity, address to, uint256 long0Fees, uint256 long1Fees, uint256 shortFees, uint96 blockTimestamp) external {

Missing: @param maturity

---

Pool.sol: L251-269

    /// @dev Collects the transaction fees of the pool.
    /// @dev only liquidity provider can call this function.
    /// @dev if the owner enters an amount which is greater than the fee amount they have earned, withdraw only the amount they have.
    /// @param pool The state of the pool.
    /// @param blockTimestamp The current block timestamp.
    /// @param long0Requested The maximum amount of long0 positions wanted.
    /// @param long1Requested The maximum amount of long1 positions wanted.
    /// @param shortRequested The maximum amount of short positions wanted.
    /// @return long0Amount The amount of long0 collected.
    /// @return long1Amount The amount of long1 collected.
    /// @return shortAmount The amount of short collected.
    function collectTransactionFees(
        Pool storage pool,
        uint256 maturity,
        uint256 long0Requested,
        uint256 long1Requested,
        uint256 shortRequested,
        uint96 blockTimestamp
    ) external returns (uint256 long0Amount, uint256 long1Amount, uint256 shortAmount) {

Missing: @param maturity

---

---

ITimeswapV2Pool.sol: L144-145

    /// @dev Returns the factory address that deployed this contract.
    function poolFactory() external view returns (address);

---

ITimeswapV2Pool.sol: L147-148

    /// @dev Returns the Timeswap V2 Option of the pair.
    function optionPair() external view returns (address);

---

ITimeswapV2Pool.sol: L150-151

    /// @dev Returns the transaction fee earned by the liquidity providers.
    function transactionFee() external view returns (uint256);

---

ITimeswapV2Pool.sol: L153-154

    /// @dev Returns the protocol fee earned by the protocol.
    function protocolFee() external view returns (uint256);

---

ITimeswapV2Pool.sol: L156-158

    /// @dev Get the strike and maturity of the pool in the pool enumeration list.
    /// @param id The chosen index.
    function getByIndex(uint256 id) external view returns (StrikeAndMaturity memory);

---

ITimeswapV2Pool.sol: L160-161

    /// @dev Get the number of pools being interacted.
    function numberOfPools() external view returns (uint256);

---

ITimeswapV2PoolFactory.sol: L19-20

    /// @dev Returns the fixed transaction fee used by all created Timeswap V2 Pool contract.
    function transactionFee() external view returns (uint256);

---

ITimeswapV2PoolFactory.sol: L22-23

    /// @dev Returns the fixed protocol fee used by all created Timeswap V2 Pool contract.
    function protocolFee() external view returns (uint256);

---

ITimeswapV2PoolFactory.sol: L37-41

    /// @dev Creates a Timeswap V2 Pool based on option parameter.
    /// @dev Cannot create a duplicate Timeswap V2 Pool with the same option parameter.
    /// @param option The address of the option contract used by the pool.
    /// @param poolPair The address of the Timeswap V2 Pool contract created.
    function create(address option) external returns (address poolPair);

---

ITimeswapV2PoolRebalanceCallback.sol: L8-12

    /// @dev When Long0ToLong1, require the transfer of long0 position into the pool.
    /// @dev When Long1ToLong0, require the transfer of long1 position into the pool.
    /// @dev The long0 positions or long1 positions will already be minted to the receipient.
    /// @param data The bytes of data to be sent to msg.sender.
    function timeswapV2PoolRebalanceCallback(TimeswapV2PoolRebalanceCallbackParam calldata param) external returns (bytes memory data);

---

ITimeswapV2PoolLeverageCallback.sol: L16-18

    /// @dev Require the transfer of short position into the pool.
    /// @param data The bytes of data to be sent to msg.sender.
    function timeswapV2PoolLeverageCallback(TimeswapV2PoolLeverageCallbackParam calldata param) external returns (bytes memory data);

---

ITimeswapV2PoolMintCallback.sol: L16-18

    /// @dev Require the transfer of long0 position, long1 position, and short position into the pool.
    /// @param data The bytes of data to be sent to msg.sender.
    function timeswapV2PoolMintCallback(TimeswapV2PoolMintCallbackParam calldata param) external returns (bytes memory data);

---

ITimeswapV2PoolDeleverageCallback.sol: L16-18

    /// @dev Require the transfer of long0 position and long1 position into the pool.
    /// @param data The bytes of data to be sent to msg.sender.
    function timeswapV2PoolDeleverageCallback(TimeswapV2PoolDeleverageCallbackParam calldata param) external returns (bytes memory data);

---

ITimeswapV2Token.sol: L9-13

/// @title An interface for TS-V2 token system
/// @notice This interface is used to interact with TS-V2 positions
interface ITimeswapV2Token is IERC1155 {
    /// @dev Returns the factory address that deployed this contract.
    function optionFactory() external view returns (address);

---

ITimeswapV2Token.sol: L15-18

    /// @dev Returns the position Balance of the owner
    /// @param owner The owner of the token
    /// @param position type of option position (long0, long1, short)
    function positionOf(address owner, TimeswapV2TokenPosition calldata position) external view returns (uint256 amount);

---

ITimeswapV2Token.sol: L32-34

    /// @dev burns TimeswapV2Token as per postion and amount
    /// @param param The TimeswapV2TokenBurnParam
    function burn(TimeswapV2TokenBurnParam calldata param) external returns (bytes memory data);

---

ITimeswapV2LiquidityToken.sol: L23-26

    /// @dev Returns the position Balance of the owner
    /// @param owner The owner of the token
    /// @param position The liquidity position
    function positionOf(address owner, TimeswapV2LiquidityTokenPosition calldata position) external view returns (uint256 amount);

---

ITimeswapV2LiquidityToken.sol: L54-59

    /// @dev collects fees as per the fees desired
    /// @param param The TimeswapV2LiquidityTokenBurnParam
    /// @return long0Fees Fees for long0
    /// @return long1Fees Fees for long1
    /// @return shortFees Fees for short
    function collect(TimeswapV2LiquidityTokenCollectParam calldata param) external returns (uint256 long0Fees, uint256 long1Fees, uint256 shortFees, bytes memory data);

Missing: @return data

---

IERC1155Enumerable.sol: L8-12

/// @title ERC-1155 Token Standard, optional enumeration extension
/// @dev See https://eips.ethereum.org/EIPS/eip-721
interface IERC1155Enumerable is IERC1155 {
    /// @dev Returns the total amount of tokens stored by the contract.
    function totalSupply() external view returns (uint256);

---

ITimeswapV2Option.sol: L109-110

    /// @dev Returns the factory address that deployed this contract.
    function optionFactory() external view returns (address);

---

ITimeswapV2Option.sol: L112-113

    /// @dev Returns the first ERC20 token address of the pair.
    function token0() external view returns (address);

---

ITimeswapV2Option.sol: L115-116

    /// @dev Returns the second ERC20 token address of the pair.
    function token1() external view returns (address);

---

ITimeswapV2Option.sol: L118-120

    /// @dev Get the strike and maturity of the option in the option enumeration list.
    /// @param id The chosen index.
    function getByIndex(uint256 id) external view returns (StrikeAndMaturity memory);

---

ITimeswapV2Option.sol: L122-123

    /// @dev Number of options being interacted.
    function numberOfOptions() external view returns (uint256);

---

ITimeswapV2Option.sol: L161-169

    /// @dev Burn short position.
    /// Withdraw token0, when long token0 is burnt.
    /// Withdraw token1, when long token1 is burnt.
    /// @dev Can only be called before the maturity of the pool.
    /// @param param The parameters for the burn function.
    /// @return token0AndLong0Amount The amount of token0 withdrawn and long0 burnt.
    /// @return token1AndLong1Amount The amount of token1 withdrawn and long1 burnt.
    /// @return shortAmount The amount of short burnt.
    function burn(TimeswapV2OptionBurnParam calldata param) external returns (uint256 token0AndLong0Amount, uint256 token1AndLong1Amount, uint256 shortAmount, bytes memory data);

Missing: @return data

---

ITimeswapV2Option.sol: L184-190

    /// @dev Burn short position, withdraw token0 and token1.
    /// @dev Can only be called after the maturity of the pool.
    /// @param param The parameters for the collect function.
    /// @return token0Amount The amount of token0 withdrawn.
    /// @return token1Amount The amount of token1 withdrawn.
    /// @return shortAmount The amount of short burnt.
    function collect(TimeswapV2OptionCollectParam calldata param) external returns (uint256 token0Amount, uint256 token1Amount, uint256 shortAmount, bytes memory data);

Missing: @return data

---

ITimeswapV2OptionDeployer.sol: L11-16

    /// @notice Get the parameters to be used in constructing the pair, set transiently during pair creation.
    /// @dev Called by the pair constructor to fetch the parameters of the pair.
    /// @return optionFactory The factory address.
    /// @param token0 The first ERC20 token address of the pair.
    /// @param token1 The second ERC20 token address of the pair.
    function parameter() external view returns (address optionFactory, address token0, address token1);

Notice: @param statements should be @return statements

---

ITimeswapV2OptionFactory.sol: L26-28

    /// @dev Get the address of the option pair in the option pair enumeration list.
    /// @param id The chosen index.
    function getByIndex(uint256 id) external view returns (address optionPair);

---

ITimeswapV2OptionFactory.sol: L30-31

    /// @dev The number of option pairs deployed.
    function numberOfPairs() external view returns (uint256);

---

ITimeswapV2OptionFactory.sol: L35-41

    /// @dev Creates a Timeswap V2 Option based on pair parameters.
    /// @dev Cannot create a duplicate Timeswap V2 Option with the same pair parameters.
    /// @notice The token0 address must be smaller than token1 address.
    /// @param token0 The first ERC20 token address of the pair.
    /// @param token1 The second ERC20 token address of the pair.
    /// @param optionPair The address of the Timeswap V2 Option contract created.
    function create(address token0, address token1) external returns (address optionPair);

Notice: @param optionPair should be @return optionPair

---

---

ITimeswapV2LiquidityToken.sol: L13

    event TransferFees(address from, address to, TimeswapV2LiquidityTokenPosition position, uint256 long0Fees, uint256 long1Fees, uint256 shortFees);

---

---