You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: documentation/en/curio-market/deal-filters.md
+70-1Lines changed: 70 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ description: How to setup and use storage deal filters
6
6
7
7
## Overview
8
8
9
-
Curio provides a flexible filtering system to manage storage deals effectively. The filters allow you to:
9
+
Curio provides a flexible filtering system to manage storage deals effectively. User have an option to choose from external filter like [CIDGravity](#cidgravity-filter) and built-in filters. The built-in filters allow you to:
10
10
11
11
* Set pricing rules based on deal duration, size, and whether the data is verified.
12
12
* Define client-specific rules, including rate limits and acceptable wallets or peers.
@@ -172,3 +172,72 @@ DenyUnknownClients bool
172
172
* Verify the order and specificity of your filters.
173
173
* Check the Allow/Deny List for conflicting entries.
174
174
* Review client filters to ensure they are active and correctly configured.
175
+
176
+
# CIDGravity Filter
177
+
178
+
## What is CIDGravity?
179
+
180
+
[CIDGravity](https://www.cidgravity.com/) is a powerful pricing and client management tool designed for Filecoin storage providers. It enables storage providers to efficiently filter storage and retrieval deals through a user-friendly interface. With CIDGravity, providers can set rules and policies for accepting or rejecting deals based on their business preferences, ensuring better control over their storage operations.
181
+
182
+
For more details, refer to the [CIDGravity documentation](https://docs.cidgravity.com/).
183
+
184
+
## How to Enable CIDGravity in Curio
185
+
186
+
CIDGravity integration in Curio is controlled through Curio configuration. To enable CIDGravity, you need to set the below parameters in the configuration.
187
+
We highly recommend setting these values in "market" layer or a layer used by all market nodes to control the market behaviour.
188
+
189
+
```toml
190
+
# CIDGravityToken is the authorization token to use for CIDGravity filters.
191
+
# If empty then CIDGravity filters are not called.
192
+
#
193
+
# type: string
194
+
#CIDGravityToken = ""
195
+
196
+
# DefaultCIDGravityAccept when set to true till accept deals when CIDGravity service is not available.
197
+
# Default behaviors is to reject the deals
198
+
#
199
+
# type: bool
200
+
#DefaultCIDGravityAccept = false
201
+
```
202
+
203
+
### Configuration Options:
204
+
205
+
#### 1. `CIDGravityToken`
206
+
-**Description**: This is the authorization token required to use CIDGravity filters.
207
+
-**Default Behavior**: If left empty, CIDGravity filters will not be applied.
208
+
-**Type**: `string`
209
+
210
+
**Example Configuration:**
211
+
```toml
212
+
CIDGravityToken = "your-auth-token-here"
213
+
```
214
+
215
+
{% hint style="info" %}
216
+
To generate a CIDGravity token [claim your miner](https://docs.cidgravity.com/storage-providers/get-started/claim-a-miner/) in CIDGravity. If you already have an existing miner then you can use the same token.
217
+
{% endhint %}
218
+
219
+
#### 2. `DefaultCIDGravityAccept`
220
+
-**Description**: Defines the default behavior when the CIDGravity service is unavailable.
221
+
-**Default Behavior**: If set to `false`, deals will be rejected when CIDGravity is not reachable. If set to `true`, deals will be accepted even if CIDGravity is not available.
222
+
-**Type**: `bool`
223
+
224
+
**Example Configuration:**
225
+
```toml
226
+
DefaultCIDGravityAccept = false
227
+
```
228
+
229
+
### Steps to Enable CIDGravity in Curio:
230
+
1. Obtain a **CIDGravityToken** from the [CIDGravity platform](https://app.cidgravity.com/).
231
+
2. Add the token to the Curio configuration file under `CIDGravityToken`.
232
+
3. Set `DefaultCIDGravityAccept` based on your preference:
233
+
-`true` to accept deals when CIDGravity is unreachable.
234
+
-`false` to reject deals when CIDGravity is unreachable.
Once enabled, Curio will automatically interact with CIDGravity to apply deal filtering and pricing rules according to the policies set in your CIDGravity account.
0 commit comments