Skip to content

docs: split wallet-evm and wallet-solana usage.md into how-to guides#105

Merged
gatteo merged 5 commits intotetherto:developfrom
ihsraham:feature/wdkdocs-188-190-usage-to-how-to-guides
Mar 24, 2026
Merged

docs: split wallet-evm and wallet-solana usage.md into how-to guides#105
gatteo merged 5 commits intotetherto:developfrom
ihsraham:feature/wdkdocs-188-190-usage-to-how-to-guides

Conversation

@ihsraham
Copy link
Copy Markdown
Contributor

@ihsraham ihsraham commented Mar 9, 2026

Summary

Addresses WDKDOCS-188 (wallet-evm) and WDKDOCS-190 (wallet-solana).

  • Split the monolithic usage.md for wallet-evm and wallet-solana into 7 distinct how-to guides each, following the pattern established by the core module guides.
  • Converted both usage.md files into hub pages with card tables linking to the new guides.
  • Updated SUMMARY.md to add sidebar navigation entries for all 14 new guides.

New Guides (per module)

Guide wallet-evm wallet-solana
Getting Started Install + create wallet with RPC/EIP-1193 Install + create wallet with Solana RPC
Manage Accounts Index-based + custom derivation paths Index-based + custom derivation paths
Check Balances Native + ERC-20 (owned and read-only) SOL + SPL (owned and read-only)
Send Transactions EIP-1559, legacy gas, fee estimation Send SOL, fee estimation
Transfer Tokens ERC-20 transfers with validation SPL transfers with validation
Sign and Verify Messages Sign + verify with read-only account Ed25519 sign + verify
Error Handling Errors, fee management, memory cleanup Errors, fee management, memory cleanup

Files Changed

  • 14 new files: 7 guides in sdk/wallet-modules/wallet-evm/guides/ + 7 in sdk/wallet-modules/wallet-solana/guides/
  • 3 modified files: SUMMARY.md, wallet-evm/usage.md, wallet-solana/usage.md

Test plan

  • Verify all guide links render correctly in GitBook preview
  • Confirm sidebar navigation shows guides nested under Usage for both modules
  • Check that card tables on hub pages link to correct guide pages
  • Verify no broken links from existing pages (README, configuration, api-reference) to usage.md

…(WDKDOCS-188, WDKDOCS-190)

Split the monolithic usage.md for wallet-evm and wallet-solana into
7 distinct how-to guides each, following the pattern established
by the core module guides.
@ihsraham ihsraham changed the base branch from main to develop March 9, 2026 14:04
@ihsraham ihsraham marked this pull request as ready for review March 12, 2026 13:33
Copy link
Copy Markdown
Contributor

@lucas-tortora lucas-tortora left a comment

Choose a reason for hiding this comment

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

Very nice PR :) It's quite an improvement. I left some comments about adding a bit more text and a lot of links to API refs on the EVM guides. Please apply the same style to Solana as well

Comment thread sdk/wallet-modules/wallet-evm/guides/getting-started.md Outdated
Comment thread sdk/wallet-modules/wallet-evm/guides/manage-accounts.md
Comment thread sdk/wallet-modules/wallet-evm/guides/check-balances.md Outdated
Comment thread sdk/wallet-modules/wallet-evm/guides/check-balances.md
Comment thread sdk/wallet-modules/wallet-evm/guides/check-balances.md

## Sign a Message

Use `account.sign()` to produce a cryptographic signature for any string message.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

link to api ref

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Addressed in e63ef35


## Verify a Signature

Use a read-only account to verify that a signature was produced by the corresponding private key.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
Use a read-only account to verify that a signature was produced by the corresponding private key.
You can get a [read-only account](/sdk/wallet-modules/wallet-evm/api-reference#walletaccountreadonlyevm) from any `Account` object by calling `account.toReadOnlyAccount()`[link to api ref].
Use a read-only account to [`verify()`](sdk/wallet-modules/wallet-evm/api-reference#verify-message-signature-1) that a signature was produced by the corresponding private key.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Addressed in e63ef35

{% endcode %}

{% hint style="info" %}
You can also create a `WalletAccountReadOnlyEvm` from any public address to verify signatures without access to the private key.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

link to api ref

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Addressed in e63ef35


## Manage Fee Limits

Set `transferMaxFee` when creating the wallet to prevent transactions from exceeding a maximum gas cost. Retrieve current network rates with `getFeeRates()` to make informed decisions.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

/sdk/wallet-modules/wallet-evm/api-reference#getfeerates

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Addressed in e63ef35

{% endcode %}

{% hint style="warning" %}
Always call `dispose()` in a `finally` block or cleanup handler to ensure sensitive data is cleared even if an error occurs.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Addressed in e63ef35

Yuri-SVB and others added 4 commits March 12, 2026 22:32
sdk/wallet-modules/wallet-evm/guides/account-management.md to
sdk/wallet-modules/wallet-evm/guides/manage-accounts.md
to match the title and make it action oriented.
…agement rename

The file was renamed to manage-accounts.md (PR 108) but SUMMARY.md
still pointed to the old name.
…n EVM guides

- getting-started: link WalletManagerEvm to API ref
- check-balances: reword getBalance/getTokenBalance/getTokenBalances with
  API ref links, link WalletManagerEvm and WalletAccountReadOnlyEvm,
  split read-only section into separate subsections
- send-transactions: add API ref links for sendTransaction,
  quoteSendTransaction, getFeeRates
- transfer-tokens: add API ref links for transfer and quoteTransfer,
  reword validation section, split validation into stepped subsections
- sign-verify-messages: add API ref links for sign, verify,
  toReadOnlyAccount, WalletAccountReadOnlyEvm
- error-handling: add API ref links for getFeeRates and dispose

Addresses review comments from lucas-tortora on PR tetherto#105.
…n Solana guides

Apply the same style as the EVM guides per lucas-tortora's review:
- getting-started: link WalletManagerSolana to API ref
- account-management: link getAccount and getAccountByPath to API ref
- check-balances: reword getBalance/getTokenBalance with API ref links,
  link WalletManagerSolana and WalletAccountReadOnlySolana, split
  read-only section into separate subsections
- send-transactions: add API ref links for sendTransaction,
  quoteSendTransaction, getFeeRates
- transfer-tokens: add API ref links for transfer and quoteTransfer,
  split validation into stepped subsections
- sign-verify-messages: add API ref links for sign, verify,
  toReadOnlyAccount, WalletAccountReadOnlySolana
- error-handling: add API ref links for getFeeRates and dispose

Addresses lucas-tortora's overall review note on PR tetherto#105:
"Please apply the same style to Solana as well."
@ihsraham ihsraham mentioned this pull request Mar 16, 2026
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.

4 participants