mainClient.getKlines - beautifyResponses doesn't beautify

[davydof]

beautifyResponses enabled option doesn't work
3.0.0-beta.10

const mainClient = new MainClient({
  beautifyResponses: true,
});
const result = await mainClient.getKlines({
  symbol: 'BTCUSDT',
  interval: '1d',
  limit: 3,
});
console.log('result', result);

result [
  [
    1746057600000,
    '94172.00000000',
    '97424.02000000',
    '94130.43000000',
    '96489.91000000',
    '21380.45343000',
    1746143999999,
    '2053857614.27326720',
    2925716,
    '10925.87308000',
    '1049157198.85876350',
    '0'
  ],
  [
    1746144000000,
    '96489.90000000',
    '97895.68000000',
    '96350.00000000',
    '96887.14000000',
    '14905.74811000',
    1746230399999,
    '1446387651.58405750',
    2698263,
    '7440.33531000',
    '722022817.22461990',
    '0'
  ],
  [
    1746230400000,
    '96887.13000000',
    '96935.67000000',
    '96132.67000000',
    '96150.98000000',
    '4592.56560000',
    1746316799999,
    '442832000.17842580',
    495791,
    '1888.51691000',
    '182094753.56621230',
    '0'
  ]
]

[tiagosiebler]

This is the same behaviour as it was in the previous release, isn't it? While I agree it contradicts the point of beautify, it doesn't seem like I've introduced this as a breaking change. When I try the same API call in master with the beautifier enabled, it returns the same data.

Mixed feelings here. I'm hesitant to introduce more breaking changes than necessary. If the beautifier maps this to kline objects (instead of that more efficient array notation), the type returned by this method would also need a conditional check on whether the beautifier is on, or it would mismatch for anyone using typescript. Need to give this more thought but might leave this as is for now, since it doesn't seem a change in behaviour vs before the beta. Let me know if I've misunderstood anything.

[davydof]

Yes, it works the same as it was in previous release.

In binance/lib/util/beautifier-maps.js I found this map

klines: {
  0: 'openTime',
  1: 'open',
  2: 'high',
  3: 'low',
  4: 'close',
  5: 'volume',
  6: 'closeTime',
  7: 'quoteAssetVolume',
  8: 'trades',
  9: 'takerBaseAssetVolume',
  10: 'takerQuoteAssetVolume',
  11: 'ignored',
}

So it make sense to beautify result with beautifyResponses: true :)

[tiagosiebler]

Yes, it's used by the WS client for kline events. The "k" property maps to the kline object, and is resolved from there:
https://github.com/tiagosiebler/binance/blob/wsapi/src/util/beautifier-maps.ts#L130

This happens since the beautifier sees that the "k" property on the object contains another object, so it renames it and looks up the beautifier map for a key matching the new name (kline), which is then used to map whatever data exists on "k".

I do agree it makes sense to use this for the REST API call while enabled - it doesn't quite make sense that it doesn't... this will need thought though on the right approach, as it would now be a breaking change and it would contradict the type returned by that method - will save this for after the next major release as there other things to focus on first.