Skip to content
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

aztec/cli: minor suggestions #1294

Closed
7 tasks done
iAmMichaelConnor opened this issue Jul 31, 2023 · 2 comments
Closed
7 tasks done

aztec/cli: minor suggestions #1294

iAmMichaelConnor opened this issue Jul 31, 2023 · 2 comments
Assignees
Labels
T-question Type: Someone is asking a questions about something T-tracking Type: Tracking Issue. This contains tasklists.

Comments

@iAmMichaelConnor
Copy link
Contributor

iAmMichaelConnor commented Jul 31, 2023

Just some minor suggestions, let me know your thoughts :)

  • Rename from azti to aztec-cli (typing "az" then tab will auto-complete the command line for users anyway, so brevity isn't necessary).
  • Do we want to seek to be consistent with common command names in Ethereum, or are we happy to deviate?
    • Consider renaming call-fn to something like send-tx. (I got confused, because many Ethereum clients use the word "call" to mean "this won't send a transaction to the network"). I'm happy to be persuaded otherwise on this one, though.
    • Consider renaming create-private-key to generate-private-key.
  • Use named arguments, rather than relying on ordering. It'll make it easier for users to read their commands, and will result in fewer user errors.
  • create-account: does this deploy an account contract? Maybe update the cli explanation to say so, if so. And if so, what kind of account contract?
    • Consider renaming to create-default-account or create-_____-account to make it clear that a particular kind of account contract is deployed.
    • How can I learn: my encryption/nullifier public key, my account contract address, and my partial contract address? Can this be output to the console at the time of creating / deploying an account?
    • How are custom account contracts deployed, via the cli?
  • create-private-key: could this display the public key as well?
  • parse-parameter-struct: I don't understand the description of what this one does.
  • Are there plans for other commands?
@github-project-automation github-project-automation bot moved this to Todo in A3 Jul 31, 2023
@iAmMichaelConnor iAmMichaelConnor added the T-question Type: Someone is asking a questions about something label Jul 31, 2023
@PhilWindle
Copy link
Collaborator

@iAmMichaelConnor I think most of your points are covered by above task list.

On account contracts. When you create-account it deploys a schnorr sig verifying account contract for you. It's not easy to enable the user of the cli to deploy arbitrary account contracts. This is because along with any given account contract you need some TS code that understands how to interface with that contract (what sig to use etc). This isn't something you can achieve very easily with a CLI. I think if you want to play around with account contracts you need to be writing code yourself. However is a dev just wants to write/deploy/call noir contracts and they don't care about the nature of their account contract then they should be perfectly fine with our 'default' contract.

@iAmMichaelConnor
Copy link
Contributor Author

Ah, ok, thanks for explaining. That makes sense to me :)
And thanks very much for opening issues and creating a task list for these.

@iAmMichaelConnor iAmMichaelConnor added the T-tracking Type: Tracking Issue. This contains tasklists. label Aug 1, 2023
@github-project-automation github-project-automation bot moved this from Todo to Done in A3 Aug 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-question Type: Someone is asking a questions about something T-tracking Type: Tracking Issue. This contains tasklists.
Projects
Archived in project
Development

No branches or pull requests

2 participants