Openocean #1610
Open
Openocean #1610
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added validation for apiOptions in postOrder method to prevent API calls that would definitely fail. The validation includes: - Required fields checking - Protocol value validation - Side value validation - Protocol address format validation Resolves TODO comment in api.ts
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The
postOrdermethod in the OpenSea SDK lacked proper input validation, which could lead to unnecessary API calls with invalid parameters. This was marked with a TODO comment in the code:// TODO: Validate apiOptions. Avoid API calls that will definitely fail
By implementing proper validation, we can:
Solution
I've added comprehensive validation for the
apiOptionsparameter in thepostOrdermethod. The validation includes:sideprotocolAddressorderThe changes are accompanied by a comprehensive test suite in
test/api/postOrder.validation.spec.tsthat verifies all validation cases.Each validation failure provides a clear, descriptive error message to help developers quickly identify and fix issues in their code.