Merge pull request #86 from primitivefinance/feat/final-touches

Feat/final touches

Author: clemlak

audits/tob/audit.pdf

@@ -107,7 +107,7 @@ contract PrimitiveManager is IPrimitiveManager, Multicall, CashManager, SelfPerm
         // Mints {delLiquidity} of liquidity tokens
         _allocate(recipient, _engine, poolId, delLiquidity);
 
-        emit Allocate(msg.sender, _engine, poolId, delLiquidity, delRisky, delStable, fromMargin);
+        emit Allocate(msg.sender, recipient, _engine, poolId, delLiquidity, delRisky, delStable, fromMargin);
 
         _engine = address(0);
     }

contracts/PrimitiveManager.sol

@@ -42,14 +42,16 @@ interface IPrimitiveManager is IPrimitiveCreateCallback, IPrimitiveLiquidityCall
 
     /// @notice              Emitted when liquidity is allocated
     /// @param payer         Payer sending liquidity
+    /// @param recipient     Address that receives minted ERC-1155 Primitive liquidity tokens
     /// @param engine        Primitive Engine receiving liquidity
     /// @param poolId        Id of the pool receiving liquidity
     /// @param delLiquidity  Amount of liquidity allocated
     /// @param delRisky      Amount of risky tokens allocated
     /// @param delStable     Amount of stable tokens allocated
     /// @param fromMargin    True if liquidity was paid from margin
     event Allocate(
-        address indexed payer,
+        address payer,
+        address indexed recipient,
         address indexed engine,
         bytes32 indexed poolId,
         uint256 delLiquidity,

contracts/interfaces/IPrimitiveManager.sol

@@ -1,10 +1,11 @@
 ---
-description: {{@if (it.title)}}{{it.title}}{{/if}}
+description: {{@if(it.title)}}{{it.title}}{{#else}}{{it.name}}{{/if}}
 
 ---
 
 {{@if (it.name)}}# {{it.name}}.sol{{/if}}
 
+> [Read code on GitHub](https://github.com/primitivefinance/rmm-manager/tree/develop/contracts{{it.path}}/{{it.name}}.sol)
 
 {{@if (it.notice)}}{{it.notice}}{{/if}}
 
@@ -21,7 +22,7 @@ description: {{@if (it.title)}}{{it.title}}{{/if}}
 ## Methods
 
 {{@foreach(it.methods) => key, val}}
-### {{key}}
+### {{key.split('(')[0]}}
 
 
 {{@if (val.notice)}}{{val.notice}}{{/if}}
@@ -47,8 +48,7 @@ description: {{@if (it.title)}}{{it.title}}{{/if}}
 | Name | Type | Description |
 |---|---|---|
 {{@foreach(val.inputs) => key, val}}
-| {{key}} | {{val.type}} | {{val.description}}
-
+| {{key}} | {{val.type}} | {{val.description}} |
 {{/foreach}}
 {{/if}}
 
@@ -58,8 +58,7 @@ description: {{@if (it.title)}}{{it.title}}{{/if}}
 | Name | Type | Description |
 |---|---|---|
 {{@foreach(val.outputs) => key, val}}
-| {{key}} | {{val.type}} | {{val.description}}
-
+| {{key}} | {{val.type}} | {{val.description}} |
 {{/foreach}}
 
 {{/if}}

docusaurus.sqrl

@@ -1,3 +1,4 @@
+import { HardhatUserConfig } from 'hardhat/types'
 import '@typechain/hardhat'
 import '@nomiclabs/hardhat-ethers'
 import '@nomiclabs/hardhat-waffle'
@@ -43,35 +44,11 @@ function createTestnetConfig(network: keyof typeof chainIds): NetworkUserConfig
   }
 }
 
-const config = {
+const config: HardhatUserConfig = {
   dodoc: {
     runOnCompile: false,
-    include: [
-      'PositionRenderer',
-      'PrimitiveManager',
-      'CashManager',
-      'ERC1155Permit',
-      'ManagerBase',
-      'MarginManager',
-      'Multicall',
-      'PositionManager',
-      'Reentrancy',
-      'SelfPermit',
-      'SwapManager',
-      'ICashManager',
-      'IERC1155Permit',
-      'IManagerBase',
-      'IMarginManager',
-      'IMulticall',
-      'IPositionRenderer',
-      'IPrimitiveManager',
-      'ISelfPermit',
-      'ISwapManager',
-      'EngineAddress',
-      'HexStrings',
-      'Margin',
-      'TransferHelper',
-    ],
+    include: ['contracts'],
+    exclude: ['test', 'libraries'],
     templatePath: './docusaurus.sqrl',
   },
   networks: {

hardhat.config.ts

@@ -47,7 +47,7 @@
     "@nomiclabs/hardhat-ethers": "^2.0.2",
     "@nomiclabs/hardhat-etherscan": "^3.0.0",
     "@nomiclabs/hardhat-waffle": "^2.0.1",
-    "@primitivefi/hardhat-dodoc": "^0.1.3",
+    "@primitivefi/hardhat-dodoc": "^0.2.3",
     "@primitivefi/rmm-math": "^2.0.0-rc.1",
     "@typechain/ethers-v5": "^7.1.0",
     "@typechain/hardhat": "^2.2.0",

package.json

@@ -115,7 +115,7 @@ runTest('allocate', function () {
           )
         )
           .to.emit(this.manager, 'Allocate')
-          .withArgs(this.deployer.address, this.engine.address, poolId, delLiquidity.raw, delRisky.raw, delStable.raw, true)
+          .withArgs(this.deployer.address, recipient, this.engine.address, poolId, delLiquidity.raw, delRisky.raw, delStable.raw, true)
       })
 
       it('does not reduces the balances of the sender', async function () {
@@ -221,7 +221,7 @@ runTest('allocate', function () {
           )
         )
           .to.emit(this.manager, 'Allocate')
-          .withArgs(this.deployer.address, this.engine.address, poolId, delLiquidity.raw, delRisky.raw, delStable.raw, false)
+          .withArgs(this.deployer.address, recipient, this.engine.address, poolId, delLiquidity.raw, delRisky.raw, delStable.raw, false)
       })
     })
 
@@ -343,7 +343,7 @@ runTest('allocate', function () {
           )
         )
           .to.emit(this.manager, 'Allocate')
-          .withArgs(this.deployer.address, engine.address, poolId, delLiquidity.raw, delRisky.raw, delStable.raw, false)
+          .withArgs(this.deployer.address, recipient, engine.address, poolId, delLiquidity.raw, delRisky.raw, delStable.raw, false)
       })
     })
   })

