What is the dev preview by czepluch · Pull Request #848 · raiden-network/raiden

czepluch · 2017-08-02T21:54:10Z

No description provided.

ulope · 2017-08-03T14:19:26Z

~~I'm getting a message that sphinx_rtd_theme isn't bundled with sphinx any more. pip install sphinx_rtd_theme fixed it. So it seems that package needs to be added to requirements-dev.txt~~

Scratch that, I missed that you added it to the regular requirements.

LefterisJP · 2017-08-04T21:04:36Z

-*************
-Raiden has a Restful API with URL endpoints corresponding to actions that the user can perform with his channels. The endpoints accept and return JSON encoded objects. The api url path always contains the api version in order to differentiate queries to different API versions. All queries start with: ``/api/<version>/`` where ``<version>`` is an integer representing the current API version.
+=============
+Raiden has a Restful API with URL endpoints corresponding to actions that the user can perform with its channels. The endpoints accept and return JSON encoded objects. The API URL path always contains the API version in order to differentiate queries to different API versions. All queries start with: ``/api/<version>/`` where ``<version>`` is an integer representing the current API version.


its -> their

It's referring to user so singular and not plural

The proper way to be gender neutral is to use plural their and not neutral form.

LefterisJP · 2017-08-04T21:06:26Z

+Below is a series of different scenarios showing different ways that the Raiden API can be used and interacted with.

-A good way to check that you started Raiden correctly before proceeding is to check that your Raiden address is the same address as the Ethereum address that you chose, when starting the Raiden node::
+A good way to check that we started Raiden correctly before proceeding is to check that our Raiden address is the same address as the Ethereum address that we chose, when starting the Raiden node::


Please do not use the "we" form here. Either leave it as is, or if you really really wanna change it, then make it to passive voice. But I see absolutely no problem in leaving it as it is.

Hmm. I see your point. I changed it to "we" for consistency, but I'd prefer the passive voice.

@LefterisJP I use we consistently throughout the entire document. Would you prefer that I change it to consistently be your/you instead?

Personally I prefer we because I find it less personal, but could also try to make it it entirely neutral.

we is quite personal. You is more neutral. It can be either you singular or plural. Even more neutral is passive voice. But I still think leaving it as you is fine. Changing it to we is not.

LefterisJP · 2017-08-04T21:07:09Z

    GET /api/1/address

-If this returns your address, you know that your Raiden node has the API up and running.
+If this returns our address, we know that our Raiden node is up and running correctly.


Same goes here and in all the other places below where you changed you to we and your to our.

LefterisJP · 2017-08-04T21:27:04Z

+
+There are some interesting parameters to note here. The ``role`` defines whether the address sending the message is the ``maker`` or the ``taker``. The maker call must be carried out before the taker call can be carried out. The ``sending_amount`` and the ``sending_token`` represents the token for which the maker wants to send some amount in return for a ``receiving_token`` and a ``receiving_amount``. So in this specific case Alice is making an offer of 42 of ``tokenA`` with the address ``0xea674fdde714fd979de3edf0f56aa9716b898ec8`` for 76 of ``tokenB`` with the address ``0x2a65aca4d5fc5b5c859090a6c34d164135398226``.
+
+Now all we need is for someone to take the offer. It could be that Alice and Bob has decided on the swap in private and thus Alice simply tells Bob the ``identifier``. Or it could be that the offer is taken by Bob who sees the offer on some decentralized exchange powered by Raiden.


Alice and Bob has -> Alice and Bob have

LefterisJP · 2017-08-04T21:28:13Z

+        "receiving_token": "0x2a65aca4d5fc5b5c859090a6c34d164135398226"
+    }
+
+There are some interesting parameters to note here. The ``role`` defines whether the address sending the message is the ``maker`` or the ``taker``. The maker call must be carried out before the taker call can be carried out. The ``sending_amount`` and the ``sending_token`` represents the token for which the maker wants to send some amount in return for a ``receiving_token`` and a ``receiving_amount``. So in this specific case Alice is making an offer of 42 of ``tokenA`` with the address ``0xea674fdde714fd979de3edf0f56aa9716b898ec8`` for 76 of ``tokenB`` with the address ``0x2a65aca4d5fc5b5c859090a6c34d164135398226``.


