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

remove unused fee values from pool (#478) #480

Merged
merged 2 commits into from
Jul 8, 2024
+84 −98
Merged

remove unused fee values from pool (#478) #480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2cf306b
remove unused fee values from pool (closes #478)
doerfli Jul 4, 2024
278a31a
return effective staked amount when creating bundle (#478)
doerfli Jul 4, 2024
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
3 changes: 0 additions & 3 deletions contracts/instance/module/IComponents.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,5 @@ interface IComponents {
bool isVerifyingApplications; // underwriting requires the pool component checks/confirms the applications
UFixed collateralizationLevel; // factor to calculate collateral for sum insurance (default 100%)
UFixed retentionLevel; // amount of collateral held in pool (default 100%)
Fee poolFee; // pool fee on net premium
Fee stakingFee; // pool fee on staked capital from investor
Fee performanceFee; // pool fee on profits from capital investors
}
}
11 changes: 1 addition & 10 deletions contracts/pool/IPoolService.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,6 @@ interface IPoolService is IService {
/// @dev sets the max capital amount for the calling pool
function setMaxCapitalAmount(Amount maxCapitalAmount) external;

/// @dev set pool sepecific fees
function setFees(
Fee memory poolFee,
Fee memory stakingFee,
Fee memory performanceFee
) external;


/// @dev locks required collateral to cover the specified application (and turn it into a policy)
/// - retention level == 1: the full collateral amount will be locked by the specified bundle
/// - retention level < 1: a part of the coverage is provided by the specified bundle, the rest by the pool component
Expand Down Expand Up @@ -102,8 +94,7 @@ interface IPoolService is IService {
bytes calldata filter // optional use case specific criteria that define if a policy may be covered by this bundle
)
external
returns(NftId bundleNftId); // the nft id of the newly created bundle
// TODO: return netAmount
returns(NftId bundleNftId, Amount netStakedAmount); // the nft id of the newly created bundle


/// @dev closes the specified bundle
Expand Down
9 changes: 3 additions & 6 deletions contracts/pool/Pool.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,10 +120,7 @@ abstract contract Pool is
false, // isExternallyManaged,
false, // isVerifyingApplications,
UFixedLib.toUFixed(1), // collateralizationLevel,
UFixedLib.toUFixed(1), // retentionLevel,
FeeLib.zero(), // initialPoolFee,
FeeLib.zero(), // initialStakingFee,
FeeLib.zero() // initialPerformanceFee,
UFixedLib.toUFixed(1) // retentionLevel,
);
}

Expand Down Expand Up @@ -299,9 +296,9 @@ abstract contract Pool is
bytes memory filter
)
internal
returns(NftId bundleNftId)
returns(NftId bundleNftId, Amount netStakedAmount)
{
bundleNftId = _getPoolStorage()._poolService.createBundle(
(bundleNftId, netStakedAmount) = _getPoolStorage()._poolService.createBundle(
bundleOwner,
fee,
amount,
Expand Down
50 changes: 8 additions & 42 deletions contracts/pool/PoolService.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,27 +109,6 @@ contract PoolService is
emit LogPoolServiceBundleOwnerRoleSet(poolNftId, bundleOwnerRole);
}


function setFees(
Fee memory poolFee,
Fee memory stakingFee,
Fee memory performanceFee
)
external
virtual
{
(NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());

IComponents.PoolInfo memory poolInfo = instance.getInstanceReader().getPoolInfo(poolNftId);
poolInfo.poolFee = poolFee;
poolInfo.stakingFee = stakingFee;
poolInfo.performanceFee = performanceFee;

instance.getInstanceStore().updatePool(poolNftId, poolInfo, KEEP_STATE());

// TODO add logging
}

/// @inheritdoc IPoolService
function createBundle(
address bundleOwner, // initial bundle owner
Expand All @@ -140,16 +119,13 @@ contract PoolService is
)
external
virtual
returns(NftId bundleNftId)
returns(NftId bundleNftId, Amount netStakedAmount)
{
(NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
InstanceReader instanceReader = instance.getInstanceReader();

(
Amount stakingFeeAmount,
Amount stakingNetAmount
) = FeeLib.calculateFee(
_getStakingFee(instanceReader, poolNftId),

Amount stakingFeeAmount;
(stakingFeeAmount, netStakedAmount) = FeeLib.calculateFee(
_getStakingFee(instance.getInstanceReader(), poolNftId),
stakingAmount);

// TODO: staking amount must be be > maxCapitalAmount
Expand All @@ -159,20 +135,20 @@ contract PoolService is
poolNftId,
bundleOwner,
fee,
stakingNetAmount,
netStakedAmount,
lifetime,
filter);

// pool book keeping
_componentService.increasePoolBalance(
instance.getInstanceStore(),
poolNftId,
stakingNetAmount,
netStakedAmount,
stakingFeeAmount);

// pool bookkeeping and collect tokens from bundle owner
_collectStakingAmount(
instanceReader,
instance.getInstanceReader(),
poolNftId,
bundleOwner,
stakingAmount);
Expand Down Expand Up @@ -312,16 +288,6 @@ contract PoolService is
return unstakedAmount;
}

function _getPerformanceFee(InstanceReader instanceReader, NftId poolNftId)
internal
virtual
view
returns (Fee memory performanceFee)
{
NftId productNftId = instanceReader.getComponentInfo(poolNftId).productNftId;
return instanceReader.getPoolInfo(productNftId).performanceFee;
}

function processSale(
NftId bundleNftId,
IPolicy.Premium memory premium
Expand Down
28 changes: 14 additions & 14 deletions test/TestBundle.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ contract TestBundle is GifTest {
token.approve(address(pool.getTokenHandler()), 2000);

Seconds lifetime = SecondsLib.toSeconds(604800);
bundleNftId = pool.createBundle(
(bundleNftId,) = pool.createBundle(
FeeLib.zero(),
1000,
lifetime,
Expand Down Expand Up @@ -93,7 +93,7 @@ contract TestBundle is GifTest {
token.approve(address(pool.getTokenHandler()), 1000);

Seconds lifetime = SecondsLib.toSeconds(604800);
bundleNftId = pool.createBundle(
(bundleNftId,) = pool.createBundle(
FeeLib.zero(),
1000,
lifetime,
Expand Down Expand Up @@ -127,7 +127,7 @@ contract TestBundle is GifTest {
token.approve(address(pool.getTokenHandler()), 2000);

Seconds lifetime = SecondsLib.toSeconds(604800);
bundleNftId = pool.createBundle(
(bundleNftId,) = pool.createBundle(
FeeLib.zero(),
1000,
lifetime,
Expand Down Expand Up @@ -156,7 +156,7 @@ contract TestBundle is GifTest {
token.approve(address(pool.getTokenHandler()), 2000);

Seconds lifetime = SecondsLib.toSeconds(604800);
bundleNftId = pool.createBundle(
(bundleNftId,) = pool.createBundle(
FeeLib.zero(),
1000,
lifetime,
Expand Down Expand Up @@ -192,7 +192,7 @@ contract TestBundle is GifTest {
token.approve(address(pool.getTokenHandler()), 2000);

Seconds lifetime = SecondsLib.toSeconds(604800);
bundleNftId = pool.createBundle(
(bundleNftId,) = pool.createBundle(
FeeLib.zero(),
1000,
lifetime,
Expand Down Expand Up @@ -227,7 +227,7 @@ contract TestBundle is GifTest {
token.approve(address(pool.getTokenHandler()), 2000);

Seconds lifetime = SecondsLib.toSeconds(604800);
bundleNftId = pool.createBundle(
(bundleNftId,) = pool.createBundle(
FeeLib.zero(),
1000,
lifetime,
Expand Down Expand Up @@ -278,7 +278,7 @@ contract TestBundle is GifTest {
token.approve(address(pool.getTokenHandler()), 2000);

Seconds lifetime = SecondsLib.toSeconds(604800);
bundleNftId = pool.createBundle(
(bundleNftId,) = pool.createBundle(
FeeLib.zero(),
1000,
lifetime,
Expand Down Expand Up @@ -330,7 +330,7 @@ contract TestBundle is GifTest {
token.approve(address(pool.getTokenHandler()), 2000);

Seconds lifetime = SecondsLib.toSeconds(604800);
bundleNftId = pool.createBundle(
(bundleNftId,) = pool.createBundle(
FeeLib.zero(),
1000,
lifetime,
Expand Down Expand Up @@ -362,7 +362,7 @@ contract TestBundle is GifTest {
token.approve(address(pool.getTokenHandler()), 2000);

Seconds lifetime = SecondsLib.toSeconds(604800);
bundleNftId = pool.createBundle(
(bundleNftId,) = pool.createBundle(
FeeLib.zero(),
1000,
lifetime,
Expand Down Expand Up @@ -391,7 +391,7 @@ contract TestBundle is GifTest {
token.approve(address(pool.getTokenHandler()), 2000);

Seconds lifetime = SecondsLib.toSeconds(604800);
bundleNftId = pool.createBundle(
(bundleNftId,) = pool.createBundle(
FeeLib.zero(),
1000,
lifetime,
Expand Down Expand Up @@ -432,7 +432,7 @@ contract TestBundle is GifTest {
token.approve(address(pool.getTokenHandler()), 1000);

Seconds lifetime = SecondsLib.toSeconds(604800);
bundleNftId = pool.createBundle(
(bundleNftId,) = pool.createBundle(
FeeLib.zero(),
1000,
lifetime,
Expand Down Expand Up @@ -472,7 +472,7 @@ contract TestBundle is GifTest {
token.approve(address(pool.getTokenHandler()), 1000);

Seconds lifetime = SecondsLib.toSeconds(604800);
bundleNftId = pool.createBundle(
(bundleNftId,) = pool.createBundle(
FeeLib.zero(),
1000,
lifetime,
Expand Down Expand Up @@ -511,7 +511,7 @@ contract TestBundle is GifTest {
token.approve(address(pool.getTokenHandler()), 1000);

Seconds lifetime = SecondsLib.toSeconds(604800);
bundleNftId = pool.createBundle(
(bundleNftId,) = pool.createBundle(
FeeLib.zero(),
1000,
lifetime,
Expand Down Expand Up @@ -543,7 +543,7 @@ contract TestBundle is GifTest {
token.approve(address(pool.getTokenHandler()), 1000);

Seconds lifetime = SecondsLib.toSeconds(0);
bundleNftId = pool.createBundle(
(bundleNftId,) = pool.createBundle(
FeeLib.zero(),
1000,
lifetime,
Expand Down
63 changes: 48 additions & 15 deletions test/TestPool.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ pragma solidity ^0.8.20;

import {console} from "../lib/forge-std/src/Test.sol";

import {Amount, AmountLib} from "../contracts/type/Amount.sol";
import {BasicPoolAuthorization} from "../contracts/pool/BasicPoolAuthorization.sol";
import {Fee, FeeLib} from "../contracts/type/Fee.sol";
import {IBundle} from "../contracts/instance/module/IBundle.sol";
Expand Down Expand Up @@ -105,17 +106,6 @@ contract TestPool is GifTest {
assertTrue(componentInfo.productNftId.eqz(), "product nft not zero (not yet linked to product)");
assertEq(poolInfo.bundleOwnerRole.toInt(), PUBLIC_ROLE().toInt(), "unexpected bundle owner role");

// check fees
Fee memory poolFee = poolInfo.poolFee;
Fee memory stakingFee = poolInfo.stakingFee;
Fee memory performanceFee = poolInfo.performanceFee;
assertEq(poolFee.fractionalFee.toInt(), 0, "pool fee not 0");
assertEq(poolFee.fixedFee, 0, "pool fee not 0");
assertEq(stakingFee.fractionalFee.toInt(), 0, "staking fee not 0");
assertEq(stakingFee.fixedFee, 0, "staking fee not 0");
assertEq(performanceFee.fractionalFee.toInt(), 0, "performance fee not 0");
assertEq(performanceFee.fixedFee, 0, "performance fee not 0");

// check pool balance
assertTrue(instanceReader.getBalanceAmount(poolNftId).eqz(), "initial pool balance not zero");
assertTrue(instanceReader.getFeeAmount(poolNftId).eqz(), "initial pool fee not zero");
Expand Down Expand Up @@ -174,7 +164,8 @@ contract TestPool is GifTest {
token.approve(address(pool.getTokenHandler()), 10000);

Seconds lifetime = SecondsLib.toSeconds(604800);
bundleNftId = pool.createBundle(
uint256 netStakedAmount;
(bundleNftId, netStakedAmount) = pool.createBundle(
FeeLib.zero(),
10000,
lifetime,
Expand All @@ -184,9 +175,15 @@ contract TestPool is GifTest {

// THEN
assertTrue(!bundleNftId.eqz(), "bundle nft id is zero");
assertEq(netStakedAmount, 10000, "net staked amount not 10000");

assertEq(token.balanceOf(poolOwner), 0, "pool owner token balance not 0");
assertEq(token.balanceOf(componentInfo.wallet), 10000, "pool wallet token balance not 10000");

assertEq(token.balanceOf(poolOwner), 0, "pool owner balance not 0");
assertEq(token.balanceOf(componentInfo.wallet), 10000, "pool wallet balance not 10000");
assertEq(instanceReader.getBalanceAmount(poolNftId).toInt(), 10000, "pool balance not 10000");
assertEq(instanceReader.getFeeAmount(poolNftId).toInt(), 0, "pool fee not 0");
assertEq(instanceReader.getBalanceAmount(bundleNftId).toInt(), 10000, "bundle balance not 10000");
assertEq(instanceReader.getFeeAmount(bundleNftId).toInt(), 0, "bundle fee not 0");

assertEq(instanceBundleSet.bundles(poolNftId), 1, "expected only 1 bundle");
assertEq(instanceBundleSet.getBundleNftId(poolNftId, 0).toInt(), bundleNftId.toInt(), "bundle nft id in bundle manager not equal to bundle nft id");
Expand All @@ -204,6 +201,42 @@ contract TestPool is GifTest {
"unexpected activatedAt");
}

function test_PoolCreateBundle_withStakingFee() public {
// GIVEN
initialStakingFee = FeeLib.percentageFee(10);
_prepareProduct(false);
_fundInvestor();

IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);

// WHEN
// SimplePool spool = SimplePool(address(pool));
vm.startPrank(investor);
token.approve(address(pool.getTokenHandler()), 10000);

Seconds lifetime = SecondsLib.toSeconds(604800);
uint256 netStakedAmount;
(bundleNftId, netStakedAmount) = pool.createBundle(
FeeLib.zero(),
10000,
lifetime,
""
);
vm.stopPrank();

// THEN
assertTrue(!bundleNftId.eqz(), "bundle nft id is zero");
assertEq(netStakedAmount, 9000, "net staked amount not 9000");

assertEq(token.balanceOf(poolOwner), 0, "pool owner token balance not 0");
assertEq(token.balanceOf(componentInfo.wallet), 10000, "pool wallet token balance not 10000");

assertEq(instanceReader.getBalanceAmount(poolNftId).toInt(), 10000, "pool balance not 10000");
assertEq(instanceReader.getFeeAmount(poolNftId).toInt(), 1000, "pool fee not 0");
assertEq(instanceReader.getBalanceAmount(bundleNftId).toInt(), 9000, "bundle balance not 10000");
assertEq(instanceReader.getFeeAmount(bundleNftId).toInt(), 0, "bundle fee not 0");
}


function test_PoolBundleInitialState() public {
// GIVEN
Expand Down Expand Up @@ -330,7 +363,7 @@ contract TestPool is GifTest {
IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
token.approve(address(componentInfo.tokenHandler), 10000);

bundleNftId = pool.createBundle(
(bundleNftId,) = pool.createBundle(
FeeLib.zero(),
10000,
SecondsLib.toSeconds(604800),
Expand Down
2 changes: 1 addition & 1 deletion test/TestProduct.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -931,7 +931,7 @@ contract TestProduct is GifTest {
token.approve(address(componentInfo.tokenHandler), bundleCapital);

Fee memory bundleFee = FeeLib.toFee(UFixedLib.zero(), 10);
bundleNftId = pool.createBundle(
(bundleNftId,) = pool.createBundle(
bundleFee,
bundleCapital,
SecondsLib.toSeconds(604800),
Expand Down
2 changes: 1 addition & 1 deletion test/base/GifTest.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,7 +486,7 @@ contract GifTest is GifDeployer {
IComponents.ComponentInfo memory poolComponentInfo = instanceReader.getComponentInfo(poolNftId);
token.approve(address(poolComponentInfo.tokenHandler), DEFAULT_BUNDLE_CAPITALIZATION * 10**token.decimals());

bundleNftId = SimplePool(address(pool)).createBundle(
(bundleNftId,) = SimplePool(address(pool)).createBundle(
FeeLib.zero(),
DEFAULT_BUNDLE_CAPITALIZATION * 10**token.decimals(),
SecondsLib.toSeconds(DEFAULT_BUNDLE_LIFETIME),
Expand Down
Loading
Loading