Categorygithub.com/filecoin-shipyard/boostly
modulepackage
0.0.0-20230824095226-2a165e4422ad
Repository: https://github.com/filecoin-shipyard/boostly.git
Documentation: pkg.go.dev

# README

Boostly

Go Reference Go Test

Filecoin Boost Client Library in Go

Boostly is a lightweight and efficient Go client library for Filecoin Boost. This library simplifies the process of integrating and interacting programmatically with Boost APIs, tailored specifically for Go developers.

Features

  • Deal Making: Seamlessly initiate deals with a Filecoin storage provider.
  • Deal Status Check: Query and monitor the status of your deals in real-time.
  • Retrieval Transports Query: Fetch retrieval transports offered by a Boost SP.

Installation

go get github.com/filecoin-shipyard/boostly@latest

Status

:construction: This repository is under active development. :construction:

Please be aware that while we strive to keep the master branch stable, breaking changes may be introduced as we push forward. We recommend using released versions for production systems and always checking the release notes before updating.

Documentation

For detailed usage and integration guidance, please refer to godoc documentation.

Resources

Contribution

Contributions are welcome! Please see the CONTRIBUTING.md for more details.

License

This project is licensed under the MIT and Apache 2.0 Licenses - see the LICENSE.md file for details.

# Functions

No description provided by the author
No description provided by the author
No description provided by the author

# 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
TransferStatusRestarted is set when the transfer restarts after previously starting.
TransferStatusStarted is set when the transfer starts.

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
DealStatusRequest is sent to get the current state of a deal from a storage provider.
DealStatusResponse is the current state of a deal.
HttpRequest has parameters for an HTTP transfer.
StorageAsk defines the parameters by which a miner will choose to accept or reject a deal.
Transfer has the parameters for a data transfer.
TransferState describes a transfer's current state.
TransportDealInfo has parameters for a transfer to be executed.
TransportEvent is fired as a transfer progresses.
No description provided by the author

# Type aliases

TransferStatus describes the status of a transfer (started, completed etc).