package
0.0.0-20250204070817-3c82b7ad6a9f
Repository: https://github.com/0chain/gosdk_common.git
Documentation: pkg.go.dev

# Functions

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.
CreateFreeAllocation creates a new free allocation (txn: `storagesc.free_allocation_request`).
FinalizeAllocation sends a finalize request for an allocation (txn: `storagesc.finalize_allocation`) - allocID is the id of the allocation.
No description provided by the author
GetAllocationBlobbers returns a list of blobber ids that can be used for a new allocation.
GetAllocationMinLock calculates and returns the minimum lock demand for creating a new allocation, which represents the cost of the creation process.
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.
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.
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.
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
KillProvider kills a blobber or a validator (txn: `storagesc.kill_blobber` or `storagesc.kill_validator`) - providerId is the id of the provider.
NewMediaPlaylist create media playlist(.m3u8).
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
SetLogFile set the log file and verbosity levels - logFile: Log file - verbose: true - console output; false - no console output.
SetLogLevel set the log level.
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
TransferAllocation transfers the ownership of an allocation to a new owner.
// UpdateAllocationWithRequest 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.
WritePoolLock locks given number of tokes for given duration in read pool.
WritePoolUnlock unlocks ALL tokens of a write pool.

# Constants

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
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

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.
ChallengePoolInfo represents a challenge pool stat.
CreateAllocationOptions is used to specify the options for creating a new allocation.
Example implementation of a reader.
DownloadRequestHeader download request header.
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.
MediaPlaylist queue-based m3u8 playlist.
PriceRange represents a price range allowed by user to filter blobbers.
ResetBlobberStatsDto represents blobber stats reset request.
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
Terms represents Blobber terms.
No description provided by the author
UpdateBlobber is used during update blobber settings calls.
UpdateTerms represents Blobber terms during update blobber calls.
UpdateValidator is used during update validator settings calls.
No description provided by the author
No description provided by the author
Validator represents validator information.

# Interfaces

M3u8Writer m3u8 writer.
No description provided by the author

# Type aliases

ProviderType is the type of the provider.