fix(eth): apply limit in EthGetBlockReceiptsLimited

[ameeetgaikwad]

Related Issues

#12838

Proposed Changes

Additional Info

Checklist

Before you mark the PR ready for review, please make sure that:

• Commits have a clear commit message.
• PR title conforms with contribution conventions
• Update CHANGELOG.md or signal that this change does not need it per contribution conventions
• New features have usage guidelines and / or documentation updates in
  • Lotus Documentation
  • Discussion Tutorials
• Tests exist for new functionality or change in behavior
• CI is green

PR title now matches the required format.

[rjan90]

OK, that was a bit excessive from the PR title GH-actions workflow, I'll investigate how to make it less spammy and improve its behavior.

outdated

[BigLep]

@ameeetgaikwad : I don't know the codebase to be able to speak to the feasibility, but did you look at adding a unit test?

[rvagg]

@ameeetgaikwad check out the lint error from CI, your editor should be able to pick this one up too if you have it configured correctly.

lotus/gateway/node.go

Line 272 in b1376cf

errLookback: fmt.Errorf("lookbacks of more than %s are disallowed", options.maxLookbackDuration),

This is the error we're kind of aiming to replicate, but it's a slightly different since we're not doing this directly in the gateway. Also, let's use the epoch (ts.Height()) number rather than tipset key because this is an Ethereum API where tipsets make less sense, so the error can tell them that the number is too far back. Let's make it:

"the requested block number %d is older than the allowed limit of %d and cannot be retrieved"

[rvagg]

Regarding testing, you should be able to piggy-back an existing itest to run this. Try this:

diff --git a/itests/fevm_test.go b/itests/fevm_test.go
index 7bbab0c64..babae9eb4 100644
--- a/itests/fevm_test.go
+++ b/itests/fevm_test.go
@@ -1185,6 +1185,17 @@ func TestEthGetBlockReceipts(t *testing.T) {
        gethBlockReceipts, err := client.EthGetBlockReceipts(ctx, req)
        require.NoError(t, err)
        require.Len(t, gethBlockReceipts, 3)
+
+       t.Run("EthGetBlockReceiptsLimited", func(t *testing.T) {
+               // just to be sure we're far enough in the chain for the limit to work
+               client.WaitTillChain(ctx, kit.HeightAtLeast(10))
+               // request epoch 2
+               bn := ethtypes.EthUint64(5)
+               // limit to 5 epochs lookback
+               blockReceipts, err := client.EthGetBlockReceiptsLimited(ctx, ethtypes.EthBlockNumberOrHash{BlockNumber: &bn}, 5)
+               require.ErrorContains(t, err, "older than the allowed")
+               require.Nil(t, blockReceipts, "should not return any receipts")
+       })
 }
 
 func deployContractWithEth(ctx context.Context, t *testing.T, client *kit.TestFullNode, ethAddr ethtypes.EthAddress,

Then you can run it with go test ./itests/fevm_test.go -v -run TestEthGetBlockReceipts to see it work 🤞

[ameeetgaikwad]

@ameeetgaikwad : I don't know the codebase to be able to speak to the feasibility, but did you look at adding a unit test?

yes i tried adding tests for EthGetBlockReceiptsLimited  function. But when I run the tests, it gives this error: EthGetBlockReceiptsLimited is not in the openrpc spec ⁠

[ameeetgaikwad]

@ameeetgaikwad check out the lint error from CI, your editor should be able to pick this one up too if you have it configured correctly.

lotus/gateway/node.go

Line 272 in b1376cf

errLookback: fmt.Errorf("lookbacks of more than %s are disallowed", options.maxLookbackDuration),

This is the error we're kind of aiming to replicate, but it's a slightly different since we're not doing this directly in the gateway. Also, let's use the epoch (ts.Height()) number rather than tipset key because this is an Ethereum API where tipsets make less sense, so the error can tell them that the number is too far back. Let's make it:

"the requested block number %d is older than the allowed limit of %d and cannot be retrieved"

ok ser! will look into this

PR title now matches the required format.