diff --git a/.gitbook/assets/host_1.png b/.gitbook/assets/host_1.png new file mode 100644 index 0000000..9f1b3e5 Binary files /dev/null and b/.gitbook/assets/host_1.png differ diff --git a/.gitbook/assets/host_2.png b/.gitbook/assets/host_2.png new file mode 100644 index 0000000..ef5b668 Binary files /dev/null and b/.gitbook/assets/host_2.png differ diff --git a/.gitbook/assets/host_3.png b/.gitbook/assets/host_3.png new file mode 100644 index 0000000..11caaff Binary files /dev/null and b/.gitbook/assets/host_3.png differ diff --git a/.gitbook/assets/host_4.png b/.gitbook/assets/host_4.png new file mode 100644 index 0000000..8976a81 Binary files /dev/null and b/.gitbook/assets/host_4.png differ diff --git a/.gitbook/assets/host_5.png b/.gitbook/assets/host_5.png new file mode 100644 index 0000000..6eb5afd Binary files /dev/null and b/.gitbook/assets/host_5.png differ diff --git a/.gitbook/assets/macos_1.png b/.gitbook/assets/macos_1.png new file mode 100644 index 0000000..02af4c3 Binary files /dev/null and b/.gitbook/assets/macos_1.png differ diff --git a/.gitbook/assets/option.png b/.gitbook/assets/option.png new file mode 100644 index 0000000..f2f4738 Binary files /dev/null and b/.gitbook/assets/option.png differ diff --git a/.gitbook/assets/receieve_2.png b/.gitbook/assets/receieve_2.png new file mode 100644 index 0000000..8eea09c Binary files /dev/null and b/.gitbook/assets/receieve_2.png differ diff --git a/.gitbook/assets/receieving_1.png b/.gitbook/assets/receieving_1.png new file mode 100644 index 0000000..611d739 Binary files /dev/null and b/.gitbook/assets/receieving_1.png differ diff --git a/.gitbook/assets/receiving_3 (1).png b/.gitbook/assets/receiving_3 (1).png new file mode 100644 index 0000000..691e6fc Binary files /dev/null and b/.gitbook/assets/receiving_3 (1).png differ diff --git a/.gitbook/assets/receiving_3.png b/.gitbook/assets/receiving_3.png new file mode 100644 index 0000000..2d8a3cc Binary files /dev/null and b/.gitbook/assets/receiving_3.png differ diff --git a/.gitbook/assets/receiving_4.png b/.gitbook/assets/receiving_4.png new file mode 100644 index 0000000..1576f5b Binary files /dev/null and b/.gitbook/assets/receiving_4.png differ diff --git a/.gitbook/assets/renter_1.png b/.gitbook/assets/renter_1.png new file mode 100644 index 0000000..cc21134 Binary files /dev/null and b/.gitbook/assets/renter_1.png differ diff --git a/.gitbook/assets/renter_7.png b/.gitbook/assets/renter_7.png new file mode 100644 index 0000000..9a37897 Binary files /dev/null and b/.gitbook/assets/renter_7.png differ diff --git a/.gitbook/assets/renterd_10.png b/.gitbook/assets/renterd_10.png new file mode 100644 index 0000000..1c20365 Binary files /dev/null and b/.gitbook/assets/renterd_10.png differ diff --git a/.gitbook/assets/renterd_11.png b/.gitbook/assets/renterd_11.png new file mode 100644 index 0000000..a5d2917 Binary files /dev/null and b/.gitbook/assets/renterd_11.png differ diff --git a/.gitbook/assets/renterd_12.png b/.gitbook/assets/renterd_12.png new file mode 100644 index 0000000..c3a3e6b Binary files /dev/null and b/.gitbook/assets/renterd_12.png differ diff --git a/.gitbook/assets/renterd_13.png b/.gitbook/assets/renterd_13.png new file mode 100644 index 0000000..6d4f10c Binary files /dev/null and b/.gitbook/assets/renterd_13.png differ diff --git a/.gitbook/assets/renterd_14.png b/.gitbook/assets/renterd_14.png new file mode 100644 index 0000000..639243f Binary files /dev/null and b/.gitbook/assets/renterd_14.png differ diff --git a/.gitbook/assets/renterd_2.png b/.gitbook/assets/renterd_2.png new file mode 100644 index 0000000..dc180df Binary files /dev/null and b/.gitbook/assets/renterd_2.png differ diff --git a/.gitbook/assets/renterd_3.png b/.gitbook/assets/renterd_3.png new file mode 100644 index 0000000..e94ac20 Binary files /dev/null and b/.gitbook/assets/renterd_3.png differ diff --git a/.gitbook/assets/renterd_4.png b/.gitbook/assets/renterd_4.png new file mode 100644 index 0000000..eede95a Binary files /dev/null and b/.gitbook/assets/renterd_4.png differ diff --git a/.gitbook/assets/renterd_5.png b/.gitbook/assets/renterd_5.png new file mode 100644 index 0000000..44bcc78 Binary files /dev/null and b/.gitbook/assets/renterd_5.png differ diff --git a/.gitbook/assets/renterd_6.png b/.gitbook/assets/renterd_6.png new file mode 100644 index 0000000..e084fc9 Binary files /dev/null and b/.gitbook/assets/renterd_6.png differ diff --git a/.gitbook/assets/renterd_8.png b/.gitbook/assets/renterd_8.png new file mode 100644 index 0000000..b435ed8 Binary files /dev/null and b/.gitbook/assets/renterd_8.png differ diff --git a/.gitbook/assets/renterd_9.png b/.gitbook/assets/renterd_9.png new file mode 100644 index 0000000..47b7b3b Binary files /dev/null and b/.gitbook/assets/renterd_9.png differ diff --git a/.gitbook/assets/sending_1.png b/.gitbook/assets/sending_1.png new file mode 100644 index 0000000..7e50cbc Binary files /dev/null and b/.gitbook/assets/sending_1.png differ diff --git a/.gitbook/assets/sending_2.png b/.gitbook/assets/sending_2.png new file mode 100644 index 0000000..c1b3295 Binary files /dev/null and b/.gitbook/assets/sending_2.png differ diff --git a/.gitbook/assets/sending_3.png b/.gitbook/assets/sending_3.png new file mode 100644 index 0000000..dc3f3ad Binary files /dev/null and b/.gitbook/assets/sending_3.png differ diff --git a/.gitbook/assets/sending_4.png b/.gitbook/assets/sending_4.png new file mode 100644 index 0000000..433b66a Binary files /dev/null and b/.gitbook/assets/sending_4.png differ diff --git a/.gitbook/assets/sending_5.png b/.gitbook/assets/sending_5.png new file mode 100644 index 0000000..bc5ebb5 Binary files /dev/null and b/.gitbook/assets/sending_5.png differ diff --git a/.gitbook/assets/terminal 1.png b/.gitbook/assets/terminal 1.png new file mode 100644 index 0000000..ddaff17 Binary files /dev/null and b/.gitbook/assets/terminal 1.png differ diff --git a/.gitbook/assets/terminal 2.png b/.gitbook/assets/terminal 2.png new file mode 100644 index 0000000..385449e Binary files /dev/null and b/.gitbook/assets/terminal 2.png differ diff --git a/.gitbook/assets/walletd_ui.png b/.gitbook/assets/walletd_ui.png new file mode 100644 index 0000000..635fffd Binary files /dev/null and b/.gitbook/assets/walletd_ui.png differ diff --git a/SUMMARY.md b/SUMMARY.md index cffb007..c6a02d6 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -4,33 +4,35 @@ ## Get Started with Sia -* [Introduction to these docs](get-started-with-sia/intro.md) -* [🚧 Sia 101](get-started-with-sia/sia101.md) -* [What are Siacoins?](get-started-with-sia/what-are-siacoins.md) -* [How to buy Siacoins](get-started-with-sia/how-to-buy-siacoins.md) +* [Introduction](get-started-with-sia/intro.md) +* [🚧 Learn about Sia](get-started-with-sia/sia101.md) +* [🚧 Learn about Siacoins](get-started-with-sia/learn-about-siacoins.md) * [🚧 The importance of your seed](get-started-with-sia/the-importance-of-your-seed.md) * [Siacoin Total Supply](get-started-with-sia/siacoin-total-supply.md) ## Renting * [🚧 About Renting on Sia](renting/about-renting.md) -* [🚧 Setup Guides](renting/setup-guides/README.md) - * [Linux](renting/setup-guides/linux.md) - * [macOS](renting/setup-guides/macos.md) - * [Windows](renting/setup-guides/windows.md) -* [🚧 Renting storage on Sia](renting/renting-storage-on-sia.md) -* [🚧 Managing your files](renting/managing-your-files.md) -* [🚧 Back up and restore your files](renting/how-to-back-up-your-files.md) -* [🚧 Renter troubleshooting](renting/renter-troubleshooting.md) +* [Setting up renterd](renting/setting-up-renterd/README.md) + * [🚧 Linux](renting/setting-up-renterd/linux.md) + * [macOS](renting/setting-up-renterd/macos.md) + * [🚧 Windows](renting/setting-up-renterd/windows.md) +* [📷 Transferring Siacoins](renting/transferring-siacoins.md) +* [Renting Storage](renting/renting-storage.md) +* [Managing Files](renting/managing-your-files.md) * [🚧 Renting FAQ](renting/renting-faq.md) ## Hosting * [About Hosting on Sia](hosting/about-hosting-on-sia.md) -* [🚧 Setup Guides](hosting/setup-guides/README.md) +* [🚧 Setting up hostd](hosting/setup-guides/README.md) * [Linux](hosting/setup-guides/linux.md) * [macOS](hosting/setup-guides/macos.md) * [Windows](hosting/setup-guides/windows.md) +* [🚧 Transferring Siacoins](hosting/transferring-siacoins.md) +* [🚧 Adding Storage](hosting/adding-storage.md) +* [🚧 Configuring your Host](hosting/configuring-your-host.md) +* [🚧 Announcing your Host](hosting/announcing-your-host.md) * [Dynamic DNS](hosting/dynamic-dns/README.md) * [DuckDNS](hosting/dynamic-dns/duckdns.md) * [Cloudflare (Advanced)](hosting/dynamic-dns/cloudflare-advanced.md) @@ -38,40 +40,31 @@ ## Wallet -* [🚧 About Wallet](wallet/wallet-overview.md) -* [🚧 Setup Guide](wallet/setup-guide/README.md) - * [Linux](wallet/setup-guide/linux.md) - * [macOS](wallet/setup-guide/macos.md) - * [Windows](wallet/setup-guide/windows.md) +* [About walletd](wallet/wallet-overview.md) +* [Setting up walletd](wallet/setting-up-walletd/README.md) + * [📸 Linux](wallet/setting-up-walletd/linux.md) + * [macOS](wallet/setting-up-walletd/macos.md) + * [📸 Windows](wallet/setting-up-walletd/windows.md) +* [Transferring Siacoins](wallet/transferring-siacoins.md) * [🚧 Wallet FAQ](wallet/wallet-faq.md) -## Your Sia Wallet - -* [Overview](your-sia-wallet/overview.md) -* [🚧 Siacoin Transfer](your-sia-wallet/siacoin-transfer/README.md) - * [Send](your-sia-wallet/siacoin-transfer/send.md) - * [Recieve](your-sia-wallet/siacoin-transfer/recieve.md) -* [🚧 Deposit](your-sia-wallet/wallet-overview.md) -* [🚧 Withdrawal](your-sia-wallet/withdrawal.md) - ## Mining -* [About mining on Sia](mining/about-mining-on-sia.md) +* [About Mining on Sia](mining/about-mining-on-sia.md) * [Sia mining pools](mining/sia-mining-pools.md) ## Siafunds -* [What are Siafunds?](siafunds/what-are-siafunds.md) -* [How do I buy Siafunds?](siafunds/how-do-i-buy-siafunds.md) +* [Learn about Siafunds](siafunds/learn-about-siafunds.md) * [How to cash out Siafunds](siafunds/how-to-cash-out-siafunds.md) * [SEC Settlement FAQ](siafunds/sec-settlement-faq.md) ## Sia Integrations * [🚧 Listing Siacoin on your exchange](sia-integrations/listing-siacoin-on-your-exchange.md) -* [Using the Sia Ledger app with Sia Central](sia-integrations/using-the-sia-ledger-nano-app-sia-central.md) +* [Using Sia Ledger app with Sia Central](sia-integrations/using-the-sia-ledger-nano-app-sia-central.md) * [Using the Sia Ledger Nano app with CLI](sia-integrations/using-the-sia-ledger-nano-app-cli.md) -* [🚧 Brand guidelines for Sia in your project or site](sia-integrations/sia-brand-guidelines.md) +* [🚧 Brand Guidelines](sia-integrations/sia-brand-guidelines.md) ## Testnet @@ -79,7 +72,6 @@ ## Miscellaneous -* [🚧 Version matrix](miscellaneous/version-matrix.md) -* [👷 Learn more and contribute](miscellaneous/learn-more-and-contribute.md) -* [🚧 Code of Conduct](miscellaneous/code-of-conduct.md) +* [🚧 Releases](miscellaneous/releases.md) +* [Getting Involved](miscellaneous/getting-involved.md) * [🚧 Glossary](miscellaneous/glossary.md) diff --git a/get-started-with-sia/how-to-buy-siacoins.md b/get-started-with-sia/how-to-buy-siacoins.md deleted file mode 100644 index 5a48596..0000000 --- a/get-started-with-sia/how-to-buy-siacoins.md +++ /dev/null @@ -1,42 +0,0 @@ -# How to buy Siacoins - -Whether you want to upload files to the decentralized cloud or lend your extra storage space to the network, you need Siacoins to use Sia. Siacoins can be sent to you once you make a Sia address, or you can mine them. Otherwise, you’ll need to buy them. - -Siacoins are available on a number of major exchanges like Binance, Bittrex, Kraken, Upbit, and Poloniex. Get the full list [here](https://sia.tech/community-ecosystem?software=exchanges#software). - -Some exchanges support direct fiat (local currency) to Siacoin purchases, but others require you to buy Bitcoins, Ethereum, or other crypto to make your purchase. We’ll walk you through the process of buying your first Siacoins. - -## What is KYC? - -No, this isn't chicken related. KYC stands for Know Your Customer and is a set of identity verification rules that most exchanges have to follow to abide by local laws. This might include submitting scans of state or federal ID, or sending in your government ID numbers like a Social Security Number if you live in the US. You'll be guided through whatever KYC process your exchange of choice has. - -## Buy SC from an exchange - -This option gets you the best prices but has a fairly intense on-ramp for a new user. - -This example will use [Bittrex](https://bittrex.com/), a US-based exchange that allows you to trade regular US dollars (USD), BTC, ETH, or USDT for Siacoins. But the general process will be similar no matter which exchange you use. - -* [Sign up for an account](https://bittrex.zendesk.com/hc/en-us/articles/115005329167-Creating-a-Bittrex-Account-and-Performing-Verification) with Bittrex. The process is simple, but fairly long and requires identity verification along the way. -* Once signed up, find the market you’re interested in. Purchase directly with [USD](https://bittrex.com/Market/Index?MarketName=USD-SC) or [Bitcoin](https://bittrex.com/Market/Index?MarketName=BTC-SC). -* Make a trade by specifying how many Siacoins you want to buy, and at what price. - -{% hint style="warning" %} -If this is your first time purchasing crypto, start with a small amount until you’re comfortable with it. -{% endhint %} - -* Now you have the Siacoins in your Bittrex wallet, but exchange wallets aren’t a good place to store crypto, and you can’t use it for its intended purpose - using Sia. -* Transfer to your Sia wallet by [making a Sia address](how-to-buy-siacoins.md) and then sending to it from Bittrex. - -## Buy SC using Transak - -Transak offers incredibly easy crypto purchasing using just your debit or credit card, but you pay extra fees and there are minimum purchase amounts that might be higher than what you need. - -Visit [transak.com](https://transak.com), tell them how much of your local currency you want to spend, and they'll tell you how much SC you can get. - -![](../.gitbook/assets/transak-widget.png) - -Click **Buy Now**. - -![](../.gitbook/assets/transak-widget-2.png) - -Then enter in your SC address [that you made](broken-reference), and click **Buy Now** again to proceed through the transaction process. diff --git a/get-started-with-sia/intro.md b/get-started-with-sia/intro.md index 40aede0..aea3bf1 100644 --- a/get-started-with-sia/intro.md +++ b/get-started-with-sia/intro.md @@ -1,10 +1,10 @@ -# Introduction to these docs +# Introduction The goal of the Sia Docs is to be a comprehensive source of Sia information. Info in these docs has been taken from a number of sources, primarily the previous Sia Support Center and community-driven sites like the Sia Wiki, SiaStats, and SiaSetup. Thanks to these sites and the many others that have contributed to the Sia ecosystem over the years. Keeping docs up to date is no small task, and GitBook allows anyone in the community to submit an edit to a document, or even a completely new article on their own. While we still need to review and approve submissions, the pipeline to getting docs updated is significantly cleaner than it used to be. -While this site can be updated by our users, a community never suffers from having too many resources. Where this site takes a targeted approach to on-boarding new users and getting them up and running, another site might take a more philosophical approach. Yet another might focus on metrics. There's nothing wrong with redundancy – the entire Sia network is based on it. +While this site can be updated by our users, a community never suffers from having too many resources. Where this site takes a targeted approach to onboarding new users and getting them up and running, another site might take a more philosophical approach. Yet another might focus on metrics. There's nothing wrong with redundancy – the entire Sia network is based on it. ### Submit your edits! diff --git a/get-started-with-sia/learn-about-siacoins.md b/get-started-with-sia/learn-about-siacoins.md new file mode 100644 index 0000000..6abab09 --- /dev/null +++ b/get-started-with-sia/learn-about-siacoins.md @@ -0,0 +1,40 @@ +# 🚧 Learn about Siacoins + +## What are Siacoins? + +Siacoins are the utility tokens that power the Sia network. This article is included early on because anything you want to do on the network requires Siacoins. + +Siacoins are used in lots of ways but serve a single purpose – facilitating network operations. When you upload files to Sia, you pay for that storage in Siacoins. If you're a host and you're storing other people's data, you get paid for that in Siacoins. If you own Siafunds, your share of Sia network growth is paid out in, you guessed it, Siacoins. + +You can send Siacoins to others, or receive them at your own wallet address. You can store them in our official software, or on a hardware or paper wallet. You can get Siacoins by having someone send them to you, buying them on an exchange, or mining them. + +New Siacoins are made through proof-of-work mining. There are over 40 billion Siacoins out there right now, and that number will never stop growing. Sia is going to be the storage layer of the internet, and billions will be required for the petabytes and exabytes of data that will be stored on Sia. + +## Where to buy Siacoins + +Whether you want to upload files to the decentralized cloud or lend your extra storage space to the network, you need Siacoins to use Sia. Siacoins can be sent to you once you make a Sia address, or you can mine them. Otherwise, you’ll need to buy them. + +Siacoins are available on a number of major exchanges like Binance, Kraken, Upbit, and Poloniex. Get the full list [here](https://sia.tech/community-ecosystem?software=exchanges#software). + +Some exchanges support direct fiat (local currency) to Siacoin purchases, but others require you to buy Bitcoins, Ethereum, or other crypto to make your purchase. We’ll walk you through the process of buying your first Siacoins. + +### Buy SC from an exchange + +This option gets you the best prices but has a fairly intense on-ramp for a new user. + +This example will use [Kraken](https://kraken.com), a US-based exchange that allows you to trade regular US dollars (USD), BTC, ETH, or USDT for Siacoins. But the general process will be similar no matter which exchange you use. + +* [Sign up for an account](https://bittrex.zendesk.com/hc/en-us/articles/115005329167-Creating-a-Bittrex-Account-and-Performing-Verification) with Kraken. The process is simple, but fairly long and requires identity verification along the way. +* Once signed up, find the market you’re interested in. Purchase directly with [USD](https://bittrex.com/Market/Index?MarketName=USD-SC) or [Bitcoin](https://bittrex.com/Market/Index?MarketName=BTC-SC). +* Make a trade by specifying how many Siacoins you want to buy, and at what price. + +{% hint style="warning" %} +If this is your first time purchasing crypto, start with a small amount until you’re comfortable with it. +{% endhint %} + +* Now you have the Siacoins in your Kraken wallet, but exchange wallets aren’t a good place to store crypto, and you can’t use it for its intended purpose - using Sia. +* Transfer to your Sia wallet by [making a Sia address](broken-reference) and then withdrawing from Kraken. + +Then enter in your SC address [that you made](broken-reference), and click **Buy Now** again to proceed through the transaction process. + +## diff --git a/get-started-with-sia/sia101.md b/get-started-with-sia/sia101.md index 7ab1ff2..3744e52 100644 --- a/get-started-with-sia/sia101.md +++ b/get-started-with-sia/sia101.md @@ -2,7 +2,7 @@ description: Let's take it from the top. --- -# 🚧 Sia 101 +# 🚧 Learn about Sia Sia has a few important terms that you'll want to get familiar with. These will be explained in more detail in their related sections, but here's a short sample. @@ -19,16 +19,12 @@ When a file gets uploaded to Sia, it gets split up, encrypted, and sent all over ## Why it's here -Sia’s core goal is to bring decentralization to data storage. We want you to be able to store your data in a way that gives you full, exclusive control. We want to make sure you're protected against theft, censorship, and that you are never denied access to your data by hackers, miners, developers, or a government body. Your data belongs to you. +Sia’s core goal is to bring decentralization to data storage. We want you to be able to store your data in a way that gives you full, exclusive control. We want to ensure you're protected against theft and censorship, and that you are never denied access to your data by hackers, miners, or developers. Your data belongs to you. ## Who makes Sia? Sia was conceived at HackMIT in 2013 by David Vorick and Luke Champine. The founders formed Nebulous Labs and later Skynet Labs to develop Sia. More recently, the Sia Foundation was formed as a non-profit dedicated to leading core development into the future. -## Community contribution - -While there is a distinct development and operations team, dozens of individuals have contributed to the core code or apps built on top of the network. Check out our [GitHub repositories](https://github.com/SiaFoundation) if you're interested in following along or writing code for Sia and further decentralizing the project! - ## **Renting on Sia** When you upload files to Sia, you become a **renter**. You upload files to other users who have made their space available, called **hosts**. We use the term renter because Sia creates contracts with other hosts: @@ -47,21 +43,12 @@ Hosts are a critical part of the ecosystem. You are contributing to the decentra ## The Sia core software -{% hint style="info" %} -Please note that while much of the documentation is written for `siad` and Sia-UI. We are actively transitioning to `renterd`, `hostd`, and `walletd` and will be updating all documentation to reflect this new software. -{% endhint %} - -The original core Sia software consists of `siad` and Sia-UI. This software is currently being deprecated and replaced with the new software outlined below. - -* **`siad`** is a daemon that can be used via CLI. `siad` supports renting, hosting, wallets, and more - essentially all-in-one software for using Sia. -* **Sia-UI** is `siad` wrapped with a graphical user interface. - The Sia Foundation has been developing a new suite of software that improves on `siad` and takes a more modular approach, with separate software for renting, hosting, wallet, and explorer. The software is generally more scalable, performant, and easier to integrate. The new software is: -* **`renterd`** is a next-generation Sia renter, developed by the Sia Foundation. It aims to serve the needs of both everyday users -- who want a simple interface for storing and retrieving their personal data -- and developers -- who want to a powerful, flexible, and reliable API for building apps on Sia. -* **`hostd`** is an advanced Sia host solution created by the Sia Foundation, designed to enhance the experience for storage providers within the Sia network. Tailored for both individual and large-scale storage providers, `hostd` boasts a user-friendly interface and a robust API, empowering providers to efficiently manage their storage resources and revenue. `hostd` incorporates an embedded web-UI, simplifying deployment and enabling remote management capabilities, ensuring a smooth user experience across a diverse range of devices. +* **`renterd`** is a next-generation Sia renter, developed by the Sia Foundation. It aims to serve the needs of both everyday users -- who want a simple interface for storing and retrieving their personal data -- and developers -- who want a powerful, flexible, and reliable API for building apps on Sia. +* **`hostd`** is an advanced Sia host solution created by the Sia Foundation, designed to enhance the experience for storage providers within the Sia network. Tailored for both individual and large-scale storage providers, `hostd` boasts a user-friendly interface and a robust API, empowering providers to efficiently manage their storage resources and revenue. `hostd` incorporates an embedded web UI, simplifying deployment and enabling remote management capabilities, ensuring a smooth user experience across a diverse range of devices. * **`walletd`** is a watch-only wallet server. It does not have access to any private keys, only addresses derived from those keys. Its role is to watch the blockchain for events relevant to particular addresses. The server therefore knows which outputs are spendable by the wallet at any given time, and can assist in constructing and broadcasting transactions spending those outputs. However, _signing_ transactions is the sole responsibility of the client. * **`explored`** An explorer backend for Sia. diff --git a/get-started-with-sia/siacoin-total-supply.md b/get-started-with-sia/siacoin-total-supply.md index e4eabb8..27a18e8 100644 --- a/get-started-with-sia/siacoin-total-supply.md +++ b/get-started-with-sia/siacoin-total-supply.md @@ -1,10 +1,10 @@ -# What is the Siacoin total supply? +# Siacoin Total Supply Siacoins are the utility token powering the Sia network and are intended to be used for the fulfillment of smart storage contracts on the decentralized network. ## So what's the total supply? -**Unlimited** – there will never be a cap on the number of Siacoins generated. Humans produce so much data that it is effectively a limitless amount – and when Sia is the industry-standard storage layer of the Internet, the network will need lots of Siacoins to fulfill all those contracts. Additionally, the Proof of Burn mechanic \(more on this later\) functions to eliminate coins from the supply, so there needs to be a constant allowance of new Siacoins being created. As of March 23, 2021, about 47.3 billion coins have been created, but the number of new coins introduced will slow as each new block is produced. By 2022, there should be about 50 billion coins in circulation. +**Unlimited** – there will never be a cap on the number of Siacoins generated. Humans produce so much data that it is effectively a limitless amount – and when Sia is the industry-standard storage layer of the Internet, the network will need lots of Siacoins to fulfill all those contracts. Additionally, the Proof of Burn mechanic (more on this later) functions to eliminate coins from the supply, so there needs to be a constant allowance of new Siacoins being created. As of March 23, 2021, about 47.3 billion coins have been created, but the number of new coins introduced will slow as each new block is produced. By 2022, there should be about 50 billion coins in circulation. Additionally, if the block reward were to stop, miners would be disincentivized to continue providing their service to the network. @@ -14,37 +14,30 @@ Siacoins are created only as block rewards during mining on the Sia Proof of Wor ## Let's get a little more technical -The number of Siacoins created each block is \(300,000 - height\). This means that a block with a block height of 200,000 created 100,000 Siacoins \(300,000 - 200,000\). After height 270,000, the block reward won't get lower and all blocks will have a reward of 30,000 Siacoins. +The number of Siacoins created each block is (300,000 - height). This means that a block with a block height of 200,000 created 100,000 Siacoins (300,000 - 200,000). After height 270,000, the block reward won't get lower and all blocks will have a reward of 30,000 Siacoins. -By about July of 2020 when Sia hits the 270,000 block height, there will be about 44.55 billion \(\(\(300,000+30,000\)/2\)x270,000=44.55 billion\) Siacoins available in the market. From there, there will be about 1.57 billion \(30,000x144x365=1.5678 billion\) Siacoins created from the mining every year, forever. +By about July of 2020 when Sia hits the 270,000 block height, there will be about 44.55 billion (((300,000+30,000)/2)x270,000=44.55 billion) Siacoins available in the market. From there, there will be about 1.57 billion (30,000x144x365=1.5678 billion) Siacoins created from the mining every year, forever. ## The Sia Foundation In addition, Sia v1.5.4 introduced a network hardfork. The fork introduced the Sia Foundation, a new non-profit entity charged with supporting, developing, and promoting the Sia network. The Foundation changed the supply structure slightly as it is funded by an ongoing block subsidy of 30,000 Siacoins per block, paid out every 4,380 blocks. The hardfork also included an initial subsidy of approximately 1.57 billion Siacoins to help get the Foundation off the ground and fund initial development and activities. -This creates a small single year spike in the inflation schedule of a few percentage points, but that quickly reduces back to nearly pre-fork levels. You can see the entire inflation schedule at the fantastic community site [SiaStats](https://siastats.info/macroeconomics). - -## Will the number of coins ever be reduced? - -In the future, we'll be implementing a mechanic called Proof of Burn. Using this, sellers of storage on the network will burn coins to prove that they are real and have good intentions towards the network. It also offers another layer of network security. Here's more explanation from Sia lead dev David Vorick on the mechanic: - -> Hosts burn coins by sending them to a provably unspendable address. Hosts are expected to burn a portion of their revenue \(~4%\) as a demonstration that they are real. Renters will select hosts that have burned coins with a probability that grows in a linear relationship to the total number of coins burned. Therefore, a host that has burned 2x as many coins will be twice as likely to be selected as another host that has all other factors the same. This provides a very important defence against Sybil attacks. An attacker that is trying to manipulate a renter will need to have all of the excess redundancy of a file before being able to commit an attack. For a file with 3x redundancy, that means the attacker will need to get at least 2.1x of that redundancy, which means that the attacker will need to burn enough coins to look like 67% of the network. That entails burning 1.5x as many coins as the rest of the network has burned combined. Especially as the network grows and matures, collecting that many coins is going to be prohibitive. \([Source](https://web.archive.org/web/20171102065557/https://forum.sia.tech/topic/108/how-sia-works)\) +This creates a small single-year spike in the inflation schedule of a few percentage points, but that quickly reduces back to nearly pre-fork levels. ## Isn't too many coins a bad thing? Inflation is built-in with Siacoin to account for the many factors over time that will cause coins to disappear, such as the Proof of Burn mechanic, lost coins, and un-refunded collateral due to bad hosting. This inflation becomes very small over time, but still provides security to the network in the form of block rewards for the miners. -| | % Growth in total Siacoins | -| :--- | :--- | -| Year 1 | 90 | -| Year 2 | 39 | -| Year 3 | 21 | -| Year 4 | 11.6 | -| Year 5 | 4.6 | -| Year 6 \(Foundation year\) | 9.9 | -| Year 7 | 6.3 | -| Year 8 | 5.9 | -| Year 9 | 5.6 | -| Year 10 | 5.3 | -| Year 20 | 2.3 | - +| | % Growth in total Siacoins | +| ------------------------ | -------------------------- | +| Year 1 | 90 | +| Year 2 | 39 | +| Year 3 | 21 | +| Year 4 | 11.6 | +| Year 5 | 4.6 | +| Year 6 (Foundation year) | 9.9 | +| Year 7 | 6.3 | +| Year 8 | 5.9 | +| Year 9 | 5.6 | +| Year 10 | 5.3 | +| Year 20 | 2.3 | diff --git a/get-started-with-sia/the-importance-of-your-seed.md b/get-started-with-sia/the-importance-of-your-seed.md index b0a34c9..1d8513c 100644 --- a/get-started-with-sia/the-importance-of-your-seed.md +++ b/get-started-with-sia/the-importance-of-your-seed.md @@ -26,44 +26,12 @@ Because your seed is so important, you should have physical and digital methods #### Physically Safe -Keep a laminated paper copy stored in a locked safe or a bank safe deposit box. +Keep a laminated paper copy stored in a locked safe or a bank safety deposit box. #### Digitally Safe -Keep your seed in a password or biometric (e.g. fingerprint) secured app like 1Password or LastPass. +Keep your seed in a password or biometric (e.g., fingerprint) secured app like 1Password or LastPass. -## Make sure it's right +## Make sure it's correct -Once you write it down, copy and paste it, or re-type it, make sure you've done so correctly. A single miswritten word or mistyped letter means the entire seed is incorrect, and can no longer be used to unlock your wallet or recover your Siacoin. - -## Unlock your wallet - -Your seed is your private key to your Siacoin balance, and it can also be used to unlock your wallet. The default setting is for your seed to double as your wallet password, but you also have the ability to set a custom password if you’d like. Because your seed is so long, it can function as an effective line of defense against someone gaining unauthorized access to your wallet. This isn’t the whole picture though, and there are other things you should consider before deciding whether to use your seed or a custom password to get in and out of your Siacoin wallet. - -### Using your seed as your password - -It would take modern technology trillions upon trillions of years to figure out a 20+ word phrase from scratch. This makes your seed a powerful deterrent against intruders if it doubles as your wallet password. But frequently typing your seed also makes you vulnerable to malicious software that might be installed on your computer. Let’s look at the pros and cons of each. - -{% hint style="success" %} -**Pro:** Your seed is long. This offers great protection against someone trying to “brute force” it, or someone peeking over your shoulder as you type it. - -**Pro:** Since you'll be typing it in fairly often, you'll know it's correct. -{% endhint %} - -{% hint style="danger" %} -**Con:** Typing your seed in repeatedly makes you vulnerable to keylogging. Keylogging is when your keyboard input is recorded using malware or a physical device and then sent to a malicious party. If someone gets your seed, they can easily steal your Siacoin, as we noted earlier. -{% endhint %} - -### Using a custom password - -During wallet creation, you have an option to create a custom password for getting in and out of your wallet. You can also set this afterward at any point. This allows you to use something familiar instead of the wallet seed. - -{% hint style="success" %} -**Pro:** You don’t have to type in a ton of words every time you want to unlock your wallet. - -**Pro:** It reduces the exposure of your seed. If keylogging software were to steal your custom password, there’s nothing they can do with it unless the person also has access to your computer. -{% endhint %} - -{% hint style="danger" %} -**Con:** It might make accessing your wallet easier for those who have physical or remote access to your computer. -{% endhint %} +Once you write it down, copy and paste it, or re-type it, ensure you've done so correctly. A single miswritten word or mistyped letter means the entire seed is incorrect and can no longer be used to unlock your wallet or recover your Siacoin. diff --git a/get-started-with-sia/what-are-siacoins.md b/get-started-with-sia/what-are-siacoins.md deleted file mode 100644 index e272823..0000000 --- a/get-started-with-sia/what-are-siacoins.md +++ /dev/null @@ -1,10 +0,0 @@ -# What are Siacoins? - -Siacoins are the utility tokens that power the Sia network. This article is included early on because anything you want to do on the network requires Siacoins, whether you want to hold or trade, or rent or host data. - -Siacoins are used in lots of ways but serve a single purpose – facilitating network operations. When you upload files to Sia, you pay for that storage in Siacoins. If you're a host and you're storing other people's data, you get paid for that in Siacoins. If you own Siafunds, your share of Sia network growth is paid out in, you guessed it, Siacoins. - -You can send Siacoins to others, or receive them at your own wallet address. You can store them in our official software, or on a hardware or paper wallet. You can get Siacoins by having someone send them to you, buying them on an exchange, or mining them. - -New Siacoins are only made by mining. There's over 40 billion Siacoins out there right now, and that number will never stop growing. Sia is going to be the storage layer of the internet, and billions will be required for the petabytes and exabytes of data that will be stored on Sia. - diff --git a/hosting/about-hosting-on-sia.md b/hosting/about-hosting-on-sia.md index f2e0526..16ece10 100644 --- a/hosting/about-hosting-on-sia.md +++ b/hosting/about-hosting-on-sia.md @@ -4,7 +4,7 @@ description: >- the Sia network. --- -# About hosting on Sia +# About Hosting on Sia {% hint style="info" %} Get started hosting on Sia with the official [`hostd` software](https://sia.tech/software/hostd). @@ -89,7 +89,7 @@ This is how many Siacoins you're willing to lose if you don't fulfill the rental You should normally set your collateral to around **2-3x your base storage price** as a starting point in order to maximize your host score in this area. For example, if you've priced your storage at 50 SC/TB, you should set your collateral at 100-150 SC/TB. * If you set your collateral **too low**, your host score will be reduced, because renters will have no reason to trust you as a host if you have little or nothing to lose by going offline. -* If you set your collateral **too high**, this can also decrease your host score. Renters pay a fee based on a percentage of your collateral that goes towards [Siafunds](../../siafunds/what-are-siafunds.md) - if your collateral is set very high, the fee a renter pays as a result will be very high, which can decrease your host score. +* If you set your collateral **too high**, this can also decrease your host score. Renters pay a fee based on a percentage of your collateral that goes towards [Siafunds](broken-reference) - if your collateral is set very high, the fee a renter pays as a result will be very high, which can decrease your host score. **Monitoring Your Collateral** diff --git a/hosting/adding-storage.md b/hosting/adding-storage.md new file mode 100644 index 0000000..78aa9be --- /dev/null +++ b/hosting/adding-storage.md @@ -0,0 +1,21 @@ +# 🚧 Adding Storage + +## Add storage + +A "volume" is a location on disk where `hostd` will store uploaded data. A volume can be anywhere, including network drives and external drives. You can create multiple volumes to combine storage from multiple drives. To add a volume: + +1. Click the "Volume" icon in the sidebar +2. Click the "Create Volume" button to add your first storage volume. + +

