alchemyplatform / alchemyplatform/aa-sdk
docs: Update AlchemyProvider @alchemy/aa-alchemy README
Nobody has claimed this yet.
- 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
Existing Documentation
If existing documentation, a clear summary of what needs to be changed
This README.md documents the creation of an AlchemySmartAccountClient by calling importing and calling the new AlchemyProvider function.
This no longer exists, erroring
Module '"@alchemy/aa-alchemy"' has no exported member 'AlchemyProvider'. on line import { AlchemyProvider } from "@alchemy/aa-alchemy";.
If new documentation, a clear summary of what needs to be added
Document a new example with the newly intended setup code and make it clear what the alternative to AlchemyProvider is.
Additional context
It would also be worth mentioning in the breaking changes post here
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with packages/alchemy/README.md and verify the documented AlchemyProvider import against the package's current exports and setup. Replace the obsolete example with the intended setup, explain the alternative to AlchemyProvider, and update the breaking-changes post at the linked Alchemy blog page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100