FactoryBase

Git Source

Inherits: IFactoryBase, AccessManaged

Base contract for all diamond factories with dynamic facet composition

Provides common functionality for deploying diamonds with configurable facets

State Variables

facetRegistry

FacetRegistry public immutable facetRegistry;

Functions

constructor

constructor(address _facetRegistry, address _globalAccessManager) AccessManaged(_globalAccessManager);

deployWithTemplate

Deploy a diamond using a predefined template

function deployWithTemplate(string memory templateName, bytes memory constructorArgs, bytes32 salt)
    public
    returns (address diamond);

Parameters

Name	Type	Description
templateName	string	Name of the template to use
constructorArgs	bytes	ABI-encoded constructor arguments
salt	bytes32	Salt for CREATE2 deployment (optional, uses default if empty)

Returns

Name	Type	Description
diamond	address	Address of the deployed diamond

deployWithCustomFacets

Deploy a diamond with custom facet selection

function deployWithCustomFacets(string[] memory facetNames, bytes memory constructorArgs, bytes32 salt)
    public
    returns (address diamond);

Parameters

Name	Type	Description
facetNames	string[]	Array of facet names to include
constructorArgs	bytes	ABI-encoded constructor arguments
salt	bytes32	Salt for CREATE2 deployment (optional, uses default if empty)

Returns

Name	Type	Description
diamond	address	Address of the deployed diamond

deployWithConfig

Deploy a diamond with advanced configuration

function deployWithConfig(IFacetRegistry.DeploymentConfig memory config, bytes memory constructorArgs, bytes32 salt)
    public
    returns (address diamond);

Parameters

Name	Type	Description
config	IFacetRegistry.DeploymentConfig	Deployment configuration with template and customizations
constructorArgs	bytes	ABI-encoded constructor arguments
salt	bytes32	Salt for CREATE2 deployment (optional, uses default if empty)

Returns

Name	Type	Description
diamond	address	Address of the deployed diamond

registerTemplate

Register a new template (restricted to admins)

function registerTemplate(
    string memory name,
    string memory description,
    string[] memory requiredFacets,
    string[] memory optionalFacets,
    bytes memory initializationData
) external restricted;

Parameters

Name	Type	Description
name	string	Template name
description	string	Template description
requiredFacets	string[]	Required facet names
optionalFacets	string[]	Optional facet names
initializationData	bytes	Default initialization data

updateTemplate

Update an existing template (restricted to admins)

function updateTemplate(
    string memory name,
    string memory description,
    string[] memory requiredFacets,
    string[] memory optionalFacets,
    bytes memory initializationData
) external restricted;

Parameters

Name	Type	Description
name	string	Template name to update
description	string	New description
requiredFacets	string[]	New required facets
optionalFacets	string[]	New optional facets
initializationData	bytes	New initialization data

deactivateTemplate

Deactivate a template (restricted to admins)

function deactivateTemplate(string memory name) external restricted;

Parameters

Name	Type	Description
name	string	Template name to deactivate

getAvailableTemplates

Get available templates

function getAvailableTemplates() external view returns (string[] memory templateNames);

Returns

Name	Type	Description
templateNames	string[]	Array of all template names

getTemplate

Get template information

function getTemplate(string memory name) external view returns (IFacetRegistry.FacetTemplate memory template);

Parameters

Name	Type	Description
name	string	Template name

Returns

Name	Type	Description
template	IFacetRegistry.FacetTemplate	Complete template information

getFacetsByCategory

Get available facets by category

function getFacetsByCategory(string memory category) external view returns (string[] memory facetNames);

Parameters

Name	Type	Description
category	string	Facet category

Returns

Name	Type	Description
facetNames	string[]	Array of facet names in the category

getAllAvailableFacets

Get all available facets

function getAllAvailableFacets() external view returns (string[] memory facetNames);

Returns

Name	Type	Description
facetNames	string[]	Array of all facet names

