DerivativeModule
Inherits: IDerivative, ERC6909, ERC6909Metadata, Module
The DerivativeModule contract is an abstract contract that provides derivative functionality for the AuctionHouse.
This contract is intended to be inherited by derivative modules that are used in the AuctionHouse.
State Variables
tokenMetadata
The metadata for a derivative token
mapping(uint256 tokenId => Token metadata) public tokenMetadata;
Functions
getTokenMetadata
Get the metadata for a derivative token
function getTokenMetadata(uint256 tokenId) external view virtual returns (Token memory);
Parameters
| Name | Type | Description |
|---|---|---|
tokenId | uint256 | The ID of the derivative token |
Returns
| Name | Type | Description |
|---|---|---|
<none> | Token | tokenData The metadata for the derivative token |
totalSupply
Returns the total supply of the token
function totalSupply(uint256 tokenId) public view virtual override returns (uint256);
Parameters
| Name | Type | Description |
|---|---|---|
tokenId | uint256 |
Returns
| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 The total supply of the token |