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.

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

refactor: required option in aztec-cli #1584

Merged
merged 3 commits into from
Aug 16, 2023
Merged

refactor: required option in aztec-cli #1584

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4ce8f96
refactor: required option in aztec-cli
benesjan Aug 16, 2023
7133e3f
Update yarn-project/aztec-cli/src/index.ts
benesjan Aug 16, 2023
bc22c85
fix
benesjan Aug 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 16 additions & 17 deletions yarn-project/aztec-cli/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,10 @@ export function getProgram(log: LogFn, debugLogger: DebugLogger): Command {
program
.command('generate-private-key')
.description('Generates a 32-byte private key.')
.option('-m, --mnemonic', 'A mnemonic string that can be used for the private key generation.')
.option(
'-m, --mnemonic',
'An optional mnemonic string used for the private key generation. If not provided, random private key will be generated.',
)
.action(async options => {
let privKey;
let publicKey;
Expand Down Expand Up @@ -143,10 +146,9 @@ export function getProgram(log: LogFn, debugLogger: DebugLogger): Command {
program
.command('deploy')
.description('Deploys a compiled Noir contract to Aztec.')
.option(
.requiredOption(
Copy link
Contributor

@iAmMichaelConnor iAmMichaelConnor Aug 16, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are --salt and --public-key also a required options, here? (Does it work without them, given they're defaulting to undefined values?)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello, yes in this case it works without them just fine.

'-c, --contract-abi <file>',
"A compiled Noir contract's ABI in JSON format or name of a contract ABI exported by @aztec/noir-contracts",
undefined,
)
.option('-a, --args <constructorArgs...>', 'Contract constructor arguments', [])
.option('-u, --rpc-url <string>', 'URL of the Aztec RPC', AZTEC_RPC_HOST || 'http://localhost:8080')
Expand Down Expand Up @@ -184,7 +186,7 @@ export function getProgram(log: LogFn, debugLogger: DebugLogger): Command {
program
.command('check-deploy')
.description('Checks if a contract is deployed to the specified Aztec address.')
.option('-ca, --contract-address <address>', 'An Aztec address to check if contract has been deployed to.')
.requiredOption('-ca, --contract-address <address>', 'An Aztec address to check if contract has been deployed to.')
.option('-u, --rpc-url <url>', 'URL of the Aztec RPC', AZTEC_RPC_HOST || 'http://localhost:8080')
.action(async options => {
const client = createAztecRpcClient(options.rpcUrl);
Expand Down Expand Up @@ -215,7 +217,7 @@ export function getProgram(log: LogFn, debugLogger: DebugLogger): Command {
.description('Gets information about the Aztec contract deployed at the specified address.')
.argument('<contractAddress>', 'Aztec address of the contract.')
.option('-u, --rpc-url <string>', 'URL of the Aztec RPC', AZTEC_RPC_HOST || 'http://localhost:8080')
.option('-b, --include-bytecode', "Include the contract's public function bytecode, if any.")
.option('-b, --include-bytecode <boolean>', "Include the contract's public function bytecode, if any.", false)
.action(async (contractAddress, options) => {
const client = createAztecRpcClient(options.rpcUrl);
const address = AztecAddress.fromString(contractAddress);
Expand Down Expand Up @@ -266,9 +268,9 @@ export function getProgram(log: LogFn, debugLogger: DebugLogger): Command {
program
.command('register-recipient')
.description('Register a recipient in the Aztec RPC.')
.option('-a, --address <aztecAddress>', "The account's Aztec address.")
.option('-p, --public-key <publicKey>', 'The account public key.')
.option('-pa, --partial-address <partialAddress', 'The partially computed address of the account contract.')
.requiredOption('-a, --address <aztecAddress>', "The account's Aztec address.")
.requiredOption('-p, --public-key <publicKey>', 'The account public key.')
.requiredOption('-pa, --partial-address <partialAddress', 'The partially computed address of the account contract.')
.option('-u, --rpc-url <string>', 'URL of the Aztec RPC', AZTEC_RPC_HOST || 'http://localhost:8080')
.action(async options => {
const client = createAztecRpcClient(options.rpcUrl);
Expand Down Expand Up @@ -353,12 +355,11 @@ export function getProgram(log: LogFn, debugLogger: DebugLogger): Command {
.description('Calls a function on an Aztec contract.')
.argument('<functionName>', 'Name of Function to view')
.option('-a, --args [functionArgs...]', 'Function arguments', [])
.option(
.requiredOption(
'-c, --contract-abi <fileLocation>',
"A compiled Noir contract's ABI in JSON format or name of a contract ABI exported by @aztec/noir-contracts",
undefined,
)
.option('-ca, --contract-address <address>', 'Aztec address of the contract.')
.requiredOption('-ca, --contract-address <address>', 'Aztec address of the contract.')
.option('-k, --private-key <string>', "The sender's private key.", PRIVATE_KEY)
.option('-u, --rpcUrl <string>', 'URL of the Aztec RPC', AZTEC_RPC_HOST || 'http://localhost:8080')

Expand Down Expand Up @@ -406,12 +407,11 @@ export function getProgram(log: LogFn, debugLogger: DebugLogger): Command {
)
.argument('<functionName>', 'Name of Function to view')
.option('-a, --args [functionArgs...]', 'Function arguments', [])
.option(
.requiredOption(
'-c, --contract-abi <fileLocation>',
"A compiled Noir contract's ABI in JSON format or name of a contract ABI exported by @aztec/noir-contracts",
undefined,
)
.option('-ca, --contract-address <address>', 'Aztec address of the contract.')
.requiredOption('-ca, --contract-address <address>', 'Aztec address of the contract.')
.option('-f, --from <string>', 'Public key of the TX viewer. If empty, will try to find account in RPC.')
.option('-u, --rpcUrl <string>', 'URL of the Aztec RPC', AZTEC_RPC_HOST || 'http://localhost:8080')
.action(async (functionName, options) => {
Expand Down Expand Up @@ -439,12 +439,11 @@ export function getProgram(log: LogFn, debugLogger: DebugLogger): Command {
.command('parse-parameter-struct')
.description("Helper for parsing an encoded string into a contract's parameter struct.")
.argument('<encodedString>', 'The encoded hex string')
.option(
.requiredOption(
'-c, --contract-abi <fileLocation>',
"A compiled Noir contract's ABI in JSON format or name of a contract ABI exported by @aztec/noir-contracts",
undefined,
)
.option('-p, --parameter <parameterName>', 'The name of the struct parameter to decode into')
.requiredOption('-p, --parameter <parameterName>', 'The name of the struct parameter to decode into')
.action(async (encodedString, options) => {
const contractAbi = await getContractAbi(options.contractAbi, log);
const parameterAbitype = contractAbi.functions
Expand Down