Skip to content
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

chore: update book docs #1925

Open
wants to merge 13 commits into
base: dev
Choose a base branch
from
Open

chore: update book docs #1925

wants to merge 13 commits into from

Conversation

ctian1
Copy link
Member

@ctian1 ctian1 commented Jan 10, 2025

Update network docs with new SDK and network changes.


## Advanced Usage

### Skip simulation
If you are using the prover network in a production system, or otherwise want to use advanced features such as async, skipping local simulation, or accessing the proof ID, you should use `sp1_sdk::NetworkProver` directly.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: Setting the strategy etc.

If you're using a "reserved" set of capacity for an account (configured by the Succinct team), you should add strategy(Reserved).

Also, add information about requesting with a timeout, etc.

This is the section to show the examples of all of the advanced usage.

ratankaliani
ratankaliani previously approved these changes Jan 10, 2025
Copy link
Member

@ratankaliani ratankaliani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, some comments on how you should expand the usage section.

Copy link
Contributor

github-actions bot commented Jan 10, 2025

SP1 Performance Test Results

Branch: chris/update-docs-2
Commit: f2dcc8f
Author: ctian1

program cycles execute (mHz) core (kHZ) compress (KHz) time success
fibonacci 11291 0.18 2.78 0.46 25s
ssz-withdrawals 2757356 17.34 123.98 38.09 1m13s
tendermint 12593597 6.57 268.09 105.93 2m1s

@ratankaliani
Copy link
Member

Merge your book changes after network.succinct.xyz is the canonical frontend/URL.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants