WarmStorageService

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:106

Methods

addApprovedProvider()

addApprovedProvider(signer, providerId): Promise<TransactionResponse>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:996

Add an approved provider by ID (owner only)

Parameters

Parameter	Type	Description
signer	Signer	Signer with owner permissions
providerId	number	Provider ID from registry

Returns

Promise<TransactionResponse>

Transaction response

---

calculateStorageCost()

calculateStorageCost(sizeInBytes): Promise<{
  perDay: bigint;
  perEpoch: bigint;
  perMonth: bigint;
  withCDN: {
     perDay: bigint;
     perEpoch: bigint;
     perMonth: bigint;
  };
}>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:743

Calculate storage costs for a given size

Parameters

Parameter	Type	Description
sizeInBytes	number	Size of data to store in bytes

Returns

Promise<{ perDay: bigint; perEpoch: bigint; perMonth: bigint; withCDN: { perDay: bigint; perEpoch: bigint; perMonth: bigint; }; }>

Cost estimates per epoch, day, and month for both CDN and non-CDN

---

checkAllowanceForStorage()

checkAllowanceForStorage(
   sizeInBytes,
   withCDN,
   paymentsService,
   lockupDays?): Promise<{
  costs: {
     perDay: bigint;
     perEpoch: bigint;
     perMonth: bigint;
  };
  currentLockupAllowance: bigint;
  currentLockupUsed: bigint;
  currentRateAllowance: bigint;
  currentRateUsed: bigint;
  depositAmountNeeded: bigint;
  lockupAllowanceNeeded: bigint;
  message?: string;
  rateAllowanceNeeded: bigint;
  sufficient: boolean;
}>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:784

Check if user has sufficient allowances for a storage operation and calculate costs

Parameters

Parameter	Type	Description
sizeInBytes	number	Size of data to store
withCDN	boolean	Whether CDN is enabled
paymentsService	PaymentsService	PaymentsService instance to check allowances
lockupDays?	number	Number of days for lockup period (defaults to 10)

Returns

Promise<{ costs: { perDay: bigint; perEpoch: bigint; perMonth: bigint; }; currentLockupAllowance: bigint; currentLockupUsed: bigint; currentRateAllowance: bigint; currentRateUsed: bigint; depositAmountNeeded: bigint; lockupAllowanceNeeded: bigint; message?: string; rateAllowanceNeeded: bigint; sufficient: boolean; }>

Allowance requirement details and storage costs

---

getAddPiecesInfo()

getAddPiecesInfo(dataSetId): Promise<AddPiecesInfo>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:411

Get information for adding pieces to a data set

Parameters

Parameter	Type	Description
dataSetId	number	The PDPVerifier data set ID

Returns

Promise<AddPiecesInfo>

Helper information for adding pieces

---

getApprovedProviderIds()

getApprovedProviderIds(): Promise<number[]>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:1028

Get list of approved provider IDs

Returns

Promise<number[]>

Array of approved provider IDs

---

getChallengeWindow()

getChallengeWindow(): Promise<number>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:1080

Get the challenge window size from the WarmStorage contract

Returns

Promise<number>

Challenge window size in epochs

---

getClientDataSets()

getClientDataSets(clientAddress): Promise<DataSetInfo[]>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:319

Get all data sets for a specific client

Parameters

Parameter	Type	Description
clientAddress	string	The client address

Returns

Promise<DataSetInfo[]>

Array of data set information

---

getClientDataSetsWithDetails()

getClientDataSetsWithDetails(client, onlyManaged): Promise<EnhancedDataSetInfo[]>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:349

Get all data sets for a client with enhanced details This includes live status and management information

Parameters

Parameter	Type	Default value	Description
client	string	undefined	The client address
onlyManaged	boolean	false	If true, only return data sets managed by this Warm Storage contract

Returns

Promise<EnhancedDataSetInfo[]>

Array of enhanced data set information

---

getComprehensiveDataSetStatus()

getComprehensiveDataSetStatus(txHashOrTransaction, pdpServer?): Promise<ComprehensiveDataSetStatus>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:538

Get comprehensive data set creation status combining server and chain info

Parameters

