Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v1

v1.9.1

May 20, 2024

v1.9.0

May 18, 2024

v1.8.6

Apr 28, 2024

v1.8.5

Apr 20, 2024

v1.8.4

Aug 12, 2023

v1.8.3

Jun 22, 2023

v1.8.0

May 2, 2023

v1.7.2

Jan 27, 2023

v1.7.1

Jan 27, 2023

v1.7.0

Jan 6, 2023

v1.6.6

Jul 19, 2022

v1.6.5

Jul 15, 2022

v1.6.4

Jul 5, 2022

v1.6.3

Jun 3, 2022

v1.6.2

Apr 13, 2022

Changes in this version

type Client

+ func (c *Client) Close() error

+ type HostClienterConfig struct

+ func NewDefaultHostClienterConfig() *HostClienterConfig

+ type Option func(*HostClienterConfig)

+ func WithLRU(lruSize int) Option

v1.6.0

Nov 22, 2021

Changes in this version

+ const DefaultListSectorIDsLimit

+ func GetRoutes(ol HandlerHTTPapi) []api2.Route

+ type API struct

+ func NewAPI(ts TokenStorage, hostSK crypto.SecretKey, host Host) *API

+ func (a *API) AttachSectors(ctx context.Context, req *AttachSectorsRequest) (*AttachSectorsResponse, error)

+ func (a *API) Close() error

+ func (a *API) DownloadWithToken(ctx context.Context, req *DownloadWithTokenRequest) (*DownloadWithTokenResponse, error)

+ func (a *API) Health(ctx context.Context, req *HealthRequest) (*HealthResponse, error)

+ func (a *API) ListSectorIDs(ctx context.Context, req *ListSectorIDsRequest) (*ListSectorIDsResponse, error)

+ func (a *API) RemoveSectors(ctx context.Context, req *RemoveSectorsRequest) (*RemoveSectorsResponse, error)

+ func (a *API) Start(ln net.Listener) (err error)

+ func (a *API) TokenResources(ctx context.Context, req *TokenResourcesRequest) (*TokenResourcesResponse, error)

+ func (a *API) UploadWithToken(ctx context.Context, req *UploadWithTokenRequest) (*UploadWithTokenResponse, error)

+ type AttachSectorsError struct

+ IncorrectBlock bool

+ NotEnoughStorage bool

+ UnknownError string

+ func (e AttachSectorsError) Error() string

+ type AttachSectorsRequest struct

+ BlockHeight types.BlockHeight

+ ContractID types.FileContractID

+ RenterSignature []byte

+ Revision types.FileContractRevision

+ Sectors []TokenAndSector

+ type AttachSectorsResponse struct

+ HostSignature []byte

+ type Client struct

+ func HostClientFromHttpClient(host, port string, client *http.Client) (*Client, error)

+ func HostClientFromPk(host, port string, hostPk types.SiaPublicKey) (*Client, error)

+ func NewClient(baseURL string, opts ...api2.Option) (*Client, error)

+ func (c *Client) AttachSectors(ctx context.Context, req *AttachSectorsRequest) (res *AttachSectorsResponse, err error)

+ func (c *Client) DownloadAndVerify(ctx context.Context, req *DownloadWithTokenRequest) (*DownloadWithTokenResponse, error)

+ func (c *Client) DownloadWithToken(ctx context.Context, req *DownloadWithTokenRequest) (res *DownloadWithTokenResponse, err error)

+ func (c *Client) Health(ctx context.Context, req *HealthRequest) (res *HealthResponse, err error)

+ func (c *Client) ListSectorIDs(ctx context.Context, req *ListSectorIDsRequest) (res *ListSectorIDsResponse, err error)

+ func (c *Client) RemoveSectors(ctx context.Context, req *RemoveSectorsRequest) (res *RemoveSectorsResponse, err error)

+ func (c *Client) TokenResources(ctx context.Context, req *TokenResourcesRequest) (res *TokenResourcesResponse, err error)

+ func (c *Client) UploadWithToken(ctx context.Context, req *UploadWithTokenRequest) (res *UploadWithTokenResponse, err error)

+ type DownloadWithTokenError struct

+ NoSuchSector *crypto.Hash

+ NotEnoughBytes bool

+ NotEnoughSectorAccesses bool

+ UnknownError string

+ func (e DownloadWithTokenError) Error() string

+ type DownloadWithTokenRequest struct

