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

Horizon v1.0.0 Compatibility #32

Closed
9 tasks done
abuiles opened this issue Jan 22, 2020 · 6 comments
Closed
9 tasks done

Horizon v1.0.0 Compatibility #32

abuiles opened this issue Jan 22, 2020 · 6 comments
Assignees

Comments

@abuiles
Copy link

abuiles commented Jan 22, 2020

The upcoming Horizon release is coming, and there are multiple breaking changes plus new features 🎉🎉🎉!

The following are the list of changes required to support this new release:

  • ➕Update /fee_stats response.

    • ✂ Remove the following fields:

      min_accepted_fee
      mode_accepted_fee
      p10_accepted_fee
      p20_accepted_fee
      p30_accepted_fee
      p40_accepted_fee
      p50_accepted_fee
      p60_accepted_fee
      p70_accepted_fee
      p80_accepted_fee
      p90_accepted_fee
      p95_accepted_fee
      p99_accepted_fee
    • ➕Add support for max_fee and fee_charged fields. Each field contains a JSON object that looks like this:

      {
        "last_ledger": "22606298",
        "last_ledger_base_fee": "100",
        "ledger_capacity_usage": "0.97",
        "fee_charged": {
          "max": "100",
          "min": "100",
          "mode": "100",
          "p10": "100",
          "p20": "100",
          "p30": "100",
          "p40": "100",
          "p50": "100",
          "p60": "100",
          "p70": "100",
          "p80": "100",
          "p90": "100",
          "p95": "100",
          "p99": "100"
        },
        "max_fee": {
          "max": "100000",
          "min": "100",
          "mode": "100",
          "p10": "100",
          "p20": "100",
          "p30": "100",
          "p40": "100",
          "p50": "100",
          "p60": "100",
          "p70": "100",
          "p80": "100",
          "p90": "15000",
          "p95": "100000",
          "p99": "100000"
        }
       }

    See Update /fee_stats documentation. stellar/go#2140 for more info.

  • ✂ Remove deprecated fee_paid field from Transaction response (replace it with the fee_charged and max_fee fields, see #1372).

  • 🚨Multiple fields changed from int64 to string. If your SDK has types, they need to be updated. If possible, we recommend implementing backward compatibility support, as we did here.

    See Decide on use of int64 in JSON responses. stellar/go#1609, protocols/horizon/effects: Add UnmarshalJSON to SequenceBumped. stellar/go#1909, and Support String or Number Unmarshalling in Int64 fields stellar/go#1912 for more info

  • 🚨 Update operation types to canonical names (if needed) (see protocols/horizon: Apply deprecation on some operation types, updating them to the correct value stellar/go#2134).

  • ➕Add support for /accounts end-point with ?signer and ?asset filters. We recommend a method like .accounts(queryParams) (see documentation for accounts).

  • ➕Add support for /offers end-point with query parameters. We recommend a method like .offers(queryParams) (see documentation for offers).

  • ➕Add support for /paths/strict-send end-point. See documentation.
    We recommend a method like

    strictSendPaths(sourceAsset, sourceAmount, [destinationAsset])
    
  • ➕ Add support for /paths/strict-receive end-point. See documentation.
    We recommend a method like:

    strictReceivePaths(sourceAssets,destinationAsset, destinationAmount)
    
  • ♻ Regenerate the XDR definitions to include MetaV2 support (also see #1902).

That's it! If you have any questions feel free to ping us on #dev-discussion in Keybase.

@bnogalm bnogalm self-assigned this Jan 23, 2020
@bnogalm
Copy link
Owner

bnogalm commented Jan 25, 2020

These three were already implemented:

  1. Remove deprecated fee_paid field from Transaction response (replace it with the fee_charged and max_fee fields, see #1372).

  2. Add support for /paths/strict-send end-point. See documentation.
    We recommend a method like

  3. Add support for /paths/strict-receive end-point. See documentation.
    We recommend a method like:

Current implementation support read int64 as number or string from the JSON and cast it to int64 with no limits. But i will update it to use string to behave like others SDK and also to match future QML API, that requires to deal with javascript number limitations.
This SDK is not using XDR code generator as i didn't find a nice one when i implemented it. As that struct is not used by the SDK i will skip that.

The other points requires some work.

@bnogalm
Copy link
Owner

bnogalm commented Jan 25, 2020

Update /fee_stats response implemented in dd8ed2c

@bnogalm
Copy link
Owner

bnogalm commented Jan 26, 2020

Add support to /accounts filters added in 308a6b9

@bnogalm
Copy link
Owner

bnogalm commented Jan 27, 2020

Add support to /offers filters a4c4a90

@bnogalm
Copy link
Owner

bnogalm commented Feb 2, 2020

Added tests to int64/string responses
Fixed some canonical names b985e49

Everything is done and ready to merge all the branches on the next version.

@abuiles
Copy link
Author

abuiles commented Feb 3, 2020

Awesome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants