Class StorageHandler

Hierarchy (view full)

EncodingHandler
- StorageHandler

Implements

IStorageHandler

Index

Constructors

Methods

assembleLocation baseFolderToMsgs batchUploads beforeUnloadHandler buildConversion buyStoragePlan checkAndInitSharing checkAndUpcycle checkIfUpcycle checkLocked checkNotifications checkSharedTo cleanShutdown clonePkgToMsgs cloneShares cloneUpload convert createExpiresValue createFolders deleteTargets downloadByUlid downloadExternalFile downloadFile downloadStaging encodeCreateNotification encodeDeleteNotification encodeExecuteContract encodeFileTreeBaseFolder encodeFileTreeFile encodeFileTreeFileShare encodeFileTreeFileShareLink encodeFileTreeFolder encodeFileTreeNull encodeFileTreeRef encodeFileTreeRefShare encodeFileTreeShared encodeFileTreeSharerRef encodeInstantiateContract encodePostKey encodeStorageCloneFile encodeStorageDeleteFile encodeStoragePostFile estimateStoragePlan executeToSpecialMsgs existingFolderToMsgs existingMetaToMsgs existingPkgToMsgs fileDeleteToMsgs filetreeDeleteToMsgs findProviderIps findUlid folderToMsgs getAllProviders getAvailableProviders getFileMetaData getFileParticulars getFolderDetailsByUlid getMetaDataByUlid initCustomRoot initStorage initUlidHome instantiateToMsgs legacyPkgToMsgs listChildFileMetas listChildFiles listChildFolderMetas listChildFolders loadDirectory loadProviderPool loadProvidersFromChain loadShared loadThumbnail makeCreateBaseFolderMsgs makeCreateFolderMsgs makeRenamePkg movePkgToMsgs moveRenameResource pkgToMsgs planStatus possibleRnsToAddress prepDelete prepShare processAllQueues processPendingNotifications processPrivate processPublic purchaseStoragePlan queuePrivate queuePublic readActivePath readChildCount readCurrentLocation readCurrentQueue readCurrentUlid readDirectoryContents readMustConvertStatus readSharing receiveShareToMsgs registerPubKey removeFromQueue removeShareRecord resetReader runUpcycleQueue saveFolder sendShareToMsgs sendUnshareToMsgs shareDirect shareLink shareLinkToMsgs stageQueue storageEncodeFileTree tidyReceivedNotifications ulidFolderToMsgs unshare upcycleBaseFolderToMsgs upcycleFile upgradeSigner enableFullSigner init

Constructors

`Protected` constructor

new StorageHandler(rns, client, jackalSigner, hostSigner, accountAddress, fullSignerState, defaultKeyPair, path, meta): StorageHandler
Parameters
- rns: null | IRnsHandler
- client: IClientHandler
- jackalSigner: TJackalSigningClient
- hostSigner: THostSigningClient
- accountAddress: string
- fullSignerState: TFullSignerState
- defaultKeyPair: PrivateKey
- path: string
- meta: IFolderMetaHandler
Returns StorageHandler
Overrides EncodingHandler.constructor
- Defined in src/classes/storageHandler.ts:90

Properties

`Protected` children

children: IChildMetaDataMap

`Protected` fullSigner

fullSigner: boolean

`Protected` `Readonly` hostAddress

hostAddress: string

`Protected` `Readonly` hostSigner

hostSigner: THostSigningClient

`Protected` `Readonly` jackalClient

jackalClient: IClientHandler

`Protected` `Readonly` jackalSigner

jackalSigner: TJackalSigningClient

`Protected` `Readonly` jklAddress

jklAddress: string

`Protected` keyPair

keyPair: PrivateKey

`Protected` meta

meta: IFolderMetaHandler

`Protected` mustConvert

mustConvert: boolean

`Protected` notifications

notifications: INotificationRecord[]

`Protected` path

path: string

`Protected` `Readonly` proofInterval

proofInterval: number

`Protected` providers

providers: IProviderPool

`Protected` reader

reader: IFiletreeReader

`Protected` `Readonly` rns

rns: null | IRnsHandler

`Protected` stagedUploads

stagedUploads: Record<string, IStagedUploadPackage>

`Protected` upcycleQueue

upcycleQueue: IWrappedEncodeObject[]

`Protected` uploadQueue

uploadQueue: IUploadPackage[]

`Protected` uploadsInProgress

uploadsInProgress: boolean

Methods

`Protected` assembleLocation

assembleLocation(name): string
Protected
Parameters
- name: string
Returns string
- Defined in src/classes/storageHandler.ts:2460

`Protected` baseFolderToMsgs

baseFolderToMsgs(pkg): Promise<IWrappedEncodeObject[]>
Protected
Parameters
- pkg: IFileTreePackage
Returns Promise<IWrappedEncodeObject[]>
Inherited from EncodingHandler.baseFolderToMsgs
- Defined in src/classes/encodingHandler.ts:652

`Protected` batchUploads

