Skip to content

Commit b6ac90b

Browse files
rya-sgerya-sge
committed
Update doc
1 parent e0c5c27 commit b6ac90b

File tree

88 files changed

+809
-797
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+809
-797
lines changed

‎doc/TOOLCHAIN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ OR
9595
- CCIPSender
9696

9797
```bash
98-
npx surya graph src/CCIPSender.sol | dot -Tpng > surya_graph_CCIPSender.png
98+
npx surya graph src/deployment/CCIPSender.sol | dot -Tpng > surya_graph_CCIPSender.png
9999
```
100100

101101
#### Report

‎doc/schema/CCIPSenderPayment.png

41.7 KB
Loading

‎doc/schema/surya/surya_graph/surya_graph_AuthorizationModule.sol.png

-5.08 KB
Loading

‎doc/schema/surya/surya_graph/surya_graph_CCIPBaseReceiver.sol.png

-74.7 KB
Binary file not shown.

‎doc/schema/surya/surya_graph/surya_graph_CCIPBaseSender.sol.png

18.2 KB
Loading

‎doc/schema/surya/surya_graph/surya_graph_CCIPContractBalance.sol.png

104 KB
Loading

‎doc/schema/surya/surya_graph/surya_graph_CCIPReceiverDefensive.sol.png

-149 KB
Binary file not shown.

‎doc/schema/surya/surya_graph/surya_graph_CCIPReceiverInternal.sol.png

-26.5 KB
Binary file not shown.

‎doc/schema/surya/surya_graph/surya_graph_CCIPRouterManage.sol.png

5.43 KB
Loading

‎doc/schema/surya/surya_graph/surya_graph_CCIPSenderBuild.sol.png

47.3 KB
Loading

‎doc/schema/surya/surya_graph/surya_graph_CCIPSenderPayment.sol.png

14.7 KB
Loading

‎doc/schema/surya/surya_graph/surya_graph_CCIPSenderReceiver.sol.png

-51.7 KB
Binary file not shown.

‎doc/schema/surya/surya_graph/surya_graph_CCIPWithdraw.sol.png

-75.5 KB
Binary file not shown.

‎doc/schema/surya/surya_inheritance/surya_inheritance_CCIPBaseReceiver.sol.png

-24.9 KB
Binary file not shown.

‎doc/schema/surya/surya_inheritance/surya_inheritance_CCIPContractBalance.sol.png

12.3 KB
Loading

‎doc/schema/surya/surya_inheritance/surya_inheritance_CCIPReceiverDefensive.sol.png

-19.3 KB
Binary file not shown.

‎doc/schema/surya/surya_inheritance/surya_inheritance_CCIPReceiverInternal.sol.png

-19.1 KB
Binary file not shown.

‎doc/schema/surya/surya_inheritance/surya_inheritance_CCIPSender.sol.png

-812 Bytes
Loading

‎doc/schema/surya/surya_inheritance/surya_inheritance_CCIPSenderReceiver.sol.png

-22.3 KB
Binary file not shown.

‎doc/schema/surya/surya_inheritance/surya_inheritance_CCIPWithdraw.sol.png

-11.8 KB
Binary file not shown.

‎doc/schema/surya/surya_report/surya_report_AuthorizationModule.sol.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
||||||
1818
| **AuthorizationModule** | Implementation | AccessControl |||
1919
| └ | hasRole | Public ❗️ | |NO❗️ |
20-
| └ | supportsInterface | Public ❗️ | |NO❗️ |
2120

2221

2322
### Legend

‎doc/schema/surya/surya_report/surya_report_CCIPBaseReceiver.sol.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

‎doc/schema/surya/surya_report/surya_report_CCIPBaseSender.sol.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
| └ | **Function Name** | **Visibility** | **Mutability** | **Modifiers** |
1717
||||||
1818
| **CCIPBaseSender** | Implementation | CCIPAllowlistedChain, CCIPSenderBuild, CCIPRouterManage |||
19-
| └ | transferTokens | External ❗️ | 🛑 | onlyRole |
20-
| └ | transferTokensBatch | External ❗️ | 🛑 | onlyRole |
21-
| └ | buildEndSend | Internal 🔒 | 🛑 | |
19+
| └ | transferTokens | External ❗️ | 🛑 | onlyRole onlyAllowlistedDestinationChain |
20+
| └ | transferTokensBatch | External ❗️ | 🛑 | onlyRole onlyAllowlistedDestinationChain |
21+
| └ | _buildEndSend | Internal 🔒 | 🛑 | |
2222

