How could we improve the Biconomy documentation site?

Add testnet tokens support as well

How could we improve the Biconomy documentation site?

I think we should have 2 different sections along with "Integration" in Paymaster. The sections should be "Sponsored" and "ERC20", and in each one of them integration of modes should be explained respectively. In the current scenario, we have spoken about feeQuotes and response at the beginning of "Methods" section and have defined modes below it, which is quite confusing and unclear.

please check these two links
https://docs.biconomy.io/docs/1.0/category/sdk-reference-1
https://docs.biconomy.io/docs/1.0/category/quick-explore

these two are part of v1 docs and are of no need as they are just docusauras template.

How could we improve the Biconomy documentation site?

No response

How could we improve the Biconomy documentation site?

https://github.com/bcnmy/docs/blob/master/docs/Account/signers/web3auth.md

Polygon Amoy chainId is not right here

Should be 0x13882 instead

How could we improve the Biconomy documentation site?

Document smartAccount.deploy() for upcoming release

Document smartAccount.getBalances(tokenAddresses) for upcoming release

Document smartAccount.getSupportedTokens() for upcoming release

.address appears not to be in the sdk. What is available is the .getSmartAccountAddress()

const biconomyAccount = new BiconomySmartAccount(biconomySmartAccountConfig)
const biconomySmartAccount = await biconomyAccount.init()
console.log("owner: ", biconomySmartAccount.owner)
console.log("address: ", biconomySmartAccount.address)

https://docs.biconomy.io/docs/Biconomy%20AA%20Stack/Account/initialization

• Provide clear explanations of the product offerings
• Improve navigation from the overview page
• Remove all the images. paymaster images are already part of the paymaster documentation.
• Add a demo, showcasing the UX improvements using privy.
• add npm i sdk-package to showcase, add redirection to the quickstart page

How could we improve the Biconomy documentation site?

• Add an interface for partialUserOp mentioned in the API call - https://docs.biconomy.io/Paymaster/api/get-fee-quotes with details on which params are needed
• fix indentation
• expiryDuration definition in the https://docs.biconomy.io/Paymaster/api/sponsor-useroperation
• verify that all params are correct as per the API specification
• Add explanation on how is this method useful in case of sponsored - https://docs.biconomy.io/Paymaster/api/get-fee-quotes#1-mode-is-sponsored

When trying to execute userOP via SessionSigner, validation is being done in two steps.
First step is validating when trying to do estimation for userOp and this is being done by passing the first calldata from above where we need to skip 4 bytes to get the destination contract.
Second step is validating the userOP for execution, and this is being done by passing the second calldata with paymaster where we need to skip 0x4a bytes to get the destination contract.
Add above in the docs https://docs.biconomy.io/Modules/abiSessionValidationModule#rules

How could we improve the Biconomy documentation site?

The simulationType flag can be of 2 ways:
"validation" which will only simulate the validation phase, checks if user op is valid but does not check if execution will succeed
"validation_and_execution" checks if user op is valid and if user op execution will succeed
By default this flag is set to "validation"

https://bcnmy.github.io/biconomy-client-sdk/classes/Bundler.html#create - config interface and definition of optional params
https://bcnmy.github.io/biconomy-client-sdk/classes/Bundler.html#estimateUserOpGas - useropstruct and StateOverrideSet
https://bcnmy.github.io/biconomy-client-sdk/classes/Bundler.html#sendUserOp - SimulationType and UserOperationStruct
https://bcnmy.github.io/biconomy-client-sdk/classes/Bundler.html#getUserOpByHash - UserOpByHashResponse
Also add any specific details related to any methods,

How could we improve the Biconomy documentation site?

AA23 error is missing troubleshooting

How could we improve the Biconomy documentation site?

No response

How could we improve the Biconomy documentation site?

Lacks an example demonstrating a key use case. It fails to illustrate how one interacts with a smart contract, such as invoking a gasless write operation.

How could we improve the Biconomy documentation site?

https://docs.biconomy.io/Bundler/api/estimate-useroperation-gas
On this page the second parameter in the request should be the EP address instead of bundler address.

https://docs.biconomy.io/docs/supportedchains/supportedTokens
In the above link, tokens supported on Ethereum Mainnet are not mentioned.
In the tables and in the Pair column, it is mentioned "AAVE/USD", USD doesnt imply anything, it should have been USDT, and USD is mentioned everywhere.

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:

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.

