cerc-io/lotus
15
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 27 Wiki Activity

update storage miner and seal worker document

Browse Source
This commit is contained in:
Frank 2020-07-11 16:55:13 +08:00
parent 5dfb8c9474
commit 14ec9a2068
45 changed files with 92 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/ISSUE_TEMPLATE/sealingfailed.md vendored
View File

@ -25,9 +25,9 @@ The output of `./lotus-miner sectors list`.
The output of `./lotus-miner sectors status --log <sectorId>` for the failed sector(s). The output of `./lotus-miner sectors status --log <sectorId>` for the failed sector(s).
**Lotus storage miner logs** **Lotus miner logs**
Please go through the logs of your storage miner, and include screenshots of any error-like messages you find. Please go through the logs of your miner, and include screenshots of any error-like messages you find.
**Version** **Version**

2
api/api_storage.go
View File

@ -16,7 +16,7 @@ import (
"github.com/filecoin-project/specs-actors/actors/abi" "github.com/filecoin-project/specs-actors/actors/abi"
) )
// StorageMiner is a low-level interface to the Filecoin network storage miner node // StorageMiner is a low-level interface to the Filecoin network miner node
type StorageMiner interface { type StorageMiner interface {
Common Common

2
api/client/client.go
View File

@ -34,7 +34,7 @@ func NewFullNodeRPC(addr string, requestHeader http.Header) (api.FullNode, jsonr
return &res, closer, err return &res, closer, err
} }
// NewStorageMinerRPC creates a new http jsonrpc client for storage miner // NewStorageMinerRPC creates a new http jsonrpc client for miner
func NewStorageMinerRPC(addr string, requestHeader http.Header) (api.StorageMiner, jsonrpc.ClientCloser, error) { func NewStorageMinerRPC(addr string, requestHeader http.Header) (api.StorageMiner, jsonrpc.ClientCloser, error) {
var res apistruct.StorageMinerStruct var res apistruct.StorageMinerStruct
closer, err := jsonrpc.NewMergeClient(addr, "Filecoin", closer, err := jsonrpc.NewMergeClient(addr, "Filecoin",

2
api/test/mining.go
View File

@ -89,7 +89,7 @@ func TestDealMining(t *testing.T, b APIBuilder, blocktime time.Duration, carExpo
ctx := context.Background() ctx := context.Background()
n, sn := b(t, 1, []StorageMiner{ n, sn := b(t, 1, []StorageMiner{
{Full: 0, Preseal: PresealGenesis}, {Full: 0, Preseal: PresealGenesis},
{Full: 0, Preseal: 0}, // TODO: Add support for storage miners on non-first full node {Full: 0, Preseal: 0}, // TODO: Add support for miners on non-first full node
}) })
client := n[0].FullNode.(*impl.FullNodeAPI) client := n[0].FullNode.(*impl.FullNodeAPI)
provider := sn[1] provider := sn[1]

2
chain/gen/genesis/genesis.go
View File

@ -312,7 +312,7 @@ func MakeGenesisBlock(ctx context.Context, bs bstore.Blockstore, sys runtime.Sys
stateroot, err = SetupStorageMiners(ctx, cs, stateroot, template.Miners) stateroot, err = SetupStorageMiners(ctx, cs, stateroot, template.Miners)
if err != nil { if err != nil {
return nil, xerrors.Errorf("setup storage miners failed: %w", err) return nil, xerrors.Errorf("setup miners failed: %w", err)
} }
cst := cbor.NewCborStore(bs) cst := cbor.NewCborStore(bs)

4
cmd/lotus-fountain/main.go
View File

@ -414,7 +414,7 @@ func (h *handler) msgwait(w http.ResponseWriter, r *http.Request) {
if mw.Receipt.ExitCode != 0 { if mw.Receipt.ExitCode != 0 {
w.WriteHeader(400) w.WriteHeader(400)
w.Write([]byte(xerrors.Errorf("create storage miner failed: exit code %d", mw.Receipt.ExitCode).Error())) w.Write([]byte(xerrors.Errorf("create miner failed: exit code %d", mw.Receipt.ExitCode).Error()))
return return
} }
w.WriteHeader(200) w.WriteHeader(200)
@ -437,7 +437,7 @@ func (h *handler) msgwaitaddr(w http.ResponseWriter, r *http.Request) {
if mw.Receipt.ExitCode != 0 { if mw.Receipt.ExitCode != 0 {
w.WriteHeader(400) w.WriteHeader(400)
w.Write([]byte(xerrors.Errorf("create storage miner failed: exit code %d", mw.Receipt.ExitCode).Error())) w.Write([]byte(xerrors.Errorf("create miner failed: exit code %d", mw.Receipt.ExitCode).Error()))
return return
} }
w.WriteHeader(200) w.WriteHeader(200)

6
cmd/lotus-fountain/site/_miner.html
View File

@ -1,14 +1,14 @@
<!DOCTYPE html> <!DOCTYPE html>
<html> <html>
<head> <head>
<title>Creating Storage Miner - Lotus Fountain</title> <title>Creating Miner - Lotus Fountain</title>
<link rel="stylesheet" type="text/css" href="main.css"> <link rel="stylesheet" type="text/css" href="main.css">
</head> </head>
<body> <body>
<div class="Index"> <div class="Index">
<div class="Index-nodes"> <div class="Index-nodes">
<div class="Index-node"> <div class="Index-node">
[CREATING STORAGE MINER] [CREATING MINER]
</div> </div>
<div class="Index-node" id="formnd"> <div class="Index-node" id="formnd">
<form id="f" action='/mkminer' method='POST'> <form id="f" action='/mkminer' method='POST'>
@ -26,7 +26,7 @@
<b>Waiting for transaction on chain..</b> <b>Waiting for transaction on chain..</b>
</div> </div>
<div class="Index-node"> <div class="Index-node">
<span>When creating storage miner, DO NOT REFRESH THE PAGE, wait for it to load. This can take more than 5min.</span> <span>When creating miner, DO NOT REFRESH THE PAGE, wait for it to load. This can take more than 5min.</span>
</div> </div>
<div class="Index-node"> <div class="Index-node">
<span>If you don't have an owner/worker address, you can create it by following <a target="_blank" href="https://docs.lotu.sh/en+mining#get-started-22083">these instructions</a>.</span> <span>If you don't have an owner/worker address, you can create it by following <a target="_blank" href="https://docs.lotu.sh/en+mining#get-started-22083">these instructions</a>.</span>

8
cmd/lotus-fountain/site/wait.html
View File

@ -1,14 +1,14 @@
<!DOCTYPE html> <!DOCTYPE html>
<html> <html>
<head> <head>
<title>Creating Storage Miner (wait) - Lotus Fountain</title> <title>Creating Miner (wait) - Lotus Fountain</title>
<link rel="stylesheet" type="text/css" href="main.css"> <link rel="stylesheet" type="text/css" href="main.css">
</head> </head>
<body> <body>
<div class="Index"> <div class="Index">
<div class="Index-nodes"> <div class="Index-nodes">
<div class="Index-node"> <div class="Index-node">
[CREATING STORAGE MINER] [CREATING MINER]
</div> </div>
<div class="Index-node"> <div class="Index-node">
Gas Funds:&nbsp;&nbsp;&nbsp;<span id="fcid"></span> - <span id="fstate">WAIT</span> Gas Funds:&nbsp;&nbsp;&nbsp;<span id="fcid"></span> - <span id="fstate">WAIT</span>
@ -17,10 +17,10 @@
Miner Actor:&nbsp;<span id="mcid"></span> - <span id="mstate">WAIT</span> Miner Actor:&nbsp;<span id="mcid"></span> - <span id="mstate">WAIT</span>
</div> </div>
<div class="Index-node" style="display: none" id="fwait"> <div class="Index-node" style="display: none" id="fwait">
New storage miners address is: <b id="actaddr">t</b> New miners address is: <b id="actaddr">t</b>
</div> </div>
<div class="Index-node" style="display: none" id="mwait"> <div class="Index-node" style="display: none" id="mwait">
<div style="padding-bottom: 1em">To initialize the storage miner run the following command:</div> <div style="padding-bottom: 1em">To initialize the miner run the following command:</div>
<div style="overflow-x: visible; white-space: nowrap; background: #353500"> <div style="overflow-x: visible; white-space: nowrap; background: #353500">
<code>lotus-miner init --actor=<span id="actaddr2">t</span> --owner=<span id="owner">t3</span></code> <code>lotus-miner init --actor=<span id="actaddr2">t</span> --owner=<span id="owner">t3</span></code>
</div> </div>

2
cmd/lotus-seal-worker/main.go
View File

@ -51,7 +51,7 @@ func main() {
app := &cli.App{ app := &cli.App{
Name: "lotus-worker", Name: "lotus-worker",
Usage: "Remote storage miner worker", Usage: "Remote miner worker",
Version: build.UserVersion(), Version: build.UserVersion(),
Flags: []cli.Flag{ Flags: []cli.Flag{
&cli.StringFlag{ &cli.StringFlag{

2
cmd/lotus-storage-miner/info.go
View File

@ -23,7 +23,7 @@ import (
var infoCmd = &cli.Command{ var infoCmd = &cli.Command{
Name: "info", Name: "info",
Usage: "Print storage miner info", Usage: "Print miner info",
Flags: []cli.Flag{ Flags: []cli.Flag{
&cli.BoolFlag{Name: "color"}, &cli.BoolFlag{Name: "color"},
}, },

18
cmd/lotus-storage-miner/init.go
View File

@ -50,7 +50,7 @@ import (
var initCmd = &cli.Command{ var initCmd = &cli.Command{
Name: "init", Name: "init",
Usage: "Initialize a lotus storage miner repo", Usage: "Initialize a lotus miner repo",
Flags: []cli.Flag{ Flags: []cli.Flag{
&cli.StringFlag{ &cli.StringFlag{
Name: "actor", Name: "actor",
@ -107,7 +107,7 @@ var initCmd = &cli.Command{
}, },
}, },
Action: func(cctx *cli.Context) error { Action: func(cctx *cli.Context) error {
log.Info("Initializing lotus storage miner") log.Info("Initializing lotus miner")
sectorSizeInt, err := units.RAMInBytes(cctx.String("sector-size")) sectorSizeInt, err := units.RAMInBytes(cctx.String("sector-size"))
if err != nil { if err != nil {
@ -249,7 +249,7 @@ var initCmd = &cli.Command{
} }
// TODO: Point to setting storage price, maybe do it interactively or something // TODO: Point to setting storage price, maybe do it interactively or something
log.Info("Storage miner successfully created, you can now start it with 'lotus-miner run'") log.Info("Miner successfully created, you can now start it with 'lotus-miner run'")
return nil return nil
}, },
@ -456,11 +456,11 @@ func storageMinerInit(ctx context.Context, cctx *cli.Context, api lapi.FullNode,
cerr := configureStorageMiner(ctx, api, a, peerid, gasPrice) cerr := configureStorageMiner(ctx, api, a, peerid, gasPrice)
if err := m.Stop(ctx); err != nil { if err := m.Stop(ctx); err != nil {
log.Error("failed to shut down storage miner: ", err) log.Error("failed to shut down miner: ", err)
} }
if cerr != nil { if cerr != nil {
return xerrors.Errorf("failed to configure storage miner: %w", cerr) return xerrors.Errorf("failed to configure miner: %w", cerr)
} }
} }
@ -494,7 +494,7 @@ func storageMinerInit(ctx context.Context, cctx *cli.Context, api lapi.FullNode,
} }
if err := configureStorageMiner(ctx, api, a, peerid, gasPrice); err != nil { if err := configureStorageMiner(ctx, api, a, peerid, gasPrice); err != nil {
return xerrors.Errorf("failed to configure storage miner: %w", err) return xerrors.Errorf("failed to configure miner: %w", err)
} }
addr = a addr = a
@ -507,7 +507,7 @@ func storageMinerInit(ctx context.Context, cctx *cli.Context, api lapi.FullNode,
addr = a addr = a
} }
log.Infof("Created new storage miner: %s", addr) log.Infof("Created new miner: %s", addr)
if err := mds.Put(datastore.NewKey("miner-address"), addr.Bytes()); err != nil { if err := mds.Put(datastore.NewKey("miner-address"), addr.Bytes()); err != nil {
return err return err
} }
@ -656,7 +656,7 @@ func createStorageMiner(ctx context.Context, api lapi.FullNode, peerid peer.ID,
} }
if mw.Receipt.ExitCode != 0 { if mw.Receipt.ExitCode != 0 {
return address.Undef, xerrors.Errorf("create storage miner failed: exit code %d", mw.Receipt.ExitCode) return address.Undef, xerrors.Errorf("create miner failed: exit code %d", mw.Receipt.ExitCode)
} }
var retval power.CreateMinerReturn var retval power.CreateMinerReturn
@ -664,6 +664,6 @@ func createStorageMiner(ctx context.Context, api lapi.FullNode, peerid peer.ID,
return address.Undef, err return address.Undef, err
} }
log.Infof("New storage miners address is: %s (%s)", retval.IDAddress, retval.RobustAddress) log.Infof("New miners address is: %s (%s)", retval.IDAddress, retval.RobustAddress)
return retval.IDAddress, nil return retval.IDAddress, nil
} }

2
cmd/lotus-storage-miner/main.go
View File

@ -65,7 +65,7 @@ func main() {
app := &cli.App{ app := &cli.App{
Name: "lotus-miner", Name: "lotus-miner",
Usage: "Filecoin decentralized storage network storage miner", Usage: "Filecoin decentralized storage network miner",
Version: build.UserVersion(), Version: build.UserVersion(),
EnableBashCompletion: true, EnableBashCompletion: true,
Flags: []cli.Flag{ Flags: []cli.Flag{

6
cmd/lotus-storage-miner/market.go
View File

@ -357,7 +357,7 @@ var dealsListCmd = &cli.Command{
var getBlocklistCmd = &cli.Command{ var getBlocklistCmd = &cli.Command{
Name: "get-blocklist", Name: "get-blocklist",
Usage: "List the contents of the storage miner's piece CID blocklist", Usage: "List the contents of the miner's piece CID blocklist",
Flags: []cli.Flag{ Flags: []cli.Flag{
&CidBaseFlag, &CidBaseFlag,
}, },
@ -388,7 +388,7 @@ var getBlocklistCmd = &cli.Command{
var setBlocklistCmd = &cli.Command{ var setBlocklistCmd = &cli.Command{
Name: "set-blocklist", Name: "set-blocklist",
Usage: "Set the storage miner's list of blocklisted piece CIDs", Usage: "Set the miner's list of blocklisted piece CIDs",
ArgsUsage: "[<path-of-file-containing-newline-delimited-piece-CIDs> (optional, will read from stdin if omitted)]", ArgsUsage: "[<path-of-file-containing-newline-delimited-piece-CIDs> (optional, will read from stdin if omitted)]",
Flags: []cli.Flag{}, Flags: []cli.Flag{},
Action: func(cctx *cli.Context) error { Action: func(cctx *cli.Context) error {
@ -435,7 +435,7 @@ var setBlocklistCmd = &cli.Command{
var resetBlocklistCmd = &cli.Command{ var resetBlocklistCmd = &cli.Command{
Name: "reset-blocklist", Name: "reset-blocklist",
Usage: "Remove all entries from the storage miner's piece CID blocklist", Usage: "Remove all entries from the miner's piece CID blocklist",
Flags: []cli.Flag{}, Flags: []cli.Flag{},
Action: func(cctx *cli.Context) error { Action: func(cctx *cli.Context) error {
api, closer, err := lcli.GetStorageMinerAPI(cctx) api, closer, err := lcli.GetStorageMinerAPI(cctx)

2
cmd/lotus-storage-miner/run.go
View File

@ -30,7 +30,7 @@ import (
var runCmd = &cli.Command{ var runCmd = &cli.Command{
Name: "run", Name: "run",
Usage: "Start a lotus storage miner process", Usage: "Start a lotus miner process",
Flags: []cli.Flag{ Flags: []cli.Flag{
&cli.StringFlag{ &cli.StringFlag{
Name: "api", Name: "api",

2
cmd/lotus-storage-miner/stop.go
View File

@ -10,7 +10,7 @@ import (
var stopCmd = &cli.Command{ var stopCmd = &cli.Command{
Name: "stop", Name: "stop",
Usage: "Stop a running lotus storage miner", Usage: "Stop a running lotus miner",
Flags: []cli.Flag{}, Flags: []cli.Flag{},
Action: func(cctx *cli.Context) error { Action: func(cctx *cli.Context) error {
api, closer, err := lcli.GetAPI(cctx) api, closer, err := lcli.GetAPI(cctx)

10
documentation/en/.glossary.json
View File

@ -69,7 +69,7 @@
}, },
"filecoin-decentralized-storage-market": { "filecoin-decentralized-storage-market": {
"title": "Filecoin Decentralized Storage Market", "title": "Filecoin Decentralized Storage Market",
"value": "Storage Market subsystem is the data entry point into the network. Storage miners only earn power from data stored in a storage deal and all deals live on the Filecoin network." "value": "Storage Market subsystem is the data entry point into the network. Miners only earn power from data stored in a storage deal and all deals live on the Filecoin network."
}, },
"filecoin-proof-parameters": { "filecoin-proof-parameters": {
"title": "Filecoin Proof Parameters", "title": "Filecoin Proof Parameters",
@ -96,12 +96,12 @@
"value": "The Block Producer Miner's logic. It currently shares an interface and process with the Lotus Node. A Block Producer chooses which messages to include in a block and is rewarded according to each message’s gas price and consumption, forming a market." "value": "The Block Producer Miner's logic. It currently shares an interface and process with the Lotus Node. A Block Producer chooses which messages to include in a block and is rewarded according to each message’s gas price and consumption, forming a market."
}, },
"lotus-storage-miner": { "lotus-storage-miner": {
"title": "Storage Miner (lotus-miner)", "title": "Miner (lotus-miner)",
"value": "The Storage Miner's logic. It has its own dedicated process. Contributes to the network through Sector commitments and Proofs of Spacetime to prove that it is storing the sectors it has commited to." "value": "The Miner's logic. It has its own dedicated process. Contributes to the network through Sector commitments and Proofs of Spacetime to prove that it is storing the sectors it has commited to."
}, },
"swarm-port": { "swarm-port": {
"title": "Swarm Port (Libp2p)", "title": "Swarm Port (Libp2p)",
"value": "The LibP2P Swarm manages groups of connections to peers, handles incoming and outgoing streams, and is part of the storage miners implementation. The port value is part of the Host interface." "value": "The LibP2P Swarm manages groups of connections to peers, handles incoming and outgoing streams, and is part of the miners implementation. The port value is part of the Host interface."
}, },
"daemon": { "daemon": {
"title": "Lotus Daemon", "title": "Lotus Daemon",
@ -129,7 +129,7 @@
}, },
"total-network-power": { "total-network-power": {
"title": "Total Network Power", "title": "Total Network Power",
"value": "A reference to all the Power Tables for every subchain, accounting for each Lotus Storage Miner on chain." "value": "A reference to all the Power Tables for every subchain, accounting for each Lotus Miner on chain."
}, },
"chain-block-height": { "chain-block-height": {
"title": "Chain Block Height", "title": "Chain Block Height",

6
documentation/en/.library.json
View File

@ -83,9 +83,9 @@
"value": null, "value": null,
"posts": [ "posts": [
{ {
"title": "Lotus Seal Worker", "title": "Lotus Worker",
"slug": "en+lotus-seal-worker", "slug": "en+lotus-worker",
"github": "en/mining-lotus-seal-worker.md", "github": "en/mining-lotus-worker.md",
"value": null "value": null
}, },
{ {

6
documentation/en/api-scripting-support.md
View File

@ -1,6 +1,6 @@
# Remote API Support # Remote API Support
You may want to delegate the work **Lotus Storage Miner** or **Lotus Node** performs to other machines. You may want to delegate the work **Lotus Miner** or **Lotus Node** performs to other machines.
Here is how to setup the necessary authorization and environment variables. Here is how to setup the necessary authorization and environment variables.
## Environment variables ## Environment variables
@ -13,7 +13,7 @@ Using the [JWT you generated](https://lotu.sh/en+api#how-do-i-generate-a-token-1
# Lotus Node # Lotus Node
FULLNODE_API_INFO="JWT_TOKEN:/ip4/127.0.0.1/tcp/1234/http" FULLNODE_API_INFO="JWT_TOKEN:/ip4/127.0.0.1/tcp/1234/http"
# Lotus Storage Miner # Lotus Miner
MINER_API_INFO="JWT_TOKEN:/ip4/127.0.0.1/tcp/2345/http" MINER_API_INFO="JWT_TOKEN:/ip4/127.0.0.1/tcp/2345/http"
``` ```
@ -21,5 +21,5 @@ You can also use `lotus auth api-info --perm admin` to quickly create _API_INFO
- The **Lotus Node**'s `mutliaddr` is in `~/.lotus/api`. - The **Lotus Node**'s `mutliaddr` is in `~/.lotus/api`.
- The default token is in `~/.lotus/token`. - The default token is in `~/.lotus/token`.
- The **Lotus Storage Miner**'s `multiaddr` is in `~/.lotusminer/config`. - The **Lotus Miner**'s `multiaddr` is in `~/.lotusminer/config`.
- The default token is in `~/.lotusminer/token`. - The default token is in `~/.lotusminer/token`.

8
documentation/en/api.md
View File

@ -18,9 +18,9 @@ Options:
For now, you can look into different files to find methods available to you based on your needs: For now, you can look into different files to find methods available to you based on your needs:
- [Both Lotus node + storage miner APIs](https://github.com/filecoin-project/lotus/blob/master/api/api_common.go) - [Both Lotus node + miner APIs](https://github.com/filecoin-project/lotus/blob/master/api/api_common.go)
- [Lotus node API](https://github.com/filecoin-project/lotus/blob/master/api/api_full.go) - [Lotus node API](https://github.com/filecoin-project/lotus/blob/master/api/api_full.go)
- [Storage miner API](https://github.com/filecoin-project/lotus/blob/master/api/api_storage.go) - [Lotus miner API](https://github.com/filecoin-project/lotus/blob/master/api/api_storage.go)
The necessary permissions for each are in [api/struct.go](https://github.com/filecoin-project/lotus/blob/master/api/struct.go). The necessary permissions for each are in [api/struct.go](https://github.com/filecoin-project/lotus/blob/master/api/struct.go).
@ -61,7 +61,7 @@ To authorize your request, you will need to include the **JWT** in a HTTP header
-H "Authorization: Bearer $(cat ~/.lotusminer/token)" -H "Authorization: Bearer $(cat ~/.lotusminer/token)"
``` ```
Admin token is stored in `~/.lotus/token` for the **Lotus Node** or `~/.lotusminer/token` for the **Lotus Storage Miner**. Admin token is stored in `~/.lotus/token` for the **Lotus Node** or `~/.lotusminer/token` for the **Lotus Miner**.
## How do I generate a token? ## How do I generate a token?
@ -71,7 +71,7 @@ To generate a JWT with custom permissions, use this command:
# Lotus Node # Lotus Node
lotus auth create-token --perm admin lotus auth create-token --perm admin
# Lotus Storage Miner # Lotus Miner
lotus-miner auth create-token --perm admin lotus-miner auth create-token --perm admin
``` ```

2
documentation/en/architecture.md
View File

@ -344,7 +344,7 @@ At the end of the `Repo()` function we see two mutually exclusive configuration
ApplyIf(isType(repo.FullNode), ConfigFullNode(c)), ApplyIf(isType(repo.FullNode), ConfigFullNode(c)),
ApplyIf(isType(repo.StorageMiner), ConfigStorageMiner(c)), ApplyIf(isType(repo.StorageMiner), ConfigStorageMiner(c)),
``` ```
As we said, the repo fully identifies the node so a repo type is also a *node* type, in this case a full node or a storage miner. (FIXME: What is the difference between the two, does *full* imply miner?) In this case the `daemon` command will create a `FullNode`, this is specified in the command logic itself in `main.DaemonCmd()`, the `FsRepo` created (and passed to `node.Repo()`) will be initiated with that type (see `(*FsRepo).Init(t RepoType)`). As we said, the repo fully identifies the node so a repo type is also a *node* type, in this case a full node or a miner. (FIXME: What is the difference between the two, does *full* imply miner?) In this case the `daemon` command will create a `FullNode`, this is specified in the command logic itself in `main.DaemonCmd()`, the `FsRepo` created (and passed to `node.Repo()`) will be initiated with that type (see `(*FsRepo).Init(t RepoType)`).
## Online ## Online

2
documentation/en/dev-tools-pond-ui.md
View File

@ -19,7 +19,7 @@ Now go to `http://127.0.0.1:2222`.
## What can I test? ## What can I test?
- The `Spawn Node` button starts a new **Lotus Node** in a new draggable window. - The `Spawn Node` button starts a new **Lotus Node** in a new draggable window.
- Click `[Spawn Storage Miner]` to start a **Lotus Storage Miner**. This require's the node's wallet to have funds. - Click `[Spawn Miner]` to start a **Lotus Miner**. This require's the node's wallet to have funds.
- Click on `[Client]` to open the **Lotus Node**'s client interface and propose a deal with an existing Miner. If successful you'll see a payment channel open up with that Miner. - Click on `[Client]` to open the **Lotus Node**'s client interface and propose a deal with an existing Miner. If successful you'll see a payment channel open up with that Miner.
Don't leave Pond unattended for more than 10 hours, the web client will eventually consume all available RAM. Don't leave Pond unattended for more than 10 hours, the web client will eventually consume all available RAM.

6
documentation/en/faqs.md
View File

@ -22,9 +22,9 @@ along the way. It can also facilitate the creation of new storage deals. If you
interested in providing your own storage to the network, and do not want to produce blocks interested in providing your own storage to the network, and do not want to produce blocks
yourself, then the Lotus Node is all you need! yourself, then the Lotus Node is all you need!
The Lotus Storage Miner does everything you need for the registration of storage, and the The Lotus Miner does everything you need for the registration of storage, and the
production of new blocks. The Lotus Storage Miner communicates with the network production of new blocks. The Lotus Miner communicates with the network by talking
by talking to a Lotus Node over the JSON-RPC API. to a Lotus Node over the JSON-RPC API.
## Setting up a Lotus Node ## Setting up a Lotus Node

8
documentation/en/getting-started.md
View File

@ -9,15 +9,15 @@ For more details about Filecoin, check out the [Filecoin Docs](https://docs.file
- How to install Lotus on [Arch Linux](https://docs.lotu.sh/en+install-lotus-arch), [Ubuntu](https://docs.lotu.sh/en+install-lotus-ubuntu), or [MacOS](https://docs.lotu.sh/en+install-lotus-macos). - How to install Lotus on [Arch Linux](https://docs.lotu.sh/en+install-lotus-arch), [Ubuntu](https://docs.lotu.sh/en+install-lotus-ubuntu), or [MacOS](https://docs.lotu.sh/en+install-lotus-macos).
- Joining the [Lotus Testnet](https://docs.lotu.sh/en+join-testnet). - Joining the [Lotus Testnet](https://docs.lotu.sh/en+join-testnet).
- [Storing](https://docs.lotu.sh/en+storing-data) or [retrieving](https://docs.lotu.sh/en+retrieving-data) data. - [Storing](https://docs.lotu.sh/en+storing-data) or [retrieving](https://docs.lotu.sh/en+retrieving-data) data.
- Mining Filecoin using the **Lotus Storage Miner** in your [CLI](https://docs.lotu.sh/en+mining). - Mining Filecoin using the **Lotus Miner** in your [CLI](https://docs.lotu.sh/en+mining).
## How is Lotus designed? ## How is Lotus designed?
Lotus is architected modularly to keep clean API boundaries while using the same process. Installing Lotus will include two separate programs: Lotus is architected modularly to keep clean API boundaries while using the same process. Installing Lotus will include two separate programs:
- The **Lotus Node** - The **Lotus Node**
- The **Lotus Storage Miner** - The **Lotus Miner**
The **Lotus Storage Miner** is intended to be run on the machine that manages a single storage miner instance, and is meant to communicate with the **Lotus Node** via the websocket **JSON-RPC** API for all of the chain interaction needs. The **Lotus Miner** is intended to be run on the machine that manages a single miner instance, and is meant to communicate with the **Lotus Node** via the websocket **JSON-RPC** API for all of the chain interaction needs.
This way, a mining operation may easily run a **Lotus Storage Miner** or many of them, connected to one or many **Lotus Node** instances. This way, a mining operation may easily run a **Lotus Miner** or many of them, connected to one or many **Lotus Node** instances.

2
documentation/en/hardware-mining.md
View File

@ -1,6 +1,6 @@
# Protocol Labs Standard Testing Configuration # Protocol Labs Standard Testing Configuration
> This documentation page describes the standard testing configuration the Protocol Labs team has used to test **Lotus Storage Miner**s on Lotus. There is no guarantee this testing configuration will be suitable for Filecoin storage mining at MainNet launch. If you need to buy new hardware to join the Filecoin Testnet, we recommend to buy no more hardware than you require for testing. To learn more please read this [Protocol Labs Standard Testing Configuration post](https://filecoin.io/blog/filecoin-testnet-mining/). > This documentation page describes the standard testing configuration the Protocol Labs team has used to test **Lotus Miner**s on Lotus. There is no guarantee this testing configuration will be suitable for Filecoin storage mining at MainNet launch. If you need to buy new hardware to join the Filecoin Testnet, we recommend to buy no more hardware than you require for testing. To learn more please read this [Protocol Labs Standard Testing Configuration post](https://filecoin.io/blog/filecoin-testnet-mining/).
**Sector sizes** and **minimum pledged storage** required to mine blocks are two very important Filecoin Testnet parameters that impact hardware decisions. We will continue to refine all parameters during Testnet. **Sector sizes** and **minimum pledged storage** required to mine blocks are two very important Filecoin Testnet parameters that impact hardware decisions. We will continue to refine all parameters during Testnet.

18
documentation/en/mining-lotus-seal-worker.md → documentation/en/mining-lotus-worker.md
View File

@ -1,8 +1,8 @@
# Lotus Seal Worker # Lotus Worker
The **Lotus Seal Worker** is an extra process that can offload heavy processing tasks from your **Lotus Storage Miner**. The sealing process automatically runs in the **Lotus Storage Miner** process, but you can use the Seal Worker on another machine communicating over a fast network to free up resources on the machine running the mining process. The **Lotus Worker** is an extra process that can offload heavy processing tasks from your **Lotus Miner**. The sealing process automatically runs in the **Lotus Miner** process, but you can use the Worker on another machine communicating over a fast network to free up resources on the machine running the mining process.
## Note: Using the Lotus Seal Worker from China ## Note: Using the Lotus Worker from China
If you are trying to use `lotus-worker` from China. You should set this **environment variable** on your machine: If you are trying to use `lotus-worker` from China. You should set this **environment variable** on your machine:
@ -18,7 +18,7 @@ Make sure that the `lotus-worker` is compiled and installed by running:
make lotus-worker make lotus-worker
``` ```
## Setting up the Storage Miner ## Setting up the Miner
First, you will need to ensure your `lotus-miner`'s API is accessible over the network. First, you will need to ensure your `lotus-miner`'s API is accessible over the network.
@ -40,9 +40,9 @@ A more permissive and less secure option is to change it to `0.0.0.0`. This will
Next, you will need to [create an authentication token](https://docs.lotu.sh/en+api-scripting-support#generate-a-jwt-46). All Lotus APIs require authentication tokens to ensure your processes are as secure against attackers attempting to make unauthenticated requests to them. Next, you will need to [create an authentication token](https://docs.lotu.sh/en+api-scripting-support#generate-a-jwt-46). All Lotus APIs require authentication tokens to ensure your processes are as secure against attackers attempting to make unauthenticated requests to them.
### Connect the Lotus Seal Worker ### Connect the Lotus Worker
On the machine that will run `lotus-worker`, set the `MINER_API_INFO` environment variable to `TOKEN:MINER_NODE_MULTIADDR`. Where `TOKEN` is the token we created above, and `NIMER_NODE_MULTIADDR` is the `multiaddr` of the **Lotus Storage Miner** API that was set in `config.toml`. On the machine that will run `lotus-worker`, set the `MINER_API_INFO` environment variable to `TOKEN:MINER_NODE_MULTIADDR`. Where `TOKEN` is the token we created above, and `NIMER_NODE_MULTIADDR` is the `multiaddr` of the **Lotus Miner** API that was set in `config.toml`.
Once this is set, run: Once this is set, run:
@ -52,7 +52,7 @@ lotus-worker run --address 192.168.2.10:2345
Replace `192.168.2.10:2345` with the proper IP and port. Replace `192.168.2.10:2345` with the proper IP and port.
To check that the **Lotus Seal Worker** is connected to your **Lotus Storage Miner**, run `lotus-miner workers list` and check that the remote worker count has increased. To check that the **Lotus Worker** is connected to your **Lotus Miner**, run `lotus-miner workers list` and check that the remote worker count has increased.
```sh ```sh
why@computer ~/lotus> lotus-miner workers list why@computer ~/lotus> lotus-miner workers list
@ -71,10 +71,10 @@ Worker 1, host othercomputer
### Running locally for manually managing process priority ### Running locally for manually managing process priority
You can also run the **Lotus Seal Worker** on the same machine as your **Lotus Storage Miner**, so you can manually manage the process priority. You can also run the **Lotus Worker** on the same machine as your **Lotus Miner**, so you can manually manage the process priority.
To do so you have to first __disable all seal task types__ in the miner config. This is important to prevent conflicts between the two processes. To do so you have to first __disable all seal task types__ in the miner config. This is important to prevent conflicts between the two processes.
You can then run the storage miner on your local-loopback interface; You can then run the miner on your local-loopback interface;
```sh ```sh
lotus-worker run --address 127.0.0.1:2345 lotus-worker run --address 127.0.0.1:2345

4
documentation/en/mining-troubleshooting.md
View File

@ -16,7 +16,7 @@ The **Bellman** lockfile is created to lock a GPU for a process. This bug can oc
mining block failed: computing election proof: github.com/filecoin-project/lotus/miner.(*Miner).mineOne mining block failed: computing election proof: github.com/filecoin-project/lotus/miner.(*Miner).mineOne
``` ```
This bug occurs when the storage miner can't acquire the `bellman.lock`. To fix it you need to stop the `lotus-miner` and remove `/tmp/bellman.lock`. This bug occurs when the miner can't acquire the `bellman.lock`. To fix it you need to stop the `lotus-miner` and remove `/tmp/bellman.lock`.
## Error: Failed to get api endpoint ## Error: Failed to get api endpoint
@ -25,7 +25,7 @@ lotus-miner info
# WARN main lotus-storage-miner/main.go:73 failed to get api endpoint: (/Users/myrmidon/.lotusminer) %!w(*errors.errorString=&{API not running (no endpoint)}): # WARN main lotus-storage-miner/main.go:73 failed to get api endpoint: (/Users/myrmidon/.lotusminer) %!w(*errors.errorString=&{API not running (no endpoint)}):
``` ```
If you see this, that means your **Lotus Storage Miner** isn't ready yet. You need to finish [syncing the chain](https://docs.lotu.sh/en+join-testnet). If you see this, that means your **Lotus Miner** isn't ready yet. You need to finish [syncing the chain](https://docs.lotu.sh/en+join-testnet).
## Error: Your computer may not be fast enough ## Error: Your computer may not be fast enough

6
documentation/en/mining.md
View File

@ -4,7 +4,7 @@ Here are instructions to learn how to perform storage mining. For hardware speci
It is useful to [join the Testnet](https://docs.lotu.sh/en+join-testnet) prior to attempting storage mining for the first time. It is useful to [join the Testnet](https://docs.lotu.sh/en+join-testnet) prior to attempting storage mining for the first time.
## Note: Using the Lotus Storage Miner from China ## Note: Using the Lotus Miner from China
If you are trying to use `lotus-miner` from China. You should set this **environment variable** on your machine. If you are trying to use `lotus-miner` from China. You should set this **environment variable** on your machine.
@ -35,10 +35,10 @@ With your wallet address:
The task will be complete when you see: The task will be complete when you see:
```sh ```sh
New storage miners address is: <YOUR_NEW_MINING_ADDRESS> New miners address is: <YOUR_NEW_MINING_ADDRESS>
``` ```
## Initialize the storage miner ## Initialize the miner
In a CLI window, use the following command to start your miner: In a CLI window, use the following command to start your miner:

2
documentation/en/retrieving-data.md
View File

@ -2,7 +2,7 @@
> There are recent bug reports with these instructions. If you happen to encounter any problems, please create a [GitHub issue](https://github.com/filecoin-project/lotus/issues/new) and a maintainer will address the problem as soon as they can. > There are recent bug reports with these instructions. If you happen to encounter any problems, please create a [GitHub issue](https://github.com/filecoin-project/lotus/issues/new) and a maintainer will address the problem as soon as they can.
Here are the operations you can perform after you have stored and sealed a **Data CID** with the **Lotus Storage Miner** in the network. Here are the operations you can perform after you have stored and sealed a **Data CID** with the **Lotus Miner** in the network.
If you would like to learn how to store a **Data CID** on a miner, read the instructions [here](https://docs.lotu.sh/en+storing-data). If you would like to learn how to store a **Data CID** on a miner, read the instructions [here](https://docs.lotu.sh/en+storing-data).

2
documentation/en/setting-a-static-port.md
View File

@ -1,6 +1,6 @@
# Static Ports # Static Ports
Depending on how your network is set up, you may need to set a static port to successfully connect to peers to perform storage deals with your **Lotus Storage Miner**. Depending on how your network is set up, you may need to set a static port to successfully connect to peers to perform storage deals with your **Lotus Miner**.
## Setup ## Setup

2
documentation/en/storing-data-troubleshooting.md
View File

@ -24,4 +24,4 @@ In order to retrieve a file, it must be sealed. Miners can check sealing progres
lotus-miner sectors list lotus-miner sectors list
``` ```
When sealing is complete, `pSet: NO` will become `pSet: YES`. From now on the **Data CID** is [retrievable](https://docs.lotu.sh/en+retrieving-data) from the **Lotus Storage Miner**. When sealing is complete, `pSet: NO` will become `pSet: YES`. From now on the **Data CID** is [retrievable](https://docs.lotu.sh/en+retrieving-data) from the **Lotus Miner**.

2
documentation/en/storing-data.md
View File

@ -59,4 +59,4 @@ lotus client list-deals
Upon success, this command will return a **Deal CID**. Upon success, this command will return a **Deal CID**.
The storage miner will need to **seal** the file before it can be retrieved. If the **Lotus Storage Miner** is not running on a machine designed for sealing, the process will take a very long time. The miner will need to **seal** the file before it can be retrieved. If the **Lotus Miner** is not running on a machine designed for sealing, the process will take a very long time.

2
lotuspond/front/src/FullNode.js
View File

@ -106,7 +106,7 @@ class FullNode extends React.Component {
) )
} }
let storageMine = <a href="#" onClick={this.startStorageMiner} hidden={!this.props.spawnStorageNode}>[Spawn Storage Miner]</a> let storageMine = <a href="#" onClick={this.startStorageMiner} hidden={!this.props.spawnStorageNode}>[Spawn Miner]</a>
let addresses = this.state.addrs.map((addr) => { let addresses = this.state.addrs.map((addr) => {
let line = <Address client={this.props.client} addN={this.props.giveN} add10k={true} nonce={true} addr={addr} mountWindow={this.props.mountWindow}/> let line = <Address client={this.props.client} addN={this.props.giveN} add10k={true} nonce={true} addr={addr} mountWindow={this.props.mountWindow}/>

2
lotuspond/front/src/StorageNode.js
View File

@ -147,7 +147,7 @@ class StorageNode extends React.Component {
} }
return <Window return <Window
title={"Storage Miner Node " + this.props.node.ID} title={"Miner Node " + this.props.node.ID}
initialPosition={{x: this.props.node.ID*30, y: this.props.node.ID * 30}} initialPosition={{x: this.props.node.ID*30, y: this.props.node.ID * 30}}
onClose={this.stop} > onClose={this.stop} >
<div className="CristalScroll"> <div className="CristalScroll">

2
lotuspond/front/src/StorageNodeInit.js
View File

@ -11,7 +11,7 @@ class StorageNodeInit extends React.Component {
render() { render() {
return <Window return <Window
title={"Storage miner initializing"} title={"Miner initializing"}
initialPosition={'center'}> initialPosition={'center'}>
<div className="CristalScroll"> <div className="CristalScroll">
<div className="StorageNodeInit"> <div className="StorageNodeInit">

4
node/builder.go
View File

@ -108,7 +108,7 @@ const (
RegisterClientValidatorKey RegisterClientValidatorKey
// storage miner // miner
GetParamsKey GetParamsKey
HandleDealsKey HandleDealsKey
HandleRetrievalKey HandleRetrievalKey
@ -274,7 +274,7 @@ func Online() Option {
Override(new(*market.FundMgr), market.NewFundMgr), Override(new(*market.FundMgr), market.NewFundMgr),
), ),
// Storage miner // miner
ApplyIf(func(s *Settings) bool { return s.nodeType == repo.StorageMiner }, ApplyIf(func(s *Settings) bool { return s.nodeType == repo.StorageMiner },
Override(new(api.Common), From(new(common.CommonAPI))), Override(new(api.Common), From(new(common.CommonAPI))),
Override(new(sectorstorage.StorageAuth), modules.StorageAuth), Override(new(sectorstorage.StorageAuth), modules.StorageAuth),

2
node/config/def.go
View File

@ -25,7 +25,7 @@ type FullNode struct {
// // Common // // Common
// StorageMiner is a storage miner config // StorageMiner is a miner config
type StorageMiner struct { type StorageMiner struct {
Common Common

4
node/modules/dtypes/miner.go
View File

@ -27,12 +27,12 @@ type ConsiderOnlineRetrievalDealsConfigFunc func() (bool, error)
type SetConsiderOnlineRetrievalDealsConfigFunc func(bool) error type SetConsiderOnlineRetrievalDealsConfigFunc func(bool) error
// StorageDealPieceCidBlocklistConfigFunc is a function which reads from miner // StorageDealPieceCidBlocklistConfigFunc is a function which reads from miner
// config to obtain a list of CIDs for which the storage miner will not accept // config to obtain a list of CIDs for which the miner will not accept
// storage proposals. // storage proposals.
type StorageDealPieceCidBlocklistConfigFunc func() ([]cid.Cid, error) type StorageDealPieceCidBlocklistConfigFunc func() ([]cid.Cid, error)
// SetStorageDealPieceCidBlocklistConfigFunc is a function which is used to set a // SetStorageDealPieceCidBlocklistConfigFunc is a function which is used to set a
// list of CIDs for which the storage miner will reject deal proposals. // list of CIDs for which the miner will reject deal proposals.
type SetStorageDealPieceCidBlocklistConfigFunc func([]cid.Cid) error type SetStorageDealPieceCidBlocklistConfigFunc func([]cid.Cid) error
// ConsiderOfflineStorageDealsConfigFunc is a function which reads from miner // ConsiderOfflineStorageDealsConfigFunc is a function which reads from miner

2
node/modules/dtypes/shutdown.go
View File

@ -1,5 +1,5 @@
package dtypes package dtypes
// ShutdownChan is a channel to which you send a value if you intend to shut // ShutdownChan is a channel to which you send a value if you intend to shut
// down the daemon (or storage miner), including the node and RPC server. // down the daemon (or miner), including the node and RPC server.
type ShutdownChan chan struct{} type ShutdownChan chan struct{}

2
node/modules/storageminer.go
View File

@ -585,7 +585,7 @@ func mutateCfg(r repo.LockedRepo, mutator func(*config.StorageMiner)) error {
setConfigErr := r.SetConfig(func(raw interface{}) { setConfigErr := r.SetConfig(func(raw interface{}) {
cfg, ok := raw.(*config.StorageMiner) cfg, ok := raw.(*config.StorageMiner)
if !ok { if !ok {
typeErr = errors.New("expected storage miner config") typeErr = errors.New("expected miner config")
return return
} }

2
scripts/devnet.bash
View File

@ -127,7 +127,7 @@ while true; do
echo echo
echo echo
echo Storage Miner Info echo Miner Info
lotus-miner info lotus-miner info
echo echo

2
scripts/lotus-miner.service
View File

@ -1,5 +1,5 @@
[Unit] [Unit]
Description=Lotus Storage Miner Description=Lotus Miner
After=network.target After=network.target
After=lotus-daemon.service After=lotus-daemon.service
Requires=lotus-daemon.service Requires=lotus-daemon.service

2
scripts/miner-mon.sh
View File

@ -4,7 +4,7 @@ SESSION=$(cat /proc/sys/kernel/random/uuid)
tmux -2 new-session -d -s $SESSION tmux -2 new-session -d -s $SESSION
tmux new-window -t $SESSION:1 -n 'Storage Miner' tmux new-window -t $SESSION:1 -n 'Miner'
tmux split-window -h tmux split-window -h

2
scripts/quick-network-join.bash
View File

@ -122,7 +122,7 @@ while true; do
echo echo
echo echo
echo Storage Miner Info echo Miner Info
lotus-miner info lotus-miner info
echo echo

4
tools/dockers/docker-examples/README.md
View File

@ -5,8 +5,8 @@ In this `docker-examples/` directory are community-contributed Docker and Docker
#### Example Use Cases #### Example Use Cases
- **For a miner** - **For a miner**
- basic storage miner (`miner-basic-`) - basic miner (`miner-basic-`)
- distributed storage miner - distributed miner
- **For API endpoints for building apps** - **For API endpoints for building apps**
- local node for a developer (`api-local-`) - local node for a developer (`api-local-`)
- hosted endpoint for apps / multiple developers (`api-hosted-`) - hosted endpoint for apps / multiple developers (`api-hosted-`)

2
tools/dockers/docker-examples/basic-miner-busybox/README.md
View File

@ -1,4 +1,4 @@
## Description ## Description
- **For a miner** - **For a miner**
- basic storage miner - basic miner