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

CLI: inconsistencies in silent auto-restoring of expired entries #1023

Open
c0linw opened this issue Oct 12, 2023 · 5 comments
Open

CLI: inconsistencies in silent auto-restoring of expired entries #1023

c0linw opened this issue Oct 12, 2023 · 5 comments
Assignees
Labels
cli Related to Soroban CLI

Comments

@c0linw
Copy link

c0linw commented Oct 12, 2023

The CLI will silently restore contract entries when using soroban contract invoke, but not when using soroban contract bump. This could confuse developers when they are able to call a contract that cannot be found, or make it unclear that the contract actually needs to be bumped. It may be helpful to keep the behaviour consistent across CLI operations either by adding the silent restore to all relevant operations, or by removing it.

image

@willemneal willemneal self-assigned this Oct 13, 2023
@stellarsaur
Copy link
Contributor

Is there an equivalent to soroban contract bump now that it's removed (according to latest changes on main)? Looks like soroban contract invoke is still silently restoring contract entries, unless I'm mistaken.

@leighmcculloch
Copy link
Member

Bump was renamed to extend in:

@stellarsaur stellarsaur added the cli Related to Soroban CLI label Dec 4, 2023
@github-project-automation github-project-automation bot moved this to Backlog in DevX Jan 29, 2024
@CollinsC1O
Copy link

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hello I'm a frontend and also a blockchain developer and I would love to work on this issue.

@gregemax
Copy link

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I have extensive experience working with CLI tools in JavaScript, TypeScript, Go, and Rust, including contributing to open-source projects. My background in designing consistent user experiences in CLI tools, particularly in ensuring predictable and clear behavior for developers, will be valuable in addressing this issue.

How I plan on tackling this issue

I would first analyze the root cause of the silent auto-restoring behavior by examining both soroban contract invoke and soroban contract bump commands. My approach would focus on ensuring consistency across these operations. To achieve this, I would:

Determine whether to standardize the silent restore behavior for all CLI operations or remove it entirely.
Update the documentation to clearly outline the behavior for each command.
Implement tests to validate consistent behavior across both scenarios, ensuring developers have a clear understanding of when and why a contract is restored or needs to be bumped.

@gregemax
Copy link

Thank you I will start right away

@janewang janewang removed the ODHack8 label Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Related to Soroban CLI
Projects
Status: Backlog (Not Ready)
Development

No branches or pull requests

7 participants