Maple
Search…
⌃K

Funding Locker Factory

FundingLockerFactory instantiates FundingLockers.

Functions

factoryType [state variable]

The type of the factory (i.e FactoryType::FUNDING_LOCKER_FACTORY).
function factoryType()
pure
returns (
uint8
);

Return Values:

Index
Name
Type
Internal Type
Description
0
uint8
uint8

isLocker [state variable]

function isLocker(
address fundingLocker
)
view
returns (
bool
);

Parameters:

Index
Name
Type
Internal Type
Description
0
fundingLocker
address
address
Some address.

Return Values:

Index
Name
Type
Internal Type
Description
0
bool
bool
Whether `fundingLocker` is a FundingLocker.

newLocker

Instantiates a FundingLocker. It emits a `FundingLockerCreated` event.
function newLocker(
address liquidityAsset
)
nonpayable
returns (
address fundingLocker
);

Parameters:

Index
Name
Type
Internal Type
Description
0
liquidityAsset
address
address
The Liquidity Asset this FundingLocker will escrow.

Return Values:

Index
Name
Type
Internal Type
Description
0
fundingLocker
address
address
The address of the instantiated FundingLocker.

owner [state variable]

function owner(
address fundingLocker
)
view
returns (
address
);

Parameters:

Index
Name
Type
Internal Type
Description
0
fundingLocker
address
address
The address of a FundingLocker.

Return Values:

Index
Name
Type
Internal Type
Description
0
address
address
The address of the owner of FundingLocker at `fundingLocker`.

Events

FundingLockerCreated

Emits an event indicating a FundingLocker was created.
event FundingLockerCreated(
address owner,
address fundingLocker,
address liquidityAsset
);

Parameters:

Index
Name
Type
Internal Type
Description
0
owner
address
address
The owner of the FundingLocker.
1
fundingLocker
address
address
The address of the FundingLocker.
2
liquidityAsset
address
address
The Liquidity Asset this FundingLocker will escrow.