2323

2424
### Legend

‎doc/schema/surya/surya_report/surya_report_CCIPWithdraw.sol.md renamed to ‎doc/schema/surya/surya_report/surya_report_CCIPContractBalance.sol.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
| File Name | SHA-1 Hash |
77
|-------------|--------------|
8-
| ./bridge/modules/wrapper/CCIPWithdraw.sol | [object Promise] |
8+
| ./bridge/modules/wrapper/CCIPContractBalance.sol | [object Promise] |
99

1010

1111
### Contracts Description Table
@@ -15,10 +15,10 @@
1515
|:----------:|:-------------------:|:----------------:|:----------------:|:---------------:|
1616
| └ | **Function Name** | **Visibility** | **Mutability** | **Modifiers** |
1717
||||||
18-
| **CCIPWithdraw** | Implementation | AuthorizationModule |||
19-
| └ | <Receive Ether> | External ❗️ | 💵 |NO❗️ |
20-
| └ | withdrawToken | Public ❗️ | 🛑 | onlyRole |
21-
| └ | withdrawNativeToken | Public ❗️ | 🛑 | onlyRole |
18+
| **CCIPContractBalance** | Implementation | AuthorizationModule |||
19+
| └ | depositNativeTokens | Public ❗️ | 💵 | onlyRole |
20+
| └ | withdrawTokens | Public ❗️ | 🛑 | onlyRole |
21+
| └ | withdrawNativeTokens | Public ❗️ | 🛑 | onlyRole |
2222

2323

2424
### Legend

‎doc/schema/surya/surya_report/surya_report_CCIPReceiverDefensive.sol.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

‎doc/schema/surya/surya_report/surya_report_CCIPReceiverInternal.sol.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

‎doc/schema/surya/surya_report/surya_report_CCIPRouterManage.sol.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
| └ | <Constructor> | Public ❗️ | 🛑 |NO❗️ |
2020
| └ | getRouter | Public ❗️ | |NO❗️ |
2121
| └ | getSupportedTokens | External ❗️ | |NO❗️ |
22+
| └ | getFee | Public ❗️ | |NO❗️ |
2223

2324

2425
### Legend

‎doc/schema/surya/surya_report/surya_report_CCIPSender.sol.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
|:----------:|:-------------------:|:----------------:|:----------------:|:---------------:|
1616
| └ | **Function Name** | **Visibility** | **Mutability** | **Modifiers** |
1717
||||||
18-
| **CCIPSender** | Implementation | CCIPBaseSender, CCIPWithdraw, ERC2771Context |||
18+
| **CCIPSender** | Implementation | CCIPBaseSender, CCIPContractBalance, ERC2771Context |||
1919
| └ | <Constructor> | Public ❗️ | 🛑 | CCIPRouterManage ERC2771Context |
2020
| └ | _msgSender | Internal 🔒 | | |
2121
| └ | _msgData | Internal 🔒 | | |

‎doc/schema/surya/surya_report/surya_report_CCIPSenderBuild.sol.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@
1616
| └ | **Function Name** | **Visibility** | **Mutability** | **Modifiers** |
1717
||||||
1818
| **CCIPSenderBuild** | Implementation | CCIPSenderPayment |||
19-
| └ | _buildCCIPMessage | Internal 🔒 | | |
20-
| └ | _buildCCIPTransferMessage | Internal 🔒 | | |
21-
| └ | buildCCIPTransferMessage | Public ❗️ | |NO❗️ |
2219
| └ | buildTokenAmounts | Public ❗️ | |NO❗️ |
20+
| └ | buildCCIPTransferMessage | Public ❗️ | |NO❗️ |
21+
| └ | _buildCCIPMessage | Public ❗️ | |NO❗️ |
22+
| └ | _buildCCIPTransferMessage | Public ❗️ | |NO❗️ |
2323

2424

2525
### Legend

