Skip to content

Docs review update #8

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

Open
wants to merge 30 commits into
base: main
Choose a base branch
from
Open

Docs review update #8

wants to merge 30 commits into from

Conversation

Cordtus
Copy link

@Cordtus Cordtus commented Jun 29, 2025

This PR is intended to update these docs to be able to share publicly. Updates largely to the chain integrations doc.

  • Integration Guide: Fixed chain ID documentation, updated account configuration to
    eth_secp256k1/cointype 60, added IBC middleware docs, and included Hermes relayer setup
  • API Documentation: Added comprehensive CLI docs, updated EVM RPC methods list based on
    current codebase
  • UI/UX Improvements: Consolidated integration docs, removed redundant Getting Started page,
    cleaned up formatting
  • Technical Updates: Replaced all Tendermint references with CometBFT, added notes about sign
    mode textual and blocked addresses
  • Landing Page: Added marketing content highlighting key features and benefits
  • Footer: Added contact form link and reorganized links

Cordtus and others added 23 commits June 28, 2025 22:17
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
- Add contact form link to footer
- Remove contribute card from landing page
- Add marketing content and key features section
- Update GitHub link to point to cosmos/evm repo

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Copy link

netlify bot commented Jun 29, 2025

Deploy Preview for evm-docs ready!

Name Link
🔨 Latest commit e1fedf0
🔍 Latest deploy log https://app.netlify.com/projects/evm-docs/deploys/68668d02e3aa790008d59b5b
😎 Deploy Preview https://deploy-preview-8--evm-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@Cordtus Cordtus requested a review from vladjdk July 2, 2025 14:07
- `--json-rpc.enable`: Enable the JSON-RPC server
- `--json-rpc.address`: JSON-RPC server address (default: `0.0.0.0:8545`)
- `--json-rpc.ws-address`: JSON-RPC WebSocket server address (default: `0.0.0.0:8546`)
- `--json-rpc.api`: API namespaces to enable (e.g., `eth,web3,net,txpool,debug`)
Copy link

Choose a reason for hiding this comment

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

I would like us to add a callout somewhere that folks should only expose the debug endpoint in non production settings as this has performance and uptime impacts if it is public

all (if not most) of the transactions will be committed to the next block (avg. block time on Cosmos chains is ~8s).
However, this causes a
few hiccups in terms of the Ethereum Web3-compatible queries that can be made to pending state.

Another significant difference with Ethereum, is that blocks are produced by validators or block producers, who include
transactions from their local mempool into blocks in a
first-in-first-out (FIFO) fashion. Transactions on the Cosmos EVM cannot be ordered or cherry picked out from the
Tendermint node [mempool](https://docs.tendermint.com/v0.34/tendermint-core/mempool.html).
CometBFT node [mempool](https://docs.tendermint.com/v0.34/tendermint-core/mempool.html).
Copy link

Choose a reason for hiding this comment

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

Lets link to the cometbft docs in all cases as well

Copy link

Choose a reason for hiding this comment

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

There are multiple non-comet docs links

Comment on lines 102 to 104
```sh
min(baseFee + gasTipCap, gasFeeCap)
```
Copy link

Choose a reason for hiding this comment

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

these aren't in shell scripting so idk if we should add this annotation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants