commp

README

go-commp-utils

Utilities for generating and working with CommP for Filecoin pieces

License

Dual-licensed under MIT + Apache 2.0

Documentation

Index

• func GeneratePieceCIDFromFile(proofType abi.RegisteredSealProof, piece io.Reader, ...) (cid.Cid, error)
• func PieceAggregateCommP(proofType abi.RegisteredSealProof, pieceInfos []abi.PieceInfo) (cid.Cid, abi.PaddedPieceSize, error)
• func ZeroPadPieceCommitment(c cid.Cid, curSize abi.UnpaddedPieceSize, toSize abi.UnpaddedPieceSize) (cid.Cid, error)

Functions

func GeneratePieceCIDFromFile

func GeneratePieceCIDFromFile(proofType abi.RegisteredSealProof, piece io.Reader, pieceSize abi.UnpaddedPieceSize) (cid.Cid, error)

GeneratePieceCIDFromFile generates an a piece cid from an io.Reader

func PieceAggregateCommP

func PieceAggregateCommP(proofType abi.RegisteredSealProof, pieceInfos []abi.PieceInfo) (cid.Cid, abi.PaddedPieceSize, error)

PieceAggregateCommP generates an aggregate CommP for a list of pieces that combine in size up to the sector size determined by the proofType parameter.

This function makes no assumptions, other than maximum size, about the pieces that you include. To create a correctly formed UnsealedCID (CommD) for a sector using this method, you should first ensure that the pieces add up to the required size.

func ZeroPadPieceCommitment

func ZeroPadPieceCommitment(c cid.Cid, curSize abi.UnpaddedPieceSize, toSize abi.UnpaddedPieceSize) (cid.Cid, error)