DiamondLoupe

Asset Tokenization Studio Team

Diamond Loupe

Exposes read-only introspection helpers for resolver-proxy facet metadata.

Implements the EIP-2535 loupe view surface over resolver-proxy storage. All queries are read-only and delegate pagination, selector, facet and ERC-165 lookups to inherited storage helpers.

Methods

getFacet

function getFacet(bytes32 _facetId) external view returns (struct IDiamondLoupe.Facet facet_)

Get the information associated with an specific facet

If facet is not found return empty Facet struct

Parameters

Name	Type	Description
_facetId	bytes32	The facet key for the resolver

Returns

Name	Type	Description
facet_	IDiamondLoupe.Facet	Facet data

getFacetAddress

function getFacetAddress(bytes4 _selector) external view returns (address facetAddress_)

Gets the facet that supports the given selector

If facet is not found return address(0)

Parameters

Name	Type	Description
_selector	bytes4	The function selector

Returns

Name	Type	Description
facetAddress_	address	The facet address

getFacetAddresses

function getFacetAddresses() external view returns (address[] facetAddresses_)

Get all the facet addresses used by a resolverProxy

Returns

Name	Type	Description
facetAddresses_	address[]	facetAddresses_

getFacetAddressesByPage

function getFacetAddressesByPage(uint256 _pageIndex, uint256 _pageLength) external view returns (address[] facetAddresses_)

Get all the facet addresses used by a resolverProxy

Parameters

Name	Type	Description
_pageIndex	uint256	members to skip : _pageIndex * _pageLength
_pageLength	uint256	number of members to return

Returns

Name	Type	Description
facetAddresses_	address[]	facetAddresses_

getFacetIdBySelector

function getFacetIdBySelector(bytes4 _selector) external view returns (bytes32 facetId_)

Returns the facet identifier registered for a function selector.

Reads resolver-proxy selector metadata and returns zero when the selector is absent.

Parameters

Name	Type	Description
_selector	bytes4	Function selector to resolve.

Returns

Name	Type	Description
facetId_	bytes32	Facet identifier associated with the selector.

getFacetIds

function getFacetIds() external view returns (bytes32[] facetIds_)

Get all the facet addresses used by a resolverProxy

Returns

Name	Type	Description
facetIds_	bytes32[]	facetIds_

getFacetIdsByPage

function getFacetIdsByPage(uint256 _pageIndex, uint256 _pageLength) external view returns (bytes32[] facetIds_)

Get all the facet addresses used by a resolverProxy

Parameters

Name	Type	Description
_pageIndex	uint256	members to skip : _pageIndex * _pageLength
_pageLength	uint256	number of members to return

Returns

Name	Type	Description
facetIds_	bytes32[]	facetIds_

getFacetSelectors

function getFacetSelectors(bytes32 _facetId) external view returns (bytes4[] facetSelectors_)

Gets all the function selectors supported by a specific facet.

Parameters

Name	Type	Description
_facetId	bytes32	The facet key for the resolver.

Returns

Name	Type	Description
facetSelectors_	bytes4[]	facetSelectors_

getFacetSelectorsByPage

function getFacetSelectorsByPage(bytes32 _facetId, uint256 _pageIndex, uint256 _pageLength) external view returns (bytes4[] facetSelectors_)

Gets all the function selectors supported by a specific facet.

Parameters

Name	Type	Description
_facetId	bytes32	The facet key for the resolver.
_pageIndex	uint256	members to skip : _pageIndex * _pageLength
_pageLength	uint256	number of members to return

Returns

Name	Type	Description
facetSelectors_	bytes4[]	facetSelectors_

getFacetSelectorsLength

function getFacetSelectorsLength(bytes32 _facetId) external view returns (uint256 facetSelectorsLength_)

Gets the function selectors length.

Parameters

Name	Type	Description
_facetId	bytes32	The facet key for the resolver.

Returns

Name	Type	Description
facetSelectorsLength_	uint256	facetSelectorsLength_

getFacets

function getFacets() external view returns (struct IDiamondLoupe.Facet[] facets_)

Gets all facet addresses and their four byte function selectors.

Returns

Name	Type	Description
facets_	IDiamondLoupe.Facet[]	Facet

getFacetsByPage

function getFacetsByPage(uint256 _pageIndex, uint256 _pageLength) external view returns (struct IDiamondLoupe.Facet[] facets_)

Gets all facet addresses and their four byte function selectors.

Parameters

Name	Type	Description
_pageIndex	uint256	members to skip : _pageIndex * _pageLength
_pageLength	uint256	number of members to return

Returns

Name	Type	Description
facets_	IDiamondLoupe.Facet[]	Facet

getFacetsLength

function getFacetsLength() external view returns (uint256 facetsLength_)

Gets facet length.

Returns

Name	Type	Description
facetsLength_	uint256	Facets length

getStaticFunctionSelectors

function getStaticFunctionSelectors() external pure returns (bytes4[] staticFunctionSelectors_)

Gets all function selectors of a facet

Returns

Name	Type	Description
staticFunctionSelectors_	bytes4[]	Face functions selectors

getStaticInterfaceIds

function getStaticInterfaceIds() external pure returns (bytes4[] staticInterfaceIds_)

Gets all interfaces ids of a facet.

Returns

Name	Type	Description
staticInterfaceIds_	bytes4[]	Face interface ids

getStaticResolverKey

function getStaticResolverKey() external pure returns (bytes32 staticResolverKey_)

Gets the static resolver key

Returns

Name	Type	Description
staticResolverKey_	bytes32	Static resolver key

supportsInterface

function supportsInterface(bytes4 _interfaceId) external view returns (bool)

Returns true if this contract implements the interface defined by interfaceId. See the corresponding https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section] to learn more about how these ids are created. This function call must use less than 30 000 gas.

Parameters

Name	Type	Description
_interfaceId	bytes4	undefined

Returns

Name	Type	Description
_0	bool	undefined

Errors

UnrecognizedResolverProxyVersion

error UnrecognizedResolverProxyVersion(bytes8 _resolverProxyVersion)

Thrown when the provided proxy version does not match any BLR compatible standard.

Parameters

Name	Type	Description
_resolverProxyVersion	bytes8	proxy version that is not compatible with the BLR.