SPRegistryService

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

Constructors

Constructor

new SPRegistryService(provider, registryAddress): SPRegistryService;

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

Constructor for SPRegistryService

Parameters

Parameter	Type
`provider`	`Provider`
`registryAddress`	`string`

Returns

SPRegistryService

Methods

activeProviderCount()

activeProviderCount(): Promise<number>;

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

Get number of active providers

Returns

Promise<number>

Active provider count

addPDPProduct()

addPDPProduct(
   signer,
   pdpOffering,
capabilities): Promise<TransactionResponse>;

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

Add PDP product to provider

Parameters

Parameter	Type	Description
`signer`	`Signer`	Provider’s signer
`pdpOffering`	`PDPOffering`	PDP offering details
`capabilities`	`Record`<`string`, `string`>	Optional capability keys

Returns

Promise<TransactionResponse>

Transaction response

getActiveProvidersByProductType()

getActiveProvidersByProductType(productType): Promise<ProviderInfo[]>;

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

Get active providers by product type (handles pagination internally)

Parameters

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

Returns

Promise<ProviderInfo[]>

List of providers with specified product type

getAllActiveProviders()

getAllActiveProviders(): Promise<ProviderInfo[]>;

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

Get all active providers (handles pagination internally)

Returns

Promise<ProviderInfo[]>

List of all active providers

getPDPService()

getPDPService(providerId): Promise<
  | null
| PDPServiceInfo>;

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

Get PDP service info for a provider

Parameters

Parameter	Type	Description
`providerId`	`number`	Provider ID

Returns

Promise< | null | PDPServiceInfo>

PDP service info or null if not found

getProvider()

getProvider(providerId): Promise<null | ProviderInfo>;

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

Get provider information by ID

Parameters

Parameter	Type	Description
`providerId`	`number`	Provider ID

Returns

Promise<null | ProviderInfo>

Provider info with decoded products

getProviderByAddress()

getProviderByAddress(address): Promise<null | ProviderInfo>;

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

Get provider information by address

Parameters

Parameter	Type	Description
`address`	`string`	Provider address

Returns

Promise<null | ProviderInfo>

Provider info with decoded products

getProviderCount()

getProviderCount(): Promise<number>;

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

Get total number of providers

Returns

Promise<number>

Total provider count

getProviderIdByAddress()

getProviderIdByAddress(address): Promise<number>;

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

Get provider ID by address

Parameters

Parameter	Type	Description
`address`	`string`	Provider address

Returns

Promise<number>

Provider ID (0 if not found)

getProviders()

getProviders(providerIds): Promise<ProviderInfo[]>;

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

Get multiple providers by IDs using Multicall3 for efficiency

Parameters

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

Returns

Promise<ProviderInfo[]>

Array of provider info

isProviderActive()

isProviderActive(providerId): Promise<boolean>;

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

Check if provider is active

Parameters

Parameter	Type	Description
`providerId`	`number`	Provider ID

Returns

Promise<boolean>

Whether provider is active

isRegisteredProvider()

isRegisteredProvider(address): Promise<boolean>;

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

Check if address is a registered provider

Parameters

Parameter	Type	Description
`address`	`string`	Address to check

Returns

Promise<boolean>

Whether address is registered

providerHasProduct()

providerHasProduct(providerId, productType): Promise<boolean>;

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

Check if provider has a specific product type

Parameters

Parameter	Type	Description
`providerId`	`number`	Provider ID
`productType`	`0`	Product type to check

Returns

Promise<boolean>

Whether provider has the product

registerProvider()

registerProvider(signer, info): Promise<TransactionResponse>;

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

Parameters

Parameter	Type	Description
`signer`	`Signer`	Signer to register as provider
`info`	`ProviderRegistrationInfo`	Provider registration information

Returns

Promise<TransactionResponse>

Transaction response containing the provider ID

Example

const tx = await spRegistry.registerProvider(signer, {
  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' }
})

// Wait for transaction and get provider ID from event
const receipt = await tx.wait()
const event = receipt.logs.find(log =>
  log.topics[0] === ethers.id('ProviderRegistered(uint256,address,address)')
)
const providerId = event ? parseInt(event.topics[1], 16) : null

removeProduct()

removeProduct(signer, productType): Promise<TransactionResponse>;

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

Remove product from provider

Parameters

Parameter	Type	Description
`signer`	`Signer`	Provider’s signer
`productType`	`0`	Type of product to remove

Returns

Promise<TransactionResponse>

Transaction response

removeProvider()

removeProvider(signer): Promise<TransactionResponse>;

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

Remove provider registration

Parameters

Parameter	Type	Description
`signer`	`Signer`	Provider’s signer

Returns

Promise<TransactionResponse>

Transaction response

updatePDPProduct()

updatePDPProduct(
   signer,
   pdpOffering,
capabilities): Promise<TransactionResponse>;

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

Update PDP product with capabilities

Parameters

Parameter	Type	Description
`signer`	`Signer`	Provider’s signer
`pdpOffering`	`PDPOffering`	Updated PDP offering
`capabilities`	`Record`<`string`, `string`>	Updated capability key-value pairs

Returns

Promise<TransactionResponse>

Transaction response

updateProviderInfo()

updateProviderInfo(
   signer,
   name,
description): Promise<TransactionResponse>;

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

Update provider information

Parameters

Parameter	Type	Description
`signer`	`Signer`	Provider’s signer
`name`	`string`	New name
`description`	`string`	New description

Returns

Promise<TransactionResponse>

Transaction response

create()

static create(provider, registryAddress): Promise<SPRegistryService>;

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

Create a new SPRegistryService instance

Parameters

Parameter	Type
`provider`	`Provider`
`registryAddress`	`string`

Returns

Promise<SPRegistryService>