add `NatSpec`

[YouStillAlive]

closes #10

[github-actions[bot]]

Slither report

THIS CHECKLIST IS NOT COMPLETE. Use --show-ignored-findings to show all the results. Summary

• reentrancy-benign (1 results) (Low)
• reentrancy-events (1 results) (Low)
• timestamp (1 results) (Low)

  reentrancy-benign

  Impact: Low Confidence: Medium

• [ ] ID-0 Reentrancy in DispenserInternal._handleSimpleNFTs(uint256,address,IDispenserProvider.Builder[]): External calls:
  • amountTaken += _nftIterator(tokenPoolId,owner,data[i])
    • poolId = lockDealNFT.mintForProvider(owner,data.simpleProvider)
    • lockDealNFT.safeTransferFrom(owner,address(lockDealNFT),poolId)
    • data.simpleProvider.registerPool(poolId,data.params)
    • lockDealNFT.cloneVaultId(poolId,tokenPoolId) State variables written after the call(s):
  • _finalizeDeal(tokenPoolId,owner,amountTaken)
    • isTaken[tokenPoolId][owner] = true
  • _finalizeDeal(tokenPoolId,owner,amountTaken)
    • poolIdToAmount[tokenPoolId] -= amountTaken

https://github.com/The-Poolz/LockDealNFT.DispenserProvider/blob/4475bd98db4cababfcadcc91a167bc5051c21f78/contracts/DispenserInternal.sol#L43-L52

reentrancy-events

Impact: Low Confidence: Medium

• [ ] ID-1 Reentrancy in DispenserProvider.dispenseLock(uint256,uint256,address,IDispenserProvider.Builder[],bytes): External calls:
  • amountTaken = _handleSimpleNFTs(poolId,owner,data)
    • poolId = lockDealNFT.mintForProvider(owner,data.simpleProvider)
    • data.simpleProvider.registerPool(poolId,data.params)
    • lockDealNFT.safeTransferFrom(owner,address(lockDealNFT),poolId)
    • lockDealNFT.cloneVaultId(poolId,tokenPoolId) Event emitted after the call(s):
  • TokensDispensed(poolId,owner,amountTaken,poolIdToAmount[poolId])

https://github.com/The-Poolz/LockDealNFT.DispenserProvider/blob/4475bd98db4cababfcadcc91a167bc5051c21f78/contracts/DispenserProvider.sol#L24-L44

timestamp

Impact: Low Confidence: Medium

• [ ] ID-2 DispenserReverts._isValidTime(uint256) uses timestamp for comparisons Dangerous comparisons:
  • validUntil < block.timestamp

https://github.com/The-Poolz/LockDealNFT.DispenserProvider/blob/4475bd98db4cababfcadcc91a167bc5051c21f78/contracts/DispenserReverts.sol#L28-L32