feat(contract invoke): support contract aliases when parsing address (#…

…1765) * feat(contract invoke): support contract aliases when parsing address fixes: 1764 * fix: only parse with address typedefs * fix: fmt * split two logics combined into one fn * feat: rename to unresolvedX to make it names clearer * fix: fmt and add tests * feat: ban overlapping names * fix: tests * fix: tests --------- Co-authored-by: Leigh McCulloch <[email protected]>
stellar · Dec 20, 2024 · 497efe8 · 497efe8
1 parent 1c0d4e6
commit 497efe8
Show file tree

Hide file tree

Showing 18 changed files with 263 additions and 61 deletions.
diff --git a/cmd/crates/soroban-test/tests/it/config.rs b/cmd/crates/soroban-test/tests/it/config.rs
@@ -393,3 +393,47 @@ fn set_default_network() {
         .stdout(predicate::str::contains("STELLAR_NETWORK=testnet"))
         .success();
 }
+
+#[test]
+fn cannot_create_contract_with_test_name() {
+    let sandbox = TestEnv::default();
+    sandbox
+        .new_assert_cmd("keys")
+        .arg("generate")
+        .arg("--no-fund")
+        .arg("d")
+        .assert()
+        .success();
+    sandbox
+        .new_assert_cmd("contract")
+        .arg("alias")
+        .arg("add")
+        .arg("d")
+        .arg("--id=CA3D5KRYM6CB7OWQ6TWYRR3Z4T7GNZLKERYNZGGA5SOAOPIFY6YQGAXE")
+        .assert()
+        .stderr(predicate::str::contains("cannot overlap with key"))
+        .failure();
+}
+
+#[test]
+fn cannot_create_key_with_alias() {
+    let sandbox = TestEnv::default();
+    sandbox
+        .new_assert_cmd("contract")
+        .arg("alias")
+        .arg("add")
+        .arg("t")
+        .arg("--id=CA3D5KRYM6CB7OWQ6TWYRR3Z4T7GNZLKERYNZGGA5SOAOPIFY6YQGAXE")
+        .assert()
+        .success();
+    sandbox
+        .new_assert_cmd("keys")
+        .arg("generate")
+        .arg("--no-fund")
+        .arg("t")
+        .assert()
+        .stderr(predicate::str::contains(
+            "cannot overlap with contract alias",
+        ))
+        .failure();
+}
diff --git a/cmd/crates/soroban-test/tests/it/integration/custom_types.rs b/cmd/crates/soroban-test/tests/it/integration/custom_types.rs
@@ -5,7 +5,7 @@ use soroban_test::TestEnv;
 
 use crate::integration::util::{deploy_custom, extend_contract};
 
