Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 6 additions & 51 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,56 +12,11 @@ sudo: required
# - "release/major"
# ########################

stages:
- name: build-test
if: tag !~ /^release\/(major|minor|patch)$/
- name: release
if: tag =~ /^release\/(major|minor|patch)$/

jobs:
include:
# Test that it builds correctly
###############################
- stage: build-test
name: build-test
services:
- docker
script:
- docker-compose build

# Deploy stage
# - code below is common between DAppNode packages
##################################################
- stage: release
name: release
services:
- docker
script:
- npm install -g @dappnode/dappnodesdk
- docker-compose build
- "TYPE=${TRAVIS_TAG##*/}"
- "[ ! '$TYPE' = 'release' ] || TYPE='patch'"
- dappnodesdk publish ${TYPE} --dappnode_team_preset
node_js:
- "10.15.3"
before_deploy:
- wget https://raw.githubusercontent.com/dappnode/DAppNode/master/scripts/before_deploy.sh
- source before_deploy.sh
deploy:
provider: releases
prerelease: true
overwrite: true
api_key: "$GITHUB_TOKEN"
file_glob: true
# $RELEASE_VERSION is exported on before_deploy.sh
file: build_${RELEASE_VERSION}/*
skip_cleanup: true
# $TRAVIS_TAG is exported on before_deploy.sh
name: "$TRAVIS_TAG"
body: "# Changelog"
on:
tags: true
condition: "$TRAVIS_TAG = release || $TRAVIS_TAG = release/patch || $TRAVIS_TAG = release/minor || $TRAVIS_TAG = release/major"
after_deploy:
- wget https://raw.githubusercontent.com/dappnode/DAppNode/master/scripts/after_deploy.sh
- source after_deploy.sh
- script: docker-compose build
if: tag !~ ^release
- stage: deploy
node_js: lts/*
if: tag =~ ^release
script: npx @dappnode/dappnodesdk publish --dappnode_team_preset
102 changes: 98 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ The Raiden Network is an off-chain scaling solution, enabling near-instant, low-

See the [documentation](https://raiden-network.readthedocs.io/en/stable/index.html) for more information.

# How to use this package

TODO

# Build prerequisites

- git
Expand Down Expand Up @@ -42,3 +38,101 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
## Note

This is early stage software

# Raiden mainet keystore uploading doc


Raiden is available in DAppNode in mainet and the different testnets, but in mainet you have to upload your own keystore.

## Running Raiden in mainet

In mainet you will have to install the mainet package and take into account that your Ethereum node should be running with this flags.

```--jsonrpc-apis=eth,net,web3,parity``` and the flag ```--no-ancient-blocks``` should not be activated.

![](https://i.imgur.com/X1bJCJF.png)

If you do not have a keystore file, you can create a new wallet in My Ether Wallet or MyCrypto, and then fund it with a bit of ETH / WETH (only token supported in mainet at the moment).

Please be aware that the online creation of wallets via a keystore file is not such a good security practice. This can be mitigated if you download the MyCrypto local app and create the wallet offline.

Do not leave significant value in wallets created through this method.


## Keystore uploading

Go to packages and enter the Raiden package

![](https://i.imgur.com/p0IVsPn.png)


* In the "File manager" tab upload your keystore file (please note that in the current version, WETH is the only token supported)

![](https://i.imgur.com/29GFRHk.png)

No need to select any path in this case, you can leave this field as it is, and the keystore file will be uploaded in the correct path once you hit the "Upload" button.

* In "Environment Variables", fill the options with:

* The password of the uploaded keystore
* Its address


Here you have an example screenshot!

![](https://i.imgur.com/DPbu66n.png)


If all the steps have been performed correctly you will see these logs within the Raiden package (at the bottom of the screen)

![](https://i.imgur.com/2SQ802h.png)


Now you can access the [Raiden UI](http://raiden.dappnode) and start doing instant payments.

## Backup of your account

When you install the Raiden mainet package the keystore is stored in your DAppNNode.

If you want to have a backup of that account follow these steps.

* Enter the Raiden Package in the packages tab and scroll down to File Manager
* Write "keystore" in the "Download from DNP" field
* Hit download

![](https://i.imgur.com/PoALyud.png)


A compressed file called "keystore" will be dowloaded containing both the keystore file and the password (the latter as a hidden file)

## Using Raiden with different accounts

If you have different keystores with WETH and you want to switch the account, you can do so by uploading your keystore file to the Raiden DAppNode Package (DNP) and by writing the address and password of your keystore in the environment variables field.

* Go to File manager
* Hit browse and select your keystore file
* Click upload without need to write anything in the path field

![](https://i.imgur.com/2NK4EV2.png)


Your keystore is now uploaded. Now we need to tell the package that you want to use that keystore

* Go to Environment Variables
* Type the password of your newly uploaded keystore (address is not necessary, it will be automatically detected)
* Hit update environment variables

![](https://i.imgur.com/sjKiw1s.png)


You are done!

When you go to the [Raiden ADMIN UI](http://raiden.dappnode) you will see your custom account.

As long as you have the keystore uploaded to the package you can use any account just by typing its password in the Environment variables field of the package and hitting Update, just the password, you do not need to write the address, the account will be recognized and you will be using that account when accessing the UI.

Now you are ready to enjoy fast, cheap, and scalable token transfers for Ethereum.




Binary file added avatar-raiden.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 22 additions & 11 deletions dappnode_package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
{
"name": "raiden.dnp.dappnode.eth",
"version": "0.0.2",
"description": "The Raiden Network is an off-chain scaling solution, enabling near-instant, low-fee and scalable payments.",
"upstreamVersion": "0.100.3",
"shortDescription": "Fast, cheap, scalable token transfers for Ethereum",
"description": "The Raiden Network is 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. \n\n\n **Getting started** \n\n Once you have installed the Raiden DAppNode Package you **must** upload your own keystore. Go to this [getting started guide](https://github.com/dappnode/DAppNodePackage-raiden) to learn how to do so. \n\n\n All set? Check out the [documentation and introductory guides](https://raiden-network.readthedocs.io/en/stable/#how-to-get-started) to quickly get started doing payments.",
"avatar": "/ipfs/QmaqgLyZXpETXYzhWcebNJnh6vPs4WqiCJbZY3EY1fXqer",
"type": "service",
"image": {
Expand All @@ -17,29 +19,38 @@
"RAIDEN_KEYSTORE_PASSWORD=",
"RAIDEN_ADDRESS=",
"EXTRA_OPTS=--disable-debug-logfile"
],
"keywords": [
"Raiden",
"Ethereum"
]
},
"backup": [],
"warnings": {},
"disclaimer": {
"message": "This software is experimental, presented 'as is' and inherently carries risks. By installing it, you acknowledge that DAppNode Association has done its best to mitigate these risks and accept to waive any liability or responsibility for DAppNode in case of any shortage, discrepancy, damage, loss or destruction of any digital asset managed within this DAppNode package.\n\nThis package stores private keys, which will be stored in your DAppNode. Neither DAppNode Association nor the developers of this software can have access to your private key, nor help you recover it if you lose it. \n\nYou are solely responsible for keeping your private keys and password safe and to perform secure backups, as well as to restrict access to your computer and other equipment. To the extent permitted by applicable law, you agree to be responsible for all activities that have been conducted from your account. You must take all necessary steps to ensure that your private key, password, and recovery phrase remain confidential and secured. \n\nThis is an Alpha version of experimental open source software released as a test version under an MIT license and may contain errors and/or bugs. No guarantee or representations whatsoever is made regarding its suitability (or its use) for any purpose or regarding its compliance with any applicable laws and regulations. Use of the software is at your own risk and discretion and by using the software you acknowledge that you have read this disclaimer, understand its contents, assume all risk related thereto and hereby release, waive, discharge and covenant not to sue Brainbot Labs Establishment or any officers, employees or affiliates from and for any direct or indirect liability resulting from the use of the software as permissible by applicable laws and regulations.\n\nPrivacy Warning: Please be aware, that by using the Raiden Client, \namong others, your Ethereum address, channels, channel deposits, settlements and the Ethereum address of your channel counterparty will be stored on the Ethereum chain, i.e. on servers of Ethereum node operators and ergo are to a certain extent publicly available. The same might also be stored on systems of parties running Raiden nodes connected to the same token network. Data present in the Ethereum chain is very unlikely to be able to be changed, removed or deleted from the public arena.\n\nAlso be aware, that data on individual Raiden token transfers will be made available via the Matrix protocol to the recipient, intermediating nodes of a specific transfer as well as to the Matrix server operators."
},
"style": {
"featuredBackground": "linear-gradient(293deg, #000000, #313131)",
"featuredColor": "white",
"featuredAvatarFilter": "invert(1)"
},
"author": "DAppNode Association <admin@dappnode.io> (https://github.com/dappnode)",
"contributors": [
"Abel Boldú (@vdo)"
],
"homepage": {
"homepage": "https://github.com/dappnode/DAppNodePackage-raiden#readme"
"categories": ["Payment channels"],
"keywords": ["Raiden", "Raiden Network", "Payment Channels", "Ethereum", "Blockchain"],
"links": {
"homepage": "https://github.com/dappnode/DAppNodePackage-raiden#readme",
"ui": "http://raiden.dappnode",
"api": "http://raiden.dappnode:5001/api/"
},
"repository": {
"type": "git",
"url": "git+https://github.com/dappnode/DAppNodePackage-raiden.git"
"url": "https://github.com/dappnode/DAppNodePackage-raiden.git"
},
"bugs": {
"url": "https://github.com/dappnode/DAppNodePackage-raiden/issues"
},
"disclaimer": {
"message": "This software is experimental, presented 'as is' and inherently carries risks. By installing it, you acknowledge that DAppNode Association has done its best to mitigate these risks and accept to waive any liability or responsibility for DAppNode in case of any shortage, discrepancy, damage, loss or destruction of any digital asset managed within this DAppNode package.\n\nThis package stores private keys, which will be stored in your DAppNode. Neither DAppNode Association nor the developers of this software can have access to your private key, nor help you recover it if you lose it. \n\nYou are solely responsible for keeping your private keys and password safe and to perform secure backups, as well as to restrict access to your computer and other equipment. To the extent permitted by applicable law, you agree to be responsible for all activities that have been conducted from your account. You must take all necessary steps to ensure that your private key, password, and recovery phrase remain confidential and secured. \n\nThis is an Alpha version of experimental open source software released as a test version under an MIT license and may contain errors and/or bugs. No guarantee or representations whatsoever is made regarding its suitability (or its use) for any purpose or regarding its compliance with any applicable laws and regulations. Use of the software is at your own risk and discretion and by using the software you acknowledge that you have read this disclaimer, understand its contents, assume all risk related thereto and hereby release, waive, discharge and covenant not to sue Brainbot Labs Establishment or any officers, employees or affiliates from and for any direct or indirect liability resulting from the use of the software as permissible by applicable laws and regulations.\n\nPrivacy Warning: Please be aware, that by using the Raiden Client, \namong others, your Ethereum address, channels, channel deposits, settlements and the Ethereum address of your channel counterparty will be stored on the Ethereum chain, i.e. on servers of Ethereum node operators and ergo are to a certain extent publicly available. The same might also be stored on systems of parties running Raiden nodes connected to the same token network. Data present in the Ethereum chain is very unlikely to be able to be changed, removed or deleted from the public arena.\n\nAlso be aware, that data on individual Raiden token transfers will be made available via the Matrix protocol to the recipient, intermediating nodes of a specific transfer as well as to the Matrix server operators."
},
"license": "MIT License",
"dependencies": {}
}
"license": "MIT License"
}
Binary file removed logo.jpg
Binary file not shown.