Skip to content

Commit bc8b260

Browse files
committed
Update solidity docs
1 parent 6e8fcfc commit bc8b260

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

contracts/trading/seaport16/zones/immutable-signed-zone/v3/ImmutableSignedZoneV3.sol

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -441,6 +441,7 @@ contract ImmutableSignedZoneV3 is
441441
*
442442
* @param context Bytes payload of context.
443443
* @param zoneParameters The zone parameters.
444+
* @param before Whether validation is occurring in before or after hook.
444445
*/
445446
function _validateSubstandards(bytes calldata context, ZoneParameters calldata zoneParameters, bool before) internal {
446447
uint256 startIndex = 0;
@@ -477,10 +478,13 @@ contract ImmutableSignedZoneV3 is
477478
}
478479

479480
/**
480-
* @dev Validates substandard 1.
481+
* @dev Validates substandard 1. This substandard is used to validate that the server's
482+
* specified first received item identifier matches the actual first received
483+
* item identifier.
481484
*
482485
* @param context Bytes payload of context, 0 indexed to start of substandard segment.
483486
* @param zoneParameters The zone parameters.
487+
* @param before Whether validation is occurring in before or after hook.
484488
* @return Length of substandard segment.
485489
*/
486490
function _validateSubstandard1(
@@ -516,6 +520,7 @@ contract ImmutableSignedZoneV3 is
516520
*
517521
* @param context Bytes payload of context, 0 indexed to start of substandard segment.
518522
* @param zoneParameters The zone parameters.
523+
* @param before Whether validation is occurring in before or after hook.
519524
* @return Length of substandard segment.
520525
*/
521526
function _validateSubstandard3(
@@ -549,6 +554,7 @@ contract ImmutableSignedZoneV3 is
549554
*
550555
* @param context Bytes payload of context, 0 indexed to start of substandard segment.
551556
* @param zoneParameters The zone parameters.
557+
* @param before Whether validation is occurring in before or after hook.
552558
* @return Length of substandard segment.
553559
*/
554560
function _validateSubstandard4(
@@ -589,6 +595,7 @@ contract ImmutableSignedZoneV3 is
589595
*
590596
* @param context Bytes payload of context, 0 indexed to start of substandard segment.
591597
* @param zoneParameters The zone parameters.
598+
* @param before Whether validation is occurring in before or after hook.
592599
* @return Length of substandard segment.
593600
*/
594601
function _validateSubstandard6(
@@ -638,6 +645,16 @@ contract ImmutableSignedZoneV3 is
638645
return 65;
639646
}
640647

648+
/**
649+
* @dev Validates substandard 7. This substandard is a superset of substandard 1. It
650+
* additionally calls the creator token standard transfer validator before and
651+
* after token transfer hooks for a specified operator.
652+
*
653+
* @param context Bytes payload of context, 0 indexed to start of substandard segment.
654+
* @param zoneParameters The zone parameters.
655+
* @param before Whether validation is occurring in before or after hook.
656+
* @return Length of substandard segment.
657+
*/
641658
function _validateSubstandard7(
642659
bytes calldata context,
643660
ZoneParameters calldata zoneParameters,
@@ -679,6 +696,16 @@ contract ImmutableSignedZoneV3 is
679696
return 73;
680697
}
681698

699+
/**
700+
* @dev Validates substandard 8. This substandard is a superset of substandard 1. It
701+
* additionally calls the creator token standard transfer validator before and
702+
* after token transfer hooks.
703+
*
704+
* @param context Bytes payload of context, 0 indexed to start of substandard segment.
705+
* @param zoneParameters The zone parameters.
706+
* @param before Whether validation is occurring in before or after hook.
707+
* @return Length of substandard segment.
708+
*/
682709
function _validateSubstandard8(
683710
bytes calldata context,
684711
ZoneParameters calldata zoneParameters,

0 commit comments

Comments
 (0)