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

feat: add arg parsing to deploy command to support new constructor feature #1570

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion FULL_HELP_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,11 @@ If no keys are specified the contract itself is extended.

Deploy a wasm contract

**Usage:** `stellar contract deploy [OPTIONS] --source-account <SOURCE_ACCOUNT> <--wasm <WASM>|--wasm-hash <WASM_HASH>>`
**Usage:** `stellar contract deploy [OPTIONS] --source-account <SOURCE_ACCOUNT> <--wasm <WASM>|--wasm-hash <WASM_HASH>> [-- <CONTRACT_CONSTRUCTOR_ARGS>...]`

###### **Arguments:**

* `<CONTRACT_CONSTRUCTOR_ARGS>` — If provided, in one transaction will deploy and call `__constructor` with provided arguments for that function as `--arg-name value`

###### **Options:**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,11 @@ impl Contract {
);
log!(&env, "hello {}", str);
}

/// Example constructor
pub fn __constructor(env: Env, world: String) {
log!(&env, "Initialized with {}", world);
}
}

#[cfg(test)]
Expand Down
106 changes: 78 additions & 28 deletions cmd/soroban-cli/src/commands/contract/deploy/wasm.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use std::array::TryFromSliceError;
use std::fmt::Debug;
use std::num::ParseIntError;
use std::{array::TryFromSliceError, ffi::OsString};

use clap::{arg, command, Parser};
use rand::Rng;
Expand All @@ -14,7 +14,11 @@ use soroban_env_host::{
},
HostError,
};
use soroban_sdk::xdr::InvokeContractArgs;
use soroban_spec_tools::contract as contract_spec;

