micropayment channel example with two chapters #4212

jvmaia · 2018-05-31T09:21:10Z

chriseth · 2018-05-31T10:26:01Z

Thanks for the pull request! I Have not yet looked into it in detail, but some remarks that will also help in the review process:

please split long lines, it makes it much easier to comment on specific parts of a paragraph
note that all code in the documentation is compiled during the CI run, so please either create full contracts or - there is some way to mark it but I cannot look it up right now, sorry.

jvmaia · 2018-05-31T14:05:57Z

hey @chriseth, i don't know what is better here, write the full contracts or mark the pieces of code to not be compiled? what do you think about?

jvmaia · 2018-06-03T03:40:01Z

i'm going to write the full contracts and use the comments to explain what the code does and it importance

VoR0220 · 2018-06-03T16:01:57Z

docs/solidity-by-example.rst

+and the sender is sent the rest via a *selfdestruct*.
+You can see the *close* function in the full contract.
+
+Channel Expriration


Expiration*

Thanks, fixing it now!

jvmaia · 2018-06-06T17:37:54Z

Any update is needed here?

chriseth

Thanks a lot for the detailed tutorial!
I will review the rest later, but could you please correct typos in the rest of the text first? Thanks!

chriseth · 2018-06-07T09:39:59Z

docs/solidity-by-example.rst

@@ -645,4 +645,499 @@ Safe Remote Purchase
 Micropayment Channel
 ********************

-To be written.
+Creating and verifying signatures


Perhaps it would be good to have 1-2 sentences before the first subsection to explain the individual components of a micropayment channel, i.e. what is the perpose of the various subsections and what are we going to do in the "micropayment channel" section?

chriseth · 2018-06-07T09:41:56Z

docs/solidity-by-example.rst

+=================================
+
+Signatures are used to authorize transactions,
+and they're a general tool that's available to


