IPlatformFee
Thirdweb's PlatformFee is a contract extension to be used with any base contract. It exposes functions for setting and reading the recipient of platform fee and the platform fee basis points, and lets the inheriting contract perform conditional logic that uses information about platform fees, if desired.
Methods
getPlatformFeeInfo
function getPlatformFeeInfo() external view returns (address, uint16)
Returns the platform fee bps and recipient.
Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| _1 | uint16 | undefined |
setPlatformFeeInfo
function setPlatformFeeInfo(address _platformFeeRecipient, uint256 _platformFeeBps) external nonpayable
Lets a module admin update the fees on primary sales.
Parameters
| Name | Type | Description |
|---|---|---|
| _platformFeeRecipient | address | undefined |
| _platformFeeBps | uint256 | undefined |
Events
PlatformFeeInfoUpdated
event PlatformFeeInfoUpdated(address indexed platformFeeRecipient, uint256 platformFeeBps)
Emitted when fee on primary sales is updated.
Parameters
| Name | Type | Description |
|---|---|---|
platformFeeRecipient indexed | address | undefined |
| platformFeeBps | uint256 | undefined |
Errors
PlatformFee__ExceedsMaxBps
error PlatformFee__ExceedsMaxBps(uint256 platformFeeBps)
Emitted when given platform-fee bps exceeds max bps.
Parameters
| Name | Type | Description |
|---|---|---|
| platformFeeBps | uint256 | undefined |
PlatformFee__NotAuthorized
error PlatformFee__NotAuthorized()
Emitted when an unauthorized caller tries to set platform fee details.