api: Note that ChainGetBlockMessages is not the method to use most of the time
This commit is contained in:
parent
e74aa7ef09
commit
82e019bd36
@ -67,6 +67,17 @@ type FullNode interface {
|
|||||||
ChainGetTipSet(context.Context, types.TipSetKey) (*types.TipSet, error)
|
ChainGetTipSet(context.Context, types.TipSetKey) (*types.TipSet, error)
|
||||||
|
|
||||||
// ChainGetBlockMessages returns messages stored in the specified block.
|
// ChainGetBlockMessages returns messages stored in the specified block.
|
||||||
|
//
|
||||||
|
// Note: If there are multiple blocks in a tipset, it's likely that some
|
||||||
|
// messages will be duplicated. It's also possible for blocks in a tipset to have
|
||||||
|
// different messages from the same sender at the same nonce. When that happens,
|
||||||
|
// only the first message (in a block with lowest ticket) will be considered
|
||||||
|
// for execution
|
||||||
|
//
|
||||||
|
// NOTE: THIS METHOD SHOULD ONLY BE USED FOR GETTING MESSAGES IN A SPECIFIC BLOCK
|
||||||
|
//
|
||||||
|
// DO NOT USE THIS METHOD TO GET MESSAGES INCLUDED IN A TIPSET
|
||||||
|
// Use ChainGetParentMessages, which will perform correct message deduplication
|
||||||
ChainGetBlockMessages(ctx context.Context, blockCid cid.Cid) (*BlockMessages, error)
|
ChainGetBlockMessages(ctx context.Context, blockCid cid.Cid) (*BlockMessages, error)
|
||||||
|
|
||||||
// ChainGetParentReceipts returns receipts for messages in parent tipset of
|
// ChainGetParentReceipts returns receipts for messages in parent tipset of
|
||||||
|
@ -425,6 +425,17 @@ Response:
|
|||||||
### ChainGetBlockMessages
|
### ChainGetBlockMessages
|
||||||
ChainGetBlockMessages returns messages stored in the specified block.
|
ChainGetBlockMessages returns messages stored in the specified block.
|
||||||
|
|
||||||
|
Note: If there are multiple blocks in a tipset, it's likely that some
|
||||||
|
messages will be duplicated. It's also possible for blocks in a tipset to have
|
||||||
|
different messages from the same sender at the same nonce. When that happens,
|
||||||
|
only the first message (in a block with lowest ticket) will be considered
|
||||||
|
for execution
|
||||||
|
|
||||||
|
NOTE: THIS METHOD SHOULD ONLY BE USED FOR GETTING MESSAGES IN A SPECIFIC BLOCK
|
||||||
|
|
||||||
|
DO NOT USE THIS METHOD TO GET MESSAGES INCLUDED IN A TIPSET
|
||||||
|
Use ChainGetParentMessages, which will perform correct message deduplication
|
||||||
|
|
||||||
|
|
||||||
Perms: read
|
Perms: read
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user