Skip to content

IListingTermsRegistry

IListingTermsRegistry

UnregisteredListingTerms

error UnregisteredListingTerms(uint256 listingTermsId)

Thrown upon attempting to work with unregistered listing terms.

MoreSpecificListingTermsExistForWarper

error MoreSpecificListingTermsExistForWarper(uint256 listingTermsId, uint256 listingId, address warperAddress)

Thrown upon attempting to work with listing terms with params that have more specific terms on warper level.

MoreSpecificListingTermsExistForUniverse

error MoreSpecificListingTermsExistForUniverse(uint256 listingTermsId, uint256 listingId, uint256 universeId)

Thrown upon attempting to work with listing terms with params that have more specific terms on universe level.

WrongListingTermsIdForParams

error WrongListingTermsIdForParams(uint256 listingTermsId, uint256 listingId, uint256 universeId, address warperAddress)

Thrown upon attempting to work with listing without listing terms.

GlobalListingTermsMismatch

error GlobalListingTermsMismatch(uint256 listingId, uint256 listingTermsId)

Thrown upon attempting to work with listing without listing terms on global level.

UniverseListingTermsMismatch

error UniverseListingTermsMismatch(uint256 listingId, uint256 universeId, uint256 listingTermsId)

Thrown upon attempting to work with listing without listing terms on universe level.

WarperListingTermsMismatch

error WarperListingTermsMismatch(uint256 listingId, address warperAddress, uint256 listingTermsId)

Thrown upon attempting to work with listing without listing terms on warper level.

ListingTermsRegistered

event ListingTermsRegistered(uint256 listingTermsId, bytes4 strategyId, bytes strategyData)

Emitted when the new listing terms are registered.

Name Type Description
listingTermsId uint256 Listing terms ID.
strategyId bytes4 Listing strategy ID.
strategyData bytes Listing strategy data.

GlobalListingTermsRegistered

event GlobalListingTermsRegistered(uint256 listingId, uint256 listingTermsId)

Emitted when existing global listing terms are registered.

Name Type Description
listingId uint256 Listing group ID.
listingTermsId uint256 Listing terms ID.

GlobalListingTermsRemoved

event GlobalListingTermsRemoved(uint256 listingId, uint256 listingTermsId)

Emitted when the global listing terms are removed.

Name Type Description
listingId uint256 Listing group ID.
listingTermsId uint256 Listing terms ID.

UniverseListingTermsRegistered

event UniverseListingTermsRegistered(uint256 listingId, uint256 universeId, uint256 listingTermsId)

Emitted when universe listing terms are registered.

Name Type Description
listingId uint256 Listing group ID.
universeId uint256 Universe ID.
listingTermsId uint256 Listing terms ID.

UniverseListingTermsRemoved

event UniverseListingTermsRemoved(uint256 listingId, uint256 universeId, uint256 listingTermsId)

Emitted when universe listing terms are removed.

Name Type Description
listingId uint256 Listing group ID.
universeId uint256 Universe ID.
listingTermsId uint256 Listing terms ID.

WarperListingTermsRegistered

event WarperListingTermsRegistered(uint256 listingId, address warperAddress, uint256 listingTermsId)

Emitted when the warper listing terms are registered.

Name Type Description
listingId uint256 Listing group ID.
warperAddress address Address of the warper.
listingTermsId uint256 Listing terms ID.

WarperListingTermsRemoved

event WarperListingTermsRemoved(uint256 listingId, address warperAddress, uint256 listingTermsId)

Emitted when warper level lister's listing terms are removed.

Name Type Description
listingId uint256 Listing group ID.
warperAddress address Address of the warper.
listingTermsId uint256 Listing terms ID.

ListingTerms

struct ListingTerms {
  bytes4 strategyId;
  bytes strategyData;
}

Params

struct Params {
  uint256 listingId;
  uint256 universeId;
  address warperAddress;
}

registerGlobalListingTerms

function registerGlobalListingTerms(uint256 listingId, struct IListingTermsRegistry.ListingTerms terms) external returns (uint256 listingTermsId)

Registers global listing terms.

Name Type Description
listingId uint256 Listing ID.
terms struct IListingTermsRegistry.ListingTerms Listing terms data.
Name Type Description
listingTermsId uint256 Listing terms ID.

removeGlobalListingTerms

