Add remove opportunties to sdk (#200)

auction-server/src/opportunity/api.rs

@@ -115,6 +115,7 @@ pub struct OpportunityDeleteV1Svm {
 }
 
 #[derive(Serialize, Deserialize, ToSchema, Clone, PartialEq, Debug)]
+#[serde(tag = "version")]
 pub enum OpportunityDeleteSvm {
     #[serde(rename = "v1")]
     #[schema(title = "v1")]

sdk/js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pythnetwork/express-relay-js",
-  "version": "0.12.3",
+  "version": "0.13.0",
   "description": "Utilities for interacting with the express relay protocol",
   "homepage": "https://github.com/pyth-network/per/tree/main/sdk/js",
   "author": "Douro Labs",

sdk/js/src/examples/simpleSearcherLimo.ts

@@ -6,7 +6,12 @@ import {
   Opportunity,
   OpportunitySvm,
 } from "../index";
-import { BidStatusUpdate, ChainId, SvmChainUpdate } from "../types";
+import {
+  BidStatusUpdate,
+  ChainId,
+  OpportunityDelete,
+  SvmChainUpdate,
+} from "../types";
 import { SVM_CONSTANTS } from "../const";
 
 import * as anchor from "@coral-xyz/anchor";
@@ -43,7 +48,8 @@ class SimpleSearcherLimo {
       undefined,
       this.opportunityHandler.bind(this),
       this.bidStatusHandler.bind(this),
-      this.svmChainUpdateHandler.bind(this)
+      this.svmChainUpdateHandler.bind(this),
+      this.removeOpportunitiesHandler.bind(this)
     );
     this.connectionSvm = new Connection(endpointSvm, "confirmed");
   }
@@ -186,6 +192,11 @@ class SimpleSearcherLimo {
     this.recentBlockhash[update.chain_id] = update.blockhash;
   }
 
+  // NOTE: Developers are responsible for implementing custom removal logic specific to their use case.
+  async removeOpportunitiesHandler(opportunityDelete: OpportunityDelete) {
+    console.log(`Opportunities ${opportunityDelete} don't exist anymore`);
+  }
+
   async start() {
     try {
       await this.client.subscribeChains([argv.chainId]);

sdk/js/src/index.ts

@@ -18,6 +18,7 @@ import {
   OpportunityCreate,
   TokenAmount,
   SvmChainUpdate,
+  OpportunityDelete,
 } from "./types";
 import {
   Connection,
@@ -97,6 +98,10 @@ export class Client {
     update: SvmChainUpdate
   ) => Promise<void>;
 
+  private websocketRemoveOpportunitiesCallback?: (
+    opportunityDelete: OpportunityDelete
+  ) => Promise<void>;
+
   private getAuthorization() {
     return this.clientOptions.apiKey
       ? {
@@ -110,7 +115,10 @@ export class Client {
     wsOptions?: WsOptions,
     opportunityCallback?: (opportunity: Opportunity) => Promise<void>,
     bidStatusCallback?: (statusUpdate: BidStatusUpdate) => Promise<void>,
-    svmChainUpdateCallback?: (update: SvmChainUpdate) => Promise<void>
+    svmChainUpdateCallback?: (update: SvmChainUpdate) => Promise<void>,
+    removeOpportunitiesCallback?: (
+      opportunityDelete: OpportunityDelete
+    ) => Promise<void>
   ) {
     this.clientOptions = clientOptions;
     this.clientOptions.headers = {
@@ -121,6 +129,7 @@ export class Client {
     this.websocketOpportunityCallback = opportunityCallback;
     this.websocketBidStatusCallback = bidStatusCallback;
     this.websocketSvmChainUpdateCallback = svmChainUpdateCallback;
+    this.websocketRemoveOpportunitiesCallback = removeOpportunitiesCallback;
   }
 
   private connectWebsocket() {
@@ -158,6 +167,17 @@ export class Client {
         if (typeof this.websocketSvmChainUpdateCallback === "function") {
           await this.websocketSvmChainUpdateCallback(message.update);
         }
+      } else if ("type" in message && message.type === "remove_opportunities") {
+        if (typeof this.websocketRemoveOpportunitiesCallback === "function") {
+          await this.websocketRemoveOpportunitiesCallback({
+            chainId: message.opportunity_delete.chain_id,
+            program: message.opportunity_delete.program,
+            permissionAccount: new PublicKey(
+              message.opportunity_delete.permission_account
+            ),
+            router: new PublicKey(message.opportunity_delete.router),
+          });
+        }
       } else if ("id" in message && message.id) {
         // Response to a request sent earlier via the websocket with the same id
         const callback = this.callbackRouter[message.id];
@@ -333,6 +353,31 @@ export class Client {
     }
   }
 
+  /**
+   * Remove an opportunity from the server and update the searchers
+   * @param opportunity Opportunity to be removed
+   */
+  async removeOpportunity(opportunity: OpportunityDelete) {
+    if (opportunity.program !== "limo") {
+      throw new ClientError("Only limo opportunities can be removed");
+    }
+
+    const client = createClient<paths>(this.clientOptions);
+    const body = {
+      chain_id: opportunity.chainId,
+      version: "v1" as const,
+      program: opportunity.program,
+      permission_account: opportunity.permissionAccount.toBase58(),
+      router: opportunity.router.toBase58(),
+    };
+    const response = await client.DELETE("/v1/opportunities", {
+      body,
+    });
+    if (response.error) {
+      throw new ClientError(response.error.error);
+    }
+  }
+
   /**
    * Submits a raw bid for a permission key
    * @param bid