test/unit/primitiveManager/allocate.ts

@@ -731,10 +731,10 @@
   resolved "https://registry.yarnpkg.com/@openzeppelin/contracts/-/contracts-4.5.0.tgz#3fd75d57de172b3743cdfc1206883f56430409cc"
   integrity sha512-fdkzKPYMjrRiPK6K4y64e6GzULR7R7RwxSigHS8DDp7aWDeoReqsQI+cxHV1UuhAqX69L1lAaWDxenfP+xiqzA==
 
-"@primitivefi/hardhat-dodoc@^0.1.3":
-  version "0.1.3"
-  resolved "https://registry.yarnpkg.com/@primitivefi/hardhat-dodoc/-/hardhat-dodoc-0.1.3.tgz#338ecff24b93d3b43fa35a98909f6840af86c27c"
-  integrity sha512-IM2rwyk9SHxnifHnoCKmB1K1su/d1BvF5C0zspCWH8rVrrNpS1NzLTjisDNJmbM69/cWcEX0vfk449LuTsQVaw==
+"@primitivefi/hardhat-dodoc@^0.2.3":
+  version "0.2.3"
+  resolved "https://registry.yarnpkg.com/@primitivefi/hardhat-dodoc/-/hardhat-dodoc-0.2.3.tgz#76aebbfa70de2d6454af29e166b1430583b54c5c"
+  integrity sha512-ver9uHa79LTDTeebOKZ/eOVRL/FP1k0s0x/5Bo/8ZaDdLWFVClKqZyZYVjjW4CJqTPCt8uU9b9p71P2vzH4O9A==
   dependencies:
     squirrelly "^8.0.8"