Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[API]: Provide maker rebate program API #11530

Closed
9 tasks
JonRay15 opened this issue Aug 6, 2024 · 1 comment
Closed
9 tasks

[API]: Provide maker rebate program API #11530

JonRay15 opened this issue Aug 6, 2024 · 1 comment
Labels
api fe-request A list of reasonably high value API change requests from front end

Comments

@JonRay15
Copy link

JonRay15 commented Aug 6, 2024

API Overview

In order to ... tell users their current maker rebate boost level
We will build an API to... provide the tier and the boost level
So that ... they can understand their rebate boost

Specs

https://github.com/vegaprotocol/specs/pull/2293/files

API request details

  • Create an API that provides informaton on the current High Volume Maker Rebate program including
    • benefit_tiers
      • minimum_party_maker_volume_fraction
      • additional_maker_rebate
      • end_of_program_timestamp
      • window_length

Filtering requirements

  • 1st API - NONE
  • 2nd API
    • partyId

Sample API output (optional)

Assume it would look a lot like this

{
  "currentReferralProgram": {
    "version": "2",
    "id": "20c76e3ea2d1fa205c626354cb506b14a23d2b288dad15990fb0f4b4cc3418dc",
    "benefitTiers": [
      {
        "minimumRunningNotionalTakerVolume": "10000",
        "minimumEpochs": "1",
        "referralRewardFactor": "0.001",
        "referralDiscountFactor": "0.001"
      },
      {
        "minimumRunningNotionalTakerVolume": "500000",
        "minimumEpochs": "6",
        "referralRewardFactor": "0.005",
        "referralDiscountFactor": "0.005"
      },
      {
        "minimumRunningNotionalTakerVolume": "1000000",
        "minimumEpochs": "24",
        "referralRewardFactor": "0.01",
        "referralDiscountFactor": "0.01"
      }
    ],
    "endOfProgramTimestamp": "1793637545000000000",
    "windowLength": "3",
  }
}

Questions

Open questions about the feature implementation, what can be done with the APIs, or currently unresolved questions around the feature.

@JonRay15 JonRay15 added the api label Aug 6, 2024
@JonRay15 JonRay15 added the fe-request A list of reasonably high value API change requests from front end label Aug 6, 2024
@JonRay15 JonRay15 changed the title [API]: Provide maker rebate boost [API]: Provide maker rebate boost APIs Aug 6, 2024
@jeremyletang jeremyletang moved this to Todo in Core Kanban Aug 6, 2024
@JonRay15 JonRay15 changed the title [API]: Provide maker rebate boost APIs [API]: Provide maker rebate program API Aug 14, 2024
@github-project-automation github-project-automation bot moved this from Todo to Merged in Core Kanban Aug 14, 2024
@jeremyletang jeremyletang reopened this Aug 14, 2024
@JonRay15
Copy link
Author

Apparently this is done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api fe-request A list of reasonably high value API change requests from front end
Projects
Archived in project
Development

No branches or pull requests

2 participants