-use super::util::invoke_with_roundtrip;
+use super::util::{invoke, invoke_with_roundtrip};
 
 fn invoke_custom(e: &TestEnv, id: &str, func: &str) -> assert_cmd::Command {
     let mut s = e.new_assert_cmd("contract");
@@ -40,7 +40,9 @@ async fn parse() {
     negative_i32(sandbox, id).await;
     negative_i64(sandbox, id).await;
     account_address(sandbox, id).await;
+    account_address_with_alias(sandbox, id).await;
     contract_address(sandbox, id).await;
+    contract_address_with_alias(sandbox, id).await;
     bytes(sandbox, id).await;
     const_enum(sandbox, id).await;
     number_arg_return_ok(sandbox, id);
@@ -237,6 +239,12 @@ async fn account_address(sandbox: &TestEnv, id: &str) {
     .await;
 }
 
+async fn account_address_with_alias(sandbox: &TestEnv, id: &str) {
+    let res = invoke(sandbox, id, "addresse", &json!("test").to_string()).await;
+    let test = format!("\"{}\"", super::tx::operations::test_address(sandbox));
+    assert_eq!(test, res);
+}
+
 async fn contract_address(sandbox: &TestEnv, id: &str) {
     invoke_with_roundtrip(
         sandbox,
@@ -247,6 +255,22 @@ async fn contract_address(sandbox: &TestEnv, id: &str) {
     .await;
 }
 
+async fn contract_address_with_alias(sandbox: &TestEnv, id: &str) {
+    sandbox
+        .new_assert_cmd("contract")
+        .arg("alias")
+        .arg("add")
+        .arg("test_contract")
+        .arg("--id=CA3D5KRYM6CB7OWQ6TWYRR3Z4T7GNZLKERYNZGGA5SOAOPIFY6YQGAXE")
+        .assert()
+        .success();
+    let res = invoke(sandbox, id, "addresse", &json!("test_contract").to_string()).await;
+    assert_eq!(
+        res,
+        "\"CA3D5KRYM6CB7OWQ6TWYRR3Z4T7GNZLKERYNZGGA5SOAOPIFY6YQGAXE\""
+    );
+}
+
 async fn bytes(sandbox: &TestEnv, id: &str) {
     invoke_with_roundtrip(sandbox, id, "bytes", json!("7374656c6c6172")).await;
 }

diff --git a/cmd/crates/soroban-test/tests/it/integration/tx.rs b/cmd/crates/soroban-test/tests/it/integration/tx.rs
@@ -4,7 +4,7 @@ use soroban_test::{AssertExt, TestEnv};
 
 use crate::integration::util::{deploy_contract, DeployKind, HELLO_WORLD};
 
-mod operations;
+pub mod operations;
 
 #[tokio::test]
 async fn simulate() {

diff --git a/cmd/crates/soroban-test/tests/it/integration/tx/operations.rs b/cmd/crates/soroban-test/tests/it/integration/tx/operations.rs
@@ -11,7 +11,7 @@ use crate::integration::{
     util::{deploy_contract, DeployKind, HELLO_WORLD},
 };
 
-fn test_address(sandbox: &TestEnv) -> String {
+pub fn test_address(sandbox: &TestEnv) -> String {
     sandbox
         .new_assert_cmd("keys")
         .arg("address")

diff --git a/cmd/crates/soroban-test/tests/it/integration/util.rs b/cmd/crates/soroban-test/tests/it/integration/util.rs
@@ -11,16 +11,19 @@ pub const CUSTOM_TYPES: &Wasm = &Wasm::Custom("test-wasms", "test_custom_types")
 pub const CUSTOM_ACCOUNT: &Wasm = &Wasm::Custom("test-wasms", "test_custom_account");
 pub const SWAP: &Wasm = &Wasm::Custom("test-wasms", "test_swap");
 
+pub async fn invoke(sandbox: &TestEnv, id: &str, func: &str, data: &str) -> String {
+    sandbox
+        .invoke_with_test(&["--id", id, "--", func, &format!("--{func}"), data])
+        .await
+        .unwrap()
+}
 pub async fn invoke_with_roundtrip<D>(e: &TestEnv, id: &str, func: &str, data: D)
 where
     D: Display,
 {
     let data = data.to_string();
     println!("{data}");
-    let res = e
-        .invoke_with_test(&["--id", id, "--", func, &format!("--{func}"), &data])
-        .await
-        .unwrap();
+    let res = invoke(e, id, func, &data).await;
     assert_eq!(res, data);
 }
 

diff --git a/cmd/soroban-cli/src/commands/contract/arg_parsing.rs b/cmd/soroban-cli/src/commands/contract/arg_parsing.rs
@@ -9,12 +9,14 @@ use ed25519_dalek::SigningKey;
 use heck::ToKebabCase;
 
 use crate::xdr::{
-    self, Hash, InvokeContractArgs, ScAddress, ScSpecEntry, ScSpecFunctionV0, ScSpecTypeDef, ScVal,
-    ScVec,
+    self, Hash, InvokeContractArgs, ScSpecEntry, ScSpecFunctionV0, ScSpecTypeDef, ScVal, ScVec,
 };
 
 use crate::commands::txn_result::TxnResult;
-use crate::config::{self};
+use crate::config::{
+    self,
+    sc_address::{self, UnresolvedScAddress},
+};
 use soroban_spec_tools::Spec;
 
 #[derive(thiserror::Error, Debug)]
@@ -43,6 +45,10 @@ pub enum Error {
     MissingArgument(String),
     #[error("")]
     MissingFileArg(PathBuf),
+    #[error(transparent)]
+    ScAddress(#[from] sc_address::Error),
+    #[error(transparent)]
+    Config(#[from] config::Error),
 }
 
 pub fn build_host_function_parameters(
@@ -80,18 +86,18 @@ pub fn build_host_function_parameters(
         .map(|i| {
             let name = i.name.to_utf8_string()?;
             if let Some(mut val) = matches_.get_raw(&name) {
-                let mut s = val.next().unwrap().to_string_lossy().to_string();
+                let mut s = val
+                    .next()
+                    .unwrap()
+                    .to_string_lossy()
+                    .trim_matches('"')
+                    .to_string();
                 if matches!(i.type_, ScSpecTypeDef::Address) {
-                    let cmd = crate::commands::keys::address::Cmd {
-                        name: s.clone(),
-                        hd_path: Some(0),
-                        locator: config.locator.clone(),
-                    };
-                    if let Ok(address) = cmd.public_key() {
-                        s = address.to_string();
-                    }
-                    if let Ok(key) = cmd.private_key() {
-                        signers.push(key);
+                    let addr = resolve_address(&s, config)?;
+                    let signer = resolve_signer(&s, config);
+                    s = addr;
+                    if let Some(signer) = signer {
+                        signers.push(signer);
                     }
                 }
                 spec.from_string(&s, &i.type_)
@@ -125,7 +131,7 @@ pub fn build_host_function_parameters(
         })
         .collect::<Result<Vec<_>, Error>>()?;
 
-    let contract_address_arg = ScAddress::Contract(Hash(contract_id.0));
+    let contract_address_arg = xdr::ScAddress::Contract(Hash(contract_id.0));
     let function_symbol_arg = function
         .try_into()
         .map_err(|()| Error::FunctionNameTooLong(function.clone()))?;
@@ -246,3 +252,27 @@ pub fn output_to_string(
     }
     Ok(TxnResult::Res(res_str))
 }
+
+fn resolve_address(addr_or_alias: &str, config: &config::Args) -> Result<String, Error> {
+    let sc_address: UnresolvedScAddress = addr_or_alias.parse().unwrap();
+    let account = match sc_address {
+        UnresolvedScAddress::Resolved(addr) => addr.to_string(),
+        addr @ UnresolvedScAddress::Alias(_) => {
+            let addr = addr.resolve(&config.locator, &config.get_network()?.network_passphrase)?;
+            match addr {
+                xdr::ScAddress::Account(account) => account.to_string(),
+                contract @ xdr::ScAddress::Contract(_) => contract.to_string(),
+            }
+        }
+    };
+    Ok(account)
+}
+
+fn resolve_signer(addr_or_alias: &str, config: &config::Args) -> Option<SigningKey> {
+    let cmd = crate::commands::keys::address::Cmd {
+        name: addr_or_alias.to_string(),
+        hd_path: Some(0),
+        locator: config.locator.clone(),
+    };
+    cmd.private_key().ok()
+}
diff --git a/cmd/soroban-cli/src/commands/contract/fetch.rs b/cmd/soroban-cli/src/commands/contract/fetch.rs
@@ -22,7 +22,7 @@ use crate::{
 pub struct Cmd {
     /// Contract ID to fetch
     #[arg(long = "id", env = "STELLAR_CONTRACT_ID")]
-    pub contract_id: config::ContractAddress,
+    pub contract_id: config::UnresolvedContract,
     /// Where to write output otherwise stdout is used
     #[arg(long, short = 'o')]
     pub out_file: Option<std::path::PathBuf>,

diff --git a/cmd/soroban-cli/src/commands/contract/info/shared.rs b/cmd/soroban-cli/src/commands/contract/info/shared.rs
@@ -47,7 +47,7 @@ pub struct Args {
         conflicts_with = "wasm",
         conflicts_with = "wasm_hash"
     )]
-    pub contract_id: Option<config::ContractAddress>,
+    pub contract_id: Option<config::UnresolvedContract>,
     #[command(flatten)]
     pub network: network::Args,
     #[command(flatten)]

diff --git a/cmd/soroban-cli/src/commands/contract/invoke.rs b/cmd/soroban-cli/src/commands/contract/invoke.rs
@@ -40,7 +40,7 @@ use soroban_spec_tools::contract;
 pub struct Cmd {
     /// Contract ID to invoke
     #[arg(long = "id", env = "STELLAR_CONTRACT_ID")]
-    pub contract_id: config::ContractAddress,
+    pub contract_id: config::UnresolvedContract,
     // For testing only
     #[arg(skip)]
     pub wasm: Option<std::path::PathBuf>,

diff --git a/cmd/soroban-cli/src/commands/events.rs b/cmd/soroban-cli/src/commands/events.rs
@@ -42,7 +42,7 @@ pub struct Cmd {
         num_args = 1..=6,
         help_heading = "FILTERS"
     )]
-    contract_ids: Vec<config::ContractAddress>,
+    contract_ids: Vec<config::UnresolvedContract>,
     /// A set of (up to 4) topic filters to filter event topics on. A single
     /// topic filter can contain 1-4 different segment filters, separated by
     /// commas, with an asterisk (`*` character) indicating a wildcard segment.

diff --git a/cmd/soroban-cli/src/commands/snapshot/create.rs b/cmd/soroban-cli/src/commands/snapshot/create.rs
@@ -34,7 +34,7 @@ use crate::{
     tx::builder,
     utils::get_name_from_stellar_asset_contract_storage,
 };
-use crate::{config::address::Address, utils::http};
+use crate::{config::address::UnresolvedMuxedAccount, utils::http};
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, ValueEnum)]
 pub enum Output {
@@ -413,7 +413,7 @@ impl Cmd {
     // Resolve an account address to an account id. The address can be a
     // G-address or a key name (as in `stellar keys address NAME`).
     fn resolve_account(&self, address: &str) -> Option<AccountId> {
-        let address: Address = address.parse().ok()?;
+        let address: UnresolvedMuxedAccount = address.parse().ok()?;
 
         Some(AccountId(xdr::PublicKey::PublicKeyTypeEd25519(
             match address.resolve_muxed_account(&self.locator, None).ok()? {

diff --git a/cmd/soroban-cli/src/commands/tx/op/add/args.rs b/cmd/soroban-cli/src/commands/tx/op/add/args.rs
@@ -23,7 +23,7 @@ pub struct Args {
         visible_alias = "op-source",
         env = "STELLAR_OPERATION_SOURCE_ACCOUNT"
     )]
-    pub operation_source_account: Option<address::Address>,
+    pub operation_source_account: Option<address::UnresolvedMuxedAccount>,
 }
 
 impl Args {

diff --git a/cmd/soroban-cli/src/config/address.rs b/cmd/soroban-cli/src/config/address.rs
@@ -6,14 +6,14 @@ use super::{locator, secret};
 
 /// Address can be either a public key or eventually an alias of a address.
 #[derive(Clone, Debug)]
-pub enum Address {
-    MuxedAccount(xdr::MuxedAccount),
+pub enum UnresolvedMuxedAccount {
+    Resolved(xdr::MuxedAccount),
     AliasOrSecret(String),
 }
 
-impl Default for Address {
+impl Default for UnresolvedMuxedAccount {
     fn default() -> Self {
-        Address::AliasOrSecret(String::default())
+        UnresolvedMuxedAccount::AliasOrSecret(String::default())
     }
 }
 
@@ -27,37 +27,49 @@ pub enum Error {
     CannotSign(xdr::MuxedAccount),
 }
 
-impl FromStr for Address {
+impl FromStr for UnresolvedMuxedAccount {
     type Err = Error;
 
     fn from_str(value: &str) -> Result<Self, Self::Err> {
         Ok(xdr::MuxedAccount::from_str(value).map_or_else(
-            |_| Address::AliasOrSecret(value.to_string()),
-            Address::MuxedAccount,
+            |_| UnresolvedMuxedAccount::AliasOrSecret(value.to_string()),
+            UnresolvedMuxedAccount::Resolved,
         ))
     }
 }
 
-impl Address {
+impl UnresolvedMuxedAccount {
     pub fn resolve_muxed_account(
         &self,
         locator: &locator::Args,
         hd_path: Option<usize>,
     ) -> Result<xdr::MuxedAccount, Error> {
         match self {
-            Address::MuxedAccount(muxed_account) => Ok(muxed_account.clone()),
-            Address::AliasOrSecret(alias) => alias.parse().or_else(|_| {
-                Ok(xdr::MuxedAccount::Ed25519(
-                    locator.read_identity(alias)?.public_key(hd_path)?.0.into(),
-                ))
-            }),
+            UnresolvedMuxedAccount::Resolved(muxed_account) => Ok(muxed_account.clone()),
+            UnresolvedMuxedAccount::AliasOrSecret(alias) => {
+                Self::resolve_muxed_account_with_alias(alias, locator, hd_path)
+            }
         }
     }
 
+    pub fn resolve_muxed_account_with_alias(
+        alias: &str,
+        locator: &locator::Args,
+        hd_path: Option<usize>,
+    ) -> Result<xdr::MuxedAccount, Error> {
+        alias.parse().or_else(|_| {
+            Ok(xdr::MuxedAccount::Ed25519(
+                locator.read_identity(alias)?.public_key(hd_path)?.0.into(),
+            ))
+        })
+    }
+
     pub fn resolve_secret(&self, locator: &locator::Args) -> Result<secret::Secret, Error> {
         match &self {
-            Address::MuxedAccount(muxed_account) => Err(Error::CannotSign(muxed_account.clone())),
-            Address::AliasOrSecret(alias) => Ok(locator.read_identity(alias)?),
+            UnresolvedMuxedAccount::Resolved(muxed_account) => {
+                Err(Error::CannotSign(muxed_account.clone()))
+            }
+            UnresolvedMuxedAccount::AliasOrSecret(alias) => Ok(locator.read_identity(alias)?),
         }
     }
 }