batchUploads(msgs, uploadHeight): Promise<Promise<IProviderUploadResponse>[]>
Protected
Parameters
- msgs: IWrappedEncodeObject[]
- uploadHeight: number
Returns Promise<Promise<IProviderUploadResponse>[]>
- Defined in src/classes/storageHandler.ts:2221

`Protected` beforeUnloadHandler

beforeUnloadHandler(ev): void
Protected
Parameters
- ev: BeforeUnloadEvent
Returns void
- Defined in src/classes/storageHandler.ts:2447

`Protected` buildConversion

buildConversion(path): Promise<null | IConversionFolderBundle>
Protected
Parameters
- path: string
Returns Promise<null | IConversionFolderBundle>
- Defined in src/classes/storageHandler.ts:2623

`Protected` buyStoragePlan

buyStoragePlan(receiver, referrer, gb, days): IWrappedEncodeObject
Protected
Parameters
- receiver: string
- referrer: string
- gb: number
- days: number
Returns IWrappedEncodeObject
- Defined in src/classes/storageHandler.ts:2312

checkAndInitSharing

checkAndInitSharing(options?): Promise<IWrappedEncodeObject[]>
Parameters
- Optional options: IBroadcastOrChainOptions
Returns Promise<IWrappedEncodeObject[]>
Implementation of IStorageHandler.checkAndInitSharing
- Defined in src/classes/storageHandler.ts:549

checkAndUpcycle

checkAndUpcycle(options?): Promise<void>
Parameters
- Optional options: IBroadcastOptions
Returns Promise<void>
Implementation of IStorageHandler.checkAndUpcycle
- Defined in src/classes/storageHandler.ts:1817

checkIfUpcycle

checkIfUpcycle(): boolean
Returns boolean
Implementation of IStorageHandler.checkIfUpcycle
- Defined in src/classes/storageHandler.ts:1806

`Protected` checkLocked

checkLocked(checkSet): Promise<boolean>
Protected
Parameters
- checkSet: IChecks
Returns Promise<boolean>
- Defined in src/classes/storageHandler.ts:2540

checkNotifications

checkNotifications(): Promise<number>
Returns Promise<number>
Implementation of IStorageHandler.checkNotifications
- Defined in src/classes/storageHandler.ts:1587

checkSharedTo

checkSharedTo(path): Promise<string[]>
Parameters
- path: string
Returns Promise<string[]>
Implementation of IStorageHandler.checkSharedTo
- Defined in src/classes/storageHandler.ts:1406

cleanShutdown

cleanShutdown(): void
Returns void
Implementation of IStorageHandler.cleanShutdown
- Defined in src/classes/storageHandler.ts:273

`Protected` clonePkgToMsgs

clonePkgToMsgs(pkg, blockHeight): Promise<IWrappedEncodeObject[]>
Protected
Parameters
- pkg: IClonePackage
- blockHeight: number
Returns Promise<IWrappedEncodeObject[]>
Inherited from EncodingHandler.clonePkgToMsgs
- Defined in src/classes/encodingHandler.ts:846

`Protected` createExpiresValue

createExpiresValue(source, currentBlock): number
Protected
Parameters
- source: number
- currentBlock: number
Returns number
Inherited from EncodingHandler.createExpiresValue
- Defined in src/classes/encodingHandler.ts:1210

createFolders

createFolders(options): Promise<IWrappedEncodeObject[]>
Parameters
- options: ICreateFolderOptions
Returns Promise<IWrappedEncodeObject[]>
Implementation of IStorageHandler.createFolders
- Defined in src/classes/storageHandler.ts:646

deleteTargets

deleteTargets(options): Promise<IWrappedEncodeObject[]>
Parameters
- options: IDeleteTargetOptions
Returns Promise<IWrappedEncodeObject[]>
Implementation of IStorageHandler.deleteTargets
- Defined in src/classes/storageHandler.ts:1371

downloadByUlid

downloadByUlid(options): Promise<File>
Parameters
- options: IDownloadByUlidOptions
Returns Promise<File>
Implementation of IStorageHandler.downloadByUlid
- Defined in src/classes/storageHandler.ts:1323

downloadExternalFile

downloadExternalFile(userAddress, filePath, trackers): Promise<File>
Parameters
- userAddress: string
- filePath: string
- trackers: IDownloadTracker
Returns Promise<File>
Implementation of IStorageHandler.downloadExternalFile
- Defined in src/classes/storageHandler.ts:1280

downloadFile

downloadFile(filePath, trackers): Promise<File>
Parameters
- filePath: string
- trackers: IDownloadTracker
Returns Promise<File>
Implementation of IStorageHandler.downloadFile
- Defined in src/classes/storageHandler.ts:1266

`Protected` downloadStaging

downloadStaging(options): Promise<File>
Protected
Parameters
- options: TDownloadStagingOptions
Returns Promise<File>
- Defined in src/classes/storageHandler.ts:1971

`Protected` encodeCreateNotification

encodeCreateNotification(pkg): Promise<EncodeObject>
Protected
Parameters
- pkg: INotificationPackage
Returns Promise<EncodeObject>
Inherited from EncodingHandler.encodeCreateNotification
- Defined in src/classes/encodingHandler.ts:570

