Skip to content

sp-registry

Namespace Description
activeProviderCount -
activeProviderCountCall -
addProduct -
addProductCall -
addProductSync -
getApprovedPDPProviders -
getPDPProvider -
getPDPProviderByAddress -
getPDPProviderCall -
getPDPProviders -
getPDPProvidersByIds -
getPDPProvidersCall -
getProviderCount -
getProviderCountCall -
getProviderIdByAddress -
getProviderIdByAddressCall -
getProvidersByProductType -
getProvidersByProductTypeCall -
getProviderWithProduct -
getProviderWithProductCall -
isProviderActive -
isProviderActiveCall -
isRegisteredProvider -
isRegisteredProviderCall -
registerProvider -
registerProviderCall -
registerProviderSync -
removeProduct -
removeProductCall -
removeProductSync -
removeProvider -
removeProviderCall -
removeProviderSync -
updateProduct -
updateProductCall -
updateProductSync -
updateProviderInfo -
updateProviderInfoCall -
updateProviderInfoSync -
Interface Description
PDPOffering PDP offering details (decoded from capability k/v pairs)
PDPProvider -
Type Alias Description
getProviderWithProductType -
ProductType -
ProviderInfo -
ProviderWithProduct -
Variable Description
PRODUCTS Product types supported by the registry
Function Description
activeProviderCount Get the number of active providers
activeProviderCountCall Create a call to the activeProviderCount function
addProduct Add a product to the service provider
addProductCall Create a call to the addProduct function
addProductSync Add a product to the service provider and wait for confirmation
extractAddProductEvent Extracts the ProductAdded event from transaction logs
extractRegisterProviderEvent Extracts the ProviderRegistered event from transaction logs
extractRemoveProductEvent Extracts the ProductRemoved event from transaction logs
extractRemoveProviderEvent Extracts the ProviderRemoved event from transaction logs
extractUpdateProductEvent Extracts the ProductUpdated event from transaction logs
extractUpdateProviderInfoEvent Extracts the ProviderInfoUpdated event from transaction logs
getApprovedPDPProviders Get FilecoinWarmStorage approved PDP providers
getPDPProvider Get PDP provider details
getPDPProviderByAddress Get PDP provider by address
getPDPProviderCall Create a call to the getPDPProvider function
getPDPProviders Get one bounded page of PDP providers.
getPDPProvidersByIds Get PDP providers by IDs
getPDPProvidersCall Create a call to the getProvidersByProductType contract function, specialized for PDP providers.
getProviderCount Get the total number of registered providers
getProviderCountCall Create a call to the getProviderCount function
getProviderIdByAddress Get provider ID by address
getProviderIdByAddressCall Create a call to the getProviderIdByAddress function
getProvidersByProductType Get one bounded page of providers offering a product type.
getProvidersByProductTypeCall Create a call to the getProvidersByProductType function
getProviderWithProduct Get provider details with specific product information
getProviderWithProductCall Create a call to the getProviderWithProduct function
hasActivePDPProduct Returns true when the contract response carries an active, populated PDP product.
isProviderActive Check if a provider is active
isProviderActiveCall Create a call to the isProviderActive function
isRegisteredProvider Check if an address is a registered provider
isRegisteredProviderCall Create a call to the isRegisteredProvider function
parsePDPProvider Parse raw provider and PDP-product contract output into a provider object.
parsePDPProviders Parse raw PDP-provider contract output into a normalized page.
registerProvider Register a new service provider in the Service Provider Registry
registerProviderCall Create a call to the registerProvider function
registerProviderSync Register a new service provider and wait for confirmation
removeProduct Remove a product from the service provider
removeProductCall Create a call to the removeProduct function
removeProductSync Remove a product from the service provider and wait for confirmation
removeProvider Remove a service provider from the Service Provider Registry
removeProviderCall Create a call to the removeProvider function
removeProviderSync Remove a service provider and wait for confirmation
updateProduct Update a product for the service provider
updateProductCall Create a call to the updateProduct function
updateProductSync Update a product for the service provider and wait for confirmation
updateProviderInfo Update provider information in the Service Provider Registry
updateProviderInfoCall Create a call to the updateProviderInfo function
updateProviderInfoSync Update provider information and wait for confirmation
validateCapabilities Validate capability keys/values arrays against the contract’s _validateCapabilities require chain.
validateLocation Defensive check for the location capability value byte length.
validatePayee Validate the payee address for registerProvider.
validateProductType Validate that productType is the currently supported ProductType.PDP (0).
validateProviderInfo Validate ServiceProviderInfo.name / description byte lengths against the on-chain MAX_NAME_LENGTH / MAX_DESCRIPTION_LENGTH require checks.
validateRegistrationFee Validate the value (msg.value) passed to registerProvider against SERVICE_PROVIDER_REGISTRY.REGISTRATION_FEE_WEI so callers get a client-side error instead of a simulate revert.