Quantillon Protocol

IStQEUROFactory

Git Source

Functions

registerVault

Registers caller vault and deploys a dedicated stQEURO proxy.

Implementation enforces vault uniqueness and deterministic token deployment.

Notes:

  • security: Restricted by implementation access control.

  • validation: Implementations should validate vault id/name and uniqueness.

  • state-changes: Updates factory registry mappings and deploys token proxy.

  • events: Emits registration event in implementation.

  • errors: Reverts on invalid input or duplicate registration.

  • reentrancy: Implementation should use CEI-safe ordering for external deployment call.

  • access: Access controlled by implementation.

  • oracle: No oracle dependencies.

function registerVault(uint256 vaultId, string calldata vaultName) external returns (address stQEUROToken);

Parameters

NameTypeDescription
vaultIduint256Vault identifier to register.
vaultNamestringUppercase alphanumeric vault name.

Returns

NameTypeDescription
stQEUROTokenaddressRegistered stQEURO token address.

previewVaultToken

Previews deterministic stQEURO address for a vault registration tuple.

Read-only helper used before registration to bind expected token address.

Notes:

  • security: Read-only helper.

  • validation: Implementations should validate vault inputs and name format.

  • state-changes: No state changes.

  • events: No events emitted.

  • errors: Reverts on invalid preview inputs.

  • reentrancy: Not applicable for view function.

  • access: Public view.

  • oracle: No oracle dependencies.

function previewVaultToken(address vault, uint256 vaultId, string calldata vaultName)
    external
    view
    returns (address stQEUROToken);

Parameters

NameTypeDescription
vaultaddressVault address that will register.
vaultIduint256Vault identifier to register.
vaultNamestringUppercase alphanumeric vault name.

Returns

NameTypeDescription
stQEUROTokenaddressPredicted token address for registration tuple.

getStQEUROByVaultId

Returns registered stQEURO token by vault id.

Read-only registry lookup.

Notes:

  • security: Read-only accessor.

  • validation: No input validation required.

  • state-changes: No state changes.

  • events: No events emitted.

  • errors: No errors expected.

  • reentrancy: Not applicable for view function.

  • access: Public view.

  • oracle: No oracle dependencies.

function getStQEUROByVaultId(uint256 vaultId) external view returns (address stQEUROToken);

Parameters

NameTypeDescription
vaultIduint256Vault identifier.

Returns

NameTypeDescription
stQEUROTokenaddressRegistered token address (or zero if unset).

getVaultIdsByVault

Returns all vault ids registered by a given vault contract.

A single QuantillonVault can register multiple staking vault ids.

Notes:

  • security: Read-only registry accessor.

  • validation: No additional validation; unknown vaults return an empty array.

  • state-changes: No state changes.

  • events: No events emitted.

  • errors: No errors expected.

  • reentrancy: Not applicable for view function.

  • access: Public view.

  • oracle: No oracle dependencies.

function getVaultIdsByVault(address vault) external view returns (uint256[] memory vaultIds);

Parameters

NameTypeDescription
vaultaddressVault contract address.

Returns

NameTypeDescription
vaultIdsuint256[]Array of registered vault ids for that vault contract.

getVaultById

Returns vault address mapped to a vault id.

Read-only registry lookup.

Notes:

  • security: Read-only accessor.

  • validation: No input validation required.

  • state-changes: No state changes.

  • events: No events emitted.

  • errors: No errors expected.

  • reentrancy: Not applicable for view function.

  • access: Public view.

  • oracle: No oracle dependencies.

function getVaultById(uint256 vaultId) external view returns (address vault);

Parameters

NameTypeDescription
vaultIduint256Vault identifier.

Returns

NameTypeDescription
vaultaddressVault address (or zero if unset).

getVaultIdByStQEURO

Returns vault id mapped to an stQEURO token address.

Read-only reverse-registry lookup.

Notes:

  • security: Read-only accessor.

  • validation: No input validation required.

  • state-changes: No state changes.

  • events: No events emitted.

  • errors: No errors expected.

  • reentrancy: Not applicable for view function.

  • access: Public view.

  • oracle: No oracle dependencies.

function getVaultIdByStQEURO(address stQEUROToken) external view returns (uint256 vaultId);

Parameters

NameTypeDescription
stQEUROTokenaddressRegistered token address.

Returns

NameTypeDescription
vaultIduint256Vault identifier (or zero if unset).

getVaultName

Returns canonical vault name string for a vault id.

Read-only registry lookup.

Notes:

  • security: Read-only accessor.

  • validation: No input validation required.

  • state-changes: No state changes.

  • events: No events emitted.

  • errors: No errors expected.

  • reentrancy: Not applicable for view function.

  • access: Public view.

  • oracle: No oracle dependencies.

function getVaultName(uint256 vaultId) external view returns (string memory vaultName);

Parameters

NameTypeDescription
vaultIduint256Vault identifier.

Returns

NameTypeDescription
vaultNamestringRegistered vault name string.