Feat/emulate mode

README.md

@@ -16,7 +16,7 @@ export DRIFT_GATEWAY_KEY=</PATH/TO/KEY.json | seedBase58>
 drift-gateway --dev https://api.devnet.solana.com
 
 # or mainnet
-# NB: `api.mainnet-beta.solana.com`` cannot be used due to rate limits on certain RPC calls
+# NB: `api.mainnet-beta.solana.com` cannot be used due to rate limits on certain RPC calls
 drift-gateway https://rpc-provider.example.com
 ```
 
@@ -28,7 +28,7 @@ docker run -e DRIFT_GATEWAY_KEY=<BASE58_SEED> -p 8080:8080 drift-gateway https:/
 
 ## Usage
 ```bash
-Usage: drift-gateway <rpc_host> [--dev] [--host <host>] [--port <port>] [--delegate <delegate>]
+Usage: drift-gateway <rpc_host> [--dev] [--host <host>] [--port <port>] [--delegate <delegate>] [--emulate <emulate>]
 
 Drift gateway server
 
@@ -39,8 +39,8 @@ Options:
   --dev             run in devnet mode
   --host            gateway host address
   --port            gateway port
-  --delegate        use delegated signing mode, provide the delegator's pubkey
-                    e.g. `--delegate <DELEGATOR_PUBKEY>`
+  --delegate        use delegated signing mode, provide the delegator pubkey
+  --emulate         run the gateway in read-only mode for given authority pubkey
   --help            display usage information
 ```
 
@@ -448,10 +448,18 @@ this event may be safely ignored, it is added in an effort to help order life-cy
 }
 ```
 
+## Emulation Mode
+Passing the `--emulate <EMULATED_PUBBKEY>` flag will instruct the gateway to run in read-only mode.
+
+The gateway will receive all events, positions, etc. as normal but be unable to send transactions.
+
+note therefore `DRIFT_GATEWAY_KEY` is not required to be set.
+
+
 ## Delegated Signing Mode
 Passing the `--delegate <DELEGATOR_PUBKEY>` flag will instruct the gateway to run in delegated signing mode.
 
-In this mode, the gateway will act for `DELEGATOR_PUBKEY` and sub-accounts while signing with the key provided via `DRIFT_GATEWAY_KEY`.
+In this mode, the gateway will act for `DELEGATOR_PUBKEY` and sub-accounts while signing with the key provided via `DRIFT_GATEWAY_KEY` (i.e delegate key).
 
 Use the drift UI or Ts/Python SDK to assign a delegator key.
 see [Delegated Accounts](https://docs.drift.trade/delegated-accounts) for more information.

src/controller.rs

@@ -49,21 +49,13 @@ impl AppState {
     pub fn default_sub_account(&self) -> Pubkey {
         self.wallet.default_sub_account()
     }
-    pub async fn new(
-        secret_key: &str,
-        endpoint: &str,
-        devnet: bool,
-        delegate: Option<Pubkey>,
-    ) -> Self {
+    pub async fn new(endpoint: &str, devnet: bool, wallet: Wallet) -> Self {
         let context = if devnet {
             Context::DevNet
         } else {
             Context::MainNet
         };
-        let mut wallet = Wallet::try_from_str(secret_key).expect("valid key");
-        if let Some(authority) = delegate {
-            wallet.to_delegated(authority);
-        }
+
         let account_provider = WsAccountProvider::new(endpoint).await.expect("ws connects");
         let client = DriftClient::new(context, endpoint, account_provider)
             .await
@@ -316,7 +308,7 @@ impl AppState {
             Cow::Borrowed(account_data),
         )
         .payer(self.wallet.signer())
-        .modify_orders(params)
+        .modify_orders(params.as_slice())
         .build();
 
         self.client
@@ -373,3 +365,28 @@ fn build_cancel_ix(
         Ok(builder.cancel_all_orders())
     }
 }
+
+/// Initialize a wallet for controller, possible valid configs:
+///
+/// 1) keypair
+/// 2) keypair + delegated
+/// 3) emulation/RO mode
+pub fn create_wallet(
+    secret_key: Option<String>,
+    emulate: Option<Pubkey>,
+    delegate: Option<Pubkey>,
+) -> Wallet {
+    match (&secret_key, emulate, delegate) {
+        (Some(secret_key), _, delegate) => {
+            let mut wallet = Wallet::try_from_str(secret_key).expect("valid key");
+            if let Some(authority) = delegate {
+                wallet.to_delegated(authority);
+            }
+            wallet
+        }
+        (None, Some(emulate), None) => Wallet::read_only(emulate),
+        _ => {
+            panic!("expected 'DRIFT_GATEWAY_KEY' or --emulate <pubkey>");
+        }
+    }
+}

src/main.rs

@@ -4,9 +4,9 @@ use actix_web::{
     App, Either, HttpResponse, HttpServer, Responder,
 };
 use argh::FromArgs;
-use log::{error, info};
+use log::{error, info, warn};
 
-use controller::{AppState, ControllerError};
+use controller::{create_wallet, AppState, ControllerError};
 use drift_sdk::Pubkey;
 use serde_json::json;
 use std::{borrow::Borrow, str::FromStr, sync::Arc};
@@ -137,11 +137,15 @@ async fn main() -> std::io::Result<()> {
     env_logger::Builder::from_default_env()
         .filter_level(log::LevelFilter::Info)
         .init();
-    let secret_key = std::env::var("DRIFT_GATEWAY_KEY").expect("missing DRIFT_GATEWAY_KEY");
+    let secret_key = std::env::var("DRIFT_GATEWAY_KEY");
     let delegate = config
         .delegate
         .map(|ref x| Pubkey::from_str(x).expect("valid pubkey"));
-    let state = AppState::new(secret_key.as_str(), &config.rpc_host, config.dev, delegate).await;
+    let emulate = config
+        .emulate
+        .map(|ref x| Pubkey::from_str(x).expect("valid pubkey"));
+    let wallet = create_wallet(secret_key.ok(), emulate, delegate);
+    let state = AppState::new(&config.rpc_host, config.dev, wallet).await;
 
     info!(
         "🏛️ gateway listening at http://{}:{}",
@@ -161,6 +165,9 @@ async fn main() -> std::io::Result<()> {
             state.authority(),
             state.default_sub_account()
         );
+        if emulate.is_some() {
+            warn!("using emulation mode, tx signing unavailable");
+        }
     }
 
     let client = Box::leak(Box::new(Arc::clone(state.client.borrow())));
@@ -206,9 +213,11 @@ struct GatewayConfig {
     #[argh(option, default = "8080")]
     port: u16,
     /// use delegated signing mode, provide the delegator's pubkey
-    /// e.g. `--delegate <DELEGATOR_PUBKEY>`
     #[argh(option)]
     delegate: Option<String>,
+    /// run the gateway in read-only mode for given authority pubkey
+    #[argh(option)]
+    emulate: Option<String>,
 }
 
 fn handle_result<T>(result: Result<T, ControllerError>) -> Either<HttpResponse, Json<T>> {
@@ -265,6 +274,8 @@ mod tests {
 
     use crate::types::Market;
 
+    use self::controller::create_wallet;
+
     use super::*;
 
     const TEST_ENDPOINT: &str = "https://api.devnet.solana.com";
@@ -276,7 +287,8 @@ mod tests {
     }
 
     async fn setup_controller() -> AppState {
-        AppState::new(&get_seed(), TEST_ENDPOINT, true, None).await
+        let wallet = create_wallet(Some(get_seed()), None, None);
+        AppState::new(TEST_ENDPOINT, true, wallet).await
     }
 
     #[actix_web::test]