Skip to content
Merged

edits #129

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 20 additions & 29 deletions docs/build/balance/balance.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,55 @@
# Balance top up
# Payment And Balance Management

## Features of Balance Management on the Fluence Platform
In order to rent a VM from the Fluence marketplace, you need to provide funds to the marketplace which are used to pay for your rented resources. It is important to note that allocated funds are managed by smart contracts and based on your VM configuration and price, the smart contracts periodically charge the rent due to the compute provider. Throughout this document, we refer to the funds escrowed to these smart contracts as the Balance.

After registering through Fluence Console, a new Self-Custodial Wallet is created for each user using Web3Auth. However, in this case, interacting with smart contracts in the Fluence network still requires signing blockchain transactions each time.

To simplify the process of interacting with the Blockchain network through Fluence Console, the Fluence uses [account abstraction](https://web3auth.io/docs/features/account-abstraction) to handle user balances. Hence, topping up your balance is reflected in the [Balance smart contract](https://blockscout.mainnet.fluence.dev/address/0xF0C308C622eeBA94aeEc2E3Fd67F34619f86761B). At the same time, the functionality of the Balance smart contract is extremely limited to ensure maximum security of user funds.

Thus, when replenishing your Balance through Fluence Console, user funds are transferred to a special smart contract, not directly to the address created through Web3Auth.

:::danger
The balance top upped through Fluence Console can only be used to rent resources in the Fluence network. To interact with other protocol mechanics, such as Staking, you need to top up the address created through Web3Auth or any other EOA directly, for example, by using a Bridge from Ethereum to Fluence Mainnet network.
:::
The Fluence Console simplifies interacting with the blockchain by using [account abstraction](https://web3auth.io/docs/features/account-abstraction) to manage balances. As a result, topping up your balance is reflected as a transaction in the secure [Balance smart contract](https://blockscout.mainnet.fluence.dev/address/0xF0C308C622eeBA94aeEc2E3Fd67F34619f86761B) and not the Web3Auth wallet created during registration. Note that the Balance can only be used to rent resources from the Fluence network and that you cannot directly withdraw funds from the Balance contract. If a refund is required, please contact the Fluence team.

:::info
Fluence Console users cannot top up their Balance by themselves on the Fluence platform (stored in Balance smart contract) from addresses created through Web3Auth or through any other third-party EOA. This restriction is related to AML (Anti-Money Laundering) limitations. Also, Fluence Console users cannot independently withdraw funds from their balance on the Fluence platform. If a refund is needed, please contact the Fluence team.
Fluence Console users **cannot** top up their Balance from the newly created Web3Auth or any other wallet you may own. This restriction is related to AML (Anti-Money Laundering) limitations. Instead, Fluence Console users need to go through whitelisted payment portals such as CopperX.
:::

## Steps to top up Balance on the Fluence Platform
## Topping up the Balance

:::info
Participants in the Alpha VM testing program will receive 256 USDC in Free Credits on their balance after registering on the Fluence platform.
Participants in the Alpha VM testing program receive 256 USDC in balance credits. This amount should easily get you through the testing period and it is doubtful that you will need to top up the Balance during the testing phase.
:::

Currently, replenishing the Balance through Fluence Console is done using the payment provider CopperX.

:::info
Currently, payment is available in the Ethereum (USDC) and Polygon (USDC.e) networks. Please note that after successful payment through CopperX in one of the available networks, your Balance will be automatically top up in the Balance smart contract in the Fluence Mainnet network.
:::
Currently, you fund your Balance using [CopperX](https://copperx.io/), which offers payment options for Ethereum (USDC) and Polygon (USDC.e). The Fluence Console integrates CopperX payment and event monitoring providing a seamless experience to establish payments to the Balance smark contracts. Once your CopperX payment is successfully executed, the Balance smart contract will reflect the transaction.

To top up your balance, follow these steps:
To initiate a payment with CopperX, follow these steps:

### 1. Click the Top Up button

Go to the **Billing page** and click the **“Top Up”** button.

:::info
Please note that at the moment, a user cannot have multiple pending Balance top-up operations. If a user, for any reason, cannot complete the payment, they must [cancel](#cancel-payment) the Balance top-up operation via CopperX.

You can check for pending payment sessions on the **Billing page**, in the **Payments History** section. Pending payment sessions have the status `Pending`.
:::
![top up button](./assets/top_up_button.webp)

### 2. Enter the amount you want to top up your Balance with

:::info
Currently, the **minimum** top up amount is **10 USDC**. At the same time, your balance on the Fluence platform cannot exceed **5000 USDC**.
Currently, the minimum top up amount is **USDC 10.00**, while your total Balance amount cannot exceed **USDC 5000.00**.
:::
![enter amount](./assets/amount.webp)

### 3. Enter your details

You will then be redirected to the CopperX payment page, where you will need to enter your details.
You will be redirected to the CopperX payment page.

![copperx payment page](./assets/payment_page.webp)

#### Cancel payment
:::info
To cancel a payment, use the corresponding option in the CopperX interface. If the payment is not completed within 15 minutes, the payment session will automatically end.
To cancel a payment, use the corresponding option in the CopperX interface. If a payment is not completed within 15 minutes, the payment will be automatically cancelled.
:::
![cancel payment](./assets/cancel.webp)
![cancel result](./assets/cancel_res.webp)

:::info
If you accidentally close the CopperX payment page, you can always return to the Fluence Console interface and go back to the payment page.
If you accidentally close the CopperX payment page, go back to the Fluence Console payment page.
:::
![return to payment page](./assets/return_to_payment.webp)

Expand All @@ -73,10 +60,14 @@ If you encounter issues with the “Wallet” payment option, we recommend using
:::
![complete payment](./assets/complete_payment.webp)

### 5. Back to Fluence Console
### 5. Return to the Fluence Console

After a successful payment, you will be redirected back to the **Fluence Console** page. The payment will be in the `Pending` status for a bit.

After a successful payment you will be redirected back to the **Fluence Console** page. The payment will be in the Pending status for some time, as the system will need time to top up your Balance in the Fluence Mainnet network.
:::info
You cannot have multiple `Pending` transactions. If you cannot complete a CopperX payment and don't want to wait 15 minutes, you need to [cancel to the payment](#cancel-payment).
:::

### 6. Wait for "Completed" payment status
### 6. Wait for the "Completed" payment status

Once the payment status changes to `Completed` your funds will be credited to your Fluence platform Balance.
Once the on-chain transactions are processed, the Balance smart contract will reflect your payment and the FLuence Console payment status updates to `Completed`.
18 changes: 5 additions & 13 deletions docs/build/manage_vm/manage_vm.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,24 @@
# CPU VM Info and Management

After renting a VM, the user can view all the relevant information about the rented resources on the Running Instances page, as well as manage the rented VM.
After renting a VM, all the relevant information is accessible on the **Running Instances** page.

## VM Information

After renting a VM, a corresponding card will appear on the **Running Instances** page, which can be expanded to view all the parameters of the rented VM. Please note that the user can now see **more detailed information** about the server hardware in the `Hardware Specs` section, as a specific server has already been allocated at this stage.

:::info
The user will be able to see extended server parameters only if the specific infrastructure provider has provided the necessary information when registering in the Fluence protocol. Since Fluence currently whitelists providers, in most cases, providers provide all the necessary information.
:::
For each VM, a corresponding card will appear on the **Running Instances** page, which can be expanded. More detailed information can be found in the `Hardware Specs` section. Note that extended server parameters are only visible if the specific infrastructure provider has provided the underlying information.

![VM information](./assets/vm_info.webp)

The user can also see the maximum rental period for the VM (`Expires in`) and information about the next billing time (`Next billing time`), which occurs daily at **5:55 PM UTC**.
The user can also see the maximum rental period for the VM (`Expires in`) and information about the next billing time (`Next billing time`) set at **5:55 PM UTC**.

## VM Management

Currently, the only operation available for a running VM is `Delete`, which terminates the VM and the rental agreement. The ability to Reboot, Reset, and Rebuild will be added soon.
Currently, the only operation available for a (running) VM is `Delete`, which terminates the VM and the rental agreement. The ability to Reboot, Reset and Rebuild from the Fluence Console will be added soon.

![VM management](./assets/vm_manage.webp)


## Billing History

After renting a VM, the user can view the history of charges on the **Billing page** in the **Billing History** section.

:::info
Please note that if your Balance on the Fluence platform does not have enough funds to pay for the next day of VM rental, the funds reserved when creating the VM will be used for payment. After the reserved funds are exhausted, in the next Billing cycle (the next day), the user's rent will be terminated, and the VM will be automatically deleted.
:::
The history of your charges can be found on the **Billing page** in the **Billing History** section.

![Billing history](./assets/billing_history.webp)
10 changes: 4 additions & 6 deletions docs/build/overview.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
# Overview

**Fluence Console** is one of the main ways to rent resources from the decentralized Fluence compute marketplace. It is a web-based application that allows you control the complete lifecycle of your resources and services and mange your payments and billing in one central locations.
**Fluence Console** is the convenient way to renting and managing resources from the decentralized Fluence compute marketplace. It is a web-based application that allows you to control the complete lifecycle of your resources and services including your payments and billing.

## Fluence Console Access

:::warning
Currently, Fluence Console is available only as part of the closed Alpha VM testing program.
:::info
Access to Fluence Console is currently only available to participants of the Alpha VM testing program.
:::

The Fluence Console web app is available via the following URL:

[https://console.fluence.network/sign-in](https://console.fluence.network/sign-in)
Access the Fluence Console: [https://console.fluence.network/sign-in](https://console.fluence.network/sign-in)
14 changes: 8 additions & 6 deletions docs/build/registration/registration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

## Self-Custodial Wallet

Since smart contracts are used to manage and rent resources from the Fluence network, any user interacting with the Fluence network needs to use a Web3 Blockchain wallet. However, managing a regular EOA (Externally Owned Account) address comes with certain risks and inconveniences.
As a decentralized project, self-custody over your wallet is a critical requirement for you stay in control over your data and resources. Yet, managing crypto wallets not only comes with certain limitations and pitfalls but also decouple users from well-known processes when it comes to account registration and log-ins.

To address this, our system uses a unique Self-Custodial Wallet based on a [solution from Web3Auth](https://web3auth.io/docs/how-web3auth-works), which operates on the [MPC](https://web3auth.io/docs/features/mpc) (Multi-Party Computation) protocol, instead of a standard EOA address. Thus, after a user registers through **Fluence Console**, a unique address is generated for them, and only the user has access to the private key. The private key is securely stored in parts within the distributed Web3Auth network and is protected by the MPC protocol. In turn, the Fluence protocol only has access to the user’s public address.
To address these concerns while still providing you with the self-custodial powers, our registration and login system uses the [Web3Auth](https://web3auth.io/docs/how-web3auth-works) solution, which works as follows: after you register through **Fluence Console**, a unique (wallet) address is generated and only you have access to the private key. However, the private key is securely stored in parts on Web3Auth's [MPC](https://web3auth.io/docs/features/mpc) (Multi-Party Computation) network. As a result, you have a self-custodial wallet that eliminates catastrophic (loss) failures commonly encountered with traditional, self-managed and seed-based wallets.

Of course, Fluence Console only has access to your wallet's public key.

## Registration Process

Expand All @@ -13,14 +15,14 @@ Please note that during registration, you must use the email address you provide
:::

If you are using the Fluence Console for the first time, you need to register using one of the following methods:
1. Email Passwordless
1. via Google account
1. via GitHub account
1. [Email Passwordless Login](https://web3auth.io/docs/auth-provider-setup/social-providers/email-passwordless#helper-sdks-menu)
2. Google account
3. GitHub account

:::warning
If you register with the same email through Google and Email Passwordless, two different accounts will be created for you.
:::

![registration page](./assets/registration.webp)

After successful registration, participants in the Alpha VM testing program will gain access to the full functionality of Fluence Console.
After successful registration, you have access to the Fluence Console.
20 changes: 10 additions & 10 deletions docs/build/settings/settings.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
# Fluence Console Settings

On the **Settings** page, users can manage additional features of the Fluence platform.
Use the **Settings** page to manage your SSH and API keys and more.

## SSH Keys

On **SSH keys** page, users have access to the following functionality:
1. Creating a new SSH key. Currently, the following SSH key formats are supported: RSA, ECDSA, and ED25519.
1. Deleting SSH keys.
On the **SSH keys** page, you can:
1. Create a new key of any of the RSA, ECDSA or ED25519 format.
2. Delete existing keys.

![SSH keys page](./assets/ssh_keys.webp)

## API Keys

Users of the Fluence platform have the ability to manage their infrastructure without using **Fluence Console** through the **Public API**.
Instead of using the **Fluence Console**, you can manage your resources also through our **Public API**.

:::info
In the first stage of the **Alpha VM testing**, users will not have access to the **Public API** functionality. The Fluence team will separately notify and provide the relevant documentation when this functionality becomes available.
In the first stage of the **Alpha VM testing**, you will not have access to the **Public API**. The Fluence team will notify you when this functionality becomes available.
:::

On the API Keys page, users can:
1. Create a new API key. Currently, it is possible to specify `Permissions` and `Expiration time` separately.
1. Delete an API key.
2. Delete an API key.

![API keys page](./assets/api_keys.webp)

## Advanced Settings

For each user, a separate **self-custodial wallet** is created through Web3Auth when registering through Fluence Console. However, the user’s Balances on the Fluence platform are not stored on the created addresses but in a separate **Balance smart contract** in Fluence mainnet network. On the **Advanced Settings** page, users can get information about:
1. The **public address** of the wallet created through Web3Auth.
1. The **address of the Balance smart contract** in the Fluence Mainnet network.
On the **Advanced Settings** page, users can get information about:
1. The **public address** of the wallet created through Web3Auth at the time of registration
2. The **address of the Balance smart contract** needed to track your Balance transactions

![Advanced settings page](./assets/advanced_settings.webp)
Loading