Could you please change the style to not use contractions (i.e. `they are a general tool that is available...') as in most of the rest of the documentation?

chriseth · 2018-06-07T09:43:42Z

docs/solidity-by-example.rst

+
+Signatures are used to authorize transactions,
+and they're a general tool that's available to
+smart contracts. In this chapter we'll use it to


prove (...) that a certain account approved a certain message - isn't that the most general form of the purpose of a signature (and still, the sentence starts with "in this chapter...")?

chriseth · 2018-06-07T09:48:26Z

docs/solidity-by-example.rst

+smart contracts. In this chapter we'll use it to
+prove to a smart contract that a certain account
+approved a certain message. We'll build a simple
+smart contract that lets me transmit ether, but


Using we and I at the same time might be confusing. Perhaps it would be better to introduce people like Alice and Bob?

chriseth · 2018-06-07T09:48:32Z

docs/solidity-by-example.rst

+prove to a smart contract that a certain account
+approved a certain message. We'll build a simple
+smart contract that lets me transmit ether, but
+in a unsual way, instead of calling a function myself


Typo: unsual

chriseth · 2018-06-07T09:57:29Z

docs/solidity-by-example.rst

+but some of them are incompatible. We'll use the new standard
+way to do that `EIP-762 <https://github.com/ethereum/EIPs/pull/712>`_,
+it provides a number of other security benefits.
+Is recommended to stick with the most standard format of signing,


This sentence is a little weird

chriseth · 2018-06-07T09:58:18Z

docs/solidity-by-example.rst

+    web3.personal.sign(hash, web3.eth.defaultAccount, function () {...});
+
+
+Remind that the prefix includes the length of the message.


Which prefix? Also: "Note that..."?

chriseth · 2018-06-07T09:59:15Z

docs/solidity-by-example.rst

+
+    1. The recipient's address
+    2. The amount to be transferred
+    3. An additional data to protects agains replay attacks


typo: to protects - agains

chriseth · 2018-06-07T09:59:54Z

docs/solidity-by-example.rst

+    2. The amount to be transferred
+    3. An additional data to protects agains replay attacks
+
+To avoid replay attacks we'll use the same as in Ethereum transactions


Did this documentation already explain what a replay attack is at some point?

chriseth · 2018-06-07T10:00:32Z

docs/solidity-by-example.rst

+    3. An additional data to protects agains replay attacks
+
+To avoid replay attacks we'll use the same as in Ethereum transactions
+themselves, a nonce. And our smart contract will check if that nonce is reused.


I think you should explain the term "nonce".

aj07 · 2018-06-11T08:33:07Z

docs/solidity-by-example.rst

+
+::
+
+    pragma solidity ^0.4.20;


IMO, it would be great if we make it for latest compiler.

Updating the code right now!

jvmaia · 2018-06-19T05:42:04Z

Any update?

vs77bb · 2018-06-25T06:30:30Z

Hi @chriseth mind providing an update here? Hope you're doing well 🙂

axic · 2018-06-25T11:19:27Z

docs/solidity-by-example.rst

+            bytes32 s;
+            uint8 v;
+
+            assembly {


I wouldn't mind an explanation here this code is from https://gist.github.com/axic/5b33912c6f61ae6fd96d6c4a47afde6d, but in a real implementation a more tested library should be used, such as openzepplin's fork of this code: https://github.com/OpenZeppelin/openzeppelin-solidity/blob/master/contracts/ECRecovery.sol

Sorry, I will put the explanation and original/fork links.

I don't know if I can use the library inside this docs section, then I put a note below the contract.

chriseth · 2018-07-10T13:34:30Z

Not sure what went wrong here. Tests are fine locally, so I will force-merge.

axic · 2018-07-11T23:15:39Z

This should have been squashed piror to merging 😉

axic · 2018-07-11T23:16:35Z

docs/solidity-by-example.rst

+``claimPayment`` function.
+
+
+The full contract


"complete contract"

axic · 2018-07-11T23:17:39Z

docs/solidity-by-example.rst

+    function isValidSignature(contractAddress, amount, signature, expectedSigner) {
+        var message = prefixed(constructPaymentMessage(contractAddress, amount));
+        var signer = recoverSigner(message, signature);
+        return signer.toLowerCase() ==


I think this should be === as part of latest JS standards, but in this case it sohuldn't matter too much.

micropayment channel example with two chapters

70345d7

split long lines

61454f5

fix code syntax

1dca223

write the full contracts

d1aa9b0

VoR0220 reviewed Jun 3, 2018

View reviewed changes

jvmaia added 4 commits June 3, 2018 13:20

fix a word

e89d635

fix clainTimeout() function

6bd8242

fix returns

94381c6

fix recoverSigner function

1db78a1

gitcoinbot mentioned this pull request Jun 4, 2018

Payment channel tutorial #4131

Closed

chriseth suggested changes Jun 7, 2018

View reviewed changes

update micropayment channel example

48e6bb5

aj07 reviewed Jun 11, 2018

View reviewed changes

update code version

6ec61e2

axic reviewed Jun 25, 2018

View reviewed changes

jvmaia and others added 2 commits June 25, 2018 19:06

add explanation about the splitSignature function

7ffdad4

Some copy-editing.

15283e8

chriseth merged commit 4547b32 into ethereum:develop Jul 10, 2018

axic reviewed Jul 11, 2018

View reviewed changes

docs/solidity-by-example.rst

``claimPayment`` function.

The full contract

Copy link

Member

axic Jul 11, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"complete contract"

axic reviewed Jul 11, 2018

View reviewed changes

ChrisChinchilla mentioned this pull request Jul 18, 2018

Micropayment channel example polish #4523

Merged

axic mentioned this pull request Jul 24, 2018

[WIP] Payment channel example. #2431

Closed

axic mentioned this pull request Jul 24, 2018

Add Micropayment channel #3063

Closed

		web3.personal.sign(hash, web3.eth.defaultAccount, function () {...});


		Remind that the prefix includes the length of the message.

micropayment channel example with two chapters #4212

micropayment channel example with two chapters #4212

Uh oh!

Conversation

jvmaia commented May 31, 2018

Uh oh!

chriseth commented May 31, 2018

Uh oh!

jvmaia commented May 31, 2018

Uh oh!

jvmaia commented Jun 3, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jvmaia commented Jun 6, 2018

Uh oh!

chriseth left a comment

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!

jvmaia commented Jun 19, 2018

Uh oh!

vs77bb commented Jun 25, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jvmaia Jun 25, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chriseth commented Jul 10, 2018

Uh oh!

axic commented Jul 11, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jvmaia Jun 25, 2018 •

edited

Loading