[Feature Request]: standard error codes

[tuxcanfly]

Implementation ideas

Implementations should return standard error codes so that clients have a way to handle the error and retry if possible.

We can reuse JSONRPC error codes in the range --32000 to -32099 , clients should map their errors into the standard error codes for e.g.:

• 32001 - request timeout
• 32002 - mempool congested
• 32003 - insufficient fee
• 32004 - incorrect sequence / nonce
• 32005 - blob size too large

gRPC can reuse the JSONRPC error codes for simplicity.

Based on the error, the client can retry with a higher fee, different nonce or smaller blob.

Implementations should wrap their error with the corresponding typed error.

E.g.:

pkg someda

...
var (
	// Err32003 is returned when the blob transaction has insufficient fee
	Err32003 = errors.New("32003")
)
...


// Submit submits the Blobs to Data Availability layer.
func (c *SomeDA) Submit(ctx context.Context, blobs []da.Blob, gasPrice float64, ns da.Namespace) ([]da.ID, error) {
        ...
	height, err := c.Submit(ctx, blobs, gasPrice, ns)
	if err != nil {
		if errors.Is(err, ErrInsufficientFee) {
			return errors.Wrap(da.Err32003, err)
		}
		return nil, err
	}
        ...
}

[gupadhyaya]

@tuxcanfly when do we expect this error? 32002 - mempool congested?

[tuxcanfly]

@tuxcanfly when do we expect this error? 32002 - mempool congested?

When blob transactions are failing to be included in blocks due to mempool being full. It would signify two things:

• this is a temporary error
• it may be retried with a higher fee or higher priority fee when fee market is implemented

[gupadhyaya]

@tuxcanfly when do we expect this error? 32002 - mempool congested?

When blob transactions are failing to be included in blocks due to mempool being full. It would signify two things:

• this is a temporary error
• it may be retried with a higher fee or higher priority fee when fee market is implemented

is this different from 32001 - request timeout?

[tuxcanfly]

is this different from 32001 - request timeout?

Yes, it indicates a generic connection error and maybe retried without modifying the transaction.

[ramin]

@tuxcanfly I like this. What are your thoughts on introducing some kind of error for this use case (ie: blob not found) celestiaorg/celestia-node#3292 (there's a lot of context in that thread, sorry)

[Manav-Aggarwal]

celestiaorg/celestia-node#3529

[github-actions]

🎉 This issue has been resolved in version 0.9.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