Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
seunlanlege committed Sep 12, 2024
1 parent e6da185 commit ca061e2
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions interfaces/IDispatcher.sol
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,20 @@ struct DispatchPostResponse {
*/
interface IDispatcher {
/**
* @return the address of the fee token ERC-20 contract on this state machine
* @dev Returns the address of the ERC-20 fee token contract configured for this state machine.
*
* @notice Hyperbridge collects it's dispatch fees in the provided token denomination. This will typically be in stablecoins.
*
* @return feeToken - The ERC20 contract address for fees.
*/
function feeToken() external view returns (address);

/**
* @return the per-byte fee for outgoing messages.
* @dev Returns the address of the per byte fee configured for this state machine.
*
* @notice Hyperbridge collects it's dispatch fees per every byte of the outgoing message.
*
* @return perByteFee - The per byte fee for outgoing messages.
*/
function perByteFee() external view returns (uint256);

Expand Down

0 comments on commit ca061e2

Please sign in to comment.