Skip to content

sp-registry

NamespaceDescription
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-
InterfaceDescription
PDPOfferingPDP offering details (decoded from capability k/v pairs)
PDPProvider-
Type AliasDescription
getProviderWithProductType-
ProductType-
ProviderInfo-
ProviderWithProduct-
VariableDescription
PRODUCTSProduct types supported by the registry
FunctionDescription
activeProviderCountGet the number of active providers
activeProviderCountCallCreate a call to the activeProviderCount function
addProductAdd a product to the service provider
addProductCallCreate a call to the addProduct function
addProductSyncAdd a product to the service provider and wait for confirmation
extractAddProductEventExtracts the ProductAdded event from transaction logs
extractRegisterProviderEventExtracts the ProviderRegistered event from transaction logs
extractRemoveProductEventExtracts the ProductRemoved event from transaction logs
extractRemoveProviderEventExtracts the ProviderRemoved event from transaction logs
extractUpdateProductEventExtracts the ProductUpdated event from transaction logs
extractUpdateProviderInfoEventExtracts the ProviderInfoUpdated event from transaction logs
getApprovedPDPProvidersGet FilecoinWarmStorage approved PDP providers
getPDPProviderGet PDP provider details
getPDPProviderByAddressGet PDP provider by address
getPDPProviderCallCreate a call to the getPDPProvider function
getPDPProvidersGet one bounded page of PDP providers.
getPDPProvidersByIdsGet PDP providers by IDs
getPDPProvidersCallCreate a call to the getProvidersByProductType contract function, specialized for PDP providers.
getProviderCountGet the total number of registered providers
getProviderCountCallCreate a call to the getProviderCount function
getProviderIdByAddressGet provider ID by address
getProviderIdByAddressCallCreate a call to the getProviderIdByAddress function
getProvidersByProductTypeGet one bounded page of providers offering a product type.
getProvidersByProductTypeCallCreate a call to the getProvidersByProductType function
getProviderWithProductGet provider details with specific product information
getProviderWithProductCallCreate a call to the getProviderWithProduct function
hasActivePDPProductReturns true when the contract response carries an active, populated PDP product.
isProviderActiveCheck if a provider is active
isProviderActiveCallCreate a call to the isProviderActive function
isRegisteredProviderCheck if an address is a registered provider
isRegisteredProviderCallCreate a call to the isRegisteredProvider function
parsePDPProviderParse raw provider and PDP-product contract output into a provider object.
parsePDPProvidersParse raw PDP-provider contract output into a normalized page.
registerProviderRegister a new service provider in the Service Provider Registry
registerProviderCallCreate a call to the registerProvider function
registerProviderSyncRegister a new service provider and wait for confirmation
removeProductRemove a product from the service provider
removeProductCallCreate a call to the removeProduct function
removeProductSyncRemove a product from the service provider and wait for confirmation
removeProviderRemove a service provider from the Service Provider Registry
removeProviderCallCreate a call to the removeProvider function
removeProviderSyncRemove a service provider and wait for confirmation
updateProductUpdate a product for the service provider
updateProductCallCreate a call to the updateProduct function
updateProductSyncUpdate a product for the service provider and wait for confirmation
updateProviderInfoUpdate provider information in the Service Provider Registry
updateProviderInfoCallCreate a call to the updateProviderInfo function
updateProviderInfoSyncUpdate provider information and wait for confirmation
validateCapabilitiesValidate capability keys/values arrays against the contract’s _validateCapabilities require chain.
validateLocationDefensive check for the location capability value byte length.
validatePayeeValidate the payee address for registerProvider.
validateProductTypeValidate that productType is the currently supported ProductType.PDP (0).
validateProviderInfoValidate ServiceProviderInfo.name / description byte lengths against the on-chain MAX_NAME_LENGTH / MAX_DESCRIPTION_LENGTH require checks.
validateRegistrationFeeValidate 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.