Class PackageDownloader

constructor

• new PackageDownloader(logger?: SoloLogger): PackageDownloader

  Parameters

  • Optionallogger: SoloLogger

  Returns PackageDownloader

Optional Readonlylogger

computeFileHash

• computeFileHash(this: any, filePath: string, algo?: string): Promise<string>

  Compute hash of the file contents

  Parameters

  • this: any
  • filePath: string

    path of the file
  • Optionalalgo: string = 'sha384'

    hash algorithm

  Returns Promise<string>

  hex digest of the computed hash

  Throws

  • if the file cannot be read

fetchFile

• fetchFile(url: string, destinationPath: string): Promise<string>

  Fetch data from a URL and save the output to a file

  Parameters

  • url: string

    source file URL
  • destinationPath: string

  Returns Promise<string>

fetchPackage

• fetchPackage(
      packageURL: string,
      checksumURL: string,
      destinationDirectory: string,
      algo?: string,
      force?: boolean,
  ): Promise<string>

  Fetch a remote package

  Parameters

  • packageURL: string
  • checksumURL: string

    package checksum URL
  • destinationDirectory: string

    a directory where the files should be downloaded to
  • Optionalalgo: string = 'sha256'

    checksum algo
  • Optionalforce: boolean = false

    force download even if the file exists in the destinationDirectory

  Returns Promise<string>

fetchPlatform

• fetchPlatform(
      tag: string,
      destinationDirectory: string,
      force?: boolean,
  ): Promise<string>

  Fetch Hedera platform release artifact

  It fetches the build.zip file containing the release from a URL like: https://builds.hedera.com/node/software/v0.40/build-v0.40.4.zip

  Parameters

  • tag: string

    full semantic version e.g. v0.40.4
  • destinationDirectory: string

    directory where the artifact needs to be saved
  • Optionalforce: boolean = false

    whether to download even if the file exists

  Returns Promise<string>

  full path to the downloaded file

isValidURL

• isValidURL(url: string): boolean

  Parameters

  • url: string

  Returns boolean

urlExists

• urlExists(url: string): Promise<boolean>

  Parameters

  • url: string

  Returns Promise<boolean>

verifyChecksum

• verifyChecksum(
      sourceFile: string,
      checksum: string,
      algo?: string,
  ): Promise<void>

  Verifies that the checksum of the sourceFile matches with the contents of the checksumFile

  It throws error if the checksum doesn't match.

  Parameters

  • sourceFile: string

    path to the file for which checksum to be computed
  • checksum: string

    expected checksum
  • Optionalalgo: string = 'sha256'

    hash algorithm to be used to compute checksum

  Returns Promise<void>

  Throws

  • if the checksum doesn't match