# Functions
No description provided by the author
No description provided by the author
AddFreeStorageAssigner adds a new free storage assigner (txn: `storagesc.add_free_allocation_assigner`).
CancelAllocation sends a cancel request for an allocation (txn: `storagesc.cancel_allocation`)
- allocID is the id of the allocation.
CollectRewards collects the rewards for a provider (txn: `storagesc.collect_reward`) - providerId is the id of the provider.
No description provided by the author
CreateAllocationForOwner creates a new allocation with the given options (txn: `storagesc.new_allocation_request`).
CreateAllocationWith creates a new allocation with the given options for the current client using the SDK.
No description provided by the author
CreateChunkedUploadFormBuilder create ChunkedUploadFormBuilder instance.
CreateDownloader create a downloander instance with options - allocationID: allocation id - localPath: local path to save the downloaded file - remotePath: remote path of the file to download - opts: download options as option functions.
CreateFfmpegRecorder create a ffmpeg commander to capture video and audio local camera and microphone - file: output file path - delay: delay in seconds.
No description provided by the author
CreateFreeAllocation creates a new free allocation (txn: `storagesc.free_allocation_request`).
CreateFsDownloadProgress create a download progress storer instance to track download progress and queue.
CreateHasher creat Hasher instance.
CreateLiveUpload create a LiveChunkedUpload instance to upload live streaming video - homedir: home directory of the allocation - allocationObj: allocation object - liveMeta: live meta data - liveReader: live reader to read video data - opts: live upload option functions which customize the LiveUpload instance.
CreateWriteMarkerMutex create WriteMarkerMutex for allocation.
CreateYoutubeDL create a youtube-dl instance to download video file from youtube - localPath: output file path - feedURL: youtube video url - downloadArgs: youtube-dl download arguments - ffmpegArgs: ffmpeg arguments - delay: delay in seconds.
No description provided by the author
FinalizeAllocation sends a finalize request for an allocation (txn: `storagesc.finalize_allocation`)
- allocID is the id of the allocation.
GenerateParentPath generates the parent path of the given path.
GetAllocation - get allocation from given allocation id
- allocationID: the allocation id
returns the allocation instance and error if any.
GetAllocationBlobbers returns a list of blobber ids that can be used for a new allocation.
GetAllocationForUpdate - get allocation for update from given allocation id without calling init allocation.
GetAllocationFromAuthTicket - get allocation from given auth ticket hash.
GetAllocationMinLock calculates and returns the minimum lock demand for creating a new allocation, which represents the cost of the creation process.
GetAllocations - get all allocations for the current client
returns the list of allocations and error if any.
GetAllocationsForClient - get all allocations for given client id
- clientID: the client id
returns the list of allocations and error if any.
No description provided by the author
GetBlobber retrieve blobber by id.
GetBlobberIds returns a list of blobber ids that can be used for a new allocation.
GetBlobbers returns list of blobbers.
GetChallengePoolInfo retrieve challenge pool info for given allocation.
GetClientEncryptedPublicKey - get the client's public key.
GetDStorageFileReader will initialize erasure decoder, decrypter if file is encrypted and other necessary fields and returns a reader that comply with io.ReadSeekCloser interface.
No description provided by the author
GetFreeAllocationBlobbers returns a list of blobber ids that can be used for a new free allocation.
GetLogger retrieves logger instance.
GetMptData retrieves mpt key data.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetReadPriceRange returns the read price range from the global configuration.
GetStakePoolInfo retrieve stake pool info for the current client configured to the sdk, given provider type and provider ID.
GetStakePoolUserInfo obtains blobbers/validators delegate pools statistic for a user.
No description provided by the author
GetUpdateAllocationMinLock returns the minimum lock demand for updating an allocation, which represents the cost of the update operation.
No description provided by the author
GetValidator retrieve validator instance by id.
GetValidators returns list of validators.
GetVersion - returns version string.
No description provided by the author
GetWritePriceRange returns the write price range from the global configuration.
InitAuthTicket initialize auth ticket instance - authTicket: base64 encoded auth ticket.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
KillProvider kills a blobber or a validator (txn: `storagesc.kill_blobber` or `storagesc.kill_validator`) - providerId is the id of the provider.
No description provided by the author
No description provided by the author
No description provided by the author
NewMediaPlaylist create media playlist(.m3u8).
No description provided by the author
No description provided by the author
No description provided by the author
NewSignalContext create SignalContext instance.
No description provided by the author
No description provided by the author
No description provided by the author
ResetBlobberStats resets the stats of a blobber (txn: `storagesc.reset_blobber_stats`) - rbs is the reset blobber stats dto, contains the blobber id and its stats.
No description provided by the author
No description provided by the author
No description provided by the author
SetLogFile set the log file and verbosity levels - logFile: Log file - verbose: true - console output; false - no console output.
SetLogLevel set the log level.
No description provided by the author
SetNumBlockDownloads - set the number of block downloads, needs to be between 1 and 500 (inclusive).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ShutdownProvider shuts down a blobber or a validator (txn: `storagesc.shutdown_blobber` or `storagesc.shutdown_validator`) - providerId is the id of the provider.
StakePoolLock locks tokens in a stake pool.
StakePoolUnlock unlocks a stake pool tokens.
No description provided by the author
No description provided by the author
No description provided by the author
Converting the video file to fmp4 format for web streaming.
TransferAllocation transfers the ownership of an allocation to a new owner.
UpdateAllocation sends an update request for an allocation (txn: `storagesc.update_allocation_request`)
- size is the size of the allocation.
UpdateBlobberSettings updates the settings of a blobber (txn: `storagesc.update_blobber_settings`) - blob is the update blobber request inputs.
UpdateValidatorSettings updates the settings of a validator (txn: `storagesc.update_validator_settings`) - v is the update validator request inputs.
No description provided by the author
WithActualHash return a wrapper option function to set actual hash of the chunked upload instance.
WithAllocation set allocation object of the download option.
WithAuthTicket set auth ticket and lookup hash for the download request options This is used to download shared files.
WithBlocks set block range for the download request options.
WithChunkNumber set the number of chunks should be upload in a request.
WithCommitTimeout return a wrapper option function to set commit timeout of the chunked upload instance.
WithDownloadProgressStorer set download progress storer of download request options.
WithEncrypt turn on/off encrypt on upload.
WithEncryptedKeyPoint return a wrapper option function to set encrypted key point of the chunked upload instance.
No description provided by the author
No description provided by the author
WithFileHandler set file handler for the download request options.
WithActualSize return a wrapper option function to set the file hasher used in the chunked upload instance.
No description provided by the author
No description provided by the author
No description provided by the author
WithLiveChunkNumber set the number of chunks should be upload in a live upload request.
WithLiveDelay set number of seconds to wait before starting the live upload.
WithLiveEncrypt trun on/off encrypt on upload.
WithLiveStatusCallback register StatusCallback instance to track live upload progress - callback: StatusCallback instance.
WithUploadMask return a wrapper option function to set upload mask of the chunked upload instance.
No description provided by the author
No description provided by the author
No description provided by the author
WithOnlyThumbnail set thumbnail download option which makes the request download only the thumbnail.
WithProgressCallback return a wrapper option function to set progress callback of the chunked upload instance.
No description provided by the author
No description provided by the author
WithStatusCallback return a wrapper option function to set status callback of the chunked upload instance, which is used to track upload progress - callback: StatusCallback instance.
WithThumbnail add thumbnail.
WithThumbnailFile add thumbnail from file.
WithUploadTimeout return a wrapper option function to set upload timeout of the chunked upload instance.
WithVerifyDownload set verify download option for the download request options.
No description provided by the author
WritePoolLock locks given number of tokes for given duration in read pool.
WritePoolUnlock unlocks ALL tokens of a write pool.
# Constants
BlocksFor10MB is number of blocks required for to make 10MB data.
No description provided by the author
No description provided by the author
0001 0000.
0000 0010.
0000 1000.
0010 0000.
0000 0100.
0000 0001.
No description provided by the author
No description provided by the author
No description provided by the author
Conflict - Conflict in file.
No description provided by the author
DefaultChunkSize default chunk size for file and thumbnail.
No description provided by the author
No description provided by the author
Delete - Delete file from remote.
No description provided by the author
Download - Download file from remote.
No description provided by the author
No description provided by the author
EncryptedDataPaddingSize additional bytes to save encrypted data.
EncryptionHeaderSize encryption header size in chunk: PRE.MessageChecksum(128)+PRE.OverallChecksum(128).
EncryptionOverHead File size increases by 16 bytes after encryption.
error codes.
No description provided by the author
No description provided by the author
No description provided by the author
error codes.
error codes.
error codes.
error codes.
No description provided by the author
LocalDelete - Delete file from local.
No description provided by the author
No description provided by the author
5MB(CHUNK_SIZE*80).
No description provided by the author
No description provided by the author
error codes.
error codes.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ReEncryptionHeaderSize re-encryption header size in chunk.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Update - Update file in remote.
Upload - Upload file to remote.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DefaultHashFunc default hash method for stream merkle tree.
ErrClispIsNotReady clips file is not ready.
No description provided by the author
No description provided by the author
No description provided by the author
errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
Allocation represents a storage allocation.
No description provided by the author
No description provided by the author
No description provided by the author
Blobber type represents blobber information.
BlobberAllocation represents the blobber in the context of an allocation.
BlobberAllocationStats represents the blobber allocation statistics.
No description provided by the author
No description provided by the author
ChallengePoolInfo represents a challenge pool stat.
ChunkData data of a chunk.
ChunkedUpload upload manager with chunked upload feature.
ChunkedUploadBlobber client of blobber's upload.
ChunkedUploadFormMetadata upload form metadata.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ConsolidatedFileMeta represents the file meta data.
No description provided by the author
No description provided by the author
No description provided by the author
CreateAllocationOptions is used to specify the options for creating a new allocation.
Example implementation of a reader.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DownloadOptions download options.
No description provided by the author
No description provided by the author
DownloadRequestHeader download request header.
FfmpegRecorder wrap ffmpeg command to capture video and audio from local camera and microphone.
FileDiff file difference representation for sync.
FileInfo file information representation for sync.
FileMeta metadata of stream input/local.
No description provided by the author
FileOptionsParameters is used to specify the file options parameters for an allocation, which control the usage permissions of the files in the allocation.
FileStats - file stats structure.
No description provided by the author
No description provided by the author
No description provided by the author
ListResult a wrapper around the result of directory listing command.
LiveMeta metadata of live stream input.
LiveUpload live streaming video upload manager.
MediaPlaylist queue-based m3u8 playlist.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OperationRequest represents an operation request with its related options.
Blobber response will be different from each other so we should only consider similar fields i.e.
No description provided by the author
PriceRange represents a price range allowed by user to filter blobbers.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
holds result of repair size.
No description provided by the author
ResetBlobberStatsDto represents blobber stats reset request.
No description provided by the author
No description provided by the author
SignalContext listen syscall signal to cancel context.
No description provided by the author
StakePoolDelegatePoolInfo represents delegate pool of a stake pool info.
StakePool information of stake pool of a provider.
StakePoolOfferInfo represents stake pool offer information.
StakePoolRewardsInfo represents stake pool rewards.
StakePoolUserInfo represents user stake pools statistic.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Terms represents Blobber terms.
UpdateBlobber is used during update blobber settings calls.
UpdateTerms represents Blobber terms during update blobber calls.
UpdateValidator is used during update validator settings calls.
UploadBlobberStatus the status of blobber's upload progress.
No description provided by the author
No description provided by the author
UploadFormData form data of upload.
No description provided by the author
UploadProgress progress of upload.
No description provided by the author
Validator represents validator information.
No description provided by the author
WriteMarkerMutex blobber WriteMarkerMutex client.
YoutubeDL wrap youtube-dl to download video from youtube.
# Interfaces
No description provided by the author
ChunkedUploadFormBuilder build form data for uploading.
ChunkedUploadProgressStorer load and save upload progress.
No description provided by the author
Downloader downloader for file, blocks and thumbnail.
No description provided by the author
FileNameBuilder build file name based output format.
Hasher interface to gather all hasher related functions.
LiveUploadReader implements io.Reader and Size for live stream upload.
M3u8Writer m3u8 writer.
No description provided by the author
No description provided by the author
# Type aliases
No description provided by the author
ChunkedUploadOption Generic type for chunked upload option functions.
DownloadOption set download option.
No description provided by the author
No description provided by the author
LiveUploadOption set live upload option.
No description provided by the author
No description provided by the author
ProviderType is the type of the provider.
No description provided by the author
No description provided by the author