enhance comment about lookup cid semantics

This commit is contained in:
vyzo 2023-03-13 12:14:30 +02:00 committed by Maciej Witowski
parent 47c810942d
commit e718857b2f

View File

@ -25,6 +25,8 @@ type MsgInfo struct {
// MsgIndex is the interface to the message index // MsgIndex is the interface to the message index
type MsgIndex interface { type MsgIndex interface {
// GetMsgInfo retrieves the message metadata through the index. // GetMsgInfo retrieves the message metadata through the index.
// The lookup is done using the onchain message Cid; that is the signed message Cid
// for SECP messages and unsigned message Cid for BLS messages.
GetMsgInfo(ctx context.Context, m cid.Cid) (MsgInfo, error) GetMsgInfo(ctx context.Context, m cid.Cid) (MsgInfo, error)
// Close closes the index // Close closes the index
Close() error Close() error