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

[snapshots] split db download and formal download snapshot commands #15494

Merged
merged 5 commits into from
Jan 11, 2024

Conversation

johnjmartin
Copy link
Contributor

@johnjmartin johnjmartin commented Dec 27, 2023

Description

Removes --skip-checkpoints, --formal, --verify, and --genesis, from the download-db-snapshot command

ToolCommand::DownloadDBSnapshot {
                epoch,
                path,
                skip_indexes,
                num_parallel_downloads,
                network,
                snapshot_bucket,
                snapshot_bucket_type,
                snapshot_path,
                no_sign_request, # support TODO
                verbose,
            }

Adds: download-formal-snapshot as a future replacement for the --formal flag.

Test Plan

Tested with both formal snapshot and db snapshot changes via: #15509


If your changes are not user-facing and do not break anything, you can skip the following section. Otherwise, please briefly describe what has changed under the Release Notes section.

Type of Change (Check all that apply)

  • protocol change
  • user-visible impact
  • breaking change for a client SDKs
  • breaking change for FNs (FN binary must upgrade)
  • breaking change for validators or node operators (must upgrade binaries)
  • breaking change for on-chain data layout
  • necessitate either a data wipe or data migration

Release notes

Breaking change for the sui-tool command. This breaks the sui-tool download-db-snapshot into sui-tool download-db-snapshot and sui-tool download-formal-snapshot commands.

Copy link

vercel bot commented Dec 27, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
mysten-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 11, 2024 6:33pm
sui-core ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 11, 2024 6:33pm
sui-typescript-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 11, 2024 6:33pm
3 Ignored Deployments
Name Status Preview Comments Updated (UTC)
explorer ⬜️ Ignored (Inspect) Visit Preview Jan 11, 2024 6:33pm
multisig-toolkit ⬜️ Ignored (Inspect) Visit Preview Jan 11, 2024 6:33pm
sui-kiosk ⬜️ Ignored (Inspect) Visit Preview Jan 11, 2024 6:33pm

@johnjmartin johnjmartin changed the title split db download and formal download snapshot commands, cleanup inputs [snapshots] split db download and formal download snapshot commands, cleanup inputs Dec 27, 2023
@johnjmartin johnjmartin changed the title [snapshots] split db download and formal download snapshot commands, cleanup inputs [snapshots] split db download and formal download snapshot commands Dec 27, 2023
Copy link

vercel bot commented Dec 30, 2023

@johnjmartin is attempting to deploy a commit to the Sui Foundation Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

@williampsmith williampsmith left a comment

Choose a reason for hiding this comment

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

Don't docs get deployed to sui.io immediately? If so, we probably need to gate these doc updates somehow so that they're not visible until the new commands rollout. Actually the right way for this to work is for us to have versioned docs cc @ronny-mysten

/// for protocol versions supporting `commit_root_state_digest`. For mainnet, this is
/// epoch 20+, and for testnet this is epoch 12+
#[clap(long = "formal")]
formal: bool,
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it make sense to leave in formal for now, with a // DEPRECATED comment, and in the very beginning of the handler do something like

if formal {
  println!("--formal flag is deprecated. Please instead use `sui-tool download-formal-snapshot`");
  return Ok(());
}

Would avoid some questions and confusion from the community

docs/content/guides/operator/snapshots.mdx Outdated Show resolved Hide resolved
docs/content/guides/operator/snapshots.mdx Outdated Show resolved Hide resolved
@ronny-mysten
Copy link
Contributor

ronny-mysten commented Jan 10, 2024

Don't docs get deployed to sui.io immediately? If so, we probably need to gate these doc updates somehow so that they're not visible until the new commands rollout. Actually the right way for this to work is for us to have versioned docs cc @ronny-mysten

True. Versioned docs are a future feature. For now, we can use Tabs and TabItems to provide instructions for each version of Sui. I can add to the PR if desired.

@johnjmartin johnjmartin merged commit 01b009e into MystenLabs:main Jan 11, 2024
41 checks passed
@johnjmartin johnjmartin deleted the split-db-download branch January 11, 2024 22:57
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.

4 participants