internal/ethapi: add comment explaining return of nil instead of error (ethereum#25097)

kosuke-taniguchi · fjl · blakehhuynh · commit 52281e0f8041 · 2022-10-07T09:59:46.000-07:00
Co-authored-by: Felix Lange &lt;fjl@twurst.com&gt;
diff --git a/internal/ethapi/api.go b/internal/ethapi/api.go
@@ -1581,6 +1581,8 @@ func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context,
 func (s *PublicTransactionPoolAPI) GetTransactionReceipt(ctx context.Context, hash common.Hash) (map[string]interface{}, error) {
 	tx, blockHash, blockNumber, index, err := s.b.GetTransaction(ctx, hash)
 	if err != nil {
+		// When the transaction doesn't exist, the RPC method should return JSON null
+		// as per specification.
 		return nil, nil
 	}
 	receipts, err := s.b.GetReceipts(ctx, blockHash)

Original file line number	Diff line number	Diff line change
`@@ -1581,6 +1581,8 @@ func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context,`
`1581`	`1581`	`func (s *PublicTransactionPoolAPI) GetTransactionReceipt(ctx context.Context, hash common.Hash) (map[string]interface{}, error) {`
`1582`	`1582`	`tx, blockHash, blockNumber, index, err := s.b.GetTransaction(ctx, hash)`
`1583`	`1583`	`if err != nil {`
	`1584`	`+ // When the transaction doesn't exist, the RPC method should return JSON null`
	`1585`	`+ // as per specification.`
`1584`	`1586`	`return nil, nil`
`1585`	`1587`	`}`
`1586`	`1588`	`receipts, err := s.b.GetReceipts(ctx, blockHash)`