feat: Update README by 0xfarhaan · Pull Request #4 · maple-labs/syrup-utils

0xfarhaan · 2025-05-25T09:44:58Z

No description provided.

github-actions · 2025-05-25T09:46:39Z

| contracts/MapleBorrowerActions.sol:MapleBorrowerActions Contract |                 |      |        |      |         |
| Deployment Cost                                                  | Deployment Size |      |        |      |         |
|------------------------------------------------------------------+-----------------+------+--------+------+---------|
| 295479                                                           | 1152            |      |        |      |         |
|------------------------------------------------------------------+-----------------+------+--------+------+---------|
|                                                                  |                 |      |        |      |         |
|------------------------------------------------------------------+-----------------+------+--------+------+---------|
| Function Name                                                    | Min             | Avg  | Median | Max  | # Calls |
|------------------------------------------------------------------+-----------------+------+--------+------+---------|
| acceptLoanTerms                                                  | 6311            | 6422 | 6422   | 6533 | 2       |
| contracts/MplUserActions.sol:MplUserActions Contract |                 |        |        |        |         |
| Deployment Cost                                      | Deployment Size |        |        |        |         |
|------------------------------------------------------+-----------------+--------+--------+--------+---------|
| 1295485                                              | 7621            |        |        |        |         |
|------------------------------------------------------+-----------------+--------+--------+--------+---------|
|                                                      |                 |        |        |        |         |
|------------------------------------------------------+-----------------+--------+--------+--------+---------|
| Function Name                                        | Min             | Avg    | Median | Max    | # Calls |
|------------------------------------------------------+-----------------+--------+--------+--------+---------|
| migrateAndStake                                      | 22530           | 95425  | 55304  | 261745 | 10      |
|------------------------------------------------------+-----------------+--------+--------+--------+---------|
| migrateAndStakeWithPermit                            | 30800           | 92311  | 58483  | 297599 | 13      |
|------------------------------------------------------+-----------------+--------+--------+--------+---------|
| migrator                                             | 462             | 462    | 462    | 462    | 1       |
|------------------------------------------------------+-----------------+--------+--------+--------+---------|
| mpl                                                  | 417             | 417    | 417    | 417    | 1       |
|------------------------------------------------------+-----------------+--------+--------+--------+---------|
| redeemAndMigrate                                     | 22596           | 85170  | 37881  | 188864 | 10      |
|------------------------------------------------------+-----------------+--------+--------+--------+---------|
| redeemAndMigrateAndStake                             | 22574           | 110004 | 37859  | 302645 | 10      |
|------------------------------------------------------+-----------------+--------+--------+--------+---------|
| redeemAndMigrateAndStakeWithPermit                   | 31169           | 104156 | 64990  | 348536 | 13      |
|------------------------------------------------------+-----------------+--------+--------+--------+---------|
| redeemAndMigrateWithPermit                           | 31147           | 90198  | 64968  | 234720 | 13      |
|------------------------------------------------------+-----------------+--------+--------+--------+---------|
| stsyrup                                              | 374             | 374    | 374    | 374    | 1       |
|------------------------------------------------------+-----------------+--------+--------+--------+---------|
| syrup                                                | 373             | 373    | 373    | 373    | 1       |
|------------------------------------------------------+-----------------+--------+--------+--------+---------|
| xmpl                                                 | 396             | 396    | 396    | 396    | 1       |
| contracts/SyrupDrip.sol:SyrupDrip Contract |                 |        |        |        |         |
| Deployment Cost                            | Deployment Size |        |        |        |         |
|--------------------------------------------+-----------------+--------+--------+--------+---------|
| 1573430                                    | 8456            |        |        |        |         |
|--------------------------------------------+-----------------+--------+--------+--------+---------|
|                                            |                 |        |        |        |         |
|--------------------------------------------+-----------------+--------+--------+--------+---------|
| Function Name                              | Min             | Avg    | Median | Max    | # Calls |
|--------------------------------------------+-----------------+--------+--------+--------+---------|
| allocate                                   | 28626           | 93487  | 99687  | 106250 | 76      |
|--------------------------------------------+-----------------+--------+--------+--------+---------|
| asset                                      | 440             | 440    | 440    | 440    | 1       |
|--------------------------------------------+-----------------+--------+--------+--------+---------|
| bitmaps                                    | 2843            | 2843   | 2843   | 2843   | 4216    |
|--------------------------------------------+-----------------+--------+--------+--------+---------|
| claim                                      | 27609           | 64850  | 74641  | 96723  | 49      |
|--------------------------------------------+-----------------+--------+--------+--------+---------|
| claimAndStake                              | 25184           | 228140 | 234448 | 238091 | 546     |
|--------------------------------------------+-----------------+--------+--------+--------+---------|
| deadline                                   | 2448            | 2448   | 2448   | 2448   | 5       |
|--------------------------------------------+-----------------+--------+--------+--------+---------|
| globals                                    | 417             | 417    | 417    | 417    | 1       |
|--------------------------------------------+-----------------+--------+--------+--------+---------|
| isClaimed                                  | 3223            | 3223   | 3223   | 3223   | 33      |
|--------------------------------------------+-----------------+--------+--------+--------+---------|
| maxId                                      | 2491            | 2491   | 2491   | 2491   | 4       |
|--------------------------------------------+-----------------+--------+--------+--------+---------|
| reclaim                                    | 28197           | 48639  | 42116  | 74403  | 10      |
|--------------------------------------------+-----------------+--------+--------+--------+---------|
| root                                       | 2534            | 2534   | 2534   | 2534   | 5       |
|--------------------------------------------+-----------------+--------+--------+--------+---------|
| stakedSyrup                                | 373             | 373    | 373    | 373    | 1       |
| contracts/SyrupRouter.sol:SyrupRouter Contract |                 |        |        |        |         |
| Deployment Cost                                | Deployment Size |        |        |        |         |
|------------------------------------------------+-----------------+--------+--------+--------+---------|
| 1706077                                        | 9444            |        |        |        |         |
|------------------------------------------------+-----------------+--------+--------+--------+---------|
|                                                |                 |        |        |        |         |
|------------------------------------------------+-----------------+--------+--------+--------+---------|
| Function Name                                  | Min             | Avg    | Median | Max    | # Calls |
|------------------------------------------------+-----------------+--------+--------+--------+---------|
| asset                                          | 401             | 401    | 401    | 401    | 1       |
|------------------------------------------------+-----------------+--------+--------+--------+---------|
| authorizeAndDeposit                            | 23859           | 70775  | 41230  | 176782 | 4       |
|------------------------------------------------+-----------------+--------+--------+--------+---------|
| authorizeAndDepositWithPermit                  | 25053           | 83173  | 42424  | 222790 | 4       |
|------------------------------------------------+-----------------+--------+--------+--------+---------|
| deposit                                        | 29015           | 83040  | 39002  | 159123 | 5       |
|------------------------------------------------+-----------------+--------+--------+--------+---------|
| depositWithPermit                              | 33838           | 122989 | 104075 | 216689 | 7       |
|------------------------------------------------+-----------------+--------+--------+--------+---------|
| nonces                                         | 2881            | 2881   | 2881   | 2881   | 4       |
|------------------------------------------------+-----------------+--------+--------+--------+---------|
| pool                                           | 379             | 379    | 379    | 379    | 1       |
|------------------------------------------------+-----------------+--------+--------+--------+---------|
| poolManager                                    | 444             | 444    | 444    | 444    | 1       |
|------------------------------------------------+-----------------+--------+--------+--------+---------|
| poolPermissionManager                          | 466             | 466    | 466    | 466    | 1       |
| contracts/SyrupUserActions.sol:SyrupUserActions Contract |                 |        |        |        |         |
| Deployment Cost                                          | Deployment Size |        |        |        |         |
|----------------------------------------------------------+-----------------+--------+--------+--------+---------|
| 1509969                                                  | 8450            |        |        |        |         |
|----------------------------------------------------------+-----------------+--------+--------+--------+---------|
|                                                          |                 |        |        |        |         |
|----------------------------------------------------------+-----------------+--------+--------+--------+---------|
| Function Name                                            | Min             | Avg    | Median | Max    | # Calls |
|----------------------------------------------------------+-----------------+--------+--------+--------+---------|
| BAL_VAULT                                                | 461             | 461    | 461    | 461    | 1       |
|----------------------------------------------------------+-----------------+--------+--------+--------+---------|
| PSM_PRECISION                                            | 347             | 347    | 347    | 347    | 1       |
|----------------------------------------------------------+-----------------+--------+--------+--------+---------|
| USDC                                                     | 373             | 373    | 373    | 373    | 1       |
|----------------------------------------------------------+-----------------+--------+--------+--------+---------|
| dai                                                      | 483             | 483    | 483    | 483    | 1       |
|----------------------------------------------------------+-----------------+--------+--------+--------+---------|
| poolId                                                   | 370             | 370    | 370    | 370    | 1       |
|----------------------------------------------------------+-----------------+--------+--------+--------+---------|
| psm                                                      | 374             | 374    | 374    | 374    | 1       |
|----------------------------------------------------------+-----------------+--------+--------+--------+---------|
| sDai                                                     | 462             | 462    | 462    | 462    | 1       |
|----------------------------------------------------------+-----------------+--------+--------+--------+---------|
| swapToDai                                                | 95574           | 477109 | 480410 | 532264 | 524     |
|----------------------------------------------------------+-----------------+--------+--------+--------+---------|
| swapToDaiWithPermit                                      | 38190           | 512007 | 519119 | 586082 | 528     |
|----------------------------------------------------------+-----------------+--------+--------+--------+---------|
| swapToUsdc                                               | 95597           | 599653 | 633822 | 742476 | 802     |
|----------------------------------------------------------+-----------------+--------+--------+--------+---------|
| swapToUsdcWithPermit                                     | 38145           | 625939 | 602619 | 796226 | 528     |
|----------------------------------------------------------+-----------------+--------+--------+--------+---------|
| syrupUsdc                                                | 396             | 396    | 396    | 396    | 1       |
| contracts/utils/SyrupRateProvider.sol:SyrupRateProvider Contract |                 |      |        |      |         |
| Deployment Cost                                                  | Deployment Size |      |        |      |         |
|------------------------------------------------------------------+-----------------+------+--------+------+---------|
| 204883                                                           | 1006            |      |        |      |         |
|------------------------------------------------------------------+-----------------+------+--------+------+---------|
|                                                                  |                 |      |        |      |         |
|------------------------------------------------------------------+-----------------+------+--------+------+---------|
| Function Name                                                    | Min             | Avg  | Median | Max  | # Calls |
|------------------------------------------------------------------+-----------------+------+--------+------+---------|
| getRate                                                          | 6424            | 6424 | 6424   | 6424 | 2       |
|------------------------------------------------------------------+-----------------+------+--------+------+---------|
| pool                                                             | 356             | 356  | 356    | 356  | 1       |
| modules/non-transparent-proxy/contracts/NonTransparentProxy.sol:NonTransparentProxy Contract |                 |       |        |       |         |
| Deployment Cost                                                                              | Deployment Size |       |        |       |         |
|----------------------------------------------------------------------------------------------+-----------------+-------+--------+-------+---------|
| 345320                                                                                       | 1642            |       |        |       |         |
|----------------------------------------------------------------------------------------------+-----------------+-------+--------+-------+---------|
|                                                                                              |                 |       |        |       |         |
|----------------------------------------------------------------------------------------------+-----------------+-------+--------+-------+---------|
| Function Name                                                                                | Min             | Avg   | Median | Max   | # Calls |
|----------------------------------------------------------------------------------------------+-----------------+-------+--------+-------+---------|
| fallback                                                                                     | 3391            | 7633  | 7908   | 33250 | 123     |
|----------------------------------------------------------------------------------------------+-----------------+-------+--------+-------+---------|
| governor                                                                                     | 8163            | 8163  | 8163   | 8163  | 26      |
|----------------------------------------------------------------------------------------------+-----------------+-------+--------+-------+---------|
| operationalAdmin                                                                             | 3391            | 3391  | 3391   | 3391  | 17      |
|----------------------------------------------------------------------------------------------+-----------------+-------+--------+-------+---------|
| setOperationalAdmin                                                                          | 53547           | 53547 | 53547  | 53547 | 77      |
| tests/utils/Mocks.sol:MockERC20.0.8.20 Contract |                 |       |        |       |         |
| Deployment Cost                                 | Deployment Size |       |        |       |         |
|-------------------------------------------------+-----------------+-------+--------+-------+---------|
| 1467265                                         | 7995            |       |        |       |         |
|-------------------------------------------------+-----------------+-------+--------+-------+---------|
|                                                 |                 |       |        |       |         |
|-------------------------------------------------+-----------------+-------+--------+-------+---------|
| Function Name                                   | Min             | Avg   | Median | Max   | # Calls |
|-------------------------------------------------+-----------------+-------+--------+-------+---------|
| DOMAIN_SEPARATOR                                | 3743            | 3743  | 3743   | 3743  | 6       |
|-------------------------------------------------+-----------------+-------+--------+-------+---------|
| PERMIT_TYPEHASH                                 | 442             | 442   | 442    | 442   | 6       |
|-------------------------------------------------+-----------------+-------+--------+-------+---------|
| allowance                                       | 3148            | 3148  | 3148   | 3148  | 8       |
|-------------------------------------------------+-----------------+-------+--------+-------+---------|
| approve                                         | 48971           | 48977 | 48971  | 48995 | 4       |
|-------------------------------------------------+-----------------+-------+--------+-------+---------|
| balanceOf                                       | 2825            | 2825  | 2825   | 2825  | 1583    |
|-------------------------------------------------+-----------------+-------+--------+-------+---------|
| burn                                            | 27729           | 30024 | 27739  | 34601 | 6       |
|-------------------------------------------------+-----------------+-------+--------+-------+---------|
| decimals                                        | 354             | 354   | 354    | 354   | 41      |
|-------------------------------------------------+-----------------+-------+--------+-------+---------|
| mint                                            | 68861           | 68865 | 68861  | 68873 | 71      |
| tests/utils/Mocks.sol:MockERC20.0.8.7 Contract |                 |       |        |       |         |
| Deployment Cost                                | Deployment Size |       |        |       |         |
|------------------------------------------------+-----------------+-------+--------+-------+---------|
| 1502133                                        | 7737            |       |        |       |         |
|------------------------------------------------+-----------------+-------+--------+-------+---------|
|                                                |                 |       |        |       |         |
|------------------------------------------------+-----------------+-------+--------+-------+---------|
| Function Name                                  | Min             | Avg   | Median | Max   | # Calls |
|------------------------------------------------+-----------------+-------+--------+-------+---------|
| DOMAIN_SEPARATOR                               | 3751            | 3751  | 3751   | 3751  | 8       |
|------------------------------------------------+-----------------+-------+--------+-------+---------|
| PERMIT_TYPEHASH                                | 447             | 447   | 447    | 447   | 8       |
|------------------------------------------------+-----------------+-------+--------+-------+---------|
| __setApproveReverts                            | 43871           | 43871 | 43871  | 43871 | 1       |
|------------------------------------------------+-----------------+-------+--------+-------+---------|
| allowance                                      | 3165            | 3165  | 3165   | 3165  | 9       |
|------------------------------------------------+-----------------+-------+--------+-------+---------|
| approve                                        | 48932           | 48932 | 48932  | 48932 | 5       |
|------------------------------------------------+-----------------+-------+--------+-------+---------|
| balanceOf                                      | 2837            | 2837  | 2837   | 2837  | 20      |
|------------------------------------------------+-----------------+-------+--------+-------+---------|
| burn                                           | 34620           | 34620 | 34620  | 34620 | 2       |
|------------------------------------------------+-----------------+-------+--------+-------+---------|
| mint                                           | 68826           | 68826 | 68826  | 68826 | 22      |
| tests/utils/Mocks.sol:MockGlobals.0.8.20 Contract |                 |      |        |      |         |
| Deployment Cost                                   | Deployment Size |      |        |      |         |
|---------------------------------------------------+-----------------+------+--------+------+---------|
| 175332                                            | 746             |      |        |      |         |
|---------------------------------------------------+-----------------+------+--------+------+---------|
|                                                   |                 |      |        |      |         |
|---------------------------------------------------+-----------------+------+--------+------+---------|
| Function Name                                     | Min             | Avg  | Median | Max  | # Calls |
|---------------------------------------------------+-----------------+------+--------+------+---------|
| governor                                          | 2505            | 2505 | 2505   | 2505 | 42      |
|---------------------------------------------------+-----------------+------+--------+------+---------|
| operationalAdmin                                  | 2486            | 2486 | 2486   | 2486 | 37      |
| tests/utils/Mocks.sol:MockLoan.0.8.25 Contract |                 |       |        |       |         |
| Deployment Cost                                | Deployment Size |       |        |       |         |
|------------------------------------------------+-----------------+-------+--------+-------+---------|
| 154659                                         | 497             |       |        |       |         |
|------------------------------------------------+-----------------+-------+--------+-------+---------|
|                                                |                 |       |        |       |         |
|------------------------------------------------+-----------------+-------+--------+-------+---------|
| Function Name                                  | Min             | Avg   | Median | Max   | # Calls |
|------------------------------------------------+-----------------+-------+--------+-------+---------|
| __setBorrower                                  | 44025           | 44025 | 44025  | 44025 | 2       |
|------------------------------------------------+-----------------+-------+--------+-------+---------|
| borrower                                       | 2505            | 2505  | 2505   | 2505  | 2       |
| tests/utils/Mocks.sol:MockPool.0.8.7 Contract |                 |       |        |       |         |
| Deployment Cost                               | Deployment Size |       |        |       |         |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
| 1743012                                       | 8968            |       |        |       |         |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
|                                               |                 |       |        |       |         |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
| Function Name                                 | Min             | Avg   | Median | Max   | # Calls |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
| __setConversionRate                           | 26693           | 38093 | 43793  | 43793 | 3       |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
| __setTransferReverts                          | 26843           | 26843 | 26843  | 26843 | 2       |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
| asset                                         | 2640            | 2640  | 2640   | 2640  | 24      |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
| balanceOf                                     | 2859            | 2859  | 2859   | 2859  | 10      |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
| convertToExitAssets                           | 2813            | 2813  | 2813   | 2813  | 2       |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
| manager                                       | 2589            | 2589  | 2589   | 2589  | 24      |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
| totalSupply                                   | 2497            | 2497  | 2497   | 2497  | 10      |
| tests/utils/Mocks.sol:MockPoolManager.0.8.7 Contract |                 |      |        |      |         |
| Deployment Cost                                      | Deployment Size |      |        |      |         |
|------------------------------------------------------+-----------------+------+--------+------+---------|
| 134450                                               | 562             |      |        |      |         |
|------------------------------------------------------+-----------------+------+--------+------+---------|
|                                                      |                 |      |        |      |         |
|------------------------------------------------------+-----------------+------+--------+------+---------|
| Function Name                                        | Min             | Avg  | Median | Max  | # Calls |
|------------------------------------------------------+-----------------+------+--------+------+---------|
| poolPermissionManager                                | 2500            | 2500 | 2500   | 2500 | 24      |
| tests/utils/Mocks.sol:MockPoolPermissionManager.0.8.7 Contract |                 |       |        |       |         |
| Deployment Cost                                                | Deployment Size |       |        |       |         |
|----------------------------------------------------------------+-----------------+-------+--------+-------+---------|
| 332079                                                         | 1269            |       |        |       |         |
|----------------------------------------------------------------+-----------------+-------+--------+-------+---------|
|                                                                |                 |       |        |       |         |
|----------------------------------------------------------------+-----------------+-------+--------+-------+---------|
| Function Name                                                  | Min             | Avg   | Median | Max   | # Calls |
|----------------------------------------------------------------+-----------------+-------+--------+-------+---------|
| __setHasPermission                                             | 26671           | 26671 | 26671  | 26671 | 2       |
|----------------------------------------------------------------+-----------------+-------+--------+-------+---------|
| __setPermissionAdmins                                          | 26743           | 26743 | 26743  | 26743 | 2       |
|----------------------------------------------------------------+-----------------+-------+--------+-------+---------|
| hasPermission                                                  | 1229            | 2895  | 3229   | 3229  | 12      |
|----------------------------------------------------------------+-----------------+-------+--------+-------+---------|
| permissionAdmins                                               | 2821            | 2821  | 2821   | 2821  | 4       |
| tests/utils/Mocks.sol:MockRDT.0.8.20 Contract |                 |       |        |       |         |
| Deployment Cost                               | Deployment Size |       |        |       |         |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
| 1587291                                       | 8664            |       |        |       |         |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
|                                               |                 |       |        |       |         |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
| Function Name                                 | Min             | Avg   | Median | Max   | # Calls |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
| DOMAIN_SEPARATOR                              | 3743            | 3743  | 3743   | 3743  | 12      |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
| PERMIT_TYPEHASH                               | 442             | 442   | 442    | 442   | 12      |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
| allowance                                     | 3192            | 3192  | 3192   | 3192  | 12      |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
| approve                                       | 46769           | 46775 | 46769  | 46793 | 8       |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
| asset                                         | 2575            | 2575  | 2575   | 2575  | 76      |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
| balanceOf                                     | 2847            | 2847  | 2847   | 2847  | 216     |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
| burn                                          | 27747           | 32331 | 34623  | 34623 | 6       |
|-----------------------------------------------+-----------------+-------+--------+-------+---------|
| mint                                          | 68883           | 68883 | 68883  | 68883 | 26      |

github-actions · 2025-05-25T09:47:49Z

LCOV of commit `20d7825` during CI #9

Summary coverage rate:
  lines......: 100.0% (194 of 194 lines)
  functions..: 100.0% (46 of 46 functions)
  branches...: 91.5% (65 of 71 branches)

Files changed coverage rate: n/a

feat: Update README

20d7825

0xfarhaan self-assigned this May 25, 2025

0xfarhaan requested a review from a team as a code owner May 25, 2025 09:44

0xfarhaan merged commit ef376c4 into main May 25, 2025
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Update README#4

feat: Update README#4
0xfarhaan merged 1 commit intomainfrom
feat/update-README

0xfarhaan commented May 25, 2025

Uh oh!

github-actions Bot commented May 25, 2025 •

edited

Loading

Uh oh!

github-actions Bot commented May 25, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

0xfarhaan commented May 25, 2025

Uh oh!

github-actions Bot commented May 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented May 25, 2025

LCOV of commit 20d7825 during CI #9

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

github-actions Bot commented May 25, 2025 •

edited

Loading

LCOV of commit `20d7825` during CI #9