getAllCategories

Get all categories

function getAllCategories() external view returns (string[] memory categories);

Returns

Name	Type	Description
categories	string[]	Array of all category names

previewTemplateFacets

Preview facet cuts for a template

function previewTemplateFacets(string memory templateName) external view returns (IDiamond.FacetCut[] memory cuts);

Parameters

Name	Type	Description
templateName	string	Template name

Returns

Name	Type	Description
cuts	IDiamond.FacetCut[]	Array of facet cuts that would be used

previewCustomFacets

Preview facet cuts for custom facets

function previewCustomFacets(string[] memory facetNames) external view returns (IDiamond.FacetCut[] memory cuts);

Parameters

Name	Type	Description
facetNames	string[]	Array of facet names

Returns

Name	Type	Description
cuts	IDiamond.FacetCut[]	Array of facet cuts that would be used

_deployDiamond

Internal function to deploy a diamond with facet cuts

function _deployDiamond(IDiamond.FacetCut[] memory facetCuts, bytes memory constructorArgs, bytes32 salt)
    internal
    virtual
    returns (address diamond);

Parameters

Name	Type	Description
facetCuts	IDiamond.FacetCut[]	Array of facet cuts to install
constructorArgs	bytes	ABI-encoded constructor arguments
salt	bytes32	Salt for CREATE2 deployment

Returns

Name	Type	Description
diamond	address	Address of the deployed diamond

_deployDiamondDefault

Default diamond deployment implementation

function _deployDiamondDefault(IDiamond.FacetCut[] memory facetCuts, bytes memory constructorArgs, bytes32 salt)
    internal
    returns (address diamond);

Parameters

Name	Type	Description
facetCuts	IDiamond.FacetCut[]	Array of facet cuts to install
constructorArgs	bytes	ABI-encoded constructor arguments
salt	bytes32	Salt for CREATE2 deployment

Returns

Name	Type	Description
diamond	address	Address of the deployed diamond

_generateDefaultSalt

Generate a default salt for CREATE2 deployment

function _generateDefaultSalt() internal view returns (bytes32 salt);

Returns

Name	Type	Description
salt	bytes32	Generated salt

predictDiamondAddress

Predict the address of a diamond deployment

function predictDiamondAddress(IDiamond.FacetCut[] memory facetCuts, bytes memory constructorArgs, bytes32 salt)
    external
    view
    returns (address predictedAddress);

Parameters

Name	Type	Description
facetCuts	IDiamond.FacetCut[]	Array of facet cuts
constructorArgs	bytes	Constructor arguments
salt	bytes32	Salt for CREATE2

Returns

Name	Type	Description
predictedAddress	address	The predicted address

_beforeDeploy

Hook called before diamond deployment (override in subclasses)

function _beforeDeploy(IDiamond.FacetCut[] memory facetCuts, bytes memory constructorArgs) internal virtual;

Parameters

Name	Type	Description
facetCuts	IDiamond.FacetCut[]	Array of facet cuts
constructorArgs	bytes	Constructor arguments

_afterDeploy

Hook called after diamond deployment (override in subclasses)

function _afterDeploy(address diamond, IDiamond.FacetCut[] memory facetCuts, bytes memory constructorArgs)
    internal
    virtual;

Parameters

Name	Type	Description
diamond	address	Address of deployed diamond
facetCuts	IDiamond.FacetCut[]	Array of facet cuts used
constructorArgs	bytes	Constructor arguments used

_validateDeploymentConfig

Validate deployment configuration (override in subclasses)

function _validateDeploymentConfig(IDiamond.FacetCut[] memory facetCuts, bytes memory constructorArgs)
    internal
    virtual
    returns (bool isValid);

Parameters

Name	Type	Description
facetCuts	IDiamond.FacetCut[]	Array of facet cuts
constructorArgs	bytes	Constructor arguments

Returns

Name	Type	Description
isValid	bool	True if configuration is valid