Skip to content

Commit

Permalink
feat: document paramenter in constructor
Browse files Browse the repository at this point in the history
  • Loading branch information
reednaa committed Jan 10, 2024
1 parent cab4379 commit b72295f
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/IncentivizedMessageEscrow.sol
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ abstract contract IncentivizedMessageEscrow is IIncentivizedMessageEscrow, Bytes
/// @dev Should be overwritten to send a message using the specific messaging protocol.
function _sendPacket(bytes32 destinationIdentifier, bytes memory destinationImplementation, bytes memory message) virtual internal returns(uint128 costOfsendPacketInNativeToken);

/// @param sendLostGasTo Who should receive Ether which would otherwise block
/// execution? It should never be set to a contract which does not implement
/// either a fallback or receive function which never revert.
/// It can be set to address 0 or a similar burn address if no-one wants to take ownership of the ether.
constructor(address sendLostGasTo) {
SEND_LOST_GAS_TO = sendLostGasTo;
}
Expand Down

0 comments on commit b72295f

Please sign in to comment.