Erc20InputFacetStorage

This library manages the storage and logic for handling the configuration of input packets for staking campaigns and facilitates their transfer.

_This implementation is designed for use in staking campaigns where the input packet is constructed solely from ERC20 tokens.

IMPORTANT:

• Extra care should be taken when specifying token amounts, especially when dealing with tokens of varying decimal precision (see setCampaignTransferInput() for more details).
• An input packet can encapsulate one (e.g., tokenA) or more (e.g., tokenA, tokenB, ..., tokenX) ERC20 tokens._

CampaignNotOnCreationStateForSetting

error CampaignNotOnCreationStateForSetting(uint256 campaignId)

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

NoInputPacketDataProvided

error NoInputPacketDataProvided(uint256 campaignId)

Thrown at setter when no data provided for either tokenAddresses or amountOfTokensPerPacket.

InvalidInputPacketDataLengths

error InvalidInputPacketDataLengths(uint256 campaignId, uint256 tokenAddressesLength, uint256 amountOfTokensPerPacketLength)

Thrown at setter when the lengths of tokenAddresses and amountOfTokensPerPacket do not match.

InvalidZeroInputPacketAddressData

error InvalidZeroInputPacketAddressData(uint256 campaignId, uint256 index)

Thrown at setter when an element of tokenAddresses is the zero address.

InvalidZeroInputPacketAmountData

error InvalidZeroInputPacketAmountData(uint256 campaignId, uint256 index)

Thrown at setter when an element of amountOfTokensPerPacket is zero.

STORAGE_SLOT

bytes32 STORAGE_SLOT

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

Layout

Struct for managing information related to campaigns' input packets.

struct Layout {
  mapping(uint256 => struct Erc20InputFacetStorage.InputPacket) campaignsPacketInfo;
}

InputPacket

Struct containing the configuration information for an input packet.

struct InputPacket {
  address[] tokenAddresses;
  mapping(address => uint256) amountOfTokensPerPacket;
}

layout

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

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

setCampaignTransferInput

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

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

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

This setter function configures the input packet for a campaign, where only ERC20 tokens should be included.

Requirements:

• The tokenAddresses and amountOfTokensPerPacket arrays must have the same length.
• tokenAddresses must contain valid, non-zero ERC20 token addresses.
• amountOfTokensPerPacket must contain non-zero values.

IMPORTANT:

• If all ERC20 tokens in tokenAddresses have the same decimal places, there are two configuration options.

  1. Parse the values in amountOfTokensPerPacket with the appropriate common number of decimal digits (using wei values). In this case, input packet amounts should be specified in whole units at the API level for stake(), restake(), partialUnstake(), and fullyUnstake() (see StakingSkeleton.sol).

  2. Specify values in amountOfTokensPerPacket in whole units, thus, input packet amounts should be parsed with the appropriate common number of decimal digits (using wei values) at the API level in stake(), restake(), partialUnstake(), and fullyUnstake() (see StakingSkeleton.sol).

• If any ERC20 token in tokenAddresses has a different decimal precision than others, only one option is valid:

  Parse the values in amountOfTokensPerPacket with each token's decimal precision (using wei values), thus, input packet amounts should be specified in whole units at the API level for stake(), restake(), partialUnstake(), and fullyUnstake() (see StakingSkeleton.sol). ----------------------------------------------------------------------------------------------------------------_

Parameters

transferInput

function transferInput(struct Erc20InputFacetStorage.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 transfers for all respective amounts of ERC20 tokens defined in the campaign's input packet (see setCampaignTransferInput()) in a single transaction.

The amounts to be transferred are calculated as amountOfTokensPerPacket[i] * amountOfPackets for each token in the input packet, where i is the index of the token in the tokenAddresses array. The transfer is performed using the safeTransferFrom method of the ERC20 token interface._

Parameters