Readme file for IELE examples and misspelling fixes. (#48)

Author: virgil-serbanuta

iele-examples/README.md

@@ -0,0 +1,44 @@
+# Iele examples
+
+## Structure
+
+* **erc20.iele**: Implements the ERC-20 token standard.
+* **forwarder.iele**: Implements a forwarder that forwards any funds sent to
+  the account it is deployed with to the account that created it.
+* **forwardingWallet-copycreate.iele**: Showcases the dynamic contract creation
+  feature of IELE. Implements a wallet that can serve deposit and withdrawal
+  requests as well as setup new accounts that forward funds sent to them to
+  this wallet.
+* **forwardingWallet.iele**: Showcases the dynamic contract creation
+  feature of IELE. Implements a forwarder that forwards any funds sent to
+  its account to the account that created it.
+* **simpleOpenAuction.iele**: Implements a simple open auction.
+
+## Running the tests
+
+To run all the tests, one can always do
+```sh
+make test
+```
+
+However, to run only the tests involving the examples above, run
+
+```sh
+make
+
+#  erc20.iele
+for f in `ls tests/iele/ERC20`; do echo $f; ./blockchaintest tests/iele/ERC20/$f || break; done
+
+# forwarder.iele and forwardingWallet-copycreate.iele
+./blockchaintest tests/iele/forwarder/copycreate.iele.json
+
+# forwarder.iele and forwardingWallet.iele
+./blockchaintest tests/iele/forwarder/create.iele.json
+
+# simpleOpenAuction.iele
+for f in `ls tests/iele/auction`; do echo $f; ./blockchaintest tests/iele/auction/$f || break; done
+```
+
+## Correctness proofs
+
+Will be available soon.

iele-examples/erc20.iele

@@ -13,7 +13,7 @@ contract ERC20 {
   // The account storage is divided into two regions:
   // - the balance region maps each account address to its balance
   // - the allowance region maps each pair of owner and spender accounts to the
-  //   allownce that the owner approves to be transferred by the spender
+  //   allowance that the owner approves to be transferred by the spender
   // Account storage keys that correspond to each of the regions use different
   // bit prefixes as follows
   @balanceRegion = 1
@@ -65,7 +65,7 @@ define @log.Approval(%owner, %spender, %allowance) {
   store %allowance, %logCell
 
   // log an approval event, where the owner approves the allowance value to be
-  // transfered by the spender
+  // transferred by the spender
   log %logCell, @approvalEvent, %owner, %spender
   ret void
 }

iele-examples/forwarder.iele

@@ -1,7 +1,7 @@
 // Copyright (c) 2017 Runtime Verification, Inc. All Rights Reserved.
 //
 // This contract implements a forwarder that forwards any funds sent to
-// the account it is deployed with to the acoount that created it.
+// the account it is deployed with to the account that created it.
 contract Forwarder {
 
   // initializes a forwarder by storing in the account storage the account

iele-examples/forwardingWallet-copycreate.iele

@@ -1,8 +1,8 @@
 // Copyright (c) 2017 Runtime Verification, Inc. All Rights Reserved.
 //
 // This example showcases the dynamic contract creation feature of IELE. The
-// Wallet contract can dynamically create acounts and deploy a full copy of a
-// contract already deployed in an exisiting account. The deployed code is not
+// Wallet contract can dynamically create accounts and deploy a full copy of a
+// contract already deployed in an existing account. The deployed code is not
 // statically known but it is not dynamically generated either.
 
 // This contract implements a wallet that can serve deposit and withdrawal
@@ -20,8 +20,8 @@ contract Wallet {
     sstore %owner, 0
     sstore %forwarder, 1
   }
- 
-  // deposits the sent value to the wallet account's balance 
+
+  // deposits the sent value to the wallet account's balance
   define public @deposit() {}
 
   // withdraws amount equal to %value from the wallet and sends it to the

iele-examples/forwardingWallet.iele

@@ -1,11 +1,11 @@
 // Copyright (c) 2017 Runtime Verification, Inc. All Rights Reserved.
 //
 // This examples showcases the dynamic contract creation feature of IELE. The
-// Wallet contract can dynamically create acounts with the Forwarder contract
+// Wallet contract can dynamically create accounts with the Forwarder contract
 // deployed, since the code for the Forwarder contract is statically available.
 
 // This contract implements a forwarder that forwards any funds sent to
-// the account it is deployed with to the acoount that created it.
+// the account it is deployed with to the account that created it.
 contract Forwarder {
 
   // initializes a forwarded by storing in the account storage the account
@@ -16,7 +16,7 @@ contract Forwarder {
     sstore %parent, 0
   }
 
-  // deposit forwards the recieved funds to the creator of this account
+  // deposit forwards the received funds to the creator of this account
   define public @deposit() {
     // get the received funds
     %value = call @iele.callvalue()

iele-examples/simpleOpenAuction.iele

@@ -27,7 +27,7 @@ contract SimpleOpenAuction {
   @highest.bid    = 4
 
   // set to 1 after the auction has been settled (the auction end time has passed and
-  // the benficiary has received the final highest bid, set to 0 otherwise
+  // the beneficiary has received the final highest bid, set to 0 otherwise
   @settled        = 5
 
 // initializes an auction with the given beneficiary and bidding time duration