From a38084d575b9eaf2e4e7c9b4c1cd3e1116fcffe0 Mon Sep 17 00:00:00 2001 From: Ansgar Grunseid Date: Sun, 17 Dec 2023 14:11:45 -0800 Subject: [PATCH] update the docs to describe the process of claiming node earnings --- README.md | 4 ++-- docs/faq.md | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7676dbd6..8e62ac35 100644 --- a/README.md +++ b/README.md @@ -230,7 +230,7 @@ If you want to switch your node from Saturn's test network (aka `test`) to Satur ## Node operator guide -For answers to common questions about operating a node, like about receiving your filecoin payouts, see the L1 node [FAQ](docs/faq.md) page. +For answers to common questions about operating a node, see the L1 node [FAQ](docs/faq.md) page. ### Network Uptime Requirement @@ -276,7 +276,7 @@ Slack. ### Claiming your earnings -Each month, your node's earnings are calculated based on various factors such as the amount of bandwidth it served, the number of requests it handled, its performance metrics like TTFB and upload speed, and its availaility and uptime. These earnings are then sent to a payout FVM smart contract by the 7th day of the following month. For example, earnings for December 2022 would be transferred to a payout smart contract by January 7th, 2023. +Each month, your node's earnings, in FIL, are calculated by the network based on various factors such as the amount of bandwidth it served, the number of requests it handled, its performance metrics like TTFB and upload speed, and its availaility and uptime. These earnings are then sent to a payout FVM smart contract by the 7th day of the following month. For example, earnings for December 2022 would be transferred to a payout smart contract by January 7th, 2023. After your node's earnings are in the payout FVM smart contract, you can claim them on [payouts.saturn.tech](https://payouts.saturn.tech). Claiming your earnings moves the Filecoin your node(s) earned from the smart contract to your personal Filecoin wallet. diff --git a/docs/faq.md b/docs/faq.md index 9451ed70..c2de2161 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -15,15 +15,15 @@ We are continuously looking at the requirements and multiple factors, such as ge ## Payouts -### When do I receive my FIL payouts? +### When can I claim my FIL earnings? -Node earnings, in FIL, are finalized at the end of every month and payouts are made shortly thereafter -- within the following few days. So you can expect to receive your FIL payout -- for prior month's earnings -- within the first week of every calendar month. +Each month, your node's earnings, in FIL, are calculated by the network based on various factors such as the amount of bandwidth it served, the number of requests it handled, its performance metrics like TTFB and upload speed, and its availaility and uptime. These earnings are then sent to a payout FVM smart contract by the 7th day of the following month, after which they can be claimed. For example, earnings for December 2022 would be transferred to a payout smart contract by January 7th, 2023. Once transferred to the payout smart contract, they can be claimed on [payouts.saturn.tech](https://payouts.saturn.tech). -### How do I receive my FIL payout? +### How do I claim my payout? -Your FIL payout will be sent in filecoin the filecoin wallet address set in your node's `FIL_WALLET_ADDRESS` environment variable. +Once your earnings have been transferred to the monthly payout smart contract, which happens by the 7th day of the following month, they can be claimed on [payouts.saturn.tech](https://payouts.saturn.tech). -Triple check that the wallet address in `FIL_WALLET_ADDRESS` is correct; filecoin sent to the wrong address can't be undone or re-sent. +Triple check that the wallet address in `FIL_WALLET_ADDRESS` is correct; earnings earmarked under the wrong address in the payout smart contract can't be changed to be claimed by a different wallet address. ### I'm already a Filecoin storage provider, how does it work with my existing nodes, wallets, etc.?