Skip to content

Commit 5e0d0b4

Browse files
kmurphypolygonkmurphypolygon
committed
more reformatting of code
1 parent 430006a commit 5e0d0b4

24 files changed

+341
-297
lines changed

docs/zkEVM/architecture/high-level/smart-contracts/api/consensus/validium/CDKValidium.md renamed to docs/zkEVM/architecture/high-level/smart-contracts/api/CDKValidium.md

Lines changed: 208 additions & 163 deletions
Large diffs are not rendered by default.

docs/zkEVM/architecture/high-level/smart-contracts/api/consensus/validium/CDKValidiumTimelock.md renamed to docs/zkEVM/architecture/high-level/smart-contracts/api/CDKValidiumTimelock.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ If emergency mode of the cdkValidium contract system is active, this timelock ha
1717
Constructor of timelock
1818

1919

20-
#### Parameters:
20+
##### Parameters:
2121
| Name | Type | Description |
2222
| :--- | :--- | :------------------------------------------------------------------- |
2323
|`minDelay` | uint256 | initial minimum delay for operations

‎docs/zkEVM/architecture/high-level/smart-contracts/api/PolygonRollupManager.md‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
) public
1111
```
1212

13-
#### Parameters
13+
##### Parameters
1414

1515
| Name | Type | Description |
1616
| :--- | :--- | :------------------------------------------------------------------- |
@@ -35,7 +35,7 @@
3535
) external
3636
```
3737

38-
#### Parameters
38+
##### Parameters
3939

4040
| Name | Type | Description |
4141
| :--- | :--- | :------------------------------------------------------------------- |
@@ -62,7 +62,7 @@
6262
) external
6363
```
6464

65-
#### Parameters
65+
##### Parameters
6666

6767
| Name | Type | Description |
6868
| :--- | :--- | :------------------------------------------------------------------- |
@@ -80,7 +80,7 @@
8080
) external
8181
```
8282

83-
#### Parameters
83+
##### Parameters
8484

8585
| Name | Type | Description |
8686
| :--- | :--- | :------------------------------------------------------------------- |
@@ -100,7 +100,7 @@
100100
) external
101101
```
102102

103-
#### Parameters
103+
##### Parameters
104104

105105
| Name | Type | Description |
106106
| :--- | :--- | :------------------------------------------------------------------- |
@@ -131,7 +131,7 @@ Add an already deployed rollup.
131131
!!! note
132132
- This rollup does not follow any `rollupType`.
133133

134-
#### Parameters
134+
##### Parameters
135135

136136
| Name | Type | Description |
137137
| :--- | :--- | :------------------------------------------------------------------- |
@@ -160,7 +160,7 @@ Add an already deployed rollup.
160160
!!! note
161161
- This rollup does not follow any `rollupType`.
162162

163-
#### Parameters
163+
##### Parameters
164164

165165
| Name | Type | Description |
166166
| :--- | :--- | :------------------------------------------------------------------- |
@@ -183,7 +183,7 @@ Upgrade an existing rollup.
183183
) external
184184
```
185185

186-
#### Parameters
186+
##### Parameters
187187

188188
| Name | Type | Description |
189189
| :--- | :--- | :------------------------------------------------------------------- |
@@ -202,7 +202,7 @@ Sequence batches, callback called by one of the consensus rollups managed by thi
202202
) external returns (uint64)
203203
```
204204

205-
#### Parameters
205+
##### Parameters
206206

207207
| Name | Type | Description |
208208
| :--- | :--- | :------------------------------------------------------------------- |
@@ -226,7 +226,7 @@ Allows an aggregator to verify multiple batches.
226226
) external
227227
```
228228

229-
#### Parameters
229+
##### Parameters
230230

231231
| Name | Type | Description |
232232
| :--- | :--- | :------------------------------------------------------------------- |
@@ -256,7 +256,7 @@ Allows a trusted aggregator to verify multiple batches.
256256
) external
257257
```
258258

259-
#### Parameters
259+
##### Parameters
260260

261261
| Name | Type | Description |
262262
| :--- | :--- | :------------------------------------------------------------------- |
@@ -286,7 +286,7 @@ Verify and reward batches internal function.
286286
) internal
287287
```
288288

289-
#### Parameters
289+
##### Parameters
290290

291291
| Name | Type | Description |
292292
| :--- | :--- | :------------------------------------------------------------------- |
@@ -319,7 +319,7 @@ Consolidates any pending state that has already exceed the `pendingStateTimeout`
319319
) external
320320
```
321321

322-
#### Parameters
322+
##### Parameters
323323

324324
| Name | Type | Description |
325325
| :--- | :--- | :------------------------------------------------------------------- |
@@ -337,7 +337,7 @@ Internal function to consolidate any pending state that has already exceed the `
337337
) internal
338338
```
339339

340-
#### Parameters
340+
##### Parameters
341341

342342
| Name | Type | Description |
343343
| :--- | :--- | :------------------------------------------------------------------- |
@@ -361,7 +361,7 @@ Allows the trusted aggregator to override the pending state if it is possible to
361361
) external
362362
```
363363

