ReferenceCurveFactory_v1

{ReferenceCurveFactory_v1} facilitates the deployment of ReferenceCurve contracts and their associated modules for the Inverter Network, ensuring seamless creation and configuration of various components in a single transaction. Source: src/factories/ReferenceCurveFactory_v1.sol. Interfaces: IReferenceCurveFactory_v1.

Functions

attachPresaleWithTreasury

function attachPresaleWithTreasury(
    uint referenceCurveId_,
    address expectedReferenceCurve_,
    ModuleConfig memory treasuryConfig_,
    ModuleConfig memory presaleConfig_
) external returns (address treasury_, address presale_);

Attaches a separate fee treasury and a presale to a ReferenceCurve that this factory created. Parameters

Name	Type	Description
`referenceCurveId_`	`uint`	The ID of a ReferenceCurve created by this factory.
`expectedReferenceCurve_`	`address`	The ReferenceCurve proxy that the caller expects for `referenceCurveId_`.
`treasuryConfig_`	`ModuleConfig`	The configuration for the separate fee treasury.
`presaleConfig_`	`ModuleConfig`	The configuration for the presale module.

Returns

Name	Type	Description
`treasury_`	`address`	The address of the separate fee treasury.
`presale_`	`address`	The address of the presale module.

IReferenceCurveFactory_v1.sol#L316

createReferenceCurve

function createReferenceCurve(
    ModuleConfig memory referenceCurveConfig_,
    IssuanceTokenConfig memory issuanceTokenConfig_,
    ModuleConfig memory authorizerConfig_,
    ModuleConfig memory feeTreasuryConfig_,
    ModuleConfig memory reserveManagerConfig_,
    ModuleConfig[] memory moduleConfigs_
) external returns (address referenceCurveAddress_);

Creates a new ReferenceCurve with its issuance token and its modules in one transaction. Parameters

Name	Type	Description
`referenceCurveConfig_`	`ModuleConfig`	The configuration for the ReferenceCurve module.
`issuanceTokenConfig_`	`IssuanceTokenConfig`	The configuration of the issuance token.
`authorizerConfig_`	`ModuleConfig`	The configuration for the Authorizer module.
`feeTreasuryConfig_`	`ModuleConfig`	The configuration for the FeeTreasury module.
`reserveManagerConfig_`	`ModuleConfig`	The configuration for the ReserveManager module.
`moduleConfigs_`	`ModuleConfig[]`	The configurations for optional modules.

Returns

Name	Type	Description
`referenceCurveAddress_`	`address`	The address of the created ReferenceCurve.

IReferenceCurveFactory_v1.sol#L279

createReferenceCurveWithRecovery

function createReferenceCurveWithRecovery(
    ModuleConfig memory referenceCurveConfig_,
    IssuanceTokenConfig memory issuanceTokenConfig_,
    ModuleConfig memory authorizerConfig_,
    ModuleConfig memory feeTreasuryConfig_,
    ModuleConfig memory reserveManagerConfig_,
    ModuleConfig[] memory moduleConfigs_,
    RecoveryConfiguration memory recovery_
) external returns (address);

Parameters

Name	Type	Description
`referenceCurveConfig_`	`ModuleConfig`
`issuanceTokenConfig_`	`IssuanceTokenConfig`
`authorizerConfig_`	`ModuleConfig`
`feeTreasuryConfig_`	`ModuleConfig`
`reserveManagerConfig_`	`ModuleConfig`
`moduleConfigs_`	`ModuleConfig[]`
`recovery_`	`RecoveryConfiguration`

Returns

Name	Type	Description
	`address`

IReferenceCurveFactory_v1.sol#L70

renounceAllowedDeployer

function renounceAllowedDeployer() external;

Removes the deployment permission of the caller. IReferenceCurveFactory_v1.sol#L329

setAllowedDeployer

function setAllowedDeployer(address deployer_, bool allowed_) external;

Sets the deployment permission for an address. Parameters

