Skip to content

Commit e9f2888

Browse files
Merge pull request #26 from boundless-xyz/Updated-Priority-List-Language
Priority list language update
2 parents 96a7a5d + c8c8bd8 commit e9f2888

File tree

2 files changed

+24
-47
lines changed

2 files changed

+24
-47
lines changed

developers/tutorials/request.mdx

Lines changed: 22 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Request a Proof
3-
description: Request a proof from the Boundless market.
4-
icon: hand-point-up
2+
title: "Request a Proof"
3+
description: "Request a proof from the Boundless market."
4+
icon: "hand-point-up"
55
---
66

77
import { PriorityRequestorForm } from '/snippets/priority-requestor-form.jsx';
@@ -16,33 +16,26 @@ Therefore, this page is split into two sections:
1616
- The second section, [Request Configuration](#request-configuration), covers all available configuration options for the 5% of requests that require fine-tuning.
1717

1818
<Note>
19-
The *Sending a Request* section uses the counter example as a template, its
20-
source code can be found at:
21-
[boundless/examples/counter](https://github.com/boundless-xyz/boundless/tree/main/examples/counter)
19+
The _Sending a Request_ section uses the counter example as a template, its source code can be found at: [boundless/examples/counter](https://github.com/boundless-xyz/boundless/tree/main/examples/counter)
2220
</Note>
2321

2422
## Sending a Request
2523

2624
<Note>
27-
If you want to submit a one-off request via the Boundless CLI, please see
28-
[Requesting a Proof via the Boundless
25+
If you want to submit a one-off request via the Boundless CLI, please see [Requesting a Proof via the Boundless
2926
CLI](/developers/tooling/cli#requesting-a-proof-via-the-boundless-cli).
3027
</Note>
3128

3229
### 1. Setting environment variables
3330

3431
<Tip>
35-
We recommend using [clap](https://crates.io/crates/clap) to parse these
36-
environment variables, as seen in
37-
[apps/L37-52](https://github.com/boundless-xyz/boundless/blob/cdc2435b6119a009c2cc73dc227a250bee7594fc/examples/counter/apps/src/main.rs#L37-L52).
32+
We recommend using [clap](https://crates.io/crates/clap) to parse these environment variables, as seen in [apps/L37-52](https://github.com/boundless-xyz/boundless/blob/cdc2435b6119a009c2cc73dc227a250bee7594fc/examples/counter/apps/src/main.rs#L37-L52).
3833
</Tip>
3934

4035
#### Blockchain
4136

4237
<Tip>
43-
We recommend using Alchemy for your RPC URL during testing; their free tier is
44-
more than enough to test requesting a proof. Receiving proofs requires event
45-
queries, which public RPCs may not support.
38+
We recommend using Alchemy for your RPC URL during testing; their free tier is more than enough to test requesting a proof. Receiving proofs requires event queries, which public RPCs may not support.
4639
</Tip>
4740

4841
Since we are submitting requests onchain, we will need private key for a wallet with sufficient funds on Sepolia, and a working RPC URL:
@@ -55,12 +48,11 @@ export PRIVATE_KEY="abcdef..."
5548
#### Storage Provider
5649

5750
<Tip>
58-
For this tutorial, we suggest using a Pinata API key which will upload your program at runtime.
51+
For this tutorial, we suggest using a Pinata API key which will upload your program at runtime.
5952

60-
If you do not want to use an API key, or if you want to use a provider other than Pinata, you can pre-upload you program to a public URL (this could be hosted via Pinata or any other service).
61-
62-
To see more information about this option, please read [No Storage Provider](/developers/tutorials/request#no-storage-provider).
53+
If you do not want to use an API key, or if you want to use a provider other than Pinata, you can pre-upload you program to a public URL (this could be hosted via Pinata or any other service).
6354

55+
To see more information about this option, please read [No Storage Provider](/developers/tutorials/request#no-storage-provider).
6456
</Tip>
6557

6658
To make a program, and its inputs, accessible to provers, they need to be hosted at a public URL. We recommend using IPFS for storage, particularly via [Pinata](https://pinata.cloud), as their free tier comfortably covers most Boundless use cases.
@@ -200,13 +192,11 @@ let request = client.new_request()
200192
### Inputs
201193

202194
<Tip>
203-
When working with trusted provers, you can store inputs in *Amazon S3* and
204-
restrict access via AWS S3's permission management - [Sensitive Inputs
195+
When working with trusted provers, you can store inputs in _Amazon S3_ and restrict access via AWS S3's permission management - [Sensitive Inputs
205196
tutorial](/developers/tutorials/sensitive-inputs).
206197
</Tip>
207198

208-
To execute and run proving, the prover requires the inputs of the program.
209-
Inputs can be provides as a public URL, or "inline" by including them directly in the request.
199+
To execute and run proving, the prover requires the inputs of the program. Inputs can be provides as a public URL, or "inline" by including them directly in the request.
210200

211201
Program inputs are uploaded to the same storage provider. This can be done manually like so:
212202

@@ -226,8 +216,7 @@ let (request_id, expires_at) = client.submit_onchain(request).await?;
226216

227217
In this example, inputs are included inline if they are small (e.g. less than 1 kB) or uploaded to a public URL first if they are large.
228218

229-
When submitting requests onchain with inline inputs, this will cost more gas if the inputs are large.
230-
The offchain order-stream service also places limits on the size of inline input.
219+
When submitting requests onchain with inline inputs, this will cost more gas if the inputs are large. The offchain order-stream service also places limits on the size of inline input.
231220

232221
### Proof Types
233222

@@ -264,9 +253,7 @@ let request = client
264253
```
265254

266255
<Note>
267-
Blake3 Groth16 proofs are only supported with the `ClaimDigestMatch`
268-
predicate, meaning you should only use this if you do not require the journal
269-
to be delivered on-chain. Additionally, the journal must be exactly 32 bytes.
256+
Blake3 Groth16 proofs are only supported with the `ClaimDigestMatch` predicate, meaning you should only use this if you do not require the journal to be delivered on-chain. Additionally, the journal must be exactly 32 bytes.
270257
</Note>
271258

272259
For more details on proof types and when to use each, see [Proof Types](/developers/tutorials/proof-types).
@@ -290,9 +277,7 @@ let (request_id, expires_at) = client.submit_onchain(request).await?; // [!code
290277
#### Offchain
291278

292279
<Note>
293-
When using offchain requests, you are required to deposit funds into the
294-
Boundless market contract before you can make any proof requests. This can be
295-
done with the [Boundless CLI](/developers/tooling/cli#requestor).
280+
When using offchain requests, you are required to deposit funds into the Boundless market contract before you can make any proof requests. This can be done with the [Boundless CLI](/developers/tooling/cli#requestor).
296281
</Note>
297282

298283
To submit a request offchain, we use:
@@ -322,7 +307,6 @@ There are two ways to configure auction parameters:
322307
- You want to configure cycle-based pricing that applies to all requests
323308
- You need to adjust gas estimates or other calculation parameters
324309
- You want consistent pricing logic across multiple requests
325-
326310
- Use `with_offer` when:
327311
- You need to override the automatic calculations for a specific request
328312
- You want to set exact prices rather than using cycle-based and gas-price calculations
@@ -384,10 +368,8 @@ With this configuration, the SDK will execute the request to estimate cycles and
384368
### Funding Modes
385369

386370
<Warning>
387-
For most use-cases, we recommend using the default setting of `Always`, which
388-
ensures that your requests will always be fully funded and thus can be
389-
fulfilled by the network. *Setting any other funding mode is considered an
390-
advanced feature*, and may lead to a degredation of proof fufillment rate.
371+
For most use-cases, we recommend using the default setting of `Always`, which ensures that your requests will always be fully funded and thus can be fulfilled by the network. _Setting any other funding mode is considered an
372+
advanced feature_, and may lead to a degredation of proof fufillment rate.
391373
</Warning>
392374

393375
When submitting requests onchain, the Boundless Market SDK needs to fund the request with ETH to cover the `max_price` (see [ Auction Parameters](/developers/tutorials/auction#what-auction-parameters-are-configurable)) of the proof.
@@ -415,8 +397,7 @@ let funding_mode = FundingMode::Always;
415397
```
416398

417399
<Tip>
418-
If your balance is more than 3x the `max_price`, the SDK will log a warning
419-
suggesting you consider a different funding mode to avoid overfunding.
400+
If your balance is more than 3x the `max_price`, the SDK will log a warning suggesting you consider a different funding mode to avoid overfunding.
420401
</Tip>
421402

422403
#### Never
@@ -428,8 +409,7 @@ let funding_mode = FundingMode::Never;
428409
```
429410

430411
<Warning>
431-
When using `Never` mode, you must ensure your onchain balance is sufficient to
432-
cover the `max_price` of each request. Otherwise, requests may fail.
412+
When using `Never` mode, you must ensure your onchain balance is sufficient to cover the `max_price` of each request. Otherwise, requests may fail.
433413
</Warning>
434414

435415
#### AvailableBalance
@@ -452,9 +432,7 @@ let funding_mode = FundingMode::BelowThreshold(threshold);
452432
```
453433

454434
<Tip>
455-
Set the threshold appropriately to avoid underfunding. The threshold should be
456-
at least as large as your typical `max_price` to ensure requests can be funded
457-
when needed.
435+
Set the threshold appropriately to avoid underfunding. The threshold should be at least as large as your typical `max_price` to ensure requests can be funded when needed.
458436
</Tip>
459437

460438
#### MinMaxBalance
@@ -473,6 +451,5 @@ let funding_mode = FundingMode::MinMaxBalance {
473451
This mode should minimize the number of onchain fundings while ensuring sufficient balance is maintained. It's ideal for applications that make frequent requests and want to optimize gas costs by reducing the number of funding transactions.
474452

475453
<Tip>
476-
When the balance drops below `min_balance`, the SDK will fund up to
477-
`max_balance` in a single transaction, reducing the need for frequent top-ups.
478-
</Tip>
454+
When the balance drops below `min_balance`, the SDK will fund up to `max_balance` in a single transaction, reducing the need for frequent top-ups.
455+
</Tip>

snippets/priority-requestor-form.jsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ export const PriorityRequestorForm = () => {
1010
<div className="text-sm text-amber-800 dark:text-amber-300 space-y-3">
1111
<p>
1212
For the best experience, we offer a priority requestor list that
13-
provides optimal performance for proof requests. Fill out the form
14-
below to be considered for testing credits and priority access.
13+
provides optimal performance for requestors looking to go to production. Fill out the form
14+
below to be considered for developer assistance.
1515
</p>
1616
</div>
1717

0 commit comments

Comments
 (0)