hostd create volume

+ +1. Enter a name for the volume. We recommend something simple, like "hostdata.dat" +2. Use the built-in browser to select a folder to store the volume file. +3. Enter a maximum size for the volume. This is the maximum amount of data that can be stored in the volume. +4. Click "Create" to add the volume to \`hostd\` + +After clicking "Create," the volume will be displayed in the volumes list. Depending on the size of the volume and the filesystem, it may take a while to fully provision the new volume. The progress will be displayed in the UI. + +

hostd volume list

+ +### diff --git a/hosting/announcing-your-host.md b/hosting/announcing-your-host.md new file mode 100644 index 0000000..6475a1b --- /dev/null +++ b/hosting/announcing-your-host.md @@ -0,0 +1,19 @@ +# 🚧 Announcing your Host + +Now that your host has finished syncing, you can announce your host to the network. This will publish your host's net address and public key to the blockchain so renters can connect to your host and form contracts. The announcement transaction costs a small amount of Siacoins, which will be deducted from your wallet. + +To announce your host: + +1. Click the "Configuration" icon in the sidebar +2. Click the "Announce" button in the top right corner of the page +3. Click "Announce" in the dialog to confirm + +\ + + + +\ + +## Check your host's status + +Once the announcement is confirmed you can check if your host is visible on the network by going to [https://troubleshoot.siacentral.com](https://troubleshoot.siacentral.com/). Enter your host's net address and click "Check Host". This tool will connect to your host and notify you of any issues. diff --git a/hosting/configuring-your-host.md b/hosting/configuring-your-host.md new file mode 100644 index 0000000..8a8001d --- /dev/null +++ b/hosting/configuring-your-host.md @@ -0,0 +1,51 @@ +# 🚧 Configuring your Host + +## Configure the host + +Now that you have a volume, you can configure your host. First, navigate to the "Configuration" page in the sidebar. This page contains all of the pricing and settings available to hosts. + +

hostd configuration page

+ +### Accepting contracts + +The first setting to configure is the "Accepting Contracts" setting. This setting determines whether your host will accept new contracts. Most hosts will always have this toggled on. However, if you want to exit the network you can toggle this off to stop accepting new contracts. You will still be required to fulfill any existing contracts before fully shutting down your host. + +### Address + +The next setting to configure is your host's net address. This is the address that is published to the blockchain and used by renters to connect to your host. Some users use their public IP address, but we recommend setting up a domain. You can use a free service like DuckDNS or No-IP or purchase a custom domain from a registrar. + +Whichever method you choose, enter your address in the "Net Address" field followed by your host's RHP2 port, which defaults to `:9982`. For example, if your IP address is `199.111.78.80` you would enter `199.111.78.80:9982`. If your domain is `example.com`, you would enter `example.com:9982`. + +

Configure netaddress

+ +#### Setup using Dynamic DNS + +* [Cloudflare](dynamic-dns/cloudflare-advanced.md) +* [DuckDNS](dynamic-dns/duckdns.md) +* [No-IP](broken-reference) + +#### Setup using public IP + +To find your public IP address click the following link: [https://icanhazip.com](https://icanhazip.com). It will display your public IP address. Copy this address to your clipboard. + +### Pricing + +On the Sia network, hosts set their prices for storage and bandwidth. The prices you select will determine how much you earn from hosting. + +{% hint style="info" %} +When setting prices, remember you are competing with other hosts. If your prices are too high, renters will choose other hosts. If your prices are too low, you will not earn enough to cover your costs. +{% endhint %} + +We've put together some recommendations for pricing below. These are just recommendations, you can set your prices to whatever you want and change your prices at any time. Hosts will need to experiment with different prices to find the right balance between earnings and utilization. + +* **Storage price:** the amount of Siacoins you charge per TB per month of storage. We recommend around $1 USD per TB per month to start. +* **Collateral:** the amount of Siacoins you lock per TB per month of storage. This should always be set to 2x your storage price. For example, if your storage price is 100 SC/TB/mo, you should set your collateral to 200 SC/TB/mo. +* **Ingress price:** the amount of Siacoins you charge per TB of data uploaded to your host. We recommend setting this low to encourage renters to upload data. Between $0.00 and $0.05 USD per TB. +* **Egress price:** the amount of Siacoins you charge per TB of data downloaded from your host. We recommend setting this higher to increase your earnings, above $5 USD per TB is a good starting point. +* **Maximum collateral:** the maximum amount of Siacoins you will lock into a single contract for collateral. This setting is important to limit your risk per contract. A good starting point is However, if you refuse to lock enough collateral for the data a renter wants to store, they will choose another host. Therefore, we recommend setting this around 10x your collateral price. For example, if your collateral price is 200 SC/TB/mo, you should set your maximum collateral to 2000 SC/TB/mo. + +We recommend leaving other settings, such as "Contract price", "Base RPC price", "Sector access price," and "Price table validity" at their default values. They are primarily for advanced users. + +Once you are happy with your prices, click the "Save Changes" button in the top right corner of the page. + +### diff --git a/hosting/hosting-faq.md b/hosting/hosting-faq.md index 89fb95a..49e69be 100644 --- a/hosting/hosting-faq.md +++ b/hosting/hosting-faq.md @@ -2,14 +2,6 @@
-How do I see advanced host stats? - -Type `host -v` to see complete stats. If you are in Sia-UI, open the Terminal with `>` at the top of the app. - -
- -
- Can I run my host on two different computers at the same time? It is not recommended to keep the same wallet and installation running in two different computers while hosting, as it could lead to data loss and loss of Siacoins. @@ -18,14 +10,6 @@ It is not recommended to keep the same wallet and installation running in two di
-What happens if my Sia wallet locks? - -Your host will appear as offline. Reference [this article](broken-reference) to keep it automatically unlocked. - -
- -
- What happens if my host computer shuts off? Your host will appear as offline. Reference [this article](broken-reference) to reboot it automatically. @@ -44,16 +28,6 @@ It may be easier to resize your old storage folders down incrementally after add
-Why are there multiple small deductions taken from my wallet? - -If you don't use DDNS, you probably have a dynamic IP from your ISP that changes from time to time. When this happens, your Sia host re-announces itself and this becomes a transaction in your wallet. - -You also might see multiple transactions form as collateral gets tied up in contracts. This is totally normal. - -
- -
- Should I backup my Sia host metadata? The Sia client maintains additional information on your contracts as a host and your renters' files in an internal location. This information is known as host metadata and is required in order to provide your renters with access to their data on the Sia cloud storage network. Without it, it's like losing renter data - you'd have no way to know which data belongs to who in your host storage folders. @@ -64,21 +38,19 @@ See more about backing up in [Sia-UI hosting guide](broken-reference).
-Is the Sia host affected when my public IP address changes, given that it is dynamic? +How do I set up port forwarding for TCP ports 9981-9983? -You can use a free Dynamic DNS (DDNS) service. DDNS involves registering for and receiving your own address, like "mysiahost.ddns.net", in combination with running a small program or script on your computer. Some routers also have built-in DDNS support for certain providers. When your public IP address changes, the DDNS program detects the change and configures your DDNS address with the new IP. This way, you can announce your Sia host using your DDNS address, and it should stay Online even with public IP changes. - -There are a number of free DDNS providers which can be found by searching for DDNS using your favorite search engine. One popular free option is [NoIP.com](https://www.noip.com/). +To set up port forwarding for TCP ports 9981-9983, you'll need to access your firewall or router settings. While we can't provide specific instructions in this guide, you can find tutorials for configuring port forwarding on most routers and firewalls online.
-Why is my Sia host becoming unresponsive for extended periods, ranging from several minutes to several hours? +Is the Sia host affected when my public IP address changes, given that it is dynamic? -Your host can become unresponsive if you add or change storage directories - especially on Windows, as Windows preallocates files so adding a drive with several terabytes of space will take as long as it takes to write to the entire drive, which is usually about 2-3 hours per TB. Your host can also become unresponsive during initial startup if it has to process or rebuild certain internal data files, or if it is syncing because it hasn't been online for a while or because the consensus data was removed or bootstrapped. +You can use a free Dynamic DNS (DDNS) service. DDNS involves registering for and receiving your own address, like "mysiahost.ddns.net", in combination with running a small program or script on your computer. Some routers also have built-in DDNS support for certain providers. When your public IP address changes, the DDNS program detects the change and configures your DDNS address with the new IP. This way, you can announce your Sia host using your DDNS address, and it should stay Online even with public IP changes. -In Sia v1.4.x and v1.5.0, there is a known issue regarding hosts becoming unresponsive, causing [SiaStats Host Monitor](https://siastats.info/hosts) benchmark failures and other issues. The SiaStats benchmark failures usually mention an I/O timeout, and several failures may occur in a row. There's not much you can do about this issue currently, but the Sia team is aware of the issue and has attempted a fix for v1.5.1. As this version has just been released in November 2020, it may take a few months to see if the resolution is effective. +There are a number of free DDNS providers which can be found by searching for DDNS using your favorite search engine. One popular free option is [NoIP.com](https://www.noip.com/).
@@ -92,30 +64,3 @@ Once you've switched off new contracts, you can track the progress of any curren
-## Can I move my Sia host to a new computer? - -{% hint style="warning" %} -Moving your host isn't recommended. It's a tough process and doesn't have a 100% success rate. Doing so might break your host completely. -{% endhint %} - -Both the installation folder and the Sia-UI folders are required to be transferred, on top of preserving the recovery seed. - -### Installation locations - -| Operating System | Data Directory | -| ---------------- | ------------------------------------------- | -| Linux | `$HOME/.config/Sia-UI` | -| Windows | `Users\\appdata\roaming\Sia-UI\` | -| macOS | `$HOME/Library/Application Support/Sia-UI/` | - -1. Install Sia on the new system, and start it once to generate the internal data files. Then close Sia completely (right-click the icon in the system tray and select **Quit**) - you don't need to wait for it to synchronize or set up your wallet. -2. Open Sia's internal data files (**About (i) icon > Open Data Folder**) on the old host, then close Sia completely. -3. Move the host storage folders and their contents from the old host to the new host. Obviously, this must be done such that the new storage locations are equal to or larger in size than the old storage locations in order to fit the data. Additionally, the hosting folders need to be accessible in the new machine in the exact same path. For instance, if the host was hosting files in a folder located on D:/Misc/Sia, the new computer will need to have a drive called “D:” and the hosting files placed exactly in /Misc/Sia. **This last requirement makes it impossible to transfer a host from the OS of one family to an OS of a different family** (for example, from Linux to Windows), as the drive routes are different. -4. Move all of Sia's internal data files from the old host to the new host at the locations found above. -5. In the internal data files on the new host, edit the `host\contractmanager\contractmanager.json` and `host\contractmanager\contractmanager.wal` files using a text editor, look for your old storage folder paths, and change them to your corresponding new storage folder paths. -6. Start Sia on the new host. - -Sia may take a while to start while it tries to figure out the changes. It may display a message while it does, or it may just sit. Your wallet and host data should be transferred over, though, and hopefully, everything will be in order once Sia finishes loading and you unlock your wallet. - - - diff --git a/hosting/setup-guides/linux.md b/hosting/setup-guides/linux.md index 3421408..b8cd58e 100644 --- a/hosting/setup-guides/linux.md +++ b/hosting/setup-guides/linux.md @@ -229,7 +229,7 @@ Once you are happy with your prices, click the "Save Changes" button in the top ## Port forwarding -If you have a firewall or router you will need to forward/open TCP ports 9981-9983. How to do so is outside of the scope of this guide, there are tutorials available for most routers/firewalls available on Google. +If you have a firewall or router, you will need to forward/open TCP ports 9981-9983. How to do so is outside of the scope of this guide; there are tutorials available for most routers/firewalls available on Google. ## Waiting for sync diff --git a/hosting/setup-guides/macos.md b/hosting/setup-guides/macos.md index 0760189..33cac0f 100644 --- a/hosting/setup-guides/macos.md +++ b/hosting/setup-guides/macos.md @@ -4,178 +4,167 @@ description: Setup a new host on macOS # macOS -This guide will walk you through setting up a new `hostd` node on macOS. For this guide, we are using a Macbook Pro M1, but the steps should work with any other macOS device. At the end of this guide, you should have a working `hostd` node on the Sia network and be ready to accept contracts from renters. +This guide will walk you through setting up `hostd` on macOS. At the end of this guide, you should have the following: -## Things you'll need +* **Installed Sia `hostd` software:** You should have successfully installed the Sia `hostd` software on your macOS system with the appropriate binary. +* **Functional `hostd` Node:** Your hostd node will be fully functional and operational on the Sia network. It will be ready to engage in various network activities, including contract negotiation, storage provision, and transaction handling. +* Created a `hostd` wallet: Have created a wallet with a Seed to access and manage your Sia network transactions and store your Siacoins in `hostd`. -Below are the minimum requirements for hosting on Sia. If you do not meet these requirements you may not receive contracts from renters or risk losing Siacoins as a penalty. Hosting is a commitment that requires some technical knowledge and a stable setup. +## Pre-requisites + +* **Network Access:** `hostd` interacts with the Sia network, so you need a stable internet connection and open network access to connect to the Sia blockchain. +* **Operating System Compatibility:** Ensure that your macOS version is compatible with the walletd software. Check [releases](../../miscellaneous/releases.md) supported macOS versions. +* **System Updates:** Ensure that your macOS is up to date with the latest system updates, as these updates can contain important security fixes and improvements. + +{% hint style="warning" %} +Your machine must meet the minimum requirements for hosting on Sia. Not meeting these requirements may result in not receiving contracts from renters or risk losing Siacoins as a penalty. Hosting on Sia is a commitment that requires some technical knowledge and a stable setup as such: * A Mac that supports macOS 12 (Monterey) or 13 (Ventura) * A quad-core CPU * 8GB of RAM * An SSD with at least 100GB of free space. * Additional storage space to rent out -* A stable internet connection - -`hostd` supports Intel-based Macs and Apple-Silicon Macs, using the M1 and M2 processors. +{% endhint %} {% hint style="info" %} This guide primarily uses the command line and assumes the user has sudo permissions. {% endhint %} -## Getting hostd +## Getting `hostd` -Download the latest version of `hostd` for your operating system and platform from the official website: [https://sia.tech/software/hostd](https://sia.tech/software/hostd). +1. Download the latest version of `hostd` for your operating system from the [official website](https://sia.tech/host). For the purpose of this guide, we'll be downloading the macOS version of `hostd` and unzip the binary to `/usr/local/bin`. -For this guide, we will download the `darwin/arm64` version and unzip the `hostd` binary to `/usr/local/bin` +{% hint style="warning" %} +Remember to check which version to download to ensure it works correctly with your operating system. To do this click on the Apple icon in the top left corner of your toolbar, then click on “About This Mac.” If the processor/chips says: -

macOS Downloads

+* **Intel** - `MacOS AMD64` +* **M1 or M2** - `MacOS ARM64` +{% endhint %} -Now that we have downloaded `hostd` we need to unzip it and move it to a more accessible location: +

macOS Download folder

-1. Double-click on the downloaded `hostd` zip file to unzip it -2. Click on the newly unzipped directory -3. Right-click on the path at the bottom of the Finder window and click "Open in Terminal" +2. Now that we have downloaded `hostd`, you may need unzip it and move it to a more accessible location: + * Double-click on the downloaded `hostd` zip file to unzip it if it hasn't done so automatically. + * Click on the newly unzipped directory. + * Right-click on the path bar at the bottom of the Finder window and click "Open in Terminal". -

macOS open in terminal

+

Options after right-clicking

-In the opened terminal window we will move the `hostd` binary to `/usr/local/bin`. Run the following command and press enter. +3. In the opened terminal window, move the `hostd` binary to `/usr/local/bin` by running the following command and press enter: -``` -sudo mv hostd /usr/local/bin +```bash +sudo mv hostd /usr/local/bin ``` -
+

