Skip to content

getUploadCosts

getUploadCosts(client, options): Promise<OutputType>

Defined in: packages/synapse-core/src/warm-storage/get-upload-costs.ts:59

Read-only function that computes upload costs, reserve-aware deposit needed, and approval state.

Fetches account state, pricing, and approval via read-only contract calls, then delegates all cost arithmetic to the shared pure calculateUploadCosts utility. Existing-data-set calls must provide dataSetLeafCount, currentLifecycleReserveBalance, and pdpEndEpoch; pass pendingOneTimePayments when the data set has unflushed lifecycle fees. Multi-piece fee and reserve estimates conservatively treat each piece as a separate add-pieces operation because actual batching is runtime-dependent.

ParameterTypeDescription
clientClient<Transport, Chain>The client to use to compute upload costs.
optionsOptionsTypegetUploadCosts.OptionsType

Promise<OutputType>

getUploadCosts.OutputType

When existing-data-set state or piece sizes are invalid, or the data-set service is terminated