`Protected` encodeDeleteNotification

encodeDeleteNotification(pkg): Promise<EncodeObject>
Protected
Parameters
- pkg: INotificationDeletePackage
Returns Promise<EncodeObject>
Inherited from EncodingHandler.encodeDeleteNotification
- Defined in src/classes/encodingHandler.ts:606

`Protected` encodeExecuteContract

encodeExecuteContract(contractAddress, execMsg): EncodeObject
Protected
Parameters
- contractAddress: string
- execMsg: EncodeObject
Returns EncodeObject
Inherited from EncodingHandler.encodeExecuteContract
- Defined in src/classes/encodingHandler.ts:145

`Protected` encodeFileTreeBaseFolder

encodeFileTreeBaseFolder(pkg): Promise<EncodeObject>
Protected
Parameters
- pkg: IFileTreePackage
Returns Promise<EncodeObject>
Inherited from EncodingHandler.encodeFileTreeBaseFolder
- Defined in src/classes/encodingHandler.ts:432

`Protected` encodeFileTreeFile

encodeFileTreeFile(pkg): Promise<EncodeObject>
Protected
Parameters
- pkg: IClonePackage | IUploadPackage
Returns Promise<EncodeObject>
Inherited from EncodingHandler.encodeFileTreeFile
- Defined in src/classes/encodingHandler.ts:333

`Protected` encodeFileTreeFileShare

encodeFileTreeFileShare(ulid, addViewers, removeViewers): Promise<EncodeObject>
Protected
Parameters
- ulid: string
- addViewers: string[]
- removeViewers: string[]
Returns Promise<EncodeObject>
Inherited from EncodingHandler.encodeFileTreeFileShare
- Defined in src/classes/encodingHandler.ts:384

`Protected` encodeFileTreeFileShareLink

encodeFileTreeFileShareLink(ulid, link): Promise<EncodeObject>
Protected
Parameters
- ulid: string
- link: string
Returns Promise<EncodeObject>
Inherited from EncodingHandler.encodeFileTreeFileShareLink
- Defined in src/classes/encodingHandler.ts:409

`Protected` encodeFileTreeFolder

encodeFileTreeFolder(pkg): Promise<EncodeObject>
Protected
Parameters
- pkg: IFileTreePackage
Returns Promise<EncodeObject>
Inherited from EncodingHandler.encodeFileTreeFolder
- Defined in src/classes/encodingHandler.ts:458

`Protected` encodeFileTreeNull

encodeFileTreeNull(pkg): Promise<EncodeObject>
Protected
Parameters
- pkg: IFileTreePackage
Returns Promise<EncodeObject>
Inherited from EncodingHandler.encodeFileTreeNull
- Defined in src/classes/encodingHandler.ts:505

`Protected` encodeFileTreeRef

encodeFileTreeRef(pkg): Promise<EncodeObject>
Protected
Parameters
- pkg: IFileTreePackage | IUploadPackage
Returns Promise<EncodeObject>
Inherited from EncodingHandler.encodeFileTreeRef
- Defined in src/classes/encodingHandler.ts:524

`Protected` encodeFileTreeRefShare

encodeFileTreeRefShare(ulid, index, addViewers, removeViewers): Promise<EncodeObject>
Protected
Parameters
- ulid: string
- index: number
- addViewers: string[]
- removeViewers: string[]
Returns Promise<EncodeObject>
Inherited from EncodingHandler.encodeFileTreeRefShare
- Defined in src/classes/encodingHandler.ts:356

`Protected` encodeFileTreeShared

encodeFileTreeShared(pkg): Promise<EncodeObject>
Protected
Parameters
- pkg: IFileTreePackage
Returns Promise<EncodeObject>
Inherited from EncodingHandler.encodeFileTreeShared
- Defined in src/classes/encodingHandler.ts:486

`Protected` encodeFileTreeSharerRef

encodeFileTreeSharerRef(pkg): Promise<EncodeObject>
Protected
Parameters
- pkg: IFileTreePackage
Returns Promise<EncodeObject>
Inherited from EncodingHandler.encodeFileTreeSharerRef
- Defined in src/classes/encodingHandler.ts:551

`Protected` encodeInstantiateContract

encodeInstantiateContract(connectionIdA, connectionIdB, codeId, label): EncodeObject
Protected
Parameters
- connectionIdA: string
- connectionIdB: string
- codeId: number
- label: string
Returns EncodeObject
Inherited from EncodingHandler.encodeInstantiateContract
- Defined in src/classes/encodingHandler.ts:109

`Protected` encodePostKey

encodePostKey(key): EncodeObject
Protected
Parameters
- key: string
Returns EncodeObject
Inherited from EncodingHandler.encodePostKey
- Defined in src/classes/encodingHandler.ts:237

`Protected` encodeStorageCloneFile

encodeStorageCloneFile(pkg, currentBlock): EncodeObject
Parameters
- pkg: IClonePackage
- currentBlock: number
Returns EncodeObject
Inherited from EncodingHandler.encodeStorageCloneFile
- Defined in src/classes/encodingHandler.ts:269

