Skip to content

Commit

Permalink
fix: Add missing natspec
Browse files Browse the repository at this point in the history
Fixes: L-04
  • Loading branch information
marktoda committed Aug 21, 2023
1 parent c478e24 commit ce6b1f5
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 2 deletions.
2 changes: 1 addition & 1 deletion src/base/ReactorEvents.sol
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ interface ReactorEvents {
/// @notice emitted when an order is filled
/// @param orderHash The hash of the order that was filled
/// @param filler The address which executed the fill
/// @param nonce The nonce of the filled order
/// @param swapper The swapper of the filled order
/// @param nonce The nonce of the filled order
event Fill(bytes32 indexed orderHash, address indexed filler, address indexed swapper, uint256 nonce);
}
1 change: 1 addition & 0 deletions src/interfaces/IReactor.sol
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ interface IReactor {

/// @notice Execute a single order using the given callback data
/// @param order The order definition and valid signature to execute
/// @param callbackData The callbackData to pass to the callback
function executeWithCallback(SignedOrder calldata order, bytes calldata callbackData) external payable;

/// @notice Execute the given orders at once
Expand Down
3 changes: 2 additions & 1 deletion src/lens/OrderQuoter.sol
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ contract OrderQuoter is IReactorCallback {
}

/// @notice Return the order info of a given order (abi-encoded bytes).
/// @param order abi-encoded order, including `reactor` as the first encoded struct member
/// @param reason The revert reason
/// @return order abi-encoded order, including `reactor` as the first encoded struct member
function parseRevertReason(bytes memory reason) private pure returns (ResolvedOrder memory order) {
if (reason.length < 192) {
assembly {
Expand Down
1 change: 1 addition & 0 deletions src/lib/ResolvedOrderLib.sol
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ pragma solidity ^0.8.0;
import {ResolvedOrder} from "../base/ReactorStructs.sol";
import {IValidationCallback} from "../interfaces/IValidationCallback.sol";

/// @notice Library for handling validation of resolved orders
library ResolvedOrderLib {
/// @notice thrown when the order targets a different reactor
error InvalidReactor();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ pragma solidity ^0.8.0;
import {IValidationCallback} from "../interfaces/IValidationCallback.sol";
import {ResolvedOrder, OrderInfo} from "../base/ReactorStructs.sol";

/// @notice validation for orders that are exclusive to a single filler
contract ExclusiveFillerValidation is IValidationCallback {
/// @notice thrown if the filler does not have fill rights
error NotExclusiveFiller(address filler);
Expand Down

0 comments on commit ce6b1f5

Please sign in to comment.