Skip to content

Commit

Permalink
2.1 Release - IMPORTANT BREAKING CHANGES (#421)
Browse files Browse the repository at this point in the history
# 2.1 Release  - IMPORTANT BREAKING CHANGES - 
* TL;DR: New [Environment
Variables](.github/workflows/proxy-router.main.env):
  * 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](/docs/02.5-api-auth.md) 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](https://github.com/orgs/Lumerin-protocol/packages/container/package/morpheus-lumerin-node)
* Please see
[02.1-proxy-router-docker](/docs/02.1-proxy-router-docker.md) for
details on how to use the container file and run with command line
variables or .env file.
  • Loading branch information
abs2023 authored Jan 27, 2025
2 parents 753b9f1 + c2dcc1c commit a0bb861
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
workflow_dispatch:
inputs:
create_release:
description: 'Create new release'
description: 'Create updated Morpheus release'
required: true
type: boolean

Expand Down

0 comments on commit a0bb861

Please sign in to comment.