Introduction to the Powergate¶
The Powergate is an API driven solution for deploying multitiered storage across Filecoin and IPFS. Persistent storage on Filecoin allows rich storage configuration for data such as replication factor, miner selection, deal renewal, and repair. Network available storage is configurable and provided through a connected IPFS peer or pinning network.
The Powergate will remain in rapid development until a formal release. During this time, will likely encounter bugs and unannounced API changes. Do not run the Powergate in production systems and please join the powergate-users channel in the Filecoin community Slack for announcements and support.
Powergate is a collection of libraries, modules, and configurations that can used independently, and composed together to integrate Filecoin into your application or storage system. The Powergate is designed to manage one or many Filecoin wallet addresses. Each address in Powergate can be independently managed through the FFS API (or grouped together into a single FFS instance).
Some benefits of using the Powergate include:
- Ensure data stored on Filecoin is available on the IPFS network easily.
- Handle long-term storage deal management, including automated renew and repair.
- Make use of network indices to improve miner selection and deal creation.
- Manage Filecoin wallet addresses for one or many users.
- Easily configure, connect, and deploy Powergate, Lotus, and IPFS together.
- Much more!
The Powergate includes the full set of features through the binary command-line interface.
Install the CLI
You can build and install the Powergate CLI from the Powergate Repo.
git clone email@example.com:textileio/powergate.git cd powergate make build
To compile from source, verify you have Go 1.14 or newer installed. All
make commands install binaries in
$GOPATH/bin, which usually is in
$PATH, so you can run them right away from any folder in your terminal.
Using the CLI
Powergate CLI commands are just
The workhorse of APIs in the Powergate is called, the FFS (Filecoin File System). This module provides a multi-tiered file storage API built on Filecoin and IPFS. Storing data on IPFS and Filecoin is as easy as expressing your desired configuration for storing a Cid.
The FFS is where the Powergate handles Filecoin wallet addresses, long-term deal management, and connecting Filecoin to IPFS. Access to the FFS is enabled through a basic token, allowing you to create many FFS Instances, and map Powergate API access to user(s) in your system.
A running Powergate deployment will collect a number of useful indices about the network. Some of the data collected in these indices are used by the FFS to streamline miner selection when creating new deals. You can use the indices directly to build other features into your own system.
- Miners index. Provides processed data regarding registered miners (on-chain and off-chain), such as: total miner power, relative power, online status, geolocation, and more!
- Ask index. Provides a fast-retrieval up to date snapshot of miner's asking prices for data storage.
- Slashing index. Provides history data about miners faults while proving their storage on-chain.
Built on top of the previous indexes, a Reputation module constructs a weighted-scoring system that allows to sort miners considering multiple on-chain and off-chain data, such as: compared price to the median of the market, low storage-fault history, power on network, and external sources (soon!).
The Powergate APIs are available as gRPC endpoints. There are three ways to get familiar with the broad set of APIs available to start using on the Powergate.
- Explore the CLI. The CLI runs on the Powergate API, so in general, anything you can do in the CLI you can also do over the API.
- User the Go Client. You can use the Powergate APIs from your go app by building directly on the Powergate Go Client.
- Browse the Protocols. The API is typed with Protocol Buffers and you can quickly view all capabilities by looking at the
.protofiles in the Powergate repo. The best place to start is the FFS API.
The Powergate comes packed with a number of additional tools that will be useful to you as you integrate it into your system.
- Lotus. A Lotus node running on the Filecoin network.
- IPFS. A full IPFS node running to back Powergate FFS.
- Prometheus. The backend for metrics processing.
- Grafana. Providing metrics dashboard.
- cAdvisor. Providing container metrics.
Running the Powergate¶
You can run the Powergate on the Filecoin mainnet or using an embedded localnet we make available as part of the Powergate stack. We recommend starting out with the localnet as you'll get access to the full set of APIs and capabilities without having to start syncing the network right away. When ready, you can update your Powergate to connect to the live mainnet.
The localnet provides a fast, fully functional, embedded Filecoin network that can be used for testing, building, or running continuous integratin. Read more about running the Powergate on localnet or running the localnet to use the Lotus client directly.
Once you are ready to start using the Powergate with the Filecoin Mainnet, it's just a single line.
git clone firstname.lastname@example.org:textileio/powergate.git cd powergate/docker make up
In the above presentation, we'll give a high-level overview of how the Powergate fits into the Filecoin and IPFS networks and a detailed walk-through of system components.
Running System Video¶
The above video shows the Powergate startup including IPFS and Lotus nodes. Next, the admin uses the Powergate CLI to create a deal on the Filecoin network.