Skip to content

PDP documentation updates #2398

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions storage-providers/pdp/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,24 @@
---
layout:
title:
visible: true
description:
visible: true
tableOfContents:
visible: true
outline:
visible: true
pagination:
visible: true
---

# PDP

{% hint style="danger" %}
**DEPRECATED DEVELOPER TOOL**\
\
This documentation refers to the legacy `pdptool`, which is intended only for low-level developer testing.\
It is not the recommended method for onboarding or interacting with PDP Storage Providers.

For current usage, including working with live PDP SPs and submitting real deals, please use the [Synapse SDK](https://github.com/FilOzone/synapse-sdk) and [Synapse dApp Tutorial](https://github.com/FIL-Builders/fs-upload-dapp).
{% endhint %}
17 changes: 13 additions & 4 deletions storage-providers/pdp/enable-pdp.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@ description: >-

# Enable PDP

{% hint style="danger" %}
**DEPRECATED DEVELOPER TOOL**\
\
This documentation refers to the legacy `pdptool`, which is intended only for low-level developer testing.\
It is not the recommended method for onboarding or interacting with PDP Storage Providers.

For current usage, including working with live PDP SPs and submitting real deals, please use the [Synapse SDK](https://github.com/FilOzone/synapse-sdk) and [Synapse dApp Tutorial](https://github.com/FIL-Builders/fs-upload-dapp).
{% endhint %}

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="https://docs.curiostorage.org/experimental-features/enable-pdp">PDP Documentation</a></td><td><a href="../../.gitbook/assets/Curio_placeholder.webp">Curio_placeholder.webp</a></td></tr><tr><td><a href="https://filecoinproject.slack.com/archives/C0717TGU7V2">Filecoin Slack - #fil-pdp</a></td><td><a href="../../.gitbook/assets/Filecoin.svg.png">Filecoin.svg.png</a></td></tr><tr><td><a href="../../basics/assets/metamask-setup.md">Filecoin Wallet - MetaMask Setup</a></td><td><a href="../../.gitbook/assets/Filecoin.svg.png">Filecoin.svg.png</a></td></tr></tbody></table>

### Attach Storage Locations
Expand Down Expand Up @@ -52,7 +61,7 @@ In the HTTP section:
* 📡 ListenAddress: `0.0.0.0:443`

{% hint style="info" %}
&#x20;You must point your domain’s A record to your server’s public IP address for Let’s Encrypt to issue a certificate.
You must point your domain’s A record to your server’s public IP address for Let’s Encrypt to issue a certificate.
{% endhint %}

***
Expand Down Expand Up @@ -116,7 +125,7 @@ You can display your Lotus wallets at any time by running:
lotus wallet list
```

Export & convert your new delegated wallet address private key:&#x20;
Export & convert your new delegated wallet address private key:

```sh
lotus wallet export <your-delegated-wallet-address> | xxd -r -p | jq -r '.PrivateKey' | base64 -d | xxd -p -c 32
Expand All @@ -135,7 +144,7 @@ Browse to the **PDP** page of the Curio GUI and in the **Owner Address** section
* Select **Import Key**

{% hint style="success" %}
Your 0x wallet address - the delegated Ethereum address derived from your Filecoin Metamask private key - will be added to the **Owner Address** section of the Curio PDP page.
Your 0x wallet address - the delegated Ethereum address derived from your Filecoin Metamask private key - will be added to the **Owner Address** section of the Curio PDP page.
{% endhint %}

Make sure to send a small amount of FIL to your 0x wallet - we recommend 5 FIL to ensure uninterrupted PDP operation during initial setup and testing.
Expand All @@ -155,7 +164,7 @@ curio run --layers=gui,pdp
```

{% hint style="warning" %}
&#x20;If you encounter errors binding to port 443 when starting Curio with the pdp configuration layer, run:
If you encounter errors binding to port 443 when starting Curio with the pdp configuration layer, run:
{% endhint %}

```sh
Expand Down
4 changes: 2 additions & 2 deletions storage-providers/pdp/install-and-run-curio.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ Clone the repository and switch to the PDP branch:
```sh
git clone https://github.com/filecoin-project/curio.git
cd curio
git checkout feat/pdp
git checkout synapse
```

{% hint style="info" %}
Curio is compiled for a specific Filecoin network at build time. Choose the appropriate build command below.&#x20;
Curio is compiled for a specific Filecoin network at build time. Choose the appropriate build command below.
{% endhint %}

```sh
Expand Down
10 changes: 9 additions & 1 deletion storage-providers/pdp/install-and-run-lotus.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,14 @@ lotus daemon --import-snapshot snapshot.car.zst --remove-existing-chain --halt-a
nohup lotus daemon > ~/lotus.log 2>&1 &
```

{% hint style="warning" %}
If you encounter errors related to `EnableEthRPC` or `EnableIndexer`, run the command below and restart Lotus
{% endhint %}

```sh
sed -i 's/EnableEthRPC = .*/EnableEthRPC = true/; s/EnableIndexer = .*/EnableIndexer = true/' ~/.lotus/config.toml
```

#### **Monitor Sync Progress**

```sh
Expand Down Expand Up @@ -96,7 +104,7 @@ lotus wallet new bls # Create worker wallet
lotus wallet list # List all created wallets
```

Make sure to send a small amount of FIL to each wallet - we recommend 1 FIL per wallet to ensure the creation of your Storage Provider in Curio.
Make sure to send a small amount of FIL (Mainnet) or tFIL (Calibration) to each wallet - we recommend 1 FIL/tFIL per wallet to ensure the creation of your Storage Provider in Curio. [Calibration test FIL faucet information](https://docs.filecoin.io/smart-contracts/developing-contracts/get-test-tokens).

{% hint style="info" %}
Both wallets will be used during Curio initialisation.
Expand Down
16 changes: 13 additions & 3 deletions storage-providers/pdp/use-pdp.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,16 @@ description: >-

# Use PDP

{% hint style="danger" %}
DEPRECATED DEVELOPER TOOL

This documentation refers to the legacy `pdptool`, which is intended only for low-level developer testing.

It is not the recommended method for onboarding or interacting with PDP Storage Providers.

For current usage, including working with live PDP SPs and submitting real deals, please use the [Synapse SDK](https://github.com/FilOzone/synapse-sdk) and [Synapse dApp Tutorial](https://github.com/FIL-Builders/fs-upload-dapp).
{% endhint %}

PDP ensures that your data is verifiably stored by a Filecoin Storage Provider using cryptographic proofs without needing to retrieve the file itself.

### Prerequisites
Expand All @@ -33,7 +43,7 @@ go build .

***

### Authenticate Your Client (JWT Token)
### Authenticate Your Client (JWT Token)

You first need to authenticate your pdptool with a PDP-enabled Storage Provider

Expand Down Expand Up @@ -95,7 +105,7 @@ Location: /pdp/proof-sets/created/0xf91617ef532748efb5a51e64391112e5328fbd9a5b9a
Response:
```

Use the `0x` transaction hash from the previous output to monitor proof set creation status:
Use the `0x` transaction hash from the previous output to monitor proof set creation status:

```sh
./pdptool get-proof-set-create-status \
Expand Down Expand Up @@ -234,6 +244,6 @@ You’ve now:
🧭 Next: Track your proof sets in the PDP Explorer

* [Calibration PDP Explorer](https://calibration.pdp-explorer.eng.filoz.org)
* [Mainnet PDP Explorer](https://pdp-explorer.eng.filoz.org)&#x20;
* [Mainnet PDP Explorer](https://pdp-explorer.eng.filoz.org)

💬 Questions? Join the conversation on Filecoin Slack: [#fil-pdp](https://filecoinproject.slack.com/archives/C0717TGU7V2)
Loading