IModuleFactory

Functions

isMakinaXModule

Module => Whether the module was deployed by this factory.

function isMakinaXModule(address module) external view returns (bool);

Parameters

Name	Type	Description
module	`address`

Returns

Name	Type	Description
<none>	`bool`

defaultProvider

Provider enforced by default on modules deployed through the free path.

function defaultProvider() external view returns (address);

Returns

Name	Type	Description
<none>	`address`

defaultSwapFeeRate

Swap fee rate enforced by default on modules deployed through the free path, 1e18 = 100%.

function defaultSwapFeeRate() external view returns (uint256);

Returns

Name	Type	Description
<none>	`uint256`

freeDeployment

Whether free module deployment is currently enabled.

function freeDeployment() external view returns (bool);

Returns

Name	Type	Description
<none>	`bool`

createModule

Deploys a new MakinaXModule clone with caller-provided service parameters.

Restricted to authorized deployers.

function createModule(
        IMakinaXModule.MakinaXModuleInitParams calldata params,
        IMakinaXModule.MakinaXModuleServiceParams calldata serviceParams,
        bytes32 salt,
        bytes32 referralKey
    ) external returns (address);

Parameters

Name	Type	Description
params	`IMakinaXModule.MakinaXModuleInitParams`	The strategy and risk initialization parameters for the MakinaXModule.
serviceParams	`IMakinaXModule.MakinaXModuleServiceParams`	The protocol-controlled service initialization parameters.
salt	`bytes32`	The salt used for deterministic deployment of the module clone.
referralKey	`bytes32`	The referral key associated with the module creation.

Returns

Name	Type	Description
<none>	`address`	The address of the newly deployed MakinaXModule.

createModuleFree

Deploys a new MakinaXModule clone, with service parameters enforced by the factory.

Callable by anyone while free deployment is enabled.

function createModuleFree(IMakinaXModule.MakinaXModuleInitParams calldata params, bytes32 salt, bytes32 referralKey)
        external
        returns (address);

Parameters

Name	Type	Description
params	`IMakinaXModule.MakinaXModuleInitParams`	The strategy and risk initialization parameters for the MakinaXModule.
salt	`bytes32`	The caller-scoped salt used for deterministic deployment of the module clone.
referralKey	`bytes32`	The referral key associated with the module creation.

Returns

Name	Type	Description
<none>	`address`	The address of the newly deployed MakinaXModule.

setDefaultProvider

Sets the provider enforced on free deployment.

function setDefaultProvider(address newDefaultProvider) external;

Parameters

Name	Type	Description
newDefaultProvider	`address`	The new default provider address.

setDefaultSwapFeeRate

Sets the swap fee rate enforced on free deployment.

function setDefaultSwapFeeRate(uint256 newDefaultSwapFeeRate) external;

Parameters

Name	Type	Description
newDefaultSwapFeeRate	`uint256`	The new default swap fee rate, 1e18 = 100%.

setFreeDeployment

Enables or disables free module deployment.

function setFreeDeployment(bool enabled) external;

Parameters

Name	Type	Description
enabled	`bool`	True to enable free deployment, false to disable it.

Events

MakinaXModuleCreated

event MakinaXModuleCreated(address indexed module, address indexed implementation, bytes32 indexed referralKey);

Parameters

Name	Type	Description
module	`address`
implementation	`address`
referralKey	`bytes32`

DefaultProviderChanged

event DefaultProviderChanged(address indexed oldDefaultProvider, address indexed newDefaultProvider);

Parameters

Name	Type	Description
oldDefaultProvider	`address`
newDefaultProvider	`address`

DefaultSwapFeeRateChanged

event DefaultSwapFeeRateChanged(uint256 oldDefaultSwapFeeRate, uint256 newDefaultSwapFeeRate);

Parameters

Name	Type	Description
oldDefaultSwapFeeRate	`uint256`
newDefaultSwapFeeRate	`uint256`

FreeDeploymentChanged

event FreeDeploymentChanged(bool enabled);

Parameters

Name	Type	Description
enabled	`bool`