Name	Type	Description
`deployer_`	`address`	The address to set permission for.
`allowed_`	`bool`	Whether the address is allowed to deploy.

IReferenceCurveFactory_v1.sol#L337

setMarketFreezeSafes

function setMarketFreezeSafes(IMarketFreezeGuardian_v1.SafePair calldata safes_) external;

Sets the freeze Safe pair of market guardians created later. Parameters

Name	Type	Description
`safes_`	`IMarketFreezeGuardian_v1.SafePair`	The Safe pair. The two Safes must differ and have code.

IReferenceCurveFactory_v1.sol#L348

setOpenDeployment

function setOpenDeployment(bool open_) external;

Sets whether deployment is open to all addresses. Parameters

Name	Type	Description
`open_`	`bool`	Whether deployment should be open.

IReferenceCurveFactory_v1.sol#L341

View functions

getIssuanceTokenDeployer

function getIssuanceTokenDeployer() external view returns (address tokenDeployer_);

Returns the curve-bound token deployer that the factory uses. Returns

Name	Type	Description
`tokenDeployer_`	`address`	The address of the CurveBoundTokenDeployer_v1.

IReferenceCurveFactory_v1.sol#L362

getMarketFreezeSafes

function getMarketFreezeSafes() external view returns (IMarketFreezeGuardian_v1.SafePair memory safes_);

Returns the freeze Safe pair of market guardians created later. Returns

Name	Type	Description
`safes_`	`IMarketFreezeGuardian_v1.SafePair`	The Safe pair.

IReferenceCurveFactory_v1.sol#L355

getModuleFactory

function getModuleFactory() external view returns (address moduleFactoryAddress_);

Returns the address of the ModuleFactory contract. Returns

Name	Type	Description
`moduleFactoryAddress_`	`address`	The address of the ModuleFactory contract.

IReferenceCurveFactory_v1.sol#L225

getReferenceCurveByID

function getReferenceCurveByID(uint id_) external view returns (address referenceCurveAddress_);

Returns the ReferenceCurve address for a given ReferenceCurve ID. Parameters

Name	Type	Description
`id_`	`uint`	The ReferenceCurve ID to query.

Returns

Name	Type	Description
`referenceCurveAddress_`	`address`	The address of the ReferenceCurve contract.

IReferenceCurveFactory_v1.sol#L233

getReferenceCurveIDCounter

function getReferenceCurveIDCounter() external view returns (uint counter_);

Returns the current ReferenceCurve ID counter. Returns

Name	Type	Description
`counter_`	`uint`	The current ReferenceCurve ID counter.

IReferenceCurveFactory_v1.sol#L240

isAllowedDeployer

function isAllowedDeployer(address deployer_) external view returns (bool allowed_);

Returns whether the given address is an allowed deployer. Parameters

Name	Type	Description
`deployer_`	`address`	The address to check.

Returns

Name	Type	Description
`allowed_`	`bool`	True if the address is allowed to deploy.

IReferenceCurveFactory_v1.sol#L245

isOpenDeployment

function isOpenDeployment() external view returns (bool open_);

Returns whether deployment is open to all addresses. Returns

Name	Type	Description
`open_`	`bool`	True if deployment is open.

IReferenceCurveFactory_v1.sol#L252

Events

ReferenceCurveCreated

event ReferenceCurveCreated(uint indexed referenceCurveId_, address indexed referenceCurveProxy_);

Event emitted when a new ReferenceCurve is created. Parameters

Name	Type	Description
`referenceCurveId_`	`uint indexed`	The unique identifier of the created ReferenceCurve.
`referenceCurveProxy_`	`address indexed`	The address of the created ReferenceCurve proxy.

IReferenceCurveFactory_v1.sol#L86

ReferenceCurveFactory__DeployerSet

event ReferenceCurveFactory__DeployerSet(address indexed deployer_, bool allowed_);

Event emitted when a deployer permission is changed. Parameters

Name	Type	Description
`deployer_`	`address indexed`	The address of the deployer.
`allowed_`	`bool`	Whether the deployer is allowed.

