Categorygithub.com/mike76-dev/renterd-satellite
modulepackage
0.6.5
Repository: https://github.com/mike76-dev/renterd-satellite.git
Documentation: pkg.go.dev

# README

renterd-satellite

Satellite package for use within Sia renting software

# Packages

Package chacha20 implements the ChaCha20 and XChaCha20 encryption algorithms as specified in RFC 8439 and draft-irtf-cfrg-xchacha-01.

# Functions

New returns a new Satellite.
NewClient returns a client that communicates with a renterd satellite server listening on the specified address.
NewSatellite returns a new Satellite handler.
UploadObject uploads a file to the satellite.
UploadPart uploads a part of an S3 multipart upload to the satellite.

# Variables

No description provided by the author

# Structs

BucketFiles contains a list of filepaths within a single bucket.
A Client provides methods for interacting with an API server.
Config contains the satellite configuration parameters.
CreateMultipartRequest is the request type for the CreateMultipart RPC.
CreateMultipartResponse is the response type for the CreateMultipart RPC.
FileMetadata contains the uploaded file metadata.
FormContractRequest is the request type for the FormContract RPC.
FormRequest is the request type for the FormContracts RPC.
ObjectPutRequest is the request type for the PUT /object requests.
ObjectResponse is the response type for the GET /object request.
RenewContractRequest is the request type for the RenewContract RPC.
RenewRequest is the request type for the RenewContracts RPC.
RenterSettings contains the renter's opt-in settings.
Satellite is the interface between the renting software and the Sia Satellite node.
SatelliteInfo contains the information about the satellite.
SatellitesAllResponse is the response type for the /satellites request.
SaveMetadataRequest is the request type for the SaveMetadata RPC.
UpdateRevisionRequest is the request type for the UpdateRevision RPC.
UpdateSlabRequest is the request type for the UpdateSlab RPC.