From c5ffb74f07fb6d637881b37ae2074e5f678f600a Mon Sep 17 00:00:00 2001 From: Peter Rabbitson Date: Sun, 20 Dec 2020 01:30:06 +0100 Subject: [PATCH] =?UTF-8?q?=E7=98=AA=E8=8E=B2?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.markdown | 36 ++++++++++++++++++++++++++++ build/openrpc/full.json | 2 +- build/openrpc/gateway.json | 2 +- build/openrpc/miner.json | 2 +- build/openrpc/worker.json | 2 +- build/version.go | 4 ++-- documentation/en/cli-lotus-miner.md | 2 +- documentation/en/cli-lotus-worker.md | 2 +- documentation/en/cli-lotus.md | 2 +- 9 files changed, 45 insertions(+), 9 deletions(-) create mode 100644 README.markdown diff --git a/README.markdown b/README.markdown new file mode 100644 index 00000000000..25584f7be1d --- /dev/null +++ b/README.markdown @@ -0,0 +1,36 @@ +# 瘪莲 (ltsh) + +A leaner variant of [莲](https://github.com/filecoin-project/lotus) powering all `riba.cloud` nodes. + +## What + +This repository contains the **PRODUCTION VERSION** of nodes used at and around `riba.cloud`. The code is the result of a series of patches on top of the [*earliest* version of `lotus`][11] compatible with the current filecoin mainnet. The changes are either backports or modifications of various aspects of upstream, aimed at leaner and/or more correct operations. + +## How + +The repository never adds tags: named branches are used as source of truth. As upstream is tracked relatively closely, all branches, including [`master`][1] are **force-pushed to quite frequently**. Always use `git pull --rebase` when fetching new changes. + +The main named-branches of interest are as follows: + +- [`upstream_base`][11]: the base point matching a recent-ish-stable release of [`lotus`][2] + +- [`backports`][12]: the portion of [`master`][1] that consists solely of backports from [`upstream-lotus:master`][2] on top of the [`upstream_base`][11]. + +- [`maybe_for_upstreaming`][13]: the portion of [`master`][1] that could reasonably be considered for inclusion upstream. Note that author **does not plan to raise PRs** against upstream. The marker is provided for those who would like to attempt upstreaming the changes on their own. + +- [`master`][1]: code powering the production nodes which author uses for various chain-syncing/-analysis tasks. Drifts between daemon-reported commitish and this branch are generally rare. You are welcome to run this version, as long as you are doing it **AT YOUR OWN RISK** and agree to keep all the pieces if something breaks. + +## Lead Maintainer + +[Peter 'ribasushi' Rabbitson](https://github.com/ribasushi) + +## License + +SPDX-License-Identifier: Apache-2.0 OR MIT + +[1]: https://github.com/ribasushi/ltsh/commits/master +[2]: https://github.com/filecoin-project/lotus +[11]: https://github.com/ribasushi/ltsh/commits/upstream_base +[12]: https://github.com/ribasushi/ltsh/compare/upstream_base...backports +[13]: https://github.com/ribasushi/ltsh/compare/backports...maybe_for_upstreaming + diff --git a/build/openrpc/full.json b/build/openrpc/full.json index a0f8e6e9c15..5840d587ad1 100644 --- a/build/openrpc/full.json +++ b/build/openrpc/full.json @@ -2,7 +2,7 @@ "openrpc": "1.2.6", "info": { "title": "Lotus RPC API", - "version": "1.27.1-rc2" + "version": "瘪莲" }, "methods": [ { diff --git a/build/openrpc/gateway.json b/build/openrpc/gateway.json index bbd7f4b6bc1..c1d8b4a18bc 100644 --- a/build/openrpc/gateway.json +++ b/build/openrpc/gateway.json @@ -2,7 +2,7 @@ "openrpc": "1.2.6", "info": { "title": "Lotus RPC API", - "version": "1.27.1-rc2" + "version": "瘪莲" }, "methods": [ { diff --git a/build/openrpc/miner.json b/build/openrpc/miner.json index 77259c3e94f..f5a98fd2404 100644 --- a/build/openrpc/miner.json +++ b/build/openrpc/miner.json @@ -2,7 +2,7 @@ "openrpc": "1.2.6", "info": { "title": "Lotus RPC API", - "version": "1.27.1-rc2" + "version": "瘪莲" }, "methods": [ { diff --git a/build/openrpc/worker.json b/build/openrpc/worker.json index 201dec42c20..ab2e6cb8479 100644 --- a/build/openrpc/worker.json +++ b/build/openrpc/worker.json @@ -2,7 +2,7 @@ "openrpc": "1.2.6", "info": { "title": "Lotus RPC API", - "version": "1.27.1-rc2" + "version": "瘪莲" }, "methods": [ { diff --git a/build/version.go b/build/version.go index b4271e6e5c1..e144344fd68 100644 --- a/build/version.go +++ b/build/version.go @@ -39,7 +39,7 @@ func BuildTypeString() string { } // NodeBuildVersion is the local build version of the Lotus daemon -const NodeBuildVersion string = "1.27.1-rc2" +const NodeBuildVersion = "瘪莲" func NodeUserVersion() BuildVersion { if os.Getenv("LOTUS_VERSION_IGNORE_COMMIT") == "1" { @@ -50,7 +50,7 @@ func NodeUserVersion() BuildVersion { } // MinerBuildVersion is the local build version of the Lotus miner -const MinerBuildVersion = "1.27.1-rc2" +const MinerBuildVersion = "瘪莲" func MinerUserVersion() BuildVersion { if os.Getenv("LOTUS_VERSION_IGNORE_COMMIT") == "1" { diff --git a/documentation/en/cli-lotus-miner.md b/documentation/en/cli-lotus-miner.md index db536a4dd05..08b0a886976 100644 --- a/documentation/en/cli-lotus-miner.md +++ b/documentation/en/cli-lotus-miner.md @@ -7,7 +7,7 @@ USAGE: lotus-miner [global options] command [command options] [arguments...] VERSION: - 1.27.1-rc2 + 瘪莲 COMMANDS: init Initialize a lotus miner repo diff --git a/documentation/en/cli-lotus-worker.md b/documentation/en/cli-lotus-worker.md index 6bc4ef6fa1c..9628e7ca4ef 100644 --- a/documentation/en/cli-lotus-worker.md +++ b/documentation/en/cli-lotus-worker.md @@ -7,7 +7,7 @@ USAGE: lotus-worker [global options] command [command options] [arguments...] VERSION: - 1.27.1-rc2 + 瘪莲 COMMANDS: run Start lotus worker diff --git a/documentation/en/cli-lotus.md b/documentation/en/cli-lotus.md index 65454899afd..767c79288ce 100644 --- a/documentation/en/cli-lotus.md +++ b/documentation/en/cli-lotus.md @@ -7,7 +7,7 @@ USAGE: lotus [global options] command [command options] [arguments...] VERSION: - 1.27.1-rc2 + 瘪莲 COMMANDS: daemon Start a lotus daemon process