represents the token for which -> represent the token for which

LefterisJP · 2017-08-04T21:33:42Z

+
+Introduction
+------------
+The goal with releasing the Developer Preview is to give developers a chance to get familiar with the


The goal with releasing the Developer -> The goal of releasing the Developer

LefterisJP · 2017-08-04T21:37:45Z

+Introduction
+------------
+The goal with releasing the Developer Preview is to give developers a chance to get familiar with the
+Raiden API and to figure out what will be possible to do with Raiden, once it's fully ready.


and to figure out what will be possible to do with Raiden, once it's fully ready. -> and to get an idea of the full potential of Raiden once all issues are addressed

LefterisJP · 2017-08-04T21:38:07Z

+
+- Opening, closing and settling of payment channels.
+- Direct and mediated (multi hop) transfers.
+- Automatically joining a token network and connecting to peers


add a full stop

LefterisJP · 2017-08-04T21:38:57Z

+- Automatically joining a token network and connecting to peers
+- A :doc:`REST API <rest_api>` with endpoints for all functionality.
+- Possibility to create token networks for all ERC20 tokens.
+- Restartability of Raiden nodes.


Here perhaps make a note that restartability means only if case of a proper shutdown

LefterisJP · 2017-08-04T21:39:45Z

+----------------------------
+
+- Safe to use in the main net and we do not recommend that anyone deploy the contracts to the Ethereum main net.
+- Properly security audited and should, hence, not be used to transfer anything of actual value.


anything of actual value. -> anything of considerable value.

fix Raiden capitalization removing unexisting link`

fix superflous comma and add paragraf about IP addresses

czepluch added the dev: Work In Progress label Aug 2, 2017

czepluch force-pushed the what_is_the_dev_preview branch from e554bad to ecc1176 Compare August 3, 2017 12:20

konradkonrad mentioned this pull request Aug 3, 2017

Document installation and usage #668

Closed

12 tasks

czepluch force-pushed the what_is_the_dev_preview branch from ecc1176 to 5b5c285 Compare August 3, 2017 13:35

czepluch added dev: Please Review and removed dev: Work In Progress labels Aug 3, 2017

LefterisJP suggested changes Aug 4, 2017

View reviewed changes

czepluch added 6 commits August 8, 2017 15:31

initial work on explaining what Dev Prev is and is not

79de3bc

correct typo in file name

1769efe

renaming files to be accepted by sphinx

b9ed5cf

rename all rst files to be accepted by sphinx and update api guide

21911c4

correcting some typos and fixing sphinx formatting

03be853

fix Raiden capitalization removing unexisting link`

updating html theme

20e1f4c

czepluch force-pushed the what_is_the_dev_preview branch from 5b5c285 to 6d1260a Compare August 8, 2017 13:32

changed walkthrough to be in neutral tone and fixed some review comments

0772d5a

fix superflous comma and add paragraf about IP addresses

czepluch force-pushed the what_is_the_dev_preview branch from 6d1260a to 0772d5a Compare August 8, 2017 14:21

LefterisJP approved these changes Aug 9, 2017

View reviewed changes

LefterisJP merged commit 45bf0f3 into raiden-network:master Aug 9, 2017


		There are some interesting parameters to note here. The ``role`` defines whether the address sending the message is the ``maker`` or the ``taker``. The maker call must be carried out before the taker call can be carried out. The ``sending_amount`` and the ``sending_token`` represents the token for which the maker wants to send some amount in return for a ``receiving_token`` and a ``receiving_amount``. So in this specific case Alice is making an offer of 42 of ``tokenA`` with the address ``0xea674fdde714fd979de3edf0f56aa9716b898ec8`` for 76 of ``tokenB`` with the address ``0x2a65aca4d5fc5b5c859090a6c34d164135398226``.

		Now all we need is for someone to take the offer. It could be that Alice and Bob has decided on the swap in private and thus Alice simply tells Bob the ``identifier``. Or it could be that the offer is taken by Bob who sees the offer on some decentralized exchange powered by Raiden.

Conversation

czepluch commented Aug 2, 2017

Uh oh!

ulope commented Aug 3, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ulope commented Aug 3, 2017 •

edited

Loading