@etherscan-npm/cli 1.0.2 → 1.0.3

package/README.md

@@ -94,6 +94,30 @@ Ensure your Go binary directory (`GOBIN`, or `GOPATH/bin` by default) is on `PAT
 
 Download the archive for your operating system and architecture plus `checksums.txt` from [GitHub Releases](https://github.com/etherscan/etherscan-cli/releases/latest). Verify the archive's SHA-256 checksum, extract it, and place `etherscan` (or `etherscan.exe`) on your `PATH`.
 
+## Uninstall
+
+Run:
+
+```sh
+etherscan uninstall
+```
+
+The command shows the exact package-manager action or executable and configuration paths before asking for confirmation. Use `--yes` to skip the prompt. Homebrew and npm installations are removed through their owning package manager. Installer, Go, manual, and source builds remove only the exact running executable; custom directories and `PATH` entries are left alone unless the installer recorded that it added them and the directory contains no other files.
+
+The command never requests administrator privileges. If a manually copied binary is in a protected location, it leaves the saved configuration intact and prints the exact command needed to remove the binary. Manually created aliases or separate symlinks may also need to be removed by hand.
+
+The installer scripts can remove a script installation without downloading a release archive:
+
+```sh
+curl -fsSL https://raw.githubusercontent.com/etherscan/etherscan-cli/master/scripts/install.sh | sh -s -- --uninstall
+```
+
+```powershell
+& ([scriptblock]::Create((irm https://raw.githubusercontent.com/etherscan/etherscan-cli/master/scripts/install.ps1))) -Uninstall
+```
+
+Uninstall removes the saved configuration directory. If `ETHERSCAN_API_KEY` is set, unset it separately in the shell or environment where it is defined.
+
 ## Get started
 
 ### 1. Create an API key
@@ -143,7 +167,7 @@ Run `etherscan tui` to open the full-screen endpoint explorer:
 etherscan tui
 ```
 
-The explorer can be opened before authentication and asks you to validate and save a key when you submit an API-backed endpoint. Running `etherscan` with no command prints the Quick Start guide.
+The explorer can be opened before authentication and asks you to validate and save a key when you submit an API-backed endpoint. It is read-only; source and proxy verification submissions remain available through the traditional commands. Running `etherscan` with no command prints the Quick Start guide.
 
 ## Practical workflows
 
@@ -168,6 +192,33 @@ etherscan contract getabi 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2
 etherscan contract getsourcecode 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2
 ```
 
+### Verify a contract
+
+Verification lives in its own command group, `etherscan contractverification`, so that `etherscan contract` stays purely for reading on-chain contract data. Both groups call the same `contract` API module.
+
+Use `--file` for Solidity, Abstract zkSync-stack, or Vyper source payloads. Stylus verification takes a public Git repository URL instead.
+
+```sh
+# Solidity standard JSON
+etherscan contractverification verify 0xYourContract --file input.json --codeformat solidity-standard-json-input --contractname contracts/Verified.sol:Verified --compilerversion v0.8.24+commit.e11b9ed9
+
+# Abstract uses the zkSync compiler stack (Abstract Mainnet and Sepolia only)
+etherscan --chain abstract contractverification verify-zksync 0xYourContract --file input.json --codeformat solidity-standard-json-input --contractname contracts/Verified.sol:Verified --compilerversion v0.8.24+commit.e11b9ed9 --zksolc-version v1.5.7
+
+# Vyper JSON verification, and Stylus repository verification (Arbitrum One and Sepolia only)
+etherscan contractverification verify-vyper 0xYourContract --file input.json --contractname contracts/Verified.vy:Verified --compilerversion vyper:0.4.0 --optimization-used 0
+etherscan --chain arbitrum contractverification verify-stylus 0xYourContract --source-code https://github.com/example/project --contractname project --compilerversion stylus:0.5.3 --license-type 3
+```
+
+Each submission returns a GUID. Poll it with `check-status` for source verification, or `check-proxy` for a proxy submission:
+
+```sh
+etherscan contractverification check-status <guid>
+etherscan contractverification check-proxy <guid>
+```
+
+Constructor arguments may be supplied as bare ABI-encoded hex or with a `0x` prefix; the CLI sends the documented bare form. Verification source files are limited to 3,000,000 bytes. Run any verification command with `--help` for its exact options.
+
 ### Switch chains
 
 ```sh
@@ -209,7 +260,7 @@ Every command includes built-in parameter and usage help:
 ```sh
 etherscan --help
 etherscan account txlist --help
-etherscan contract verify --help
+etherscan contractverification verify --help
 ```
 
 <details>
@@ -223,7 +274,7 @@ etherscan contract verify --help
 | `etherscan tui` | Launch the interactive explorer |
 | `etherscan login` | Validate and store an API key |
 | `etherscan logout` | Remove the stored API key |
-| `etherscan uninstall` | Remove all CLI configuration |
+| `etherscan uninstall` | Remove the CLI and saved configuration |
 | `etherscan update` | Update a Homebrew or installer-script installation |
 | `etherscan whoami` | Show the active chain and masked API key |
 | `etherscan config` | Get, list, or set CLI configuration |
@@ -264,10 +315,20 @@ etherscan contract verify --help
 | `etherscan contract getabi` | Get a verified contract's ABI | [getabi](https://docs.etherscan.io/api-reference/endpoint/getabi.md) |
 | `etherscan contract getsourcecode` | Get verified source code and contract metadata | [getsourcecode](https://docs.etherscan.io/api-reference/endpoint/getsourcecode.md) |
 | `etherscan contract getcontractcreation` | Get creator and creation transaction data for contracts | [getcontractcreation](https://docs.etherscan.io/api-reference/endpoint/getcontractcreation.md) |
-| `etherscan contract verify` | Submit contract source code for verification | [verifysourcecode](https://docs.etherscan.io/api-reference/endpoint/verifysourcecode.md) |
-| `etherscan contract verify-status` | Check a source verification submission | [checkverifystatus](https://docs.etherscan.io/api-reference/endpoint/checkverifystatus.md) |
-| `etherscan contract verify-proxy` | Submit a proxy contract for verification | [verifyproxycontract](https://docs.etherscan.io/api-reference/endpoint/verifyproxycontract.md) |
-| `etherscan contract check-proxy` | Check a proxy verification submission | [checkproxyverification](https://docs.etherscan.io/api-reference/endpoint/checkproxyverification.md) |
+
+### Contract verification
+
+Grouped separately from the contract data commands above. All of these call the `contract` API module.
+
+| Command | Description | API docs |
+| --- | --- | --- |
+| `etherscan contractverification verify` | Submit Solidity source code for verification | [verifysourcecode](https://docs.etherscan.io/api-reference/endpoint/verifysourcecode.md) |
+| `etherscan contractverification verify-zksync` | Submit zkSync-stack source code on Abstract | [verifyzksyncsourcecode](https://docs.etherscan.io/api-reference/endpoint/verifyzksyncsourcecode.md) |
+| `etherscan contractverification verify-vyper` | Submit Vyper source code for verification | [verifyvyper](https://docs.etherscan.io/api-reference/endpoint/verifyvyper.md) |
+| `etherscan contractverification verify-stylus` | Submit Stylus source code for verification | [verifystylus](https://docs.etherscan.io/api-reference/endpoint/verifystylus.md) |
+| `etherscan contractverification verify-proxy` | Submit a proxy contract for verification | [verifyproxycontract](https://docs.etherscan.io/api-reference/endpoint/verifyproxycontract.md) |
+| `etherscan contractverification check-status` | Check a source verification submission | [checkverifystatus](https://docs.etherscan.io/api-reference/endpoint/checkverifystatus.md) |
+| `etherscan contractverification check-proxy` | Check a proxy verification submission | [checkproxyverification](https://docs.etherscan.io/api-reference/endpoint/checkproxyverification.md) |
 
 ### Transaction
 

package/npm/bin/etherscan.js

@@ -5,6 +5,7 @@
 const fs = require("node:fs");
 const path = require("node:path");
 const { spawnSync } = require("node:child_process");
+const packageInfo = require("../../package.json");
 
 const packageRoot = path.resolve(__dirname, "..", "..");
 const executable = path.join(
@@ -26,6 +27,8 @@ const result = spawnSync(executable, process.argv.slice(2), {
   env: {
     ...process.env,
     ETHERSCAN_INSTALL_METHOD: "npm",
+    ETHERSCAN_NPM_PACKAGE: packageInfo.name,
+    ETHERSCAN_NPM_WRAPPER_PID: String(process.pid),
   },
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherscan-npm/cli",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Command-line client and interactive explorer for the Etherscan V2 API",
   "license": "MIT",
   "homepage": "https://github.com/etherscan/etherscan-cli",

package/scripts/install.ps1

@@ -4,7 +4,8 @@ param(
     [string]$InstallDir = $env:ETHERSCAN_INSTALL_DIR,
     [switch]$NoPathUpdate,
     [int]$WaitForProcessId = 0,
-    [switch]$CleanupScript
+    [switch]$CleanupScript,
+    [switch]$Uninstall
 )
 
 $ErrorActionPreference = "Stop"
@@ -12,6 +13,8 @@ $ProgressPreference = "SilentlyContinue"
 
 $Repository = "etherscan/etherscan-cli"
 $DownloadBaseUrl = $env:ETHERSCAN_INSTALL_TEST_DOWNLOAD_BASE_URL
+$InstallMarkerName = ".etherscan-cli-path-added"
+$InstallMarkerContent = "etherscan-cli:path-added:v1"
 
 function Get-EtherscanArchitecture {
     $architecture = $env:PROCESSOR_ARCHITEW6432
@@ -118,12 +121,13 @@ function Add-EtherscanToUserPath {
     $userPath = [Environment]::GetEnvironmentVariable("Path", "User")
     $entries = @($userPath -split ';' | Where-Object { -not [string]::IsNullOrWhiteSpace($_) })
     $alreadyPresent = $entries | Where-Object {
+        $entry = $_
         try {
-            $expandedEntry = [Environment]::ExpandEnvironmentVariables($_)
+            $expandedEntry = [Environment]::ExpandEnvironmentVariables($entry)
             [IO.Path]::GetFullPath($expandedEntry).TrimEnd('\').Equals($fullDirectory, [StringComparison]::OrdinalIgnoreCase)
         }
         catch {
-            $_.TrimEnd('\').Equals($fullDirectory, [StringComparison]::OrdinalIgnoreCase)
+            $entry.TrimEnd('\').Equals($fullDirectory, [StringComparison]::OrdinalIgnoreCase)
         }
     }
 
@@ -136,12 +140,53 @@ function Add-EtherscanToUserPath {
         }
         [Environment]::SetEnvironmentVariable("Path", $newUserPath, "User")
         Write-Host "Added $fullDirectory to your user PATH."
+        $pathAdded = $true
+    }
+    else {
+        $pathAdded = $false
     }
 
     $processEntries = @($env:Path -split ';')
     if (-not ($processEntries | Where-Object { $_.TrimEnd('\').Equals($fullDirectory, [StringComparison]::OrdinalIgnoreCase) })) {
         $env:Path = "$env:Path;$fullDirectory"
     }
+    return $pathAdded
+}
+
+function Remove-EtherscanFromUserPath {
+    param([string]$Directory)
+
+    $fullDirectory = [IO.Path]::GetFullPath($Directory).TrimEnd('\')
+    $entries = @([Environment]::GetEnvironmentVariable("Path", "User") -split ';' | Where-Object { -not [string]::IsNullOrWhiteSpace($_) })
+    $kept = @($entries | Where-Object {
+        $entry = $_
+        try {
+            $expandedEntry = [Environment]::ExpandEnvironmentVariables($entry)
+            -not [IO.Path]::GetFullPath($expandedEntry).TrimEnd('\').Equals($fullDirectory, [StringComparison]::OrdinalIgnoreCase)
+        }
+        catch {
+            -not $entry.TrimEnd('\').Equals($fullDirectory, [StringComparison]::OrdinalIgnoreCase)
+        }
+    })
+    if ($kept.Count -ne $entries.Count) {
+        [Environment]::SetEnvironmentVariable("Path", ($kept -join ';'), "User")
+        Write-Host "Removed $fullDirectory from your user PATH."
+    }
+}
+
+function Test-EtherscanInstallMarker {
+    param([string]$Path)
+    if (-not (Test-Path -LiteralPath $Path -PathType Leaf)) { return $false }
+    $item = Get-Item -LiteralPath $Path -Force
+    if ($item.Attributes -band [IO.FileAttributes]::ReparsePoint) { return $false }
+    return (Get-Content -LiteralPath $Path -Raw) -eq $InstallMarkerContent
+}
+
+function Get-EtherscanConfigDirectory {
+    if (-not [string]::IsNullOrWhiteSpace($env:XDG_CONFIG_HOME)) {
+        return Join-Path $env:XDG_CONFIG_HOME "etherscan"
+    }
+    return Join-Path $env:USERPROFILE ".etherscan"
 }
 
 if ($env:OS -ne "Windows_NT") {
@@ -162,6 +207,58 @@ if ($WaitForProcessId -gt 0) {
     Wait-Process -Id $WaitForProcessId -ErrorAction SilentlyContinue
 }
 
+if ($Uninstall) {
+    try {
+        $targetExecutable = Join-Path $InstallDir "etherscan.exe"
+        $marker = Join-Path $InstallDir $InstallMarkerName
+        $validMarker = Test-EtherscanInstallMarker -Path $marker
+        $localAppData = [Environment]::GetFolderPath([Environment+SpecialFolder]::LocalApplicationData)
+        $defaultInstallDir = Join-Path $localAppData "Programs\Etherscan\bin"
+        $legacyDefault = [IO.Path]::GetFullPath($InstallDir).TrimEnd('\').Equals(
+            [IO.Path]::GetFullPath($defaultInstallDir).TrimEnd('\'), [StringComparison]::OrdinalIgnoreCase)
+        $removed = $false
+
+        if (Test-Path -LiteralPath $targetExecutable) {
+            Remove-Item -LiteralPath $targetExecutable -Force
+            Write-Host "Removed $targetExecutable"
+            $removed = $true
+        }
+
+        $otherEntries = @()
+        if (Test-Path -LiteralPath $InstallDir -PathType Container) {
+            $otherEntries = @(Get-ChildItem -LiteralPath $InstallDir -Force | Where-Object {
+                -not ($validMarker -and $_.FullName -eq $marker)
+            } | Select-Object -First 1)
+        }
+        if (-not $NoPathUpdate -and ($validMarker -or $legacyDefault) -and $otherEntries.Count -eq 0) {
+            Remove-EtherscanFromUserPath -Directory $InstallDir
+            if ($validMarker) { Remove-Item -LiteralPath $marker -Force }
+            Remove-Item -LiteralPath $InstallDir -Force -ErrorAction SilentlyContinue
+            $removed = $true
+        }
+        elseif (-not $NoPathUpdate -and (Test-Path -LiteralPath $InstallDir)) {
+            Write-Host "Left $InstallDir on PATH because ownership was not proven or the directory is shared."
+        }
+
+        $configDirectory = Get-EtherscanConfigDirectory
+        if (Test-Path -LiteralPath $configDirectory) {
+            Remove-Item -LiteralPath $configDirectory -Recurse -Force
+            Write-Host "Removed $configDirectory"
+            $removed = $true
+        }
+        if ($removed) { Write-Host "Etherscan CLI uninstalled." } else { Write-Host "Nothing to remove." }
+        if (-not [string]::IsNullOrWhiteSpace($env:ETHERSCAN_API_KEY)) {
+            Write-Warning "ETHERSCAN_API_KEY remains set; unset it in your shell."
+        }
+    }
+    finally {
+        if ($CleanupScript -and -not [string]::IsNullOrWhiteSpace($PSCommandPath)) {
+            Remove-Item -LiteralPath $PSCommandPath -Force -ErrorAction SilentlyContinue
+        }
+    }
+    return
+}
+
 $resolved = Resolve-EtherscanVersion -RequestedVersion $Version
 $architecture = Get-EtherscanArchitecture
 $archiveName = "etherscan_$($resolved.Version)_windows_$architecture.zip"
@@ -240,7 +337,10 @@ try {
     }
 
     if (-not $NoPathUpdate) {
-        Add-EtherscanToUserPath -Directory $InstallDir
+        $pathAdded = Add-EtherscanToUserPath -Directory $InstallDir
+        if ($pathAdded) {
+            Set-Content -LiteralPath (Join-Path $InstallDir $InstallMarkerName) -Value $InstallMarkerContent -NoNewline
+        }
     }
 
     Write-Host ""

package/scripts/install.sh

@@ -7,6 +7,9 @@ version=${ETHERSCAN_VERSION:-}
 install_dir=${ETHERSCAN_INSTALL_DIR:-"$HOME/.local/bin"}
 download_base=${ETHERSCAN_INSTALL_TEST_DOWNLOAD_BASE_URL:-}
 update_path=1
+uninstall=0
+marker_name=.etherscan-cli-path-added
+marker_content=etherscan-cli:path-added:v1
 
 usage() {
     cat <<'EOF'
@@ -18,6 +21,7 @@ Options:
   --version VERSION         Install a specific version (for example, v1.1.0).
   --install-dir DIRECTORY   Install into DIRECTORY (default: ~/.local/bin).
   --no-path-update          Do not update the shell profile.
+  --uninstall               Remove the CLI and saved configuration.
   -h, --help                Show this help.
 EOF
 }
@@ -43,6 +47,10 @@ while [ "$#" -gt 0 ]; do
             update_path=0
             shift
             ;;
+        --uninstall)
+            uninstall=1
+            shift
+            ;;
         -h|--help)
             usage
             exit 0
@@ -57,6 +65,126 @@ if printf '%s' "$install_dir" | LC_ALL=C grep '[[:cntrl:]]' >/dev/null 2>&1; the
     die "the installation directory cannot contain control characters"
 fi
 
+config_dir() {
+    if [ -n "${XDG_CONFIG_HOME:-}" ]; then
+        printf '%s\n' "$XDG_CONFIG_HOME/etherscan"
+    else
+        printf '%s\n' "$HOME/.etherscan"
+    fi
+}
+
+profile_has_block() {
+    profile=$1
+    target=$2
+    [ -f "$profile" ] && [ ! -L "$profile" ] || return 1
+    ETHERSCAN_PROFILE_TARGET=$target awk '
+        BEGIN { target = ENVIRON["ETHERSCAN_PROFILE_TARGET"] }
+        previous == "# Etherscan CLI" && $0 == target { found = 1; exit }
+        { previous = $0 }
+        END { exit found ? 0 : 1 }
+    ' "$profile"
+}
+
+remove_profile_block() {
+    profile=$1
+    target=$2
+    profile_has_block "$profile" "$target" || return 0
+    tmp=$(mktemp "${profile}.etherscan-uninstall.XXXXXX") || die "could not create a profile temporary file"
+    if ! cp -p "$profile" "$tmp"; then
+        rm -f "$tmp"
+        die "could not preserve permissions for $profile"
+    fi
+    if ! ETHERSCAN_PROFILE_TARGET=$target awk '
+        BEGIN { target = ENVIRON["ETHERSCAN_PROFILE_TARGET"] }
+        {
+            if (pending) {
+                if ($0 == target) { pending = 0; next }
+                print "# Etherscan CLI"
+                pending = 0
+            }
+            if ($0 == "# Etherscan CLI") { pending = 1; next }
+            print
+        }
+        END { if (pending) print "# Etherscan CLI" }
+    ' "$profile" >"$tmp"; then
+        rm -f "$tmp"
+        die "could not update $profile"
+    fi
+    mv -f "$tmp" "$profile"
+    printf 'Removed the PATH entry from %s\n' "$profile"
+}
+
+directory_empty_except_marker() {
+    directory=$1
+    marker=$2
+    [ -d "$directory" ] || return 0
+    for entry in "$directory"/.[!.]* "$directory"/..?* "$directory"/*; do
+        [ -e "$entry" ] || [ -L "$entry" ] || continue
+        [ "$entry" = "$marker" ] && continue
+        return 1
+    done
+    return 0
+}
+
+if [ "$uninstall" -eq 1 ]; then
+    binary="$install_dir/etherscan"
+    marker="$install_dir/$marker_name"
+    marker_valid=0
+    if [ -f "$marker" ] && [ ! -L "$marker" ] && [ "$(cat "$marker")" = "$marker_content" ]; then
+        marker_valid=1
+    fi
+
+    escaped_install_dir=$(printf '%s' "$install_dir" | sed 's/[\\"$`]/\\&/g')
+    posix_path_line="export PATH=\"$escaped_install_dir:\$PATH\""
+    fish_path_line="fish_add_path \"$escaped_install_dir\""
+    legacy_provenance=0
+    for candidate in "$HOME/.zshrc" "$HOME/.bashrc" "$HOME/.profile"; do
+        if profile_has_block "$candidate" "$posix_path_line"; then
+            legacy_provenance=1
+        fi
+    done
+    if profile_has_block "$HOME/.config/fish/config.fish" "$fish_path_line"; then
+        legacy_provenance=1
+    fi
+
+    removed=0
+    if [ -e "$binary" ] || [ -L "$binary" ]; then
+        rm -f "$binary"
+        printf 'Removed %s\n' "$binary"
+        removed=1
+    fi
+
+    if [ "$update_path" -eq 1 ] && { [ "$marker_valid" -eq 1 ] || [ "$legacy_provenance" -eq 1 ]; } && directory_empty_except_marker "$install_dir" "$marker"; then
+        for candidate in "$HOME/.zshrc" "$HOME/.bashrc" "$HOME/.profile"; do
+            remove_profile_block "$candidate" "$posix_path_line"
+        done
+        remove_profile_block "$HOME/.config/fish/config.fish" "$fish_path_line"
+        if [ "$marker_valid" -eq 1 ]; then
+            rm -f "$marker"
+        fi
+        rmdir "$install_dir" 2>/dev/null || true
+        removed=1
+    elif [ "$update_path" -eq 1 ] && [ -d "$install_dir" ]; then
+        printf 'Left %s on PATH because ownership was not proven or the directory is shared.\n' "$install_dir"
+    fi
+
+    etherscan_config=$(config_dir)
+    if [ -e "$etherscan_config" ] || [ -L "$etherscan_config" ]; then
+        rm -rf "$etherscan_config"
+        printf 'Removed %s\n' "$etherscan_config"
+        removed=1
+    fi
+    if [ "$removed" -eq 1 ]; then
+        printf 'Etherscan CLI uninstalled.\n'
+    else
+        printf 'Nothing to remove.\n'
+    fi
+    if [ -n "${ETHERSCAN_API_KEY:-}" ]; then
+        printf 'note: ETHERSCAN_API_KEY remains set; unset it in your shell.\n' >&2
+    fi
+    exit 0
+fi
+
 fetch_stdout() {
     url=$1
     if command -v curl >/dev/null 2>&1; then
@@ -195,6 +323,7 @@ if [ "$update_path" -eq 1 ]; then
                     printf '%s\n' "$path_line"
                 } >>"$profile"
                 path_updated=1
+                printf '%s' "$marker_content" >"$install_dir/$marker_name"
             fi
             ;;
     esac