Skip to content

Commit

Permalink
Update Natspec for FeeAdapter (#10969)
Browse files Browse the repository at this point in the history
  • Loading branch information
martinvol authored Apr 18, 2024
1 parent dd0899b commit 0f0833a
Showing 1 changed file with 29 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,49 @@
pragma solidity >=0.8.7 <0.8.20;

interface IFeeCurrencyAdapter {
/**
* @return The address of the adapted token.
*/
function getAdaptedToken() external view returns (address);

/**
* @return The multiplier that should be used when upscaling and downscaling. This is the result of 10**(expectedDecimals - getAdaptedToken().decimals()).
*/
function digitDifference() external view returns (uint96);

/**
* @return The amount that is debited after calling debitGasFees() and before creditGasFees().
*/
function debited() external view returns (uint256);

/**
* @return The name of the adapted token.
*/
function name() external view returns (string memory);

/**
* @return The symbol of adapted token.
*/
function symbol() external view returns (string memory);

function expectedDecimals() external view returns (uint8);

/**
* @return The decimals expected by the vm.
*/
function decimals() external view returns (uint8);

/**
* @return Same as decimals.
*/
function expectedDecimals() external view returns (uint8);

/**
* @notice Same as debitGasFees in IFeeCurrency, always using the number of decimals the evm expects.
*/
function debitGasFees(address from, uint256 value) external;

/**
* @notice Same as creditGasFees in IFeeCurrency, always using the number of decimals the evm expects.
*/
function creditGasFees(
address refundRecipient,
address tipRecipient,
Expand Down

0 comments on commit 0f0833a

Please sign in to comment.