Package: raiden-webui
Raiden WebUIGetting Started∙ContactRaiden WebUI is a simple web application that utilizes the Raiden REST API endpoints to
allow the user to interact with token networks, make token payments, see the current status of open
channels along with closing and settling channels to name some of the functionality.Table of ContentsTable of ContentsAbout The ProjectGetting StartedLearn about RaidenUsing the WebUIPrerequisitesDevelopmentConfigurationRunning the WebUIPython packageContributingLicenseContactAbout The ProjectTheRaiden Networkis an off-chain scaling solution, enabling near-instant,
low-fee and scalable payments. It’s complementary to the Ethereum blockchain and works with any ERC20 compatible token.The Raiden client code is availablehereand has beenreleased for mainnetfor the Alderaan release of the Raiden Network in May 2020.Raiden WebUI is built using the following technologies:AngularAngular MaterialAngular Flex-LayoutWeb3.jsGetting StartedLearn about RaidenIf you haven't used Raiden before, you can:Checkout thedeveloper portalLook at thedocumentationLearn more by watching explanatoryvideosRead the blog posts onMediumUsing the WebUIIf you want to learn how to use the Raiden WebUI anupdated tutorialhas been published in the new documentation for Raiden.PrerequisitesIf you just want to use the WebUI all you need to do is install and run Raiden. A version of the WebUI comes bundled with each Raiden release and is accessible fromhttp://127.0.0.1:5001.For details on how to easily install Raiden:Read theQuick Startsection in the documentation.If you want to work on the WebUI codebase you need:Node >=10.13.0A workingRaiden client.Git for version control.Yarn v1 for package management.DevelopmentBefore you start working on the WebUI you need to install the WebUI dependencies.yarninstallConfigurationBefore you begin to work on the WebUI you have to make sure that you have the proper configuration.
Check if theproxy configurationcorresponds to your actual environment configuration.Since you will not be running the WebUI embedded into Raiden you need to provide both the Ethereum RPC endpoint
and the Raiden REST API endpoint to theproxy.config.json.By default the configurations looks like this:{"/api":{"target":"http://localhost:5001","proxyTimeout":600000},"/web3":{"target":"http://localhost:8545","pathRewrite":{"^/web3":""},"changeOrigin":true,"proxyTimeout":60000}}The configuration assumes that the Ethereum RPC endpoint listens onhttp://localhost:8545and the Raiden REST API is onhttp://localhost:5001. If you are using a different configuration make sure
to update the corresponding fields in the configuration.For example if you run Raiden on port5002and you use Infura as your RPC provider you would have to
modify theproxy.config.jsonto like like:{"/api":{"target":"http://localhost:5002","proxyTimeout":600000},"/web3":{"target":"http://goerli.infura.io/v3/YOUR_API_KEY","pathRewrite":{"^/web3":""},"changeOrigin":true,"proxyTimeout":60000}}Info: On development mode there is no way to guarantee that raiden and the RPC provider run on the same chain.
You have to be careful, because if you start for example Raiden on Rinkeby and pass Görli as the RPC endpoint, WebUI
will fail to work.Important: Modifications onproxy.config.jsonmake sure never be part of your PR.Running the WebUIAfter you are done with the configuration you can start the development server:yarnrunserveAfter the development server starts you have to navigate tohttp://localhost:4200/ui, in order to use the WebUI.Python packageThe WebUI is build as a python package and it's available on PyPI. This package is pinned as a dependency on Raiden.
The PyPI package provides a precompiled version of the WebUI that is bundled with Raiden and can be used out of the box.The python package provides a static variable that points to the location of the WebUI static content root directory.
This can be imported by raiden to expose the bundled WebUI resources:fromraiden_webuiimportRAIDEN_WEBUI_PATHThe package can build the python package by calling:pythonsetup.pybuildsdistbdist_wheelThe command callsyarn build:prodto build the static production version of the WebUI so
that it can get included in the python package.If you need to install the package locally to your development virtual environment you can do
so by running:pythonsetup.pybuildinstallIn case you need to use the debug version of the WebUI within your virtual environment you can also
run:pythonsetup.pycompile_webui-DinstallThis will build the debug version of the WebUI to include in your package.ContributingContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make aregreatly appreciated.Also have a look at theRaiden WebUI Development Guidefor more info.LicenseDistributed under theMIT License.ContactDev Chat:GitterTwitter:@raiden_networkWebsite:Raiden NetworkMail:contact@raiden.networkProject Link:https://github.com/raiden-network/light-client