Integrations documentation improvements #497
Conversation
README.md
Outdated
|
|
||
| You can watch a full end-to-end demo of the project [here](https://www.youtube.com/watch?v=MOQ3sCLP56g) | ||
| A set of components to easily utilize Ethereum Layer 2 smart contract wallets that use [BLS signatures](https://en.wikipedia.org/wiki/BLS_digital_signature) to aggregate transactions, in order to reduce gas costs. Our smart contract wallet supports recovery, atomic multi-action transactions, sponsored transactions and user-controlled upgradeability. |
There was a problem hiding this comment.
Edited the intro here to give readers better context on what BLS Wallet is. Let me know if any disagreement/adjustments need making
There was a problem hiding this comment.
Suggestion: reverse the components you mention, namely putting 'reduce gas costs' first since that is the "why". The "How" is via bls sig aggregation on evm rollups.
There was a problem hiding this comment.
Some options with gas mentioned earlier in the sentence:
"A set of components to easily utilize Ethereum Layer 2 smart contract wallets, that reduce use gas costs by using BLS signatures to aggregate transactions."
"A set of components to easily utilize smart contract wallets that reduce gas costs on Ethereum Layers 2s, by using BLS signatures to aggregate transactions."
There was a problem hiding this comment.
eg. "A set of components to bring lower gas costs to evm rollups via ..."
There was a problem hiding this comment.
Thoughts on where to put the part about/how to mention SCWs? Few options in full:
-
A set of components to bring lower gas costs to EVM rollups via BLS signatures to aggregate transactions. Our smart contract wallet supports recovery, atomic multi-action transactions, sponsored transactions and user-controlled upgradeability.
-
A set of components to reduce gas costs on EVM Optimistic rollups by using BLS signatures to aggregate transactions. Our smart contract wallet supports recovery, atomic multi-action transactions, sponsored transactions and user-controlled upgradeability.
-
A set of components to reduce gas costs on EVM Optimistic rollups by using BLS signatures to aggregate transactions. This includes a smart contract wallet that supports recovery, atomic multi-action transactions, sponsored transactions and user-controlled upgradeability.
There was a problem hiding this comment.
Tweaked one of yours: "A set of components to bring lower gas costs to EVM rollups via aggregated BLS signatures. Our smart contract wallet supports recovery, atomic multi-action operations, sponsored transactions and user-controlled upgradability."
There was a problem hiding this comment.
Updated cheers, thanks for catching the "upgradability" typo as well.
| }); | ||
| ``` | ||
|
|
||
| ## Estimating and paying fees |
There was a problem hiding this comment.
@jacque006 This fees section includes the code examples you gave from the hackmd doc you shared. Let me know if this covers things well. I changed the examples slightly but let me know if you think they need additional changes.
Also more generally, if you feel like I've missed anything from your hackmd doc, feel free to add yourself or let me know and I'll make the changes.
contracts/clients/README.md
Outdated
| const bundle = wallet.sign({ | ||
| nonce: await wallet.Nonce(), | ||
| actions: [ | ||
| bundle, // ... do your transaction/actions here (approve, transfer, etc.) |
There was a problem hiding this comment.
This is a bit confusing, maybe instead:
| bundle, // ... do your transaction/actions here (approve, transfer, etc.) | |
| ...actions, // ... do your actions here (approve, transfer, etc.) |
There was a problem hiding this comment.
good point, fixed
d504b4c to
c7b245f
Compare
|
@jacque006 everything should be updated. Also felt like a quick win so added #500 to these changes |
What is this PR doing?
Adding improvements to docs based on conversations with developers integrating bls-wallet in web3well.
Edit: Added #500 to this change as a quick win.
How can these changes be manually tested?
Does this PR resolve or contribute to any issues?
#437
#500
Checklist
Guidelines
resolve conversationbutton is for reviewers, not authors