bcnmy / docs

Biconomy official documentation
https://docs.biconomy.io/
MIT License
15 stars 28 forks source link

Better highlight the requirement for setting rpcUrl when non ethers/ viemWallet signers are used #202

Closed joepegler closed 6 months ago

joepegler commented 6 months ago

There are certain circumstances where the rpcUrl will be picked up when custom signers are used, but for the most part it's safe to say they will not be ingested during createSmartAccountClient unless the signer is one of those two signer types (viemWallet or ethers.Signer).

Because of this we should make it better known that rpcUrl is an available property in the config, particularly in the sections for the custom signers: image

If rpcUrl is not provided then a default public rpc will be used - which will likely be heavily throttled and can often silently fail - so the ramifications can be nasty for end users if the dev isn't paying attention.

himanshugarg06 commented 6 months ago

Add the following in the Usage code here - https://docs.biconomy.io/Account/methods#createsmartaccountclient

const smartAccount = await createSmartAccountClient({
  signer,
  bundlerUrl: "", // <-- Read about this at https://docs.biconomy.io/dashboard#bundler-url
  biconomyPaymasterApiKey: "", // <-- Read about at https://docs.biconomy.io/dashboard/paymaster
  rpcUrl: "", // This is an optional param, Its advised to pass RPC url in case of custom signers such as privy, dynamic etc. If 
            // rpcUrl is not provided then a default public rpc will be used - which will likely be heavily throttled and can often 
           // silently fail
});

we can mention the same in description of the rpcUrl param below

and add rpcUrl in the smart account creation for all signers.