`Protected` encodeStorageDeleteFile

encodeStorageDeleteFile(item): EncodeObject
Protected
Parameters
- item: UnifiedFile
Returns EncodeObject
Inherited from EncodingHandler.encodeStorageDeleteFile
- Defined in src/classes/encodingHandler.ts:292

`Protected` encodeStoragePostFile

encodeStoragePostFile(pkg, currentBlock): EncodeObject
Protected
Parameters
- pkg: IUploadPackage
- currentBlock: number
Returns EncodeObject
Inherited from EncodingHandler.encodeStoragePostFile
- Defined in src/classes/encodingHandler.ts:252

estimateStoragePlan

estimateStoragePlan(options): Promise<number>
Parameters
- options: IBuyStorageOptions
Returns Promise<number>
Implementation of IStorageHandler.estimateStoragePlan
- Defined in src/classes/storageHandler.ts:606

`Protected` executeToSpecialMsgs

executeToSpecialMsgs(contractAddress, execs): EncodeObject[]
Protected
Parameters
- contractAddress: string
- execs: EncodeObject | EncodeObject[]
Returns EncodeObject[]
Inherited from EncodingHandler.executeToSpecialMsgs
- Defined in src/classes/encodingHandler.ts:211

`Protected` existingFolderToMsgs

existingFolderToMsgs(pkg): Promise<IWrappedEncodeObject[]>
Protected
Parameters
- pkg: IFileTreePackage
Returns Promise<IWrappedEncodeObject[]>
Inherited from EncodingHandler.existingFolderToMsgs
- Defined in src/classes/encodingHandler.ts:706

`Protected` existingMetaToMsgs

existingMetaToMsgs(pkg): Promise<IWrappedEncodeObject[]>
Protected
Parameters
- pkg: IFileTreePackage
Returns Promise<IWrappedEncodeObject[]>
Inherited from EncodingHandler.existingMetaToMsgs
- Defined in src/classes/encodingHandler.ts:971

`Protected` existingPkgToMsgs

existingPkgToMsgs(toReplace, pkg, blockHeight): Promise<IWrappedEncodeObject[]>
Protected
Parameters
- toReplace: UnifiedFile
- pkg: IUploadPackage
- blockHeight: number
Returns Promise<IWrappedEncodeObject[]>
Inherited from EncodingHandler.existingPkgToMsgs
- Defined in src/classes/encodingHandler.ts:935

`Protected` fileDeleteToMsgs

fileDeleteToMsgs(filePkg): IWrappedEncodeObject[]
Protected
Parameters
- filePkg: IFileDeletePackage
Returns IWrappedEncodeObject[]
Inherited from EncodingHandler.fileDeleteToMsgs
- Defined in src/classes/encodingHandler.ts:787

`Protected` filetreeDeleteToMsgs

filetreeDeleteToMsgs(pkg): Promise<IWrappedEncodeObject[]>
Protected
Parameters
- pkg: IFileTreePackage
Returns Promise<IWrappedEncodeObject[]>
Inherited from EncodingHandler.filetreeDeleteToMsgs
- Defined in src/classes/encodingHandler.ts:760

findProviderIps

findProviderIps(providers): Promise<IProviderIpSet>
Parameters
- providers: string[]
Returns Promise<IProviderIpSet>
Implementation of IStorageHandler.findProviderIps
- Defined in src/classes/storageHandler.ts:442

findUlid

findUlid(path, address?): string
Parameters
- path: string
- Optional address: string
Returns string
Implementation of IStorageHandler.findUlid
- Defined in src/classes/storageHandler.ts:1202

`Protected` folderToMsgs

folderToMsgs(pkg): Promise<IWrappedEncodeObject[]>
Protected
Parameters
- pkg: IFileTreePackage
Returns Promise<IWrappedEncodeObject[]>
Inherited from EncodingHandler.folderToMsgs
- Defined in src/classes/encodingHandler.ts:679

`Protected` getAllProviders

getAllProviders(): Promise<IProviderIpSet>
Protected
Returns Promise<IProviderIpSet>
- Defined in src/classes/storageHandler.ts:2204

getAvailableProviders

getAvailableProviders(): Promise<string[]>
Returns Promise<string[]>
Implementation of IStorageHandler.getAvailableProviders
- Defined in src/classes/storageHandler.ts:422

getFileMetaData

getFileMetaData(filePath, address?): Promise<IFileMetaData>
Parameters
- filePath: string
- Optional address: string
Returns Promise<IFileMetaData>
Implementation of IStorageHandler.getFileMetaData
- Defined in src/classes/storageHandler.ts:1217

getFileParticulars

getFileParticulars(filePath, address?): Promise<IFileParticulars>
Parameters
- filePath: string
- Optional address: string
Returns Promise<IFileParticulars>
Implementation of IStorageHandler.getFileParticulars
- Defined in src/classes/storageHandler.ts:1236

getFolderDetailsByUlid

