TransferInputMixerStorage

This library implementation ensembles Transfer Input Explicit Facets enabling the configuration of campaings' input packets that can encapsulate diverse asset types (e.g., ERC20, ERC1155 etc.), and facilitate the transfer of these input packets.

AlreadyInitialized

error AlreadyInitialized()

Thrown when attempting to re-initialize.

InvalidInputMixerInitDataLengths

error InvalidInputMixerInitDataLengths(uint256 selectorsLength, uint256 supportedAssetTypeCodesLength)

Thrown at initializer when the lengths of selectors and inputAssetTypeCodes do not match.

CampaignNotOnCreationStateForSetting

error CampaignNotOnCreationStateForSetting(uint256 campaignId)

Thrown when a targeted campaign is not "On Creation" state, which is required at configurations.

InvalidInputMixerSetterDataLengths

error InvalidInputMixerSetterDataLengths(uint256 campaignInputDataLength, uint256 inputAssetTypeCodesLength)

Thrown at setter when the lengths of campaignInputData and inputAssetTypeCodes arrays do not match.

UnsupportedInputAssetType

error UnsupportedInputAssetType(uint256 unsupportedAssetTypeCode)

Thrown at setter when an unsupported asset type code is specified as input for a campaign.

STORAGE_SLOT

bytes32 STORAGE_SLOT

Unique identifier for the storage slot where the Layout struct is stored.

FunctionSelectors

Struct containing selectors of setter & transfer functions implemented in a TransferInput Explicit Facet.

struct FunctionSelectors {
  bytes4 setterSelector;
  bytes4 transferSelector;
}

CampaignInputAssetInfo

Struct containing the local codes for the asset types supported within input packets of a staking campaign.

struct CampaignInputAssetInfo {
  uint256[] activeInputAssetTypeCodes;
}

Layout

Struct for managing information related to the Transfer Input Mixer and campaigns configuration.

struct Layout {
  bool isInitialized;
  mapping(uint256 => bool) isInputAssetTypeSupported;
  mapping(uint256 => bytes4) setterSelectorForAssetType;
  mapping(uint256 => bytes4) transferSelectorForAssetType;
  mapping(uint256 => struct TransferInputMixerStorage.CampaignInputAssetInfo) inputTypesForCampaign;
}

layout

function layout() internal pure returns (struct TransferInputMixerStorage.Layout l)

Retrieves a reference to the Layout struct stored at the slot specified by STORAGE_SLOT unique identifier.

initTransferInput

function initTransferInput(struct TransferInputMixerStorage.Layout l, bytes initTransferInputData) internal returns (uint256[])

Initializes the TransferInputMixerStorage by registering the selectors for the setter and transferInput functions of the supported TransferInput Explicit facets, along with code schema for representing the ERC types handled by these Explicit facets.

_The selectors provided must belong to the TransferInput Explicit facets that will be used for constructing input packets of campaigns and for transferring assets encapsulated within a campaing's input packet.

Requirements:

• The selectors and inputAssetTypeCodes arrays must have the same length.

IMPORTANT:

• The code schema for supported ERCs in campaigns' input packets helps identify the asset type that each registered Transfer Input Explicit facet handles. While the construction of this shcema is at the discreation of the Admin, it is advised to use the numerical suffix of the ERC standards of the ERCs (e.g., 20 for ERC20, 1155 for ERC1155 etc.) as codes for clarity and consistency.

• The i-th member of the inputAssetTypeCodes array should correspond to the i-th member of the selectors array. ----------------------------------------------------------------------------------------------------------------_

Parameters

setCampaignTransferInput

function setCampaignTransferInput(struct TransferInputMixerStorage.Layout l, uint256 campaignId, bytes campaignTransferInputData) internal returns (uint256[])

Setter function for configuring the input packet for the specified staking campaign.

_This setter function configures the input packet for a campaign, where any of the supported asset types can be included. For instance, if ERC20 and ERC1155 Transfer Input Explicit facets are supported, a packet could be configured as follows:

{ 100 TokenA (ERC20), 20.5 tokenB (ERC20), 10 tokenC ID 2 (ERC1155), 5 tokenD ID 1 (ERC1155) }

The construction of the input packet is at the discreation of the campaign creator, as any possible combination of the supported Transfer Input Explicit facets can be employed. These explicit facets must be already registered via initTransferInput().

Setter functions are executed during the creation process of campaigns (see CampaignCreationSkeleton.sol).

Requirements:

• The campaignInputData and inputAssetTypeCodes arrays must have the same length.

IMPORTANT:

• The asset type codes specified in inputAssetTypeCodes should be valid, meaning that they should already be registered in the TransferInput Mixer storage (see initTransferInput()).

• The i-th member of the inputAssetTypeCodes array should correspond to the i-th member of the campaignInputData array. ----------------------------------------------------------------------------------------------------------------_

Parameters

transferInput

function transferInput(struct TransferInputMixerStorage.Layout l, uint256 campaignId, address from, address to, uint256 amountOfPackets) internal

Transfers the specified amount of a given campaign's input packets from the from address to the to address.

This function iteratively executes the respective transferInput functions of all Input Explicit facets associated with the input packet.

Parameters