v2.2.0 Release - IMPORTANT - Breaking Changes (API Auth, Blockscout, Docker)

[abs2023]

2.2 Release - IMPORTANT - BREAKING CHANGES

• TL;DR: New Environment Variables:
  • Mandatory:
    • BLOCKSCOUT_API_URL replaces EXPLORER_API_URL for the proxy-router
  • Optional:
    • COOKIE_FILE_PATH adds directed location for the .cookie API auth file (auth-n)
    • AUTH_CONFIG_FILE_PATH adds directed location for the proxy.conf file which holds the fine-grained authorization for admin, users and agents (auth-z)

Bug Fix - Arbiscan.io

• As of the first of the year, Arbiscan.io (which we used for explorer lookups) now require a free API Key even for basic lookups.
• This issue broke the display of wallet transactions in the Desktop UI
• To mitigate this issue and enable future enhancements with agent activity and to give deeper insight into wallet activity, we are now using Blockscout.com's API for explorer / blockchain lookups.
• THIS WILL REQUIRE A CHANGE TO YOUR .ENV Environment files and variables by adding BLOCKSCOUT_API_URL=https://arbitrum.blockscout.com/api/v2 the functionality will now be restored.
• This is a mandatory variable for the proxy-router, and it will not start without this new variable

API-Authorization

• In order to secure the proxy-router API and enable future agent authorization, the API will now require authentication
• Please see 02.5-api-auth for details on how to examine the .cookie file, authenticate to the proxy-router as admin and then manually add agent/users with fine-grained access
• Pre-seed .cookie file for Docker builds or other complex environments, you can supply a .cookie file (via echo or other command) into the COOKIE_FILE_PATH location with the format admin:my_strong_password.
• This will build the .cookie file and the proxy-router will build the proxy.conf file. This allows you to know the admin password for the API prior to build/runtime.

Docker Package

• To reduce friction for deploying the Morpheus-Lumerin proxy-router (core system) via container, we have included Linux/AMD64 and Linux/ARM64 compatible docker image
• Please visit Morpheus-Lumerin-Node Package Site
• Please see 02.1-proxy-router-docker for details on how to use the container file and run with command line variables or .env file.