UploadResult

Defined in: packages/synapse-sdk/src/types.ts:493

Result of a multi-copy upload operation.

To determine success, check complete, it’s true when all requested copies were successfully stored and recorded on-chain. Do NOT use failedAttempts.length > 0 as a failure signal; failed attempts may have been resolved by successful retries on other providers.

Example

const result = await synapse.storage.upload(data, { copies: 3 })
if (!result.complete) {
  console.warn(`Got ${result.copies.length}/${result.requestedCopies} copies`)
  for (const attempt of result.failedAttempts) {
    console.warn(`  Provider ${attempt.providerId}: ${attempt.error}`)
  }
}

Properties

complete

complete: boolean

Defined in: packages/synapse-sdk/src/types.ts:501

True when all requested copies were successfully stored and recorded on-chain

---

copies

copies: CopyResult[]

Defined in: packages/synapse-sdk/src/types.ts:503

Successful copies across providers

---

failedAttempts

failedAttempts: FailedAttempt[]

Defined in: packages/synapse-sdk/src/types.ts:509

Provider attempts that did not produce a copy. A non-empty array does NOT indicate upload failure, check complete or compare copies.length against requestedCopies to determine overall success.

---

pieceCid

pieceCid: PieceLink

Defined in: packages/synapse-sdk/src/types.ts:495

PieceCID of the uploaded data

---

requestedCopies

requestedCopies: number

Defined in: packages/synapse-sdk/src/types.ts:499

Number of copies that were requested

---

size

size: number

Defined in: packages/synapse-sdk/src/types.ts:497

Size of the original data