Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to use Frame #148

Merged
merged 14 commits into from May 17, 2019

Conversation

3 participants
@0xGabi
Copy link
Member

commented May 13, 2019

closes #106

0xGabi added some commits May 11, 2019

@0xGabi 0xGabi requested review from sohkai and 0x6431346e May 13, 2019

0xGabi added some commits May 13, 2019

@sohkai

sohkai approved these changes May 13, 2019

Copy link
Member

left a comment

Have a number of small English suggestions, but this is really great 😍 .

For potential next steps, I'd definitely suggest depositing both ETH and tokens through an organization's Finance app from the client, as well as voting, as those are some of the most common actions :).

Show resolved Hide resolved docs/guides-use-frame.md Outdated
Show resolved Hide resolved docs/guides-use-frame.md Outdated
Show resolved Hide resolved docs/guides-use-frame.md Outdated
Show resolved Hide resolved docs/guides-use-frame.md Outdated
Show resolved Hide resolved docs/guides-use-frame.md Outdated
Show resolved Hide resolved docs/guides-use-frame.md Outdated
Show resolved Hide resolved docs/guides-use-frame.md Outdated
Show resolved Hide resolved docs/guides-use-frame.md Outdated
Show resolved Hide resolved docs/guides-use-frame.md Outdated
Show resolved Hide resolved docs/guides-use-frame.md Outdated
@hackingclimate

This comment has been minimized.

Copy link
Contributor

commented May 13, 2019

@0xGabi Awesome. I like the structure :)

A couple of thoughts:

Since we're linking to this in the Getting Started page, for the 'Signing your first transaction' section, I think it would be great to have a subsection that takes you through incrementing the Counter in the first-dao app. Perhaps with a browser extension, to contrast with your example which shows how to sign directly with Frame.

What do you think?

Apply suggestions from code review
Co-Authored-By: Brett Sun <qisheng.brett.sun@gmail.com>
@0xGabi

This comment has been minimized.

Copy link
Member Author

commented May 13, 2019

Thanks @sohkai and @hackingclimate for reviewing.

What do you think?

I think your suggestion make sense but I'm not 100% convinced of the place where this section should be.

Note: I was not able to use the Frame browser extension.

@sohkai

This comment has been minimized.

Copy link
Member

commented May 13, 2019

You shouldn't need to use Frame's browser extension when using the Aragon client (and if you do, make sure to disable metamask :)).

@hackingclimate
Copy link
Contributor

left a comment

Minor suggestions ❤️

npm install -g @aragon/cli
```

> You need a Ledger or Trezor wallet to use Frame. Hot wallet support will be added soon!

This comment has been minimized.

Copy link
@hackingclimate

hackingclimate May 13, 2019

Contributor

I would put this right at the top, under setup. Just so the reader doesn't waste any time.

```sh
npm install -g @aragon/cli
```

This comment has been minimized.

Copy link
@hackingclimate

hackingclimate May 13, 2019

Contributor

Would be useful to link to the troubleshooting section here, in case the reader has any issues.

<img width="240" height="500" src="/docs/assets/frame/frame-accounts.gif">
</p>

In the configuration menu you can also manage the dapp permisions you have granted for that particular account. More about this will be explained in the next section.

This comment has been minimized.

Copy link
@hackingclimate

hackingclimate May 13, 2019

Contributor

Would replace: "More about this will be explained in the next section."
with: "We'll explain more about this in the next section."

✖ Returned error: Permission denied, approve AragonCLI in Frame to continue
```

No worry, we just need to grant `aragonCLI` permission to access your account on Frame. You may have already seen Frame asking for this earlier when we were setting it up. Approve the request to continue.

This comment has been minimized.

Copy link
@hackingclimate

hackingclimate May 13, 2019

Contributor

Would replace "No worry", with "Don't worry"

And: "You may have already seen Frame asking for this earlier when we were setting it up."
with: "You may have seen Frame ask or this earlier on setup."


#### Signing

Now run the command again. This time, Frame will ask you to sign the transaction that `aragonCLI` generated and finally confirm it from your hardware device. A couple of seconds later, the transaction should be mined.

This comment has been minimized.

Copy link
@hackingclimate

hackingclimate May 13, 2019

Contributor

Would replace: "Frame will ask you to sign the transaction that aragonCLI generated and finally confirm it from your hardware device. A couple of seconds later, the transaction should be mined."

with: "Frame will ask you to sign the transaction that aragonCLI generated. Sign and then confirm it from your hardware device. In a couple of seconds, the transaction should be mined."


#### Viewing transactions

By clicking on the "View details" button, Frame will open the transaction's details on Etherscan.

This comment has been minimized.

