Skip to content

Commit

Permalink
new multiclam function with test
Browse files Browse the repository at this point in the history
  • Loading branch information
@asserules
asserules committed Feb 20, 2024
1 parent c466bc3 commit 4ecba8b
Show file tree
Hide file tree
Showing 2 changed files with 105 additions and 43 deletions.
93 changes: 51 additions & 42 deletions src/royalty/ABClaim.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -291,67 +291,76 @@ contract ABClaim is Initializable, AccessControlUpgradeable {
// abKycModule.beforeRoyaltyClaim(_user, _signature);
}

function _claimMultiDrop(
function _claimMultiDrop(
uint256[] calldata _dropIds,
uint256[][] calldata _tokenIds,
address _user,
bytes calldata _signature
) internal {
// Enforce KYC Signature validity through ABKYCModule contract
_beforeClaim(_user, _signature);

// Check parameters validity
uint256 dLength = _dropIds.length;
if (dLength != _tokenIds.length) revert ABErrors.INVALID_PARAMETER();
// Check parameters validity
if (_dropIds.length != _tokenIds.length) revert ABErrors.INVALID_PARAMETER();

uint256 totalClaimable;

for (uint256 i; i < dLength;) {
uint256 dropId = _dropIds[i];

for (uint256 i; i < _dropIds.length;) {
// Get drop data
ABDataTypes.DropData memory data = dropData[dropId];
ABDataTypes.DropData memory data = dropData[_dropIds[i]];
// get the claimableAmount depening on L1 or Base
uint256 dropClaimable = data.isL1 ?
handleL1Drop(_dropIds[i], _tokenIds[i], _user) :
handleBaseDrop(_dropIds[i], _tokenIds[i], _user, data.nft);

//emit event with dropClaimable from the handler
emit ABEvents.RoyaltyClaimed(_dropIds[i], _tokenIds[i], dropClaimable, _user);
totalClaimable += dropClaimable;

// Calculate royalties per token
uint256 royaltiesPerToken = totalDepositedPerDrop[dropId] / data.supply;
unchecked {
++i;
}
}
//transfer the totalClaimable
USDC.transfer(_user, totalClaimable);
}

function handleL1Drop(uint256 dropId, uint256[] calldata tokenIds, address user) internal returns (uint256) {
uint256 totalClaimable;
uint256 royaltiesPerToken = totalDepositedPerDrop[dropId] / dropData[dropId].supply;

// Check if the drop is on Layer 1 or on Base
if (data.isL1) {
for (uint256 j; j < _tokenIds[i].length;) {
// Enforce token ownership
if (ownerOf[dropId][_tokenIds[i][j]] != _user) revert ABErrors.NOT_TOKEN_OWNER();
for (uint256 j; j < tokenIds.length;) {
if (ownerOf[dropId][tokenIds[j]] != user) revert ABErrors.NOT_TOKEN_OWNER();

// Calculate claimable amount
uint256 _claimable = royaltiesPerToken - claimedAmount[dropId][_tokenIds[i][j]];
totalClaimable += _claimable;
claimedAmount[dropId][_tokenIds[i][j]] += _claimable;
uint256 claimable = royaltiesPerToken - claimedAmount[dropId][tokenIds[j]];
totalClaimable += claimable;
claimedAmount[dropId][tokenIds[j]] += claimable;

unchecked {
++j;
}
}
} else {
for (uint256 j; j < _tokenIds[i].length;) {
// Enforce token ownership
if (IERC721AB(data.nft).ownerOf(_tokenIds[i][j]) != _user) revert ABErrors.NOT_TOKEN_OWNER();

// Calculate claimable amount
uint256 _claimable = royaltiesPerToken - claimedAmount[dropId][_tokenIds[i][j]];
totalClaimable += _claimable;
claimedAmount[dropId][_tokenIds[i][j]] += _claimable;

unchecked {
++j;
}
}
unchecked {
++j;
}
emit ABEvents.RoyaltyClaimed(_dropIds[i], _tokenIds[i], totalClaimable, _user);
}

return totalClaimable;
}

function handleBaseDrop(uint256 dropId, uint256[] calldata tokenIds, address user, address nftAddress) internal returns (uint256) {
uint256 totalClaimable;
uint256 royaltiesPerToken = totalDepositedPerDrop[dropId] / dropData[dropId].supply;
IERC721AB nft = IERC721AB(nftAddress);

for (uint256 j; j < tokenIds.length;) {
if (nft.ownerOf(tokenIds[j]) != user) revert ABErrors.NOT_TOKEN_OWNER();

uint256 claimable = royaltiesPerToken - claimedAmount[dropId][tokenIds[j]];
totalClaimable += claimable;
claimedAmount[dropId][tokenIds[j]] += claimable;

unchecked {
++i;
++j;
}
}
// Transfer total claimable amount to the shareholder
USDC.transfer(_user, totalClaimable);

return totalClaimable;
}

function _claimSingleDrop(uint256 _dropId, uint256[] calldata _tokenIds, address _user, bytes calldata _signature)
Expand Down
55 changes: 54 additions & 1 deletion test/royalty/ABClaim.t.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {ABClaim} from "src/royalty/ABClaim.sol";
import {ABErrors} from "src/libraries/ABErrors.sol";
import {MockNFT} from "test/_mocks/MockNFT.sol";
import {MockToken} from "test/_mocks/MockToken.sol";

import "../../lib/openzeppelin-contracts/contracts/utils/Strings.sol";
import {TransparentUpgradeableProxy} from "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
import {ProxyAdmin} from "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
import {ECDSA} from "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
Expand Down Expand Up @@ -940,6 +940,59 @@ contract ABClaimTest is Test {
assertEq(abClaim.getClaimableAmount(dropIds, uTokenIds), 0);
}

function test_claim_multiScaleBaseDrop(address _sender, address u1, uint256 scaleAmount) public {
vm.assume(_sender != address(0));
vm.assume(u1 != address(0));
vm.assume(scaleAmount < 50);

abClaim.grantRole(DEFAULT_ADMIN_ROLE_HASH, _sender);

uint256[] memory dropIds = new uint256[](scaleAmount);
uint256[] memory amounts = new uint256[](scaleAmount);
uint256 amount = 6000;
MockNFT[] memory nfts = new MockNFT[](scaleAmount);

for (uint256 i; i < scaleAmount; i++) {
amounts[i] = amount;
}

mockUSD.mint(_sender, amount * scaleAmount);

vm.startPrank(_sender);
mockUSD.approve(address(abClaim), amount * scaleAmount);
abClaim.depositRoyalty(dropIds, amounts);
vm.stopPrank();


for (uint256 i; i < dropIds.length; i++ ) {
dropIds[i] = i;
string memory nftName = string(abi.encodePacked("NFT", Strings.toString(i)));
string memory nftSymbol = string(abi.encodePacked("AB", Strings.toString(i)));
nfts[i] = new MockNFT(nftName, nftSymbol);
abClaim.setDropData(dropIds[i], address(nfts[i]), false, 3);
}
uint256[][] memory u1TokenIdsParent = new uint256[][](scaleAmount);

for (uint256 i; i < nfts.length; i++) {
nfts[i].mint(u1, 3);

uint256[] memory tokenIds = new uint256[](3);

for (uint256 j; j < 3; j++) {
tokenIds[j] = j;
}
u1TokenIdsParent[i] = tokenIds;
}

bytes memory sigU1 = _generateValidSignature(kycSignerPkey, u1, 0);

vm.prank(u1);
abClaim.claim(dropIds, u1TokenIdsParent, sigU1);
assertEq(mockUSD.balanceOf(u1), amount * scaleAmount);
assertEq(abClaim.getClaimableAmount(dropIds, u1TokenIdsParent), 0);

}

function _generateValidSignature(uint256 _signerPkey, address _user, uint256 _nonce)
internal
pure
Expand Down

0 comments on commit 4ecba8b

Please sign in to comment.