Skip to content

docs(evm): fix config examples and api ref#74

Open
ihsraham wants to merge 2 commits intotetherto:developfrom
ihsraham:fix/evm-wallet-audit
Open

docs(evm): fix config examples and api ref#74
ihsraham wants to merge 2 commits intotetherto:developfrom
ihsraham:fix/evm-wallet-audit

Conversation

@ihsraham
Copy link
Contributor

This PR addresses inaccuracies in the EVM Wallet documentation identified during verification.

Changes

  • configuration.md: Replaced the incorrect JsonRpcProvider (Ethers v6) example with a working viem createPublicClient example. The previous example caused runtime errors due to missing EIP-1193 compliance.
  • api-reference.md: Removed the "Fee Rate Constants" section (FEE_RATE_NORMAL_MULTIPLIER, FEE_RATE_FAST_MULTIPLIER). These are protected static properties and are not exposed in the public API.
  • usage.md: Included user-provided edits to align with the latest findings.

Related Task

Asana Task: EVM Standard Audit

Verification

  • Verified that the new viem configuration example matches the library's usage patterns.
  • Confirmed that the removed constants are indeed internal.

- Replace incorrect Ethers.js provider example with Viem in configuration.md
- Remove internal fees constants from api-reference.md
- Update usage.md (user edits)

Task: https://app.asana.com/1/45238840754660/project/1210603136530746/task/1212799451446492
console.log('Seed phrase:', seedPhrase)

{% hint style="danger" %}
**Secure the Seed Phrase:** You must securely store this seed phrase immediately. If it is lost, the user will permanently lose access to their funds.

Choose a reason for hiding this comment

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

Suggested change
**Secure the Seed Phrase:** You must securely store this seed phrase immediately. If it is lost, the user will permanently lose access to their funds.
**Secure the Seed Phrase:** You must securely store this seed phrase immediately. If you lose it, you will be unable to unlock the wallet and access its funds.

Active voice when possible.

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