docs: updating client page and adding to auth section #2078
Conversation
avarobinson
requested review from
dancoombs,
dphilipson,
linnall,
adamegyed,
Zer0dot,
noam-alchemy,
jakehobbs,
florrdv,
blakecduncan,
Shenghu-Yang,
andysim3d,
0xfourzerofour,
niveda-krish,
alex-miao,
thebrianchen,
joshzhang5,
AlvaroLuken,
Dan-Nolan,
SahilAujla and
Richard-Dang
as code owners
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🌿 Documentation Preview
|
| transport: alchemy({ apiKey: "your-alchemy-api-key"}), | ||
| chain: sepolia, | ||
| signer: LocalAccountSigner.privateKeyToAccountSigner( | ||
| "0x-your-wallet-private-key", | ||
| ), | ||
| policyId: "your-policy-id", | ||
| }; |
There was a problem hiding this comment.
Missing indentation here, looks funny in the preview.
| import React from "react"; | ||
| import { useSmartAccountClient } from "@account-kit/react"; | ||
|
|
||
| const { client } = useSmartAccountClient({}); |
There was a problem hiding this comment.
We don't want this to be the "client" that the end-user is using, we want it to either be wrapped in a specific action like the useSendCalls hook, or wrapped in the useSmartWalletClient hook. If we end the guide here, they will likely assune this client is what they should use, and try to call .sendUserOperation or similar.
There was a problem hiding this comment.
Hmm okay. Then what would you suggest we use as the example for react and react native? No client example?
I don't rlly know what the recommendation is for this case i guess
| import React from "react"; | ||
| import { useSmartAccountClient } from "@account-kit/react"; | ||
|
|
||
| const { client } = useSmartAccountClient({}); |
| - `"ModularAccountV2"` (recommended and default) | ||
| - `"LightAccount"` | ||
| - `"MultiOwnerLightAccount"` | ||
| - `"MultiOwnerModularAccount"` |
There was a problem hiding this comment.
We should remove MultiOwnerModularAccount from the list here
| | Simulate user operations before sending (i.e. use [`alchemyUserOperationSimulator`](/wallets/reference/account-kit/infra/functions/alchemyUserOperationSimulator)) | `useSimulation` | `boolean` | | ||
| | Custom middleware to run before requesting sponsorship | `customMiddleware` | `ClientMiddlewareFn` | | ||
| | Override fee estimation middleware (if you are using our RPCs, it's important to use the default [`alchemyFeeEstimator`](/wallets/reference/account-kit/infra/functions/alchemyFeeEstimator)) | `feeEstimator` | `ClientMiddlewareFn` | | ||
| | Override gas estimation middleware (the default middleware calls the underlying bundler RPC to `eth_estimateUserOperationGas`) | `gasEstimator` | `ClientMiddlewareFn` | | ||
| | Override middleware that signs user operation(s) | `signUserOperation` | `ClientMiddlewareFn` | |
There was a problem hiding this comment.
I don't think any of these are valid options - they won't change the behavior of the resulting SmartWalletClient.
There was a problem hiding this comment.
And actually, these aren't valid options to pass to the JS client at all
There was a problem hiding this comment.
Oh really? we used to have these documented - when did that change?
There was a problem hiding this comment.
Are the advanced account params still valid like passing 7702?
docs/docs.yml
Outdated
| - page: Set up client | ||
| path: wallets/pages/concepts/smart-account-client.mdx |
There was a problem hiding this comment.
Imo we should leave this at the bottom - the setup provided in all of the other examples is more direct and gets the job done, I'd rather people view those first. This doc goes deeper into client config, which is likely a follow-up action after getting it to work at all.
There was a problem hiding this comment.
Interesting. Would you rename this to something like Congifure client then? My concern was that we throw people into example and they have to look at the client.ts file and use it but dont actually know what it is
…form/aa-sdk into ava/update-sa-client
Pull Request Checklist
yarn test)sitefolder, and guidelines for updating/adding docs can be found in the contribution guide)feat!: breaking change)yarn lint:check) and fix any issues? (yarn lint:write)PR-Codex overview
This PR focuses on updating documentation related to the
Smart Account Client, enhancing clarity and usability for developers interacting with smart wallets.Detailed summary
Smart Account Clientdocumentation.SmartWalletClientdescription and its functionalities.ReactandJavaScriptusage.