IReferenceCurveFactory_v1.sol#L97

ReferenceCurveFactory__MarketFreezeGuardianCreated

event ReferenceCurveFactory__MarketFreezeGuardianCreated(
    address referenceCurve_,
    address guardian_
);

A freeze guardian was created for a new market. Parameters

Name	Type	Description
`referenceCurve_`	`address`	The ReferenceCurve of the market.
`guardian_`	`address`	The market freeze guardian.

IReferenceCurveFactory_v1.sol#L216

ReferenceCurveFactory__MarketFreezeSafesSet

event ReferenceCurveFactory__MarketFreezeSafesSet(address approvalSafe_, address emergencySafe_);

The freeze Safe pair of new market guardians was set. Parameters

Name	Type	Description
`approvalSafe_`	`address`	The approval Safe.
`emergencySafe_`	`address`	The emergency Safe.

IReferenceCurveFactory_v1.sol#L209

ReferenceCurveFactory__OpenDeploymentSet

event ReferenceCurveFactory__OpenDeploymentSet(bool open_);

Event emitted when open deployment is toggled. Parameters

Name	Type	Description
`open_`	`bool`	Whether deployment is open to all.

IReferenceCurveFactory_v1.sol#L103

ReferenceCurveFactory__PresaleAttached

event ReferenceCurveFactory__PresaleAttached(
    uint indexed referenceCurveId_,
    address indexed referenceCurveProxy_,
    address treasury_,
    address presale_
);

Event emitted when a separate fee treasury and a presale are attached to a ReferenceCurve. Parameters

Name	Type	Description
`referenceCurveId_`	`uint indexed`	The ID of the ReferenceCurve.
`referenceCurveProxy_`	`address indexed`	The address of the ReferenceCurve proxy.
`treasury_`	`address`	The address of the separate fee treasury.
`presale_`	`address`	The address of the presale module.

IReferenceCurveFactory_v1.sol#L111

ReferenceCurveFactoryInitialized

event ReferenceCurveFactoryInitialized(address moduleFactory_);

Event emitted when the ReferenceCurveFactory is initialized. Parameters

Name	Type	Description
`moduleFactory_`	`address`	The address of the ModuleFactory contract.

IReferenceCurveFactory_v1.sol#L92

Errors

ReferenceCurveFactory__CallerNotCurveAdmin

error ReferenceCurveFactory__CallerNotCurveAdmin();

Caller does not hold DEFAULT_ADMIN_ROLE on the curve’s authorizer. IReferenceCurveFactory_v1.sol#L134

ReferenceCurveFactory__CreditFacilityMarketMismatch

error ReferenceCurveFactory__CreditFacilityMarketMismatch(address creditFacility_);

The Presale’s CreditFacility has a different curve or authorizer. Parameters

Name	Type	Description
`creditFacility_`	`address`	The configured CreditFacility.

IReferenceCurveFactory_v1.sol#L144

ReferenceCurveFactory__InvalidAddress

error ReferenceCurveFactory__InvalidAddress();

Given address is invalid (zero address). IReferenceCurveFactory_v1.sol#L125

ReferenceCurveFactory__InvalidAuthorizerModule

error ReferenceCurveFactory__InvalidAuthorizerModule();

The authorizer config does not name an expected authorizer, or the created authorizer does not report its interfaces. IReferenceCurveFactory_v1.sol#L169

ReferenceCurveFactory__InvalidCurveConfigData

error ReferenceCurveFactory__InvalidCurveConfigData();

The curve config data is shorter than one word, or its first word, the issuance token slot, is not zero. IReferenceCurveFactory_v1.sol#L161

ReferenceCurveFactory__InvalidCurveModule

error ReferenceCurveFactory__InvalidCurveModule();

The curve config does not name an expected curve module. IReferenceCurveFactory_v1.sol#L164

ReferenceCurveFactory__InvalidFeeTreasuryModule

error ReferenceCurveFactory__InvalidFeeTreasuryModule();

