Fraction ProtocolsubSkeletonFacets

ReceiveNonPurchasedWrappedAssetsSubSkeleton

Implementation of the ReceiveNonPurchasedWrappedAssets sub-skeleton facet for the TMI-Fraction Protocol.

_This facet serves as a sub-core component (sub-skeleton) of a TMI-Fraction Platform, enabling eligible users (e.g., campaign issuers) to claim and receive any unpurchased wrapped assets from campaigns after their purchase period has successfully ended (e.g., the campaign reached or surpassed its softcap but did not reach its hardcap).


IMPORTANT:

  • This implementation is intended only for Platforms that issue campaigns with either fungible (e.g., ERC20) or semi-fungible (e.g., ERC1155) wrapped (underlying) assets.

The process of receiving unpurchased wrapped assets from a campaign is triggered when receiveNonPurchasedWrappedAssets() is called, following a sequential pipeline with three phases:

  • State Check: The Platform interacts with its ReceiveNonPurchasedWrappedAssetsState sub-internal facet to verify that the current state of the targeted campaign allows the action (e.g., only permissible in post-FUNDED states indicating that the purchase period has ended successfully).

  • Eligibility Check: The Platform interacts with its ReceiveNonPurchasedWrappedAssetsEligibility sub-internal facet to verify that the user (caller) meets the campaign's eligibility criteria (e.g., campaign issuer only).

  • Receive Action: The Platform interacts with its DoReceiveNonPurchasedWrappedAssets sub-internal facet to burn any remaining fractions of the campaign from the Platform (not owned by investors), unwrap the corresponding amount(s) of asset(s) held in the campaign's Vault, and transfer them to the user._

NonPurchasedWrappedAssetsReceived

event NonPurchasedWrappedAssetsReceived(uint256 campaignId, address receiver, address[] tokens, uint256[] ids, uint256[] values)

Emitted at receiveNonPurchasedWrappedAssets().

receiveNonPurchasedWrappedAssets

function receiveNonPurchasedWrappedAssets(uint256 campaignId) external

Burns all unpurchased fractions (those not owned by investors) from the specified campaign, unwraps the corresponding amount(s) of underlying asset(s) held in the campaign's Vault, and transfers them to the caller (user).

_Users must meet eligibility criteria (see receiveNonPurchasedWrappedAssets Eligibility sub-internal facets).

This action should only be allowed after the campaign's purchase period has successfully ended.

Emits a {NonPurchasedWrappedAssetsReceived} event._

Parameters

NameTypeDescription
campaignIduint256The unique identifier of the targeted campaign.

On this page