‎doc/schema/surya/surya_report/surya_report_CCIPSenderPayment.sol.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
| └ | **Function Name** | **Visibility** | **Mutability** | **Modifiers** |
1717
||||||
1818
| **CCIPSenderPayment** | Implementation | AuthorizationModule |||
19+
| └ | setMessageGasLimit | Public ❗️ | 🛑 | onlyRole |
20+
| └ | setMessageData | Public ❗️ | 🛑 | onlyRole |
1921
| └ | setFeePaymentMethod | Public ❗️ | 🛑 | onlyRole |
2022
| └ | isValidPaymentId | Internal 🔒 | | |
2123
| └ | changeStatusFeePaymentMethod | Public ❗️ | 🛑 | onlyRole |

‎doc/schema/surya/surya_report/surya_report_CCIPSenderReceiver.sol.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

‎doc/test/coverage/bridge/CCIPBaseSender.sol.func-sort-c.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@
3131
<td class="headerValue">lcov.info</td>
3232
<td></td>
3333
<td class="headerItem">Lines:</td>
34-
<td class="headerCovTableEntry">20</td>
3534
<td class="headerCovTableEntry">21</td>
36-
<td class="headerCovTableEntryHi">95.2 %</td>
35+
<td class="headerCovTableEntry">21</td>
36+
<td class="headerCovTableEntryHi">100.0 %</td>
3737
</tr>
3838
<tr>
3939
<td class="headerItem">Date:</td>
40-
<td class="headerValue">2024-04-17 17:59:19</td>
40+
<td class="headerValue">2024-04-26 14:53:42</td>
4141
<td></td>
4242
<td class="headerItem">Functions:</td>
4343
<td class="headerCovTableEntry">3</td>

‎doc/test/coverage/bridge/CCIPBaseSender.sol.func.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@
3131
<td class="headerValue">lcov.info</td>
3232
<td></td>
3333
<td class="headerItem">Lines:</td>
34-
<td class="headerCovTableEntry">20</td>
3534
<td class="headerCovTableEntry">21</td>
36-
<td class="headerCovTableEntryHi">95.2 %</td>
35+
<td class="headerCovTableEntry">21</td>
36+
<td class="headerCovTableEntryHi">100.0 %</td>
3737
</tr>
3838
<tr>
3939
<td class="headerItem">Date:</td>
40-
<td class="headerValue">2024-04-17 17:59:19</td>
40+
<td class="headerValue">2024-04-26 14:53:42</td>
4141
<td></td>
4242
<td class="headerItem">Functions:</td>
4343
<td class="headerCovTableEntry">3</td>

