This directory contains Superform's "Form" smart contracts. These form contracts serve as fundamental components of the Superform DeFi infrastructure, acting as intermediaries for deposit and withdrawal actions to and from vaults. Each resulting Superform, created when vaults are added to Forms, is uniquely associated with a single underlying Vault.
All Form contracts adhere to the IBaseForm standard interface and implement abstract functions defined in BaseForm for both same-chain and cross-chain operations. Apart from the standard ERC4626 Form, numerous other "custom" Form types can be created. These are extended from BaseForm and used when Superform needs to handle specific scenarios not covered by an existing Form.
Interaction with Superforms happens through the four implemented external functions in BaseForm. They are split by direct chain (accessible by SuperformRouter only) or cross chain access (accessible by CoreStateRegistry only).
ERC4626FormImplementation.sol: Abstract implementation of a Form contract with functions that are commonly used across forms. All functions can be overriden in specific Form implementations.
ERC4626Form.sol: The standard implementation of a Form contract. This Form interacts with a corresponding ERC4626 compliant vault.
ERC4626KYCDAOForm.sol: The standard implementation of a Form contract integrated with KYCDao's whitelist NFT. This Form interacts with a corresponding ERC4626 compliant vault.
ERC4626TimelockForm.sol: A variant of the standard Form contract that includes timelock functionality. This Form contract is used when time-based conditions need to be met during the deposit or withdrawal process. This Form requires a TimelockRegistry to execute redemption at a later time through the processUnlock() function.