Interface PinOptionsWithCharges

Extended pin options with custom charges support

interface PinOptionsWithCharges {
    customCharges?: {
        estimatedBreakdown?: IPFSCostBreakdown;
        maxCostOs: string;
    };
    duration?: number;
    fileSize?: number;
    metadata?: Record<string, unknown>;
}

Hierarchy (view full)

Properties

customCharges? duration? fileSize? metadata?

Properties

OptionalcustomCharges

customCharges?: {
    estimatedBreakdown?: IPFSCostBreakdown;
    maxCostOs: string;
}

Optional custom charges configuration for cost control

Type declaration

  • OptionalestimatedBreakdown?: IPFSCostBreakdown

    Optional cost breakdown for reference

  • maxCostOs: string

    Maximum cost user agrees to pay, decimal-string OS (from ipfsQuote response).

Optionalduration

duration?: number

Duration in blocks (0 = indefinite)

OptionalfileSize

fileSize?: number

File size in bytes (required when using custom charges)

Optionalmetadata

metadata?: Record<string, unknown>

Optional metadata to associate with the pin

Settings

Member Visibility

On This Page

Properties