Skip to content

Commit

Permalink
add tests for referral creation (#690)
Browse files Browse the repository at this point in the history
  • Loading branch information
@doerfli
doerfli committed Sep 9, 2024
1 parent ec19f94 commit 10d6ca4
Show file tree
Hide file tree
Showing 3 changed files with 146 additions and 11 deletions.
10 changes: 5 additions & 5 deletions contracts/distribution/DistributionService.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -191,9 +191,9 @@ contract DistributionService is
(NftId distributionNftId, IInstance instance) = _getAndVerifyActiveDistribution();

if (bytes(code).length == 0) {
revert ErrorDistributionServiceInvalidReferral(code);
revert ErrorDistributionServiceInvalidReferral();
}
if (expiryAt.eqz() || expiryAt.lte(TimestampLib.blockTimestamp())) {
if (expiryAt.eqz() || expiryAt < TimestampLib.blockTimestamp()) {
revert ErrorDistributionServiceExpirationInvalid(expiryAt);
}

Expand All @@ -208,13 +208,13 @@ contract DistributionService is
IDistribution.DistributorTypeInfo memory distributorTypeData = instanceReader.getDistributorTypeInfo(distributorType);

if (distributorTypeData.maxReferralCount < maxReferrals) {
revert ErrorDistributionServiceMaxReferralsExceeded(distributorTypeData.maxReferralCount);
revert ErrorDistributionServiceMaxReferralsExceeded(distributorTypeData.maxReferralCount, maxReferrals);
}
if (distributorTypeData.minDiscountPercentage > discountPercentage) {
revert ErrorDistributionServiceDiscountTooLow(distributorTypeData.minDiscountPercentage.toInt(), discountPercentage.toInt());
revert ErrorDistributionServiceDiscountTooLow(distributorTypeData.minDiscountPercentage, discountPercentage);
}
if (distributorTypeData.maxDiscountPercentage < discountPercentage) {
revert ErrorDistributionServiceDiscountTooHigh(distributorTypeData.maxDiscountPercentage.toInt(), discountPercentage.toInt());
revert ErrorDistributionServiceDiscountTooHigh(distributorTypeData.maxDiscountPercentage, discountPercentage);
}
if (expiryAt.toInt() - TimestampLib.blockTimestamp().toInt() > distributorTypeData.maxReferralLifetime.toInt()) {
revert ErrorDistributionServiceExpiryTooLong(distributorTypeData.maxReferralLifetime, expiryAt);
Expand Down
8 changes: 4 additions & 4 deletions contracts/distribution/IDistributionService.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ interface IDistributionService is IService {
error ErrorDistributionServiceParentNftIdNotInstance(NftId nftId, NftId parentNftId);
error ErrorDistributionServiceCallerNotDistributor(address caller);
error ErrorDistributionServiceInvalidReferralId(ReferralId referralId);
error ErrorDistributionServiceMaxReferralsExceeded(uint256 maxReferrals);
error ErrorDistributionServiceDiscountTooLow(uint256 minDiscountPercentage, uint256 discountPercentage);
error ErrorDistributionServiceDiscountTooHigh(uint256 maxDiscountPercentage, uint256 discountPercentage);
error ErrorDistributionServiceMaxReferralsExceeded(uint256 limit, uint256 maxReferrals);
error ErrorDistributionServiceDiscountTooLow(UFixed minDiscountPercentage, UFixed discountPercentage);
error ErrorDistributionServiceDiscountTooHigh(UFixed maxDiscountPercentage, UFixed discountPercentage);
error ErrorDistributionServiceExpiryTooLong(Seconds maxReferralLifetime, Timestamp expiryAt);
error ErrorDistributionServiceInvalidReferral(string code);
error ErrorDistributionServiceInvalidReferral();
error ErrorDistributionServiceExpirationInvalid(Timestamp expiryAt);
error ErrorDistributionServiceCommissionTooHigh(uint256 commissionPercentage, uint256 maxCommissionPercentage);
error ErrorDistributionServiceMinFeeTooHigh(uint256 minFee, uint256 limit);
Expand Down
139 changes: 137 additions & 2 deletions test/component/distribution/Referral.t.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {console} from "../../../lib/forge-std/src/Test.sol";
import {FeeLib} from "../../../contracts/type/Fee.sol";
import {IComponents} from "../../../contracts/instance/module/IComponents.sol";
import {IDistribution} from "../../../contracts/instance/module/IDistribution.sol";
import {IDistributionService} from "../../../contracts/distribution/IDistributionService.sol";
import {IPolicy} from "../../../contracts/instance/module/IPolicy.sol";
import {NftId, NftIdLib} from "../../../contracts/type/NftId.sol";
import {POLICY} from "../../../contracts/type/ObjectType.sol";
Expand All @@ -15,8 +16,8 @@ import {ReferralTestBase} from "./ReferralTestBase.sol";
import {RiskId, RiskIdLib} from "../../../contracts/type/RiskId.sol";
import {SecondsLib} from "../../../contracts/type/Seconds.sol";
import {SimpleDistribution} from "../../../contracts/examples/unpermissioned/SimpleDistribution.sol";
import {TimestampLib} from "../../../contracts/type/Timestamp.sol";
import {UFixedLib} from "../../../contracts/type/UFixed.sol";
import {Timestamp, TimestampLib} from "../../../contracts/type/Timestamp.sol";
import {UFixed, UFixedLib} from "../../../contracts/type/UFixed.sol";

contract ReferralTest is ReferralTestBase {

Expand Down Expand Up @@ -307,6 +308,140 @@ contract ReferralTest is ReferralTestBase {
vm.stopPrank();
}

function test_createReferral_codeEmpty() public {
// GIVEN
_setupTestData(true);
vm.startPrank(customer);

// THEN
vm.expectRevert(abi.encodeWithSelector(
IDistributionService.ErrorDistributionServiceInvalidReferral.selector));

// WHEN
referralId = distribution.createReferral(
distributorNftId,
"",
discountPercentage,
maxReferrals,
expiryAt,
referralData);
}

function test_createReferral_expirationInvalid() public {
// GIVEN
vm.warp(500);
_setupTestData(true);
vm.startPrank(customer);
Timestamp tsZero = TimestampLib.zero();

// THEN
vm.expectRevert(abi.encodeWithSelector(
IDistributionService.ErrorDistributionServiceExpirationInvalid.selector,
0));

// WHEN
referralId = distribution.createReferral(
distributorNftId,
"CODE",
discountPercentage,
maxReferrals,
tsZero,
referralData);

Timestamp exp = TimestampLib.toTimestamp(TimestampLib.blockTimestamp().toInt() - 10);

// THEN
vm.expectRevert(abi.encodeWithSelector(
IDistributionService.ErrorDistributionServiceExpirationInvalid.selector,
exp));

// WHEN
referralId = distribution.createReferral(
distributorNftId,
"CODE",
discountPercentage,
maxReferrals,
exp,
referralData);

exp = TimestampLib.toTimestamp(TimestampLib.blockTimestamp().toInt() + maxReferralLifetime.toInt() + 10);

// THEN
vm.expectRevert(abi.encodeWithSelector(
IDistributionService.ErrorDistributionServiceExpiryTooLong.selector,
maxReferralLifetime,
exp));

// WHEN
referralId = distribution.createReferral(
distributorNftId,
"CODE",
discountPercentage,
maxReferrals,
exp,
referralData);
}

function test_createReferral_referralCountInvalid() public {
// GIVEN
_setupTestData(true);
vm.startPrank(customer);
Timestamp exp = TimestampLib.blockTimestamp().addSeconds(SecondsLib.toSeconds(10));

// THEN
vm.expectRevert(abi.encodeWithSelector(
IDistributionService.ErrorDistributionServiceMaxReferralsExceeded.selector,
20,
42));

// WHEN
referralId = distribution.createReferral(
distributorNftId,
"CODE",
discountPercentage,
42,
exp,
referralData);
}

function test_createReferral_discoundInvalid() public {
// GIVEN
_setupTestData(true);
vm.startPrank(customer);
Timestamp exp = TimestampLib.blockTimestamp().addSeconds(SecondsLib.toSeconds(10));
UFixed discount = UFixedLib.toUFixed(3, -2);

// THEN
vm.expectRevert(abi.encodeWithSelector(
IDistributionService.ErrorDistributionServiceDiscountTooLow.selector,
minDiscountPercentage,
discount));

// WHEN
referralId = distribution.createReferral(
distributorNftId,
"CODE",
discount,
15,
exp,
referralData);

// THEN
discount = UFixedLib.toUFixed(22, -2);
vm.expectRevert(abi.encodeWithSelector(
IDistributionService.ErrorDistributionServiceDiscountTooHigh.selector,
maxDiscountPercentage,
discount));

// WHEN
referralId = distribution.createReferral(
distributorNftId,
"CODE",
discount,
15,
exp,
referralData);
}

function _setupBundle(uint256 bundleAmount) internal {

Expand Down

0 comments on commit 10d6ca4

Please sign in to comment.