Skip to content

[SC-1465] Add Incomplete Docstrings #365

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[SC-1465] Add Incomplete Docstrings #365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions contracts/interfaces/IAmountGetter.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ interface IAmountGetter {
* @param takingAmount Actual taking amount
* @param remainingMakingAmount Order remaining making amount
* @param extraData Extra data
* @return makingAmount Actual making amount that should be used for the order
*/
function getMakingAmount(
IOrderMixin.Order calldata order,
Expand All @@ -34,6 +35,7 @@ interface IAmountGetter {
* @param makingAmount Actual taking amount
* @param remainingMakingAmount Order remaining making amount
* @param extraData Extra data
* @return takingAmount Actual taking amount that should be used for the order
*/
function getTakingAmount(
IOrderMixin.Order calldata order,
Expand Down
2 changes: 2 additions & 0 deletions contracts/interfaces/IOrderMixin.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,15 @@ interface IOrderMixin {

/**
* @notice Returns bitmask for double-spend invalidators based on lowest byte of order.info and filled quotes
* @param maker Address of the order maker
* @param orderHash Hash of the order
* @return remaining Remaining amount of the order
*/
function remainingInvalidatorForOrder(address maker, bytes32 orderHash) external view returns(uint256 remaining);

/**
* @notice Returns bitmask for double-spend invalidators based on lowest byte of order.info and filled quotes
* @param maker Address of the order maker
* @param orderHash Hash of the order
* @return remainingRaw Inverse of the remaining amount of the order if order was filled at least once, otherwise 0
*/
Expand Down
Loading