Features/sma 329 improve repo #49
Conversation
…nto features/SMA-329-improve-repo
Aboudjem
requested review from
filmakarov,
ankurdubey521,
AmanRaj1608,
tomarsachin2271 and
livingrockrises
README.md
Outdated
|
|
||
| 1. Singleton Verifying Paymaster: Acts as a sponsorship paymaster and lets Dapps manage deposit without deploying a new one for each Dapp. | ||
| ## What is Biconomy Paymasters? 🤔 |
There was a problem hiding this comment.
is -> are
would be good to talk about ERC4337 paymasters on the high level maybe with some flow diagrams.
There was a problem hiding this comment.
check some content from here
https://erc4337.mirror.xyz/7DUTUn2eNrjvum3tWAnRih8576IrX13E6WnZeADvAHQ
https://erc4337.mirror.xyz/RKG9kt7af3B_Dj0KHjuhwOOpEP6JxLXr-2vW4DOlhQM
there are also some articles by alchemy and visa
README.md
Outdated
|
|
||
| 2. Token Paymaster: Extended version of Verifying Paymaster which can accept fees from user by withdrawing ERC20 tokens | ||
| Biconomy Paymasters are smart contracts that abstract away the complexity of gas fees for end-users. By utilizing these contracts, developers can offer their users gasless transactions or the ability to pay for gas in ERC20 tokens. 🚀 |
There was a problem hiding this comment.
can just limit to gas abstraction. then talk about kind of paymaster we already have or we plan to have with gas abstraction (how) aspect of each
|
|
||
| - ERC20 Token Paymaster helps users pay for their transactions using ERC20 tokens. | ||
| - Users initiate a transaction using an ERC20 token. |
There was a problem hiding this comment.
refer to ERC20 paymaster design notion doc
|
in one of the diagrams it's not clear what SmartAccount is and how it would return signedUserOp |
|
resolve conflicts |
|
|
||
| #### Other WIP | ||
| - **Sponsorship Paymaster**: Allows transactions without end-users needing to pay for gas, enhancing UX. | ||
| - **Token Paymaster**: Provides the ability to pay for transactions with ERC20 tokens. |
There was a problem hiding this comment.
Maybe highlight, that users still pay by themselves with token paymaster and token paymaster allows not having native token
There was a problem hiding this comment.
nvm, I see that this is explained later
README.md
Outdated
|
|
||
| - ERC20 Token Paymaster helps users pay for their transactions using ERC20 tokens. | ||
| - Users initiate a transaction using an ERC20 token. | ||
| - Paymaster validates the transaction and forwards it to the network while handling necessary fee conversions. |
There was a problem hiding this comment.
Technically Paymaster doesn't forward the transaction. It just pays for the userOp.
README.md
Outdated
|
|
||
| #### In order to add/udpate git submodule account-abstraction: #### | ||
| .gitmodules file is already added. two submodules are being used in this project | ||
| - Sponsorship Paymaster covers transaction fees for users. |
There was a problem hiding this comment.
I suggest changing txns to userOps everywhere
There was a problem hiding this comment.
Maybe I'm missing something, but I find it a bit confusing, that we have it named 'Sponsorship Paymaster', however I can't find Sponsorship Paymaster in the repo.
I understand Verifying Paymaster is not the best name, Sponsorship Paymaster is much better , but I think need some consistency between readme and file names here
There was a problem hiding this comment.
You're right @filmakarov, I found the references to 'Sponsorship Paymaster' in both Biconomy blog and official documentation.
I agree 'Sponsorship Paymaster' sounds like a better name to me too. Let's bring this up with the team for further discussion.
README.md
Outdated
| .gitmodules file is already added. two submodules are being used in this project | ||
| - Sponsorship Paymaster covers transaction fees for users. | ||
| - The process starts with the user initiating a transaction. | ||
| - Paymaster takes over and sponsors the fees, so users don't have to bear the gas costs. |
There was a problem hiding this comment.
Should we describe that to sponsor a userOp, paymaster still needs signature by verifying party that reviews userOps before agreeing to pay for it
Add Audits folder
Improved Readme
Add contributions / Readme/ Licenses