Skip to content
This repository has been archived by the owner on Apr 4, 2024. It is now read-only.

Add Ethereum Tooling Guides #474

Merged
merged 8 commits into from
Aug 24, 2021
Merged

Conversation

jolube
Copy link
Contributor

@jolube jolube commented Aug 23, 2021

Closes: #XXX

Description

This PR improves on existing Ethereum tooling guides (Truffle, Remix) in addition to adding new ones (Hardhat, Metamask). The guides now also target testnet configs.


For contributor use:

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer

For admin use:

  • Added appropriate labels to PR (ex. WIP, R4R, docs, etc)
  • Reviewers assigned
  • Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)

Copy link
Contributor

@fedekunze fedekunze 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! Love the tabs too. Left a few questions too (specially around the 2 metamask guides)

I'd suggest you download the markdownlint plug-in (if you are using VS Code): https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint

@@ -13,7 +13,9 @@ parent:
* [Keyring](./keys-wallets/keyring)
* [Metamask](./keys-wallets/metamask)
Copy link
Contributor

Choose a reason for hiding this comment

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

should we remove this one?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Kept this one and merged the other into it

docs/guides/tools/hardhat.md Outdated Show resolved Hide resolved
order: 1
-->

# MetaMask: Connecting to Ethermint
Copy link
Contributor

Choose a reason for hiding this comment

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

how does this guide relate to the one on guides/keys-wallets/?

Copy link
Contributor

Choose a reason for hiding this comment

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

wondering if we should merge them

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Merged


First, install the latest Truffle version on your machine globally.

```bash
yarn install truffle -g
```shell
Copy link
Contributor

Choose a reason for hiding this comment

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

curious about the use of bash vs shell? should we enforce one over the other?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually, after doing some research the answer is no. The lexers Github-flavored md uses are different than vuepress it seems.

shell is just an alias of bash for vuepress, so using bash is fine. Full list here.

docs/guides/tools/truffle.md Outdated Show resolved Hide resolved
docs/guides/tools/metamask.md Outdated Show resolved Hide resolved
docs/guides/tools/metamask.md Outdated Show resolved Hide resolved
docs/guides/tools/metamask.md Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Aug 23, 2021

Codecov Report

Merging #474 (5891482) into main (7c97831) will decrease coverage by 13.72%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##             main     #474       +/-   ##
===========================================
- Coverage   64.11%   50.38%   -13.73%     
===========================================
  Files          11       51       +40     
  Lines        1346     5005     +3659     
===========================================
+ Hits          863     2522     +1659     
- Misses        454     2373     +1919     
- Partials       29      110       +81     
Impacted Files Coverage Δ
x/evm/types/tx_data.go 74.35% <0.00%> (ø)
x/evm/client/cli/utils.go 73.07% <0.00%> (ø)
x/evm/keeper/keeper.go 70.68% <0.00%> (ø)
x/evm/keeper/state_transition.go 58.29% <0.00%> (ø)
types/block.go 0.00% <0.00%> (ø)
x/evm/types/chain_config.go 76.61% <0.00%> (ø)
x/evm/types/key.go 0.00% <0.00%> (ø)
types/hdpath.go 0.00% <0.00%> (ø)
x/evm/genesis.go 44.26% <0.00%> (ø)
types/validation.go 33.33% <0.00%> (ø)
... and 30 more

@fedekunze fedekunze added the Type: Docs Improvements or additions to documentation label Aug 24, 2021
@fedekunze fedekunze enabled auto-merge (squash) August 24, 2021 00:18
@fedekunze fedekunze merged commit 49b5ecf into evmos:main Aug 24, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Type: Docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants