filecoin-pin
    Preparing search index...

    Interface UploadReadinessResult

    Result of the payment readiness check prior to upload.

    interface UploadReadinessResult {
        allowances: {
            needsUpdate: boolean;
            transactionHash?: string;
            updated: boolean;
        };
        capacity?: PaymentCapacityCheck;
        filStatus: {
            balance: bigint;
            hasSufficientGas: boolean;
            isCalibnet: boolean;
        };
        status: "ready"
        | "blocked";
        suggestions: string[];
        validation: {
            errorMessage?: string;
            helpMessage?: string;
            isValid: boolean;
        };
        walletUsdfcBalance: bigint;
    }
    Index

    Properties

    allowances: { needsUpdate: boolean; transactionHash?: string; updated: boolean }

    Allowance update information.

    Capacity check from Synapse (present even when blocked).

    filStatus: { balance: bigint; hasSufficientGas: boolean; isCalibnet: boolean }

    FIL/gas balance status.

    status: "ready" | "blocked"

    Overall status of the readiness check.

    suggestions: string[]

    Suggestions returned by the capacity check.

    validation: { errorMessage?: string; helpMessage?: string; isValid: boolean }

    Gas + USDFC validation outcome.

    walletUsdfcBalance: bigint

    Wallet USDFC balance.