getFolderDetailsByUlid(options): Promise<IChildMetaDataMap>
Parameters
- options: IMetaDataByUlidOptions
Returns Promise<IChildMetaDataMap>
Implementation of IStorageHandler.getFolderDetailsByUlid
- Defined in src/classes/storageHandler.ts:1185

getMetaDataByUlid

getMetaDataByUlid(options): Promise<TMetaDataSets>
Parameters
- options: IMetaDataByUlidOptions
Returns Promise<TMetaDataSets>
Implementation of IStorageHandler.getMetaDataByUlid
- Defined in src/classes/storageHandler.ts:1171

initCustomRoot

initCustomRoot(options): Promise<IWrappedEncodeObject[]>
Parameters
- options: ICustomRootOptions
Returns Promise<IWrappedEncodeObject[]>
Implementation of IStorageHandler.initCustomRoot
- Defined in src/classes/storageHandler.ts:524

initStorage

initStorage(options?): Promise<IWrappedEncodeObject[]>
Parameters
- Optional options: IBroadcastOrChainOptions
Returns Promise<IWrappedEncodeObject[]>
Implementation of IStorageHandler.initStorage
- Defined in src/classes/storageHandler.ts:494

`Protected` initUlidHome

initUlidHome(): Promise<IWrappedEncodeObject[]>
Protected
Returns Promise<IWrappedEncodeObject[]>
- Defined in src/classes/storageHandler.ts:2278

`Protected` instantiateToMsgs

instantiateToMsgs(connectionIdA, connectionIdB, codeId): IWrappedEncodeObject[]
Protected
Parameters
- connectionIdA: string
- connectionIdB: string
- codeId: number
Returns IWrappedEncodeObject[]
Inherited from EncodingHandler.instantiateToMsgs
- Defined in src/classes/encodingHandler.ts:181

`Protected` legacyPkgToMsgs

legacyPkgToMsgs(pkg): Promise<IWrappedEncodeObject[]>
Protected
Parameters
- pkg: IUploadPackage
Returns Promise<IWrappedEncodeObject[]>
Inherited from EncodingHandler.legacyPkgToMsgs
- Defined in src/classes/encodingHandler.ts:906

listChildFileMetas

listChildFileMetas(): IFileMetaData[]
Returns IFileMetaData[]
Implementation of IStorageHandler.listChildFileMetas
- Defined in src/classes/storageHandler.ts:397

listChildFiles

listChildFiles(): string[]
Returns string[]
Implementation of IStorageHandler.listChildFiles
- Defined in src/classes/storageHandler.ts:385

listChildFolderMetas

listChildFolderMetas(): IFolderMetaData[]
Returns IFolderMetaData[]
Implementation of IStorageHandler.listChildFolderMetas
- Defined in src/classes/storageHandler.ts:377

listChildFolders

listChildFolders(): string[]
Returns string[]
Implementation of IStorageHandler.listChildFolders
- Defined in src/classes/storageHandler.ts:365

loadDirectory

loadDirectory(options?): Promise<void>
Parameters
- Optional options: IReadFolderContentOptions = {}
Returns Promise<void>
Implementation of IStorageHandler.loadDirectory
- Defined in src/classes/storageHandler.ts:313

loadProviderPool

loadProviderPool(providers?): Promise<void>
Parameters
- Optional providers: IProviderIpSet
Returns Promise<void>
Implementation of IStorageHandler.loadProviderPool
- Defined in src/classes/storageHandler.ts:465

`Protected` loadProvidersFromChain

loadProvidersFromChain(): Promise<IProviderIpSet>
Protected
Returns Promise<IProviderIpSet>
- Defined in src/classes/storageHandler.ts:2189

loadShared

loadShared(): Promise<void>
Returns Promise<void>
Implementation of IStorageHandler.loadShared
- Defined in src/classes/storageHandler.ts:351

loadThumbnail

loadThumbnail(options): Promise<string>
Parameters
- options: TLoadThumbnailOptions
Returns Promise<string>
Implementation of IStorageHandler.loadThumbnail
- Defined in src/classes/storageHandler.ts:1152

`Protected` makeCreateBaseFolderMsgs

makeCreateBaseFolderMsgs(name, count?): Promise<IWrappedEncodeObject[]>
Protected
Parameters
- name: string
- Optional count: number
Returns Promise<IWrappedEncodeObject[]>
- Defined in src/classes/storageHandler.ts:2368

`Protected` makeCreateFolderMsgs

makeCreateFolderMsgs(name, position): Promise<IWrappedEncodeObject[]>
Protected
Parameters
- name: string
- position: number
Returns Promise<IWrappedEncodeObject[]>
- Defined in src/classes/storageHandler.ts:2341

`Protected` makeRenamePkg

makeRenamePkg(target, movedTo?): Promise<IFileTreePackage>
Protected
Parameters
- target: IMoveRenameTarget
- Optional movedTo: string
Returns Promise<IFileTreePackage>
- Defined in src/classes/storageHandler.ts:2121

`Protected` movePkgToMsgs

