Skip to content
This repository has been archived by the owner on May 13, 2022. It is now read-only.

To create new releases of the Raiden Wizard

Raphael Lullis edited this page Nov 25, 2019 · 3 revisions

We are yet to automate the build/release of new Wizard releases. Until this is not done, read below to find out what is needed to get a Wizard binary.

Quick HOWTO create new Wizard releases

  1. Write the toml file with the configuration for the desired target (network, tokens, services version, funding requirements) according to the definition below.
  2. Run the script available on tools/build_static_binary.sh, passing the path of the configuration file you want as a parameter.

TOML Configuration File

When starting, the wizard looks for a file called settings.toml on the folder resources/conf. The following values need to be always set:

  • network is the name of the chain you want to use. Accepted values:

    • mainnet
    • goerli
    • ropsten
    • rinkeby
    • kovan
  • client_release_channel: to choose between mainnet releases, testnet releases and nightly releases. Accepted values:

    • mainnet
    • testing
    • nightly
  • client_release_version: the tag of the release. Eg.: "v0.200.0-rc1"

  • services_version: which PFS to connect to. Possible values of dev or test

  • ethereum_amount_required: amount of ethereum (in wei) required for the account to have in balance so that raiden can launch. E.g 2e16 will ask the user to have 0.02 ETH in the balance

Besides the values above, it is also required to look set the values for the tokens that we will use/request the user to have. There are two types of token that need to be defined: service_token and transfer_token. Each token can be defined by the following attributes

  • ticker: the common ticker of the token. E.g RDN, SVT, DAI
  • amount_required: amount in wei. e.g: 6e18
  • mintable: boolean to indicate if we are able to mint the token on behalf of the user (i.e, only makes sense to be used on testnets). Defaults to false

Relation to Raiden Contracts

When a new release of Raiden is made, it is very important to check what version of the raiden contracts is being used. These will affect the following parameters:

  • Address of the UDC
  • Address of Service Token (for testnets only)

What needs to be done if there is any new release of the raiden contract?

  1. Update the raiden_contracts entry on requirements.txt
  2. Check the address of the Service Token used in the UDC.
  3. Create a new TokenV{VERSION_NUMBER} Enum on raiden_installer/tokens.py, and define all the relevant addresses. (Look at TokenV33 as an example)
  4. On raiden_installer/tokens.py, find the Erc20Token.find_by_ticker method and add the created Enum to token_list_version mapping.