Class StorageHandler

Hierarchy

StorageHandler

Implements

IStorageHandler

Index

Constructors

`Private` constructor

new StorageHandler(wallet): StorageHandler
Private
Receives properties from trackStorage() instantiate StorageHandler.
Parameters
- wallet: IWalletHandler
  
  Query or signing WalletHandler instance.
Returns StorageHandler
- Defined in src/classes/storageHandler.ts:30

Properties

`Private` `Readonly` qH

qH: IQueryHandler

`Private` `Readonly` sharingRoot

sharingRoot: "s/Sharing" = 's/Sharing'

Manage FT Noti

`Private` `Readonly` walletRef

walletRef: IWalletHandler

Methods

buyStorage

buyStorage(forAddress, duration, space): Promise<DeliverTxResponse>
Purchase storage for specified address that does not currently have storage. For existing see upgradeStorage().
Parameters
- forAddress: string
  
  Jkl address to receive the purchased storage.
- duration: number
  
  How long in months to purchase the storage.
- space: number
  
  Amount of effective storage to purchase in TB.
Returns Promise<DeliverTxResponse>
- Result of purchase broadcast.
Implementation of IStorageHandler.buyStorage
- Defined in src/classes/storageHandler.ts:51

getAllStrays

getAllStrays(): Promise<IStray[]>
Find all strays in the storage deals system.

Returns Promise<IStray[]>
Implementation of IStorageHandler.getAllStrays
- Defined in src/classes/storageHandler.ts:112

getClientFreeSpace

getClientFreeSpace(address): Promise<number>
Determine how much space jkl address has remaining.
Parameters
- address: string
  
  Jkl address to check.
Returns Promise<number>
- Remaining space in bytes.
Implementation of IStorageHandler.getClientFreeSpace
- Defined in src/classes/storageHandler.ts:126

getPayData

getPayData(address): Promise<IPayData>
Determine what storage plan (if any) has been purchased for the provided jkl address.
Parameters
- address: string
  
  Jkl address to check.
Returns Promise<IPayData>
- Storage plan details.
Implementation of IStorageHandler.getPayData
- Defined in src/classes/storageHandler.ts:150

getStorageJklPrice

getStorageJklPrice(space, duration): Promise<number>
Determine current price in $JKL of specified size and duration of storage.
Parameters
- space: number
  
  Amount of effective space to use for price check.
- duration: number
  
  Amount of time to use for price check.
Returns Promise<number>
- Estimated price of specified storage in ujkl.
Implementation of IStorageHandler.getStorageJklPrice
- Defined in src/classes/storageHandler.ts:137

getStoragePaymentInfo

getStoragePaymentInfo(address): Promise<IStoragePaymentInfo>
Determine space used and available for provided jkl address.
Parameters
- address: string
  
  Jkl address to check.
Returns Promise<IStoragePaymentInfo>
- Space used and available. Defaults to zeros when nothing is found.
Implementation of IStorageHandler.getStoragePaymentInfo
- Defined in src/classes/storageHandler.ts:159

makeStorageInitMsg

makeStorageInitMsg(): EncodeObject
Initialize address' storage system. Replaces WalletHandler.initAccount().

Returns EncodeObject
- Postkey msg ready for broadcast.
Implementation of IStorageHandler.makeStorageInitMsg
- Defined in src/classes/storageHandler.ts:98

readSharing

readSharing(owner, receiverAddress): Promise<ISharedTracker>
Read data saved with saveSharing(). accessible by owner and sharing receiver.
Parameters
- owner: string
  
  data owner's jkl address.
- receiverAddress: string
  
  Jkl address receiving sharing data.
Returns Promise<ISharedTracker>
- Bundle of all records shared with receiver.
Implementation of IStorageHandler.readSharing
- Defined in src/classes/storageHandler.ts:196

saveSharing

saveSharing(receiverAddress, shared): Promise<EncodeObject>
Save data to file sharing address. Overwrites existing data. Savable only by owner.
Parameters
- receiverAddress: string
  
  Jkl address receiving sharing data.
- shared: ISharedTracker
  
  Bundle of all records shared with receiverAddress.
Returns Promise<EncodeObject>
- PostFile msg ready for broadcast.
Implementation of IStorageHandler.saveSharing
- Defined in src/classes/storageHandler.ts:175

stopSharing

stopSharing(receiverAddress): Promise<EncodeObject>
Remove all sharing data for specified receiver.
Parameters
- receiverAddress: string
  
  Jkl address receiving sharing data.
Returns Promise<EncodeObject>
- DeleteFile msg ready for broadcast.
Implementation of IStorageHandler.stopSharing
- Defined in src/classes/storageHandler.ts:219

upgradeStorage

upgradeStorage(forAddress, duration, space): Promise<DeliverTxResponse>
Purchase storage for specified address that currently has storage. For new see buyStorage().
Parameters
- forAddress: string
  
  Jkl address to receive the purchased storage.
- duration: number
  
  How long in months to purchase the storage.
- space: number
  
  Amount of effective storage to purchase in TB.
Returns Promise<DeliverTxResponse>
- Result of purchase broadcast.
Implementation of IStorageHandler.upgradeStorage
- Defined in src/classes/storageHandler.ts:76

`Static` trackStorage

trackStorage(wallet): Promise<IStorageHandler>
Creates StorageHandler instance.
Parameters
- wallet: IWalletHandler
  
  Query or signing WalletHandler instance.
Returns Promise<IStorageHandler>
- StorageHandler instance linked to provided WalletHandler instance.
- Defined in src/classes/storageHandler.ts:40

Class StorageHandler

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

wallet: IWalletHandler

Returns StorageHandler

Properties

Private Readonly qH

Private Readonly sharingRoot

Private Readonly walletRef

Methods

buyStorage

Parameters

forAddress: string

duration: number

space: number

Returns Promise<DeliverTxResponse>

getAllStrays

Returns Promise<IStray[]>

getClientFreeSpace

Parameters

address: string

Returns Promise<number>

getPayData

Parameters

address: string

Returns Promise<IPayData>

getStorageJklPrice

Parameters

space: number

duration: number

Returns Promise<number>

getStoragePaymentInfo

Parameters

address: string

Returns Promise<IStoragePaymentInfo>

makeStorageInitMsg

Returns EncodeObject

readSharing

Parameters

owner: string

receiverAddress: string

Returns Promise<ISharedTracker>

saveSharing

Parameters

receiverAddress: string

shared: ISharedTracker

Returns Promise<EncodeObject>

stopSharing

Parameters

receiverAddress: string

Returns Promise<EncodeObject>

upgradeStorage

Parameters

forAddress: string

duration: number

space: number

Returns Promise<DeliverTxResponse>

Static trackStorage

Parameters

wallet: IWalletHandler

Returns Promise<IStorageHandler>

Settings

Member Visibility

Theme

On This Page

`Private` constructor

`Private` `Readonly` qH

`Private` `Readonly` sharingRoot

`Private` `Readonly` walletRef

`Static` trackStorage