Copy link
@hackingclimate

hackingclimate May 13, 2019

Contributor

Would replace: 'By clicking on the "View details" button'
with: 'Finally, if you click on the "View details" button'

<img width="240" height="500" src="/docs/assets/frame/frame-first-tx.gif">
</p>

Congratulation 🎉! You just signed your first transaction with Frame, minting tokens from a DAO. Navigate your browser to the [live Aragon DAO's Token Manager](https://rinkeby.aragon.org/#/0x16b3C84d4DB149590981F2d3A36e14Db96069730/0x1a8d8bb7eb5ac6e6f51df5e65d301c7e5dd00d58) to see the minted `FRAME` tokens for the address you chose.

This comment has been minimized.

Copy link
@hackingclimate

hackingclimate May 13, 2019

Contributor

Suggested edit:

Congratulations 🎉! You've just signed your first transaction with Frame. Navigate to the live Aragon DAO's Token Manager to see the minted FRAME tokens for your chosen address.

@hackingclimate

This comment has been minimized.

Copy link
Contributor

commented May 13, 2019

@sohkai thanks for the tip :)

@0xGabi no problem! In that case I think we can merge without. I'll try incrementing the counter with Frame tomorrow and see what happens. If i'm able to do it, I'll document it and let you know.

@hackingclimate

This comment has been minimized.

Copy link
Contributor

commented May 14, 2019

@0xGabi @sohkai Is there a way to connect Frame to Localhost 8545?

@0xGabi

This comment has been minimized.

Copy link
Member Author

commented May 15, 2019

@hackingclimate I apology to not been able to proper review your Metamask tutorial. Will do in the next couple of days. About Frame you should be able to run a local devchain with aragon devchain and then use the same commands as in the tutorial I made but without the --environment option (will default to local development)

@0xGabi

This comment has been minimized.

Copy link
Member Author

commented May 15, 2019

I just realize you mean the port. I'm not sure about that. You should ask Jordan here: https://gitter.im/framehq/general

@hackingclimate

This comment has been minimized.

Copy link
Contributor

commented May 15, 2019

@hackingclimate I apology to not been able to proper review your Metamask tutorial. Will do in the next couple of days.

No worries! Looking forward to it :)

@hackingclimate

This comment has been minimized.

Copy link
Contributor

commented May 16, 2019

@0xGabi Got in touch with Jordan. Pasting his response below:

@hackingclimate Frame checks to make sure the network id you set in Frame matches the one you're connecting to
You can disable this if running from source but we don't have that dev mode option added to the interface yet
So you either need to tell the network you're creating to have an id currently supported by Frame (e.g. 4 for "Rinkeby") or run Frame from source and disable the check here https://github.com/floating/frame/blob/master/main/provider/index.js#L63
If you're using a hardware signer let me know as you'll need to disable it in that module as well.
Sorry the inconvenience, we're planning to add a dev mode to handle cases like this

As it currently stands, looks like we can't use Frame to interact with the Getting started page app. So ignore this suggestion -- #148 (comment)

hackingclimate added a commit to hackingclimate/hack that referenced this pull request May 16, 2019

remove introduction to frame
We can't use Frame to interact with the Getting started page app (see aragon#148 (comment)).
As a result, the user should use Metamask. To avoid confusing the user, better to introduce Frame in the tutorial page.

0xGabi added a commit that referenced this pull request May 17, 2019