‎doc/test/coverage/bridge/CCIPBaseSender.sol.gcov.html

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@
3131
<td class="headerValue">lcov.info</td>
3232
<td></td>
3333
<td class="headerItem">Lines:</td>
34-
<td class="headerCovTableEntry">20</td>
3534
<td class="headerCovTableEntry">21</td>
36-
<td class="headerCovTableEntryHi">95.2 %</td>
35+
<td class="headerCovTableEntry">21</td>
36+
<td class="headerCovTableEntryHi">100.0 %</td>
3737
</tr>
3838
<tr>
3939
<td class="headerItem">Date:</td>
40-
<td class="headerValue">2024-04-17 17:59:19</td>
40+
<td class="headerValue">2024-04-26 14:53:42</td>
4141
<td></td>
4242
<td class="headerItem">Functions:</td>
4343
<td class="headerCovTableEntry">3</td>
@@ -194,15 +194,17 @@
194194
<a name="123"><span class="lineNum"> 123 </span> : : // transfer tokens to the contract</a>
195195
<a name="124"><span class="lineNum"> 124 </span> :<span class="lineCov"> 20 : IERC20(tokenAmounts[i].token).safeTransferFrom(_msgSender(), address(this), tokenAmounts[i].amount);</span></a>
196196
<a name="125"><span class="lineNum"> 125 </span> : : // approve the Router to spend tokens on contract's behalf. It will spend the amount of the given token</a>
197-
<a name="126"><span class="lineNum"> 126 </span> :<span class="lineCov"> 18 : bool result = IERC20(tokenAmounts[i].token).approve(address(router), tokenAmounts[i].amount);</span></a>
198-
<a name="127"><span class="lineNum"> 127 </span> [<span class="branchNoExec" title="Branch 0 was not executed"> # </span><span class="branchCov" title="Branch 1 was taken 6 times"> + </span>]:<span class="lineCov"> 12 : if(!result){</span></a>
199-
<a name="128"><span class="lineNum"> 128 </span> :<span class="lineNoCov"> 0 : revert CCIPErrors.CCIP_BaseSender_FailApproval();</span></a>
200-
<a name="129"><span class="lineNum"> 129 </span> : : }</a>
201-
<a name="130"><span class="lineNum"> 130 </span> : : }</a>
202-
<a name="131"><span class="lineNum"> 131 </span> : : // Send CCIP Message</a>
203-
<a name="132"><span class="lineNum"> 132 </span> :<span class="lineCov"> 8 : messageId = router.ccipSend(_destinationChainSelector, message); </span></a>
204-
<a name="133"><span class="lineNum"> 133 </span> : : }</a>
205-
<a name="134"><span class="lineNum"> 134 </span> : : }</a>
197+
<a name="126"><span class="lineNum"> 126 </span> :<span class="lineCov"> 12 : IERC20(tokenAmounts[i].token).safeIncreaseAllowance(address(router), tokenAmounts[i].amount);</span></a>
198+
<a name="127"><span class="lineNum"> 127 </span> : : }</a>
199+
<a name="128"><span class="lineNum"> 128 </span> : : // Send CCIP Message</a>
200+
<a name="129"><span class="lineNum"> 129 </span> [<span class="branchNoExec" title="Branch 0 was not executed"> # </span><span class="branchCov" title="Branch 1 was taken 2 times"> + </span>]:<span class="lineCov"> 8 : if(_paymentMethodId == 0){ // Native token</span></a>
201+
<a name="130"><span class="lineNum"> 130 </span> :<span class="lineCov"> 4 : messageId = router.ccipSend{value: fees}(_destinationChainSelector, message); </span></a>
202+
<a name="131"><span class="lineNum"> 131 </span> : : } else{</a>
203+
<a name="132"><span class="lineNum"> 132 </span> :<span class="lineCov"> 4 : messageId = router.ccipSend(_destinationChainSelector, message); </span></a>
204+
<a name="133"><span class="lineNum"> 133 </span> : : }</a>
205+
<a name="134"><span class="lineNum"> 134 </span> : : </a>
206+
<a name="135"><span class="lineNum"> 135 </span> : : }</a>
207+
<a name="136"><span class="lineNum"> 136 </span> : : }</a>
206208
</pre>
207209
</td>
208210
</tr>

‎doc/test/coverage/bridge/index-sort-b.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@
3131
<td class="headerValue">lcov.info</td>
3232
<td></td>
3333
<td class="headerItem">Lines:</td>
34-
<td class="headerCovTableEntry">20</td>
3534
<td class="headerCovTableEntry">21</td>
36-
<td class="headerCovTableEntryHi">95.2 %</td>
35+
<td class="headerCovTableEntry">21</td>
36+
<td class="headerCovTableEntryHi">100.0 %</td>
3737
</tr>
3838
<tr>
3939
<td class="headerItem">Date:</td>
40-
<td class="headerValue">2024-04-17 17:59:19</td>
40+
<td class="headerValue">2024-04-26 14:53:42</td>
4141
<td></td>
4242
<td class="headerItem">Functions:</td>
4343
<td class="headerCovTableEntry">3</td>
@@ -84,10 +84,10 @@
8484
<tr>
8585
<td class="coverFile"><a href="CCIPBaseSender.sol.gcov.html">CCIPBaseSender.sol</a></td>
8686
<td class="coverBar" align="center">
87-
<table border=0 cellspacing=0 cellpadding=1><tr><td class="coverBarOutline"><img src="../emerald.png" width=95 height=10 alt="95.2%"><img src="../snow.png" width=5 height=10 alt="95.2%"></td></tr></table>
87+
<table border=0 cellspacing=0 cellpadding=1><tr><td class="coverBarOutline"><img src="../emerald.png" width=100 height=10 alt="100.0%"></td></tr></table>
8888
</td>
89-
<td class="coverPerHi">95.2&nbsp;%</td>
90-
<td class="coverNumHi">20 / 21</td>
89+
<td class="coverPerHi">100.0&nbsp;%</td>
90+
<td class="coverNumHi">21 / 21</td>
9191
<td class="coverPerHi">100.0&nbsp;%</td>
9292
<td class="coverNumHi">3 / 3</td>
9393
<td class="coverPerLo">50.0&nbsp;%</td>

