8000 FAQ and FireFly Tutorial Updates by trevorsc19 · Pull Request #857 · hyperledger/firefly · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

FAQ and FireFly Tutorial Updates #857

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 10 commits into from
Jul 6, 2022
Merged

FAQ and FireFly Tutorial Updates #857

merged 10 commits into from
Jul 6, 2022

Conversation

trevorsc19
Copy link
Contributor

Two main changes in this PR:
1- FAQ updates. Added some FAQs related to deploying smart contracts, connecting to Metamask, and how FireFly enables multi-chain applications
2- FireFly tutorial updates. Fixed some links to swagger pages that were outdated, updated some instructions, added instructions and screenshots on using the FireFly sandbox in order to follow along some of the examples given in the tutorials

@nguyer nguyer self-assigned this Jun 14, 2022
nguyer
nguyer suggested changes Jun 14, 2022
View reviewed changes
Copy link
Contributor
@nguyer nguyer left a comment

Choose a reason for hiding this comment

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

Just a couple of minor spelling things. Also a couple notes on the FAQs. Up to you, how much you want to incorporate those. Otherwise looks good, thanks!

docs/faqs/faqs.md Outdated
- A deployment script (two of the most popular deployment tools are [Hardhat](https://hardhat.org/guides/deploying.html) and [Truffle](https://trufflesuite.com/docs/truffle/advanced/networks-and-app-deployment/))
- Access to a node on your network

Once your contract is deployed, you can view the contract details through popular blockchain explorers such as [Etherscan](https://etherscan.io/), which will show all transaction interactions with the contract and show any token value associated with the contract.
Copy link
Contributor

Choose a reason for hiding this comment

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

It may be worth noting that etherscan.io will only work for public Ethereum. I'm not sure if this will be confusing to someone who is totally new, and manages to deploy their contract to a locally running node.

docs/faqs/faqs.md Outdated
For additional information about Smart Contracts, please see the official [Ethereum.org documentation](https://ethereum.org/en/developers/docs/smart-contracts/)

## 🦊 Can I connect FireFly to MetaMask?
Yes! In order to do this, you'll want to set up a FireFly stack and deploy an ERC-20 or ERC-721 contract to the chain (see the FAQ above on how to deploy a smart contract).
Copy link
Contributor

Choose a reason for hiding this comment

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

A token factory that can deploy ERC-20 and ERC-721 contracts is deployed by default. After creating a token pool, they could use the contract that is automatically deployed, rather than needing to figure out how to deploy one on their own.

@nguyer
Copy link
Contributor
nguyer commented Jun 14, 2022

It also looks like the docs build has failed. To test this locally, you can run make docs to ensure all the checks pass.

@trevorsc19 trevorsc19 requested a review from shorsher as a code owner July 1, 2022 18:04
@trevorsc19
Copy link
Contributor Author

I've made changes based on the comments from Nicko. Running make docs fails due to some missing alt attributes and one external link issue. Fixing those now and will push again

@codecov-commenter
Copy link
codecov-commenter commented Jul 1, 2022 •
edited by codecov bot
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.96%. Comparing base (a425fde) to head (66ff429).
Report is 1948 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #857      +/-   ##
==========================================
- Coverage   99.98%   99.96%   -0.03%     
==========================================
  Files         299      302       +3     
  Lines       19457    19736     +279     
==========================================
+ Hits        19455    19730     +275     
- Misses          1        5       +4     
  Partials        1        1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

nguyer and others added 7 commits July 5, 2022 14:14
@nguyer @trevorsc19
Fix relative links in reference descriptions docs
9d25ac9 
Signed-off-by: Nicko Guyer <nicko.guyer@kaleido.io>
Signed-off-by: Trevor Scanlon <trevor.scanlon@kaleido.io>
@trevorsc19
Added new FAQ Updates
3b011de 
Signed-off-by: Trevor Scanlon <trevor.scanlon@kaleido.io>
@trevorsc19
Updates to FireFly tutorials
923e865 
Signed-off-by: Trevor Scanlon <trevor.scanlon@kaleido.io>
@trevorsc19
More updates to FAQs
7769be2 
Signed-off-by: Trevor Scanlon <trevor.scanlon@kaleido.io>
@trevorsc19
small edit in broadcast message page
3a1aa34 
Signed-off-by: Trevor Scanlon <trevor.scanlon@kaleido.io>
@trevorsc19
Changes to FAQs
d1906c2 
Signed-off-by: Trevor Scanlon <trevor.scanlon@kaleido.io>
@trevorsc19
Changes to images so that the doc builds won't fail
a92c3b3 
Signed-off-by: Trevor Scanlon <trevor.scanlon@kaleido.io>
@trevorsc19
changed name of image
52455d4 
Signed-off-by: Trevor Scanlon <trevor.scanlon@kaleido.io>
shorsher
shorsher approved these changes Jul 5, 2022
View reviewed changes
Copy link
Member
@shorsher shorsher left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Looks good to me, but I'll defer to @nguyer

nguyer
nguyer suggested changes Jul 6, 2022
View reviewed changes
Copy link
Contributor
@nguyer nguyer left a comment

Choose a reason for hiding this comment

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

There's just one section that should be removed, but otherwise looks good. Thanks!

@trevorsc19
removed vendor specific information and added one sentence to truffle…
7f808e2 
… documentation

Signed-off-by: Trevor Scanlon <trevor.scanlon@kaleido.io>
nguyer
nguyer suggested changes Jul 6, 2022
View reviewed changes
@trevorsc19
Cleaned up smart contract FAQ some more
66ff429 
Signed-off-by: Trevor Scanlon <trevor.scanlon@kaleido.io>
nguyer
nguyer approved these changes Jul 6, 2022
View reviewed changes
Copy link
Contributor
@nguyer nguyer left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks @trevorsc19

@nguyer nguyer merged commit 7975b39 into hyper 8000 ledger:main Jul 6, 2022
shorsher pushed a commit to kaleido-io/firefly that referenced this pull request Jul 7, 2022
@trevorsc19 @shorsher
FAQ and FireFly Tutorial Updates (hyperledger#857)
fc947bb
@shorsher shorsher mentioned this pull request Jul 7, 2022
Merged
shorsher pushed a commit to kaleido-io/firefly that referenced this pull request Jul 7, 2022
@trevorsc19 @shorsher
FAQ and FireFly Tutorial Updates (hyperledger#857)
38fe893 
Signed-off-by: Alex Shorsher <alex.shorsher@kaleido.io>
nguyer pushed a commit that referenced this pull request Jul 7, 2022
@shorsher @trevorsc19
FAQ and FireFly Tutorial Updates (#857) (#889)
b039fb3 
Signed-off-by: Alex Shorsher <alex.shorsher@kaleido.io>

Co-authored-by: trevorsc19 <30576577+trevorsc19@users.noreply.github.com>
@shorsher shorsher mentioned this pull request Jul 18, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nguyer nguyer nguyer approved these changes

@shorsher shorsher shorsher approved these changes

@peterbroadhurst peterbroadhurst Awaiting requested review from peterbroadhurst

@awrichar awrichar Awaiting requested review from awrichar

@nickgaski nickgaski Awaiting requested review from nickgaski

Assignees

@nguyer nguyer

Labels
backport-candidate
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@trevorsc19 @nguyer @codecov-commenter @shorsher
0