Skip to content
Merged
Binary file added .gitbook/assets/1 (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/1 (2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/2 (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/2 (2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/3 (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/3 (2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/4 (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
375 changes: 190 additions & 185 deletions SUMMARY.md

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions builder-cookbook/filecoin-pin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
description: How to use the Filecoin Pin CLI and creating GitHub Actions from the terminal
---

# Filecoin Pin

* [filecoin-pin-cli.md](filecoin-pin-cli.md "mention")
* [host-a-website-with-filecoin-pin-using-github-actions.md](host-a-website-with-filecoin-pin-using-github-actions.md "mention")
* [store-ipfs-files-on-filecoin-a-drag-and-drop-guide.md](store-ipfs-files-on-filecoin-a-drag-and-drop-guide.md "mention")
* [faq.md](faq.md "mention")
114 changes: 114 additions & 0 deletions builder-cookbook/filecoin-pin/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
# FAQ

### What is Filecoin Pin?

Filecoin Pin stores IPFS content on the Filecoin Network of decentralized Storage Providers. It enables developers to programmatically pay for storage and retrieval with Filecoin Pay. When SPs prove storage, they are paid from the developers' Filecoin Pay Account.

***

### How can I use Filecoin Pin today?

Two paths are available:

* **Website:** Upload files in your browser. Uses a pre-funded test wallet.
* **CLI:** Upload files from your terminal. Fund storage from your own wallet.

{% hint style="info" %}
Both run on Calibration testnet. They use tFIL and USDFC. Data has no persistence guarantees while on Calibnet.
{% endhint %}

***

### What do I need to get started?

* You can find different links related to Filecoin Pin here: [https://docs.filecoin.io/builder-cookbook/filecoin-pin](https://docs.filecoin.io/builder-cookbook/filecoin-pin)

***

### How do payments and approvals work?

* **Website:** The demo wallet handles payments. It has been prefunded with testnet USDFC and FIL. Users don't need to connect their own wallet.
* **CLI:** Your test wallet handles payments. You approve and deposit funds through Filecoin Pay.

{% hint style="info" %}
Storage providers receive payment after cryptographically proving data possession.
{% endhint %}

***

### How does auto-funding work?

Use `--auto-fund` when uploading. The CLI calculates storage costs automatically. It deposits the right amount of USDFC to your payment rail.

{% hint style="info" %}
No manual deposit calculations needed. The system handles it.
{% endhint %}

***

### How long is my data stored?

This runs on Calibration testnet only. Treat it as a demo. No duration guarantees exist for Website or CLI.

Mainnet will offer persistence guarantees. Data persists while you maintain deposits. The CLI supports auto-funding for storage.

***

### What is a Data Set?

A Data Set groups your uploads together. Each upload becomes a "piece" within the Data Set. Multiple files you upload share the same payment rail.

Check your Data Set with `filecoin-pin data-set <id>`.

***

### How do I retrieve my data?

Three methods:

1. **IPFS Gateways:** Use public gateways with your root CID: `https://gateway.example.com/ipfs/<root-cid>`
2. **Direct from Storage Provider:** Get the direct download URL from `filecoin-pin data-set <id>`
3. **IPFS Tools:** Use Kubo, Helia, IPFS Desktop with your root CID.

***

### What is a piece CID vs root CID?

**Root CID** (bafybei...) is your IPFS content identifier. Use this to retrieve your data.

**Piece CID** (bafkzci...) is the Filecoin commitment. Storage Providers prove they store this piece.

{% hint style="info" %}
Both are linked cryptographically on-chain.
{% endhint %}

***

### How do I verify my data is actually stored?

Two ways to verify:

1. **CLI:** Run `filecoin-pin data-set <id>` to see on-chain verification. Check proof status and piece details.
2. **PDP Explorer:** Visit `https://pdp.vxb.ai/calibration/dataset/{datasetID}` to view proofs in your browser.

{% hint style="info" %}
Both methods show CommP and proof state directly from blockchain state.
{% endhint %}

***

### How do I access the code for the dApp and CLI?

See the repos as reference implementations and to fork for my own project?

* **Website**: [https://github.com/filecoin-project/filecoin-pin-website](https://github.com/filecoin-project/filecoin-pin-website)
* **CLI:** [https://github.com/filecoin-project/filecoin-pin](https://github.com/filecoin-project/filecoin-pin)

***

## References

* Filecoin Pin CLI Docs: [https://docs.filecoin.io/builder-cookbook/filecoin-pin](https://docs.filecoin.io/builder-cookbook/filecoin-pin)
* Filecoin Pin dApp Repo: [https://github.com/filecoin-project/filecoin-pin-website](https://github.com/filecoin-project/filecoin-pin-website)
* Synapse SDK: [https://github.com/FilOzone/synapse-sdk](https://github.com/FilOzone/synapse-sdk)
* USDFC documentation: [https://docs.secured.finance/usdfc-stablecoin/getting-started](https://docs.secured.finance/usdfc-stablecoin/getting-started)
Loading
Loading