Moving hostd binary

-Finally, we'll create a folder in our home drive to store `hostd`'s data. It is important to store `hostd`'s metadata on an SSD. You will need at least 80GB of space available. 50GB for the current blockchain and additional space for volume metadata. +You'll be prompted to authorize this action by providing your system password. Type this in and press enter to continue. -``` +4. Finally, for good practice, create a folder on the home drive. This folder will be utilized specifically to store data related to the `hostd` software. It is important to store `hostd`'s metadata on an SSD. You will need at least 80GB of space available. 50GB for the current blockchain and additional space for volume metadata. Run the following command to do so: + +```bash mkdir ~/hostd ``` ## Creating a wallet -`hostd` uses BIP-39 12-word recovery phrases. It does not support legacy 28/29-word `siad` seeds. If you already have a 12-word seed, skip this step. Run the following command to generate a new wallet recovery phrase: +1. `hostd` uses BIP-39 12-word recovery phrases. If you already have a 12-word seed, skip this step, otherwise run the following command to generate a new wallet recovery phrase: -``` +```bash hostd seed ``` -After pressing enter, a new 12-word recovery phrase will be generated. Please write down this phrase and keep it in a safe place. You will need this phrase to recover your wallet. If you lose this phrase, you will lose access to your wallet and funds. You will also see the wallet's funding address. You can send Siacoin to this address to fund your host. +A new 12-word recovery phrase will be generated, so please copy and store it in a safe place as you will need this phrase to recover your wallet. -

