# Generated by Scrape::ApiDefinitionsJob: 2019-09-03 18:38:25 UTC
# See: https://git.io/vx5CY
---
- name: :rewards_api
  description: |
    Returns the simulated curve for payouts.  Parameters: `curve:string`; `var1:string`
    
    Note: **The `rewards_api` plugin is for testing purposes only, do not run in production.**
    
    | `curve` (string) | `var1` (string) | |
    |--------------------|-|
    | `"quadratic"` | "2000000000000" |  |
    | `"bounded_curation"` | "2000000000000" |  |
    | `"linear"` | "2000000000000" |  |
    | `"square_root"` | "2000000000000" |  |
    | `"convergent_linear"` | "2000000000000" |  |
    | `"convergent_square_root"` | "2000000000000" |  |
    
    See: [#3325]({{ 'https://github.com/steemit/steem/issues/3325' | archived_url }})
  methods:
  - api_method: rewards_api.simulate_curve_payouts
    purpose: 
    parameter_json: '{"curve":"quadratic","var1":"2000000000000"}'
    expected_response_json: '{"recent_claims":"","payouts":[]}' # TODO - recheck in HF23
    curl_examples:
      - '{"jsonrpc":"2.0", "method":"rewards_api.simulate_curve_payouts", "params": {"curve": "quadratic", "var1": "2000000000000"}, "id":1}'
      - '{"jsonrpc":"2.0", "method":"rewards_api.simulate_curve_payouts", "params": {"curve": "bounded_curation", "var1": "2000000000000"}, "id":1}'
      - '{"jsonrpc":"2.0", "method":"rewards_api.simulate_curve_payouts", "params": {"curve": "linear", "var1": "2000000000000"}, "id":1}'
      - '{"jsonrpc":"2.0", "method":"rewards_api.simulate_curve_payouts", "params": {"curve": "square_root", "var1": "2000000000000"}, "id":1}'
      - '{"jsonrpc":"2.0", "method":"rewards_api.simulate_curve_payouts", "params": {"curve": "convergent_linear", "var1": "2000000000000"}, "id":1}'
      - '{"jsonrpc":"2.0", "method":"rewards_api.simulate_curve_payouts", "params": {"curve": "convergent_square_root", "var1": "2000000000000"}, "id":1}'
    client_docs:
      - '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