The fee treasury config does not name an expected treasury, or the created treasury does not report its interfaces. IReferenceCurveFactory_v1.sol#L174

ReferenceCurveFactory__InvalidId

error ReferenceCurveFactory__InvalidId();

Given ReferenceCurve ID is invalid. IReferenceCurveFactory_v1.sol#L122

ReferenceCurveFactory__InvalidMarketFreezeSafes

error ReferenceCurveFactory__InvalidMarketFreezeSafes();

The freeze Safes are equal, or one of them has no code. IReferenceCurveFactory_v1.sol#L157

ReferenceCurveFactory__InvalidOptionalModule

error ReferenceCurveFactory__InvalidOptionalModule();

An optional module config uses a title that is not accepted. IReferenceCurveFactory_v1.sol#L182

ReferenceCurveFactory__InvalidPresaleModule

error ReferenceCurveFactory__InvalidPresaleModule();

The presale config does not name a Presale_v1 module. IReferenceCurveFactory_v1.sol#L140

ReferenceCurveFactory__InvalidReserveManagerModule

error ReferenceCurveFactory__InvalidReserveManagerModule();

The reserve manager config does not name a ReserveManager_v1, or the created module does not report the ReserveManager interface or starts with a liability. IReferenceCurveFactory_v1.sol#L179

ReferenceCurveFactory__InvalidTreasuryModule

error ReferenceCurveFactory__InvalidTreasuryModule();

The treasury config does not name a SplitterTreasury_v1 module. IReferenceCurveFactory_v1.sol#L137

ReferenceCurveFactory__IssuanceTokenMismatch

error ReferenceCurveFactory__IssuanceTokenMismatch(address token_);

The issuance token does not belong to the market curve. Parameters

Name	Type	Description
`token_`	`address`	The issuance token with a wrong link.

IReferenceCurveFactory_v1.sol#L191

ReferenceCurveFactory__MarketGuardianMismatch

error ReferenceCurveFactory__MarketGuardianMismatch(address guardian_);

The freeze guardian does not hold the market freeze Safes. Parameters

Name	Type	Description
`guardian_`	`address`	The market freeze guardian with wrong Safes.

IReferenceCurveFactory_v1.sol#L195

ReferenceCurveFactory__ModuleLinkMismatch

error ReferenceCurveFactory__ModuleLinkMismatch(address module_);

A module does not point to the partner that the factory created for the same market. Parameters

Name	Type	Description
`module_`	`address`	The module with a wrong partner.

IReferenceCurveFactory_v1.sol#L187

ReferenceCurveFactory__NotAllowed

error ReferenceCurveFactory__NotAllowed();

Caller is not allowed to deploy. IReferenceCurveFactory_v1.sol#L128

ReferenceCurveFactory__PresaleAlreadyAttached

error ReferenceCurveFactory__PresaleAlreadyAttached();

A presale is already attached to the given ReferenceCurve. IReferenceCurveFactory_v1.sol#L147

ReferenceCurveFactory__ReentrantCall

error ReferenceCurveFactory__ReentrantCall();

A presale attachment was re-entered while it was executing. IReferenceCurveFactory_v1.sol#L131

ReferenceCurveFactory__ReferenceCurveMismatch

error ReferenceCurveFactory__ReferenceCurveMismatch(address expected_, address actual_);

The ReferenceCurve of the given ID is not the expected curve. Parameters

Name	Type	Description
`expected_`	`address`	The curve that the caller expected for the ID.
`actual_`	`address`	The curve that the factory holds for the ID.

IReferenceCurveFactory_v1.sol#L152

ReferenceCurveFactory__TokenCapBelowCurveCapacity

error ReferenceCurveFactory__TokenCapBelowCurveCapacity(uint cap_, uint capacity_);

The cap of the issuance token is below the capacity of the initial curve segments. Parameters

Name	Type	Description
`cap_`	`uint`	The cap of the issuance token.
`capacity_`	`uint`	The total capacity of the initial curve segments.

IReferenceCurveFactory_v1.sol#L201