Draft: Improved getting-started page (#139)
* Update getting-started.md

started work on issue #104 + empathy for web3 newbies.

* Update getting-started.md

Fix typo + edit.

* Update getting-started.md

Add Mac considerations

* Update getting-started.md

Add empathy to quick start

* Update getting-started.md

start fleshing out 'What is Aragon and what does it do'

* Update getting-started.md

add introduction

* Update getting-started.md

intro edits

* Update getting-started.md

add further reading subsection to intro

* Update getting-started.md

Flesh out 'More on DAOs' subsection

* Update getting-started.md

Edits

* Update getting-started.md

minor edits + ellipses as placeholders

* Update getting-started.md

intro edits: clarify link between Aragon Apps and DAOs

* Update getting-started.mf

intro edits

* Update getting-started.md

intro edits

* Update getting-started.md

intro edits

* Update getting-started.md

intro edit

* Update getting-started.md

start fleshing out web3 subsection

* Update getting-started.md

web3 subsection additions + edits

* Add web2 vs web3 stack image via upload

For getting-started.md

* Add another web2 vs web3 stack image via upload

for getting-started.md

* Update getting-started.md

web3 subsection: add web2 vs web3 stack image + edits

* Update getting-started.md

environment setup edits. start fleshing out web3 provider text

* Update getting-started.md

Metamask subsection: quote update

* Update getting-started.md

Up and running: lots of little edits

* Update getting-started.md

add placeholders for tomorrow

* Update getting-started.md

Metamask subsection: add instructions modulo images

* Add images for getting-started.md via upload

metamask subsection images

* Update getting-started.md

Metamask subsection: add images + edits

* Update getting-started.md

Interacting with your first DAO subsection: add instructions

* Update getting-started.md

intro edits

* Update getting-started.md

web3 provider subsection edits

* Update getting-started.md

metamask subsection edits

* Update getting-started.md

aragonCLI subsection edits

* Update getting-started.md

Quick start section edits

* Update getting-started.md

style edit: replace uppercase words with bold + capitalized

* Update getting-started.md

minor edits

* Add image for getting-started.md

For 'Interacting with your first DAO' subsection

* Add image for getting-started.md

For 'Interacting with your first DAO' subsection

* Add image for getting-started.md 

For 'Interacting with your first DAO' subsection

* Update getting-started.md

Add images to 'Interacting with your first DAO' subsection + minor edits

* Update getting-started.md

kill my darlings + minor edits

* Update getting-started.md

minor edit

* Update docs/getting-started.md

fix grammar

Co-Authored-By: hackingclimate <sacha.saint-leger@mail.mcgill.ca>

* Update docs/getting-started.md

style change - avoid repetition

Co-Authored-By: hackingclimate <sacha.saint-leger@mail.mcgill.ca>

* Update docs/getting-started.md

fix typo

Co-Authored-By: hackingclimate <sacha.saint-leger@mail.mcgill.ca>

* Update docs/getting-started.md

fix typo

Co-Authored-By: hackingclimate <sacha.saint-leger@mail.mcgill.ca>

* Update docs/getting-started.md

style change

Co-Authored-By: hackingclimate <sacha.saint-leger@mail.mcgill.ca>

* Update getting-started.md

npx: add Gabi's suggested link + minor edit

* Update getting-started.md

mention Edit button + typo fix

* Update docs/getting-started.md

minor edit

* Update getting-started.md

Interacting with your first DAO subsection: replace first image with code snippet

* Update getting-started.md

change DAO name from foo to first_dao

* Update getting-started.md

remove aragonCLI installation troubleshooting subsections. link to troubleshooting guide instead

* Update guides-faq.md

add installing aragonCLI section

* Update getting-started.md

web3 provider subsection edits + remove metamask images/tutorial: will create and link to more complete guide instead.

* Update getting-started.md

Metamask subsection edit

* Update getting-started.md

Explain scaffolding + minor edits

* Update getting-started.md

Quick start section edits

* Update getting-started.md

Quick start edits

* Update getting-started.md

remove some comments, remaining comments now in bold

* Update getting-started.md

style edit

* Update getting-started.md

style edit

* Update guides-faq.md

Git subsection edits

* Update getting-started.md

comments now italic

* Update getting-started.md

add contributing section + feedback link + minor edits

* Include linux considerations for node LTS

* Update getting-started.md

update required node version.

* Explain why we prefer Frame to MetaMask

* Make clear that Aragon is more than just apps

* Broke up long paragraphs

* Make quick start section clearer

* Minor edit

* App name: replace first_dao with first-dao

Fix error: cannot generate application artifact:   Illegal char _

(The name of an App can't have an underscore)

* Add Frame guide link

* Create guides-use-metamask.md

* fill in guides-use-metamask.md modulo images

* Add metamask-guide images

* Update guides-use-metamask.md

minor edits

* Add metamask guide link

* Add further resources

* Add link to signing with metamask guide

* Add images for github guide

* Add github guide

* move github guide to docs folder

* replace link to github blog post with md file

* replace contributing tutorial with github guide

* remove introduction to frame 

We can't use Frame to interact with the Getting started page app (see #148 (comment)).
As a result, the user should use Metamask. To avoid confusing the user, better to introduce Frame in the tutorial page.

* Docs: Small fixes and comment court section

* Docs: Update metamask and update image to better display & small fixes

* Docs: Update github-guide

@0xGabi 0xGabi force-pushed the 0xGabi:docs/how-use-frame branch 2 times, most recently from 6ee82f3 to 8c7c244 May 17, 2019

0xGabi added some commits May 17, 2019

@0xGabi 0xGabi merged commit c3bb389 into aragon:master May 17, 2019

1 check passed

license/cla Contributor License Agreement is signed.
Details

@0xGabi 0xGabi added this to In progress in Aragon Mesh Team via automation May 17, 2019

@0xGabi 0xGabi moved this from In progress to Done in Aragon Mesh Team May 17, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.