From a33c7e4a2c1d1d30c47dd83895721dd374ddb963 Mon Sep 17 00:00:00 2001 From: Max Langenfeld Date: Tue, 4 Aug 2020 09:23:38 +0200 Subject: [PATCH 1/4] Fix slash for multiline terminal commands Change the slash to backslash symbols for the multiline terminal code snippets. --- installation/starting-raiden-manually.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/installation/starting-raiden-manually.md b/installation/starting-raiden-manually.md index cd223b7..c6075c2 100644 --- a/installation/starting-raiden-manually.md +++ b/installation/starting-raiden-manually.md @@ -20,17 +20,17 @@ Download the latest Raiden [https://github.com/raiden-network/raiden/releases/ta You can start Raiden with either Geth, Parity or Infura as RPC Endpoint. All you need is an Ethereum Account and the respective keystore file funded with the tokens you want to transfer. -```text -raiden / ---address $YOUR-ETHEREUM-ADDRESS / ---keystore-path $PATH-TO-YOUR-KEYSTORE-FILE / ---password-file $PASSWORD-FILE-FOR-KEYSTORE-FILE / +```console +raiden \ +--address $YOUR-ETHEREUM-ADDRESS \ +--keystore-path $PATH-TO-YOUR-KEYSTORE-FILE \ +--password-file $PASSWORD-FILE-FOR-KEYSTORE-FILE \ --eth-rpc-endpoint $YOUR-ETHEREUM-NODE ``` In doubt, you can use -```text +```console raiden --help ``` @@ -40,15 +40,15 @@ to see all possible CLI arguments. Per default a **Pathfinding Service** is used by your Raiden client when a **mediated transfer** is initiated. The maximum amount paid for one request to the Pathfinding services is set to `0.05` RDN and 3 different paths are requested. -```text ---pathfinding-service-address auto / ---pathfinding-max-fee 50000000000000000 / +```console +--pathfinding-service-address auto \ +--pathfinding-max-fee 50000000000000000 \ --pathfinding-max-paths 3 ``` By default the **Monitoring Services** are disabled. Enabling monitoring of channels will require a default reward value of `5` RDN for successfully monitoring your channel. -```text +```console --enable-monitoring FALSE ``` From 900d75e6b454cdb11f745c951f64e2a7e8fe1800 Mon Sep 17 00:00:00 2001 From: Max Langenfeld Date: Tue, 4 Aug 2020 10:24:02 +0200 Subject: [PATCH 2/4] Add notes for required testnet arguments --- installation/starting-raiden-manually.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/installation/starting-raiden-manually.md b/installation/starting-raiden-manually.md index c6075c2..e32d519 100644 --- a/installation/starting-raiden-manually.md +++ b/installation/starting-raiden-manually.md @@ -52,3 +52,16 @@ By default the **Monitoring Services** are disabled. Enabling monitoring of chan --enable-monitoring FALSE ``` +## Testnet usage + +When using one of the Ethereum testnets, you have to set the `--environment-type` to development-mode, +so that the correct Matrix federation network for the PFS will be chosen. + +In order to connect to one of the Ethereum testnets, you have to provide the following additional arguments: + +```console +--network-id $TESTNET-NAME-OR-ID \ +--environment-type development +``` + +E.g. for the Goerli testnet `$TESTNET-NAME-OR_ID` would be `goerli` or `5`. From 054b6c8ae20b2a43d263079a6c4969deffdd6d0b Mon Sep 17 00:00:00 2001 From: Max Langenfeld Date: Tue, 4 Aug 2020 10:33:22 +0200 Subject: [PATCH 3/4] Add back-reference to v1 SVT tutorial Until the tutorial on how to fund an account with SVT is integrated in the v2 docs add a back-reference --- installation/starting-raiden-manually.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/installation/starting-raiden-manually.md b/installation/starting-raiden-manually.md index e32d519..7c9d385 100644 --- a/installation/starting-raiden-manually.md +++ b/installation/starting-raiden-manually.md @@ -65,3 +65,6 @@ In order to connect to one of the Ethereum testnets, you have to provide the fol ``` E.g. for the Goerli testnet `$TESTNET-NAME-OR_ID` would be `goerli` or `5`. + +More information on how to aquire and deposit the utility token (SVT) on the testnets are [provided in the v1 docs](https://raiden-network.readthedocs.io/en/latest/overview_and_guide.html#depositing-tokens-to-pay-the-services). + From cf7ec6c74a68b748b538d12219f80135eb601622 Mon Sep 17 00:00:00 2001 From: Max Langenfeld Date: Tue, 4 Aug 2020 10:58:47 +0200 Subject: [PATCH 4/4] Remove hard-link to v.1.0.0 release Direct to the GitHub releases page instead of hard-linking the v.1.0.0 version so that the most recent stable version can be downloaded and people don't use an old version. --- installation/starting-raiden-manually.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/installation/starting-raiden-manually.md b/installation/starting-raiden-manually.md index 7c9d385..28b9fe0 100644 --- a/installation/starting-raiden-manually.md +++ b/installation/starting-raiden-manually.md @@ -14,7 +14,7 @@ You might want to start Raiden manually if: ## Downloading Raiden -Download the latest Raiden [https://github.com/raiden-network/raiden/releases/tag/v1.0.0](https://github.com/raiden-network/raiden/releases/tag/v1.0.0) +Download the latest Raiden [https://github.com/raiden-network/raiden/releases/](https://github.com/raiden-network/raiden/releases/) ## Run Raiden