+ Authorization string

+ Ranges []Range

+ type DownloadWithTokenResponse struct

+ Sections []Section

+ TokenRecord *TokenRecord

+ type HandlerHTTPapi interface

+ AttachSectors func(context.Context, *AttachSectorsRequest) (*AttachSectorsResponse, error)

+ DownloadWithToken func(context.Context, *DownloadWithTokenRequest) (*DownloadWithTokenResponse, error)

+ Health func(ctx context.Context, req *HealthRequest) (*HealthResponse, error)

+ ListSectorIDs func(ctx context.Context, req *ListSectorIDsRequest) (*ListSectorIDsResponse, error)

+ RemoveSectors func(ctx context.Context, req *RemoveSectorsRequest) (*RemoveSectorsResponse, error)

+ TokenResources func(ctx context.Context, req *TokenResourcesRequest) (*TokenResourcesResponse, error)

+ UploadWithToken func(context.Context, *UploadWithTokenRequest) (*UploadWithTokenResponse, error)

+ type HealthRequest struct

+ type HealthResponse struct

+ Alive bool

+ Arch string

+ BlockHeight types.BlockHeight

+ BuildTime string

+ Commit string

+ OS string

+ type Host interface

+ AddSector func(sectorRoot crypto.Hash, sectorData []byte) error

+ BlockHeight func() types.BlockHeight

+ MoveTokenSectorsToStorageObligation func(fcID types.FileContractID, newRev types.FileContractRevision, ...) ([]byte, error)

+ ReadSector func(sectorRoot crypto.Hash) ([]byte, error)

+ RemoveSectorBatch func(sectorRoots []crypto.Hash) error

+ type HostClienter struct

+ func NewClienter() *HostClienter

+ func (hc *HostClienter) Client(host, port string, hostPk types.SiaPublicKey) (*Client, error)

+ type ListSectorIDsRequest struct

+ Authorization string

+ PageID string

+ type ListSectorIDsResponse struct

+ NextPageID string

+ SectorIDs []crypto.Hash

+ type Range struct

+ Length uint32

+ MerkleProof bool

+ MerkleRoot crypto.Hash

+ Offset uint32

+ type RemoveSectorsRequest struct

+ Authorization string

+ SectorIDs []crypto.Hash

+ type RemoveSectorsResponse struct

+ type Section struct

+ Data []byte

+ MerkleProof []crypto.Hash

+ type TokenAndSector struct

+ Authorization string

+ SectorID crypto.Hash

+ type TokenRecord struct

+ DownloadBytes int64

+ SectorAccesses int64

+ TokenInfo TokenStorageInfo

+ UploadBytes int64

+ type TokenResourcesRequest struct

+ Authorization string

+ type TokenResourcesResponse struct

+ DownloadBytes int64

+ LastChangeTime time.Time

+ SectorAccesses int64

+ Storage int64

+ UploadBytes int64

+ type TokenStorage interface

+ AddSectors func(id types.TokenID, sectorsIDs []crypto.Hash, time time.Time) (tokenstorage.TokenRecord, error)

+ AttachSectors func(tokensSectors map[types.TokenID][]crypto.Hash, time time.Time) error

+ EnoughStorageResource func(id types.TokenID, sectorsNum int64, now time.Time) (bool, error)

+ ListSectorIDs func(id types.TokenID, pageID string, limit int) (sectorIDs []crypto.Hash, nextPageID string, err error)

+ RecordDownload func(id types.TokenID, downloadBytes, sectorAccesses int64, time time.Time) (tokenstorage.TokenRecord, error)

+ RemoveSpecificSectors func(id types.TokenID, sectorsIDs []crypto.Hash, time time.Time) error

+ TokenRecord func(id types.TokenID) (tokenstorage.TokenRecord, error)

+ type TokenStorageInfo struct

+ LastChangeTime time.Time

+ SectorsNum uint64

+ Storage int64

+ type UploadWithTokenError struct

+ DataLengthIsZero bool

+ IncorrectSectorSize bool

+ NotEnoughBytes bool

+ NotEnoughStorage bool

+ TokenRecord *TokenRecord

+ UnknownError string

+ func (e UploadWithTokenError) Error() string

+ type UploadWithTokenRequest struct

+ Authorization string

+ Sectors [][]byte

+ type UploadWithTokenResponse struct

+ TokenRecord *TokenRecord