Introduced by-name deployment and `declare-deploy` command #2331

integraledelebesgue · 2024-07-24T10:53:18Z

Closes #2279

Introduced changes

sncast deploy now allows to deploy a contract by its name instead of class hash;
--contract-name and --class-hash arguments are mutually exclusive
Added a new command - declare-deploy, used to quickly combine declaration with deployment
Command handlers build contract artifacts:
- declare, declare-deploy - always
- deploy - when depolying by name

Checklist

docs/src/starknet/deploy.md

crates/sncast/src/starknet_commands/deploy.rs

crates/sncast/src/starknet_commands/declare.rs

crates/sncast/src/helpers/scarb_utils.rs

crates/sncast/src/starknet_commands/declare.rs

crates/sncast/src/starknet_commands/deploy.rs

crates/sncast/tests/e2e/deploy.rs

docs/src/appendix/sncast/deploy.md

…` command

crates/sncast/src/main.rs

crates/sncast/src/starknet_commands/declare.rs

crates/sncast/src/starknet_commands/deploy.rs

crates/sncast/tests/e2e/declare_deploy.rs

docs/src/appendix/sncast/declare-deploy.md

docs/src/starknet/declare-deploy.md

docs/src/starknet/deploy.md

crates/sncast/src/starknet_commands/declare.rs

docs/src/starknet/declare-deploy.md

crates/sncast/src/starknet_commands/deploy.rs

crates/sncast/tests/e2e/deploy.rs

cptartur · 2024-09-23T10:07:55Z

crates/sncast/src/main.rs

+            let deploy: DeployResolved = if deploy.class_hash.is_some() {
+                deploy.try_into().unwrap()
+            } else {
+                let contract =
+                    deploy.build_artifacts_and_get_compiled_contract(cli.json, &cli.profile)?;
+                let class_hash = contract.sierra_class_hash;
+
+                if !contract.is_declared(&provider).await? {
+                    bail!("Contract with class hash {:x} is not declared", class_hash);
+                }
+
+                deploy.resolved_with_class_hash(class_hash)
+            };
+
+            deploy.validate()?;
+


So now we will explicitly fail if user tries to deploy contract that wasn't declared? What was the previous behavior. This might be worth including in a changelog if this behavior changed.

cptartur · 2024-09-23T10:08:52Z

crates/sncast/src/main.rs

@@ -233,6 +247,76 @@ async fn run_async_command(
            Ok(())
        }

+        Commands::DeclareDeploy(declare_deploy) => {


Should we explicitly document that declare-deploy behave exactly as deploy if the contract has been already declared?

cptartur · 2024-09-23T10:22:32Z

crates/sncast/src/starknet_commands/declare_deploy.rs

+use sncast::helpers::{deploy::DeployArgs, fee::FeeToken, rpc::RpcArgs};
+
+#[derive(Args)]
+#[command(about = "Deploy a contract on Starknet")]


Shouldn't it be Declare and deploy a contract on Starknet?

cptartur · 2024-09-23T10:23:19Z

crates/sncast/src/starknet_commands/deploy.rs

-    /// Calldata for the contract constructor
-    #[clap(short, long, value_delimiter = ' ', num_args = 1..)]
-    pub constructor_calldata: Vec<FieldElement>,


What happened to this argument and these below

cptartur · 2024-09-23T12:50:25Z

crates/sncast/tests/e2e/declare_deploy.rs

+}
+
+#[test]
+#[ignore = "Expand the contract's code to more complex or wait for fix: https://github.com/xJonathanLEI/starknet-rs/issues/649#issue-2469861847"]


This issue seems to be resolved. If this still cannot be addressed, let's create an issue and link TODO here.

cptartur · 2024-09-23T12:51:40Z

docs/src/starknet/declare-deploy.md

@@ -0,0 +1,32 @@
+# Joining the Declaration and Deployment Together


Maybe this would be clearer to the users? Or something similar

Suggested change

# Joining the Declaration and Deployment Together

# Deploying an Undeclared Contract

cptartur · 2024-09-23T12:51:58Z

docs/src/starknet/declare-deploy.md

+# Joining the Declaration and Deployment Together
+
+`sncast` allows declaring and deploying contracts through dedicated commands.
+The `declare-deploy` command simplifies this pipeline by performing these two actions one after the other. It is used to declare a contract and deploy it immediately.


Suggested change

The `declare-deploy` command simplifies this pipeline by performing these two actions one after the other. It is used to declare a contract and deploy it immediately.

The `declare-deploy` command simplifies this pipeline by performing these two actions at the same time. It is used to declare a contract and deploy it immediately.

I know what you wrote is technically correct, but I think my suggestion is a better description for the user

cptartur · 2024-09-23T12:55:09Z

docs/src/starknet/declare-deploy.md

+
+### General Example
+
+Make sure you have a `Scarb.toml` in your project directory. Suppose we would like to declare and instantly deploy an example contract named `SimpleBalance`, defined in the default project.


I don't think we have a contract like that in template. Maybe let's use the name of the contract that's defined there?

integraledelebesgue added 5 commits July 24, 2024 12:45

Added a compiled contract representation

eecc2e2

Redesigned declare handler

c4dbf57

Introduced deploy by name

69cf938

Improved deploy-by-name

c449de5

Added deploy-by-name tests

1f74c9c

integraledelebesgue linked an issue Jul 24, 2024 that may be closed by this pull request

Deploy contract by name #2279

Open

integraledelebesgue added 4 commits July 24, 2024 15:07

Merge branch 'master' into integraledelebesgue/feature-2279

b87ef03

Added deploy-by-name to changelog and docs

436dd28

Merge branch 'master' into integraledelebesgue/feature-2279

48ab4a9

Merge branch 'master' into integraledelebesgue/feature-2279

c84afe1

integraledelebesgue marked this pull request as ready for review July 29, 2024 08:59

integraledelebesgue requested review from Arcticae, ksew1 and tomek0123456789 as code owners July 29, 2024 08:59

integraledelebesgue requested review from Arcticae and removed request for Arcticae July 29, 2024 09:00

Arcticae requested a review from cptartur July 30, 2024 14:38

Arcticae requested changes Jul 30, 2024

View reviewed changes

integraledelebesgue added 3 commits July 31, 2024 11:08

Moved deploy-by-name example higher in the docs

f691a22

Improved descriptivity of the build_artifacts method

40b8ad7

Merge branch 'master' into integraledelebesgue/feature-2279

d6b13d3

cptartur requested changes Jul 31, 2024

View reviewed changes

integraledelebesgue added 6 commits August 5, 2024 15:48

Removed auto-declaration from deploy and introduced `declare-deploy…

