Connector client error: invalid type: boolean `false` when using DerivativesTradingUsdsFuturesRestApi's symbol_configuration

[joelchen]

let futures_client = DerivativesTradingUsdsFuturesRestApi::production(config);
let params = SymbolConfigurationParams::default();
let output = futures_client.symbol_configuration(params).await;
if let Ok(response) = output {
    match response.data().await {
        Ok(configurations) => println!("a: {:?}", configurations),
        Err(e) => eprintln!("b: {}", e)
    }
}
let result = SymbolConfigurationParams::builder().symbol("BTCUSDT".to_string()).build();
if let Ok(params) = result {
    let output = futures_client.symbol_configuration(params).await;
    if let Ok(response) = output {
        match response.data().await {
            Ok(configurations) => println!("c: {:?}", configurations),
            Err(e) => eprintln!("d: {}", e)
        }
    }
}

The above code yields the following:

b: Connector client error: invalid type: boolean `false`, expected a string at line 1 column 67
d: Connector client error: invalid type: boolean `false`, expected a string at line 1 column 68

[joelchen]

binance-connector-rust/src/derivatives_trading_usds_futures/rest_api/models/symbol_configuration_response_inner.rs

Line 25 in 440a0e3

pub is_auto_add_margin: Option<String>,

Repository has is_auto_add_margin using Option<String>, but querying /fapi/v1/symbolConfig returns isAutoAddMargin as boolean instead of string:

[
    {
        "symbol": "BTCUSDT",
        "marginType": "CROSSED",
        "isAutoAddMargin": false,
        "leverage": 20,
        "maxNotionalValue": "12000000"
    }
]

[joelchen]

@dimitrisn442 Have fixed this issue in #83, please review and merge.

[joelchen]

Noticed in the official API documentation (https://developers.binance.com/docs/derivatives/usds-margined-futures/account/rest-api/Symbol-Config), "false" is wrapped with quotes, but actual response from /fapi/v1/symbolConfig is false, not wrapped with quotes. @dimitrisn442 I have separately contacted Binance Customer Service regarding this discrepancy, please escalate this issue to Binance API team from your side as well.

[joelchen]

@dimitrisn442 Since this issue likely stems from a disconnect between what Binance API team are changing and how Binance Connectors are keeping up, are there plans for Binance API team to run a more comprehensive test by testing all endpoints with official Binance Connectors (especially binance-connector-rust) before pushing API changes to production?

To avoid similar issues from happening in the future, please enhance binance-connector-rust to handle errors more gracefully instead of aborting with error.

One way is by adding DefaultOnError on every field:

use serde_with::{serde_as, DefaultOnError};

#[serde_as]
#[derive(Deserialize)]
struct MyData {
    #[serde_as(deserialize_as = "DefaultOnError")]
    pub field: Option<String>
}

Another way is to implement a custom deserializer to convert any types, and if it is not able to convert, log error to stderr and return Ok(None):

use serde::{Deserialize, Deserializer, de::DeserializeOwned};
use serde_json::Value;

pub fn flexible_option<'de, T, D>(deserializer: D) -> Result<Option<T>, D::Error>
where
    D: Deserializer<'de>,
    T: DeserializeOwned,
{
    let value = Value::deserialize(deserializer)?;

    match serde_json::from_value::<T>(value) {
        Ok(converted) => Ok(Some(converted)),
        Err(e) => {
            eprintln!("Deserialization error for field: {}", e);
            Ok(None)
        }
    }
}

#[derive(Deserialize)]
struct MyData {
    #[serde(deserialize_with = "flexible_option")]
    pub field_str: Option<String>,
    
    #[serde(deserialize_with = "flexible_option")]
    pub field_bool: Option<bool>,
    
    #[serde(deserialize_with = "flexible_option")]
    pub field_float: Option<f64>
}

[dimitrisn442]

Hi @joelchen, thanks for bringing this up. The latest version handles this field properly, so feel free to upgrade. Let us know if you find any other inconsistency. Thanks!