Skip to content

Document --arguments flag in the appendix for sncast invoke, sncast call and sncast deploy #3251

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.

Sign up for GitHub

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

Jump to bottom
Closed
cptartur opened this issue Apr 22, 2025 · 3 comments · Fixed by #3255
Closed

Document --arguments flag in the appendix for sncast invoke, sncast call and sncast deploy #3251

cptartur opened this issue Apr 22, 2025 · 3 comments · Fixed by #3255
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers new sncast

Comments

@cptartur
Copy link
Member

cptartur commented Apr 22, 2025 •
edited
Loading

Current State

These are not currently documented in the appendix section of the documentation.

Objective

Document --arguments flag in the appendix for sncast invoke, sncast call and sncast deploy

Additional Context

No response
@cptartur cptartur added documentation Improvements or additions to documentation good first issue Good for newcomers sncast labels Apr 22, 2025
@cptartur cptartur moved this to New in Starknet foundry Apr 22, 2025
@github-actions github-actions bot added the new label Apr 22, 2025
@cptartur cptartur moved this from New to Backlog in Starknet foundry Apr 22, 2025
@khayss
Copy link
Contributor

khayss commented Apr 22, 2025

I'll like to take this

sumitvekariya added a commit to sumitvekariya/starknet-foundry that referenced this issue Apr 22, 2025
@sumitvekariya
docs: add --arguments flag documentation for sncast commands
1283ba6 
Add documentation for the --arguments flag in:
- invoke command
- call command
- deploy command

Closes foundry-rs#3251
sumitvekariya added a commit to sumitvekariya/starknet-foundry that referenced this issue Apr 22, 2025
@sumitvekariya
docs: add --arguments flag documentation for sncast commands
a181336 
Add documentation for the --arguments flag in:
- invoke command
- call command
- deploy command

Closes foundry-rs#3251
sumitvekariya added a commit to sumitvekariya/starknet-foundry that referenced this issue Apr 22, 2025
@sumitvekariya
docs: add --arguments flag documentation for sncast commands
ad59240 
Add documentation for the --arguments flag in:
- invoke command
- call command
- deploy command

The flag provides a human-readable way to pass arguments to contract functions and constructors compared to raw calldata.

Closes foundry-rs#3251

## Introduced changes

- Added documentation for the --arguments flag in invoke command showing how to pass arguments as human-readable Cairo expressions
- Added documentation for the --arguments flag in call command showing how to pass arguments as human-readable Cairo expressions
- Added documentation for the --arguments flag in deploy command showing how to pass constructor arguments as human-readable Cairo expressions
- Added changelog entry for the documentation addition

## Checklist

- [x] Linked relevant issue (foundry-rs#3251)
- [x] Updated relevant documentation (added --arguments flag docs)
- [ ] Added relevant tests (N/A - documentation only change)
- [x] Performed self-review of the code
- [x] Added changes to CHANGELOG.md
@sumitvekariya sumitvekariya mentioned this issue Apr 22, 2025
Merged
5 tasks
@cptartur cptartur moved this from Backlog to TODO in Starknet foundry Apr 30, 2025
@EDOHWARES
Copy link

Hi, I'm EDOHWAREZ, a software developer with years of experience in building scalable software. I'll like to work on this issue.

@BlessingEmejulu
Copy link

Can I start working on this?

github-merge-queue bot pushed a commit that referenced this issue May 14, 2025
@sumitvekariya @cptartur
Docs/add arguments flag docs (#3255)
d257bb5 
Add documentation for the --arguments flag in:
- invoke command
- call command 
- deploy command

The flag provides a human-readable way to pass arguments to contract
functions and constructors compared to raw calldata.

Closes #3251

## Introduced changes

- Added documentation for the --arguments flag in invoke command showing
how to pass arguments as human-readable Cairo expressions
- Added documentation for the --arguments flag in call command showing
how to pass arguments as human-readable Cairo expressions
- Added documentation for the --arguments flag in deploy command showing
how to pass constructor arguments as human-readable Cairo expressions
- Added changelog entry for the documentation addition

## Checklist

- [x] Linked relevant issue (#3251)
- [x] Updated relevant documentation (added --arguments flag docs)
- [ ] Added relevant tests (N/A - documentation only change)
- [x] Performed self-review of the code
- [x] Added changes to CHANGELOG.md"

---------

Co-authored-by: Artur Michałek <[email protected]>
@github-project-automation github-project-automation bot moved this from TODO to Done in Starknet foundry May 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers new sncast
Projects
Starknet foundry
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docs/add arguments flag docs sumitvekariya/starknet-foundry
4 participants
@cptartur @BlessingEmejulu @khayss @EDOHWARES