generate recovery phrase

+{% hint style="warning" %} +If you lose this phrase, you will lose access to your wallet and funds. Find out [more](../../get-started-with-sia/the-importance-of-your-seed.md) about the importance of your seed. +{% endhint %} -## Running hostd +You will also see the wallet's funding address. You can send Siacoin to this address to fund your host. -In the same terminal you used to generate your recovery phrase, run the following command to start `hostd:` +

Generating a recovery phrase and wallet's funding address

-``` -hostd --dir ~/hostd -``` +## Running `hostd` -You will be asked to input a password and a wallet recovery phrase. The password is used to unlock the `hostd` UI, it should be something secure and easy to remember. The recovery phrase is the 12-word phrase you generated in the previous step. Type it carefully, with one space between each word, or copy it from the previous step. These values are not stored anywhere; you will need to reenter them every time you start `hostd`. +1. In the same terminal, run the following command to start `hostd`: -{% hint style="info" %} -You can also set the `HOSTD_SEED` and `HOSTD_API_PASSWORD` environment variables so you do not have to reenter the values every time. -{% endhint %} - -

start hostd

- -After entering your password and recovery phrase, `hostd` will start. You can now access the `hostd` UI by opening a browser and going to `http://localhost:9980`. Enter your password to unlock `hostd`. +```bash +hostd --dir ~/hostd +``` -## Send Siacoin to your wallet +You will be prompted input both: -Before you can start hosting, you must send Siacoin to your wallet. Hosts must lock Siacoin as collateral to ensure they are financially incentivized to store data. Hosts also need Siacoin to submit storage proofs to the blockchain. Therefore, it is essential to always keep your wallet funded with Siacoin. If your wallet runs out of Siacoin, your host cannot submit storage proofs and you will lose collateral. +* `API password` - This password is chosen by you and can be anything you want it to be. It will be used to unlock the `hostd` UI via your browser, it should be something secure and easy to remember. +* `wallet seed` - The recovery phrase is the 12-word phrase you generated in the previous step. Type it carefully, with one space between each word, or copy it from the previous step. -To send Siacoin to your `hostd` wallet, you must get the wallet's address which can be found on the "Wallet" page of the `hostd` UI. +These values are not stored anywhere; and will be used requested every time you start `hostd`. {% hint style="info" %} -It is okay if your wallet is not synced at this point. You can still send funds to your wallet. However, they will not be available until the wallet is fully synced. +You can also set the `HOSTD_SEED` and `HOSTD_API_PASSWORD` environment variables so you do not have to re-enter the values every time. Check out this \ to set this. {% endhint %} -We recommend around $50 USD worth of Siacoin to start hosting. Hosts are constantly locking collateral; you may need more or less depending on how much data you store. - -1. Navigate to the "Wallet" page by clicking the "Wallet" icon in the sidebar -2. Click the "Receive" button in the top right corner of the page -3. Copy your wallet address by clicking the "Copy" button or scan the QR code with your phone - -

hostd wallet address

- -## Add storage - -A "volume" is a location on disk where `hostd` will store uploaded data. A volume can be anywhere, including network drives and external drives. You can create multiple volumes to combine storage from multiple drives. To add a volume: - -1. Click the "Volume" icon in the sidebar -2. Click the "Create Volume" button to add your first storage volume. - -

hostd create volume

- -1. Enter a name for the volume. We recommend something simple, like "hostdata.dat" -2. Use the built-in browser to select a folder to store the volume file. -3. Enter a maximum size for the volume. This is the maximum amount of data that can be stored in the volume. -4. Click "Create" to add the volume to \`hostd\` - -After clicking "Create," the volume will be displayed in the volumes list. Depending on the size of the volume and the filesystem, it may take a while to fully provision the new volume. The progress will be displayed in the UI. +2. After entering your desired `API password` and the created `wallet seed`, `hostd` will start. -

hostd volume list

+

Starting hostd

-## Configure the host +Your terminal will produce a range of different values you may not be familiar with, so feel free to check the tabs below to see what each of them are and why they are important: -Now that you have a volume, you can configure your host. First, navigate to the "Configuration" page in the sidebar. This page contains all of the pricing and settings available to hosts. +{% tabs %} +{% tab title="p2p" %} +**p2p (Peer-to-Peer) Component:** -

hostd configuration page

+* "p2p" refers to the communication between different nodes or devices without relying on a central server. +* `Listening on 127.0.0.1:9981` means that the application's p2p component is currently set to listen for incoming network connections on the local loopback IP address `127.0.0.1` (also known as `localhost`) and the port `9981`. Localhost refers to the current machine itself. +{% endtab %} -### Accepting contracts +{% tab title="api" %} +**api (Application Programming Interface) Component:** -The first setting to configure is the "Accepting Contracts" setting. This setting determines whether your host will accept new contracts. Most hosts will always have this toggled on. However, if you want to exit the network you can toggle this off to stop accepting new contracts. You will still be required to fulfill any existing contracts before fully shutting down your host. +* "api" refers to the application programming interface, which allows different software components to communicate and interact with each other. +* `Listening on 127.0.0.1:9980` indicates that the application's API component is actively waiting for incoming connections on the local loopback IP address `127.0.0.1` and the port `9980.` +{% endtab %} -### Address +{% tab title="rhp2" %} +**rhp2 (Remote Host Protocol - Version 2) Component:** -The next setting to configure is your host's net address. This is the address that is published to the blockchain and used by renters to connect to your host. Some users use their public IP address, but we recommend setting up a domain. You can use a free service like DuckDNS or No-IP or purchase a custom domain from a registrar. +* "rhp2" stands for Remote Host Protocol - Version 2, which pertains to a communication protocol between remote hosts without the necessity of a central server. +* Being configured to listen on `127.0.0.1:9982` signifies that the application's rhp2 component is presently configured to accept incoming network connections on the local loopback IP address `127.0.0.1` (also recognized as `localhost`) and the port `9982.` +{% endtab %} -Whichever method you choose, enter your address in the "Net Address" field followed by your host's RHP2 port, which defaults to `:9982`. For example, if your IP address is `199.111.78.80` you would enter `199.111.78.80:9982`. If your domain is `example.com`, you would enter `example.com:9982`. +{% tab title="rhp3 TCP" %} +**rhp3 TCP (Remote Host Protocol - Version 3) over TCP:** -

Configure netaddress

+* "rhp3 TCP" denotes the utilization of Remote Host Protocol - Version 3 over the Transmission Control Protocol (TCP). This protocol allows for remote hosts to communicate without relying on a centralized server. +* Listening on `127.0.0.1:9983` through TCP implies that the application's rhp3 component is actively awaiting incoming connections on the local loopback IP address `127.0.0.1` and the port `9983` using the TCP protocol. +{% endtab %} -#### Setup using Dynamic DNS +{% tab title="rhp3" %} +**rhp3 WebSocket (Remote Host Protocol - Version 3) over WebSocket**: -* [Cloudflare](../dynamic-dns/cloudflare-advanced.md) -* [DuckDNS](../dynamic-dns/duckdns.md) -* [No-IP](broken-reference) +* "rhp3 WebSocket" represents the implementation of Remote Host Protocol - Version 3 over the WebSocket communication protocol. This setup facilitates communication between remote hosts, eliminating the need for a central server. +* Operating on `127.0.0.1:9984` via WebSocket designates that the application's rhp3 component is actively ready to accept incoming connections on the local loopback IP address `127.0.0.1` and the port `9984` using the WebSocket protocol. +{% endtab %} +{% endtabs %} -#### Setup using public IP +3. You can now access the `hostd` UI by opening a browser and going to `http://localhost:9980`. -To find your public IP address click the following link: [https://icanhazip.com](https://icanhazip.com). It will display your public IP address. Copy this address to your clipboard. - -### Pricing - -On the Sia network, hosts set their prices for storage and bandwidth. The prices you select will determine how much you earn from hosting. - -{% hint style="info" %} -When setting prices, remember you are competing with other hosts. If your prices are too high, renters will choose other hosts. If your prices are too low, you will not earn enough to cover your costs. +{% hint style="warning" %} +Remember to leave the terminal window open while `hostd` is running. If you close the command prompt window, `hostd`will stop. {% endhint %} -We've put together some recommendations for pricing below. These are just recommendations, you can set your prices to whatever you want and change your prices at any time. Hosts will need to experiment with different prices to find the right balance between earnings and utilization. +

