add stellar metadata section to contract cargo.toml files#680
Open
knQzx wants to merge 1 commit intoOpenZeppelin:mainfrom
Open
add stellar metadata section to contract cargo.toml files#680knQzx wants to merge 1 commit intoOpenZeppelin:mainfrom
knQzx wants to merge 1 commit intoOpenZeppelin:mainfrom
Conversation
Contributor
WalkthroughThis pull request adds a Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@examples/fungible-allowlist/Cargo.toml`:
- Around line 9-10: The root Cargo.toml is missing a
[workspace.metadata.stellar] section so the per-crate setting
package.metadata.stellar.cargo_inherit = true is a no-op; add a top-level
[workspace.metadata.stellar] block in the root Cargo.toml containing the
canonical SEP-49 fields you expect to share (the same keys present in individual
package.metadata.stellar blocks) so cargo_inherit works, or alternatively remove
cargo_inherit = true from crates and copy those explicit values into each
package.metadata.stellar block; locate usages by searching for
package.metadata.stellar and cargo_inherit to mirror the shared metadata into
workspace.metadata.stellar.
In `@examples/fungible-governor-timelock/governor/Cargo.toml`:
- Around line 9-10: The crates declare cargo_inherit = true under
[package.metadata.stellar] but there is no root source to inherit from; add a
[workspace.metadata.stellar] block to the root Cargo.toml providing the shared
SEP-49 metadata (the keys that child crates expect) so cargo_inherit can work;
update the root Cargo.toml to include a [workspace.metadata.stellar] section
with the canonical fields used by child crates (matching the names under
package.metadata.stellar) rather than adding metadata to each crate.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 9b5f7d0f-1576-453b-acad-de36c1c2cbcd
📒 Files selected for processing (52)
examples/fee-forwarder-permissioned/Cargo.tomlexamples/fee-forwarder-permissionless/Cargo.tomlexamples/fungible-allowlist/Cargo.tomlexamples/fungible-blocklist/Cargo.tomlexamples/fungible-capped/Cargo.tomlexamples/fungible-governor-timelock/governor/Cargo.tomlexamples/fungible-governor-timelock/token/Cargo.tomlexamples/fungible-governor/governor/Cargo.tomlexamples/fungible-governor/token/Cargo.tomlexamples/fungible-merkle-airdrop/Cargo.tomlexamples/fungible-pausable/Cargo.tomlexamples/fungible-vault/Cargo.tomlexamples/fungible-votes/Cargo.tomlexamples/merkle-voting/Cargo.tomlexamples/multisig-smart-account/account/Cargo.tomlexamples/multisig-smart-account/ed25519-verifier/Cargo.tomlexamples/multisig-smart-account/spending-limit-policy/Cargo.tomlexamples/multisig-smart-account/threshold-policy/Cargo.tomlexamples/multisig-smart-account/webauthn-verifier/Cargo.tomlexamples/multisig-smart-account/weighted-threshold-policy/Cargo.tomlexamples/nft-access-control/Cargo.tomlexamples/nft-consecutive/Cargo.tomlexamples/nft-enumerable/Cargo.tomlexamples/nft-royalties/Cargo.tomlexamples/nft-sequential-minting/Cargo.tomlexamples/ownable/Cargo.tomlexamples/pausable/Cargo.tomlexamples/rwa/claim-issuer/Cargo.tomlexamples/rwa/claim-topics-and-issuers/Cargo.tomlexamples/rwa/compliance/Cargo.tomlexamples/rwa/identity-registry/Cargo.tomlexamples/rwa/identity-verifier/Cargo.tomlexamples/rwa/identity/Cargo.tomlexamples/rwa/sign-claim/Cargo.tomlexamples/rwa/token/Cargo.tomlexamples/sac-admin-generic/Cargo.tomlexamples/sac-admin-wrapper/Cargo.tomlexamples/timelock-controller/Cargo.tomlexamples/upgradeable/lazy-v1/Cargo.tomlexamples/upgradeable/lazy-v2/Cargo.tomlexamples/upgradeable/upgrader/Cargo.tomlexamples/upgradeable/v1/Cargo.tomlexamples/upgradeable/v2/Cargo.tomlpackages/access/Cargo.tomlpackages/accounts/Cargo.tomlpackages/contract-utils/Cargo.tomlpackages/fee-abstraction/Cargo.tomlpackages/governance/Cargo.tomlpackages/macros/Cargo.tomlpackages/test-utils/event-assertion/Cargo.tomlpackages/tokens/Cargo.tomlpackages/zk-email/Cargo.toml
Comment on lines
+9
to
+10
| [package.metadata.stellar] | ||
| cargo_inherit = true |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify whether workspace-level stellar metadata exists and where inheritance is used.
set -euo pipefail
echo "== Root/workspace stellar metadata tables =="
rg -n '^\[workspace\.metadata\.stellar\]' Cargo.toml || true
echo
echo "== Crates using package.metadata.stellar and cargo_inherit = true =="
rg -n '^\[package\.metadata\.stellar\]|^cargo_inherit\s*=\s*true' --type tomlRepository: OpenZeppelin/stellar-contracts
Length of output: 7161
🏁 Script executed:
# Check the root Cargo.toml for workspace configuration
cat -n Cargo.toml | head -50Repository: OpenZeppelin/stellar-contracts
Length of output: 1958
🏁 Script executed:
# Check if there's any workspace.metadata section (even without stellar)
rg -n '^\[workspace' Cargo.tomlRepository: OpenZeppelin/stellar-contracts
Length of output: 138
🏁 Script executed:
# Verify if cargo_inherit appears in the git history to understand if it's new
git log --oneline --all -S 'cargo_inherit' | head -10Repository: OpenZeppelin/stellar-contracts
Length of output: 160
Add workspace-level Stellar metadata to root Cargo.toml to make cargo_inherit effective
The pattern of using cargo_inherit = true appears across 60+ crates in this repository, but the root Cargo.toml lacks a [workspace.metadata.stellar] section to inherit from. This means the inheritance directive is currently a no-op and won't achieve the SEP-49 metadata consistency objective across the workspace.
Add a [workspace.metadata.stellar] section to the root Cargo.toml with the appropriate metadata entries, or replace cargo_inherit = true with explicit values in each crate if inheritance is not intended.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@examples/fungible-allowlist/Cargo.toml` around lines 9 - 10, The root
Cargo.toml is missing a [workspace.metadata.stellar] section so the per-crate
setting package.metadata.stellar.cargo_inherit = true is a no-op; add a
top-level [workspace.metadata.stellar] block in the root Cargo.toml containing
the canonical SEP-49 fields you expect to share (the same keys present in
individual package.metadata.stellar blocks) so cargo_inherit works, or
alternatively remove cargo_inherit = true from crates and copy those explicit
values into each package.metadata.stellar block; locate usages by searching for
package.metadata.stellar and cargo_inherit to mirror the shared metadata into
workspace.metadata.stellar.
Comment on lines
+9
to
+10
| [package.metadata.stellar] | ||
| cargo_inherit = true |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify whether workspace-level stellar metadata exists and where cargo_inherit is used.
set -euo pipefail
echo "== Workspace Cargo manifests =="
fd -a '^Cargo\.toml$' | sed 's#^\./##'
echo
echo "== Find workspace metadata.stellar blocks =="
rg -n --type toml '^\[workspace\.metadata\.stellar\]|^cargo_inherit\s*='
echo
echo "== Find package metadata.stellar blocks =="
rg -n --type toml '^\[package\.metadata\.stellar\]|^cargo_inherit\s*='Repository: OpenZeppelin/stellar-contracts
Length of output: 13642
Add [workspace.metadata.stellar] to the root Cargo.toml
This file uses cargo_inherit = true, but the root workspace Cargo.toml has no [workspace.metadata.stellar] block. The same pattern appears across 50+ crates in this repository—all declaring cargo inheritance without a source to inherit from. This prevents SEP-49 metadata inheritance from working as intended.
Add to root Cargo.toml
+[workspace.metadata.stellar]
+# define shared stellar metadata inherited by member crates🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@examples/fungible-governor-timelock/governor/Cargo.toml` around lines 9 - 10,
The crates declare cargo_inherit = true under [package.metadata.stellar] but
there is no root source to inherit from; add a [workspace.metadata.stellar]
block to the root Cargo.toml providing the shared SEP-49 metadata (the keys that
child crates expect) so cargo_inherit can work; update the root Cargo.toml to
include a [workspace.metadata.stellar] section with the canonical fields used by
child crates (matching the names under package.metadata.stellar) rather than
adding metadata to each crate.
Author
|
hey, thanks for flagging but this is actually fine - cargo_inherit = true in the stellar context inherits from the crate's own [package] section (name -> name, version -> binver, authors -> authors, etc.), not from workspace.metadata.stellar. it's processed by stellar-scaffold-cli, not standard cargo. you can see the same pattern in the contracts-wizard PR #613 and in stellar-core's own test contracts. no workspace-level section needed here. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
summary
test plan
fixes #341
Summary by CodeRabbit