A few fixes and two rewrites for clarity. #76

roschler · 2018-05-27T00:25:28Z

No description provided.

The tutorial did not instruct the user on how to add a section to their Truffle configuration file that describes the Ganache network. This version has those instructions. Also instead of using "local" for the deployment command, this version uses "development" as the network mnemonic since that is the default label used in Truffle's documentation on the Truffle configuration file.

Completed document wide replacement of the "local" network designation with "development".

The original document used lowercase "basil" in the "zos init" command. This led to the generated "zos.json" having a lowercase "basil" for the "name" field, which didn't match the tutorial.

fiiiu

@roschler Many thanks for the fixes! Please see the suggested changes :)

fiiiu · 2018-06-06T14:20:13Z

docs/docs/basil.md

@@ -91,7 +91,7 @@ Now, to get the niceties that ZeppelinOS provides, let's install the `zos` comma

 ```sh
 npm install zos
-zos init basil 0.0.1
+zos init Basil 0.0.1


We are using all lowercase for app names, please see https://docs.zeppelinos.org/docs/setup.html where my-app is used.

Done, see latest commit.

fiiiu · 2018-06-06T14:22:35Z

docs/docs/basil.md

@@ -128,16 +128,32 @@ Let's start a local ethereum network:
 ganache-cli --deterministic
 ```

-This will print 10 accounts. Copy the address of the first one, and then back into the initial terminal, export it as the `OWNER` because it will be useful for us later:
+This will print 10 accounts. Copy the address of the first one and then go back to the terminal window that you used to launch the Ganache client.  Export the address you just copied to an environment variable named `OWNER`.  You will need easy access to that address as you complete this tutorial:


This phrase could indeed be improved, but please note that the "going back" is not to the terminal running the Ganache client, but the other, where the initial commands were run, and is at this point free to run the next steps.

Agreed. Changed text to tell the user to go back to the terminal window that they used to create the Basil project.

fiiiu · 2018-06-06T14:25:51Z

docs/docs/basil.md

+
+If you don't, use your favorite editor to add an entry to the `networks` section like the one shown above.  If your `truffle.js` file is empty except for a couple of comment lines, just replace the entire contents of that file with that shown above.  Now Truffle knows where to find the Ganache client.
+
+Next, we deploy our app to Ganache:


This should actually be covered by the zos init command, which generates a suitable truffle config file. We would like to keep these details hidden from the users where possible, so as to avoid cluttering the guides with non-zos content.

Removed that section. zos init generates a truffle-config.js file with the port set at 9545 for Ganache in the networks section.

fiiiu · 2018-06-06T14:26:23Z

docs/docs/basil.md


 ```sh
-zos push --from $OWNER --network local
+zos push --from $OWNER --network development


The truffle config file generated by zos init uses local for the network name.

Changed all instance of development back to `local.

fiiiu · 2018-06-06T14:26:36Z

docs/docs/basil.md

@@ -146,15 +162,15 @@ of your project in that specific network, including contract logic and instance

 ## Contract logic and upgradeable instances

-Notice how the file `zos.local.json` lists a series of "contracts" and "proxies". The first are the logic contracts for a specific contract name, while the second are the actual contract instances that our users will interact with in the blockchain. 
+Notice how the file `zos.development.json` lists a series of "contracts" and "proxies". The first are the logic contracts for a specific contract name, while the second are the actual contract instances that our users will interact with in the blockchain. 


Changed all instances of development back to local.

fiiiu · 2018-06-06T14:26:50Z

docs/docs/basil.md


 ```sh
-zos create Basil --from $OWNER --network local --init --args $OWNER
+zos create Basil --from $OWNER --network development --init --args $OWNER


See above, and several instances following.

Changed all instances of development back to local.

fiiiu · 2018-06-06T14:29:30Z

docs/docs/basil.md

 ```

-Notice the `--deploy-stdlib` option we've used. What this does is inject a version of the standard lib in our development network. Since we're working on a local blockchain, ZeppelinOS's contracts don't exist. This handy option solves that problem for us quite conveniently ^^
+Notice the `--deploy-stdlib` option we've used. What this does is inject a version of the standard lib into our development network. Since we're working on a local blockchain, the smart contracts that make up the ZeppelinOS library don't exist there. This handy option solves that problem for us quite nicely.