walletd Login UI

-* **Storage price:** the amount of Siacoins you charge per TB per month of storage. We recommend around $1 USD per TB per month to start. -* **Collateral:** the amount of Siacoins you lock per TB per month of storage. This should always be set to 2x your storage price. For example, if your storage price is 100 SC/TB/mo, you should set your collateral to 200 SC/TB/mo. -* **Ingress price:** the amount of Siacoins you charge per TB of data uploaded to your host. We recommend setting this low to encourage renters to upload data. Between $0.00 and $0.05 USD per TB. -* **Egress price:** the amount of Siacoins you charge per TB of data downloaded from your host. We recommend setting this higher to increase your earnings, above $5 USD per TB is a good starting point. -* **Maximum collateral:** the maximum amount of Siacoins you will lock into a single contract for collateral. This setting is important to limit your risk per contract. A good starting point is However, if you refuse to lock enough collateral for the data a renter wants to store, they will choose another host. Therefore, we recommend setting this around 10x your collateral price. For example, if your collateral price is 200 SC/TB/mo, you should set your maximum collateral to 2000 SC/TB/mo. +Enter your `API password` you created in the in the previous step to unlock `hostd`. -We recommend leaving other settings, such as "Contract price", "Base RPC price", "Sector access price," and "Price table validity" at their default values. They are primarily for advanced users. - -Once you are happy with your prices, click the "Save Changes" button in the top right corner of the page. - -## Port forwarding - -If you have a firewall or router you will need to forward/open TCP ports 9981-9983. How to do so is outside of the scope of this guide, there are tutorials available for most routers/firewalls available on Google. +{% hint style="success" %} +Congratulations on successfully setting up `hostd` and taking a significant step towards contributing your excess storage space to the Sia network. +{% endhint %} ## Waiting for sync Now that you have configured your host, you must wait for your host to finish syncing the blockchain. This can take several hours or even days depending on your hardware and internet connection. You can check the progress of the sync by mousing over the "Sia" logo at the top of the sidebar. -

check sync status

+

check sync status

## Announce your host @@ -187,11 +176,11 @@ To announce your host: 2. Click the "Announce" button in the top right corner of the page 3. Click "Announce" in the dialog to confirm -

announce your host

+

announce your host

After announcing, an "Unconfirmed" transaction will appear on the "Wallet" page. Once it is confirmed, your host will be visible on the network and renters will be able to form contracts with your host. -

unconfirmed announcement transaction

+

unconfirmed announcement transaction

