Skip to content

Commit

Permalink
Update Mock IPGraph to support Royalty LRP Policy (storyprotocol#239)
Browse files Browse the repository at this point in the history
  • Loading branch information
@kingster-will
kingster-will authored Sep 10, 2024
1 parent 6a1557c commit 68f87a7
Showing 1 changed file with 132 additions and 5 deletions.
137 changes: 132 additions & 5 deletions test/foundry/mocks/MockIPGraph.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,20 @@ import { DoubleEndedQueue } from "@openzeppelin/contracts/utils/structs/DoubleEn
contract MockIPGraph {
using EnumerableSet for EnumerableSet.AddressSet;
using DoubleEndedQueue for DoubleEndedQueue.Bytes32Deque;

uint256 public constant POLICY_KIND_LAP = 0;
uint256 public constant POLICY_KIND_LRP = 1;
uint32 public constant HUNDRED_PERCENT = 100000000; // 100 * 10 ** 6

mapping(address childIpId => EnumerableSet.AddressSet parentIpIds) parentIps;
mapping(address ipId => mapping(address parentIpId => uint256)) royalties;
mapping(address parentIpId => address childIpId) childMap;
mapping(address ipId => mapping(address parentIpId => uint256 percent)) royaltiesLap;
mapping(address ipId => mapping(address parentIpId => uint256 percent)) royaltiesLrp;
mapping(address ipId => mapping(address parentIdId => mapping(uint256 policyKind => uint256 percent))) royalties;
mapping(address ipId => mapping(uint256 policyKind => uint256)) royaltyStacks;
EnumerableSet.AddressSet ancestorIps;
DoubleEndedQueue.Bytes32Deque queue;
DoubleEndedQueue.Bytes32Deque lrpQueue;

function addParentIp(address ipId, address[] calldata parentIpIds) external {
for (uint256 i = 0; i < parentIpIds.length; i++) {
Expand Down Expand Up @@ -66,10 +76,103 @@ contract MockIPGraph {
) external view returns (address[] memory) {
return new address[](0);
}

function setRoyalty(address ipId, address parentIpId, uint256 royaltyPercentage) external {
royalties[ipId][parentIpId] = royaltyPercentage;
_setRoyalty(ipId, parentIpId, POLICY_KIND_LAP, royaltyPercentage);
}

function setRoyalty(address ipId, address parentIpId, uint256 policyKind, uint256 royaltyPercentage) external {
_setRoyalty(ipId, parentIpId, policyKind, royaltyPercentage);
}

function calculateRoyalty(
address ipId,
address ancestorIpId,
uint256 policyKind
) external returns (uint256 result) {
result = _getRoyalty(ipId, ancestorIpId, policyKind);
royalties[ipId][ancestorIpId][policyKind] = result;
}

function getRoyalty(address ipId, address ancestorIpId) external returns (uint256) {
return _getRoyalty(ipId, ancestorIpId, POLICY_KIND_LAP);
}

function getRoyalty(address ipId, address ancestorIpId, uint256 policyKind) external view returns (uint256) {
return royalties[ipId][ancestorIpId][policyKind];
}

function updateRoyaltyStack(address ipId, uint256 policyKind) external returns (uint256 result) {
result = _getRoyaltyStack(ipId, policyKind);
royaltyStacks[ipId][policyKind] = result;
}

function getRoyaltyStack(address ipId) external returns (uint256) {
return _getRoyaltyStack(ipId, POLICY_KIND_LAP);
}

function getRoyaltyStack(address ipId, uint256 policyKind) external view returns (uint256) {
return royaltyStacks[ipId][policyKind];
}

function _setRoyalty(address ipId, address parentIpId, uint256 policyKind, uint256 royaltyPercentage) internal {
if (policyKind == POLICY_KIND_LAP) royaltiesLap[ipId][parentIpId] = royaltyPercentage;
if (policyKind == POLICY_KIND_LRP) royaltiesLrp[ipId][parentIpId] = royaltyPercentage;
}

function _getRoyalty(address ipId, address ancestorIpId, uint256 policyKind) internal returns (uint256) {
uint256 totalRoyalty = 0;
if (policyKind == POLICY_KIND_LAP) {
totalRoyalty = _getRoyaltyLap(ipId, ancestorIpId);
}
if (policyKind == POLICY_KIND_LRP) {
totalRoyalty = _getRoyaltyLrp(ipId, ancestorIpId);
}

return totalRoyalty;
}

// solhint-disable-next-line code-complexity
function _getRoyaltyLrp(address ipId, address ancestorIpId) internal returns (uint256 result) {
result = 0;
_cleanAncestorIps();
queue.pushFront(_toBytes32(ipId));
while (queue.length() > 0) {
address currentIpId = _toAddress(queue.popFront());
if (currentIpId == ancestorIpId) {
break;
}
if (parentIps[currentIpId].length() == 0) {
continue;
}
for (uint256 i = 0; i < parentIps[currentIpId].length(); i++) {
address parentIpId = parentIps[currentIpId].at(i);
childMap[parentIpId] = currentIpId;
if (!ancestorIps.contains(parentIpId)) {
ancestorIps.add(parentIpId);
queue.pushFront(_toBytes32(parentIpId));
}
}
}
address currentIpId = ancestorIpId;
while (currentIpId != ipId) {
lrpQueue.pushFront(_toBytes32(currentIpId));
address childIpId = childMap[currentIpId];
currentIpId = childIpId;
}
currentIpId = ipId;
if (lrpQueue.length() > 0) {
address parentIpId = _toAddress(lrpQueue.popFront());
result = royaltiesLrp[currentIpId][parentIpId];
currentIpId = parentIpId;
while (lrpQueue.length() > 0) {
parentIpId = _toAddress(lrpQueue.popFront());
result = (result * royaltiesLrp[currentIpId][parentIpId]) / HUNDRED_PERCENT;
}
}
}

function _getRoyaltyLap(address ipId, address ancestorIpId) internal returns (uint256) {
uint256 totalRoyalty = 0;
_cleanAncestorIps();
queue.pushFront(_toBytes32(ipId));
Expand All @@ -82,13 +185,34 @@ contract MockIPGraph {
queue.pushFront(_toBytes32(parentIpId));
}
if (parentIpId == ancestorIpId) {
totalRoyalty += royalties[currentIpId][ancestorIpId];
totalRoyalty += royaltiesLap[currentIpId][ancestorIpId];
}
}
}
return totalRoyalty;
}
function getRoyaltyStack(address ipId) external returns (uint256) {

function _getRoyaltyStack(address ipId, uint256 policyKind) internal returns (uint256) {
uint256 royaltyStack = 0;
if (policyKind == POLICY_KIND_LAP) {
royaltyStack = _getRoyaltyStackLap(ipId);
}
if (policyKind == POLICY_KIND_LRP) {
royaltyStack = _getRoyaltyStackLrp(ipId);
}
return royaltyStack;
}

function _getRoyaltyStackLrp(address ipId) internal returns (uint256) {
uint256 royaltyStack = 0;
for (uint256 i = 0; i < parentIps[ipId].length(); i++) {
address parentIpId = parentIps[ipId].at(i);
royaltyStack += royaltiesLrp[ipId][parentIpId];
}
return royaltyStack;
}

function _getRoyaltyStackLap(address ipId) internal returns (uint256) {
uint256 royaltyStack = 0;
_cleanAncestorIps();
queue.pushFront(_toBytes32(ipId));
Expand All @@ -100,16 +224,19 @@ contract MockIPGraph {
ancestorIps.add(parentIpId);
queue.pushFront(_toBytes32(parentIpId));
}
royaltyStack += royalties[currentIpId][parentIpId];
royaltyStack += royaltiesLap[currentIpId][parentIpId];
}
}
return royaltyStack;
}

function _cleanAncestorIps() internal {
uint256 length = ancestorIps.length();
for (uint256 i = 0; i < length; i++) {
ancestorIps.remove(ancestorIps.at(0));
}
lrpQueue.clear();
queue.clear();
}
function _toBytes32(address value) internal pure returns (bytes32) {
return bytes32(uint256(uint160(value)));
Expand Down

0 comments on commit 68f87a7

Please sign in to comment.