Parameter	Type	Description
txHashOrTransaction	| string | TransactionResponse	Transaction hash or transaction object
pdpServer?	PDPServer	PDP server instance for status checks

Returns

Promise<ComprehensiveDataSetStatus>

Combined status information

---

getDataSet()

getDataSet(dataSetId): Promise<DataSetInfo>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:290

Get a single data set by ID

Parameters

Parameter	Type	Description
dataSetId	number	The data set ID to retrieve

Returns

Promise<DataSetInfo>

Data set information

Throws

Error if data set doesn’t exist

---

getDataSetMetadata()

getDataSetMetadata(dataSetId): Promise<Record<string, string>>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:666

Get all metadata for a data set

Parameters

Parameter	Type	Description
dataSetId	number	The data set ID

Returns

Promise<Record<string, string>>

Object with metadata key-value pairs

---

getDataSetMetadataByKey()

getDataSetMetadataByKey(dataSetId, key): Promise<string | null>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:684

Get specific metadata key for a data set

Parameters

Parameter	Type	Description
dataSetId	number	The data set ID
key	string	The metadata key to retrieve

Returns

Promise<string | null>

The metadata value if it exists, null otherwise

---

getMaxProvingPeriod()

getMaxProvingPeriod(): Promise<number>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:1070

Get the maximum proving period from the WarmStorage contract

Returns

Promise<number>

Maximum proving period in epochs

---

getOwner()

getOwner(): Promise<string>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:1048

Get the contract owner address

Returns

Promise<string>

Owner address

---

getPaymentsAddress()

getPaymentsAddress(): string;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:218

Returns

string

---

getPDPVerifierAddress()

getPDPVerifierAddress(): string;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:214

Returns

string

---

getPieceMetadata()

getPieceMetadata(dataSetId, pieceId): Promise<Record<string, string>>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:696

Get all metadata for a piece in a data set

Parameters

Parameter	Type	Description
dataSetId	number	The data set ID
pieceId	number	The piece ID

Returns

Promise<Record<string, string>>

Object with metadata key-value pairs

---

getPieceMetadataByKey()

getPieceMetadataByKey(
   dataSetId,
   pieceId,
key): Promise<string | null>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:715

Get specific metadata key for a piece in a data set

Parameters

Parameter	Type	Description
dataSetId	number	The data set ID
pieceId	number	The piece ID
key	string	The metadata key to retrieve

Returns

Promise<string | null>

The metadata value if it exists, null otherwise

---

getProvider()

getProvider(): Provider;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:242

Get the provider instance

Returns

Provider

The ethers provider

---

getServicePrice()

getServicePrice(): Promise<ServicePriceInfo>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:727

Get the current service price per TiB per month

Returns

Promise<ServicePriceInfo>

Service price information for both CDN and non-CDN options

---

getServiceProviderRegistryAddress()

getServiceProviderRegistryAddress(): string;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:230

Returns

string

---

getSessionKeyRegistryAddress()

getSessionKeyRegistryAddress(): string;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:234

Returns

string

---

getUSDFCTokenAddress()

getUSDFCTokenAddress(): string;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:222

Returns

string

---

getViewContractAddress()

getViewContractAddress(): string;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:226

Returns

string

---

isOwner()

isOwner(signer): Promise<boolean>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:1058

Check if a signer is the contract owner

Parameters

Parameter	Type	Description
signer	Signer	Signer to check

Returns

Promise<boolean>

Whether the signer is the owner

---

isProviderIdApproved()

isProviderIdApproved(providerId): Promise<boolean>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:1039

Check if a provider ID is approved

Parameters

Parameter	Type	Description
providerId	number	Provider ID to check

Returns

Promise<boolean>

Whether the provider is approved

---

prepareStorageUpload()

prepareStorageUpload(options, paymentsService): Promise<{
  actions: object[];
  allowanceCheck: {
     message?: string;
     sufficient: boolean;
  };
  estimatedCost: {
     perDay: bigint;
     perEpoch: bigint;
     perMonth: bigint;
  };
}>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:892

Prepare for storage upload by checking balances and allowances

This method performs a comprehensive check of the prerequisites for storage upload, including verifying sufficient funds and service allowances. It returns a list of actions that need to be executed before the upload can proceed.

Parameters