## Check your host's status diff --git a/hosting/transferring-siacoins.md b/hosting/transferring-siacoins.md new file mode 100644 index 0000000..f86c88c --- /dev/null +++ b/hosting/transferring-siacoins.md @@ -0,0 +1,17 @@ +# 🚧 Transferring Siacoins + +Before you can start hosting, you must send Siacoin to your wallet. Hosts must lock Siacoin as collateral to ensure they are financially incentivized to store data. Hosts also need Siacoin to submit storage proofs to the blockchain. Therefore, it is essential to always keep your wallet funded with Siacoin. If your wallet runs out of Siacoin, your host cannot submit storage proofs and you will lose collateral. + +To send Siacoin to your `hostd` wallet, you must get the wallet's address which can be found on the "Wallet" page of the `hostd` UI. + +{% hint style="info" %} +It is okay if your wallet is not synced at this point. You can still send funds to your wallet. However, they will not be available until the wallet is fully synced. +{% endhint %} + +We recommend around $50 USD worth of Siacoin to start hosting. Hosts are constantly locking collateral; you may need more or less depending on how much data you store. + +1. Navigate to the "Wallet" page by clicking the "Wallet" icon in the sidebar +2. Click the "Receive" button in the top right corner of the page +3. Copy your wallet address by clicking the "Copy" button or scan the QR code with your phone + +\ diff --git a/miscellaneous/code-of-conduct.md b/miscellaneous/code-of-conduct.md deleted file mode 100644 index 8a338af..0000000 --- a/miscellaneous/code-of-conduct.md +++ /dev/null @@ -1,2 +0,0 @@ -# 🚧 Code of Conduct - diff --git a/miscellaneous/learn-more-and-contribute.md b/miscellaneous/getting-involved.md similarity index 86% rename from miscellaneous/learn-more-and-contribute.md rename to miscellaneous/getting-involved.md index 8fde4a9..24cc9de 100644 --- a/miscellaneous/learn-more-and-contribute.md +++ b/miscellaneous/getting-involved.md @@ -1,21 +1,19 @@ -# 👷 Learn more and contribute +# Getting Involved ## Learn more about Sia Sia provides an abundant array of valuable resources and excels in nurturing others' understanding of the Sia network. -* [Sia Website](https://sia.tech/) - ?? -* [Sia 101 Infographic](https://siastats.info/sia101) - ?? * [SiaStats](http://siastats.info/) - Charts and metrics of the Sia network. * [Sia's API](https://api.sia.tech) - The Sia Storage Platform API documentation. ## Contribute to Sia -If you've got some dev skills and free time, Sia is here for you. +If you've got some dev skills and free time, Sia is here for you! Sia is 100% open source. The US and EU-based Sia Foundation team have been the core developers of Sia, but hundreds of individuals have contributed either to the core code or apps built on top of the network. -View [GitHub](https://github.com/siafoundation) and contribute to all Sia development. Check all our repos! +While there is a distinct development and operations team, dozens of individuals have contributed to the core code or apps built on top of the network. Check out our [GitHub repositories](https://github.com/SiaFoundation) if you're interested in following along or writing code for Sia and further decentralizing the project! ## Join us! diff --git a/miscellaneous/releases.md b/miscellaneous/releases.md new file mode 100644 index 0000000..6acb10f --- /dev/null +++ b/miscellaneous/releases.md @@ -0,0 +1,113 @@ +# 🚧 Releases + +All Sia software is compatible for:\ + + +
Operating SystemArchitectureChip/Processor Requirements
Windows AMD64x86-64 compatible CPU
MacOS AMD64x86-64 compatible CPU
ARM64ARMv8-A compatible CPU
Linux AMD64x86-64 compatible CPU
ARM64ARMv8-A compatible CPU
+ +{% hint style="info" %} +Please note that the "AMD64" architecture is a common name for the x86-64 architecture, and it doesn't necessarily mean that the processor must be made by AMD. It includes CPUs from various manufacturers, such as Intel and AMD, that are compatible with the x86-64 instruction set. +{% endhint %} + +## [renterd](broken-reference) + +Rent storage space on the Sia network + +
+ +v0.4.0-betaLatest Pre-release + + + +**Last week** + +
+ +* [Source code](https://github.com/SiaFoundation/renterd) +* [Project Roadmap](https://github.com/orgs/SiaFoundation/projects/3) +* [API Docs](https://api.sia.tech/renterd) + +*** + +## [hostd](broken-reference) + +Offer you storage space on the Sia network + +
+ +v0.1.4Latest + +`v0.1.4` focuses on enhancing performance, efficiency, and user experience. It introduces a cache for contract sector roots to improve contract lookup speeds, optimizes metrics monitoring with a shorter interval, and increases sector batch size for faster volume operations. The contract lifecycle is adjusted for better alignment with blockchain status, and database transaction retries are improved with backoff and jitter mechanisms. + +Removed unnecessary components therefore streamlining the system. The fixes address various issues, including metric calculations, volume removal, and integration concerns. + +Overall, the latest version aims to boost system efficiency, reliability, and user interactions while refining existing features and addressing identified issues. + +La**st week** + +[**Download**](https://sia.tech/software/hostd) + +
+ +
+ +v0.1.3Pre-release + + + +**2 weeks ago** + +
+ +
+ +v0.1.2Pre-release + + + +**Last Month** + +
+ +
+ +v0.1.1Pre-release + + + +**July 16th 2023** + +
+ +
+ +v0.1.0Pre-release + + + +**June 27th 2023** + +
+ +* [Source code](https://github.com/SiaFoundation/hostd) +* [Project Roadmap](https://github.com/orgs/SiaFoundation/projects/3/views/1) +* [API Doc](https://api.sia.tech/hostd)[s](https://api.sia.tech/hostd) + +*** + +## [walletd](https://github.com/SiaFoundation/walletd) + +Manage your wallet on the Sia network + +
+ +v0.1.0-alphaLatest Pre-release + + + +**July 1st 2023** + +
+ +* [Source code](https://github.com/SiaFoundation/walletd) +* Project Roadmap diff --git a/miscellaneous/version-matrix.md b/miscellaneous/version-matrix.md deleted file mode 100644 index 92e9060..0000000 --- a/miscellaneous/version-matrix.md +++ /dev/null @@ -1,23 +0,0 @@ -# 🚧 Version matrix - - - -{% tabs %} -{% tab title="renterd" %} - -{% endtab %} - -{% tab title="hosts" %} - -{% endtab %} - -{% tab title="walletd" %} - - -| | | | -| - | - | - | -| | | | -| | | | -| | | | -{% endtab %} -{% endtabs %} diff --git a/renting/about-renting.md b/renting/about-renting.md index 5fb049b..010b1e3 100644 --- a/renting/about-renting.md +++ b/renting/about-renting.md @@ -63,7 +63,3 @@ Setting your allowance happens before uploading files, and Sia starts to automat ## **Uploading files** Uploading files is done using the `renterd` Sia software either via API or its user-interface which is accessible via web browser. - -## Software - -The `renterd` software is how you rent storage on Sia. Software downloads can be found on the [`renterd` page](https://sia.tech/software/renterd) of the official website. diff --git a/renting/how-to-back-up-your-files.md b/renting/how-to-back-up-your-files.md deleted file mode 100644 index 1687c5f..0000000 --- a/renting/how-to-back-up-your-files.md +++ /dev/null @@ -1,59 +0,0 @@ -# 🚧 Back up and restore your files - -Back in version 1.4.1 of Sia, we introduced seed-based file recovery. This feature lets you create a metadata snapshot of your current files, which is stored on the Sia network and linked to your seed. As long as your contracts are active, you can then use this backup to restore your files at any future date and from any (preferably empty) Sia node. - -When your files are on Sia, they're on the most private, secure network in the world. With seed-based file recovery, they're now also recoverable anywhere, anytime. - -File backups are meant to be used to restore files in a brand new instance of Sia, but can also be accessed in your current Sia node. - -{% hint style="info" %} -Your contracts need to be active, which means Sia isn't totally fire-and-forget just yet. You still need to boot Sia up every few weeks to renew your allowance and contracts. -{% endhint %} - -## Back up your files in Sia-UI - -### **Create your backup** - -After you've [uploaded files to Sia](broken-reference), go to the Rent tab and click **More**. You've got two new options, Backup Files and Restore Files. Click **Backup Files**. - -![](../.gitbook/assets/backup-1.png) - -Name your backup file, and click **Start Backup**. - -![](../.gitbook/assets/backup-2.png) - -Sia now takes a snapshot of your current files and stores it in the cloud. You'll see a notification pop up in the upper right corner to let you know. - -![](../.gitbook/assets/backup-3.png) - -### View your backups - -Just created your first backup? You can verify that Sia's got it. - -Click on **More** and go to **Restore Files** to see your available backups. If any backups are currently being taken, you'll see a green progress bar. It can take a while for a backup to complete, so check back later if it's not done. Completed backups show with the date they were taken, and an option to restore them. - -![](../.gitbook/assets/backup-4.png) - -### Restore your backup - -File backups are typically used to restore your files in a new instance of Sia if the one you were previously using had issues. If you haven't set an allowance or uploaded files in Sia yet, you can choose **Restore Files** as soon as you go to the Rent tab. - -![](../.gitbook/assets/backup-5.png) - -Otherwise, get to **Restore Files** from More. - -Sia needs to scan for your contracts and your backups. Click **Start Recovery Scan**. - -![](../.gitbook/assets/backup-6.png) - -Sia will scan for your contracts and available backups. You'll see a progress bar indicating how many blocks it has scanned. - -![](../.gitbook/assets/backup-7.png) - -Wait for the scan to complete. Sia might find your backups right away, but it might need some time. Give Sia up to 10 minutes after the scan completes to locate your backups. They'll appear in the window once they've been found. If after 10 minutes you don't see them, click **Start Recovery Scan** again. - -![](../.gitbook/assets/backup-8.png) - -Sia has found your backups. Click **Restore** next to the one you want. Feel free to close this window, or reopen it to check back - your files will begin to appear in the file manager in Sia over the next few minutes. - -There's one last step - check your allowance to make sure it's set. Sia needs your allowance to be able to spend your Siacoins on contracts and download bandwidth to get your files back. Once that's done, you're good to go! diff --git a/renting/managing-your-files.md b/renting/managing-your-files.md index ecb249c..f93e1c2 100644 --- a/renting/managing-your-files.md +++ b/renting/managing-your-files.md @@ -1,58 +1,45 @@ ---- -description: >- - There's some specific info you should know before you get your first file on - Sia. ---- +# Managing Files -# 🚧 Managing your files +## Maintaining Data -{% hint style="info" %} -As with any file storage or backup solution, Sia should not be your sole location for critical files. -{% endhint %} +To ensure the constant availability of your data, there are a few crucial tasks you should perform periodically. -## Uploading +{% hint style="warning" %} +`renterd` **MUST** be running with your wallet unlocked for these any actions to take place, therefore advisable to open it at least once a month and let it run overnight to perform various essential housekeeping tasks. -Uploading happens in Sia-UI or your preferred command-line interface. Sia-UI has your standard file browser or drag-and-drop options, just like any other file storage application. There are special commands that you'll want to become familiar with when using the CLI version of Sia, which is called `siac`. +If you upload files and subsequently neglect to reopen `renterd`, your allowance and contracts will eventually expire, leading to the immediate deletion of your files once your contracts become invalid. +{% endhint %} -When you begin to upload a file to Sia, it has to get processed on your machine to allow for maximum redundancy and security on the network. It is first split into manageable chunks. Each chunk is then run through a process that creates 30 pieces, each of which gets encrypted before being sent to a different host. Only 10 of the 30 pieces are needed to reconstruct a chunk, but no host ever sees more than one. This means, for each part of your original file, 20 hosts could drop from the network and your data will still be safe and secure. +### **Refreshing your allowance** -{% hint style="info" %} -For the more technical readers, here is what happens behind the scenes: +About six weeks after your contracts are created, your allowance attempts to refill itself. `renterd` will never spend more than your allowance, so it needs to be refilled to facilitate contract renewals and downloads through the rest of the contract period. -* Files are chunked into 40MB chunks (if a file is smaller, it is padded to 40MB so that data looks identical as it moves across networks) -* Each chunk is then erasure-coded using [Reed-Solomon](https://en.wikipedia.org/wiki/Reed%E2%80%93Solomon\_error\_correction) encoding. After processing, each chunk has 30 unique 4MB pieces associated with it. -* Each piece is then encrypted using [Threefish](https://en.wikipedia.org/wiki/Threefish) and uploaded to a distinct host. -* Because Reed-Solomon encoding is done with 10 data shards and 20 parity shards, any 10 pieces are sufficient for rebuilding the file. +{% hint style="info" %} +The allowance will refill automatically when you open `renterd`. {% endhint %} -That's a lot of details but just know: you don't have to do anything, or even see that this process happens. +### **Renewing your contracts** -## Limits on uploading\* +Your storage contracts will renew automatically at the end of the contract period. By default, Sia will attempt to renew your contract within about one month of the contract expiration date. -\*These numbers will change over time. +If you started renting at the beginning of January, your 3-month contracts would expire around the end of March. Sia would attempt to renew contracts around the beginning of March. -**Maximum total storage:** Sia can currently handle 35 TB of data in a single node, or installation of Sia. +{% hint style="info" %} +Your contracts renew automatically when you open `renterd`. +{% endhint %} -**File size:** The minimum file size on Sia is currently 40 MB. Uploading smaller files isn't a problem, but Sia will pad each of them out to 40 MB. Your 80 MB short video stays 80 MB. But your 8 MB photo and your 100 KB document each become 40 MB when uploaded. +### **Boosting file health** -This means that, if you're uploading many small files, you'll save a lot of money by zipping them up together before uploading. This minimum file size will be _significantly_ reduced in a future update. +In `renterd`, the health of your files is quantified as a percentage, representing the quantity of available fragments that make up each file. Ideally, you should strive for a perfect health rating of 100%, indicating that all 30 file fragments are securely distributed among various hosts. -## Health and Redundancy +

File health check in renterd

-In Sia, you'll see the health of your files represented as a percentage. This refers to how many pieces of this file are available. You always want this to be 100%, which means that all 30 pieces of your file are stored on hosts. Sia is smart though – if a host goes offline, it will re-duplicate that piece on a new host the next time it checks. +`renterd` incorporates an intelligent redundancy system that swiftly replicates any missing fragment onto a new host in case one becomes unavailable during its next active check. -Sia can only check when it's active though, so be sure to open Sia periodically to refresh the health of your files. +Health assessments can only be conducted if `renterd` when it's actively running. To ensure the ongoing integrity of your data, it's advisable to periodically launch and operate Sia, allowing it to refresh the health status of your files and sustain their redundancy at optimal levels. ## Downloading -Downloading files happens right through the app as well. There's a small download icon next to each file in your list. Downloading requires Siacoins since you pay for the bandwidth you use. - -### Maintaining Data _\*\*_ - -In order to make sure that your data is always available, there's a couple of important tasks you should periodically perform. - -* **Refreshing your allowance** - About six weeks after your contracts are created, your allowance attempts to refill itself. Sia will never spend more than your allowance, so it needs to be refilled to facilitate contract renewals and downloads through the rest of the contract period. _**!** The allowance will refill automatically when you open Sia._ -* **Renewing your contracts** - Your storage contracts will renew automatically at the end of the contract period. By default, Sia will attempt to renew your contract within about 1 month of the contract expiration date. If you started renting at the beginning of January, your 3-month contracts would expire around the end of March. Sia would attempt to renew them around the beginning of March. _**!** Your contracts renew automatically when you open Sia._ -* **Boosting file health** - File health and redundancy are also boosted if needed, as described above. +Downloading files occurs directly within the app as well. Each file in your list is accompanied by a small download icon. Downloading necessitates Siacoins because you are billed for the bandwidth consumed. -**Sia needs to be running with your wallet unlocked for these things to occur**, so as a renter, it's a good idea to open Sia **at least once a month** and let it run overnight to take care of miscellaneous housekeeping tasks such as these. If you simply upload files and then never open Sia again, your allowance and your contracts will eventually expire and your files will be immediately deleted once your contracts are no longer valid. +

Downloading files in renterd

diff --git a/renting/renter-troubleshooting.md b/renting/renter-troubleshooting.md deleted file mode 100644 index cd528e1..0000000 --- a/renting/renter-troubleshooting.md +++ /dev/null @@ -1,167 +0,0 @@ -# 🚧 Renter troubleshooting - -There are some common issues that you might encounter when uploading files to Sia, mostly related to stuck or stalling uploads. There are some easy solutions for these issues, as long as you have the right info. We’ll detail what to look for and possible solutions in this document. - -`siac`, the command-line for Sia, is a great way to get information that can help identify your problem. Commands can be run in your preferred CLI, or in Sia-UI by accessing the built-in Terminal from the top menu bar. - -## Gather general Sia info - -Use the command `siac`. This will print basic info about Sia’s status, focusing on your blockchain sync status, your wallet status, and some info about your renter. - -```go -Consensus: - Synced: Yes - Height: 216307 - -Wallet: - Status: unlocked - Siacoin Balance: 415.95 KS - -Renter: - Files: 257 - Total Stored: 2.93 TB - Min Redundancy: 0 - Contracts: 52 -``` - -You can use this info to make sure that your wallet is unlocked, that you have enough Siacoins, and check important renter info like your number of files, amount of data stored, and minimum redundancy. - -If your wallet is locked, you can’t spend Siacoins. This means you can’t form contracts or renew your allowance. This alone can grind your Sia renting to a standstill. - -If you don’t have enough contracts, Sia won’t be able to maintain your data on the network. Contracts should usually be right around 50. If you have too few, your allowance settings might be too strict. Try raising the amount you’re willing to spend on storage and confirm the number of hosts in your allowance settings as this controls the number of contracts. - -### Get renter-specific info - -Use the command `siac renter`. This will print some info that you saw earlier, but also important allowance info. - -{% hint style="info" %} -**Quick Tip:** Your allowance is the maximum amount of Siacions you’re willing to spend on storage. By setting this number, you’re making sure that you don’t end up spending way more over your contract period than you intended. If your allowance runs out, you can’t make new contracts and your data will eventually be removed from Sia. -{% endhint %} - -```go -Allowance: 12 KS - Spent Funds: 254.4 SC - Unspent Funds: 11.75 KS - -Data Storage: - Files: 257 - Total Stored: 2.93 TB - Min Redundancy: 0 - Contracts: 52 -``` - -You can also run `siac renter allowance` to get even more detailed allowance info. - -```go -Allowance: - Amount: 75 KS - Period: 12096 blocks - Renew Window: 4032 blocks - Hosts: 50 - -Expectations for period: - Expected Storage: 23.0000 TB - Expected Upload: 560.000 GB - Expected Download: 280.000 GB - Expected Redundancy: 3 - -Spending: - Current Period Spending: - Spent Funds: 18.07 KS - Storage: 12.72 KS - Upload: 732.2 SC - Download: 3.093 SC - Fees: 4.617 KS - Unspent Funds: 56.93 KS - Allocated: 29.03 KS - Unallocated: 27.9 KS - Previous Spending: 34.32 KS - Withheld Funds: 0 H - Release Block: 0 -``` - -You can use this to see if your allowance is large enough to accommodate the amount of storage you’re trying to rent. This might clue you in that you need to raise your allowance or add more Siacoins to your wallet if you don’t have enough to set a proper allowance. - -Specifically, look at your Unspent Unallocated amount. If this is reporting very low amounts of Siacoins then the allowance needs to be increased because all the other funds have been locked up. - -Use the command `siac renter contracts`. This will print a long list of your contracts, but importantly will allow you to see your number of active contracts and the total amount of data stored. - -### The log files - -There’s also another important file - the renter.log. This can be found in the `/sia/renter/` folder in your Sia data folder. You can use this to search for errors classified as `worker` or `uploadheap`. - -Worker logs to search for: - -```go -2019/07/29 18:16:05.728694 worker.go:199: Refreshed Worker Pool has 167 total workers and 0 are on cooldown -``` - -This log will tell you how many of your workers are on cool down. Search for \`Refreshed Worker Pool\`. If too many of your workers are on cooldown then uploads and downloads will be impacted. To find out why and which workers are on cooldown see the log messages directly above this line. There will be a line for each worker. - -Uploadheap logs to search for: - -```go -2019/07/29 18:16:12.598899 uploadheap.go:1122: [DEBUG] Executing an upload and repair cycle, uploadHeap has 250 chunks in it -``` - -Search for `Executing`. Check to see if this line appears and if so, how often. This will tell you how fast your renter is working through the uploadHeap for repairs. Also, it should always have 250 chunks in it so if that number is not 250 then let the core team know so they can investigate. One edge case is if you are on the last cycle and have less than 250 chunks remaining, or there are just less than 250 chunks that need repair in general. - -```go -2019/07/29 18:16:12.598899 uploadheap.go:348: WARN: no chunk indicies gathered, can’t add chunks to heap -``` - -If this is coming up a lot, this could be an issue. Reach out to a core team member. - -Check your root `.siadir` file: - -```go -cat siad/renter/siafiles/.siadir - -{"aggregatehealth":0.75,"aggregatelasthealthchecktime":"2019-08- -05T18:10:19.088309123+02:00","aggregateminredundancy":1.5,"aggregatemodtime":"2019-08- -05T20:13:52.972312906+02:00","aggregatenumfiles":63062,"aggregatenumstuckchunks":0,"aggregatenumsubdirs":0,"aggregatesize" -:23044664385536,"aggregatestuckhealth":0,"health":0,"lasthealthchecktime":"2019-08- -05T20:40:08.755212828+02:00","minredundancy":0,"modtime":"2019-08- -05T20:40:08.755948025+02:00","numfiles":0,"numstuckchunks":0,"numsubdirs":10,"size":0,"stuckhealth":0} -``` - -If you have python installed on your machine: - -```python -cat siad/renter/siafiles/.siadir | python -m json.tool - -{ - "aggregatehealth": 0.75, - "aggregatelasthealthchecktime": "2019-08-05T18:10:19.088309123+02:00", - "aggregateminredundancy": 1.5, - "aggregatemodtime": "2019-08-05T20:13:52.972312906+02:00", - "aggregatenumfiles": 63062, - "aggregatenumstuckchunks": 0, - "aggregatenumsubdirs": 0, - "aggregatesize": 23044664385536, - "aggregatestuckhealth": 0, - "health": 0, - "lasthealthchecktime": "2019-08-05T20:40:08.755212828+02:00", - "minredundancy": 0, - "modtime": "2019-08-05T20:40:08.755948025+02:00", - "numfiles": 0, - "numstuckchunks": 0, - "numsubdirs": 10, - "size": 0, - "stuckhealth": 0 -} -``` - -Here is the aggregate metadata of your filesystem that the repair loop is going to use. If `aggregatehealth` is <= 0.25 then your system is healthy, if it is > 0.25 then it should be repairing. - -If there is a large number of `aggregatenumstuckchunks` then slow uploads could be because all the work is relying on the stuck loop. In this case, you can try `siac renter unstuckall` to try and unmark those stuck chunks and allow for the repair loop to pick them up again. - -Big things that you want to check for: - -* Is your wallet unlocked? -* Does your allowance have Siacoins in it? -* Is your allowance large enough? -* Do you have enough active contracts? -* Do you have enough total contracts? - -Reference the [renter README](https://github.com/SiaFoundation/siad/blob/master/modules/renter/README.md) to get an understanding of how the upload should be happening to then understand if the logs in renter.log make sense or indicate an error. diff --git a/renting/renting-storage-on-sia.md b/renting/renting-storage-on-sia.md deleted file mode 100644 index a78cccd..0000000 --- a/renting/renting-storage-on-sia.md +++ /dev/null @@ -1,2 +0,0 @@ -# 🚧 Renting storage on Sia - diff --git a/renting/renting-storage.md b/renting/renting-storage.md new file mode 100644 index 0000000..2a6e12c --- /dev/null +++ b/renting/renting-storage.md @@ -0,0 +1,44 @@ +# Renting Storage + +Uploading files on `renterd` is remarkably straightforward, making it accessible even to those new to the Sia network. With just a few simple steps, you can securely store your files and data on Sia's decentralized cloud storage platform, where a network of hosts ensures the redundancy and reliability of your files. `renterd` provides an intuitive interface for effortlessly transferring your files to the Sia network. + +## Before you begin... + +* **Install `renterd`**: Make sure you have the latest version of `renterd` installed on your machine. +* **Create a Wallet**: If you haven't already, create a Sia wallet to store your Siacoins. +* **Fund Your Wallet**: Transfer Siacoins (SC) to your Sia wallet from an exchange or another source. You'll need these coins to pay for storage. + +## Uploading your files in renterd + +{% hint style="warning" %} +Uploading files and data using `renterd` is a very straightforward process, assuming you have completed all the steps of the `renterd` guide and it running. Visit the [renterd](setting-up-renterd/) guides ensure everything is set up correctly before proceeding. +{% endhint %} + +1. Access the `rentered` UI from your local host address. Enter your `API password` you created to unlock `renterd`. + +

renterd Login UI

+ +2. Drag-and-drop files or in the top right corner, click the "Upload Files" button to begin uploading files. It's that simple! + +

File upload UI

+ +Once you've chosen the file(s) to upload, it will be classed as active uploads, give it a few seconds. + +{% hint style="success" %} +Congratulations on successfully uploading your file(s) using `renterd`! Your data is now securely stored on the Sia network, benefiting from the reliability and resilience of decentralized storage. +{% endhint %} + +## File processing + +When you begin to upload a file to Sia, it undergoes processing on your local machine to ensure optimal redundancy and security within the network. Initially, the file is divided into manageable chunks. Subsequently, each chunk undergoes a procedure that generates 30 distinct pieces, each of which is encrypted before being dispatched to separate hosts. It's worth noting that only 10 out of the 30 pieces are required for reconstructing a chunk, and no single host ever has access to more than one piece. + +This arrangement ensures that, for each section of your original file, up to 20 hosts could become disconnected from the network, yet your data would remain safe and secure. + +{% hint style="info" %} +For the more technical readers, here is what happens behind the scenes: + +* Files are chunked into 40MB chunks (if a file is smaller, it is padded to 40MB so that data looks identical as it moves across networks) +* Each chunk is then erasure-coded using [Reed-Solomon](https://en.wikipedia.org/wiki/Reed%E2%80%93Solomon\_error\_correction) encoding. After processing, each chunk has 30 unique 4MB pieces associated with it. +* Each piece is then encrypted using [Threefish](https://en.wikipedia.org/wiki/Threefish) and uploaded to a distinct host. +* Because Reed-Solomon encoding is done with 10 data shards and 20 parity shards, any 10 pieces are sufficient for rebuilding the file. +{% endhint %} diff --git a/renting/setting-up-renterd/README.md b/renting/setting-up-renterd/README.md new file mode 100644 index 0000000..0683d9f --- /dev/null +++ b/renting/setting-up-renterd/README.md @@ -0,0 +1,2 @@ +# Setting up renterd + diff --git a/renting/setting-up-renterd/linux.md b/renting/setting-up-renterd/linux.md new file mode 100644 index 0000000..92ef896 --- /dev/null +++ b/renting/setting-up-renterd/linux.md @@ -0,0 +1,3 @@ +# 🚧 Linux + +This guide will walk you through setting up a new `renterd` on Linux. For this guide, we are using Ubuntu, but the steps should work with most Linux distros. At the end of this guide, you should have a working `renterd` diff --git a/renting/setting-up-renterd/macos.md b/renting/setting-up-renterd/macos.md new file mode 100644 index 0000000..8ca7488 --- /dev/null +++ b/renting/setting-up-renterd/macos.md @@ -0,0 +1,129 @@ +# macOS + +This guide will walk you through setting up `renterd` on macOS. At the end of this guide, you should have the following: + +* **Installed Sia `renterd` software:** Successfully installed the Sia `renterd` software on your macOS system with the appropriate binary. +* **Created a `renterd` wallet**: Have created a wallet with a Seed to access and manage your Sia network transactions and store your Siacoins in `renterd`. + +## Pre-requisites + +* **Network Access:** `renterd` interacts with the Sia network, so you need a stable internet connection and open network access to connect to the Sia blockchain. +* **Operating System Compatibility:** Ensure that your macOS version is compatible with the walletd software. Check [releases](../../miscellaneous/releases.md) supported macOS versions. +* **System Updates:** Ensure that your macOS is up to date with the latest system updates, as these updates can contain important security fixes and improvements. + +## Getting `renterd` + +1. Download the latest version of `renterd` for your operating system from the [official website](https://sia.tech/software/renterd). For the purpose of this guide, we'll be downloading the macOS version of `renterd` and unzip the binary to `/usr/local/bin`. + +{% hint style="warning" %} +Remember to check which version to download to ensure it works correctly with your operating system. To do this click on the Apple icon in the top left corner of your toolbar, then click on “About This Mac.” If the processor/chips says: + +* **Intel** - `MacOS AMD64` +* **M1 or M2** - `MacOS ARM64` +{% endhint %} + +

macOS Download folder

+ +2. Now that we have downloaded `renterd`, you may need unzip it and move it to a more accessible location: + * Double-click on the downloaded `renterd` zip file to unzip it if it hasn't done so automatically. + * Click on the newly unzipped directory. + * Right-click on the path bar at the bottom of the Finder window and click "Open in Terminal". + +

Options after right-clicking

+ +3. In the opened terminal window, move the `renterd` binary to `/usr/local/bin` by running the following command and press enter: + +```bash +sudo mv renterd /usr/local/bin +``` + +

Moving renterd binary

+ +You'll be prompted to authorize this action by providing your system password. Type this in and press enter to continue. + +4. Finally, for good practice, create a folder on the home drive. This folder will be utilized specifically to store data related to the `renterd` software. + +```bash +mkdir ~/renterd +``` + +## Creating a wallet + +1. `renterd` uses BIP-39 12-word recovery phrases. If you already have a 12-word seed, skip this step, otherwise run the following command to generate a new wallet recovery phrase: + +```bash +renterd seed +``` + +A new 12-word recovery phrase will be generated, so please copy and store it in a safe place as you will need this phrase to recover your wallet. + +{% hint style="warning" %} +If you lose this phrase, you will lose access to your wallet and funds. Find out [more](../../get-started-with-sia/the-importance-of-your-seed.md) about the importance of your seed. +{% endhint %} + +

Generating a recovery phrase

+ +## Running `renterd` + +1. In the same terminal, run the following command to start `hostd`: + +```bash +renterd --dir ~/renterd +``` + +You will be prompted input both: + +* `API password` - This password is chosen by you and can be anything you want it to be. It will be used to unlock the `renterd` UI via your browser, it should be something secure and easy to remember. +* `wallet seed` - The recovery phrase is the 12-word phrase you generated in the previous step. Type it carefully, with one space between each word, or copy it from the previous step. + +These values are not stored anywhere; and will be used requested every time you start `renterd`. + +{% hint style="info" %} +You can also set the RENTERD`_SEED` and RENTERD`_API_PASSWORD` environment variables so you do not have to re-enter the values every time. Check out this \
to set this. +{% endhint %} + +2. After entering your desired `API password` and the created `seed`, `hostd` will start. + +

Starting renterd

+ +Your terminal will produce a two different values you may not be familiar with, so feel free to check the tabs below to see what each of them are and why they are important: + +{% tabs %} +{% tab title="p2p" %} +**api (Application Programming Interface) Component:** + +* "api" refers to the application programming interface, which allows different software components to communicate and interact with each other. +* `Listening on 127.0.0.1:9980` indicates that the application's API component is actively waiting for incoming connections on the local loopback IP address `127.0.0.1` and the port `9980`. +{% endtab %} + +{% tab title="bus" %} + +{% endtab %} +{% endtabs %} + +3. You can now access the `renterd` UI by opening a browser and going to `http://localhost:9980`. + +{% hint style="warning" %} +Remember to leave the terminal window open while `hostd` is running. If you close the command prompt window, `hostd`will stop. +{% endhint %} + + + +

renterd Login UI

+ +Enter your `API password` you created in the in the previous step to unlock `renterd`. + +{% hint style="success" %} +Congratulations on successfully setting up `renterd` and taking a significant step towards renting storage space on the Sia network. +{% endhint %} + +## Updating + +It is very important to keep your host up to date. New versions of `renterd` are released regularly and contain bug fixes and performance improvements. + +To update: + +1. Download the latest version of `renterd` from the [official website](https://sia.tech/software/renterd). +2. Stop the `renterd` service with the command `sudo systemctl stop renterd` +3. Unzip and replace `renterd` in `/usr/local/bin` with the new version +4. Restart `renterd` with `sudo systemctl start renterd` diff --git a/renting/setting-up-renterd/windows.md b/renting/setting-up-renterd/windows.md new file mode 100644 index 0000000..1f63579 --- /dev/null +++ b/renting/setting-up-renterd/windows.md @@ -0,0 +1,2 @@ +# 🚧 Windows + diff --git a/renting/setup-guides/README.md b/renting/setup-guides/README.md deleted file mode 100644 index b6b8a39..0000000 --- a/renting/setup-guides/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# 🚧 Setup Guides - diff --git a/renting/setup-guides/linux.md b/renting/setup-guides/linux.md deleted file mode 100644 index 5cc4b51..0000000 --- a/renting/setup-guides/linux.md +++ /dev/null @@ -1,2 +0,0 @@ -# Linux - diff --git a/renting/setup-guides/macos.md b/renting/setup-guides/macos.md deleted file mode 100644 index 52f9cf7..0000000 --- a/renting/setup-guides/macos.md +++ /dev/null @@ -1,2 +0,0 @@ -# macOS - diff --git a/renting/setup-guides/windows.md b/renting/setup-guides/windows.md deleted file mode 100644 index 375784c..0000000 --- a/renting/setup-guides/windows.md +++ /dev/null @@ -1,2 +0,0 @@ -# Windows - diff --git a/renting/transferring-siacoins.md b/renting/transferring-siacoins.md new file mode 100644 index 0000000..e803169 --- /dev/null +++ b/renting/transferring-siacoins.md @@ -0,0 +1,71 @@ +# 📷 Transferring Siacoins + +Whether you're sending Siacoins to an exchange or receiving from friend, `renterd` facilitate the transfer of Siacoins and easily achieved via the UI. + +## Sending Siacoins (SC) + +Go to `renterd`. If you're asked to unlock the UI, use your custom password if you've set one. If you haven't got a wallet set up on `renterd`, visit our [Setting up renterd](setting-up-renterd/), otherwise choose from the **sidebar** a **Wallet**. + +

renterd UI choosing "Wallet" from sidebar

+ +### Setup your transaction + +Click on the `Send` button. Enter the recipient's wallet address and the amount of Siacoins you want to send. Make sure that you've entered a Siacoin wallet address, and that you've entered it correctly. + +

Sending Siacoins via renterd

+ +{% hint style="warning" %} +Siacoins sent to mistyped addresses, or addresses of other types of cryptocurrency can not be retrieved. +{% endhint %} + +Click **Generate Transaction.** + +### Confirm your info + +Next, you need to confirm everything. You'll have a chance to double-check the currency, amount, and recipient address. The window will also show you estimated network fees. + +

Confirming your transaction

+ +Click **Setup** to change something. If it's all good, click B**roadcast transaction**. + +

Confirmation of a successful transaction broadcasted

+ +You'll immediately get a confirmation that your transaction has been successfully broadcasted. + +### Checking the status + +By looking at the transactions in the **Wallet** section of the UI, you can check the transaction status. It's normal to 'Unconfirmed' at the latest transaction, as it means the transaction is on its way but hasn't yet appeared in a block. + +

renterd wallet transaction list

+ +{% hint style="info" %} +It might take a minute or two for the transaction to pop up in the wallet's transactions list. +{% endhint %} + +Once it's in a block, you can go back to check the status and see new transaction type of 'siacoin transfer'. + +\ + +## Receiving Siacoins (SC) + +Go to `renterd`. If you're asked to unlock the UI, use your custom password if you've set one. If you haven't got a wallet set up on `renterd`, visit our [Setting up renterd](setting-up-renterd/), otherwise choose from the **sidebar** a **Wallet**. + +

renterd UI choosing "Wallet" from sidebar

+ +### Sharing the address or QR + +Copy and paste this manually, or use the **Copy** button to the right to make sure you get the full address without any extra spaces, and provide this address to whom ever you're receiving the fund from. + +You can also receive Siacoin, simply share your wallet address by displaying your QR code for others to scan. + +

Getting the address and QR of your renterd wallet

+ +By going to your **Dashboard**, and selecting the wallet you made the transaction with, you can check the transaction status. It's normal to 'Unknown' at the top of the list of transactions, it means the transaction is on its way but hasn't yet appeared in a block. + +{% hint style="info" %} +It might take a minute or two for the transaction to pop up in the wallet's transactions list. +{% endhint %} + +Once it's in a block, you can go back to check the status and see new transaction type of 'siacoin transfer'. + +\ diff --git a/siafunds/how-do-i-buy-siafunds.md b/siafunds/how-do-i-buy-siafunds.md deleted file mode 100644 index fe87290..0000000 --- a/siafunds/how-do-i-buy-siafunds.md +++ /dev/null @@ -1,9 +0,0 @@ -# How do I buy Siafunds? - -Siafunds aren't available on normal exchanges. The SEC has designated Siafunds as securities according to United States laws. **We recommend that you research the applicable securities laws in your country before buying or selling Siafunds.** - -If you are based in the United States, you may be required to be an accredited investor to buy or sell Siafunds. We recommend consulting with an attorney. - -We treat them like securities, and most exchanges aren't willing to follow the regulatory requirements necessary to trade in securities. - -There are however [Siafunds markets on Bisq](https://bisq.network/markets/?currency=sf\_btc), a decentralized exchange. You can also check the [Sia Discord server](https://sia.tech/discord) for the #siafunds channel, where over-the-counter trades are available through a trusted escrow. diff --git a/siafunds/how-to-cash-out-siafunds.md b/siafunds/how-to-cash-out-siafunds.md index 5d85c67..9018b1d 100644 --- a/siafunds/how-to-cash-out-siafunds.md +++ b/siafunds/how-to-cash-out-siafunds.md @@ -1,6 +1,6 @@ # How to cash out Siafunds -As Sia network usage increases, Siafunds will accrue Siacoins over time. [Learn more about Siafunds.](what-are-siafunds.md) +As Sia network usage increases, Siafunds will accrue Siacoins over time. [Learn more about Siafunds.](broken-reference) If you're a Siafund owner, you have the option of cashing out these accrued Siacoins at any point by sending your Siafunds to a Sia address you own. This can be the same wallet the Siafunds are currently in, or a different wallet you control. @@ -28,7 +28,7 @@ Go to the Wallet tab of Sia, and click **Receive.** Click **Generate New Address** to create a new Sia address. -![](../.gitbook/assets/address-2%20%282%29%20%282%29%20%282%29%20%281%29.png) +![](<../.gitbook/assets/address-2 (2) (2) (2) (1).png>) Copy and paste this manually, or use the `Copy` button to the right to make sure you get the full address without any extra spaces. @@ -69,4 +69,3 @@ If you're using siac, the process is the same. Just initiate a transaction and s `siac wallet send siafunds ` to take the accrued Siacoins and put them in your wallet. The Siafunds will still be on your wallet because you sent them to your own address. - diff --git a/siafunds/what-are-siafunds.md b/siafunds/learn-about-siafunds.md similarity index 71% rename from siafunds/what-are-siafunds.md rename to siafunds/learn-about-siafunds.md index fcb1741..6a3710b 100644 --- a/siafunds/what-are-siafunds.md +++ b/siafunds/learn-about-siafunds.md @@ -1,8 +1,10 @@ -# What are Siafunds? +# Learn about Siafunds + +## What are Siafunds? You know all about Siacoins, the utility token used for automatically fulfilling Sia's smart contracts. But what about Siafunds - the other token on the Sia network? -Siafunds are tokens used for revenue sharing on the Sia network; a 3.9% fee from every storage-related transaction on Sia is distributed to the holders of Siafunds. Approximately 1,400 Siafunds were distributed to investors via securities sales and the reamining ~86,000 Siafunds are held by Skynet Labs. +Siafunds are tokens used for revenue sharing on the Sia network; a 3.9% fee from every storage-related transaction on Sia is distributed to the holders of Siafunds. Approximately 1,400 Siafunds were distributed to investors via securities sales and the reamining \~86,000 Siafunds are held by Skynet Labs. When contracts are completed on the network, 3.9% of each funding source is reserved for Siafund holders. Funding sources for contracts are: @@ -36,3 +38,12 @@ The maximum number of Siafunds that will ever be issued is 10,000, all of which Nebulous, Inc. originally owned all 10,000, but over the years have conducted multiple Siafund sales to fund development. In 2021 Nebulous rebranded to Skynet Labs and still holds about 8,600 Siafunds, the rest have been issued to third parties. +## Where to buy Siafunds + +Siafunds aren't available on normal exchanges. The SEC has designated Siafunds as securities according to United States laws. **We recommend that you research the applicable securities laws in your country before buying or selling Siafunds.** + +If you are based in the United States, you may be required to be an accredited investor to buy or sell Siafunds. We recommend consulting with an attorney. + +We treat them like securities, and most exchanges aren't willing to follow the regulatory requirements necessary to trade in securities. + +There are however [Siafunds markets on Bisq](https://bisq.network/markets/?currency=sf\_btc), a decentralized exchange. You can also check the [Sia Discord server](https://sia.tech/discord) for the #siafunds channel, where over-the-counter trades are available through a trusted escrow. diff --git a/wallet/setting-up-walletd/README.md b/wallet/setting-up-walletd/README.md new file mode 100644 index 0000000..0319b6a --- /dev/null +++ b/wallet/setting-up-walletd/README.md @@ -0,0 +1,2 @@ +# Setting up walletd + diff --git a/wallet/setting-up-walletd/linux.md b/wallet/setting-up-walletd/linux.md new file mode 100644 index 0000000..6d02e86 --- /dev/null +++ b/wallet/setting-up-walletd/linux.md @@ -0,0 +1,60 @@ +# 📸 Linux + +This guide will walk you through setting up a `walletd` on Linux. At the end of this guide, you should have the following: + +* **Installed Sia `walletd` software:** You should have successfully installed the Sia `walletd` software on your Linux operating system with the appropriate binary. +* **Functional Sia Wallet:** You should have a functional Sia wallet that is set up and ready for transactional use in the Sia network. +* **Basic Wallet Security:** You should have taken basic security measures, such as using a strong password for your wallet. + +## Pre-requisites + +* **Network Access:** `walletd` interacts with the Sia network, so you need a stable internet connection and open network access to connect to the Sia blockchain. +* **Operating System Compatibility:** Ensure that your Linux version is compatible with the walletd software. Check [releases](../../miscellaneous/releases.md) supported Linux versions. +* **System Updates:** Ensure that your Linux is up to date with the latest system updates, as these updates can contain important security fixes and improvements. + +{% hint style="info" %} +This guide primarily uses the command line and assumes the user has sudo permissions. +{% endhint %} + +## Getting walletd + +1. Download the latest version of `walletd` for your operating system from the [official website](https://sia.tech/software/walletd). For the purpose of this guide, we will download the Linux version and unzip the `walletd` binary to `/usr/local/bin`. + +\ + +```sh +unzip walletd_linux_amd64.zip +sudo mv -t /usr/local/bin walletd_linux_amd64/walletd +rm -rf walletd_linux_amd64.zip +``` + +... + +### Accessing the UI + +For users with a desktop environment, you can open a browser to `http://localhost:9980` to access the `walletd` UI. + +If you do not have a desktop environment: + +1. Find your server's LAN IP using `ip addr`, `ifconfig`, etc. +2. Switch to another computer in your LAN and open the browser +3. Type your LAN IP followed by `:9980` in the address bar (e.g. `http://192.168.1.50:9980`) + +\ + +## + +{% hint style="success" %} +Congratulations on successfully setting up walletd and taking a significant step towards securing your Siacoins. We invite you to explore our comprehensive [Wallet Overview](broken-reference), enabling you to become familiar with the UI and it's features. +{% endhint %} + +## Updating + +It is very important to keep your host up to date. New versions of hostd are released regularly and contain bug fixes and performance improvements. + +To update: + +1. Download the latest version of walletd from [https://sia.tech/software/walletd](https://sia.tech/software/walletd) +2. Stop the `walletd` service with the command `sudo systemctl stop walletd` +3. Unzip and replace `hostd` in `/usr/local/bin` with the new version +4. Restart `hostd` with `sudo systemctl start walletd` diff --git a/wallet/setting-up-walletd/macos.md b/wallet/setting-up-walletd/macos.md new file mode 100644 index 0000000..377363d --- /dev/null +++ b/wallet/setting-up-walletd/macos.md @@ -0,0 +1,113 @@ +# macOS + +This guide will walk you through setting up `walletd` on macOS. At the end of this guide, you should have the following: + +* **Installed Sia `walletd` software:** You should have successfully installed the Sia `walletd` software on your macOS system with the appropriate binary. +* **Functional Sia Wallet:** You should have a functional Sia wallet that is set up and ready for transactional use in the Sia network. + +## Pre-requisites + +* **Network Access:** `walletd` interacts with the Sia network, so you need a stable internet connection and open network access to connect to the Sia blockchain. +* **Operating System Compatibility:** Ensure that your macOS version is compatible with the walletd software. Check [releases](../../miscellaneous/releases.md) supported macOS versions. +* **System Updates:** Ensure that your macOS is up to date with the latest system updates, as these updates can contain important security fixes and improvements. + +{% hint style="info" %} +This guide primarily uses the command line and assumes the user has sudo permissions. +{% endhint %} + +## Getting `walletd` + +1. Download the latest version of `walletd` for your operating system from the [official website](https://sia.tech/software/walletd). For the purpose of this guide, we'll be downloading the macOS version of `walletd` and unzip the binary to `/usr/local/bin`. + +{% hint style="warning" %} +Remember to check which version to download to ensure it works correctly with your operating system. To do this click on the Apple icon in the top left corner of your toolbar, then click on “About This Mac.” If the processor/chips says: + +* **Intel** - `MacOS AMD64` +* **M1 or M2** - `MacOS ARM64` +{% endhint %} + +

macOS Download folder

+ +2. Now that we have downloaded `walletd`, you may need unzip it and move it to a more accessible location: + * Double-click on the downloaded `walletd` zip file to unzip it if it hasn't done so automatically. + * Click on the newly unzipped directory. + * Right-click on the path bar at the bottom of the Finder window and click "Open in Terminal". + +

Options after right-clicking

+ +3. In the opened terminal window, move the `walletd` binary to `/usr/local/bin` by running the following command and press enter: + +```sh +sudo mv walletd /usr/local/bin +``` + +

Moving walletd binary

+ +You'll be prompted to authorize this action by providing your system password. Type this in and press enter to continue. + +4. Finally, for good practice, create a folder on the home drive. This folder will be utilized specifically to store data related to the `walletd` software, which may includes information, configurations, logs, or any other relevant files. Run the following command to do so: + +```sh +mkdir ~/walletd +``` + +## Running `walletd` + +1. In the same terminal, run the following command to start `walletd`: + +
walletd --dir ~/walletd
+
+ +You will be prompted input a `API password`. This password is chosen by you and can be anything you want it to be. It will be used to unlock the `walletd` UI via your browser, it should be something secure and easy to remember. This value are not stored anywhere; you will need to re-enter it every time you start `walletd`. + +{% hint style="info" %} +You can also set the SIA`_API_PASSWORD` environment variables so you do not have to re-enter the values every time. Check out this \
to set this. +{% endhint %} + +2. After entering your desired `API password`, `walletd` will start. + +

Starting walletd via macOS terminal

+ +Your terminal will produce a two different values you may not be familiar with, so feel free to check the tabs below to see what each of them are and why they are important: + +{% tabs %} +{% tab title="p2p" %} +**p2p (Peer-to-Peer) Component:** + +* "p2p" refers to the communication between different nodes or devices without relying on a central server. +* `Listening on 127.0.0.1:9981` means that the application's p2p component is currently set to listen for incoming network connections on the local loopback IP address `127.0.0.1` (also known as `localhost`) and the port `9981`. Localhost refers to the current machine itself. +{% endtab %} + +{% tab title="api " %} +**api (Application Programming Interface) Component:** + +* "api" refers to the application programming interface, which allows different software components to communicate and interact with each other. +* `Listening on 127.0.0.1:9980` indicates that the application's API component is actively waiting for incoming connections on the local loopback IP address `127.0.0.1` and the port `9980`. +{% endtab %} +{% endtabs %} + +3. You can now access the `walletd` UI by opening a browser and going to `http://localhost:9980`. + +{% hint style="warning" %} +Remember to leave the terminal window open while `walletd` is running. If you close the command prompt window, `walletd`will stop. +{% endhint %} + +

walletd

+ +Enter your `API password` you created in the in the previous step to unlock `walletd`. + +{% hint style="success" %} +Congratulations on successfully setting up `walletd` and taking a significant step towards securing your Siacoins. +{% endhint %} + +## Updating + +It is very important to keep your host up to date. New versions of `walletd` are released regularly and contain bug fixes and performance improvements. + +To update: + +1. Download the latest version of `walletd` from the [official website](https://sia.tech/software/walletd). +2. Stop the `walletd` service with the command `sudo systemctl stop walletd` +3. Unzip and replace `walletd` in `/usr/local/bin` with the new version +4. Restart `walletd` with `sudo systemctl start walletd` + diff --git a/wallet/setting-up-walletd/windows.md b/wallet/setting-up-walletd/windows.md new file mode 100644 index 0000000..5f23ee9 --- /dev/null +++ b/wallet/setting-up-walletd/windows.md @@ -0,0 +1,79 @@ +# 📸 Windows + +This guide will walk you through setting up a `walletd` on Windows. At the end of this guide, you should have the following: + +* **Installed Sia `walletd` software:** You should have successfully installed the Sia `walletd` software on your Windows operating system with the appropriate binary. +* **Functional Sia Wallet:** You should have a functional Sia wallet that is set up and ready for transactional use in the Sia network. +* **Basic Wallet Security:** You should have taken basic security measures, such as using a strong password for your wallet. + +## Pre-requisites + +* **Network Access:** `walletd` interacts with the Sia network, so you need a stable internet connection and open network access to connect to the Sia blockchain. +* **Operating System Compatibility:** Ensure that your Windows operating system version is compatible with the walletd software. Check [releases](../../miscellaneous/releases.md) supported macOS versions. +* **System Updates:** Ensure that your Windows operating system is up to date with the latest system updates, as these updates can contain important security fixes and improvements. + +## Getting `walletd` + +1. Download the latest version of `walletd` for your operating system from the [official website](https://sia.tech/software/walletd). For the purpose of this guide, we will download the Windows version and unzip the `walletd` binary to `C:\walletd`. + +{% hint style="warning" %} +Windows Defender may flag `walletd` as a virus. This is a false positive. You can add an exception to Windows Defender. Read more [here](https://go.dev/doc/faq#virus). +{% endhint %} + +\ + +2. text +3. text + +\ + +4. + +## Running `walletd` + +1. In the same terminal, run the following command to start `walletd`: + +``` +walletd.exe +``` + +You will be prompted input a `API password`. This password is chosen by you and can be anything you want it to be. It will be used to unlock the `walletd` UI via your browser, it should be something secure and easy to remember. This value are not stored anywhere; you will need to re-enter it every time you start `walletd`. + +2. After entering your desired password, `walletd` will start. + +\ + +3. You can now access the `walletd` UI by opening a browser and going to `http://localhost:9980`. + + + +\ + + + +{% hint style="warning" %} +You must leave the command prompt window open while `walletd` is running. If you close the command prompt window, `walletd`will stop. +{% endhint %} + + + +\ + + + +Enter your `API password` you created in the in the previous step to unlock `walletd`. + +{% hint style="success" %} +Congratulations on successfully setting up walletd and taking a significant step towards securing your Siacoins. We invite you to explore our comprehensive [Wallet Overview](broken-reference), enabling you to become familiar with the UI and it's features. +{% endhint %} + +## Updating + +It is very important to keep your host up to date. New versions of `walletd` are released regularly and contain bug fixes and performance improvements. + +To update: + +1. Download the latest version of `walletd` from the [official website](https://sia.tech/software/walletd). +2. Stop `walletd` in your command line by pressing `Ctrl+C` +3. Replace `walletd.exe` with the new version +4. Restart `walletd` in your command line diff --git a/wallet/setup-guide/README.md b/wallet/setup-guide/README.md deleted file mode 100644 index 04664b3..0000000 --- a/wallet/setup-guide/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# 🚧 Setup Guide - diff --git a/wallet/setup-guide/linux.md b/wallet/setup-guide/linux.md deleted file mode 100644 index 5cc4b51..0000000 --- a/wallet/setup-guide/linux.md +++ /dev/null @@ -1,2 +0,0 @@ -# Linux - diff --git a/wallet/setup-guide/macos.md b/wallet/setup-guide/macos.md deleted file mode 100644 index 52f9cf7..0000000 --- a/wallet/setup-guide/macos.md +++ /dev/null @@ -1,2 +0,0 @@ -# macOS - diff --git a/wallet/setup-guide/windows.md b/wallet/setup-guide/windows.md deleted file mode 100644 index 375784c..0000000 --- a/wallet/setup-guide/windows.md +++ /dev/null @@ -1,2 +0,0 @@ -# Windows - diff --git a/wallet/transferring-siacoins.md b/wallet/transferring-siacoins.md new file mode 100644 index 0000000..4498c0a --- /dev/null +++ b/wallet/transferring-siacoins.md @@ -0,0 +1,79 @@ +# Transferring Siacoins + +## Sending Siacoins (SC) + +Whether you're sending Siacoins to an exchange or a friend, it's easy and can be done right in `walletd`. + +Go to `walletd`. If you're asked to unlock the wallet, use either your seed or a custom password if you've set one. If you haven't got a wallet set up, visit our Setup Guide, otherwise choose from the **Dashboard** a wallet you wish send Siacoins from. + +

Wallet dashboard

+ +### Setup your transaction + +Click on the `Send` button. Enter the recipient's wallet address and the amount of Siacoins you want to send. Make sure that you've entered a Siacoin wallet address, and that you've entered it correctly. + +

Sending Siacoins via walletd

+ +{% hint style="warning" %} +Siacoins sent to mistyped addresses, or addresses of other types of cryptocurrency can not be retrieved. +{% endhint %} + +Click **Generate Transaction.** + +### Confirm your info + +Next, you need to confirm everything. You'll have a chance to double-check the currency, amount, and recipient address. The window will also show you estimated network fees. + +For security measures, you will also be asked to provide your Seed. + +

Confirming your transaction

+ +Click **Setup** to change something. If it's all good, click **Sign and broadcast transaction**. + +

Confirmation of a successful transaction broadcasted

+ +You'll immediately get a confirmation that your transaction has been successfully broadcasted. + +### Checking the status + +By going to your **Dashboard**, and selecting the wallet you made the transaction with, you can check the transaction status. It's normal to 'Unknown' or 'Send' at the top of the list of transactions, it means the transaction is on its way but hasn't yet appeared in a block. + +

Wallet transaction list

+ +{% hint style="info" %} +It might take a minute or two for the transaction to pop up in the wallet's transactions list. +{% endhint %} + +Once it's in a block, you can go back to check the status and see new transaction type of 'siacoin transfer'. + +

Successfully sending Siacoins via walletd

+ +## Receiving Siacoins (SC) + +At some point, you'll need to receive Siacoins. You might be receiving them over from an exchange wallet, another Sia wallet you own, or requesting Siacoins from a friend. No matter the reason, it's easy to \ or retrieve your address in `walletd` to receive Siacoins. + +Go to the `walletd`. If you're asked to unlock the wallet, use either your seed or a custom password if you've set one. If you haven't got a wallet set up, visit our \, otherwise choose from the **Dashboard** a wallet you wish receive Siacoins from. + +

Wallet dashboard

+ +Click on the **Addresses** in the top right corner and you'll be presented the wallet address. + +

Wallet addresses

+ +### Sharing the address or QR + +Copy and paste this manually, or use the **Copy** button to the right to make sure you get the full address without any extra spaces, and provide this address to whom ever you're receiving the fund from. + +You can also receive Siacoin, simply share your wallet address by displaying your QR code for others to scan. + +

Getting the address and QR of your wallet

+ +By going to your **Dashboard**, and selecting the wallet you made the transaction with, you can check the transaction status. It's normal to 'Unknown' at the top of the list of transactions, it means the transaction is on its way but hasn't yet appeared in a block. + +{% hint style="info" %} +It might take a minute or two for the transaction to pop up in the wallet's transactions list. +{% endhint %} + +Once it's in a block, you can go back to check the status and see new transaction type of 'siacoin transfer'. + +

Successful receiving Siacoin to walletd

diff --git a/wallet/wallet-overview.md b/wallet/wallet-overview.md index 944e0de..cafd52b 100644 --- a/wallet/wallet-overview.md +++ b/wallet/wallet-overview.md @@ -1,18 +1,23 @@ -# 🚧 About Wallet +# About walletd + +`walletd` is the best place for users within our network to manage and transact their Siacoins. It is the official wallet web application made by the developers of the Sia network. + +* Safely send, receive and store Siacoins and Siafunds. +* Watch the blockchain for events relevant to particular addresses. +* Monitor wallet balance and transactions +* Supports Ledger hardware wallets + +Watch our Wallet Overview video tour to see what the `walletd` user interface looks like! + +\