use crate::commands::contract::arg_parsing;
use crate::utils::rpc::get_remote_wasm_from_hash;
use crate::{
commands::{contract::install, HEADING_RPC},
config::{self, data, locator, network},
Expand All @@ -31,6 +35,8 @@ use crate::{
print::Print,
};

pub const CONSTRUCTOR_FUNCTION_NAME: &str = "__constructor";

#[derive(Parser, Debug, Clone)]
#[command(group(
clap::ArgGroup::new("wasm_src")
Expand Down Expand Up @@ -63,6 +69,9 @@ pub struct Cmd {
/// configuration without asking for confirmation.
#[arg(long, value_parser = clap::builder::ValueParser::new(alias_validator))]
pub alias: Option<String>,
/// If provided, in one transaction will deploy and call `__constructor` with provided arguments for that function as `--arg-name value`
#[arg(last = true, id = "CONTRACT_CONSTRUCTOR_ARGS")]
pub slop: Vec<OsString>,
}

#[derive(thiserror::Error, Debug)]
Expand Down Expand Up @@ -115,6 +124,10 @@ pub enum Error {
InvalidAliasFormat { alias: String },
#[error(transparent)]
Locator(#[from] locator::Error),
#[error(transparent)]
ContractSpec(#[from] contract_spec::Error),
#[error(transparent)]
ArgParse(#[from] arg_parsing::Error),
}

impl Cmd {
Expand Down Expand Up @@ -160,6 +173,7 @@ impl NetworkRunnable for Cmd {
type Error = Error;
type Result = TxnResult<String>;

#[allow(clippy::too_many_lines)]
async fn run_against_rpc_server(
&self,
global_args: Option<&global::Args>,
Expand Down Expand Up @@ -213,20 +227,54 @@ impl NetworkRunnable for Cmd {
.verify_network_passphrase(Some(&network.network_passphrase))
.await?;
let key = config.key_pair()?;
let source_account = AccountId(PublicKey::PublicKeyTypeEd25519(
key.verifying_key().to_bytes().into(),
));

let contract_id_preimage = ContractIdPreimage::Address(ContractIdPreimageFromAddress {
address: ScAddress::Account(source_account),
salt: Uint256(salt),
});
let contract_id =
get_contract_id(contract_id_preimage.clone(), &network.network_passphrase)?;
let raw_wasm = if let Some(wasm) = self.wasm.as_ref() {
wasm::Args { wasm: wasm.clone() }.read()?
} else {
get_remote_wasm_from_hash(&client, &wasm_hash).await?
};
let entries = soroban_spec_tools::contract::Spec::new(&raw_wasm)?.spec;
let res = soroban_spec_tools::Spec::new(entries.clone());
let constructor_params = if res.find_function(CONSTRUCTOR_FUNCTION_NAME).is_ok() {
let mut slop = vec![OsString::from(CONSTRUCTOR_FUNCTION_NAME)];
slop.extend_from_slice(&self.slop);
if let Ok((_, _, args, _)) = arg_parsing::build_host_function_parameters(
&stellar_strkey::Contract(contract_id.0),
&slop,
&entries,
config,
) {
Some(args)
} else {
print.warnln("Contract has `__constructor` function but no arguments provided so skipping deploy and init");
None
}
} else {
None
};

// Get the account sequence number
let public_strkey =
stellar_strkey::ed25519::PublicKey(key.verifying_key().to_bytes()).to_string();

let account_details = client.get_account(&public_strkey).await?;
let sequence: i64 = account_details.seq_num.into();
let (txn, contract_id) = build_create_contract_tx(
let txn = build_create_contract_tx(
wasm_hash,
sequence + 1,
self.fee.fee,
&network.network_passphrase,
salt,
&key,
contract_id_preimage,
constructor_params.as_ref(),
)?;

if self.fee.build_only {
Expand Down Expand Up @@ -269,29 +317,22 @@ impl NetworkRunnable for Cmd {
}

fn build_create_contract_tx(
hash: Hash,
wasm_hash: Hash,
sequence: i64,
fee: u32,
network_passphrase: &str,
salt: [u8; 32],
key: &ed25519_dalek::SigningKey,
) -> Result<(Transaction, Hash), Error> {
let source_account = AccountId(PublicKey::PublicKeyTypeEd25519(
key.verifying_key().to_bytes().into(),
));

let contract_id_preimage = ContractIdPreimage::Address(ContractIdPreimageFromAddress {
address: ScAddress::Account(source_account),
salt: Uint256(salt),
});
let contract_id = get_contract_id(contract_id_preimage.clone(), network_passphrase)?;

contract_id_preimage: ContractIdPreimage,
constructor_params: Option<&InvokeContractArgs>,
) -> Result<Transaction, Error> {
if let Some(constructor_args) = constructor_params {
eprintln!("Deploying with constructor arguments {constructor_args:#?}");
}
let op = Operation {
source_account: None,
body: OperationBody::InvokeHostFunction(InvokeHostFunctionOp {
host_function: HostFunction::CreateContract(CreateContractArgs {
contract_id_preimage,
executable: ContractExecutable::Wasm(hash),
executable: ContractExecutable::Wasm(wasm_hash),
}),
auth: VecM::default(),
}),
Expand All @@ -306,7 +347,7 @@ fn build_create_contract_tx(
ext: TransactionExt::V0,
};

Ok((tx, Hash(contract_id.into())))
Ok(tx)
}

#[cfg(test)]
Expand All @@ -319,15 +360,24 @@ mod tests {
.unwrap()
.try_into()
.unwrap();
let result = build_create_contract_tx(
Hash(hash),
300,
1,
"Public Global Stellar Network ; September 2015",
[0u8; 32],
let salt = [0u8; 32];
let key =
&utils::parse_secret_key("SBFGFF27Y64ZUGFAIG5AMJGQODZZKV2YQKAVUUN4HNE24XZXD2OEUVUP")
.unwrap(),
);
.unwrap();
let source_account = AccountId(PublicKey::PublicKeyTypeEd25519(
key.verifying_key().to_bytes().into(),
));

let contract_id_preimage = ContractIdPreimage::Address(ContractIdPreimageFromAddress {
address: ScAddress::Account(source_account),
salt: Uint256(salt),
});
// let contract_id = get_contract_id(
// contract_id_preimage.clone(),
// "Public Global Stellar Network ; September 2015",
// )
// .unwrap();
let result = build_create_contract_tx(Hash(hash), 300, 1, key, contract_id_preimage, None);

assert!(result.is_ok());
}
Expand Down
Loading