-
Notifications
You must be signed in to change notification settings - Fork 141
Generate AGENTS.md when running stellar contract init
#2687
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
66 changes: 66 additions & 0 deletions
66
cmd/soroban-cli/src/utils/contract-workspace-template/AGENTS.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # Agent instructions | ||
|
|
||
| This is a Stellar smart-contract workspace (Soroban). Each contract is a | ||
| workspace member under `contracts/<name>/`. | ||
|
|
||
| ## Layout | ||
|
|
||
| - `Cargo.toml` — workspace root; contract crates inherit `soroban-sdk` from here | ||
| - `contracts/<name>/src/lib.rs` — contract implementation (`#![no_std]`) | ||
| - `contracts/<name>/src/test.rs` — host-side unit tests | ||
|
|
||
| ## Build | ||
|
|
||
| From the workspace root: | ||
|
|
||
| ```sh | ||
| stellar contract build | ||
| ``` | ||
|
|
||
| That compiles every `cdylib` member to WASM. Artifacts land in | ||
| `target/wasm32v1-none/release/*.wasm`. Build one crate with | ||
| `stellar contract build --package <name>`. | ||
|
|
||
| Do not substitute `cargo build --target wasm32v1-none`. `stellar contract build` | ||
| applies the flags and metadata the network expects. | ||
|
|
||
| The `wasm32v1-none` Rust target must be installed (`rustup target add wasm32v1-none`). | ||
| Rust 1.84 or newer is required for that target. Rust 1.82 and 1.83 cannot build | ||
|
rohansingh4 marked this conversation as resolved.
Outdated
|
||
| contracts. | ||
|
|
||
| ## Test | ||
|
|
||
| Host tests run with the normal Cargo test harness (not on-chain): | ||
|
|
||
| ```sh | ||
| cargo test | ||
| ``` | ||
|
|
||
| A single crate: `cargo test -p <name>`. | ||
|
|
||
| ## Deploy and invoke | ||
|
|
||
| On testnet, after a successful build: | ||
|
|
||
| ```sh | ||
| stellar contract deploy \ | ||
| --wasm target/wasm32v1-none/release/<name>.wasm \ | ||
| --source-account <identity> \ | ||
| --network testnet \ | ||
| --alias <alias> | ||
|
|
||
| stellar contract invoke \ | ||
| --id <alias> \ | ||
| --network testnet \ | ||
| --source-account <identity> \ | ||
| -- hello --to world | ||
| ``` | ||
|
|
||
| The sample `hello_world` contract exposes `hello(to: String) -> Vec<String>`. | ||
| Replace that with your own functions; `stellar contract invoke --id <id> -- -h` | ||
| prints the generated CLI for the deployed contract. | ||
|
|
||
| ## Further reading | ||
|
|
||
| - https://developers.stellar.org/docs/build/smart-contracts/overview | ||
| - https://github.com/stellar/soroban-examples | ||
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
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.
Uh oh!
There was an error while loading. Please reload this page.