alchemyplatform / alchemyplatform/aa-sdk

docs: Incorrect param format for signTypedData

Open
#916 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
TypeScript
Stars
321
Forks
231
Avg merge
43m
Merged PRs (30d)
3

Description

Is this a request for new documentation or updates to existing documentation
the documentation has a small mistake, the input is supposed to look like this:
smartAccountClient.signTypedData({
typedData: {
domain: {...

If existing documentation, a clear summary of what needs to be changed
A clear and concise description of what documentation should be changed, and a link to the resource that needs the update.

If new documentation, a clear summary of what needs to be added
A clear and concise description of what documentation should be added.

Additional context
Add any other context or screenshots about the feature request here.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the linked signTypedData documentation page and inspect its input example. Update the example to show the typedData wrapper around the domain and remaining signTypedData fields, then verify that the rendered documentation matches the reported format.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.