364-
#### Parameters
364+
##### Parameters
365365

366366
| Name | Type | Description |
367367
| :--- | :--- | :------------------------------------------------------------------- |
@@ -391,7 +391,7 @@ Activates the emergency state if its possible to prove a different state root gi
391391
) external
392392
```
393393

394-
#### Parameters
394+
##### Parameters
395395

396396
| Name | Type | Description |
397397
| :--- | :--- | :------------------------------------------------------------------- |
@@ -421,7 +421,7 @@ Internal function that proves a different state root given the same batches to v
421421
) internal
422422
```
423423

424-
#### Parameters
424+
##### Parameters
425425

426426
| Name | Type | Description |
427427
| :--- | :--- | :------------------------------------------------------------------- |
@@ -444,7 +444,7 @@ Function to update the batch fee based on the new verified batches. The batch fe
444444
) internal
445445
```
446446

447-
#### Parameters
447+
##### Parameters
448448

449449
| Name | Type | Description |
450450
| :--- | :--- | :------------------------------------------------------------------- |
@@ -487,7 +487,7 @@ Set a new pending state timeout. The timeout can only be lowered, except if emer
487487
) external
488488
```
489489

490-
#### Parameters
490+
##### Parameters
491491

492492
| Name | Type | Description |
493493
| :--- | :--- | :------------------------------------------------------------------- |
@@ -503,7 +503,7 @@ Set a new trusted aggregator timeout. The timeout can only be lowered, except if
503503
) external
504504
```
505505

506-
#### Parameters
506+
##### Parameters
507507

508508
| Name | Type | Description |
509509
| :--- | :--- | :------------------------------------------------------------------- |
@@ -519,7 +519,7 @@ Set a new multiplier batch fee.
519519
) external
520520
```
521521

522-
#### Parameters
522+
##### Parameters
523523

524524
| Name | Type | Description |
525525
| :--- | :--- | :------------------------------------------------------------------- |
@@ -535,7 +535,7 @@ Set a new verify batch time target. This value will only be relevant once the ag
535535
) external
536536
```
537537

538-
#### Parameters
538+
##### Parameters
539539

540540
| Name | Type | Description |
541541
| :--- | :--- | :------------------------------------------------------------------- |
@@ -549,7 +549,7 @@ Set a new verify batch time target. This value will only be relevant once the ag
549549
) external
550550
```
551551

552-
#### Parameters
552+
##### Parameters
553553

554554
| Name | Type | Description |
555555
| :--- | :--- | :------------------------------------------------------------------- |
@@ -589,7 +589,7 @@ Returns a boolean that indicates if the `pendingStateNum` is consolidate-able.
589589
) public returns (bool)
590590
```
591591

592-
#### Parameters
592+
##### Parameters
593593

594594
| Name | Type | Description |
595595
| :--- | :--- | :------------------------------------------------------------------- |
@@ -610,7 +610,7 @@ Returns a boolean that indicates if the `pendingStateNum` is consolidate-able.
610610
) internal returns (bool)
611611
```
612612

613-
#### Parameters
613+
##### Parameters
614614

615615
| Name | Type | Description |
616616
| :--- | :--- | :------------------------------------------------------------------- |
@@ -660,7 +660,7 @@ Function to calculate the input snark bytes.
660660
) public returns (bytes)
661661
```
662662

663-
#### Parameters
663+
##### Parameters
664664

665665
| Name | Type | Description |
666666
| :--- | :--- | :------------------------------------------------------------------- |
@@ -686,7 +686,7 @@ Function to calculate the input snark bytes.
686686
) internal returns (bytes)
687687
```
688688

689-
#### Parameters
689+
##### Parameters
690690

691691
| Name | Type | Description |
692692
| :--- | :--- | :------------------------------------------------------------------- |
@@ -707,7 +707,7 @@ Function to check if the state root is inside of the prime field.
707707
) internal returns (bool)
708708
```
709709

710-
#### Parameters
710+
##### Parameters
711711

712712
| Name | Type | Description |
713713
| :--- | :--- | :------------------------------------------------------------------- |
@@ -724,7 +724,7 @@ Get rollup state root given a batch number.
724724
) public returns (bytes32)
725725
```
726726

727-
#### Parameters
727+
##### Parameters
728728

729729
| Name | Type | Description |
730730
| :--- | :--- | :------------------------------------------------------------------- |
@@ -742,7 +742,7 @@ Get rollup sequence batches struct given a batch number.
742742
) public returns (struct LegacyZKEVMStateVariables.SequencedBatchData)
743743
```
744744

745-
#### Parameters
745+
##### Parameters
746746

747747
| Name | Type | Description |
748748
| :--- | :--- | :------------------------------------------------------------------- |
@@ -760,7 +760,7 @@ Get rollup sequence pending state struct given a batch number.
760760
) public returns (struct LegacyZKEVMStateVariables.PendingState)
761761
```
762762

763-
#### Parameters
763+
##### Parameters
764764

765765
| Name | Type | Description |
766766
| :--- | :--- | :------------------------------------------------------------------- |

0 commit comments

Comments
 (0)