873f524

…` command

Fixed clippy warnings

9739534

Merged master

41880aa

Updated declare-deploy in docs and changelog

ae24960

Updated doc summary

c29673b

Updated tests

9af83f9

integraledelebesgue requested review from Arcticae and cptartur August 8, 2024 07:43

integraledelebesgue added 2 commits August 8, 2024 12:42

Merge branch 'master' into integraledelebesgue/feature-2279

8f9502a

Simplified declare_compiled flow

6350ac6

integraledelebesgue changed the title ~~Added deploy by name~~ Introduced by-name deployment and declare-deploy command Aug 8, 2024

cptartur reviewed Aug 8, 2024

View reviewed changes

integraledelebesgue added 3 commits August 9, 2024 10:18

Updated tests

67b2b96

Updated docs

79f23e9

Merge branch 'master' into integraledelebesgue/feature-2279

fa5052f

integraledelebesgue requested a review from cptartur August 9, 2024 14:38

Optimized errors

9a60f27

cptartur reviewed Aug 26, 2024

View reviewed changes

Merge branch 'master' into integraledelebesgue/feature-2279

c272f71

integraledelebesgue requested a review from ddoktorski as a code owner August 27, 2024 09:45

integraledelebesgue added 7 commits August 27, 2024 11:46

Removed duplicated test

1d0341e

Changed salt name to more professional 🥴

15d26df

Changed notes to warnings

7578221

Changed From to TryFrom

f085c3e

Added block explorer output to declare-deploy

7b77cd3

Removed unnecessary test-runner argument

85f478e

Fixed logic related to class hashes

b11b1bc

cptartur reviewed Sep 23, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduced by-name deployment and `declare-deploy` command #2331

Introduced by-name deployment and `declare-deploy` command #2331

integraledelebesgue commented Jul 24, 2024 •

edited

Loading

cptartur Sep 23, 2024

cptartur Sep 23, 2024

cptartur Sep 23, 2024

cptartur Sep 23, 2024

cptartur Sep 23, 2024

cptartur Sep 23, 2024

cptartur Sep 23, 2024

cptartur Sep 23, 2024

cptartur Sep 23, 2024

		@@ -0,0 +1,32 @@
		# Joining the Declaration and Deployment Together

	# Joining the Declaration and Deployment Together
	# Deploying an Undeclared Contract

	The `declare-deploy` command simplifies this pipeline by performing these two actions one after the other. It is used to declare a contract and deploy it immediately.
	The `declare-deploy` command simplifies this pipeline by performing these two actions at the same time. It is used to declare a contract and deploy it immediately.


		### General Example

		Make sure you have a `Scarb.toml` in your project directory. Suppose we would like to declare and instantly deploy an example contract named `SimpleBalance`, defined in the default project.

Introduced by-name deployment and declare-deploy command #2331

Are you sure you want to change the base?

Introduced by-name deployment and declare-deploy command #2331

Conversation

integraledelebesgue commented Jul 24, 2024 • edited Loading

Introduced changes

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Introduced by-name deployment and `declare-deploy` command #2331

Introduced by-name deployment and `declare-deploy` command #2331

integraledelebesgue commented Jul 24, 2024 •

edited

Loading