I like most changes here but why "conveniently" -> "nicely"?

Also, the "^^" is supposed to be an emoticon :)

Note: This is an interim commit. I have asked a Solidity professional to go through the tutorial on a fresh machine. Once I get their review of this new revision I will do a final commit of this document. Included in this version: - The tutorial is now completely stand-alone including setup and installation of: `truffle`, `ganache-cli`, the necessary auxiliary packages, and the contents of the initial `truffle.js` file. The user does not have to have anything but a working Linux station with the usual tools. - It fixes the most significant problem with the tutorial. The original version told the user immediately after the `zos push` command to assign the output address of that to the BASIL_ADDRESS environment variable. These instructions should have been after the tutorial asks the user to do the `zos create` command since that command outputs the the Basil proxy address. The `zos push` command outputs the `app` package address. This resulted in the the `setToken()` call to fail at the end of the tutorial with a `revert` exception. - Numerous enhancements of various sections of the tutorial to include additional explanations and file snapshots. - Many rewrites of the some of the text to improve clarity and specificity. - Renamed the BASIL_ADDRESS and TOKEN_ADDRESS environment variables to BASIL_PROXY_ADDRESS and TOKEN_PROXY_ADDRESS since that is what they actually contain.

Added a small note that tells the user that the addresses found in this tutorial document are only samples and will not match what they see on their system monitor as the execute the commands in this tutorial.

Closed off a backward quoted text element that was missing.

Replaced the hard coded address in one of the address export statements with a substitution label. Enhanced and cleaned up the text involving the exporting of the mintable token and the `setToken()` command.

Removed the section on creating a truffle.js file since `zos init` creates one.

roschler added 4 commits May 26, 2018 20:22

A few fixes and two rewrites for clarity.

c774225

Finished replacement of "local" with "development"

7328db3

Completed document wide replacement of the "local" network designation with "development".

Uppercased Basil in zos init command

ac35f32

The original document used lowercase "basil" in the "zos init" command. This led to the generated "zos.json" having a lowercase "basil" for the "name" field, which didn't match the tutorial.

fiiiu reviewed Jun 6, 2018

View reviewed changes

roschler and others added 7 commits June 13, 2018 22:10

Added not about sample addresses.

52da54b

Added a small note that tells the user that the addresses found in this tutorial document are only samples and will not match what they see on their system monitor as the execute the commands in this tutorial.

Fixed missing backward quote

c02ccbc

Closed off a backward quoted text element that was missing.

Several minor improvements

0e56791

Replaced the hard coded address in one of the address export statements with a substitution label. Enhanced and cleaned up the text involving the exporting of the mintable token and the `setToken()` command.

Removed unnecessary repetition of "token".

d4ae3b5

Removed truffle.js section

f188c02

Removed the section on creating a truffle.js file since `zos init` creates one.

Push being done solely to update pull request history.

85dc65d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

A few fixes and two rewrites for clarity. #76

A few fixes and two rewrites for clarity. #76

roschler commented May 27, 2018

fiiiu left a comment •

edited

Loading

fiiiu Jun 6, 2018

roschler Jun 15, 2018

fiiiu Jun 6, 2018

roschler Jun 15, 2018

fiiiu Jun 6, 2018

roschler Jun 15, 2018

fiiiu Jun 6, 2018

roschler Jun 15, 2018

fiiiu Jun 6, 2018

roschler Jun 15, 2018

fiiiu Jun 6, 2018

roschler Jun 15, 2018

fiiiu Jun 6, 2018


		If you don't, use your favorite editor to add an entry to the `networks` section like the one shown above. If your `truffle.js` file is empty except for a couple of comment lines, just replace the entire contents of that file with that shown above. Now Truffle knows where to find the Ganache client.

		Next, we deploy our app to Ganache:

A few fixes and two rewrites for clarity. #76

Are you sure you want to change the base?

A few fixes and two rewrites for clarity. #76

Conversation

roschler commented May 27, 2018

fiiiu left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fiiiu left a comment •

edited

Loading