Vault

​

Overview

• ACLModule: Role-based access control.
• ShareModule: Management of user-facing shares, including deposit and redemption processes.
• VaultModule: Subvault management.

​

Inheritance Structure

contract Vault is IFactoryEntity, VaultModule, ShareModule, ACLModule

• ACLModule: Admin and permission management
• ShareModule: Deposits, redemptions, share management
• VaultModule: Subvault delegation control

​

Constructor

constructor(
    string memory name_,
    uint256 version_,
    address depositQueueFactory_,
    address redeemQueueFactory_,
    address subvaultFactory_,
    address verifierFactory_
)

​

Parameters:

• name_: Unique name identifier for the vault instance
• version_: Configuration version of the vault
• depositQueueFactory_: Address of the factory used to deploy deposit queues
• redeemQueueFactory_: Address of the factory used to deploy redemption queues
• subvaultFactory_: Address of the factory used to deploy subvaults
• verifierFactory_: Address of the factory for deploying verifier contracts

​

Behavior:

• ACLModule(name_, version_)
• ShareModule(name_, version_, depositQueueFactory_, redeemQueueFactory_)
• VaultModule(name_, version_, subvaultFactory_, verifierFactory_)

​

Structs

​

RoleHolder

struct RoleHolder {
    bytes32 role;
    address holder;
}

​

External Functions

​

initialize

function initialize(bytes calldata initParams) external initializer

​

initParams structure (ABI-encoded):

(
    address admin_,
    address shareManager_,
    address feeManager_,
    address riskManager_,
    address oracle_,
    address defaultDepositHook_,
    address defaultRedeemHook_,
    uint256 queueLimit_,
    RoleHolder[] roleHolders
)

​

Initialization Logic:

• Calls __ACLModule_init(admin_) to configure the default admin.
• Calls __ShareModule_init(...) to link share management and hook modules.
• Calls __VaultModule_init(riskManager_) to initialize risk management.
• Iterates over roleHolders and grants each role using _grantRole(...).
• Emits Initialized(initParams).

​

Design Notes

• Modular Composition: The vault is composed by inheriting three upgradeable modules, enabling reuse and flexible configuration.
• Factory-Compatible: The contract is factory-deployable and supports atomic configuration during creation.
• Centralized Control Layer: Acts as a trusted coordinator for hooks, queues, shares, and strategy logic.
• Role Assignment: Enables full delegation of operational control via batched RoleHolder entries.
• Upgradeable and Isolated: Each module manages its own storage via deterministic slots (SlotLibrary) to support safe upgrades.

​

Events

​

Initialized(bytes data)