Merge pull request #68 from bcnmy/divio_system_docs

update how tos for divio and update links
bcnmy · Sep 22, 2023 · 61b066c · 61b066c
2 parents dd0552a + 7f25675
commit 61b066c
Show file tree

Hide file tree

Showing 28 changed files with 963 additions and 245 deletions.
diff --git a/docs/Biconomy AA Stack/Account/description.md b/docs/Biconomy AA Stack/Account/description.md
@@ -8,4 +8,4 @@ Building and sending UserOperations is a key offering of any toolkit designed fo
 
 The Biconomy account package achieves this by providing a comprehensive set of methods that enable developers to effortlessly create UserOperations. Combined with the sophisticated backend infrastructure of the Biconomy platform, it ensures efficient and reliable transmission of these operations across EVM networks.
 
-The Biconomy account package also supports the addition of modules. Each module unlocks new Smart Account functionality such as passkeys, session keys, account recovery etc. 
+The Biconomy account package also supports the addition of modules. Each module unlocks new Smart Account functionality such as passkeys, session keys, account recovery etc. Lear more about Modules [here](/docs/category/modules)
diff --git a/docs/Biconomy AA Stack/Bundler/description.md b/docs/Biconomy AA Stack/Bundler/description.md
@@ -3,4 +3,4 @@ sidebar_position: 1
 ---
 # Description
 
-In the context of Account Abstraction (ERC4337), A bundler plays a main role in the infrastructure. This concept is integral to the operation of account abstraction across any network that utilizes the Ethereum Virtual Machine (EVM). The main purpose of a bundler is to take UserOperations included in a mempool and and handle sending them to an entry point contract to be executed as a transaction onchain. 
+The Bundler is a service that tracks userOps that exist in an alternative mem pool and as the name suggests, bundles them together to send to an Entry Point Contract for eventual execution onchain. This is the final piece of the flow where after constructing your userOp and then potentially signing it with data from a paymaster, you send the userOp on chain to be handled and executed as a transaction on the EVM. You can start using our Bundlers right now in your dApps; each of our [tutorials](/docs/category/tutorials) will walk you through how to use them in different scenarios.
diff --git a/docs/Biconomy AA Stack/Paymaster/description.md b/docs/Biconomy AA Stack/Paymaster/description.md
@@ -3,4 +3,18 @@ sidebar_position: 1
 ---
 # Description
 
-ERC4337, Account abstraction, introduces the concept of Paymasters. These specialised entities play a pivotal role in revolutionising the traditional gas payment system in EVM transactions. Paymasters, acting as third-party intermediaries, possess the capability to sponsor gas fees for an account, provided specific predefined conditions are satisfied.
+Biconomy offers a Paymaster service designed with one of the best developer experiences in mind. Simply use one URL and switch modes between our sponsorship paymaster and our Token Paymaster. 
+
+## Sponsorship Paymaster
+
+![Sponsored](../../images/overview/sponsored.png)
+
+If the mode you choose in the request to the Paymaster URL is the sponsored mode, your users will benefit from gasless transactions, and you remove the friction point of needed native tokens to pay for gas on transactions. Learn how to set up your paymaster [here](/docs/dashboard/paymaster).
+
+## Token Paymaster
+
+![Erc20](../../images/overview/erc20gas.png)
+
+Switching the mode of your Paymster to ERC20 allows you to unlock an experience where users can pay gas in any of our supported ERC20 tokens on different networks. Check out the latest supported tokens [here](/docs/supportedchains/supportedTokens).
+
+Learn how to utilize either of these Paymasters by checking out our How To Guide on [Executing transactions](/docs/category/executing-transactions)
diff --git a/docs/addons/Social Login/_category_.json b/docs/addons/Social Login/_category_.json
diff --git a/docs/addons/Social Login/other.md b/docs/addons/Social Login/other.md
diff --git a/docs/addons/Social Login/particleAuth.md b/docs/addons/Social Login/particleAuth.md
diff --git a/docs/addons/_category_.json b/docs/addons/_category_.json
diff --git a/docs/audits.md b/docs/audits.md
@@ -9,15 +9,15 @@ sidebar_position: 12
 
 | Audit Title | Link |
 | --------------- | --------------- |
