lotus/node/impl/client/import.go

package client

import (
	"bufio"
	"context"
	"io"
	"os"

	"github.com/filecoin-project/lotus/build"
	"github.com/ipfs/go-blockservice"
	"github.com/ipfs/go-cid"
	"github.com/ipfs/go-cidutil"
	chunker "github.com/ipfs/go-ipfs-chunker"
	offline "github.com/ipfs/go-ipfs-exchange-offline"
	files2 "github.com/ipfs/go-ipfs-files"
	ipld "github.com/ipfs/go-ipld-format"
	"github.com/ipfs/go-merkledag"
	"github.com/ipfs/go-unixfs/importer/balanced"
	ihelper "github.com/ipfs/go-unixfs/importer/helpers"
	"github.com/ipld/go-car"
	carv2 "github.com/ipld/go-car/v2"
	"github.com/ipld/go-car/v2/blockstore"
	"golang.org/x/xerrors"
)

// importNormalFileToCARv2 transforms the client's "normal file" to a Unixfs IPLD DAG and writes out the DAG to a CARv2 file at the given output path.
func (a *API) importNormalFileToCARv2(ctx context.Context, importID uint64, inputFilePath string, outputCARv2Path string) (c cid.Cid, finalErr error) {

	// TODO: We've currently put in a hack to create the Unixfs DAG as a CARv2 without using Badger.
	// We first transform the Unixfs DAG to a rootless CARv2 file as CARv2 doesen't allow streaming writes without specifying the root upfront and we
	// don't have the root till the Unixfs DAG is created.
	//
	// In the second pass, we create a CARv2 file with the root present using the root node we get in the above step.
	// This hack should be fixed when CARv2 allows specifying the root AFTER finishing the CARv2 streaming write.
	tmpCARv2Path, err := a.imgr().NewTempFile(importID)
	if err != nil {
		return cid.Undef, xerrors.Errorf("failed to create temp CARv2 file: %w", err)
	}
	defer os.Remove(tmpCARv2Path) //nolint:errcheck

	tempCARv2Store, err := blockstore.NewReadWrite(tmpCARv2Path, []cid.Cid{})
	if err != nil {
		return cid.Undef, xerrors.Errorf("failed to create rootless temp CARv2 rw store: %w", err)
	}
	defer tempCARv2Store.Finalize() //nolint:errcheck
	bsvc := blockservice.New(tempCARv2Store, offline.Exchange(tempCARv2Store))

	// ---- First Pass ---  Write out the UnixFS DAG to a rootless CARv2 file by instantiating a read-write CARv2 blockstore without the root.
	root, err := importNormalFileToUnixfsDAG(ctx, inputFilePath, merkledag.NewDAGService(bsvc))
	if err != nil {
		return cid.Undef, xerrors.Errorf("failed to import file to store: %w", err)
	}

	//------ Second Pass --- Now that we have the root of the Unixfs DAG -> write out the Unixfs DAG to a CARv2 file with the root present by using a read-write CARv2 blockstore.
	rw, err := blockstore.NewReadWrite(outputCARv2Path, []cid.Cid{root})
	if err != nil {
		return cid.Undef, xerrors.Errorf("failed to create a CARv2 read-write blockstore: %w", err)
	}
	defer rw.Finalize() //nolint:errcheck

	bsvc = blockservice.New(rw, offline.Exchange(rw))
	root2, err := importNormalFileToUnixfsDAG(ctx, inputFilePath, merkledag.NewDAGService(bsvc))
	if err != nil {
		return cid.Undef, xerrors.Errorf("failed to create Unixfs DAG with CARv2 blockstore: %w", err)
	}

	if root != root2 {
		return cid.Undef, xerrors.New("roots do not match")
	}

	return root, nil
}

// importNormalFileToUnixfsDAG transforms a client's normal file to a UnixfsDAG and imports the DAG to the given DAG service.
func importNormalFileToUnixfsDAG(ctx context.Context, inputFilePath string, dag ipld.DAGService) (cid.Cid, error) {
	f, err := os.Open(inputFilePath)
	if err != nil {
		return cid.Undef, xerrors.Errorf("failed to open input file: %w", err)
	}
	defer f.Close() //nolint:errcheck

	stat, err := f.Stat()
	if err != nil {
		return cid.Undef, xerrors.Errorf("failed to stat file :%w", err)
	}

	file, err := files2.NewReaderPathFile(inputFilePath, f, stat)
	if err != nil {
		return cid.Undef, xerrors.Errorf("failed to create reader path file: %w", err)
	}

	bufDs := ipld.NewBufferedDAG(ctx, dag)

	prefix, err := merkledag.PrefixForCidVersion(1)
	if err != nil {
		return cid.Undef, err
	}
	prefix.MhType = DefaultHashFunction

	params := ihelper.DagBuilderParams{
		Maxlinks:  build.UnixfsLinksPerLevel,
		RawLeaves: true,
		CidBuilder: cidutil.InlineBuilder{
			Builder: prefix,
			Limit:   126,
		},
		Dagserv: bufDs,
		NoCopy:  true,
	}

	db, err := params.New(chunker.NewSizeSplitter(file, int64(build.UnixfsChunkSize)))
	if err != nil {
		return cid.Undef, err
	}
	nd, err := balanced.Layout(db)
	if err != nil {
		return cid.Undef, err
	}

	if err := bufDs.Commit(); err != nil {
		return cid.Undef, err
	}

	return nd.Cid(), nil
}

// transformCarToCARv2 transforms a client's CAR file to a CARv2 file.
func transformCarToCARv2(inputCARPath string, outputCARv2Path string) (root cid.Cid, err error) {
	inputF, err := os.Open(inputCARPath)
	if err != nil {
		return cid.Undef, xerrors.Errorf("failed to open input CAR: %w", err)
	}
	defer inputF.Close() //nolint:errcheck

	// read the CAR header to determine the DAG root and the CAR version.
	hd, _, err := car.ReadHeader(bufio.NewReader(inputF))
	if err != nil {
		return cid.Undef, xerrors.Errorf("failed to read CAR header: %w", err)
	}
	if len(hd.Roots) != 1 {
		return cid.Undef, xerrors.New("cannot import CAR with more than one root")
	}

	switch hd.Version {
	case 2:

		// This is a CARv2, we can import it as it is by simply copying it.
		outF, err := os.Open(outputCARv2Path)
		if err != nil {
			return cid.Undef, xerrors.Errorf("failed to open output CARv2 file: %w", err)
		}
		defer outF.Close() //nolint:errcheck
		_, err = io.Copy(outF, inputF)
		if err != nil {
			return cid.Undef, xerrors.Errorf("failed to copy CARv2 file: %w", err)
		}
	case 1:

		// This is a CARv1, let's transform it to a CARv2.
		if err := carv2.WrapV1File(inputCARPath, outputCARv2Path); err != nil {
			return cid.Undef, xerrors.Errorf("failed to transform CARv1 to CARv2: %w", err)
		}

	default:
		return cid.Undef, xerrors.Errorf("unrecognized CAR version %d", hd.Version)
	}

	return hd.Roots[0], nil
}