Skip to content

Commit d2ff58e

Browse files
authored
Merge pull request #2398 from TippyFlitsUK/main
PDP documentation updates
2 parents 3c67034 + dbfeaf0 commit d2ff58e

File tree

5 files changed

+59
-10
lines changed

5 files changed

+59
-10
lines changed

storage-providers/pdp/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,24 @@
1+
---
2+
layout:
3+
title:
4+
visible: true
5+
description:
6+
visible: true
7+
tableOfContents:
8+
visible: true
9+
outline:
10+
visible: true
11+
pagination:
12+
visible: true
13+
---
14+
115
# PDP
216

17+
{% hint style="danger" %}
18+
**DEPRECATED DEVELOPER TOOL**\
19+
\
20+
This documentation refers to the legacy `pdptool`, which is intended only for low-level developer testing.\
21+
It is not the recommended method for onboarding or interacting with PDP Storage Providers.
22+
23+
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).
24+
{% endhint %}

storage-providers/pdp/enable-pdp.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,15 @@ description: >-
77

88
# Enable PDP
99

10+
{% hint style="danger" %}
11+
**DEPRECATED DEVELOPER TOOL**\
12+
\
13+
This documentation refers to the legacy `pdptool`, which is intended only for low-level developer testing.\
14+
It is not the recommended method for onboarding or interacting with PDP Storage Providers.
15+
16+
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).
17+
{% endhint %}
18+
1019
<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>
1120

1221
### Attach Storage Locations
@@ -52,7 +61,7 @@ In the HTTP section:
5261
* 📡 ListenAddress: `0.0.0.0:443`
5362

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

5867
***
@@ -116,7 +125,7 @@ You can display your Lotus wallets at any time by running:
116125
lotus wallet list
117126
```
118127

119-
Export & convert your new delegated wallet address private key:&#x20;
128+
Export & convert your new delegated wallet address private key:
120129

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

137146
{% hint style="success" %}
138-
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.
147+
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.
139148
{% endhint %}
140149

141150
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.
@@ -155,7 +164,7 @@ curio run --layers=gui,pdp
155164
```
156165

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

161170
```sh

storage-providers/pdp/install-and-run-curio.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ Clone the repository and switch to the PDP branch:
3131
```sh
3232
git clone https://github.com/filecoin-project/curio.git
3333
cd curio
34-
git checkout feat/pdp
34+
git checkout synapse
3535
```
3636

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

4141
```sh

storage-providers/pdp/install-and-run-lotus.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,14 @@ lotus daemon --import-snapshot snapshot.car.zst --remove-existing-chain --halt-a
6363
nohup lotus daemon > ~/lotus.log 2>&1 &
6464
```
6565

66+
{% hint style="warning" %}
67+
If you encounter errors related to `EnableEthRPC` or `EnableIndexer`, run the command below and restart Lotus
68+
{% endhint %}
69+
70+
```sh
71+
sed -i 's/EnableEthRPC = .*/EnableEthRPC = true/; s/EnableIndexer = .*/EnableIndexer = true/' ~/.lotus/config.toml
72+
```
73+
6674
#### **Monitor Sync Progress**
6775

6876
```sh
@@ -96,7 +104,7 @@ lotus wallet new bls # Create worker wallet
96104
lotus wallet list # List all created wallets
97105
```
98106

99-
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.
107+
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).
100108

101109
{% hint style="info" %}
102110
Both wallets will be used during Curio initialisation.

storage-providers/pdp/use-pdp.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,16 @@ description: >-
77

88
# Use PDP
99

10+
{% hint style="danger" %}
11+
DEPRECATED DEVELOPER TOOL
12+
13+
This documentation refers to the legacy `pdptool`, which is intended only for low-level developer testing.
14+
15+
It is not the recommended method for onboarding or interacting with PDP Storage Providers.
16+
17+
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).
18+
{% endhint %}
19+
1020
PDP ensures that your data is verifiably stored by a Filecoin Storage Provider using cryptographic proofs without needing to retrieve the file itself.
1121

1222
### Prerequisites
@@ -33,7 +43,7 @@ go build .
3343

3444
***
3545

36-
### Authenticate Your Client (JWT Token)
46+
### Authenticate Your Client (JWT Token)
3747

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

@@ -95,7 +105,7 @@ Location: /pdp/proof-sets/created/0xf91617ef532748efb5a51e64391112e5328fbd9a5b9a
95105
Response:
96106
```
97107

98-
Use the `0x` transaction hash from the previous output to monitor proof set creation status:
108+
Use the `0x` transaction hash from the previous output to monitor proof set creation status:
99109

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

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

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

0 commit comments

Comments
 (0)