movePkgToMsgs(pkg): Promise<IWrappedEncodeObject[]>
Protected
Parameters
- pkg: IFileTreePackage
Returns Promise<IWrappedEncodeObject[]>
Inherited from EncodingHandler.movePkgToMsgs
- Defined in src/classes/encodingHandler.ts:879

moveRenameResource

moveRenameResource(options): Promise<IWrappedEncodeObject[]>
Parameters
- options: IMoveRenameResourceOptions
Returns Promise<IWrappedEncodeObject[]>
Implementation of IStorageHandler.moveRenameResource
- Defined in src/classes/storageHandler.ts:777

`Protected` pkgToMsgs

pkgToMsgs(pkg, blockHeight): Promise<IWrappedEncodeObject[]>
Protected
Parameters
- pkg: IUploadPackage
- blockHeight: number
Returns Promise<IWrappedEncodeObject[]>
Inherited from EncodingHandler.pkgToMsgs
- Defined in src/classes/encodingHandler.ts:810

planStatus

planStatus(): Promise<IStorageStatus>
Returns Promise<IStorageStatus>
Implementation of IStorageHandler.planStatus
- Defined in src/classes/storageHandler.ts:585

`Protected` possibleRnsToAddress

possibleRnsToAddress(name): Promise<string>
Protected
Parameters
- name: string
Returns Promise<string>
- Defined in src/classes/storageHandler.ts:2257

`Protected` prepDelete

prepDelete(target): Promise<IWrappedEncodeObject[]>
Protected
Parameters
- target: string
Returns Promise<IWrappedEncodeObject[]>
- Defined in src/classes/storageHandler.ts:2393

`Protected` prepShare

prepShare(pkg): Promise<IShareResults>
Protected
Parameters
- pkg: TSharePackage
Returns Promise<IShareResults>
- Defined in src/classes/storageHandler.ts:1912

processAllQueues

processAllQueues(options?): Promise<void>
Parameters
- Optional options: IBroadcastOptions
Returns Promise<void>
Implementation of IStorageHandler.processAllQueues
- Defined in src/classes/storageHandler.ts:1099

processPendingNotifications

processPendingNotifications(options?): Promise<IWrappedEncodeObject[]>
Parameters
- Optional options: IBroadcastOrChainOptions
Returns Promise<IWrappedEncodeObject[]>
Implementation of IStorageHandler.processPendingNotifications
- Defined in src/classes/storageHandler.ts:1613

`Protected` processPrivate

processPrivate(toProcess, duration): Promise<IUploadPackage>
Protected
Parameters
- toProcess: File
- duration: number
Returns Promise<IUploadPackage>
- Defined in src/classes/storageHandler.ts:2471

`Protected` processPublic

processPublic(toProcess, duration): Promise<IUploadPackage>
Protected
Parameters
- toProcess: File
- duration: number
Returns Promise<IUploadPackage>
- Defined in src/classes/storageHandler.ts:2516

purchaseStoragePlan

purchaseStoragePlan(options): Promise<IWrappedEncodeObject[]>
Parameters
- options: IBuyStorageOptions
Returns Promise<IWrappedEncodeObject[]>
Implementation of IStorageHandler.purchaseStoragePlan
- Defined in src/classes/storageHandler.ts:624

queuePrivate

queuePrivate(toQueue, duration?): Promise<number>
Parameters
- toQueue: File | File[]
- Optional duration: number = 0
Returns Promise<number>
Implementation of IStorageHandler.queuePrivate
- Defined in src/classes/storageHandler.ts:940

queuePublic

queuePublic(toQueue, duration?): Promise<number>
Parameters
- toQueue: File | File[]
- Optional duration: number = 0
Returns Promise<number>
Implementation of IStorageHandler.queuePublic
- Defined in src/classes/storageHandler.ts:970

readActivePath

readActivePath(): string
Returns string
Implementation of IStorageHandler.readActivePath
- Defined in src/classes/storageHandler.ts:870

readChildCount

readChildCount(): number
Returns number
Implementation of IStorageHandler.readChildCount
- Defined in src/classes/storageHandler.ts:894

readCurrentLocation

readCurrentLocation(): string
Returns string
Implementation of IStorageHandler.readCurrentLocation
- Defined in src/classes/storageHandler.ts:878

readCurrentQueue

readCurrentQueue(): string[]
Returns string[]
Implementation of IStorageHandler.readCurrentQueue
- Defined in src/classes/storageHandler.ts:916

readCurrentUlid

readCurrentUlid(): string
Returns string
Implementation of IStorageHandler.readCurrentUlid
- Defined in src/classes/storageHandler.ts:886

readDirectoryContents

readDirectoryContents(path, options?): Promise<IChildMetaDataMap>
Parameters
- path: string
- Optional options: IReadFolderContentOptions
Returns Promise<IChildMetaDataMap>
Implementation of IStorageHandler.readDirectoryContents
- Defined in src/classes/storageHandler.ts:338

readMustConvertStatus

readMustConvertStatus(): boolean
Returns boolean
Implementation of IStorageHandler.readMustConvertStatus
- Defined in src/classes/storageHandler.ts:908

