feat: import_contract! macro + consolidate registry macros (stellar-scaffold/cli#419)

CLAUDE.md

@@ -10,7 +10,7 @@ Related repos:
 - `stellar-registry/contracts` — the on-chain registry contracts this CLI talks to
 - `stellar-registry/ui` — registry frontend
 - `stellar-registry/indexer` — registry indexer & API
-- `stellar-scaffold/cli` — the `stellar scaffold` CLI; publishes `stellar-build` and `stellar-scaffold-macro` (crates.io) that this repo depends on
+- `stellar-scaffold/cli` — the `stellar scaffold` CLI; publishes `stellar-build` (crates.io) that this repo depends on
 
 ## Common Commands
 
@@ -41,7 +41,10 @@ Note: the `justfile` still carries some recipes from the monorepo. Prefer the `c
 |-------|---------|
 | `stellar-registry-cli` | The `stellar registry` CLI: `publish`, `deploy`, `download`, `install`/`create-alias`, `upgrade`, `register-contract` |
 | `stellar-registry-build` | Library for interacting with the registry at build time |
-| `stellar-registry` | Shared registry types and the `import_contract_client!` macro (published to crates.io; dev-dependency of `stellar-registry/contracts`) |
+| `stellar-registry-macro` | Macro crate defining procedural macros `import_contract!`, `import_contract_client!`, and `import_asset`. Proc-macro crates are special and need to only export proc-macros. |
+| `stellar-registry` | Re-exports the `import_contract!`, `import_contract_client!`, and `import_asset!` macros from `stellar-registry-macro`. Might export more behavior later. (published to crates.io; dev-dependency of `stellar-registry/contracts`) |
+| `stellar-registry-name` | Defines standard name parsing/formatting used by `stellar-registry-macro` and `stellar-registry-cli` |
+| `stellar-registry-test` | Unpublished testing tools used throughout this monorepo as a dev-dependency |
 
 ### CLI Command Flow
 
@@ -59,7 +62,6 @@ Note: the `justfile` still carries some recipes from the monorepo. Prefer the `c
 ## Cross-repo dependencies
 
 This repo's crates depend on, from crates.io:
-- `stellar-build` and `stellar-scaffold-macro` — published from `stellar-scaffold/cli`
-- `stellar-scaffold-test` — pulled via git from `stellar-scaffold/cli` (it is `publish = false`); used in tests only
+- `stellar-build` — published from `stellar-scaffold/cli`
 
 These are declared as workspace dependencies in the root `Cargo.toml`. If the registry CLI ever needs an unreleased change in one of these, bump and publish it from `stellar-scaffold/cli` first (or temporarily `[patch]` it locally).

Cargo.toml

@@ -10,11 +10,12 @@ repository = "https://github.com/stellar-registry/cli"
 # Local crates
 stellar-registry = { path = "crates/stellar-registry" }
 stellar-registry-test = { path = "crates/stellar-registry-test" }
+stellar-registry-macro = { path = "crates/stellar-registry-macro", version = "0.0.1" }
+stellar-registry-build = { path = "crates/stellar-registry-build", version = "0.0.9" }
+stellar-registry-name = { path = "crates/stellar-registry-name", version = "0.0.1" }
 
-# Cross-repo deps from scaffold-stellar/cli (crates.io for published libs,
-# git for stellar-scaffold-test which is `publish = false`).
+# Cross-repo deps from scaffold-stellar/cli
 stellar-build = "0.0.6"
-stellar-scaffold-macro = "0.8.14"
 
 stellar-cli = { version = "27.0.0", package = "soroban-cli", default-features = false }
 soroban-rpc = { package = "stellar-rpc-client", version = "27.0.0" }
@@ -25,9 +26,14 @@ admin-sep = { git = "https://github.com/theahaco/admin-sep", rev = "c4624cc74291
 stellar-xdr = "=27.0.0"
 stellar-strkey = "0.0.16"
 
+proc-macro2 = "1.0"
+quote = "1.0"
+syn = { version = "2", features = ["full"] }
+
 cargo_metadata = "0.18.1"
 thiserror = "2.0.17"
 sha2 = "0.10.9"
+semver = "1.0.28"
 
 clap = "4.6.1"
 reqwest = { version = "0.12.9", default-features = false }

README.md

@@ -56,7 +56,10 @@ the detailed command reference, configuration, and the mainnet workflow.
 |-------|---------|
 | [`stellar-registry-cli`](./crates/stellar-registry-cli) | The `stellar registry` CLI plugin |
 | [`stellar-registry-build`](./crates/stellar-registry-build) | Library for interacting with the registry at build time |
-| [`stellar-registry`](./crates/stellar-registry) | Shared registry types and the `import_contract_client!` macro |
+| [`stellar-registry-macro`](./crates/stellar-registry-macro) | Macro crate defining procedural macros `import_contract!`, `import_contract_client!`, and `import_asset`. [Proc-macro crates are special](https://www.reddit.com/r/rust/comments/tuxawv/why_do_procedural_macros_have_to_be_defined_in_a/) and need to only export proc-macros. |
+| [`stellar-registry`](./crates/stellar-registry) | For use in Stellar smart contracts. Re-exports the `import_contract!`, `import_contract_client!`, and `import_asset!` macros from `stellar-registry-macro`. Might export more behavior later. |
+| [`stellar-registry-name`](./crates/stellar-registry-name)| Defines standard name parsing/formatting used by `stellar-registry-macro` and `stellar-registry-cli`. |
+| [`stellar-registry-test`](./crates/stellar-registry-test)| Unpublished testing tools used throughout this monorepo as a dev-dependency |
 
 ## What is the Contract Registry?
 

crates/stellar-registry-build/Cargo.toml

@@ -15,20 +15,14 @@ crate-type = ["rlib"]
 [dependencies]
 stellar-cli = { workspace = true, default-features = false, features = [] }
 stellar-build = { workspace = true }
+stellar-registry-name = { workspace = true }
 
-soroban-spec-tools = { workspace = true }
 soroban-rpc = { workspace = true }
 stellar-strkey = { workspace = true }
-
-thiserror = "2.0.17"
-tokio = { version = "1", features = ["full"] }
-shlex = "1.1.0"
-heck = "0.5.0"
-ed25519-dalek = "2.2.0"
 sha2 = { workspace = true }
 
-dotenvy = "0.15.7"
-# soroban-rpc = "=20.3.3"
+thiserror = { workspace = true }
+semver = { workspace = true }
 
 [dev-dependencies]
 expect-test = "1.5"

crates/stellar-registry-build/src/contract.rs

@@ -1,4 +1,4 @@
-use crate::{Error, named_registry::PrefixedName, registry::Registry};
+use crate::{Error, name, registry::Registry};
 use sha2::{Digest, Sha256};
 use soroban_rpc as rpc;
 use stellar_build::Network;
@@ -88,7 +88,13 @@ pub enum ContractId {
     Resolved(stellar_strkey::Contract),
     Unresolved(stellar_cli::config::UnresolvedContract),
     PreHash(PreHashContractID),
-    FromRegistry(PrefixedName),
+    FromRegistry(name::Prefixed),
+}
+
+impl From<name::Prefixed> for ContractId {
+    fn from(value: name::Prefixed) -> Self {
+        Self::FromRegistry(value)
+    }
 }
 
 impl ContractId {
@@ -105,10 +111,10 @@ impl ContractId {
             ContractId::PreHash(pre_hash_contract_id) => {
                 pre_hash_contract_id.id(&network_passphrase.parse()?)
             }
-            ContractId::FromRegistry(PrefixedName { channel, name }) => {
-                Registry::new(config, channel.as_deref())
+            ContractId::FromRegistry(name) => {
+                Registry::new(config, name.channel())
                     .await?
-                    .fetch_contract_id(name)
+                    .fetch_contract_id(name.name())
                     .await?
             }
         })

crates/stellar-registry-build/src/error.rs

@@ -7,6 +7,8 @@ use stellar_cli::{
 pub enum Error {
     #[error("Invalid contract id: {0}")]
     InvalidContractId(String),
+    #[error("contract `{0}` is flagged as compromised in the registry")]
+    ContractFlagged(String),
     #[error(transparent)]
     Invoke(#[from] invoke::Error),
     #[error(transparent)]
@@ -15,4 +17,8 @@ pub enum Error {
     Locator(#[from] locator::Error),
     #[error(transparent)]
     Build(#[from] stellar_build::networks::Error),
+    #[error(transparent)]
+    Rpc(#[from] soroban_rpc::Error),
+    #[error(transparent)]
+    Xdr(#[from] stellar_cli::xdr::Error),
 }

crates/stellar-registry-build/src/lib.rs

@@ -1,6 +1,14 @@
+//! Registry interaction at build time.
+//!
+//! Talks to the on-chain registry over the network (`contract`, `registry`,
+//! `error`), pulling in the full stellar-cli stack. Proc-macro crates that only
+//! need typed registry names depend on the dependency-light `stellar-registry-name`
+//! crate directly (re-exported here via the `name` module).
+
 pub mod contract;
 pub mod error;
-pub mod named_registry;
 pub mod registry;
 
+pub mod name;
+
 pub use error::Error;

crates/stellar-registry-build/src/name.rs

@@ -0,0 +1,22 @@
+pub use stellar_registry_name::*;
+
+mod cli {
+    use stellar_cli::config;
+
+    use super::Prefixed;
+    use crate::registry::Registry;
+
+    #[allow(async_fn_in_trait)]
+    pub trait RegistryAccess {
+        /// Resolve the (sub)registry this name's channel points at.
+        async fn registry(&self, config: &config::Args) -> Result<Registry, crate::Error>;
+    }
+
+    impl RegistryAccess for Prefixed {
+        async fn registry(&self, config: &config::Args) -> Result<Registry, crate::Error> {
+            Registry::from_named_registry(config, self).await
+        }
+    }
+}
+
+pub use cli::RegistryAccess;