Skip to content

Commit 0aa00f7

Browse files
LexLuthrgitbook-bot
authored andcommitted
GITBOOK-42: Market docs warning
1 parent da0f41d commit 0aa00f7

File tree

3 files changed

+28
-10
lines changed

3 files changed

+28
-10
lines changed

documentation/en/best-practices.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ description: Curio best practices
1010
4. Multiple workers should be started with `--post` layer to allow fast wdPost and winPost turn around time. 
1111
5. We recommend running 1 GUI layer enabled node. A cluster wide GUI can be access via this node without putting any additional strain of read operations on the DB.
1212
6. The unsealed and sealed copies should not be stored in the same storage location. Curio will allow automatic regeneration of sealed and unsealed in future if one is lost.
13-
7. It is recommended to create a distinct layer for each market adapter, corresponding to each minerID. This configuration enables precise control, allowing for the assignment of specific minerIDs to either the Snap Deals pipeline or the PoRep pipeline.
14-
8. It is advised to run the market adapter on the same node that will execute the TreeD task for the PoRep pipeline or the Encode task for the Snap Deals pipeline.
13+
7. It is recommended to create a distinct layer for each market adapter (Deprecated), corresponding to each minerID. This configuration enables precise control, allowing for the assignment of specific minerIDs to either the Snap Deals pipeline or the PoRep pipeline.
14+
8. It is advised to run the market adapter (Deprecated) on the same node that will execute the TreeD task for the PoRep pipeline or the Encode task for the Snap Deals pipeline.

documentation/en/curio-market/migrating-from-boost.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ Migrating from Boost to Curio involves transitioning all deal data, including Bo
99
## Build the `migrate-curio` CLI Tool
1010

1111
* First, you need to build the `migrate-curio` tool, which is part of the Boost code base. This tool will handle the migration of deals.
12-
* Run the following command to build the tool.\
13-
12+
* Run the following command to build the tool.\\
1413

1514
```bash
1615
git checkout feat/curio-migration
@@ -19,6 +18,10 @@ Migrating from Boost to Curio involves transitioning all deal data, including Bo
1918

2019
## Preparation for Migration
2120

21+
{% hint style="warning" %}
22+
Please read the [Curio market documentation](storage-market.md) carefully before proceeding. Curio market should be fully [configured](storage-market.md#enabling-storage-market) before proceeding with migration.
23+
{% endhint %}
24+
2225
* Ensure that both Boost and Curio setups are ready for the migration. **Boost must be shutdown and no deal should be in process**. You will need the following details:
2326
* Path to the Boost repository (default is `~/.boost`)
2427
* Backup your Boost repository
@@ -90,14 +93,12 @@ For all deals that have been migrated and are in unsealed sectors, Curio handles
9093
9194
## Cleanup of Local Index Directory (LID) (optional)
9295
93-
* After the migration, you can clean up the old LevelDB (`LID`) data that was used by Boost:\
94-
96+
* After the migration, you can clean up the old LevelDB (`LID`) data that was used by Boost:\\
9597
9698
```bash
9799
migrate-curio --boost-repo <boost-repo-path> cleanup leveldb
98100
```
99-
* If the `LID` store was using YugabyteDB for storing indexes, use the following command\
100-
101+
* If the `LID` store was using YugabyteDB for storing indexes, use the following command\\
101102
102103
```bash
103104
./migrate-curio cleanup yugabyte \

documentation/en/curio-market/storage-market.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,21 @@ To enable the Curio market on a Curio node, the following configuration changes
117117
* `MaxDealsPerPublishMsg` for the maximum number of deals per message.
118118
* `MaxPublishDealFee` to set the fee limit for publishing deals.
119119
* If handling offline deals, configure `PieceLocator` to specify the endpoints for piece retrieval.
120+
8. Verify that HTTP server is working:
121+
122+
* Curl to your domain name and verify that server is reachable from outside\
123+
124+
125+
```shell
126+
curl https://<Domain name>
127+
128+
Hello, World!
129+
-Curio
130+
```
131+
132+
{% hint style="warning" %}
133+
If you do not get above output then something went wrong with configuration and you should not proceed with migration from Boost or Deal making.
134+
{% endhint %}
120135

121136
By applying these changes, the Curio market subsystem will be activated on the specified node(s), enabling storage deals, IPNI synchronization, and retrieval functionality.
122137

@@ -241,21 +256,23 @@ curio market seal --actor <actor address> <sector>
241256
Consequences: Sealing early can speed up the process, but it may result in inefficiencies if all deals are not batched correctly.
242257

243258
## Offline Verified DDO deals
244-
Curio only supports offline verified DDO deals as of now. The allocation must be created by the client for the piece and handed over to the SP alongside the data.
245259

260+
Curio only supports offline verified DDO deals as of now. The allocation must be created by the client for the piece and handed over to the SP alongside the data.
246261

247262
### How to create allocation
263+
248264
Clients can create allocation using the `sptool toolbox` or other methods.
249265

250266
```shell
251267
sptool --actor t01000 toolbox mk12-client allocate -p <MINER ID> --piece-cid <COMMP> --piece-size <PIECE SIZE>
252268
```
253269

254270
### Start a DDO deal
271+
255272
Storage providers can onboard the DDO deal using the below command.
256273

257274
```shell
258275
curio market ddo --actor <MINER ID> <client-address> <allocation-id>
259276
```
260277

261-
Since this is an offline deal, user must either make the data available via PieceLocator or add a data URL for this offline deal.
278+
Since this is an offline deal, user must either make the data available via PieceLocator or add a data URL for this offline deal.

0 commit comments

Comments
 (0)