CommonValidationLibrary

Git Source

Title: CommonValidationLibrary

Author: Quantillon Labs - Nicolas Bellengé - @chewbaccoin

Common validation functions used across multiple contracts

Main characteristics:

Consolidates common validation patterns
Reduces code duplication across contracts
Uses custom errors for gas efficiency
Maintains same validation logic

Note: security-contact: team@quantillon.money

Constants

VERSION

Library version (semver); see deployments/{chainId}/versions.json for provenance.

string internal constant VERSION = "1.0.0"

Checks if the provided address is the zero address and reverts with appropriate error. Uses string comparison which is gas-intensive but maintains backward compatibility. For new code, prefer using validateNonZeroAddressWithType() with AddressType enum.

Notes:

security: Pure; no state change
validation: Reverts if addr is zero
state-changes: None
events: None
errors: InvalidAdmin, InvalidTreasury, InvalidToken, InvalidOracle, InvalidVault, InvalidAddress
reentrancy: No external calls
access: Internal library
oracle: None

function validateNonZeroAddress(address addr, string memory errorType) internal pure;

Parameters

Name	Type	Description
`addr`	`address`	The address to validate
`errorType`	`string`	The type of address being validated (admin, treasury, token, oracle, vault)

validatePositiveAmount

Validates that an amount is positive

Reverts with InvalidAmount if amount is zero

Notes:

security: Pure; no state change
validation: Reverts if amount is zero
state-changes: None
events: None
errors: InvalidAmount
reentrancy: No external calls
access: Internal library
oracle: None

function validatePositiveAmount(uint256 amount) internal pure;

Parameters

Name	Type	Description
`amount`	`uint256`	The amount to validate

validateMinAmount

Validates that an amount is above minimum threshold

Reverts with InsufficientBalance if amount is below minimum

Notes:

security: Pure; no state change
validation: Reverts if amount < minAmount
state-changes: None
events: None
errors: InsufficientBalance
reentrancy: No external calls
access: Internal library
oracle: None

function validateMinAmount(uint256 amount, uint256 minAmount) internal pure;

Parameters

Name	Type	Description
`amount`	`uint256`	The amount to validate
`minAmount`	`uint256`	The minimum required amount

validateMaxAmount

Validates that an amount is below maximum threshold

Reverts with AboveLimit if amount exceeds maximum

Notes:

security: Pure; no state change
validation: Reverts if amount > maxAmount
state-changes: None
events: None
errors: AboveLimit
reentrancy: No external calls
access: Internal library
oracle: None

function validateMaxAmount(uint256 amount, uint256 maxAmount) internal pure;

Parameters

Name	Type	Description
`amount`	`uint256`	The amount to validate
`maxAmount`	`uint256`	The maximum allowed amount

validatePercentage

Validates that a percentage is within valid range

Reverts with AboveLimit if percentage exceeds maximum

Notes:

security: Pure; no state change
validation: Reverts if percentage > maxPercentage
state-changes: None
events: None
errors: AboveLimit
reentrancy: No external calls
access: Internal library
oracle: None

function validatePercentage(uint256 percentage, uint256 maxPercentage) internal pure;

Parameters

Name	Type	Description
`percentage`	`uint256`	The percentage to validate (in basis points)
`maxPercentage`	`uint256`	The maximum allowed percentage (in basis points)

validateCondition

Validates that a boolean condition is true

Generic condition validator that throws specific errors based on error type

Notes:

security: Pure; no state change
validation: Reverts if condition is false
state-changes: None
events: None
errors: InvalidOracle, InsufficientCollateralization, NotAuthorized, InvalidCondition
reentrancy: No external calls
access: Internal library
oracle: None

function validateCondition(bool condition, string memory errorType) internal pure;

Parameters

Name	Type	Description
`condition`	`bool`	The condition to validate
`errorType`	`string`	The type of error to throw if condition is false

_keccak256Bytes

Internal keccak256 of string using inline assembly (gas-efficient)

function _keccak256Bytes(string memory s) private pure returns (bytes32);

validateCountLimit

Validates that a count is within limits

Reverts with TooManyPositions if count exceeds or equals maximum

Notes:

security: Pure; no state change
validation: Reverts if count >= maxCount
state-changes: None
events: None
errors: TooManyPositions
reentrancy: No external calls
access: Internal library
oracle: None

function validateCountLimit(uint256 count, uint256 maxCount) internal pure;

Parameters

Name	Type	Description
`count`	`uint256`	The current count
`maxCount`	`uint256`	The maximum allowed count

validateSufficientBalance

Validates that a balance is sufficient

Reverts with InsufficientBalance if balance is below required amount

Notes:

security: Pure; no state change
validation: Reverts if balance < requiredAmount
state-changes: None
events: None
errors: InsufficientBalance
reentrancy: No external calls
access: Internal library
oracle: None

function validateSufficientBalance(uint256 balance, uint256 requiredAmount) internal pure;

Parameters

Name	Type	Description
`balance`	`uint256`	The current balance
`requiredAmount`	`uint256`	The required amount

validateTreasuryAddress

Validates treasury address is not zero address

Reverts with ZeroAddress if treasury is zero address

Notes:

security: Pure; no state change
validation: Reverts if treasury is zero
state-changes: None
events: None
errors: ZeroAddress
reentrancy: No external calls
access: Internal library
oracle: None

function validateTreasuryAddress(address treasury) internal pure;

Parameters

Name	Type	Description
`treasury`	`address`	The treasury address to validate