Feat/leverage (#50)

* add user leverage endpoint

Author: akashr-gsr

README.md

@@ -20,6 +20,7 @@ Self hosted API gateway to easily interact with Drift V2 Protocol
       - [`GET` Transaction Events](#get-transaction-events)
       - [`GET` SOL Balance](#get-sol-balance)
       - [`GET` Margin Info](#get-margin-info)
+      - [`GET` Leverage](#get-leverage)
       - [`POST` Place Orders](#place-orders)
       - [`PATCH` Modify Orders](#modify-orders)
       - [`DELETE` Cancel Orders](#cancel-orders)
@@ -209,6 +210,21 @@ $ curl localhost:8080/v2/user/marginInfo
 }
 ```
 
+## Get Leverage
+Returns the account leverage
+
+```bash
+$ curl localhost:8080/v2/leverage
+```
+
+**Response**
+
+```json
+{
+   "leverage" : "0.094489"
+}
+```
+
 ## Get Market Info
 
 Returns market details (perps only)

src/controller.rs

@@ -1,3 +1,4 @@
+use drift_sdk::math::leverage::get_leverage;
 use drift_sdk::{
     constants::{ProgramData, BASE_PRECISION},
     dlob_client::DLOBClient,
@@ -26,7 +27,7 @@ use crate::{
         GetOrderbookRequest, GetOrdersRequest, GetOrdersResponse, GetPositionsRequest,
         GetPositionsResponse, Market, MarketInfoResponse, ModifyOrdersRequest, Order, OrderbookL2,
         PerpPosition, PerpPositionExtended, PlaceOrdersRequest, SolBalanceResponse, SpotPosition,
-        TxEventsResponse, TxResponse, UserMarginResponse, PRICE_DECIMALS,
+        TxEventsResponse, TxResponse, UserMarginResponse, UserLeverageResponse, PRICE_DECIMALS,
     },
     websocket::map_drift_event_for_account,
     Context, LOG_TARGET,
@@ -216,6 +217,16 @@ impl AppState {
         .map_err(|err| ControllerError::Sdk(err))
     }
 
+    pub async fn get_leverage(&self, ctx: Context) -> GatewayResult<UserLeverageResponse> {
+        let sub_account = self.resolve_sub_account(ctx.sub_account_id);
+        get_leverage(
+            &self.client,
+            &self.client.get_user_account(&sub_account).await?,
+        )
+        .map(Into::into)
+        .map_err(|err| ControllerError::Sdk(err))
+    }
+
     pub async fn get_position_extended(
         &self,
         ctx: Context,

src/main.rs

@@ -192,6 +192,11 @@ async fn get_margin_info(
     handle_result(controller.get_margin_info(ctx.0).await)
 }
 
+#[get("/leverage")]
+async fn get_leverage(controller: web::Data<AppState>, ctx: web::Query<Context>) -> impl Responder {
+    handle_result(controller.get_leverage(ctx.0).await)
+}
+
 #[actix_web::main]
 async fn main() -> std::io::Result<()> {
     let config: GatewayConfig = argh::from_env();
@@ -277,7 +282,8 @@ async fn main() -> std::io::Result<()> {
                     .service(get_positions_extended)
                     .service(get_tx_events)
                     .service(get_market_info)
-                    .service(get_margin_info),
+                    .service(get_margin_info)
+                    .service(get_leverage),
             )
     })
     .keep_alive(Duration::from_secs(config.keep_alive_timeout as u64))

src/types.rs

@@ -616,6 +616,19 @@ impl From<MarginRequirementInfo> for UserMarginResponse {
     }
 }
 
+#[derive(Serialize, Debug)]
+pub struct UserLeverageResponse {
+    pub leverage: Decimal,
+}
+
+impl From<u128> for UserLeverageResponse {
+    fn from(value: u128) -> Self {
+        Self {
+            leverage: Decimal::from_i128_with_scale(value as i128, PRICE_DECIMALS).normalize(),
+        }
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use drift_sdk::{