package testkit import ( "context" "crypto/rand" "encoding/json" "fmt" "io/ioutil" "net/http" "path/filepath" "time" "contrib.go.opencensus.io/exporter/prometheus" "github.com/filecoin-project/go-address" "github.com/filecoin-project/go-jsonrpc" "github.com/filecoin-project/go-jsonrpc/auth" "github.com/filecoin-project/go-state-types/abi" "github.com/filecoin-project/go-storedcounter" "github.com/filecoin-project/lotus/api" "github.com/filecoin-project/lotus/build" "github.com/filecoin-project/lotus/chain/actors" genesis_chain "github.com/filecoin-project/lotus/chain/gen/genesis" "github.com/filecoin-project/lotus/chain/types" "github.com/filecoin-project/lotus/chain/wallet" "github.com/filecoin-project/lotus/cmd/lotus-seed/seed" "github.com/filecoin-project/lotus/extern/sector-storage/stores" "github.com/filecoin-project/lotus/markets/storageadapter" "github.com/filecoin-project/lotus/miner" "github.com/filecoin-project/lotus/node" "github.com/filecoin-project/lotus/node/config" "github.com/filecoin-project/lotus/node/impl" "github.com/filecoin-project/lotus/node/modules" "github.com/filecoin-project/lotus/node/repo" "github.com/filecoin-project/specs-actors/actors/builtin" saminer "github.com/filecoin-project/specs-actors/actors/builtin/miner" "github.com/google/uuid" "github.com/gorilla/mux" "github.com/hashicorp/go-multierror" "github.com/ipfs/go-datastore" libp2pcrypto "github.com/libp2p/go-libp2p-core/crypto" "github.com/libp2p/go-libp2p-core/peer" "github.com/testground/sdk-go/sync" ) const ( sealDelay = 30 * time.Second ) type LotusMiner struct { *LotusNode MinerRepo repo.Repo NodeRepo repo.Repo FullNetAddrs []peer.AddrInfo GenesisMsg *GenesisMsg Subsystems config.MinerSubsystemConfig t *TestEnvironment } func PrepareMiner(t *TestEnvironment) (*LotusMiner, error) { ctx, cancel := context.WithTimeout(context.Background(), PrepareNodeTimeout) defer cancel() ApplyNetworkParameters(t) pubsubTracer, err := GetPubsubTracerMaddr(ctx, t) if err != nil { return nil, err } drandOpt, err := GetRandomBeaconOpts(ctx, t) if err != nil { return nil, err } // first create a wallet walletKey, err := wallet.GenerateKey(types.KTBLS) if err != nil { return nil, err } // publish the account ID/balance balance := t.FloatParam("balance") balanceMsg := &InitialBalanceMsg{Addr: walletKey.Address, Balance: balance} t.SyncClient.Publish(ctx, BalanceTopic, balanceMsg) // create and publish the preseal commitment priv, _, err := libp2pcrypto.GenerateEd25519Key(rand.Reader) if err != nil { return nil, err } minerID, err := peer.IDFromPrivateKey(priv) if err != nil { return nil, err } // pick unique sequence number for each miner, no matter in which group they are seq := t.SyncClient.MustSignalAndWait(ctx, StateMinerPickSeqNum, t.IntParam("miners")) minerAddr, err := address.NewIDAddress(genesis_chain.MinerStart + uint64(seq-1)) if err != nil { return nil, err } presealDir, err := ioutil.TempDir("", "preseal") if err != nil { return nil, err } sectors := t.IntParam("sectors") genMiner, _, err := seed.PreSeal(minerAddr, abi.RegisteredSealProof_StackedDrg8MiBV1, 0, sectors, presealDir, []byte("TODO: randomize this"), &walletKey.KeyInfo, false) if err != nil { return nil, err } genMiner.PeerId = minerID t.RecordMessage("Miner Info: Owner: %s Worker: %s", genMiner.Owner, genMiner.Worker) presealMsg := &PresealMsg{Miner: *genMiner, Seqno: seq} t.SyncClient.Publish(ctx, PresealTopic, presealMsg) // then collect the genesis block and bootstrapper address genesisMsg, err := WaitForGenesis(t, ctx) if err != nil { return nil, err } // prepare the repo minerRepoDir, err := ioutil.TempDir("", "miner-repo-dir") if err != nil { return nil, err } minerRepo, err := repo.NewFS(minerRepoDir) if err != nil { return nil, err } err = minerRepo.Init(repo.StorageMiner) if err != nil { return nil, err } var subsystems config.MinerSubsystemConfig { lr, err := minerRepo.Lock(repo.StorageMiner) if err != nil { return nil, err } c, err := lr.Config() if err != nil { return nil, err } cfg := c.(*config.StorageMiner) subsystems = cfg.Subsystems ks, err := lr.KeyStore() if err != nil { return nil, err } kbytes, err := priv.Bytes() if err != nil { return nil, err } err = ks.Put("libp2p-host", types.KeyInfo{ Type: "libp2p-host", PrivateKey: kbytes, }) if err != nil { return nil, err } ds, err := lr.Datastore(context.Background(), "/metadata") if err != nil { return nil, err } err = ds.Put(datastore.NewKey("miner-address"), minerAddr.Bytes()) if err != nil { return nil, err } nic := storedcounter.New(ds, datastore.NewKey(modules.StorageCounterDSPrefix)) for i := 0; i < (sectors + 1); i++ { _, err = nic.Next() if err != nil { return nil, err } } var localPaths []stores.LocalPath b, err := json.MarshalIndent(&stores.LocalStorageMeta{ ID: stores.ID(uuid.New().String()), Weight: 10, CanSeal: true, CanStore: true, }, "", " ") if err != nil { return nil, fmt.Errorf("marshaling storage config: %w", err) } if err := ioutil.WriteFile(filepath.Join(lr.Path(), "sectorstore.json"), b, 0644); err != nil { return nil, fmt.Errorf("persisting storage metadata (%s): %w", filepath.Join(lr.Path(), "sectorstore.json"), err) } localPaths = append(localPaths, stores.LocalPath{ Path: lr.Path(), }) if err := lr.SetStorage(func(sc *stores.StorageConfig) { sc.StoragePaths = append(sc.StoragePaths, localPaths...) }); err != nil { return nil, err } err = lr.Close() if err != nil { return nil, err } } minerIP := t.NetClient.MustGetDataNetworkIP().String() // create the node // we need both a full node _and_ and storage miner node n := &LotusNode{} // prepare the repo nodeRepoDir, err := ioutil.TempDir("", "node-repo-dir") if err != nil { return nil, err } nodeRepo, err := repo.NewFS(nodeRepoDir) if err != nil { return nil, err } err = nodeRepo.Init(repo.FullNode) if err != nil { return nil, err } stop1, err := node.New(context.Background(), node.FullAPI(&n.FullApi), node.Base(), node.Repo(nodeRepo), withGenesis(genesisMsg.Genesis), withApiEndpoint(fmt.Sprintf("/ip4/0.0.0.0/tcp/%s", t.PortNumber("node_rpc", "0"))), withListenAddress(minerIP), withBootstrapper(genesisMsg.Bootstrapper), withPubsubConfig(false, pubsubTracer), drandOpt, ) if err != nil { return nil, fmt.Errorf("node node.new error: %w", err) } // set the wallet err = n.setWallet(ctx, walletKey) if err != nil { stop1(context.TODO()) return nil, err } minerOpts := []node.Option{ node.StorageMiner(&n.MinerApi, subsystems), node.Base(), node.Repo(minerRepo), node.Override(new(api.FullNode), n.FullApi), node.Override(new(*storageadapter.DealPublisher), storageadapter.NewDealPublisher(nil, storageadapter.PublishMsgConfig{ Period: 15 * time.Second, MaxDealsPerMsg: 1, })), withApiEndpoint(fmt.Sprintf("/ip4/0.0.0.0/tcp/%s", t.PortNumber("miner_rpc", "0"))), withMinerListenAddress(minerIP), } if t.StringParam("mining_mode") != "natural" { mineBlock := make(chan miner.MineReq) minerOpts = append(minerOpts, node.Override(new(*miner.Miner), miner.NewTestMiner(mineBlock, minerAddr))) n.MineOne = func(ctx context.Context, cb miner.MineReq) error { select { case mineBlock <- cb: return nil case <-ctx.Done(): return ctx.Err() } } } stop2, err := node.New(context.Background(), minerOpts...) if err != nil { stop1(context.TODO()) return nil, fmt.Errorf("miner node.new error: %w", err) } registerAndExportMetrics(minerAddr.String()) // collect stats based on blockchain from first instance of `miner` role if t.InitContext.GroupSeq == 1 && t.Role == "miner" { go collectStats(t, ctx, n.FullApi) } // Start listening on the full node. fullNodeNetAddrs, err := n.FullApi.NetAddrsListen(ctx) if err != nil { panic(err) } // set seal delay to lower value than 1 hour err = n.MinerApi.SectorSetSealDelay(ctx, sealDelay) if err != nil { return nil, err } // set expected seal duration to 1 minute err = n.MinerApi.SectorSetExpectedSealDuration(ctx, 1*time.Minute) if err != nil { return nil, err } // print out the admin auth token token, err := n.MinerApi.AuthNew(ctx, api.AllPermissions) if err != nil { return nil, err } t.RecordMessage("Auth token: %s", string(token)) // add local storage for presealed sectors err = n.MinerApi.StorageAddLocal(ctx, presealDir) if err != nil { return nil, err } // set the miner PeerID minerIDEncoded, err := actors.SerializeParams(&saminer.ChangePeerIDParams{NewID: abi.PeerID(minerID)}) if err != nil { return nil, err } changeMinerID := &types.Message{ To: minerAddr, From: genMiner.Worker, Method: builtin.MethodsMiner.ChangePeerID, Params: minerIDEncoded, Value: types.NewInt(0), } _, err = n.FullApi.MpoolPushMessage(ctx, changeMinerID, nil) if err != nil { return nil, err } t.RecordMessage("publish our address to the miners addr topic") minerActor, err := n.MinerApi.ActorAddress(ctx) if err != nil { return nil, err } minerNetAddrs, err := n.MinerApi.NetAddrsListen(ctx) if err != nil { return nil, err } t.SyncClient.MustPublish(ctx, MinersAddrsTopic, MinerAddressesMsg{ FullNetAddrs: fullNodeNetAddrs, MinerNetAddrs: minerNetAddrs, MinerActorAddr: minerActor, WalletAddr: walletKey.Address, }) t.RecordMessage("connecting to all other miners") // densely connect the miner's full nodes. minerCh := make(chan *MinerAddressesMsg, 16) sctx, cancel := context.WithCancel(ctx) defer cancel() t.SyncClient.MustSubscribe(sctx, MinersAddrsTopic, minerCh) var fullNetAddrs []peer.AddrInfo for i := 0; i < t.IntParam("miners"); i++ { m := <-minerCh if m.MinerActorAddr == minerActor { // once I find myself, I stop connecting to others, to avoid a simopen problem. break } err := n.FullApi.NetConnect(ctx, m.FullNetAddrs) if err != nil { return nil, fmt.Errorf("failed to connect to miner %s on: %v", m.MinerActorAddr, m.FullNetAddrs) } t.RecordMessage("connected to full node of miner %s on %v", m.MinerActorAddr, m.FullNetAddrs) fullNetAddrs = append(fullNetAddrs, m.FullNetAddrs) } t.RecordMessage("waiting for all nodes to be ready") t.SyncClient.MustSignalAndWait(ctx, StateReady, t.TestInstanceCount) fullSrv, err := startFullNodeAPIServer(t, nodeRepo, n.FullApi) if err != nil { return nil, err } minerSrv, err := startStorageMinerAPIServer(t, minerRepo, n.MinerApi) if err != nil { return nil, err } n.StopFn = func(ctx context.Context) error { var err *multierror.Error err = multierror.Append(fullSrv.Shutdown(ctx)) err = multierror.Append(minerSrv.Shutdown(ctx)) err = multierror.Append(stop2(ctx)) err = multierror.Append(stop2(ctx)) err = multierror.Append(stop1(ctx)) return err.ErrorOrNil() } m := &LotusMiner{n, minerRepo, nodeRepo, fullNetAddrs, genesisMsg, subsystems, t} return m, nil } func RestoreMiner(t *TestEnvironment, m *LotusMiner) (*LotusMiner, error) { ctx, cancel := context.WithTimeout(context.Background(), PrepareNodeTimeout) defer cancel() minerRepo := m.MinerRepo nodeRepo := m.NodeRepo fullNetAddrs := m.FullNetAddrs genesisMsg := m.GenesisMsg minerIP := t.NetClient.MustGetDataNetworkIP().String() drandOpt, err := GetRandomBeaconOpts(ctx, t) if err != nil { return nil, err } // create the node // we need both a full node _and_ and storage miner node n := &LotusNode{} stop1, err := node.New(context.Background(), node.FullAPI(&n.FullApi), node.Base(), node.Repo(nodeRepo), //withGenesis(genesisMsg.Genesis), withApiEndpoint(fmt.Sprintf("/ip4/0.0.0.0/tcp/%s", t.PortNumber("node_rpc", "0"))), withListenAddress(minerIP), withBootstrapper(genesisMsg.Bootstrapper), //withPubsubConfig(false, pubsubTracer), drandOpt, ) if err != nil { return nil, err } minerOpts := []node.Option{ node.StorageMiner(&n.MinerApi, m.Subsystems), node.Base(), node.Repo(minerRepo), node.Override(new(api.FullNode), n.FullApi), withApiEndpoint(fmt.Sprintf("/ip4/0.0.0.0/tcp/%s", t.PortNumber("miner_rpc", "0"))), withMinerListenAddress(minerIP), } stop2, err := node.New(context.Background(), minerOpts...) if err != nil { stop1(context.TODO()) return nil, err } fullSrv, err := startFullNodeAPIServer(t, nodeRepo, n.FullApi) if err != nil { return nil, err } minerSrv, err := startStorageMinerAPIServer(t, minerRepo, n.MinerApi) if err != nil { return nil, err } n.StopFn = func(ctx context.Context) error { var err *multierror.Error err = multierror.Append(fullSrv.Shutdown(ctx)) err = multierror.Append(minerSrv.Shutdown(ctx)) err = multierror.Append(stop2(ctx)) err = multierror.Append(stop2(ctx)) err = multierror.Append(stop1(ctx)) return err.ErrorOrNil() } for i := 0; i < len(fullNetAddrs); i++ { err := n.FullApi.NetConnect(ctx, fullNetAddrs[i]) if err != nil { // we expect a failure since we also shutdown another miner t.RecordMessage("failed to connect to miner %d on: %v", i, fullNetAddrs[i]) continue } t.RecordMessage("connected to full node of miner %d on %v", i, fullNetAddrs[i]) } pm := &LotusMiner{n, minerRepo, nodeRepo, fullNetAddrs, genesisMsg, m.Subsystems, t} return pm, err } func (m *LotusMiner) RunDefault() error { var ( t = m.t clients = t.IntParam("clients") miners = t.IntParam("miners") ) t.RecordMessage("running miner") t.RecordMessage("block delay: %v", build.BlockDelaySecs) t.D().Gauge("miner.block-delay").Update(float64(build.BlockDelaySecs)) ctx := context.Background() myActorAddr, err := m.MinerApi.ActorAddress(ctx) if err != nil { return err } // mine / stop mining mine := true done := make(chan struct{}) if m.MineOne != nil { go func() { defer t.RecordMessage("shutting down mining") defer close(done) var i int for i = 0; mine; i++ { // synchronize all miners to mine the next block t.RecordMessage("synchronizing all miners to mine next block [%d]", i) stateMineNext := sync.State(fmt.Sprintf("mine-block-%d", i)) t.SyncClient.MustSignalAndWait(ctx, stateMineNext, miners) ch := make(chan error) const maxRetries = 100 success := false for retries := 0; retries < maxRetries; retries++ { f := func(mined bool, epoch abi.ChainEpoch, err error) { if mined { t.D().Counter(fmt.Sprintf("block.mine,miner=%s", myActorAddr)).Inc(1) } ch <- err } req := miner.MineReq{ Done: f, } err := m.MineOne(ctx, req) if err != nil { panic(err) } miningErr := <-ch if miningErr == nil { success = true break } t.D().Counter("block.mine.err").Inc(1) t.RecordMessage("retrying block [%d] after %d attempts due to mining error: %s", i, retries, miningErr) } if !success { panic(fmt.Errorf("failed to mine block %d after %d retries", i, maxRetries)) } } // signal the last block to make sure no miners are left stuck waiting for the next block signal // while the others have stopped stateMineLast := sync.State(fmt.Sprintf("mine-block-%d", i)) t.SyncClient.MustSignalEntry(ctx, stateMineLast) }() } else { close(done) } // wait for a signal from all clients to stop mining err = <-t.SyncClient.MustBarrier(ctx, StateStopMining, clients).C if err != nil { return err } mine = false <-done t.SyncClient.MustSignalAndWait(ctx, StateDone, t.TestInstanceCount) return nil } func startStorageMinerAPIServer(t *TestEnvironment, repo repo.Repo, minerApi api.StorageMiner) (*http.Server, error) { mux := mux.NewRouter() rpcServer := jsonrpc.NewServer() rpcServer.Register("Filecoin", minerApi) mux.Handle("/rpc/v0", rpcServer) mux.PathPrefix("/remote").HandlerFunc(minerApi.(*impl.StorageMinerAPI).ServeRemote(true)) mux.PathPrefix("/").Handler(http.DefaultServeMux) // pprof exporter, err := prometheus.NewExporter(prometheus.Options{ Namespace: "lotus", }) if err != nil { return nil, err } mux.Handle("/debug/metrics", exporter) ah := &auth.Handler{ Verify: func(ctx context.Context, token string) ([]auth.Permission, error) { return api.AllPermissions, nil }, Next: mux.ServeHTTP, } endpoint, err := repo.APIEndpoint() if err != nil { return nil, fmt.Errorf("no API endpoint in repo: %w", err) } srv := &http.Server{Handler: ah} listenAddr, err := startServer(endpoint, srv) if err != nil { return nil, fmt.Errorf("failed to start storage miner API endpoint: %w", err) } t.RecordMessage("started storage miner API server at %s", listenAddr) return srv, nil }