SPRegistryService

Defined in: packages/synapse-sdk/src/sp-registry/service.ts:30

Constructors

Constructor

new SPRegistryService(client): SPRegistryService

Defined in: packages/synapse-sdk/src/sp-registry/service.ts:36

Constructor for SPRegistryService

Parameters

Parameter	Type
`client`	`Client`<`Transport`, `Chain`>

Returns

SPRegistryService

Methods

activeProviderCount()

activeProviderCount(): Promise<bigint>

Defined in: packages/synapse-sdk/src/sp-registry/service.ts:236

Get number of active providers

Returns

Promise<bigint>

Active provider count

addPDPProduct()

addPDPProduct(client, pdpOffering, capabilities): Promise<`0x${string}`>

Defined in: packages/synapse-sdk/src/sp-registry/service.ts:249

Add PDP product to provider

Parameters

Parameter	Type	Description
`client`	`Client`<`Transport`, `Chain`, `Account`>	Client to use for the transaction
`pdpOffering`	`PDPOffering`	PDP offering details
`capabilities`	`Record`<`string`, `string`>	Optional capability keys

Returns

Promise<`0x${string}`>

Transaction hash

getActiveProvidersByProductType()

getActiveProvidersByProductType(productType): Promise<object[]>

Defined in: packages/synapse-sdk/src/sp-registry/service.ts:181

Get active providers by product type (handles pagination internally)

Parameters

Parameter	Type	Description
`productType`	`0`	Product type to filter by

Returns

Promise<object[]>

List of providers with specified product type

getAllActiveProviders()

getAllActiveProviders(): Promise<PDPProvider[]>

Defined in: packages/synapse-sdk/src/sp-registry/service.ts:154

Get all active providers (handles pagination internally)

Returns

Promise<PDPProvider[]>

List of all active providers

getProvider()

getProvider(providerId): Promise<PDPProvider | null>

Defined in: packages/synapse-sdk/src/sp-registry/service.ts:116

Get provider information by ID

Parameters

Parameter	Type	Description
`providerId`	`bigint`	Provider ID

Returns

Promise<PDPProvider | null>

Provider info with decoded products

getProviderByAddress()

getProviderByAddress(address): Promise<PDPProvider | null>

Defined in: packages/synapse-sdk/src/sp-registry/service.ts:132

Get provider information by address

Parameters

Parameter	Type	Description
`address`	`0x${string}`	Provider address

Returns

Promise<PDPProvider | null>

Provider info with decoded products

getProviderCount()

getProviderCount(): Promise<bigint>

Defined in: packages/synapse-sdk/src/sp-registry/service.ts:228

Get total number of providers

Returns

Promise<bigint>

Total provider count

getProviderIdByAddress()

getProviderIdByAddress(address): Promise<bigint>

Defined in: packages/synapse-sdk/src/sp-registry/service.ts:146

Get provider ID by address

Parameters

Parameter	Type	Description
`address`	`0x${string}`	Provider address

Returns

Promise<bigint>

Provider ID (0 if not found)

getProviders()

getProviders(providerIds): Promise<PDPProvider[]>

Defined in: packages/synapse-sdk/src/sp-registry/service.ts:303

Get multiple providers by IDs using Multicall3 for efficiency

Parameters

Parameter	Type	Description
`providerIds`	`bigint`[]	Array of provider IDs

Returns

Promise<PDPProvider[]>

Array of provider info

isProviderActive()

isProviderActive(providerId): Promise<boolean>

Defined in: packages/synapse-sdk/src/sp-registry/service.ts:211

Check if provider is active

Parameters

Parameter	Type	Description
`providerId`	`bigint`	Provider ID

Returns

Promise<boolean>

Whether provider is active

isRegisteredProvider()

isRegisteredProvider(address): Promise<boolean>

Defined in: packages/synapse-sdk/src/sp-registry/service.ts:220

Check if address is a registered provider

Parameters

Parameter	Type	Description
`address`	`0x${string}`	Address to check

Returns

Promise<boolean>

Whether address is registered

registerProvider()

registerProvider(client, info): Promise<`0x${string}`>

Defined in: packages/synapse-sdk/src/sp-registry/service.ts:73

Parameters

Parameter	Type	Description
`client`	`Client`<`Transport`, `Chain`, `Account`>	Client to use for the transaction
`info`	`ProviderRegistrationInfo`	Provider registration information

Returns

Promise<`0x${string}`>

Transaction hash

Example

const hash = await spRegistry.registerProvider(client, {
  payee: '0x...', // Address that will receive payments
  name: 'My Storage Provider',
  description: 'High-performance storage service',
  pdpOffering: {
    serviceURL: 'https://provider.example.com',
    minPieceSizeInBytes: SIZE_CONSTANTS.KiB,
    maxPieceSizeInBytes: SIZE_CONSTANTS.GiB,
    // ... other PDP fields
  },
  capabilities: { 'region': 'us-east', 'tier': 'premium' }
})

console.log(hash)

removeProduct()

removeProduct(client, productType): Promise<`0x${string}`>

Defined in: packages/synapse-sdk/src/sp-registry/service.ts:288

Remove product from provider

Parameters

Parameter	Type	Description
`client`	`Client`<`Transport`, `Chain`, `Account`>	Client to use for the transaction
`productType`	`0`	Type of product to remove

Returns

Promise<`0x${string}`>

Transaction hash

removeProvider()

removeProvider(client): Promise<`0x${string}`>

Defined in: packages/synapse-sdk/src/sp-registry/service.ts:105

Remove provider registration

Parameters

Parameter	Type	Description
`client`	`Client`<`Transport`, `Chain`, `Account`>	Client to use for the transaction

Returns

Promise<`0x${string}`>

Transaction response

updatePDPProduct()

updatePDPProduct(client, pdpOffering, capabilities): Promise<`0x${string}`>

Defined in: packages/synapse-sdk/src/sp-registry/service.ts:269

Update PDP product with capabilities

Parameters

Parameter	Type	Description
`client`	`Client`<`Transport`, `Chain`, `Account`>	Client to use for the transaction
`pdpOffering`	`PDPOffering`	Updated PDP offering
`capabilities`	`Record`<`string`, `string`>	Updated capability key-value pairs

Returns

Promise<`0x${string}`>

Transaction hash

updateProviderInfo()

updateProviderInfo(client, name, description): Promise<`0x${string}`>

Defined in: packages/synapse-sdk/src/sp-registry/service.ts:92

Update provider information

Parameters

Parameter	Type	Description
`client`	`Client`<`Transport`, `Chain`, `Account`>	Client to use for the transaction
`name`	`string`	New name
`description`	`string`	New description

Returns

Promise<`0x${string}`>

Transaction response

create()

static create(client): Promise<SPRegistryService>

Defined in: packages/synapse-sdk/src/sp-registry/service.ts:43

Create a new SPRegistryService instance

Parameters

Parameter	Type
`client`	`Client`<`Transport`, `Chain`>

Returns

Promise<SPRegistryService>