readSharing

readSharing(sharer?): Promise<IFolderMetaData[] | IShareMetaData[]>
Parameters
- Optional sharer: string
Returns Promise<IFolderMetaData[] | IShareMetaData[]>
Implementation of IStorageHandler.readSharing
- Defined in src/classes/storageHandler.ts:1757

`Protected` receiveShareToMsgs

receiveShareToMsgs(pkg): Promise<IWrappedEncodeObject[]>
Protected
Parameters
- pkg: IFileTreePackage
Returns Promise<IWrappedEncodeObject[]>
Inherited from EncodingHandler.receiveShareToMsgs
- Defined in src/classes/encodingHandler.ts:1160

registerPubKey

registerPubKey(options?): Promise<IWrappedEncodeObject[]>
Parameters
- Optional options: IBroadcastOrChainOptions
Returns Promise<IWrappedEncodeObject[]>
Implementation of IStorageHandler.registerPubKey
- Defined in src/classes/storageHandler.ts:284

removeFromQueue

removeFromQueue(name): void
Parameters
- name: string
Returns void
Implementation of IStorageHandler.removeFromQueue
- Defined in src/classes/storageHandler.ts:924

removeShareRecord

removeShareRecord(options): Promise<IWrappedEncodeObject[]>
Parameters
- options: IRemoveShareRecordOptions
Returns Promise<IWrappedEncodeObject[]>
Implementation of IStorageHandler.removeShareRecord
- Defined in src/classes/storageHandler.ts:1554

`Protected` resetReader

resetReader(keyPair): Promise<void>
Protected
Parameters
- keyPair: PrivateKey
Returns Promise<void>
Inherited from EncodingHandler.resetReader
- Defined in src/classes/encodingHandler.ts:86

runUpcycleQueue

runUpcycleQueue(options?): Promise<void>
Parameters
- Optional options: IBroadcastOptions
Returns Promise<void>
Implementation of IStorageHandler.runUpcycleQueue
- Defined in src/classes/storageHandler.ts:1876

saveFolder

saveFolder(bundle): Promise<IWrappedEncodeObject[]>
Parameters
- bundle: IStagedUploadPackage
Returns Promise<IWrappedEncodeObject[]>
Implementation of IStorageHandler.saveFolder
- Defined in src/classes/storageHandler.ts:696

`Protected` sendShareToMsgs

sendShareToMsgs(pkg, additionalViewers?): Promise<IWrappedEncodeObject[]>
Protected
Parameters
- pkg: IShareDirectPackage
- Optional additionalViewers: string[] = []
Returns Promise<IWrappedEncodeObject[]>
Inherited from EncodingHandler.sendShareToMsgs
- Defined in src/classes/encodingHandler.ts:1049

`Protected` sendUnshareToMsgs

sendUnshareToMsgs(pkg): Promise<IWrappedEncodeObject[]>
Protected
Parameters
- pkg: IUnsharePackage
Returns Promise<IWrappedEncodeObject[]>
Inherited from EncodingHandler.sendUnshareToMsgs
- Defined in src/classes/encodingHandler.ts:1115

shareDirect

shareDirect(options): Promise<IWrappedEncodeObject[]>
Parameters
- options: IShareOptions
Returns Promise<IWrappedEncodeObject[]>
Implementation of IStorageHandler.shareDirect
- Defined in src/classes/storageHandler.ts:1419

shareLink

shareLink(options): Promise<IShareLinks>
Parameters
- options: IShareLinkOptions
Returns Promise<IShareLinks>
Implementation of IStorageHandler.shareLink
- Defined in src/classes/storageHandler.ts:1463

`Protected` shareLinkToMsgs

shareLinkToMsgs(pkg): Promise<IWrappedEncodeObject[]>
Protected
Parameters
- pkg: IShareLinkPackage
Returns Promise<IWrappedEncodeObject[]>
Inherited from EncodingHandler.shareLinkToMsgs
- Defined in src/classes/encodingHandler.ts:994

`Protected` stageQueue

stageQueue(): Promise<void>
Protected
Returns Promise<void>
- Defined in src/classes/storageHandler.ts:2600

`Protected` storageEncodeFileTree

storageEncodeFileTree(location, meta, options?): Promise<EncodeObject>
Protected
Parameters
- location: TMerkleParentChild
- meta: TMetaDataSets
- Optional options: IFileTreeOptions
Returns Promise<EncodeObject>
Inherited from EncodingHandler.storageEncodeFileTree
- Defined in src/classes/encodingHandler.ts:310

`Protected` tidyReceivedNotifications

tidyReceivedNotifications(pkg): Promise<IWrappedEncodeObject[]>
Protected
Parameters
- pkg: INotificationDeletePackage
Returns Promise<IWrappedEncodeObject[]>
Inherited from EncodingHandler.tidyReceivedNotifications
- Defined in src/classes/encodingHandler.ts:1187

`Protected` ulidFolderToMsgs

ulidFolderToMsgs(): Promise<IWrappedEncodeObject[]>
Protected
Returns Promise<IWrappedEncodeObject[]>
Inherited from EncodingHandler.ulidFolderToMsgs
- Defined in src/classes/encodingHandler.ts:728

