docker-only install experience

[alexghr]

In order to provide a seamless install experience to aztec-sandbox users we should consider offering a dockerized version of aztec-cli so that users can get up and running without having to install node/npm/yarn.

We'd have to deploy the aztec-cli to docker hub and create a wrapper script around it that starts a container and delegates commands to it. The wrapper will have to manage mount points in order to ensure compiling contracts works (and the compiled artifacts are available on the host computer). We'll also need to consider how to handle updates to the underlying cli image.

Needs #2644

[PhilWindle]

Sounds good!

[rahul-kothari]

Do users need to do docker exec to run aztec-cli then? If so - add a script (like charlie suggested in the call)?

Also can make some of the pains referenced in #2870 go away

[alexghr]

Do users need to do docker exec to run aztec-cli then? If so - add a script (like charlie suggested in the call)?

we'd provide a wrapper-script that manages the container for the user. The script would provide the same interface as the cli.

[charlielye]

The dockerfile would specify entrypoint as aztec-cli, (globally installed in the container) meaning the wrapper script would then look something like:

#!/bin/sh
docker run -ti --rm -v <mount paths> aztecprotocol/aztec-sandbox $@

The only tricky thing here, is where to install the wrapper script. Even in unix there's no standard user bin folder, and requiring root or sudo to install it into /usr/bin or /usr/local/bin is a no go.

So our sandbox install script will need to do something like (a few gpt prompts later):

#!/bin/bash

# Define the binary's source path
BINARY_SRC_PATH="/path/to/your/binary"

# Define the target directory
TARGET_DIR="$HOME/.local/bin"

# Check if the target directory exists, if not create it
if [ ! -d "$TARGET_DIR" ]; then
    mkdir -p "$TARGET_DIR"
fi

# Copy the binary to the target directory
cp "$BINARY_SRC_PATH" "$TARGET_DIR"

# Check if the target directory is in the user's PATH
if [[ ":$PATH:" != *":$TARGET_DIR:"* ]]; then
    # Determine the user's shell
    SHELL_PROFILE=""
    case $SHELL in
        */bash)
            SHELL_PROFILE="$HOME/.bashrc"
            ;;
        */zsh)
            SHELL_PROFILE="$HOME/.zshrc"
            ;;
        # Add other shells as needed
        *)
            echo "Unsupported shell: $SHELL"
            exit 1
            ;;
    esac

    # Inform the user about the change and ask for confirmation
    echo "The directory $TARGET_DIR is not in your PATH."
    echo "We'd like to add it to your $SHELL_PROFILE to make the binary accessible."
    read -p "Do you want to proceed? (y/n) " -n 1 -r
    echo    # Move to a new line
    if [[ $REPLY =~ ^[Yy]$ ]]; then
        # Add the target directory to the user's PATH in their profile
        echo "export PATH=\$PATH:$TARGET_DIR" >> "$SHELL_PROFILE"
        echo "Updated PATH in $SHELL_PROFILE"
    else
        echo "Skipped updating PATH. You might need to add $TARGET_DIR to your PATH manually to use the binary."
    fi
else
    echo "Installation complete!"
fi

[alexghr]

Docker image and script merged in but this still needs the install script. See https://github.com/AztecProtocol/sandbox-website/pull/24