...
51
tosort/dashboard/dao_voting/dao_voting.md
Normal file
@@ -0,0 +1,51 @@
|
||||
<h1>DAO Voting</h1>
|
||||
|
||||
<h2>Table of Contents</h1>
|
||||
|
||||
- [An Introduction to the DAO concept](#an-introduction-to-the-dao-concept)
|
||||
- [Prerequisites to Vote](#prerequisites-to-vote)
|
||||
- [How to Vote for a Proposal](#how-to-vote-for-a-proposal)
|
||||
- [The Goal of the Threefold DAO](#the-goal-of-the-threefold-dao)
|
||||
|
||||
***
|
||||
|
||||
## An Introduction to the DAO concept
|
||||
|
||||
[A decentralized autonomous organization (DAO)](https://library.threefold.me/info/threefold#/decentralization/dao/threefold__dao_why) is an entity with no central leadership. Decisions get made from the bottom-up, governed by a community organized around a specific set of rules enforced on a blockchain.
|
||||
|
||||
DAOs are internet-native organizations collectively owned and managed by their members. They have built-in treasuries that are only accessible with the approval of their members. Decisions are made via proposals the group votes on during a specified period.
|
||||
|
||||
***
|
||||
|
||||
## Prerequisites to Vote
|
||||
|
||||
Voting for a DAO proposal is very simple. You first need to meet certain requirements to be able to vote.
|
||||
|
||||
* Have a [Threefold farm](../../farmers/3node_building/1_create_farm.md)
|
||||
* Have at least one active [3node server](../../faq/faq.md#i-want-to-farm-tft-with-a-3node-what-are-my-choices) on the farm
|
||||
* If you created your farm with the Threefold Connect app
|
||||
* [Import your farm on the Threefold Dashboard](../../threefold_token/storing_tft/tf_connect_app.md#move-farm-from-the-tf-connect-app-to-the-tf-portal-polkadotjs)
|
||||
|
||||
***
|
||||
|
||||
## How to Vote for a Proposal
|
||||
|
||||
To vote, you need to log into your Threefold Dashboard account, go to the DAO section of Portal and vote. Make sure to read the proposition and ask questions on the Threefold Forum proposition post if you have any.
|
||||
|
||||
You can watch this short video to learn how to vote for a Threefold DAO proposal:
|
||||
|
||||
<div class="youtubeVideoWrapper">
|
||||
<iframe title="Threefold Dashboard DAO Voting" width="560" height="315" src="https://www.youtube-nocookie.com/embed/8RvBpmloVV0" frameborder="0" allowfullscreen="" sandbox="allow-same-origin allow-scripts allow-popups"></iframe>
|
||||
</div>
|
||||
|
||||
If you have any questions, ask around on the [Threefold forum DAO section](https://forum.threefold.io/c/dao/).
|
||||
|
||||
***
|
||||
|
||||
## The Goal of the Threefold DAO
|
||||
|
||||
The goal of DAO voting system is to gather the thoughts and will of the Threefold community and build projects that are aligned with the ethos of the project.
|
||||
|
||||
We encourage anyone to share their ideas. Who knows? Your sudden spark of genius might lead to an accepted proposal on the Threefold DAO!
|
||||
|
||||
For more information on the Threefold DAO, read the [Threefold Library](https://library.threefold.me/info/threefold#/tfgrid/threefold__dao).
|
140
tosort/dashboard/dashboard.md
Normal file
@@ -0,0 +1,140 @@
|
||||
<h1> ThreeFold Dashboard </h2>
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [Introduction](#introduction)
|
||||
- [TFChain Wallet](#tfchain-wallet)
|
||||
- [Introduction](#introduction-1)
|
||||
- [Generate Account](#generate-account)
|
||||
- [Connect Your Wallet](#connect-your-wallet)
|
||||
- [Login](#login)
|
||||
- [Twin/Farm Management](#twinfarm-management)
|
||||
- [Twin Management](#twin-management)
|
||||
- [Farms Management](#farms-management)
|
||||
- [Nodes Uptime](#nodes-uptime)
|
||||
- [TFChain DAO](#tfchain-dao)
|
||||
- [Token Management](#token-management)
|
||||
- [TFChain-Stellar Bridge](#tfchain-stellar-bridge)
|
||||
- [Transferring TFT to Other TFChain Users](#transferring-tft-to-other-tfchain-users)
|
||||
- [TFGrid Explorer](#tfgrid-explorer)
|
||||
- [Exploring Threefold Nodes](#exploring-threefold-nodes)
|
||||
- [Exploring Farms](#exploring-farms)
|
||||
- [Grid Statistics](#grid-statistics)
|
||||
- [Learn More](#learn-more)
|
||||
|
||||
***
|
||||
|
||||
# Introduction
|
||||
|
||||
This section of the ThreeFold Manual introduces you to the **ThreeFold Dashboard**, a powerful tool designed to empower individuals and organizations with seamless control and management over their ThreeFold Grid resources. The ThreeFold Dashboard provides an intuitive web-based interface that allows users to effortlessly deploy, monitor, and scale their workloads on the decentralized and sustainable ThreeFold Grid infrastructure.
|
||||
|
||||
The ThreeFold Dashboard is a unified admin interface for everything related to the Threefold Grid. We now give an overview of the different features of the ThreeFold Dashboard.
|
||||
***
|
||||
|
||||
# TFChain Wallet
|
||||
|
||||
## Introduction
|
||||
|
||||
The TFChain Wallet, seamlessly integrated within the ThreeFold Dashboard, stands as a secure and user-centric gateway to the world of decentralized finance (DeFi) within the ThreeFold ecosystem. As the digital landscape evolves, the TFChain Wallet empowers users with a streamlined and intuitive interface, facilitating effortless management of digital assets and transactions on the TFGrid.
|
||||
|
||||
More than just a repository for tokens, the TFChain Wallet is designed to offer a holistic financial experience. Users can securely store, send, and receive various digital assets while enjoying the benefits of deployable decentralized weblets built on the ThreeFold Grid.
|
||||
|
||||
Throughout this manual, we will explore the intricacies of the TFChain Wallet within the ThreeFold Dashboard, delving into its key features, security measures, and its role in facilitating decentralized financial activities.
|
||||
|
||||
## Generate Account
|
||||
|
||||

|
||||

|
||||
|
||||
Mnemonics serve as your private keys, acting as your representation on the ThreeFold Grid. You can input an existing mnemonic or click the **Generate Account** button to establish an account and generate a new mnemonic. In the latter case, you will be redirected to our **Terms and Conditions** page, where acceptance is required. Afterward, the mnemonic will be automatically created and filled into the form.
|
||||
|
||||
## Connect Your Wallet
|
||||
|
||||

|
||||
|
||||
After entering your information, you can connect your wallet seamlessly.
|
||||
|
||||
## Login
|
||||
|
||||

|
||||
|
||||
Once you've logged in with the password used while connecting your wallet, you can access all of the ThreeFold Dashboard sections.
|
||||
|
||||
# Twin/Farm Management
|
||||
|
||||
## Twin Management
|
||||
|
||||

|
||||
|
||||
The TF Twin management feature of the ThreeFold Dashboard enables users to create, manage, and monitor their individual digital entities known as **Twins**. A Twin can represent a virtual machine (VM) or a container running on the ThreeFold Grid. With the Twin management, users can easily deploy and scale their workloads, allocate resources, and configure networking and storage settings for their Twins.
|
||||
|
||||
## Farms Management
|
||||
|
||||

|
||||
|
||||
The Farms management feature allows users to manage their own infrastructure, referred to as **Farms** on the ThreeFold Grid. Farms consist of servers and storage devices that contribute computing and storage capacity to the grid. Through the Farms management feature, users can add or remove, as well as monitor the health and performance of their farms, all the while efficiently using their resources.
|
||||
|
||||
### Nodes Uptime
|
||||
|
||||
Farmers can consult the Dashboard to see their 3Nodes' uptime.
|
||||
|
||||
To see the uptime of a given node, on the Dashboard go to the **Farms** section of the **Portal**, then under **Your Farm Nodes** click on the down arrow button situated on the left of the screen. On the right of the screen, you will see an icon with the uptime, as shown below:
|
||||
|
||||

|
||||
|
||||
The uptime calculation is done as follows:
|
||||
|
||||
> ((uptime - downtime) / uptime) * 100
|
||||
|
||||
***
|
||||
|
||||
# TFChain DAO
|
||||
|
||||

|
||||
|
||||
The TFChain DAO (i.e. Decentralized Autonomous Organization) feature integrates decentralized governance capabilities into the ThreeFold Dashboard. It enables community members to participate in decision-making processes and to contribute to the evolution of the ThreeFold ecosystem. Through the TFChain DAO, users can propose, vote on, and implement changes to the network protocols, policies, and operations, fostering a collaborative and inclusive environment.
|
||||
|
||||
***
|
||||
|
||||
# Token Management
|
||||
|
||||
The Token management feature allows users to securely manage their ThreeFold Tokens (TFT) directly from the ThreeFold Dashboard. Users can view their token balance, perform transactions, and manage their wallet addresses. This feature provides convenience and accessibility for users to engage in token-related activities, such as buying, selling, or transferring TFT within the ThreeFold ecosystem.
|
||||
|
||||
Users can bridge and transfer TFT within the ThreeFold ecosystem. Here's an overview of both procedures.
|
||||
|
||||
## TFChain-Stellar Bridge
|
||||
|
||||

|
||||
|
||||
The TFChain-Stellar Bridge establishes connections between the ThreeFold blockchain (TFChain) and the Stellar blockchain. This bridge enables interoperability and facilitates the exchange or utilization of TFT in a broader ecosystem.
|
||||
|
||||
For more information on the TFChain-Stellar Bridge, read [this section](../threefold_token/tft_bridges/tfchain_stellar_bridge.md).
|
||||
|
||||
## Transferring TFT to Other TFChain Users
|
||||
|
||||

|
||||
|
||||
Additionally, users can transfer TFT directly to other TFChain users via the ThreeFold Dashboard, expanding the possibilities for peer-to-peer transactions within the ThreeFold network.
|
||||
|
||||
For more information on how to transfer TFT between TFChain accounts, read [this section](./portal/dashboard_portal_ui_tokens.md).
|
||||
***
|
||||
|
||||
# TFGrid Explorer
|
||||
|
||||
The TFGrid Explorer feature provides a comprehensive view of the ThreeFold Grid infrastructure. Users can explore and analyze information related to ThreeFold nodes, farms, and grid statistics. It also provides insights into the farms contributing to the grid and their respective performance metrics. By utilizing the TFGrid Explorer, users can access detailed information about individual nodes, including their location, capacity, and availability.
|
||||
|
||||
## Exploring Threefold Nodes
|
||||
|
||||

|
||||
|
||||
## Exploring Farms
|
||||
|
||||

|
||||
|
||||
## Grid Statistics
|
||||
|
||||

|
||||
|
||||
# Learn More
|
||||
|
||||
To learn more about the TFGrid Explorer, visit [this section](./explorer/explorer_home.md) of the ThreeFold Manual.
|
97
tosort/dashboard/explorer/explorer_find_capacity.md
Normal file
@@ -0,0 +1,97 @@
|
||||
<h1> ThreeFold Nodes Explorer </h1>
|
||||
|
||||
<h2>Table of Contents</h2>
|
||||
|
||||
- [Introduction](#introduction)
|
||||
- [Nodes Explorer Links](#nodes-explorer-links)
|
||||
- [Nodes Explorer Parameters](#nodes-explorer-parameters)
|
||||
- [Nodes Explorer Filters](#nodes-explorer-filters)
|
||||
- [Note on Public IP](#note-on-public-ip)
|
||||
- [Finding a Node](#finding-a-node)
|
||||
- [Questions and Feedback](#questions-and-feedback)
|
||||
|
||||
***
|
||||
|
||||
## Introduction
|
||||
|
||||
In this section, we cover how to use the ThreeFold Nodes Explorer to find capacity on the TFGrid.
|
||||
|
||||
Using the ThreeFold Nodes Explorer is a quick way to make sure that you are deploying on a node that is optimal for your specific workload. For example, you can use the Explorer to verify that there is enough capacity on a given node for your workload requirements.
|
||||
|
||||
## Nodes Explorer Links
|
||||
|
||||
Each network has a specific Dashboard. Make sure to use the correct URL that corresponds to the network you are deploying on.
|
||||
|
||||
- [Devnet Dashboard](https://dashboard.dev.grid.tf)
|
||||
- [Nodes Explorer](https://dashboard.dev.grid.tf/#/deploy/nodes)
|
||||
- [Qanet Dashboard](https://dashboard.qa.grid.tf)
|
||||
- [Nodes Explorer](https://dashboard.qa.grid.tf/explorer/nodes)
|
||||
- [Testnet Dashboard](https://dashboard.test.grid.tf)
|
||||
- [Nodes Explorer](https://dashboard.test.grid.tf/explorer/nodes)
|
||||
- [Mainnet Dashboard](https://dashboard.grid.tf)
|
||||
- [Nodes Explorer](https://dashboard.grid.tf/explorer/nodes)
|
||||
|
||||
## Nodes Explorer Parameters
|
||||
|
||||
There are many ways to use the Nodes Explorer.
|
||||
|
||||
To search only nodes with GPU, click on the toggle button **GPU Node (Only)**.
|
||||
|
||||

|
||||
|
||||
To search only gateway nodes, click on the toggle button **Gateways (Only)**.
|
||||
|
||||

|
||||
|
||||
On the right of the window, there is a drop-down menu to filter nodes based on their status: **Up**, **Down** and **Standby**. By default, this is set to **Up**.
|
||||
|
||||

|
||||
|
||||
Note that you can combine all those parameters.
|
||||
|
||||
## Nodes Explorer Filters
|
||||
|
||||
You can use different filters to narrow down your search. They are as follows:
|
||||
|
||||
- Node ID
|
||||
- Twin ID
|
||||
- Farm IDs
|
||||
- Farm Name
|
||||
- Country Full Name
|
||||
- Free SRU (GB)
|
||||
- Total HRU (GB)
|
||||
- Total MRU (GB)
|
||||
- Total CRU (Cores)
|
||||
- Free Public IP
|
||||
|
||||
### Note on Public IP
|
||||
|
||||
If you want to find a node with a public IP, it is recommended to set the filter **Free Public IP** to at least **2**. This will make sure that the public IP of the nodes presented to you are properly set.
|
||||
|
||||
## Finding a Node
|
||||
|
||||
To give you an overview of the search process, let's look for a node in Belgium with at least 4GB of SSD storage, 2GB of memory and an available public IP. We simply select those filters in the filter menu and set the filter information:
|
||||
|
||||

|
||||
|
||||
The nodes corresponding to your search are then presented to you:
|
||||
|
||||

|
||||
|
||||
At any time, you can click on a given node to see the node information:
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
You can also click on **Check Node Metrics** to see the node information on Grafana. Using Grafana can be quite useful to get some very precise node data.
|
||||
|
||||

|
||||
|
||||
Once you've found a proper node for your deployment, take note of its node ID. There are different ways to deploy on a node. For example, you can use [Terraform](../../terraform/terraform_readme.md) or [Pulumi](../../pulumi/pulumi_readme.md).
|
||||
|
||||
## Questions and Feedback
|
||||
|
||||
If you have any questions, you can ask the ThreeFold community for help on the [ThreeFold Forum](http://forum.threefold.io/) or on the [ThreeFold Grid Tester Community](https://t.me/threefoldtesting) on Telegram. You can also reach the [ThreeFold Support](https://threefoldfaq.crisp.help/en/) for help.
|
39
tosort/dashboard/explorer/explorer_gpu_support.md
Normal file
@@ -0,0 +1,39 @@
|
||||
<h1> GPU Support </h1>
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [Introduction](#introduction)
|
||||
- [ThreeFold Explorer](#threefold-explorer)
|
||||
- [Statistics View](#statistics-view)
|
||||
|
||||
***
|
||||
|
||||
## Introduction
|
||||
|
||||
The ThreeFold Explorer is a powerful tool that empowers users to navigate and interact with the ThreeFold Grid seamlessly. Offering a comprehensive Statistics View, the TF Explorer provides real-time insights into the network, enabling users to make informed decisions and optimize their experiences within the decentralized ecosystem.
|
||||
|
||||
One of the groundbreaking advancements introduced in the ThreeFold Grid is the support for GPUs. This addition opens up new possibilities for users seeking enhanced computational capabilities. However, it's important to note that, to leverage GPU support, users must rent the entire 3Node as a dedicated server. This ensures the optimal utilization of GPU resources and provides users with a dedicated environment for deploying GPU-accelerated workloads on the TFGrid.
|
||||
|
||||
## ThreeFold Explorer
|
||||
|
||||

|
||||
|
||||
- A new filter for GPU supported node is now available on the TF Explorer
|
||||
- GPU count
|
||||
- Filtering capabilities based on the model / device
|
||||
|
||||
On the details pages is shown the card information and its status (`reserved` or `available`) also the ID that’s needed to be used during deployments is easily accessible and has a copy to clipboard button.
|
||||
|
||||

|
||||
|
||||
Here’s an example of how it looks in case of reserved
|
||||
|
||||

|
||||
|
||||
The TF Dashboard is where to reserve the nodes the farmer should be able to set the extra fees on the form and the user also should be able to reserve and get the details of the node (cost including the extrafees, GPU informations).
|
||||
|
||||
## Statistics View
|
||||
|
||||
A simple card with GPUs count been added.
|
||||
|
||||

|
203
tosort/dashboard/explorer/explorer_graphql_intro.md
Normal file
@@ -0,0 +1,203 @@
|
||||
<h1> A Glimpse Into GraphQL </h1>
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [Introduction](#introduction)
|
||||
- [Get Started](#get-started)
|
||||
- [GraphQL Examples](#graphql-examples)
|
||||
- [Getting Many Nodes](#getting-many-nodes)
|
||||
- [Finding Gateways](#finding-gateways)
|
||||
- [Finding Farms with Public IPs](#finding-farms-with-public-ips)
|
||||
- [Finding Nodes on a Specific Farm](#finding-nodes-on-a-specific-farm)
|
||||
- [Finding Nodes by Country](#finding-nodes-by-country)
|
||||
- [Filtering Nodes with GPU Devices](#filtering-nodes-with-gpu-devices)
|
||||
- [Finding Nodes by Capacity](#finding-nodes-by-capacity)
|
||||
- [Filtering Nodes with Specific Capacity](#filtering-nodes-with-specific-capacity)
|
||||
- [GraphQL and the ThreeFold Explorer](#graphql-and-the-threefold-explorer)
|
||||
|
||||
***
|
||||
|
||||
## Introduction
|
||||
|
||||
[GraphQL](https://graphql.org/), or Graph Query Language, is a powerful and flexible query language used for accessing and manipulating data. It serves as a fundamental component in the ThreeFold Grid ecosystem, offering a standardized and efficient means to interact with and retrieve information from various ThreeFold networks.
|
||||
|
||||
GraphQL allows users to request specific data they need, making it a more dynamic alternative to traditional REST APIs.
|
||||
|
||||
In the context of TFGrid, GraphQL plays a pivotal role in indexing and organizing information related to TFChain, the decentralized blockchain technology powering the ThreeFold ecosystem. TFChain's data, including information about nodes, transactions, and network status, is indexed over GraphQL, providing a unified interface for querying the ThreeFold networks (Devnet, Qanet, Testnet, and Mainnet).
|
||||
|
||||
## Get Started
|
||||
|
||||
Information on TFChain is indexed over GraphQL and is available for queries.
|
||||
|
||||
You can query the following ThreeFold networks with GraphQL:
|
||||
|
||||
- [Devnet GraphQL](https://graphql.dev.grid.tf/graphql)
|
||||
- [Qanet GraphQL](https://graphql.qa.grid.tf/graphql)
|
||||
- [Testnet GraphQL](https://graphql.test.grid.tf/graphql)
|
||||
- [Mainnet GraphQL](https://graphql.grid.tf/graphql)
|
||||
|
||||
The GraphQL interface used to query TF-Chain is the one offered by [Subsquid](https://docs.subsquid.io/). See more info on supported queries [here](https://docs.subsquid.io/query-squid/).
|
||||
|
||||
***
|
||||
|
||||
## GraphQL Examples
|
||||
|
||||
We present here some example on how to use GraphQL to query the ThreeFold Grid and find suitable nodes depending on your specific needs.
|
||||
***
|
||||
### Getting Many Nodes
|
||||
|
||||
```graphql
|
||||
query MyQuery {
|
||||
nodes(orderBy: nodeId_ASC, limit: 5000, where: {
|
||||
cru_gt: "2", hru_gt: "500000000", mru_gt: "50000000", sru_gt: "1000000000",
|
||||
deletedAt_eq: null
|
||||
})
|
||||
{
|
||||
twinId
|
||||
city
|
||||
certificationType
|
||||
country
|
||||
created
|
||||
createdById
|
||||
cru
|
||||
farmId
|
||||
hru
|
||||
id
|
||||
uptime
|
||||
version
|
||||
mru
|
||||
sru
|
||||
nodeId
|
||||
interfaces {
|
||||
ips
|
||||
name
|
||||
node {
|
||||
city
|
||||
country
|
||||
cru
|
||||
hru
|
||||
sru
|
||||
mru
|
||||
}
|
||||
}
|
||||
location {
|
||||
latitude
|
||||
longitude
|
||||
}
|
||||
publicConfig {
|
||||
domain
|
||||
gw4
|
||||
gw6
|
||||
ipv4
|
||||
ipv6
|
||||
}
|
||||
deletedById
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
```
|
||||
***
|
||||
### Finding Gateways
|
||||
|
||||
gateway typically needs to be a node with public ipv4 or ipv6 and a domain configured otherwise it won't be able to create `NameContracts`
|
||||
|
||||
```graphql
|
||||
query MyQuery {
|
||||
nodes {
|
||||
nodeId
|
||||
publicConfig {
|
||||
domain
|
||||
ipv4
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
***
|
||||
### Finding Farms with Public IPs
|
||||
|
||||
```graphql
|
||||
query MyQuery {
|
||||
farms {
|
||||
farmId
|
||||
name
|
||||
|
||||
publicIPs {
|
||||
ip
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
***
|
||||
### Finding Nodes on a Specific Farm
|
||||
|
||||
```graphql
|
||||
query MyQuery {
|
||||
nodes(where: {farmId_eq: 1}) {
|
||||
twinId
|
||||
}
|
||||
}
|
||||
```
|
||||
***
|
||||
### Finding Nodes by Country
|
||||
|
||||
```graphql
|
||||
query MyQuery {
|
||||
nodes(where: {country_eq: "BE"}) {
|
||||
twinId
|
||||
}
|
||||
}
|
||||
```
|
||||
***
|
||||
### Filtering Nodes with GPU Devices
|
||||
|
||||
```graphql
|
||||
query MyQuery {
|
||||
nodes(where: {hasGpu_eq: true}) {
|
||||
hasGpu
|
||||
id
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
***
|
||||
### Finding Nodes by Capacity
|
||||
|
||||
```graphql
|
||||
query MyQuery {
|
||||
nodes() {
|
||||
cru,
|
||||
hru,
|
||||
mru,
|
||||
sru,
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
> Note that the cru are in bytes.
|
||||
***
|
||||
### Filtering Nodes with Specific Capacity
|
||||
|
||||
```graphql
|
||||
query MyQuery {
|
||||
nodes(where: {cru_gt: "2", hru_gt: "500000000", mru_gt: "50000000", sru_gt: "1000000000"}) {
|
||||
nodeId
|
||||
cru
|
||||
hru
|
||||
mru
|
||||
sru
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
> Note that the cru are in bytes.
|
||||
|
||||
***
|
||||
|
||||
## GraphQL and the ThreeFold Explorer
|
||||
|
||||
Note that most of those examples have their equivalent searches available in our [ThreeFold Explorer](https://dashboard.grid.tf/explorer/nodes).
|
111
tosort/dashboard/explorer/explorer_home.md
Normal file
@@ -0,0 +1,111 @@
|
||||
<h1> ThreeFold Explorer </h1>
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [Introduction](#introduction)
|
||||
- [ThreeFold Explorer Links](#threefold-explorer-links)
|
||||
- [ExplorerUI](#explorerui)
|
||||
- [Statistics](#statistics)
|
||||
- [Exploring Farms](#exploring-farms)
|
||||
- [Farm Details](#farm-details)
|
||||
- [Exploring Nodes](#exploring-nodes)
|
||||
- [Light and Dark Modes](#light-and-dark-modes)
|
||||
- [Map Capacity Distribution](#map-capacity-distribution)
|
||||
|
||||
***
|
||||
|
||||
## Introduction
|
||||
|
||||
The ThreeFold Explorer serves as a powerful and intuitive tool within the ThreeFold Dashboard specifically designed to empower users in navigating and interacting with the ThreeFold Grid.
|
||||
|
||||
At its core, the TF Explorer is a comprehensive platform that enables users to discover nodes within the grid that align with their specific requirements, facilitating a seamless and efficient exploration of the decentralized network. Whether you are seeking computational resources, specific geographic locations, or specialized hardware configurations, the ThreeFold Explorer provides a user-friendly interface to effortlessly identify and connect with nodes that best suit your needs.
|
||||
|
||||
Throughout this manual, we will delve into the intricacies of the ThreeFold Explorer, highlighting key features, utilization strategies, and best practices for harnessing its capabilities effectively.
|
||||
|
||||
## ThreeFold Explorer Links
|
||||
|
||||
The ThreeFold Explorer can give insights into the different ThreeFold networks. Each ThreeFold network has an associated ThreeFold Explorer. You can use the ThreeFold Explorer to query information about ThreeFold Statistics, Nodes and Farms. The links are the following:
|
||||
|
||||
- [Devnet Dashboard](https://dashboard.dev.grid.tf)
|
||||
- [Statistics](https://dashboard.dev.grid.tf/#/tf-grid/stats)
|
||||
- [Nodes](https://dashboard.dev.grid.tf/#/deploy/nodes)
|
||||
- [Farms](https://dashboard.dev.grid.tf/#/farms/farm-finder)
|
||||
- [Qanet Dashboard](https://dashboard.qa.grid.tf)
|
||||
- [Statistics](https://dashboard.qa.grid.tf/explorer/statistics)
|
||||
- [Nodes](https://dashboard.qa.grid.tf/explorer/nodes)
|
||||
- [Farms](https://dashboard.qa.grid.tf/explorer/farms)
|
||||
- [Testnet Dashboard](https://dashboard.test.grid.tf)
|
||||
- [Statistics](https://dashboard.test.grid.tf/explorer/statistics)
|
||||
- [Nodes](https://dashboard.test.grid.tf/explorer/nodes)
|
||||
- [Farms](https://dashboard.test.grid.tf/explorer/farms)
|
||||
- [Mainnet Dashboard](https://dashboard.grid.tf)
|
||||
- [Statistics](https://dashboard.grid.tf/explorer/statistics)
|
||||
- [Nodes](https://dashboard.grid.tf/explorer/nodes)
|
||||
- [Farms](https://dashboard.grid.tf/explorer/farms)
|
||||
|
||||
When you open an Explorer link, you will be asked to log in, but this is optional. You can simply close the login window and consult the Explorer.
|
||||
|
||||
|
||||
|
||||
## ExplorerUI
|
||||

|
||||
|
||||
Explorer UI helps exploring the capacity connected to Threefold Grid. Searching for nodes, farms, gateways .. etc. It also supports Dark mode for more comfortable navigation.
|
||||
|
||||
### Statistics
|
||||
|
||||

|
||||
|
||||
Here you can see generic overview about:
|
||||
|
||||
- Number of farms
|
||||
- Number of nodes
|
||||
- Number of gateways
|
||||
- Number of twins
|
||||
- Number of contracts
|
||||
- The capacity CRU, SRU, HRU, MRU
|
||||
- The number of public IPs available
|
||||
|
||||
### Exploring Farms
|
||||
|
||||
You can see a list of all farms with filtering options.
|
||||
|
||||

|
||||
|
||||
### Farm Details
|
||||
|
||||
Click on a farm shows up the farm details information.
|
||||
|
||||

|
||||
|
||||
### Exploring Nodes
|
||||
|
||||
Explorer UI allows exploring the nodes and filtering them by many filtering option.
|
||||
|
||||

|
||||
|
||||
You can see all of the node details by clicking on a node record.
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
|
||||
## Light and Dark Modes
|
||||
|
||||
Both light and dark modes are supported on the ThreeFold Explorer. Click on the icon in the upper right corner of the screen to change the view mode.
|
||||
|
||||

|
||||
|
||||
|
||||
|
||||
## Map Capacity Distribution
|
||||
|
||||
You can also see a map of how the capacity is distributed.
|
||||
A map is available with a global overview, showing in which countries capacity is offered.
|
||||
|
||||

|
||||
|
||||
|
||||
|
||||
|
6
tosort/dashboard/explorer/explorer_list.md
Normal file
@@ -0,0 +1,6 @@
|
||||
|
||||
- [Devnet Explorer](https://dashboard.dev.grid.tf)
|
||||
- [Qanet Explorer](https://dashboard.qa.grid.tf)
|
||||
- [Testnet Explorer](https://dashboard.test.grid.tf)
|
||||
- [Mainnet explorer](https://dashboard.grid.tf)
|
||||
<!-- - Overview of all nodes in the world, over all nets https://explorer.threefold.io/ (not useful to find node on specific net). ==> comment because it's pointing to TFGrid 2-->
|
11
tosort/dashboard/explorer/explorer_report_issues.md
Normal file
@@ -0,0 +1,11 @@
|
||||
## Report Explorer Bugs:
|
||||
|
||||
!!!include:report_issue_fr_include
|
||||
|
||||
### If you are an expert user
|
||||
|
||||
Please open a github issue in [grid_explorer_ui repo](https://github.com/threefoldtech/tfgrid_dashboard)
|
||||
|
||||
Also to plan your deployment beyond the explorer capabilities you can use these [graphql example queries](explorer_graphql_examples)
|
||||
|
||||
!!!include:explorer_toc
|
6
tosort/dashboard/explorer/explorer_toc.md
Normal file
@@ -0,0 +1,6 @@
|
||||
## Explorer Information
|
||||
|
||||
- [Find Capacity](explorer_find_capacity)
|
||||
<!-- - [GraphQL Support](explorer_graphql_intro) -->
|
||||
- [User Interface](explorer_ui)
|
||||
- [Report Issues or Ask For Features](explorer_report_issues)
|
48
tosort/dashboard/explorer/explorer_ui.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# Explorer UI
|
||||
|
||||

|
||||
|
||||
Explorer UI helps exploring the capacity connected to Threefold Grid. Searching for nodes, farms, gateways .. etc. It also supports Dark mode for more comfortable navigation.
|
||||
|
||||
## Statistics
|
||||
|
||||

|
||||
|
||||
Here you can see generic overview about
|
||||
|
||||
- number of farms
|
||||
- number of nodes
|
||||
- number of gateways
|
||||
- number of twins
|
||||
- number of contracts
|
||||
- the capacity CRU, SRU, HRU, MRU
|
||||
- the number of public IPs available
|
||||
|
||||
## Exploring farms
|
||||
|
||||
You can see a list of all farms with filtering options
|
||||

|
||||
|
||||
## Farm details
|
||||
|
||||
Click on a farm shows up the farm details information
|
||||

|
||||
|
||||
## Exploring nodes
|
||||
|
||||
Explorer UI allows exploring the nodes and filtering them by many filtering option
|
||||

|
||||
|
||||
You can see all of the node details by clicking on a node record.
|
||||
|
||||

|
||||

|
||||
|
||||
Lightmode is supported. Click on the icon in the upper right corner of the screen.
|
||||
|
||||

|
||||
|
||||
Can also see a map of how the capacity is distributed.
|
||||
A map is available with a global overview, showing in which countries capacity is offered.
|
||||
|
||||

|
BIN
tosort/dashboard/img/dashboard_T&C.png
Normal file
After Width: | Height: | Size: 656 KiB |
BIN
tosort/dashboard/img/dashboard_bridge.png
Normal file
After Width: | Height: | Size: 52 KiB |
BIN
tosort/dashboard/img/dashboard_connect.png
Normal file
After Width: | Height: | Size: 93 KiB |
BIN
tosort/dashboard/img/dashboard_dao.png
Normal file
After Width: | Height: | Size: 67 KiB |
BIN
tosort/dashboard/img/dashboard_explorer_farms.png
Normal file
After Width: | Height: | Size: 100 KiB |
BIN
tosort/dashboard/img/dashboard_explorer_nodes.png
Normal file
After Width: | Height: | Size: 120 KiB |
BIN
tosort/dashboard/img/dashboard_explorer_statistics.png
Normal file
After Width: | Height: | Size: 255 KiB |
BIN
tosort/dashboard/img/dashboard_generate_account.png
Normal file
After Width: | Height: | Size: 70 KiB |
BIN
tosort/dashboard/img/dashboard_login.png
Normal file
After Width: | Height: | Size: 130 KiB |
BIN
tosort/dashboard/img/dashboard_portal_account.png
Normal file
After Width: | Height: | Size: 37 KiB |
BIN
tosort/dashboard/img/dashboard_portal_create_account_1.png
Normal file
After Width: | Height: | Size: 137 KiB |
BIN
tosort/dashboard/img/dashboard_portal_create_account_2.png
Normal file
After Width: | Height: | Size: 123 KiB |
BIN
tosort/dashboard/img/dashboard_portal_create_farm.png
Normal file
After Width: | Height: | Size: 8.7 KiB |
BIN
tosort/dashboard/img/dashboard_portal_create_twin.png
Normal file
After Width: | Height: | Size: 29 KiB |
BIN
tosort/dashboard/img/dashboard_portal_deposit_tft.png
Normal file
After Width: | Height: | Size: 64 KiB |
BIN
tosort/dashboard/img/dashboard_portal_farm.png
Normal file
After Width: | Height: | Size: 47 KiB |
BIN
tosort/dashboard/img/dashboard_portal_farm0.png
Normal file
After Width: | Height: | Size: 26 KiB |
BIN
tosort/dashboard/img/dashboard_portal_farms.png
Normal file
After Width: | Height: | Size: 59 KiB |
BIN
tosort/dashboard/img/dashboard_portal_fill_ipv6.png
Normal file
After Width: | Height: | Size: 68 KiB |
BIN
tosort/dashboard/img/dashboard_portal_ip_add.png
Normal file
After Width: | Height: | Size: 5.8 KiB |
BIN
tosort/dashboard/img/dashboard_portal_ip_add_detail.png
Normal file
After Width: | Height: | Size: 20 KiB |
BIN
tosort/dashboard/img/dashboard_portal_ip_add_detail_range.png
Normal file
After Width: | Height: | Size: 24 KiB |
BIN
tosort/dashboard/img/dashboard_portal_ip_result.png
Normal file
After Width: | Height: | Size: 10 KiB |
BIN
tosort/dashboard/img/dashboard_portal_node_info.png
Normal file
After Width: | Height: | Size: 83 KiB |
BIN
tosort/dashboard/img/dashboard_portal_stellar.png
Normal file
After Width: | Height: | Size: 18 KiB |
BIN
tosort/dashboard/img/dashboard_portal_terms_conditions.png
Normal file
After Width: | Height: | Size: 666 KiB |
BIN
tosort/dashboard/img/dashboard_portal_transaction_sign.png
Normal file
After Width: | Height: | Size: 157 KiB |
BIN
tosort/dashboard/img/dashboard_portal_transfer.png
Normal file
After Width: | Height: | Size: 51 KiB |
BIN
tosort/dashboard/img/dashboard_portal_transfer_detail.png
Normal file
After Width: | Height: | Size: 23 KiB |
BIN
tosort/dashboard/img/dashboard_portal_twin.png
Normal file
After Width: | Height: | Size: 55 KiB |
BIN
tosort/dashboard/img/dashboard_portal_twin_created.png
Normal file
After Width: | Height: | Size: 64 KiB |
BIN
tosort/dashboard/img/dashboard_portal_ui_nodes_minting.png
Normal file
After Width: | Height: | Size: 64 KiB |
BIN
tosort/dashboard/img/dashboard_portal_withdraw_tft.png
Normal file
After Width: | Height: | Size: 31 KiB |
BIN
tosort/dashboard/img/dashboard_sidebar_portal.png
Normal file
After Width: | Height: | Size: 22 KiB |
BIN
tosort/dashboard/img/dashboard_statistics.png
Normal file
After Width: | Height: | Size: 28 KiB |
BIN
tosort/dashboard/img/dashboard_swap.png
Normal file
After Width: | Height: | Size: 62 KiB |
BIN
tosort/dashboard/img/dashboard_uptime.png
Normal file
After Width: | Height: | Size: 61 KiB |
BIN
tosort/dashboard/img/dedicated_nodes.png
Normal file
After Width: | Height: | Size: 50 KiB |
BIN
tosort/dashboard/img/dedicated_nodes_discounts.png
Normal file
After Width: | Height: | Size: 32 KiB |
BIN
tosort/dashboard/img/explorer_basics_.png
Normal file
After Width: | Height: | Size: 124 KiB |
BIN
tosort/dashboard/img/explorer_basics_2.png
Normal file
After Width: | Height: | Size: 270 KiB |
BIN
tosort/dashboard/img/explorer_darkmode.png
Normal file
After Width: | Height: | Size: 104 KiB |
BIN
tosort/dashboard/img/explorer_farm_details.png
Normal file
After Width: | Height: | Size: 26 KiB |
BIN
tosort/dashboard/img/explorer_farms.png
Normal file
After Width: | Height: | Size: 100 KiB |
BIN
tosort/dashboard/img/explorer_find_country_pubip.png
Normal file
After Width: | Height: | Size: 120 KiB |
BIN
tosort/dashboard/img/explorer_gpu.png
Normal file
After Width: | Height: | Size: 57 KiB |
BIN
tosort/dashboard/img/explorer_grafana.png
Normal file
After Width: | Height: | Size: 190 KiB |
BIN
tosort/dashboard/img/explorer_node_details.png
Normal file
After Width: | Height: | Size: 73 KiB |
BIN
tosort/dashboard/img/explorer_node_example_1.png
Normal file
After Width: | Height: | Size: 30 KiB |
BIN
tosort/dashboard/img/explorer_node_example_2.png
Normal file
After Width: | Height: | Size: 94 KiB |
BIN
tosort/dashboard/img/explorer_node_resources_1.png
Normal file
After Width: | Height: | Size: 25 KiB |
BIN
tosort/dashboard/img/explorer_node_resources_2.png
Normal file
After Width: | Height: | Size: 124 KiB |
BIN
tosort/dashboard/img/explorer_node_resources_3.png
Normal file
After Width: | Height: | Size: 55 KiB |
BIN
tosort/dashboard/img/explorer_nodes.png
Normal file
After Width: | Height: | Size: 90 KiB |
BIN
tosort/dashboard/img/explorer_nodes_distribution.png
Normal file
After Width: | Height: | Size: 277 KiB |
BIN
tosort/dashboard/img/explorer_statistics.png
Normal file
After Width: | Height: | Size: 77 KiB |
BIN
tosort/dashboard/img/explorer_status.png
Normal file
After Width: | Height: | Size: 15 KiB |
BIN
tosort/dashboard/img/explorer_toggle_gateways.png
Normal file
After Width: | Height: | Size: 7.0 KiB |
BIN
tosort/dashboard/img/explorer_toggle_gpu.png
Normal file
After Width: | Height: | Size: 7.0 KiB |
BIN
tosort/dashboard/img/gpu_details.png
Normal file
After Width: | Height: | Size: 25 KiB |
BIN
tosort/dashboard/img/gpu_details_reserved.png
Normal file
After Width: | Height: | Size: 27 KiB |
BIN
tosort/dashboard/img/node_detail_.png
Normal file
After Width: | Height: | Size: 178 KiB |
BIN
tosort/dashboard/img/node_detail_1.png
Normal file
After Width: | Height: | Size: 49 KiB |
BIN
tosort/dashboard/img/node_info.png
Normal file
After Width: | Height: | Size: 51 KiB |
BIN
tosort/dashboard/img/polkadot_extension_.png
Normal file
After Width: | Height: | Size: 241 KiB |
BIN
tosort/dashboard/img/rented_succeeded.png
Normal file
After Width: | Height: | Size: 8.8 KiB |
76
tosort/dashboard/portal/dashboard_portal_dedicated_nodes.md
Normal file
@@ -0,0 +1,76 @@
|
||||
<h1> Dedicated Nodes </h1>
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [What is a Dedicated Node?](#what-is-a-dedicated-node)
|
||||
- [Description](#description)
|
||||
- [Billing \& Pricing](#billing--pricing)
|
||||
- [Discounts](#discounts)
|
||||
- [Usage](#usage)
|
||||
- [GPU Support](#gpu-support)
|
||||
|
||||
***
|
||||
|
||||
## What is a Dedicated Node?
|
||||
|
||||
Dedicated nodes are 3Nodes that can be reserved and rented entirely by one user. The user can thus reserve an entire node and use it exclusively to deploy solutions. This feature is ideal for users who want to host heavy deployments with the benefits of high reliability and cost effectiveness.
|
||||
|
||||
|
||||
## Description
|
||||
|
||||
- Node reserved with deploying a `RentContract` on this node. node can has only one rentContract.
|
||||
- When a user create a RentContract against a node, the grid validate that there are no other active contracts on that node on the creation.
|
||||
- Once a RentContract is created, the grid can only accept contracts on this node from the tenant.
|
||||
- Only workloads from the tenant are accepted
|
||||
|
||||
## Billing & Pricing
|
||||
|
||||
- Once a node is rented, there is a fixed charge billed to the tenant regardless of deployed workloads.
|
||||
- Any subsequent NodeContract deployed on a node where a rentContract is active (and the same user is creating the nodeContracts) can be excluded from billing (apart from public ip and network usage).
|
||||
- Billing rates are calculated hourly on the TFGrid.
|
||||
- While some of the documentation mentions a monthly price, the chain expresses pricing per hour. The monthly price shown within the manual is offered as a convenience to users, as it provides a simple way to estimate costs.
|
||||
|
||||
## Discounts
|
||||
|
||||
- Received Discounts for renting a node on TFGrid internet capacity
|
||||
- 50% for dedicated node (TF Pricing policies)
|
||||
- A second level discount up to 60% for balance level see [Discount Levels](../../wiki/cloudunits/pricing/staking_discount_levels.md)
|
||||
- Discounts are calculated every time the grid bills by checking the available TFT balance on the user wallet and seeing if it is sufficient to receive a discount. As a result, if the user balance drops below the treshold of a given discount, the deployment price increases.
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
- See list of all dedicated node on `Dedicated Nodes` tab on the portal.
|
||||
|
||||

|
||||
|
||||
- Hover over the price to see the applied discounts
|
||||
|
||||

|
||||
|
||||
- Expand row to see more info on the node:
|
||||
|
||||

|
||||
- Resources
|
||||
- Location
|
||||
- Possible Public Ips *this depends on the farm it belongs to*
|
||||
|
||||
- You can see the nodes in 3 states:
|
||||
- Free
|
||||
- Reserved *Owned by current twin*
|
||||
- Taken *Owned by another twin*
|
||||
- Reserve a node:
|
||||
- If node is not rented by another twin you can simply click reserve.
|
||||
- Type your password on the polkadot pop up window.
|
||||
- Wait for the pop up message said `Transaction succeeded`
|
||||
|
||||

|
||||
|
||||
- Unreserve a node:
|
||||
- Simply as reserving but another check will be done to check you don't have any active workloads on the node before unreserving.
|
||||
|
||||
## GPU Support
|
||||
|
||||
To use a GPU on the TFGrid, users need to rent a dedicated node. Once they have rented a dedicated node equipped with a GPU, users can deploy workloads on their dedicated GPU node.
|
||||
|
||||
For more information on GPU support, please read the [GPU section](../../gpu/gpu_toc.md) of the manual.
|
41
tosort/dashboard/portal/dashboard_portal_home.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# TF-Chain Portal
|
||||
|
||||
The TFChain Portal is a central hub within the ThreeFold Dashboard built for users to manage their accounts, perform transactions, explore network capacities, and engage with the ThreeFold Grid decentralized infrastructure.
|
||||
|
||||
Whether you're exploring the development network (Devnet), the quality assurance network (Qanet), the testing network (Testnet), or the production network (Mainnet), this manual will guide you through the essential functionalities of the TF-Chain Portal. So, let's get started!
|
||||
|
||||
|
||||
## Currently on:
|
||||
- [Devnet](https://dashboard.dev.grid.tf/)
|
||||
- [Qanet](https://dashboard.qa.grid.tf/)
|
||||
- [Testnet](https://dashboard.test.grid.tf/)
|
||||
- [Mainnet](https://dashboard.grid.tf/)
|
||||
|
||||

|
||||
|
||||
## Installation and activation
|
||||
|
||||
Follow the [Getting Started](../../getstarted/tfgrid3_getstarted.md) to make sure your TFChain account set up.
|
||||
|
||||
## Transfer TFT
|
||||
|
||||
- [Manage your Tokens on TFChain](../portal/dashboard_portal_ui_tokens.md) e.g. transfer TFT to TFChain
|
||||
|
||||
## Be a Farmer, manage your information
|
||||
|
||||
- [Activate your farmer account and nodes on TFChain](./dashboard_portal_ui_farming.md)
|
||||
|
||||
## Capacity Explorer
|
||||
|
||||
In the upper right corner, you can click on `EXPLORER` to get a view of all capacity connected to TFGrid v3. For more info, see [here](../explorer/explorer_home.md).
|
||||
|
||||
## Modify you Twin Info
|
||||
|
||||
A twinIP can be edited at any moment. Simply update the field and sign afterwards.
|
||||
Probably not needed right now.
|
||||
|
||||
|
||||
## Dedicated Nodes
|
||||
|
||||
Rent a whole node to serve your solutions.
|
||||
[Dedicated Nodes](./dashboard_portal_dedicated_nodes.md)
|
5
tosort/dashboard/portal/dashboard_portal_list.md
Normal file
@@ -0,0 +1,5 @@
|
||||
|
||||
- on [Devnet](https://dashboard.dev.grid.tf/)
|
||||
- on [Qanet](https://dashboard.qa.grid.tf/)
|
||||
- on [Testnet](https://dashboard.test.grid.tf/)
|
||||
- on [Mainnet](https://dashboard.grid.tf/)
|
@@ -0,0 +1,24 @@
|
||||
|
||||
# Create an Account for TFChain using Polkadot UI
|
||||
|
||||
> make sure [extension is installed](./dashboard_portal_polkadot_widget.md)
|
||||
|
||||
You will be asked to create a new account or to recover an existing account.
|
||||
|
||||
When creating a new account, the mnemonic seed words will be shown, which can be used to recover your wallet.
|
||||
|
||||
> Keep them in a safe place, they give access to the TFTs that you will hold on the TFGrid.
|
||||
|
||||

|
||||
|
||||
In the next screen, you can choose a network. Select `Allow use on any chain`. Give your account a name and a password for easy access from your local hardware. With this information, the account can be generated.
|
||||
|
||||

|
||||
|
||||
Once the account is generated, activate it by accepting the Terms & Conditions. You will get prompted to sign in the Polkadot extension.
|
||||
|
||||

|
||||
|
||||
|
||||
>> PLEASE DO NOT FORGET TO REMEMBER YOUR MNEMONIC WORDS, YOU WILL NEED THEM IN NEXT STEPS.
|
||||
|
17
tosort/dashboard/portal/dashboard_portal_polkadot_widget.md
Normal file
@@ -0,0 +1,17 @@
|
||||
|
||||
# Polkadot Extension
|
||||
|
||||

|
||||
|
||||
## What does it do
|
||||
|
||||
This browser extension manages accounts and allows the signing of transactions with those accounts. It does not inject providers for use by dapps at this early point, nor does it perform wallet functions, e.g send funds.
|
||||
|
||||
## Install
|
||||
|
||||
Before using the tfchain_portal, you need to install a Polkadot extension.
|
||||
|
||||
It can be installed from [here](https://polkadot.js.org/extension/).
|
||||
|
||||
Extensions are available for the Google Chrome and Firefox browsers.
|
||||
|
7
tosort/dashboard/portal/dashboard_portal_toc.md
Normal file
@@ -0,0 +1,7 @@
|
||||
## More Info
|
||||
|
||||
- [Dashboard Portal Home](dashboard_portal_home)
|
||||
- [Install Polkadot Widget](dashboard_portal_polkadot_widget)
|
||||
- [Activate your account on TFChain](dashboard_portal_ui_activation)
|
||||
- [Manage your Tokens on TFChain](dashboard_portal_ui_tokens) e.g. transfer TFT to TFChain
|
||||
- [Activate your farmer account and nodes on TFChain](dashboard_portal_ui_farming)
|
17
tosort/dashboard/portal/dashboard_portal_transfer.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# TF-Chain Portal Transfer
|
||||
|
||||
## Transfer TFT between TFChain accounts
|
||||
|
||||
The portal can be used to transfer TFTs between 2 accounts that exist on the same chain.
|
||||
|
||||
> Remark: testnet and mainnet both have the same TFTs but as the 2 chains are different, there is no way to do a direct transfer between accounts on testnet and on mainnet.
|
||||
|
||||

|
||||
|
||||
Click on `Transfer` in the sidebar to get the transfer screen.
|
||||
|
||||

|
||||
|
||||
Fill in the recipient address, the amount of tokens to transfer, and click on `Submit`. Sign in the extension screen, and you're done !
|
||||
|
||||
There is no transfer fee, just a signing fee of 0.001 TFT.
|
33
tosort/dashboard/portal/dashboard_portal_ui_activation.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# TF-Chain Portal Activation
|
||||
|
||||
## Go to the Portal
|
||||
|
||||
- [Devnet](https://dashboard.dev.grid.tf/)
|
||||
- [Qanet](https://dashboard.qa.grid.tf/)
|
||||
- [Testnet](https://dashboard.test.grid.tf/)
|
||||
- [Mainnet](https://dashboard.grid.tf/)
|
||||
|
||||
|
||||
## Create a Twin
|
||||
|
||||
A twin is a unique identifier of where you can be found digitally. Click on `CREATE` to register your Twin on TF-Chain.
|
||||
|
||||

|
||||
|
||||
If you want to connect your TwinID to the planetary network, fill in the IPv6 address you get from Yggdrasil.
|
||||
If not, no need to fill in the ip address, use ```127.0.0.1```.
|
||||
|
||||
This address is reserved for future usage once the digital twin will launch.
|
||||
|
||||

|
||||
|
||||
Submit the transaction using the password selected when creating the account.
|
||||
|
||||
The Twin IP can be modified at any moment.
|
||||
|
||||
## Required result
|
||||
|
||||
Shoud see something like:
|
||||
|
||||

|
||||
|
70
tosort/dashboard/portal/dashboard_portal_ui_farming.md
Normal file
@@ -0,0 +1,70 @@
|
||||
# Create a Farm
|
||||
|
||||
In this section, we'll walk you through the process of activating your farmer account, an essential step if you're looking to participate in the innovative world of farming on the ThreeFold Grid.
|
||||
|
||||
If you want to start farming, you need a farmID, which is the ID of the farm that is owning the hardware node(s) you connect to the TFGrid.
|
||||
|
||||
## Currently on:
|
||||
- [Devnet](https://dashboard.dev.grid.tf/)
|
||||
- [Qanet](https://dashboard.qa.grid.tf/)
|
||||
- [Testnet](https://dashboard.test.grid.tf/)
|
||||
- [Mainnet](https://dashboard.grid.tf/)
|
||||
|
||||
Click `CREATE FARM` and choose a name.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
Click `Submit` and sign the action.
|
||||
|
||||
The farm is by default set up as 'DIY'. A farm can become certified through certification program.
|
||||
Also a pricing policy is defined. Pricing policy is currently the same for all farms, the field is created for future use.
|
||||
|
||||
## Add a public IP to your Farm
|
||||
|
||||
If you have public IPv4 addresses available that can be used for usage on the TFGrid, you can add them in your farm.
|
||||
Click `ADD IP`, specify the addresses, the gateway and click `CREATE`.
|
||||
You can add them one by one or using range of IPs.
|
||||
|
||||
__Some notes about adding a new IPs__:
|
||||
|
||||
- Be careful not to create a new IP range that contains an IP address that already exists; doing so will result in an error.
|
||||
- Verify that both the gateway address and the IP address are correct.
|
||||
- Be careful not to include the same gateway address in a new IP range.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
Deleting IPv4 addresses is also possible here. The `Deployed Contract ID` gives an indication of whether an IP is currently used. If it is 0, it is safe to remove it.
|
||||
|
||||

|
||||
|
||||
## Add a Stellar address for payout
|
||||
|
||||
In a first phase, farming of tokens still results in payout on the Stellar network. So to get the farming reward, a Stellar address needs to be provided.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
## Generate your node bootstrap image
|
||||
|
||||
Once you know your farmID, you can set up your node on TFGrid3. Click on `View bootstrap`.
|
||||
|
||||
After booting a node, the info will become available in your portal, including the status info along with the minting and fixup receipts.
|
||||
|
||||

|
||||
|
||||
Clicking on the node statistics will open up a calendar where you can view the periods the node was minting or undergoing a fixup. Clicking on the periods will show a popup with the start and end datetimes, receipt hash and the amount of TFTs minted (if it is a minting receipt).
|
||||
|
||||

|
||||
|
||||
You can also download a single node's receipts using the `Download Receipts` button within the node statistics. Moreover, you can download all of the nodes' receipts using the `Download Receipts` button on the top left corner of the farm nodes table.
|
||||
|
||||
## Capacity Explorer
|
||||
|
||||
In the upper right corner, you can click on `EXPLORER` to get a view of all capacity connected to TFGrid v3. For more info, see [here](../explorer/explorer_home.md).
|
||||
|
||||
|
62
tosort/dashboard/portal/dashboard_portal_ui_tokens.md
Normal file
@@ -0,0 +1,62 @@
|
||||
# Manage your TFT on TFChain
|
||||
|
||||
## Transfer TFT between TFChain accounts
|
||||
|
||||
The portal can be used to transfer TFTs between 2 accounts that exist on the same chain.
|
||||
|
||||
> Remark: testnet and mainnet both have the same TFTs but as the 2 chains are different, there is no way to do a direct transfer between accounts on testnet and on mainnet.
|
||||
|
||||

|
||||
|
||||
Click on `Transfer` in the sidebar to get the transfer screen.
|
||||
|
||||

|
||||
|
||||
Fill in the recipient address, the amount of tokens to transfer, and click on `Submit`. Sign in the extension screen, and you're done !
|
||||
|
||||
There is no transfer fee, just a signing fee of 0.001 TFT.
|
||||
|
||||
## Transfer TFT between Stellar Network and TF-Chain
|
||||
|
||||
A minimum amount of TFT is sponsored for the initial setup, but as every action on TF-Chain requires some small TFT amount, TFT can be sent over from the Stellar network.
|
||||
Also, capacity that is reserved is paid to the Substrate account. For multiple reasons (selling, storing, ...) you might need to transfer this amount to the Stellar network. There is a bridge between the two blockchains available, and transfers can be launched as indicated below.
|
||||
|
||||
### Deposit
|
||||
|
||||
A deposit of tokens from the Stellar network onto TF-Chain needs to happen from a Stellar wallet, like in the ThreeFold Connect App.
|
||||
|
||||
You have 2 options:
|
||||
|
||||
- TFT needs to be sent to the bridge account
|
||||
- specifying in the memo field the twinID that was generated with the Twin creation e.g. twin_110 (dont forget twin_)
|
||||
- Note there is a transaction cost of 1 TFT.
|
||||
|
||||
Or
|
||||
|
||||
- You can scan the QR code
|
||||
|
||||
Go to portal
|
||||
|
||||
!!!include:tfchain_portal_list
|
||||
|
||||
Click on `Bridge` in the sidebar to get the transfer screen. Click `Deposit`
|
||||
|
||||

|
||||
|
||||
### Withdraw
|
||||
|
||||
Sending tokens to the Stellar network can happen from this portal, after indicating the destination address and the amount to be transferred.
|
||||
|
||||
Go to portal
|
||||
|
||||
!!!include:tfchain_portal_list
|
||||
|
||||
Click on `Swap` in the sidebar to get the transfer screen. Click `Withdraw`.
|
||||
|
||||

|
||||
|
||||
Click on `Submit` and sign using your password.
|
||||
|
||||

|
||||
|
||||
!!!include:tfchain_portal_toc
|