with the migration of the polygon testnet, mumbai chain will be deprecated. So we plan to move the docs and tutorial to Amoy testnet.
https://polygon.technology/blog/introducing-the-amoy-testnet-for-polygon-pos

https://www.notion.so/biconomy/Docs-FAQs-372e054e0cb44a22938762ccff609814

• Add Algolia search option https://docusaurus.io/docs/search
• Add swagger API for the API section using https://github.com/PaloAltoNetworks/docusaurus-openapi-docs
• In the quick explore > setup node cli section
  • We should mention what all contracts they should verify for doing transactions, only adding paymaster url will not work.
  • Or maybe we can have a section to do trx and then tell why they get that error.
• Add common error page what Talha had created previously https://www.notion.so/biconomy/Troubleshooting-Guide-778da8ec6c104ab08c5ff9313cdc0091

How could we improve the Biconomy documentation site?

Polygon Mumbai is outdated and missing supported ERC20 for Ethereum Sepolia thanks!

We're getting lots of reports from v4 users who are receiving a tx hash and assuming that their code is working, but they are also receiving "success" === "false" from the userOp hash without realising.

In our docs we need to better inform devs to check that success == 'true' in the responseafter they've sent a transaction. For example here, and the rest of the tutorials

See the test here as an example of how the check can be performed

We will add this check in our tests too more thoroughly so that readers of the tests notice how to measure the success of a tx.

TLDR:

Change

    const { receipt: { transactionHash }  } = await wait();

for

    const { success } = await response.wait();

throughout the docs where appropriate

1. The Biconomy SDK is an Account Abstraction toolkit that enables the simplest UX on your dApp and wallet << Lets include appchain here too.

2. The Biconomy Smart Accounts are signer agnostic, which allows you to use any authorization package of your choice as long as you can pass a signer to our SDK upon the creation of a Smart Account. Check out different ways you can create a Biconomy Smart Account here. << lets be specific here that signers can be MPC or something else so its clear from the get go.

3. Get Aditya to change the image to remove batched txn module

4. Lets include how smart accounts are the most gas efficient in the market

5. I would also include somewhere our stack is modular meaning that you can use the full stack or use individual components and overall prevents lock in

6. Lets include a image for the bundler?

It's only available for use in a node environment and it was affecting nextjs builds

• https://www.npmjs.com/package/@biconomy/session-file-storage
• bcnmy/biconomy-client-sdk#515
• bcnmy/sdk-examples#43

How could we improve the Biconomy documentation site?

Hi! The full code should be this:
const userOpResponse = await smartAccount.sendTransaction({
to: nftAddress,
data: nftData,
});

const { waitForTxHash } = await smartAccount.sendTransaction({
    to: nftAddress,
    data: nftData,
});

const { transactionHash } = await waitForTxHash();
console.log("transactionHash", transactionHash);

const userOpReceipt = await userOpResponse.wait();
if (userOpReceipt.success == "true") {
    console.log("UserOp receipt", userOpReceipt);
    console.log("Transaction receipt", userOpReceipt.receipt);
}

How could we improve the Biconomy documentation site?

Document smartAccount.getBalances(tokenAddresses) for upcoming release

How could we improve the Biconomy documentation site?

Document smartAccount.getSupportedTokens() for upcoming release

How could we improve the Biconomy documentation site?

No response

Would be great to have error messages explained on the docs

1. {"code": 502, "data": undefined, "message": "An invalid response was received from the upstream server"}

How could we improve the Biconomy documentation site?

SimulationType === "validation" = no latency, no useful feedback: (production mode). SimulationType === "validation_and_execution" = increased latency, provides useful errors (developer mode).

Multiple users are still highlighting issues that could be resolved if they'd known and availed of our validation_and_execution mode, most recently Kwenta.

https://docs.biconomy.io/Account/methods <-- This page is too big imo, and it'll need to get bigger. I am in the process of adding three new public helper methods on the smartAccount class:

• getBalances(tokenAddresses)
• withdraw(recipientAddress, requests)
• getSupportedTokens()

Given the current size of the methods page and that we know it will expand further I think it make sense to split out concerns into separate pages.