filecoin-pin/dist/core/piece/remove-piece.d.ts

Bridge IPFS content to Filecoin Onchain Cloud using familiar tools

import type { StorageContext, Synapse } from '@filoz/synapse-sdk';
import type { Logger } from 'pino';
import type { ProgressEvent, ProgressEventHandler } from '../utils/types.js';
/**
 * Progress events emitted during piece removal
 *
 * These events allow callers to track the removal process:
 * - submitting: Transaction is being submitted to blockchain
 * - submitted: Transaction submitted successfully, txHash available
 * - confirming: Waiting for transaction confirmation (if waitForConfirmation=true)
 * - confirmation-failed: Confirmation wait timed out (non-fatal, tx may still succeed)
 * - complete: Removal process finished
 *
 * Note: Errors are propagated via thrown exceptions, not events (similar to upload pattern)
 */
export type RemovePieceProgressEvents = ProgressEvent<'remove-piece:submitting', {
    pieceCid: string;
    dataSetId: number;
}> | ProgressEvent<'remove-piece:submitted', {
    pieceCid: string;
    dataSetId: number;
    txHash: `0x${string}` | string;
}> | ProgressEvent<'remove-piece:confirming', {
    pieceCid: string;
    dataSetId: number;
    txHash: `0x${string}` | string;
}> | ProgressEvent<'remove-piece:confirmation-failed', {
    pieceCid: string;
    dataSetId: number;
    txHash: `0x${string}` | string;
    message: string;
}> | ProgressEvent<'remove-piece:complete', {
    txHash: `0x${string}` | string;
    confirmed: boolean;
}>;
/**
 * Base options for piece removal
 */
interface RemovePieceOptionsBase {
    /** Initialized Synapse SDK instance (required when waitForConfirmation is true)*/
    synapse?: Synapse | undefined;
    /** Optional progress event handler for tracking removal status */
    onProgress?: ProgressEventHandler<RemovePieceProgressEvents> | undefined;
    /** Whether to wait for transaction confirmation before returning (default: false) */
    waitForConfirmation?: boolean | undefined;
    /** Optional logger for tracking removal operations */
    logger?: Logger | undefined;
}
interface RemovePieceOptionsWithWaitForConfirmation extends RemovePieceOptionsBase {
    waitForConfirmation: true;
    synapse: Synapse;
}
export type RemovePieceOptions = RemovePieceOptionsBase | RemovePieceOptionsWithWaitForConfirmation;
/**
 * Remove a piece from a Data Set
 *
 * @example
 * ```typescript
 * const txHash = await removePiece('baga...', storageContext, {
 *   synapse,
 *   onProgress: (event) => console.log(event.type),
 *   waitForConfirmation: true
 * })
 * ```
 *
 * Process:
 * 1. Submit the transaction via storageContext.deletePiece
 * 2. Optionally wait for confirmation using Synapse provider
 * 3. Emit progress events for each stage
 *
 * @param pieceCid - Piece CID to remove
 * @param storageContext - Storage context bound to a Data Set
 * @param options - Callbacks and confirmation settings (synapse required if waiting)
 * @returns Transaction hash of the removal
 */
export declare function removePiece(pieceCid: string, storageContext: StorageContext, options: RemovePieceOptions): Promise<`0x${string}` | string>;
export {};
//# sourceMappingURL=remove-piece.d.ts.map