Parameter	Type	Description
options	{ dataSize: number; withCDN?: boolean; }	Configuration options for the storage upload
options.dataSize	number	Size of data to store in bytes
options.withCDN?	boolean	Whether to enable CDN for faster retrieval (optional, defaults to false)
paymentsService	PaymentsService	Instance of PaymentsService for handling payment operations

Returns

Promise<{ actions: object[]; allowanceCheck: { message?: string; sufficient: boolean; }; estimatedCost: { perDay: bigint; perEpoch: bigint; perMonth: bigint; }; }>

Object containing:

• estimatedCost: Breakdown of storage costs (per epoch, day, and month)
• allowanceCheck: Status of service allowances with optional message
• actions: Array of required actions (deposit, approveService) that need to be executed

Example

const prep = await warmStorageService.prepareStorageUpload(
  { dataSize: Number(SIZE_CONSTANTS.GiB), withCDN: true },
  paymentsService
)

if (prep.actions.length > 0) {
  for (const action of prep.actions) {
    console.log(`Executing: ${action.description}`)
    await action.execute()
  }
}

---

removeApprovedProvider()

removeApprovedProvider(signer, providerId): Promise<TransactionResponse>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:1008

Remove an approved provider by ID (owner only)

Parameters

Parameter	Type	Description
signer	Signer	Signer with owner permissions
providerId	number	Provider ID from registry

Returns

Promise<TransactionResponse>

Transaction response

---

terminateDataSet()

terminateDataSet(signer, dataSetId): Promise<TransactionResponse>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:982

Terminate a data set with given ID

Parameters

Parameter	Type	Description
signer	Signer	Signer which created this dataset
dataSetId	number	ID of the data set to terminate

Returns

Promise<TransactionResponse>

Transaction receipt

---

topUpCDNPaymentRails()

topUpCDNPaymentRails(
   signer,
   dataSetId,
   cdnAmountToAdd,
cacheMissAmountToAdd): Promise<TransactionResponse>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:1096

Increments the fixed locked-up amounts for CDN payment rails.

This method tops up the prepaid balance for CDN services by adding to the existing lockup amounts. Both CDN and cache miss rails can be incremented independently.

Parameters

Parameter	Type	Description
signer	Signer	-
dataSetId	number	The ID of the data set
cdnAmountToAdd	bigint	Amount to add to the CDN rail lockup
cacheMissAmountToAdd	bigint	Amount to add to the cache miss rail lockup

Returns

Promise<TransactionResponse>

Transaction response

---

verifyDataSetCreation()

verifyDataSetCreation(txHashOrTransaction): Promise<DataSetCreationVerification>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:456

Verify that a data set creation transaction was successful This checks both the transaction status and on-chain data set state

Parameters

Parameter	Type	Description
txHashOrTransaction	| string | TransactionResponse	Transaction hash or transaction object

Returns

Promise<DataSetCreationVerification>

Verification result with data set ID if found

---

waitForDataSetCreationWithStatus()

waitForDataSetCreationWithStatus(
   txHashOrTransaction,
   pdpServer,
   maxWaitTime,
   pollInterval,
onProgress?): Promise<ComprehensiveDataSetStatus>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:617

Wait for data set creation with status updates

Parameters

Parameter	Type	Default value	Description
txHashOrTransaction	| string | TransactionResponse	undefined	Transaction hash or transaction object to wait for
pdpServer	PDPServer	undefined	PDP server for status checks
maxWaitTime	number	TIMING_CONSTANTS.DATA_SET_CREATION_TIMEOUT_MS	Maximum time to wait in milliseconds
pollInterval	number	TIMING_CONSTANTS.DATA_SET_CREATION_POLL_INTERVAL_MS	Polling interval in milliseconds
onProgress?	(status, elapsedMs) => Promise<void>	undefined	Optional progress callback

Returns

Promise<ComprehensiveDataSetStatus>

Final comprehensive status

---

create()

static create(provider, warmStorageAddress): Promise<WarmStorageService>;

Defined in: packages/synapse-sdk/src/warm-storage/service.ts:148

Create a new WarmStorageService instance with initialized addresses

Parameters

Parameter	Type
provider	Provider
warmStorageAddress	string

Returns

Promise<WarmStorageService>