Skip to content

Commit

Permalink
Merge pull request #25 from bcnmy/brokenLinks-fixed
Browse files Browse the repository at this point in the history
broken links fixed
  • Loading branch information
himanshugarg06 authored Aug 22, 2024
2 parents a7309f4 + 3e40dc4 commit b80fbc4
Show file tree
Hide file tree
Showing 18 changed files with 30 additions and 30 deletions.
2 changes: 1 addition & 1 deletion docs/pages/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Explore services such as Web3Auth, Particle Network, Magic.link, or Lit Protocol

**How do I enable session keys for users?**

Utilize the session key validation [module](https://docs.biconomy.io/modules/sessionvalidationmodule).
Utilize the session key validation [module](https://docs.biconomy.io/modules/sessions/sessionvalidationmodule).

**How to enable debug mode in SDK to log more?**

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/account/integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ console.log("SA Address", saAddress);
In this doc, the following values are used by default:

- ECDSA Validation Module. Other validation [modules](/modules) can be enabled based on the specific use case.
- The default entry point [address](contracts.md) is used for the chainId.
- The default entry point [address](/contracts.md) is used for the chainId.
- An index with a value 0, but you can also specify a custom index value in the configuration to generate multiple smart accounts with the same signer.

CREATE2 allows us to enable flows where users could even send funds to an undeployed wallet, which could then be used to pay for the gas for deployment.
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/addOns/fiatRails.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Onramp aggregators enable access to multiple onramp providers. The one listed be
| Fiat Onramp | Outlier Factor | Quick Guides | Supported Currencies |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| **Ramp Network** | global coverage on/off-ramp, most payment methods & currencies, best Ux with Native integration, lowest user fees, high conversion rates | [Technical Docs](https://docs.ramp.network/), [Off-ramp Demo Video](https://www.youtube.com/watch?v=KSXgmRpl_Pg) | [List](https://support.ramp.network/en/articles/471-supported-fiat-currencies) |
| [**Transak**](/account/fiatonramp) | Best rates globally, native integration for all products with Biconomy SDK | [Demo UI](https://transak-biconomy.netlify.app/), [Demo Video](https://www.loom.com/share/90d1473db6cd44879a24c3407bf39789), [Technical Docs](https://docs.biconomy.io/guides/enable-fiat-on-ramp-and-off-ramp) | [List](https://docs.transak.com/docs/fiat-currency-country-payment-method-coverage-plus-fees-and-limits) |
| [**Transak**](/account/fiatonramp) | Best rates globally, native integration for all products with Biconomy SDK | [Demo UI](https://transak-biconomy.netlify.app/), [Demo Video](https://www.loom.com/share/90d1473db6cd44879a24c3407bf39789), [Technical Docs](https://docs.biconomy.io/account/fiatonramp) | [List](https://docs.transak.com/docs/fiat-currency-country-payment-method-coverage-plus-fees-and-limits) |
| **Unlimit** | Simple and flexible integration methods, easy and secure verification methods. | [Technical Docs](https://docs.gatefi.com/docs/gatefi-docs/zczlqjv647sxz-what-is-unlimit-crypto) | [List](https://docs.gatefi.com/docs/gatefi-docs/dqboe8phjgui5-supported-assets-and-payments) |

## User Flow
Expand Down
6 changes: 3 additions & 3 deletions docs/pages/modules/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ Validation Modules in MSA play a crucial role in determining who can perform act

Following is the list of Validation Modules:

- [**ECDSA Ownership Module**](ecdsa.mdx): This module is widely adopted as a validation module for Biconomy smart accounts. It can seamlessly integrate with MPC providers such as Web3Auth, abstracting EOA Private Key storage and enabling a web2-like experience such as email login.
- [**Multichain ECDSA Validator Module**](multichain.mdx): This module significantly improves UX for deploying and setting up Smart Accounts on several chains. It is an extension of the ECDSA Module enabling to dispatch multiple userOps on different chains using a single signature.
- [**Session key Manager Validation Module**](sessionvalidationmodule.mdx): This module enables the use of sessions to execute transactions. It verifies whether a given user operation adheres to the permissions defined within the session key and confirms that the operation has been signed by that session key. This can only be used as an active validation module.
- [**ECDSA Ownership Module**](/modules/ecdsa.mdx): This module is widely adopted as a validation module for Biconomy smart accounts. It can seamlessly integrate with MPC providers such as Web3Auth, abstracting EOA Private Key storage and enabling a web2-like experience such as email login.
- [**Multichain ECDSA Validator Module**](/modules/multichain.mdx): This module significantly improves UX for deploying and setting up Smart Accounts on several chains. It is an extension of the ECDSA Module enabling to dispatch multiple userOps on different chains using a single signature.
- [**Session key Manager Validation Module**](/modules/sessions/sessionvalidationmodule): This module enables the use of sessions to execute transactions. It verifies whether a given user operation adheres to the permissions defined within the session key and confirms that the operation has been signed by that session key. This can only be used as an active validation module.
- **MultiOwnedECDSAModule**: This is an alteration of the ECDSA Module which allows multiple signers to be set up, and any one of the enabled owners can authorize a transaction using the ECDSA signature.

### How to create a custom Validation Module
Expand Down
8 changes: 4 additions & 4 deletions docs/pages/modules/sessions/DistributedSessions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ The Delegated Authorisation Network (DAN) is Biconomy’s blockchain-agnostic pr

## How Can I use it?

Currently when you create a session our [ABI session validation module](./abiSessionValidationModule) is used, and permissions are stored on-chain. However, the private key associated with these permissions can be stored in DAN by setting the `storeSessionKeyInDAN` to `true` while calling the [`createSession()`](../../tutorials/sessions/createSession) helper.
Currently when you create a session our [ABI session validation module](/modules/sessions/abiSessionValidationModule) is used, and permissions are stored on-chain. However, the private key associated with these permissions can be stored in DAN by setting the `storeSessionKeyInDAN` to `true` while calling the [`createSession()`](../../tutorials/sessions/createSession) helper.
If you want to generate a session key with dan, or sign a message using the session key then the following utility helpers can be used:

- [generateSessionKey()](../../tutorials/utils/DAN/generateSessionKey)
- [signMessage()](../../tutorials/utils/DAN/signMessage)
- [generateSessionKey()](/tutorials/utils/DAN/generateSessionKey)
- [signMessage()](/tutorials/utils/DAN/signMessage)

### Coming Soon...

We will soon also facilitate the permissions object being passed to DAN (off chain) which will omit the need to use our ABI SVM and associated gas costs.

[Get started](../../tutorials/sessions/createSession)
[Get started](/tutorials/sessions/createSession)
6 changes: 3 additions & 3 deletions docs/pages/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Modular architecture enables developers to easily & securely plug-in programmabl

If you want to start diving into Smart Accounts you can begin [here](/account). For those, who are already familiar with Smart Accounts and prefer to start with modules, you can check out [here](/modules) or follow this step-by-step [tutorial](/tutorials/sessions/createSession) on how to build a dApp that utilizes session key modules.

View the audit reports for smart accounts and Modules [here](audits).
View the audit reports for smart accounts and Modules [here](/audits).

![FullStakAA](/overview/fullstackaa.png)

Expand All @@ -68,7 +68,7 @@ For the mainnet bundler URL, reach out to us via [email](bd@biconomy.io) or [tel

If you are looking to integrate account abstraction using APIs, checkout the [bundler APIs](/bundler/api) and [tutorials](/tutorials/apiIntegration/).

## [Paymaster](paymaster)
## [Paymaster](/paymaster)

Biconomy's paymaster service enables Dapps to sponsor transactions and, also allows users to use ERC-20 tokens as payment for gas. Log in to the [Biconomy dashboard](/dashboard) to get the paymaster URL and switch modes between our sponsorship and token Paymaster. Make use of different [Spending limits](/dashboard/spendingLimits) to customize the paymaster usage.

Expand All @@ -82,4 +82,4 @@ Switching your Paymaster mode to ERC20 enables users to pay gas fees with ERC20

Learn how to utilize either of these Paymasters by checking out our How To Guide on [Executing transactions](/tutorials)

**Next:** Checkout the [quickstart](quickstart) guide to start the integration.
**Next:** Checkout the [quickstart](/quickstart) guide to start the integration.
4 changes: 2 additions & 2 deletions docs/pages/paymaster/integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ sidebar_position: 2

# Integration

To see how this interacts with other packages in the sdk you can view the [Smart Accounts Integration page](../account/integration.mdx).
To see how this interacts with other packages in the sdk you can view the [Smart Accounts Integration page](/account/integration.mdx).

## Installation

First, install the required packages for initializing the Paymaster.

```bash
```bash
npm install @biconomy/account
```

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/react/useBatchSession.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Description

Uses a previously created batch session ([see here](./useCreateBatchSession.md)) which batches transactions in the context of a users smart account.
Uses a previously created batch session ([see here](/react/useCreateBatchSession)) which batches transactions in the context of a users smart account.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/react/useCreateSessionWithDistributedKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Creates a session to be used when submitting tx in the context of a users smart account.

Please carefully read [this](../tutorials/sessions/index.md) information regarding `Rules` and how they should be constructed before building your Policy.
Please carefully read [this](/tutorials/sessions) information regarding `Rules` and how they should be constructed before building your Policy.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/react/useSendGasTokenTransaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Description

Sends a transaction, taking an erc20 token of choice as payment for the gas. token can be specified in advance by providing the tokenParam as a Hex address, or user can set the token dynamically by setting the tokenParam to a [feeQuote](./useTokenFees.md)
Sends a transaction, taking an erc20 token of choice as payment for the gas. token can be specified in advance by providing the tokenParam as a Hex address, or user can set the token dynamically by setting the tokenParam to a [feeQuote](/react/useTokenFees)

## Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/react/useSession.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Description

Uses a previously created session ([see here](./useCreateSession.md)) which sends transactions in the context of a users smart account.
Uses a previously created session ([see here](/react/useCreateSession)) which sends transactions in the context of a users smart account.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/react/useSessionWithDistributedKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Description

Uses a previously created session ([see here](./useCreateSessionWithDistributedKey.md)) which sends transactions in the context of a users smart account.
Uses a previously created session ([see here](/react/useCreateSessionWithDistributedKey)) which sends transactions in the context of a users smart account.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/tutorials/customValidationModule.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This section of the tutorial requires Solidity knowledge and smart contract deve

In this tutorial, we will look at how to create your own validation module using solidity

As mentioned in the [overview](./../modules#how-to-create-a-custom-validation-module), any custom validation module needs to extend the abstract contract [BaseAuthorizationModule](https://github.com/bcnmy/scw-contracts/blob/main/contracts/smart-account/modules/BaseAuthorizationModule.sol). This contract is crucial as it connects your module to essential authorization functions.
As mentioned in the [overview](/modules#how-to-create-a-custom-validation-module), any custom validation module needs to extend the abstract contract [BaseAuthorizationModule](https://github.com/bcnmy/scw-contracts/blob/main/contracts/smart-account/modules/BaseAuthorizationModule.sol). This contract is crucial as it connects your module to essential authorization functions.
The following implementation enables a module to receive userOp data and provide validation results back to the SmartAccount.

Let's take a look at the step-by-step guide to create a custom Validation Module.
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/tutorials/sessions/createBatchSession.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "Create a batch session"
---

:::info
Building in React? [check here](../../react/useCreateBatchSession.md)
Building in React? [check here](/react/useCreateBatchSession)
:::

### Overview
Expand Down Expand Up @@ -60,7 +60,7 @@ const usersSmartAccount = await createSmartAccountClient({

This function is used to create a new session key and store it in the sessionStorageClient.
You can feed the sessionStorageClient into the `createSessionKeyEOA(...args)` as the third argument. If you do not provide a sessionStorageClient then one will get generated for you based on the environment.
When localStorage is supported, it will return a `SessionLocalStorage` store, otherwise it will assume you are in a backend and use `SessionFileStorage` store. See [here](./customSessionStorage.md) for detail regarding creating your own session storage client.
When localStorage is supported, it will return a `SessionLocalStorage` store, otherwise it will assume you are in a backend and use `SessionFileStorage` store. See [here](/tutorials/sessions/customSessionStorage) for detail regarding creating your own session storage client.

```typescript
const { sessionKeyAddress, sessionStorageClient } = await createSessionKeyEOA(
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/tutorials/sessions/createSession.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "Create a session"
---

:::info
Building in React? [check here](../../react/useCreateSession.md)
Building in React? [check here](/react/useCreateSession)
:::

### Overview
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/tutorials/sessions/useBatchSession.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "Use a batch session"
---

:::info
Building in React? [check here](../../react/useBatchSession.md)
Building in React? [check here](/react/useBatchSession.md)
:::

### Overview
Expand All @@ -23,7 +23,7 @@ You can get your Biconomy Paymaster API key from the dashboard [here](https://da
https://bundler.biconomy.io/api/v2/80002/nJPK7B3ru.dd7f7861-190d-41bd-af80-6877f74b8f44
```

- A session granted by a user [see the previous step](./createBatchSession)
- A session granted by a user [see the previous step](/tutorials/sessions/createBatchSession)

### Step 1: Setup

Expand Down
6 changes: 3 additions & 3 deletions docs/pages/tutorials/sessions/useSession.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ title: "Use a session"
---

:::info
Building in React? [check here](../../react/useSession.md)
Building in React? [check here](/react/useSession.md)
:::

### Overview

This tutorial demonstrates how to use a simple session with viem and the Biconomy Smart Account with the `@biconomy/account` SDK. The provided code assumes you have a Biconomy Paymaster API key, and a valid session setup during the [previous step](./createSession). The following is appropriately viewed from the perspective of a dapp, looking to make txs on a users behalf.
This tutorial demonstrates how to use a simple session with viem and the Biconomy Smart Account with the `@biconomy/account` SDK. The provided code assumes you have a Biconomy Paymaster API key, and a valid session setup during the [previous step](/tutorials/sessions/createSession). The following is appropriately viewed from the perspective of a dapp, looking to make txs on a users behalf.

You can get your Biconomy Paymaster API key from the dashboard [here](https://dashboard.biconomy.io/).

Expand All @@ -23,7 +23,7 @@ You can get your Biconomy Paymaster API key from the dashboard [here](https://da
https://bundler.biconomy.io/api/v2/80002/nJPK7B3ru.dd7f7861-190d-41bd-af80-6877f74b8f44
```

- A session granted by a user [see the previous step](./createSession)
- A session granted by a user [see the previous step](/tutorials/sessions/createSession)

### Step 1: Setup

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/tutorials/utils/transferOwnership.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This tutorial provides insights into how to transfer the ownership of a smart account.

:::caution
Transfer Ownership is performed within the framework of either the [ECDSA Ownership Module](https://docs.biconomy.io/modules/ecdsa) or the [Multichain Validation Module](https://docs.biconomy.io/modules/multichain). If you are utilizing the [Session Key Manager](https://docs.biconomy.io/modules/sessionvalidationmodule), you will need to **recreate the smart account client with the new owner** (new signer). This involves specifying the smart account address and recreating the session.
Transfer Ownership is performed within the framework of either the [ECDSA Ownership Module](https://docs.biconomy.io/modules/ecdsa) or the [Multichain Validation Module](https://docs.biconomy.io/modules/multichain). If you are utilizing the [Session Key Manager](https://docs.biconomy.io/modules/sessions/sessionvalidationmodule), you will need to **recreate the smart account client with the new owner** (new signer). This involves specifying the smart account address and recreating the session.
:::


Expand Down

0 comments on commit b80fbc4

Please sign in to comment.