unshare

unshare(options): Promise<IWrappedEncodeObject[]>
Parameters
- options: IUnshareOptions
Returns Promise<IWrappedEncodeObject[]>
Implementation of IStorageHandler.unshare
- Defined in src/classes/storageHandler.ts:1519

`Protected` upcycleBaseFolderToMsgs

upcycleBaseFolderToMsgs(pkg): Promise<IWrappedEncodeObject[]>
Protected
Parameters
- pkg: IFileTreePackage
Returns Promise<IWrappedEncodeObject[]>
Inherited from EncodingHandler.upcycleBaseFolderToMsgs
- Defined in src/classes/encodingHandler.ts:630

`Protected` upcycleFile

upcycleFile(source): Promise<IUploadPackage>
Protected
Parameters
- source: FileMetaHandler
Returns Promise<IUploadPackage>
- Defined in src/classes/storageHandler.ts:2043

upgradeSigner

upgradeSigner(): Promise<void>
Returns Promise<void>
Implementation of IStorageHandler.upgradeSigner
- Defined in src/classes/storageHandler.ts:405

`Static` enableFullSigner

enableFullSigner(client): Promise<TFullSignerState>
Parameters
- client: IClientHandler
Returns Promise<TFullSignerState>
- Defined in src/classes/storageHandler.ts:190

`Static` init

init(client, options?): Promise<IStorageHandler>
Parameters
- client: IClientHandler
- Optional options: IStorageOptions = {}
Returns Promise<IStorageHandler>
- Defined in src/classes/storageHandler.ts:137

Class StorageHandler

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Parameters

Returns StorageHandler

Properties

Protected children

Protected fullSigner

Protected Readonly hostAddress

Protected Readonly hostSigner

Protected Readonly jackalClient

Protected Readonly jackalSigner

Protected Readonly jklAddress

Protected keyPair

Protected meta

Protected mustConvert

Protected notifications

Protected path

Protected Readonly proofInterval

Protected providers

Protected reader

Protected Readonly rns

Protected stagedUploads

Protected upcycleQueue

Protected uploadQueue

Protected uploadsInProgress

Methods

Protected assembleLocation

Parameters

Returns string

Protected baseFolderToMsgs

Parameters

Returns Promise<IWrappedEncodeObject[]>

Protected batchUploads

Parameters

Returns Promise<Promise<IProviderUploadResponse>[]>

Protected beforeUnloadHandler

Parameters

Returns void

Protected buildConversion

Parameters

Returns Promise<null | IConversionFolderBundle>

Protected buyStoragePlan

Parameters

Returns IWrappedEncodeObject

checkAndInitSharing

Parameters

Returns Promise<IWrappedEncodeObject[]>

checkAndUpcycle

Parameters

Returns Promise<void>

checkIfUpcycle

Returns boolean

Protected checkLocked

Parameters

Returns Promise<boolean>

checkNotifications

Returns Promise<number>

checkSharedTo

Parameters

Returns Promise<string[]>

cleanShutdown

Returns void

Protected clonePkgToMsgs

Parameters

Returns Promise<IWrappedEncodeObject[]>

cloneShares

Parameters

Returns Promise<IWrappedEncodeObject[]>

cloneUpload

Parameters

Returns Promise<IWrappedEncodeObject[]>

convert

Parameters

`Protected` constructor

`Protected` children

`Protected` fullSigner

`Protected` `Readonly` hostAddress

`Protected` `Readonly` hostSigner

`Protected` `Readonly` jackalClient

`Protected` `Readonly` jackalSigner

`Protected` `Readonly` jklAddress

`Protected` keyPair

`Protected` meta

`Protected` mustConvert

`Protected` notifications

`Protected` path

`Protected` `Readonly` proofInterval

`Protected` providers

`Protected` reader

`Protected` `Readonly` rns

`Protected` stagedUploads

`Protected` upcycleQueue

`Protected` uploadQueue

`Protected` uploadsInProgress

`Protected` assembleLocation

`Protected` baseFolderToMsgs

`Protected` batchUploads

`Protected` beforeUnloadHandler

`Protected` buildConversion

`Protected` buyStoragePlan

`Protected` checkLocked

`Protected` clonePkgToMsgs

`Protected` createExpiresValue

`Protected` downloadStaging

`Protected` encodeCreateNotification

`Protected` encodeDeleteNotification

`Protected` encodeExecuteContract

`Protected` encodeFileTreeBaseFolder

`Protected` encodeFileTreeFile

`Protected` encodeFileTreeFileShare

`Protected` encodeFileTreeFileShareLink

`Protected` encodeFileTreeFolder

`Protected` encodeFileTreeNull

`Protected` encodeFileTreeRef

`Protected` encodeFileTreeRefShare

`Protected` encodeFileTreeShared

`Protected` encodeFileTreeSharerRef

`Protected` encodeInstantiateContract

`Protected` encodePostKey

`Protected` encodeStorageCloneFile