Skip to content

Commit

Permalink
[move-prover] Print warning about the level of Prover support for Sui (
Browse files Browse the repository at this point in the history
…#14348)

## Description 

People keep trying to use Move Prover with Sui and there is currently no
easily accessible place where the current level of support is mentioned.
Adding a warning at the time when Prover is ran seems like a reasonable
thing to do here.

## Test Plan 

Verified that the warning is printed.

---
If your changes are not user-facing and not a breaking change, you can
skip the following section. Otherwise, please indicate what changed, and
then add to the Release Notes section as highlighted during the release
process.

### Type of Change (Check all that apply)

- [ ] protocol change
- [x] 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
A warning about current level of Move Prover support for Sui is now
printed when the Prover is ran.
  • Loading branch information
awelc authored Oct 27, 2023
1 parent a53af84 commit 95eead4
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions crates/sui-move/src/prove.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ use sui_types::sui_framework_address_concat_string;

const SUI_NATIVE_TEMPLATE: &[u8] = include_bytes!("sui-natives.bpl");

/// Run the Move Prover on the package at `path` (Warning: Move Prover support for Sui is currently limited)
#[derive(Parser)]
#[group(id = "sui-move-prover")]
pub struct Prover {
Expand Down Expand Up @@ -92,6 +93,7 @@ impl Prover {
),
);

eprintln!("WARNING: the level of Move Prover support for Sui is incomplete; use at your own risk as not everything is guaranteed to work (please file an issue if an update breaks existing usage but the level of current support is limited)");
let prover_result = std::thread::spawn(move || {
prove::run_move_prover(
build_config,
Expand Down

1 comment on commit 95eead4

@vercel
Copy link

@vercel vercel bot commented on 95eead4 Oct 27, 2023

Choose a reason for hiding this comment

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

Please sign in to comment.