function removeGlobalListingTerms(uint256 listingId, uint256 listingTermsId) external

Removes global listing terms.

Name Type Description
listingId uint256 Listing ID.
listingTermsId uint256 Listing Terms ID.

registerUniverseListingTerms

function registerUniverseListingTerms(uint256 listingId, uint256 universeId, struct IListingTermsRegistry.ListingTerms terms) external returns (uint256 listingTermsId)

Registers universe listing terms.

Name Type Description
listingId uint256 Listing ID.
universeId uint256 Universe ID.
terms struct IListingTermsRegistry.ListingTerms Listing terms data.
Name Type Description
listingTermsId uint256 Listing terms ID.

removeUniverseListingTerms

function removeUniverseListingTerms(uint256 listingId, uint256 universeId, uint256 listingTermsId) external

Removes universe listing terms.

Name Type Description
listingId uint256 Listing ID.
universeId uint256 Universe ID.
listingTermsId uint256 Listing terms ID.

registerWarperListingTerms

function registerWarperListingTerms(uint256 listingId, address warperAddress, struct IListingTermsRegistry.ListingTerms terms) external returns (uint256 listingTermsId)

Registers warper listing terms.

Name Type Description
listingId uint256 Listing ID.
warperAddress address The address of the warper.
terms struct IListingTermsRegistry.ListingTerms Listing terms.
Name Type Description
listingTermsId uint256 Listing terms ID.

removeWarperListingTerms

function removeWarperListingTerms(uint256 listingId, address warperAddress, uint256 listingTermsId) external

Removes warper listing terms.

Name Type Description
listingId uint256 Listing ID.
warperAddress address The address of the warper.
listingTermsId uint256 Listing terms ID

listingTerms

function listingTerms(uint256 listingTermsId) external view returns (struct IListingTermsRegistry.ListingTerms)

Returns listing terms by ID.

Name Type Description
listingTermsId uint256 Listing terms ID.
Name Type Description
[0] struct IListingTermsRegistry.ListingTerms Listing Terms.

listingTermsWithParams

function listingTermsWithParams(uint256 listingTermsId) external view returns (struct IListingTermsRegistry.ListingTerms, struct IListingTermsRegistry.Params)

Returns listing terms by ID.

Name Type Description
listingTermsId uint256 Listing terms ID.
Name Type Description
[0] struct IListingTermsRegistry.ListingTerms Listing Terms.
[1] struct IListingTermsRegistry.Params Listing Terms Params.

allListingTerms

function allListingTerms(struct IListingTermsRegistry.Params params, uint256 offset, uint256 limit) external view returns (uint256[], struct IListingTermsRegistry.ListingTerms[])

Returns all listing terms for params.

Name Type Description
params struct IListingTermsRegistry.Params Listing terms specific params.
offset uint256 List offset value.
limit uint256 List limit value.
Name Type Description
[0] uint256[] List of Listing Terms IDs.
[1] struct IListingTermsRegistry.ListingTerms[] List of Listing Terms.

areRegisteredListingTerms

function areRegisteredListingTerms(uint256 listingTermsId) external view returns (bool)

Checks registration of listing terms.

Name Type Description
listingTermsId uint256 Listing Terms ID.
Name Type Description
[0] bool Boolean that is positive in case of existance

areRegisteredListingTermsWithParams

function areRegisteredListingTermsWithParams(uint256 listingTermsId, struct IListingTermsRegistry.Params params) external view returns (bool)

Checks registration of listing terms.

Name Type Description
listingTermsId uint256 Listing Terms ID.
params struct IListingTermsRegistry.Params Listing terms specific params.
Name Type Description
[0] bool Boolean that is positive in case of existance

checkRegisteredListingTerms

function checkRegisteredListingTerms(uint256 listingTermsId) external view

Checks registration of listing terms. Reverts with UnregisteredListingTerms() in case listing terms were not registered.

Name Type Description
listingTermsId uint256 Listing Terms ID.

checkRegisteredListingTermsWithParams

function checkRegisteredListingTermsWithParams(uint256 listingTermsId, struct IListingTermsRegistry.Params params) external view

Checks registration of listing terms for lister on global, universe and warper levels. Reverts in case of absence of listing terms on all levels.

Name Type Description
listingTermsId uint256 Listing Terms ID.
params struct IListingTermsRegistry.Params Listing terms specific params.