forked from DecentralizedClimateFoundation/DCIPs
195 lines
7.6 KiB
Solidity
195 lines
7.6 KiB
Solidity
// SPDX-License-Identifier: CC0-1.0
|
|
|
|
pragma solidity ^0.8.16;
|
|
|
|
import "./IERC5773.sol";
|
|
|
|
/**
|
|
* @title IERC6220
|
|
* @author RMRK team
|
|
* @notice Interface smart contract of the equippable module.
|
|
*/
|
|
interface IERC6220 is IERC5773 {
|
|
/**
|
|
* @notice Used to store the core structure of the `Equippable` component.
|
|
* @return assetId The ID of the asset equipping a child
|
|
* @return childAssetId The ID of the asset used as equipment
|
|
* @return childId The ID of token that is equipped
|
|
* @return childEquippableAddress Address of the collection to which the child asset belongs to
|
|
*/
|
|
struct Equipment {
|
|
uint64 assetId;
|
|
uint64 childAssetId;
|
|
uint256 childId;
|
|
address childEquippableAddress;
|
|
}
|
|
|
|
/**
|
|
* @notice Used to provide a struct for inputing equip data.
|
|
* @dev Only used for input and not storage of data.
|
|
* @return tokenId ID of the token we are managing
|
|
* @return childIndex Index of a child in the list of token's active children
|
|
* @return assetId ID of the asset that we are equipping into
|
|
* @return slotPartId ID of the slot part that we are using to equip
|
|
* @return childAssetId ID of the asset that we are equipping
|
|
*/
|
|
struct IntakeEquip {
|
|
uint256 tokenId;
|
|
uint256 childIndex;
|
|
uint64 assetId;
|
|
uint64 slotPartId;
|
|
uint64 childAssetId;
|
|
}
|
|
|
|
/**
|
|
* @notice Used to notify listeners that a child's asset has been equipped into one of its parent assets.
|
|
* @param tokenId ID of the token that had an asset equipped
|
|
* @param assetId ID of the asset associated with the token we are equipping into
|
|
* @param slotPartId ID of the slot we are using to equip
|
|
* @param childId ID of the child token we are equipping into the slot
|
|
* @param childAddress Address of the child token's collection
|
|
* @param childAssetId ID of the asset associated with the token we are equipping
|
|
*/
|
|
event ChildAssetEquipped(
|
|
uint256 indexed tokenId,
|
|
uint64 indexed assetId,
|
|
uint64 indexed slotPartId,
|
|
uint256 childId,
|
|
address childAddress,
|
|
uint64 childAssetId
|
|
);
|
|
|
|
/**
|
|
* @notice Used to notify listeners that a child's asset has been unequipped from one of its parent assets.
|
|
* @param tokenId ID of the token that had an asset unequipped
|
|
* @param assetId ID of the asset associated with the token we are unequipping out of
|
|
* @param slotPartId ID of the slot we are unequipping from
|
|
* @param childId ID of the token being unequipped
|
|
* @param childAddress Address of the collection that a token that is being unequipped belongs to
|
|
* @param childAssetId ID of the asset associated with the token we are unequipping
|
|
*/
|
|
event ChildAssetUnequipped(
|
|
uint256 indexed tokenId,
|
|
uint64 indexed assetId,
|
|
uint64 indexed slotPartId,
|
|
uint256 childId,
|
|
address childAddress,
|
|
uint64 childAssetId
|
|
);
|
|
|
|
/**
|
|
* @notice Used to notify listeners that the assets belonging to a `equippableGroupId` have been marked as
|
|
* equippable into a given slot and parent
|
|
* @param equippableGroupId ID of the equippable group being marked as equippable into the slot associated with
|
|
* `slotPartId` of the `parentAddress` collection
|
|
* @param slotPartId ID of the slot part of the catalog into which the parts belonging to the equippable group
|
|
* associated with `equippableGroupId` can be equipped
|
|
* @param parentAddress Address of the collection into which the parts belonging to `equippableGroupId` can be
|
|
* equipped
|
|
*/
|
|
event ValidParentEquippableGroupIdSet(
|
|
uint64 indexed equippableGroupId,
|
|
uint64 indexed slotPartId,
|
|
address parentAddress
|
|
);
|
|
|
|
/**
|
|
* @notice Used to equip a child into a token.
|
|
* @dev The `IntakeEquip` stuct contains the following data:
|
|
* [
|
|
* tokenId,
|
|
* childIndex,
|
|
* assetId,
|
|
* slotPartId,
|
|
* childAssetId
|
|
* ]
|
|
* @param data An `IntakeEquip` struct specifying the equip data
|
|
*/
|
|
function equip(
|
|
IntakeEquip memory data
|
|
) external;
|
|
|
|
/**
|
|
* @notice Used to unequip child from parent token.
|
|
* @dev This can only be called by the owner of the token or by an account that has been granted permission to
|
|
* manage the given token by the current owner.
|
|
* @param tokenId ID of the parent from which the child is being unequipped
|
|
* @param assetId ID of the parent's asset that contains the `Slot` into which the child is equipped
|
|
* @param slotPartId ID of the `Slot` from which to unequip the child
|
|
*/
|
|
function unequip(
|
|
uint256 tokenId,
|
|
uint64 assetId,
|
|
uint64 slotPartId
|
|
) external;
|
|
|
|
/**
|
|
* @notice Used to check whether the token has a given child equipped.
|
|
* @dev This is used to prevent from transferring a child that is equipped.
|
|
* @param tokenId ID of the parent token for which we are querying for
|
|
* @param childAddress Address of the child token's smart contract
|
|
* @param childId ID of the child token
|
|
* @return bool The boolean value indicating whether the child token is equipped into the given token or not
|
|
*/
|
|
function isChildEquipped(
|
|
uint256 tokenId,
|
|
address childAddress,
|
|
uint256 childId
|
|
) external view returns (bool);
|
|
|
|
/**
|
|
* @notice Used to verify whether a token can be equipped into a given parent's slot.
|
|
* @param parent Address of the parent token's smart contract
|
|
* @param tokenId ID of the token we want to equip
|
|
* @param assetId ID of the asset associated with the token we want to equip
|
|
* @param slotId ID of the slot that we want to equip the token into
|
|
* @return bool The boolean indicating whether the token with the given asset can be equipped into the desired
|
|
* slot
|
|
*/
|
|
function canTokenBeEquippedWithAssetIntoSlot(
|
|
address parent,
|
|
uint256 tokenId,
|
|
uint64 assetId,
|
|
uint64 slotId
|
|
) external view returns (bool);
|
|
|
|
/**
|
|
* @notice Used to get the Equipment object equipped into the specified slot of the desired token.
|
|
* @dev The `Equipment` struct consists of the following data:
|
|
* [
|
|
* assetId,
|
|
* childAssetId,
|
|
* childId,
|
|
* childEquippableAddress
|
|
* ]
|
|
* @param tokenId ID of the token for which we are retrieving the equipped object
|
|
* @param targetCatalogAddress Address of the `Catalog` associated with the `Slot` part of the token
|
|
* @param slotPartId ID of the `Slot` part that we are checking for equipped objects
|
|
* @return struct The `Equipment` struct containing data about the equipped object
|
|
*/
|
|
function getEquipment(
|
|
uint256 tokenId,
|
|
address targetCatalogAddress,
|
|
uint64 slotPartId
|
|
) external view returns (Equipment memory);
|
|
|
|
/**
|
|
* @notice Used to get the asset and equippable data associated with given `assetId`.
|
|
* @param tokenId ID of the token for which to retrieve the asset
|
|
* @param assetId ID of the asset of which we are retrieving
|
|
* @return metadataURI The metadata URI of the asset
|
|
* @return equippableGroupId ID of the equippable group this asset belongs to
|
|
* @return catalogAddress The address of the catalog the part belongs to
|
|
* @return partIds An array of IDs of parts included in the asset
|
|
*/
|
|
function getAssetAndEquippableData(uint256 tokenId, uint64 assetId)
|
|
external
|
|
view
|
|
returns (
|
|
string memory metadataURI,
|
|
uint64 equippableGroupId,
|
|
address catalogAddress,
|
|
uint64[] calldata partIds
|
|
);
|
|
}
|