filecoin-pin
    Preparing search index...

    Variable checkUploadReadiness

    checkUploadReadiness: (
        options: UploadReadinessOptions,
    ) => Promise<UploadReadinessResult>

    Type Declaration

      • (options: UploadReadinessOptions): Promise<UploadReadinessResult>
      • Check readiness for uploading a CAR file.

        This performs the same validation chain previously used by the CLI/action:

        1. Ensure basic wallet requirements (FIL for gas, USDFC balance)
        2. Confirm or configure WarmStorage allowances
        3. Validate that the current deposit can cover the upload

        The function only mutates state when autoConfigureAllowances is enabled (default), in which case it will call setMaxAllowances as needed.

        Session Key Authentication: When using session key authentication, autoConfigureAllowances is automatically disabled since payment operations require the owner wallet to sign. Allowances must be configured separately by the owner wallet before uploads can proceed.

        Parameters

        Returns Promise<UploadReadinessResult>