Erc20InputFacet

This facet handles the configuration of input packets for staking campaigns and facilitates the transfer of these input packets.

_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._

CampaignInputConfigured

event CampaignInputConfigured(uint256 campaignId, address[] tokenAddresses, uint256[] amountOfTokensPerPacket)

Emitted at setCampaignTransferInput().

CampaignInputPacketsTransferred

event CampaignInputPacketsTransferred(uint256 campaignId, address from, address to, uint256 amountOfPackets)

Emitted at transferInput().

setCampaignTransferInput

function setCampaignTransferInput(uint256 campaignId, bytes campaignTransferInputData) external

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.

Emits a {CampaignInputConfigured} event.

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). This is the recommended configuration option.

  2. Specify values in amountOfTokensPerPacket in whole units, thus, input packet amounts should be parsed with the appropriate number of decimal digits 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(uint256 campaignId, address from, address to, uint256 amountOfPackets) external

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.

Emits a {CampaignInputPacketsTransferred} event._

Parameters