From 8393d9f48f9c76184c724bd2112ae0512bd00720 Mon Sep 17 00:00:00 2001 From: Moses Narrow <36607567+0pcom@users.noreply.github.com> Date: Mon, 18 Dec 2023 09:16:01 -0600 Subject: [PATCH] Update minimum version requirement in mainnet rules (#1699) * update minimum version requirement * update version in windows installer script * update changelog --- CHANGELOG.md | 66 +++++++++++++++++++++++++++++++ mainnet_rules.md | 46 ++++++++++++++++++--- scripts/win_installer/Product.wxs | 14 +++---- 3 files changed, 114 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 544c36ad03..9c9d2a8339 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,14 +6,80 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. updates may be generated with `scripts/changelog.sh ` +## 1.3.15 + +- Update minimum version requirement in mainnet rules [#1699](https://github.com/skycoin/skywire/pull/1699) +- `riscv64` archive structure [#1698](https://github.com/skycoin/skywire/pull/1698) +- update golangci-lint [#1697](https://github.com/skycoin/skywire/pull/1697) +- fix enable vpn server environmental variable detection for config gen [#1695](https://github.com/skycoin/skywire/pull/1695) + ## 1.3.14 +- improve postinstall script on Mac installer [#1691](https://github.com/skycoin/skywire/pull/1691) +- add skysocks client to windows archive [#1690](https://github.com/skycoin/skywire/pull/1690) +- add missed apps to package installer [#1689](https://github.com/skycoin/skywire/pull/1689) +- correct rewards update cutoff date [#1688](https://github.com/skycoin/skywire/pull/1688) +- update dmsghttp-config.json file [#1687](https://github.com/skycoin/skywire/pull/1687) +- Update Mainnet rules minimum version requirement [#1686](https://github.com/skycoin/skywire/pull/1686) +- Rebuild Hypervisor UI [#1685](https://github.com/skycoin/skywire/pull/1685) +- Update skywire-cli README.md [#1684](https://github.com/skycoin/skywire/pull/1684) +- new flag `--confpath` on generate config [#1683](https://github.com/skycoin/skywire/pull/1683) +- improve `skywire-cli proxy` command [#1680](https://github.com/skycoin/skywire/pull/1680) +- improve `skywire-cli ut` command logic [#1679](https://github.com/skycoin/skywire/pull/1679) +- update dmsg and skywire-utilities [#1677](https://github.com/skycoin/skywire/pull/1677) +- Fix/update skywire utilities [#1676](https://github.com/skycoin/skywire/pull/1676) - Rebuild Hypervisor UI [#1672](https://github.com/skycoin/skywire/pull/1672) - Fix two panic issues on `skywire-cli` commands [#1671](https://github.com/skycoin/skywire/pull/1671) - Improve UI and Backend on `reboot` and `turn off` [#1670](https://github.com/skycoin/skywire/pull/1670) + +## 1.3.10 - 1.3.13 + - add skywire version to `skywire-cli log` [#1669](https://github.com/skycoin/skywire/pull/1669) +- `skywire-cli reward calc` [#1668](https://github.com/skycoin/skywire/pull/1668) - fix issue fetching data from hardcoded server [#1666](https://github.com/skycoin/skywire/pull/1666) +- replace dmsgget with dmsgcurl lib [#1663](https://github.com/skycoin/skywire/pull/1663) - Fix wrong config generation with t flag [#1661](https://github.com/skycoin/skywire/pull/1661) +- Remove Comments [#1658](https://github.com/skycoin/skywire/pull/1658) +- Develop [#1655](https://github.com/skycoin/skywire/pull/1655) +- Update minimum version requirement in mainnet rules [#1654](https://github.com/skycoin/skywire/pull/1654) +- Fix transport bandwidth logs [#1653](https://github.com/skycoin/skywire/pull/1653) +- fix `ping` command logic [#1652](https://github.com/skycoin/skywire/pull/1652) +- improve ping command output [#1651](https://github.com/skycoin/skywire/pull/1651) +- Update Mainnet rules ; increment minimum version requirement [#1650](https://github.com/skycoin/skywire/pull/1650) +- improve `skywire-cli log` command [#1648](https://github.com/skycoin/skywire/pull/1648) +- UI improvements [#1647](https://github.com/skycoin/skywire/pull/1647) +- v1.3.11 [#1645](https://github.com/skycoin/skywire/pull/1645) +- source a .conf file with skywire-cli config gen [#1644](https://github.com/skycoin/skywire/pull/1644) +- UI for turning off the visor [#1642](https://github.com/skycoin/skywire/pull/1642) +- Update dmsghttp config [#1632](https://github.com/skycoin/skywire/pull/1632) +- Use `MarkFlagsMutuallyExclusive` for `config gen -rf` and `config gen -up` [#1629](https://github.com/skycoin/skywire/pull/1629) +- [WIP] dmsghttp updater [#1628](https://github.com/skycoin/skywire/pull/1628) +- Vendor dmsg@master and replace two yamux deps [#1626](https://github.com/skycoin/skywire/pull/1626) +- `skywire-cli log` collect transport bandwidth logging for today [#1625](https://github.com/skycoin/skywire/pull/1625) +- reduce `transport_manager` timeout on module shutting down [#1624](https://github.com/skycoin/skywire/pull/1624) +- collect surveys from online visors only [#1623](https://github.com/skycoin/skywire/pull/1623) +- Improvements for the UI [#1620](https://github.com/skycoin/skywire/pull/1620) +- Add details to mainnet rules article [#1618](https://github.com/skycoin/skywire/pull/1618) +- add new flag to log command [#1617](https://github.com/skycoin/skywire/pull/1617) +- improve log collection logic [#1615](https://github.com/skycoin/skywire/pull/1615) +- update dependencies [#1614](https://github.com/skycoin/skywire/pull/1614) +- fix GitHub Action [#1613](https://github.com/skycoin/skywire/pull/1613) +- `skywire-cli config gen -r` test [#1611](https://github.com/skycoin/skywire/pull/1611) +- Limit the Skychay UI to localhost [#1605](https://github.com/skycoin/skywire/pull/1605) +- Add CSRF protection to the Hypervisor API [#1604](https://github.com/skycoin/skywire/pull/1604) +- fix dockerhub username and token [#1601](https://github.com/skycoin/skywire/pull/1601) +- Fix/makefile clean target [#1600](https://github.com/skycoin/skywire/pull/1600) +- Merge Develop to Master [#1599](https://github.com/skycoin/skywire/pull/1599) +- Add dmsghttp servers [#1597](https://github.com/skycoin/skywire/pull/1597) +- fix release issue on mac and win [#1593](https://github.com/skycoin/skywire/pull/1593) +- remove .asc file from archives of release [#1592](https://github.com/skycoin/skywire/pull/1592) +- Fix `skywire-cli config gen -r` [#1591](https://github.com/skycoin/skywire/pull/1591) +- Merge develop to master [#1589](https://github.com/skycoin/skywire/pull/1589) +- Remove pgp key previously used for survey collection on earlier versions [#1588](https://github.com/skycoin/skywire/pull/1588) +- Update Command Documentation [#1587](https://github.com/skycoin/skywire/pull/1587) +- Fix config gen logic for fetching services & erroneous app config [#1586](https://github.com/skycoin/skywire/pull/1586) +- change json of service struct to transport_setup [#1585](https://github.com/skycoin/skywire/pull/1585) +- fix wrong variable name for config gen [#1584](https://github.com/skycoin/skywire/pull/1584) ## 1.3.9 diff --git a/mainnet_rules.md b/mainnet_rules.md index dcb4428fc2..ecc24e8e62 100644 --- a/mainnet_rules.md +++ b/mainnet_rules.md @@ -39,8 +39,15 @@ A total of up to ~1117.808 Skycoin are distributed daily in non leap-years; even ## Rules & Requirements +To obtain Skycoin rewards for running skywire, the following requirements must be met. +The update deadlines specify the version of software required as of (i.e. on or before) the specified date in order to maintain reward eligibility: + +* **Minimum skywire version v1.3.13** + * **Minimum skywire version v1.3.14** - Cutoff January 1st 2024 +* **Minimum skywire version v1.3.15** - Cutoff January 14th 2024 + * The visor must be an **ARM architecture SBC running on approved [hardware](#hardware)** * Visors must be running on **[the skywire production deployment](https://conf.skywire.skycoin.com)** @@ -59,6 +66,21 @@ A total of up to ~1117.808 Skycoin are distributed daily in non leap-years; even * **The visor produces transport bandwidth logs** - needed for bandwidth-based rewards +### Exceptions for Deployment Changes with dmsghttp-config (Chinese users) + +All the production deployment services may be accessed by the visor over the dmsg network when the visor runs with a dmsghttp config. + +This type of config is generated automatically based on region (via `skywire-cli config gen -b --bestproto`), to circumvent ISP blocking of http requests. + +In order to bootstrap the visor's to connection to the dmsg network (via TCP connection to an individual dmsg server) the `dmsghttp-config.json` is provided with the skywire binary release. + +In the instance that the skywire production deployment changes - specifically the dmsg servers - it will be necessary to update to the next version or package release which fixes the dmsg servers - or else to manually update the `dmsghttp-config.json` which is provided by your skywire installation. + +Currently, **there is no mechanism for updating the dmsghttp-config.json which does not require an http request** ; a request which may be blocked depending on region. + +In this instance, the visor will not connect to any service because it is not connected to the dmsg network, so it will not be possible for the visor to accumulate uptime or for the reward system to collect the survey, which are prerequisite for reward eligibility. + +As a consequence of this; any visors running a dmsghttp-config, and hence any visors running in regions such as China, the minimum version requirement for obtaining rewards is not only the latest available version, but __the latest release of the package__ unless the dmsghttp-config.json is updated manually. ## Verifying Requirements & Eligibility @@ -70,18 +92,28 @@ skywire-cli -v skywire-visor -v ``` -**Reward eligibility requires Skywire v1.3.14** +**Reward eligibility before 1-1-2024 requires minimum Skywire version v1.3.13** + +**Reward eligibility after 1-1-2024 requires Skywire v1.3.14** Requirement established 12-10-2023 Rewards Cutoff date for updating 1-1-2024 +**Reward eligibility after 1-14-2024 requires Skywire v1.3.15** + +Requirement established 12-18-2023 + +Rewards Cutoff date for updating 1-14-2024 + ### Deployment -The deployment your visor is running on can be verified by comparing the services configured in the visor's .json config against [conf.skywire.skycoin.com](https://conf.skywire.skycoin.com) +The deployment your visor is running on can be verified by comparing the services configured in the visor's `.json` config against [conf.skywire.skycoin.com](https://conf.skywire.skycoin.com) + +The service configuration will be automatically updated any time a config is generated or regenerated. For those visors in china or those running a dmsghttp-config, compare the dmsghttp-config of your current installation with the dmsghttp-config on the develop branch of [github.com/skycoin/skywire](https://github.com/skycoin/skywire) -It will be automatically updated any time a config is generated or regenerated. + ### Uptime @@ -133,11 +165,15 @@ The skycoin reward address is in a text file contained in the "local" folder (lo The skycoin reward address is also included with the [system survey](https://github.com/skycoin/skywire/tree/develop/cmd/skywire-cli#survey) and served, along with transport logs, via dmsghttp. -The system survey is fetched hourly with `skywire-cli log`; along with transport bandwidth logs. +The system survey (`local/node-info.json`) is fetched hourly by the reward system via `skywire-cli log`; along with transport bandwidth logs. + +The index of the collected files may be viewed at [fiber.skywire.dev/log-collection/tree](https://fiber.skywire.dev/log-collection/tree) + + Once collected from the nodes, the surveys for those visors which met uptime are checked to verify hardware and other requirements, etc. -The system survey is only made available to those keys which are whitelisted for survey collection, but is additionally available to any `hypervisor` or `dmsgpty_whitelist` keys set inthe config for a given visor. +The system survey is only made available to those keys which are whitelisted for survey collection, but is additionally available to any `hypervisor` or `dmsgpty_whitelist` keys set in the config for a given visor. The public keys which require to be whitelisted in order to collect the surveys, for the purpose of reward eligibility verification, should populate in the visor's config automatically when the config is generated with visors of at least version 1.3.8. diff --git a/scripts/win_installer/Product.wxs b/scripts/win_installer/Product.wxs index b0da75e03f..df26c756ce 100644 --- a/scripts/win_installer/Product.wxs +++ b/scripts/win_installer/Product.wxs @@ -11,7 +11,7 @@ @@ -48,7 +48,7 @@ - + - + @@ -73,13 +73,13 @@ Key="Software\Skycoin\Skywire" Name="installed0" Type="integer" Value="1" KeyPath="yes"/> - + - + - - + +