-| Kawach Smart Account  | [Link to report](https://file.notion.so/f/s/1c85315c-1ad4-4839-b111-237b47441117/Biconomy_Smart_Wallet_Kawach_Audit_Report.pdf?id=97283eaa-7604-43f4-add3-692d471eb78a&table=block&spaceId=25dc957f-e7fd-41fb-a6a6-55939771f1ed&expirationTimestamp=1693094400000&signature=IaWv3qQIlSEAYnWgPMZL8KU1Us3kTV-cblebjl7yS6k&downloadName=Biconomy+Smart+Wallet+Kawach+Audit+Report.pdf)|
-| Zellic Biconomy Smart Account  | [Link to report](https://file.notion.so/f/s/0c72e92e-50f4-439e-85f1-d768b7b8504d/Biconomy_Smart_Account_-_Zellic_Audit_Report.pdf?id=0e3038bd-cb07-4825-bd25-f1651f419d4c&table=block&spaceId=25dc957f-e7fd-41fb-a6a6-55939771f1ed&expirationTimestamp=1693094400000&signature=TCXccm40TjzGKe5ROXzLD4oOUVVtCmsELKxA93LHEgY&downloadName=Biconomy+Smart+Account+-+Zellic+Audit+Report.pdf) |
-| Zellic - PasskeyRegistry and SessionKey Manager| [Link to report](https://file.notion.so/f/s/52a464f3-bdea-4061-92b0-8c58e39deebc/Biconomy_PasskeyRegistry_and_SessionKeyManager_Zellic_Audit_Report.pdf?id=610a400c-8f7e-4caa-ba9d-03225bdcc1a6&table=block&spaceId=25dc957f-e7fd-41fb-a6a6-55939771f1ed&expirationTimestamp=1693094400000&signature=VZ_RTpES21wboiCN_g7a9xCOPODn5PltMpihbMInqfM&downloadName=Biconomy_PasskeyRegistry_and_SessionKeyManager_Zellic_Audit_Report.pdf) | 
+| Kawach Smart Account  | [Link to report](https://file.notion.so/f/s/1c85315c-1ad4-4839-b111-237b47441117/Biconomy_Smart_Wallet_Kawach_Audit_Report.pdf?id=97283eaa-7604-43f4-add3-692d471eb78a&table=block&spaceId=25dc957f-e7fd-41fb-a6a6-55939771f1ed&expirationTimestamp=1695427200000&signature=FgFi1iS77is43aw9e32W3b253BPVLZ0WSrC8EYwntts&downloadName=Biconomy+Smart+Wallet+Kawach+Audit+Report.pdf)|
+| Zellic Biconomy Smart Account  | [Link to report](https://file.notion.so/f/s/0c72e92e-50f4-439e-85f1-d768b7b8504d/Biconomy_Smart_Account_-_Zellic_Audit_Report.pdf?id=0e3038bd-cb07-4825-bd25-f1651f419d4c&table=block&spaceId=25dc957f-e7fd-41fb-a6a6-55939771f1ed&expirationTimestamp=1695427200000&signature=Rb4S8SD8y191FKXkc-twPoFulkIMjuKGcIjjk7ilM0M&downloadName=Biconomy+Smart+Account+-+Zellic+Audit+Report.pdf) |
+| Zellic - PasskeyRegistry and SessionKey Manager| [Link to report](https://file.notion.so/f/s/52a464f3-bdea-4061-92b0-8c58e39deebc/Biconomy_PasskeyRegistry_and_SessionKeyManager_Zellic_Audit_Report.pdf?id=610a400c-8f7e-4caa-ba9d-03225bdcc1a6&table=block&spaceId=25dc957f-e7fd-41fb-a6a6-55939771f1ed&expirationTimestamp=1695427200000&signature=jCr_ZE1CUjcAzxgXFxz_zyffTMSF6rr8vKNi9ydtgZk&downloadName=Biconomy_PasskeyRegistry_and_SessionKeyManager_Zellic_Audit_Report.pdf) | 
 
 
 
 ## Paymasters 
 
 | Audit Title | Link |
 | --------------- | --------------- |
-| Zellic Paymaster  | [Link to report](https://file.notion.so/f/s/e4e3ca6d-d75e-4b18-abf6-e5248b94019f/Final_Biconomy_Security_Assessment_Report_(1).pdf?id=235ac9f0-9d66-45b0-8bfa-60c17986a2c4&table=block&spaceId=25dc957f-e7fd-41fb-a6a6-55939771f1ed&expirationTimestamp=1693094400000&signature=TQUXiX-t7pDlmjCz7RcC3I3IeN2Zp7cjOny7W1rBAeI&downloadName=Final+Biconomy+Security+Assessment+Report+%281%29.pdf) |
-| Zellic Token Paymaster| [Link to report](https://file.notion.so/f/s/4e24265c-325a-4586-8b20-2de279741fa0/Token_Paymaster_-_Zellic_Audit_Report.pdf?id=23ce7158-3cdd-498d-b6b3-40f5cc83dac5&table=block&spaceId=25dc957f-e7fd-41fb-a6a6-55939771f1ed&expirationTimestamp=1693094400000&signature=0fI2yqKSOuMx8_Fxf9b0CQDgNDAqlxYh1iss8AUx6D4&downloadName=Token+Paymaster+-+Zellic+Audit+Report.pdf) | 
+| Zellic Paymaster  | [Link to report](https://file.notion.so/f/s/4e24265c-325a-4586-8b20-2de279741fa0/Token_Paymaster_-_Zellic_Audit_Report.pdf?id=23ce7158-3cdd-498d-b6b3-40f5cc83dac5&table=block&spaceId=25dc957f-e7fd-41fb-a6a6-55939771f1ed&expirationTimestamp=1695427200000&signature=snkMNlGFiHJ5SXjM3_V2GiVNt_tZOQxllUsUyoA3juQ&downloadName=Token+Paymaster+-+Zellic+Audit+Report.pdf) |
+| Zellic Token Paymaster| [Link to report](https://file.notion.so/f/s/e4e3ca6d-d75e-4b18-abf6-e5248b94019f/Final_Biconomy_Security_Assessment_Report_(1).pdf?id=235ac9f0-9d66-45b0-8bfa-60c17986a2c4&table=block&spaceId=25dc957f-e7fd-41fb-a6a6-55939771f1ed&expirationTimestamp=1695427200000&signature=qt-B8G6j5M7T87yQT-5WW7-C6JwFZflv4ZSvVIzA188&downloadName=Final+Biconomy+Security+Assessment+Report+%281%29.pdf) | 
diff --git a/docs/howtos/_category_.json b/docs/howtos/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "How to Guides",
+  "position": 5,
+  "link": {
+    "type": "generated-index",
+    "description": "Quick Recipes for implementing features into your code"
+  }
+}
diff --git a/docs/howtos/creatingAccounts/_category_.json b/docs/howtos/creatingAccounts/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Creating Accounts",
+  "position": 1,
+  "link": {
+    "type": "generated-index",
+    "description": "The many different ways you can create a Biconomy Smart Account"
+  }
+}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,4 @@ Building and sending UserOperations is a key offering of any toolkit designed fo

		The Biconomy account package achieves this by providing a comprehensive set of methods that enable developers to effortlessly create UserOperations. Combined with the sophisticated backend infrastructure of the Biconomy platform, it ensures efficient and reliable transmission of these operations across EVM networks.

		The Biconomy account package also supports the addition of modules. Each module unlocks new Smart Account functionality such as passkeys, session keys, account recovery etc.
		The Biconomy account package also supports the addition of modules. Each module unlocks new Smart Account functionality such as passkeys, session keys, account recovery etc. Lear more about Modules [here](/docs/category/modules)