lotus/chain/deals/types.go

package deals

import (
	"github.com/ipfs/go-cid"
	cbor "github.com/ipfs/go-ipld-cbor"

	"github.com/filecoin-project/go-lotus/chain/actors"
	"github.com/filecoin-project/go-lotus/chain/address"
	"github.com/filecoin-project/go-lotus/chain/types"
)

func init() {
	cbor.RegisterCborType(PaymentInfo{})
	cbor.RegisterCborType(StorageDealProposal{})
	cbor.RegisterCborType(SignedStorageDealProposal{})

	cbor.RegisterCborType(PieceInclusionProof{})

	cbor.RegisterCborType(StorageDealResponse{})
	cbor.RegisterCborType(SignedStorageDealResponse{})
}

type SerializationMode string

const (
	SerializationUnixFs = "UnixFs"
	SerializationRaw    = "Raw"
	SerializationIPLD   = "IPLD"
)

type DealState int

const (
	Unknown = iota
	Rejected
	Accepted
	Started
	Failed
	Staged
	Sealing
	Complete
)

// TODO: this should probably be in a separate package with other paych utils
type PaymentInfo struct {
	PayChActor     address.Address
	Payer          address.Address
	Channel        uint64 // TODO: Not clear what that refers to, guessing something to do with multi-lane payments
	ChannelMessage cid.Cid

	Vouchers []actors.SignedVoucher
}

type StorageDealProposal struct {
	PieceRef          string // TODO: string per spec, but maybe should be a CID?
	SerializationMode SerializationMode
	CommP             []byte

	Size       uint64 // TODO: spec doesn't clearly specify the type
	TotalPrice types.BigInt
	Duration   uint64

	Payment PaymentInfo

	MinerAddress  address.Address
	ClientAddress address.Address
}

type SignedStorageDealProposal struct {
	Proposal StorageDealProposal

	Signature *types.Signature
}

// response
type PieceInclusionProof struct {
	Position      uint // todo: type?
	ProofElements [32]byte
}

// TODO: Spec says 'representation keyed', this is probably wrong
type StorageDealResponse struct {
	State DealState

	// Rejected / Accepted / Failed / Staged
	Message  string
	Proposal cid.Cid

	// Sealing
	PieceInclusionProof PieceInclusionProof

	// Complete
	SectorCommitMessage cid.Cid
}

type SignedStorageDealResponse struct {
	Response StorageDealResponse

	Signature *types.Signature
}