Skip to content
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

🔍 review contract #1

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

🔍 review contract #1

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
65 changes: 54 additions & 11 deletions src/FriendlyAgent.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,27 @@
pragma solidity ^0.8.18;

interface IFriendtechSharesV1 {
function getBuyPriceAfterFee(address sharesSubject, uint256 amount) external view returns (uint256);
function getSellPriceAfterFee(address sharesSubject, uint256 amount) external view returns (uint256);
function getBuyPriceAfterFee(
address sharesSubject,
uint256 amount
) external view returns (uint256);

function getSellPriceAfterFee(
address sharesSubject,
uint256 amount
) external view returns (uint256);

function buyShares(address sharesSubject, uint256 amount) external payable;

function sellShares(address sharesSubject, uint256 amount) external payable;
}

interface IERC20 {
function transfer(address recipient, uint256 amount) external returns (bool);
function transfer(
address recipient,
uint256 amount
) external returns (bool);

function balanceOf(address account) external view returns (uint256);
}

Expand All @@ -22,7 +35,7 @@ contract FriendlyAgent {

IFriendtechSharesV1 public immutable i_friendtechShares;
address public immutable i_owner;
mapping(address => uint256) private s_holdings;
mapping(address => uint256) private s_holdings; // recommend passing this public

constructor(address _friendtechSharesAddress) {
i_friendtechShares = IFriendtechSharesV1(_friendtechSharesAddress);
Expand All @@ -36,21 +49,39 @@ contract FriendlyAgent {
_;
}

function buyShares(uint256 maxPrice, uint256 amount, address sharesSubject) public payable onlyOwner {
uint256 priceAfterFee = i_friendtechShares.getBuyPriceAfterFee(sharesSubject, amount);
function buyShares(
uint256 maxPrice,
uint256 amount,
address sharesSubject
) public payable onlyOwner {
uint256 priceAfterFee = i_friendtechShares.getBuyPriceAfterFee(
sharesSubject,
amount
);
if (priceAfterFee > maxPrice) {
revert FriendlyAgent__OverMaxLimit();
}

s_holdings[sharesSubject] += amount;
i_friendtechShares.buyShares{value: priceAfterFee}(sharesSubject, amount);
i_friendtechShares.buyShares{value: priceAfterFee}(
sharesSubject,
amount
);
}

function sellShares(uint256 minPrice, uint256 amount, address sharesSubject) public onlyOwner {
function sellShares(
uint256 minPrice,
uint256 amount,
address sharesSubject
) public onlyOwner {
if (s_holdings[sharesSubject] < amount) {
// Useless check, if not true, `s_holdings[sharesSubject] -= amount` will revert
revert FriendlyAgent__AmountGreaterThanHoldings();
}
uint256 priceAfterFee = i_friendtechShares.getSellPriceAfterFee(sharesSubject, amount);
uint256 priceAfterFee = i_friendtechShares.getSellPriceAfterFee(
sharesSubject,
amount
);
if (priceAfterFee < minPrice) {
revert FriendlyAgent__UnderMinLimit();
}
Expand All @@ -60,7 +91,9 @@ contract FriendlyAgent {
}

function withdraw() public onlyOwner {
(bool callSuccess,) = payable(i_owner).call{value: address(this).balance}("");
(bool callSuccess, ) = payable(i_owner).call{
value: address(this).balance
}("");
require(callSuccess, "Call failed");
}

Expand All @@ -69,9 +102,19 @@ contract FriendlyAgent {
uint256 balance = token.balanceOf(address(this));
require(balance > 0, "No tokens to withdraw");
require(token.transfer(i_owner, balance), "Token transfer failed");
// Previous require will not work with every ERC-20
// Recommend to implement the following:
// function _callOptionalReturn(IERC20 token, bytes memory data) private {
// bytes memory returndata = address(token).functionCall(data);
// if (returndata.length != 0 && !abi.decode(returndata, (bool))) {
// revert SafeERC20FailedOperation(address(token));
// }
}

function getHoldings(address sharesSubject) external view returns (uint256) {
function getHoldings(
address sharesSubject
) external view returns (uint256) {
// Can be removed if s_holdings is changed to public
return s_holdings[sharesSubject];
}

Expand Down