Class BundlrClient

Represents the BundlrClient for handling file uploads and downloads using the Bundlr network.

Hierarchy

StorageModule
- BundlrClient

Index

Constructors

Properties

Methods

bundlr download downloadJson fund getUploadPriceForBytes getUploadPriceForFile getUploadPriceForFiles honeycomb install upload uploadAll uploadJson

Constructors

constructor

new BundlrClient(options?): BundlrClient
Constructs a new BundlrClient instance with the specified options.
Parameters
- Optional options: BundlrOptions
  
  The options to configure the BundlrClient.
Returns BundlrClient
Overrides StorageModule.constructor
- Defined in packages/hive-control/modules/Storage/BundlrClient.d.ts:38

Properties

`Protected` _honeycomb

_honeycomb: Honeycomb

Methods

bundlr

bundlr(): Promise<default | default>
Retrieves the Bundlr instance used for file uploads and downloads.

Returns Promise<default | default>
A Promise resolving to the Bundlr instance.
Overrides StorageModule.bundlr
- Defined in packages/hive-control/modules/Storage/BundlrClient.d.ts:46

download

download(uri): Promise<HoneycombFile>
Downloads a HoneycombFile from the provided URI.
Parameters
- uri: string
  
  The URI of the file to download.
Returns Promise<HoneycombFile>
The downloaded HoneycombFile.
Inherited from StorageModule.download
- Defined in packages/hive-control/modules/Storage/StorageModule.d.ts:56

downloadJson

downloadJson<T>(uri): Promise<T>
Downloads a JSON object from the provided URI.
Type Parameters
- T extends object = object
Parameters
- uri: string
  
  The URI of the JSON object to download.
Returns Promise<T>
The downloaded JSON object.
Inherited from StorageModule.downloadJson
- Defined in packages/hive-control/modules/Storage/StorageModule.d.ts:62

fund

fund(amount, skipBalanceCheck?): Promise<any>
Funds the Bundlr account with the specified amount of tokens.
Parameters
- amount: Amount
  
  The amount to fund the Bundlr account with.
- Optional skipBalanceCheck: boolean
  
  Whether to skip the balance check and always fund the account.
Returns Promise<any>
A Promise resolving to void.
- Defined in packages/hive-control/modules/Storage/BundlrClient.d.ts:71

getUploadPriceForBytes

getUploadPriceForBytes(bytes): Promise<Amount>
Retrieves the upload price for a specified number of bytes.
Parameters
- bytes: number
  
  The number of bytes to calculate the upload price for.
Returns Promise<Amount>
A Promise resolving to the upload price in the form of an Amount.
Overrides StorageModule.getUploadPriceForBytes
- Defined in packages/hive-control/modules/Storage/BundlrClient.d.ts:52

getUploadPriceForFile

getUploadPriceForFile(file): Promise<Amount>
Retrieves the upload price for a HoneycombFile.
Parameters
- file: HoneycombFile
  
  The HoneycombFile for which to calculate the upload price.
Returns Promise<Amount>
A Promise resolving to the upload price in the form of an Amount.
Overrides StorageModule.getUploadPriceForFile
- Defined in packages/hive-control/modules/Storage/BundlrClient.d.ts:58

getUploadPriceForFiles

getUploadPriceForFiles(files): Promise<Amount>
Retrieves the upload price for an array of HoneycombFiles.
Parameters
- files: HoneycombFile[]
  
  An array of HoneycombFiles to calculate the upload price for.
Returns Promise<Amount>
A Promise resolving to the upload price in the form of an Amount.
Overrides StorageModule.getUploadPriceForFiles
- Defined in packages/hive-control/modules/Storage/BundlrClient.d.ts:64

honeycomb

honeycomb(): Honeycomb
Get the Honeycomb client instance associated with the module.

Returns Honeycomb
The Honeycomb client instance.
Inherited from StorageModule.honeycomb
- Defined in packages/hive-control/Abstracts.d.ts:13

install

install(honeycomb): Honeycomb
Installs the BundlrClient into the Honeycomb instance.
Parameters
- honeycomb: Honeycomb
  
  The Honeycomb instance to install the BundlrClient into.
Returns Honeycomb
The Honeycomb instance with the BundlrClient installed.
Overrides StorageModule.install
- Defined in packages/hive-control/modules/Storage/BundlrClient.d.ts:89

upload

upload(file): Promise<string>
Uploads a HoneycombFile to the Bundlr storage.
Parameters
- file: HoneycombFile
  
  The HoneycombFile to upload.
Returns Promise<string>
A Promise resolving to the URI of the uploaded file.
Overrides StorageModule.upload
- Defined in packages/hive-control/modules/Storage/BundlrClient.d.ts:83

uploadAll

uploadAll(files): Promise<string[]>
Uploads an array of HoneycombFiles to the Bundlr storage.
Parameters
- files: HoneycombFile[]
  
  An array of HoneycombFiles to upload.
Returns Promise<string[]>
A Promise resolving to an array of URIs for the uploaded files.
Overrides StorageModule.uploadAll
- Defined in packages/hive-control/modules/Storage/BundlrClient.d.ts:77

uploadJson

uploadJson<T>(json): Promise<string>
Uploads a JSON object to the Honeycomb storage.
Type Parameters
- T extends object = object
Parameters
- json: T
  
  The JSON object to upload.
Returns Promise<string>
The URI of the uploaded file.
Inherited from StorageModule.uploadJson
- Defined in packages/hive-control/modules/Storage/StorageModule.d.ts:50

Generated using TypeDoc