feat: adapt check exchange policy for bundle offers #999
Conversation
This file contains hidden or 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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the exchange policy validation flow to support Bundle offers by allowing multiple Yup schema templates (selected by metadata.type) and adds core-sdk tests/fixtures to cover bundle validation.
Changes:
- Extend exchange policy rules format to support
metadataTypeand additional schemas viayupSchemas(e.g.BUNDLE,ITEM_PRODUCT_V1). - Update core-sdk
checkExchangePolicyto select the appropriate schema based on offer metadata type and to validate bundle items. - Update react-kit defaults/storybook config to use the new rules template IPFS hash and adjust rules-template placeholder replacement for multiple schemas.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/react-kit/src/stories/widgets/Commit.stories.tsx | Updates Storybook stories to use the new exchange policy rules IPFS hash. |
| packages/react-kit/src/hooks/useCheckExchangePolicy.ts | Applies placeholder replacements across the base schema and additional yupSchemas (but includes leftover debug/commented code). |
| packages/react-kit/src/components/boson/BosonProvider.tsx | Updates the default fairExchangePolicyRules IPFS hash. |
| packages/core-sdk/tests/exchangePolicy/exchangePolicyRules.testing.json | Adds metadataType + additional schemas for bundle/item validation and updates an error message. |
| packages/core-sdk/tests/exchangePolicy/examples/validBundle.json | Adds a valid bundle fixture for tests. |
| packages/core-sdk/tests/exchangePolicy/examples/invalidBundle.json | Adds an invalid bundle fixture for tests. |
| packages/core-sdk/tests/check-exchange-policy.test.ts | Adds bundle validation test cases and updates expected error messaging. |
| packages/core-sdk/src/offers/checkExchangePolicy.ts | Implements schema selection by metadata type + bundle item validation logic. |
| data/ipfs.txt | Records the new IPFS hash for traceability. |
| data/exchangePolicies/exchangePolicyRules.template.json | Updates the IPFS template to include bundle/item schemas and metadataType. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| disputeResolverId_matches; | ||
| } | ||
| // replace TOKENS_LIST (environment dependent) | ||
| const tokensList = defaultTokens.map((token) => token.address); |
There was a problem hiding this comment.
tokensList is computed here but never used. Either remove it, or reuse this precomputed list in the <TOKENS_LIST> replacement inside the loop to avoid recalculating.
Suggested change
| const tokensList = defaultTokens.map((token) => token.address); |
Comment on lines
36
to
54
| // // replace DEFAULT_DISPUTE_RESOLVER_ID (environment dependent) | ||
| // const disputeResolverId_matches = | ||
| // rulesTemplate?.yupSchema?.properties?.disputeResolverId?.matches?.replace( | ||
| // "<DEFAULT_DISPUTE_RESOLVER_ID>", | ||
| // defaultDisputeResolverId | ||
| // ); | ||
| // if (disputeResolverId_matches) { | ||
| // rulesTemplate.yupSchema.properties.disputeResolverId.matches = | ||
| // disputeResolverId_matches; | ||
| // } | ||
| // // replace TOKENS_LIST (environment dependent) | ||
| // const tokensList_pattern = | ||
| // rulesTemplate?.yupSchema?.properties?.exchangeToken?.properties?.address?.pattern?.replace( | ||
| // "<TOKENS_LIST>", | ||
| // tokensList.join("|") | ||
| // ); | ||
| // if ( | ||
| // rulesTemplate.yupSchema.properties.exchangeToken.properties && | ||
| // tokensList_pattern |
There was a problem hiding this comment.
Please remove the commented-out legacy replacement code that starts here (and continues below). Leaving large commented blocks in production hooks makes the current behavior harder to reason about and maintain.
Suggested change
| // // replace DEFAULT_DISPUTE_RESOLVER_ID (environment dependent) | |
| // const disputeResolverId_matches = | |
| // rulesTemplate?.yupSchema?.properties?.disputeResolverId?.matches?.replace( | |
| // "<DEFAULT_DISPUTE_RESOLVER_ID>", | |
| // defaultDisputeResolverId | |
| // ); | |
| // if (disputeResolverId_matches) { | |
| // rulesTemplate.yupSchema.properties.disputeResolverId.matches = | |
| // disputeResolverId_matches; | |
| // } | |
| // // replace TOKENS_LIST (environment dependent) | |
| // const tokensList_pattern = | |
| // rulesTemplate?.yupSchema?.properties?.exchangeToken?.properties?.address?.pattern?.replace( | |
| // "<TOKENS_LIST>", | |
| // tokensList.join("|") | |
| // ); | |
| // if ( | |
| // rulesTemplate.yupSchema.properties.exchangeToken.properties && | |
| // tokensList_pattern |
| } | ||
| } | ||
| } | ||
| console.log("rulesTemplate", rulesTemplate); |
There was a problem hiding this comment.
Remove this console.log. Logging the full rules template in a hook will spam production logs and can expose internal configuration details.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
…com/bosonprotocol/core-components into 998-check-exchangepolicy-for-bundle
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
fixes #998
How to test
Storybook
http://localhost:6006/?path=/story/widgets-commit--commit-bundle&args=configId:testing-80002-0;bundleUuid:d0d3fb4-34cd-0e78-a3a8-adeb2a434f;sellerId:2