Utils Command

The starkexpress-cli tool provides general utility commands for key pair generation, which is crucial when working with the Arc platform. By utilizing the utils command and its subcommands, you can easily generate Ethereum and STARK key pairs directly from the CLI.

starkexpress-cli utils [OPTIONS] COMMAND [ARGS]...

Sub-Commands

The starkexpress-cli utils command provides the following sub-commands: gen-eth-keys and gen-stark-keys

Generate Ethereum Keys

The gen-eth-keys sub-command is used to generate a Ethereum key pairs.

starkexpress-cli utils gen-eth-keys [OPTIONS]

Options:

  • --count INTEGER: Number of key pairs to generate. (default: 1)

  • --json: Output result as json.

  • --help: Show the help message and exit.

Example:

starkexpress-cli utils gen-eth-keys --count=2 --json

This command will generate 2 Ethereum key pairs and output the result in JSON format.

List Users

The gen-stark-keys sub-command is used to generate a STARK key pairs.

starkexpress-cli utils gen-stark-keys [OPTIONS]

Options:

  • --count INTEGER: Number of key pairs to generate. (default: 1)

  • --json: Output result as json.

  • --help: Show the help message and exit.

Example Usage:

starkexpress-cli utils gen-stark-keys --count=3 --json

This command will generate three STARK key pairs and output the result in JSON format.

Register

The register sub-command allows you to register a new user in the Arc platform.

starkexpress-cli users register [OPTIONS] USERNAME

Parameters:

  • USERNAME: The username of the user to register.

Options:

  • --eth-key TEXT: Your Ethereum private key.

  • --stark-key TEXT: Your STARK private key.

  • --json: Output result as json.

  • --help: Show this message and exit.

Example:

starkexpress-cli users register john_doe --eth-key=your_eth_key --stark-key=your_stark_key --json

This command will register a new user with the username john_doe, the provided Ethereum and STARK private keys, and return the result in JSON format. When a private key is omitted a random key will be generated.

Last updated