Update partner-fee.md #589
Conversation
Updating Partner Fee as requested, please let me know if there is anything else that needs to be changed :)
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
I have read the CLA Document and I hereby sign the CLA You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot. |
📝 WalkthroughWalkthroughThe pull request updates partner fee documentation to reference CIP-75 instead of CIP-61, reduces the default service fee from 50% to 25%, and expands Partner Fee applicability to include both Widget and API integrations in addition to clarifying related payment processes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/governance/fees/partner-fee.md`:
- Around line 72-74: Update the wording so all three bullets consistently state
that both Widget and API integrations are included: change the second bullet's
"Widget integration" to "Widget or API integration" and the third bullet's
"Widget" to "Widget or API integration" (references: "Partner Fee parameters",
"appData", and the Partner Fee 'Recipient' parameter) so the data script and
weekly transfer clearly apply to trades via either integration.
🧹 Nitpick comments (1)
docs/governance/fees/partner-fee.md (1)
20-20: Clarify if the 100 BPS limit applies to API integrations.Since the Partner Fee scope has been expanded to include API integrations (lines 22, 72), consider clarifying whether the 100 BPS limit also applies to API integrations or if it remains Widget-specific.
📝 Suggested update if the limit applies to both Widget and API
-You may charge users a fee of no more than 100 bps of order volume through your Widget. +You may charge users a fee of no more than 100 bps of order volume through your Widget or API integration.
| 1. Upon completing the implementation of the Partner Fee parameters, you will be eligible to receive the Partner Fee on trades executed by your users through the Widget or API integration. | ||
| 2. A data script will be run on a weekly basis on your project's eligible Partner Fee amount calculated based on the sum of all transactions traded through your project's Widget integration associated with Partner Fee defined in the [`appData`](/cow-protocol/reference/core/intents/app-data) your AppKey. | ||
| 3. The Net Partner Fee (refer to the [Partner Fee Calculation](#partner-fee-calculation) section for details on calculations) will be transferred to your designated Ethereum wallet address defined under the Partner Fee "Recipient" parameter of the Widget on a weekly basis. |
There was a problem hiding this comment.
Inconsistent scope in the payment process description.
Line 72 correctly mentions "Widget or API integration," but lines 73-74 reference only "Widget integration." This inconsistency may confuse users about whether API integration trades are included in the data script and payment calculations.
📝 Proposed fix to ensure consistency
1. Upon completing the implementation of the Partner Fee parameters, you will be eligible to receive the Partner Fee on trades executed by your users through the Widget or API integration.
-2. A data script will be run on a weekly basis on your project's eligible Partner Fee amount calculated based on the sum of all transactions traded through your project's Widget integration associated with Partner Fee defined in the [`appData`](/cow-protocol/reference/core/intents/app-data) your AppKey.
-3. The Net Partner Fee (refer to the [Partner Fee Calculation](`#partner-fee-calculation`) section for details on calculations) will be transferred to your designated Ethereum wallet address defined under the Partner Fee "Recipient" parameter of the Widget on a weekly basis.
+2. A data script will be run on a weekly basis on your project's eligible Partner Fee amount calculated based on the sum of all transactions traded through your project's Widget or API integration associated with Partner Fee defined in the [`appData`](/cow-protocol/reference/core/intents/app-data) and your AppKey.
+3. The Net Partner Fee (refer to the [Partner Fee Calculation](`#partner-fee-calculation`) section for details on calculations) will be transferred to your designated Ethereum wallet address defined under the Partner Fee "Recipient" parameter on a weekly basis.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 1. Upon completing the implementation of the Partner Fee parameters, you will be eligible to receive the Partner Fee on trades executed by your users through the Widget or API integration. | |
| 2. A data script will be run on a weekly basis on your project's eligible Partner Fee amount calculated based on the sum of all transactions traded through your project's Widget integration associated with Partner Fee defined in the [`appData`](/cow-protocol/reference/core/intents/app-data) your AppKey. | |
| 3. The Net Partner Fee (refer to the [Partner Fee Calculation](#partner-fee-calculation) section for details on calculations) will be transferred to your designated Ethereum wallet address defined under the Partner Fee "Recipient" parameter of the Widget on a weekly basis. | |
| 1. Upon completing the implementation of the Partner Fee parameters, you will be eligible to receive the Partner Fee on trades executed by your users through the Widget or API integration. | |
| 2. A data script will be run on a weekly basis on your project's eligible Partner Fee amount calculated based on the sum of all transactions traded through your project's Widget or API integration associated with Partner Fee defined in the [`appData`](/cow-protocol/reference/core/intents/app-data) and your AppKey. | |
| 3. The Net Partner Fee (refer to the [Partner Fee Calculation](`#partner-fee-calculation`) section for details on calculations) will be transferred to your designated Ethereum wallet address defined under the Partner Fee "Recipient" parameter on a weekly basis. |
🤖 Prompt for AI Agents
In `@docs/governance/fees/partner-fee.md` around lines 72 - 74, Update the wording
so all three bullets consistently state that both Widget and API integrations
are included: change the second bullet's "Widget integration" to "Widget or API
integration" and the third bullet's "Widget" to "Widget or API integration"
(references: "Partner Fee parameters", "appData", and the Partner Fee
'Recipient' parameter) so the data script and weekly transfer clearly apply to
trades via either integration.
Updating Partner Fee as requested, please let me know if there is anything else that needs to be changed :)
Description
Changes
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.