‎doc/test/coverage/bridge/index-sort-f.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@
3131
<td class="headerValue">lcov.info</td>
3232
<td></td>
3333
<td class="headerItem">Lines:</td>
34-
<td class="headerCovTableEntry">20</td>
3534
<td class="headerCovTableEntry">21</td>
36-
<td class="headerCovTableEntryHi">95.2 %</td>
35+
<td class="headerCovTableEntry">21</td>
36+
<td class="headerCovTableEntryHi">100.0 %</td>
3737
</tr>
3838
<tr>
3939
<td class="headerItem">Date:</td>
40-
<td class="headerValue">2024-04-17 17:59:19</td>
40+
<td class="headerValue">2024-04-26 14:53:42</td>
4141
<td></td>
4242
<td class="headerItem">Functions:</td>
4343
<td class="headerCovTableEntry">3</td>
@@ -84,10 +84,10 @@
8484
<tr>
8585
<td class="coverFile"><a href="CCIPBaseSender.sol.gcov.html">CCIPBaseSender.sol</a></td>
8686
<td class="coverBar" align="center">
87-
<table border=0 cellspacing=0 cellpadding=1><tr><td class="coverBarOutline"><img src="../emerald.png" width=95 height=10 alt="95.2%"><img src="../snow.png" width=5 height=10 alt="95.2%"></td></tr></table>
87+
<table border=0 cellspacing=0 cellpadding=1><tr><td class="coverBarOutline"><img src="../emerald.png" width=100 height=10 alt="100.0%"></td></tr></table>
8888
</td>
89-
<td class="coverPerHi">95.2&nbsp;%</td>
90-
<td class="coverNumHi">20 / 21</td>
89+
<td class="coverPerHi">100.0&nbsp;%</td>
90+
<td class="coverNumHi">21 / 21</td>
9191
<td class="coverPerHi">100.0&nbsp;%</td>
9292
<td class="coverNumHi">3 / 3</td>
9393
<td class="coverPerLo">50.0&nbsp;%</td>

‎doc/test/coverage/bridge/index-sort-l.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@
3131
<td class="headerValue">lcov.info</td>
3232
<td></td>
3333
<td class="headerItem">Lines:</td>
34-
<td class="headerCovTableEntry">20</td>
3534
<td class="headerCovTableEntry">21</td>
36-
<td class="headerCovTableEntryHi">95.2 %</td>
35+
<td class="headerCovTableEntry">21</td>
36+
<td class="headerCovTableEntryHi">100.0 %</td>
3737
</tr>
3838
<tr>
3939
<td class="headerItem">Date:</td>
40-
<td class="headerValue">2024-04-17 17:59:19</td>
40+
<td class="headerValue">2024-04-26 14:53:42</td>
4141
<td></td>
4242
<td class="headerItem">Functions:</td>
4343
<td class="headerCovTableEntry">3</td>
@@ -84,10 +84,10 @@
8484
<tr>
8585
<td class="coverFile"><a href="CCIPBaseSender.sol.gcov.html">CCIPBaseSender.sol</a></td>
8686
<td class="coverBar" align="center">
87-
<table border=0 cellspacing=0 cellpadding=1><tr><td class="coverBarOutline"><img src="../emerald.png" width=95 height=10 alt="95.2%"><img src="../snow.png" width=5 height=10 alt="95.2%"></td></tr></table>
87+
<table border=0 cellspacing=0 cellpadding=1><tr><td class="coverBarOutline"><img src="../emerald.png" width=100 height=10 alt="100.0%"></td></tr></table>
8888
</td>
89-
<td class="coverPerHi">95.2&nbsp;%</td>
90-
<td class="coverNumHi">20 / 21</td>
89+
<td class="coverPerHi">100.0&nbsp;%</td>
90+
<td class="coverNumHi">21 / 21</td>
9191
<td class="coverPerHi">100.0&nbsp;%</td>
9292
<td class="coverNumHi">3 / 3</td>
9393
<td class="coverPerLo">50.0&nbsp;%</td>

0 commit comments

Comments
 (0)