initial sdk prototype (#1850)

* initial sdk prototype

* generalize svm endpoints, some reorg

* some renamings, reorg

* address some lint issues

* lint + name changes

* fixed tx serialization to include signatures & template

* fixed type hints

* address comments

* unused import

* update to new server bidsvm format

* improve org

* refactored js sdk + addressed comments

* fix lint

* idl folders

* idl folders

* bump package version

* rename package

* address comments

Author: anihamde

express_relay/examples/easy_lend/package.json

@@ -21,7 +21,7 @@
   },
   "dependencies": {
     "@openzeppelin/contracts": "^4.5.0",
-    "@pythnetwork/express-relay-evm-js": "workspace:*",
+    "@pythnetwork/express-relay-js": "workspace:*",
     "@pythnetwork/express-relay-sdk-solidity": "workspace:*",
     "@pythnetwork/price-service-client": "workspace:^",
     "@pythnetwork/pyth-evm-js": "workspace:*",

express_relay/examples/easy_lend/src/monitor.ts

@@ -4,8 +4,7 @@ import {
   checkAddress,
   Client,
   OpportunityParams,
-} from "@pythnetwork/express-relay-evm-js";
-import { privateKeyToAccount } from "viem/accounts";
+} from "@pythnetwork/express-relay-js";
 import type { ContractFunctionReturnType } from "viem";
 import {
   Address,
@@ -15,7 +14,6 @@ import {
   getContract,
   Hex,
   http,
-  isHex,
 } from "viem";
 import { optimismSepolia } from "viem/chains";
 import { abi } from "./abi";

express_relay/sdk/js/README.md

@@ -7,13 +7,13 @@ Utility library for interacting with the Pyth Express Relay API.
 ### npm
 
 ```
-$ npm install --save @pythnetwork/express-relay-evm-js
+$ npm install --save @pythnetwork/express-relay-js
 ```
 
 ### Yarn
 
 ```
-$ yarn add @pythnetwork/express-relay-evm-js
+$ yarn add @pythnetwork/express-relay-js
 ```
 
 ## Development
@@ -24,14 +24,20 @@ To generate the latest type declarations from the server openapi schema, run:
 npm run generate-api-types
 ```
 
+You can generate the Solana Typescript declaration files from the IDLs via:
+
+```bash
+npm run generate-anchor-types
+```
+
 ## Quickstart
 
 ```typescript
 import {
   Client,
   OpportunityParams,
   BidParams,
-} from "@pythnetwork/express-relay-evm-js";
+} from "@pythnetwork/express-relay-js";
 
 function calculateOpportunityBid(opportunity: Opportunity): BidParams | null {
   // searcher implementation here
@@ -79,4 +85,16 @@ npm run simple-searcher -- \
   --private-key <YOUR-PRIVATE-KEY>
 ```
 
+#### SimpleSearcherSvm
+
+The SimpleSearcherSvm example submits a dummy SVM transaction to the auction server after appending the appropriate `SubmitBid` instruction that permissions the transaction. You can run it with `npm run simple-searcher-svm`, and the full command looks like:
+
+```bash
+npm run simple-searcher-svm -- \
+  --endpoint-express-relay http://per-staging.dourolabs.app/ \
+  --chain-id solana \
+  --private-key <YOUR-PRIVATE-KEY> \
+  --endpoint-svm "https://api.mainnet-beta.solana.com"
+```
+
 Note that if you are using a localhost server at `http://127.0.0.1`, you should specify `--endpoint http://127.0.0.1:{PORT}` rather than `http://localhost:{PORT}`, as Typescript maps `localhost` to `::1` in line with IPv6 rather than to `127.0.0.1` as with IPv4.

express_relay/sdk/js/package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@pythnetwork/express-relay-evm-js",
-  "version": "0.8.1",
+  "name": "@pythnetwork/express-relay-js",
+  "version": "0.9.0",
   "description": "Utilities for interacting with the express relay protocol",
   "homepage": "https://github.com/pyth-network/pyth-crosschain/tree/main/express_relay/sdk/js",
   "author": "Douro Labs",
@@ -16,7 +16,9 @@
     "build": "tsc",
     "test": "jest src/ --passWithNoTests",
     "simple-searcher": "pnpm run build && node lib/examples/simpleSearcher.js",
+    "simple-searcher-svm": "pnpm run build && node lib/examples/simpleSearcherSvm.js",
     "generate-api-types": "openapi-typescript http://127.0.0.1:9000/docs/openapi.json --output src/serverTypes.d.ts",
+    "generate-anchor-types": "anchor idl type src/idl/idlExpressRelay.json --out src/expressRelayTypes.d.ts && anchor idl type src/examples/idl/idlDummy.json --out src/examples/dummyTypes.d.ts",
     "format": "prettier --write \"src/**/*.ts\"",
     "lint": "eslint src",
     "prepublishOnly": "pnpm run build && pnpm test && pnpm run lint",
@@ -34,6 +36,8 @@
     "directory": "express_relay/sdk/js"
   },
   "dependencies": {
+    "@coral-xyz/anchor": "^0.30.1",
+    "@solana/web3.js": "^1.95.3",
     "isomorphic-ws": "^5.0.0",
     "openapi-client-axios": "^7.5.5",
     "openapi-fetch": "^0.8.2",

express_relay/sdk/js/src/const.ts

@@ -1,4 +1,5 @@
-import { OpportunityAdapterConfig } from "./types";
+import { PublicKey } from "@solana/web3.js";
+import { OpportunityAdapterConfig, SvmConstantsConfig } from "./types";
 
 export const OPPORTUNITY_ADAPTER_CONFIGS: Record<
   string,
@@ -21,3 +22,17 @@ export const OPPORTUNITY_ADAPTER_CONFIGS: Record<
     weth: "0x4200000000000000000000000000000000000006",
   },
 };
+
+export const SVM_CONSTANTS: Record<string, SvmConstantsConfig> = {
+  solana: {
+    relayerSigner: new PublicKey(
+      "3pR5W8qPTHKEdoD7mNMx1SwkaPE18aQZwoAKWYpnHozY"
+    ),
+    feeReceiverRelayer: new PublicKey(
+      "3pR5W8qPTHKEdoD7mNMx1SwkaPE18aQZwoAKWYpnHozY"
+    ),
+    expressRelayProgram: new PublicKey(
+      "GwEtasTAxdS9neVE4GPUpcwR7DB7AizntQSPcG36ubZM"
+    ),
+  },
+};

express_relay/sdk/js/src/examples/dummyTypes.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Program IDL in camelCase format in order to be used in JS/TS.
+ *
+ * Note that this is only a type helper and is not the actual IDL. The original
+ * IDL can be found at `target/idl/dummy.json`.
+ */
+export type Dummy = {
+  address: "HYCgALnu6CM2gkQVopa1HGaNf8Vzbs9bomWRiKP267P3";
+  metadata: {
+    name: "dummy";
+    version: "0.1.0";
+    spec: "0.1.0";
+    description: "Created with Anchor";
+  };
+  instructions: [
+    {
+      name: "doNothing";
+      discriminator: [112, 130, 224, 161, 71, 149, 192, 187];
+      accounts: [
+        {
+          name: "payer";
+          writable: true;
+          signer: true;
+        },
+        {
+          name: "expressRelay";
+          address: "GwEtasTAxdS9neVE4GPUpcwR7DB7AizntQSPcG36ubZM";
+        },
+        {
+          name: "sysvarInstructions";
+          address: "Sysvar1nstructions1111111111111111111111111";
+        },
+        {
+          name: "permission";
+        },
+        {
+          name: "router";
+        }
+      ];
+      args: [];
+    }
+  ];
+};

express_relay/sdk/js/src/examples/idl/idlDummy.json

@@ -0,0 +1,37 @@
+{
+  "address": "HYCgALnu6CM2gkQVopa1HGaNf8Vzbs9bomWRiKP267P3",
+  "metadata": {
+    "name": "dummy",
+    "version": "0.1.0",
+    "spec": "0.1.0",
+    "description": "Created with Anchor"
+  },
+  "instructions": [
+    {
+      "name": "do_nothing",
+      "discriminator": [112, 130, 224, 161, 71, 149, 192, 187],
+      "accounts": [
+        {
+          "name": "payer",
+          "writable": true,
+          "signer": true
+        },
+        {
+          "name": "express_relay",
+          "address": "GwEtasTAxdS9neVE4GPUpcwR7DB7AizntQSPcG36ubZM"
+        },
+        {
+          "name": "sysvar_instructions",
+          "address": "Sysvar1nstructions1111111111111111111111111"
+        },
+        {
+          "name": "permission"
+        },
+        {
+          "name": "router"
+        }
+      ],
+      "args": []
+    }
+  ]
+}

express_relay/sdk/js/src/examples/simpleSearcherSvm.ts

@@ -0,0 +1,178 @@
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
+import { Client } from "../index";
+import { BidStatusUpdate } from "../types";
+import { SVM_CONSTANTS } from "../const";
+
+import * as anchor from "@coral-xyz/anchor";
+import { Program, AnchorProvider } from "@coral-xyz/anchor";
+import { Keypair, PublicKey, Connection } from "@solana/web3.js";
+import dummyIdl from "./idl/idlDummy.json";
+import { Dummy } from "./dummyTypes";
+
+const DAY_IN_SECONDS = 60 * 60 * 24;
+const DUMMY_PIDS: Record<string, PublicKey> = {
+  solana: new PublicKey("HYCgALnu6CM2gkQVopa1HGaNf8Vzbs9bomWRiKP267P3"),
+};
+
+class SimpleSearcherSvm {
+  private client: Client;
+  private connectionSvm: Connection;
+  constructor(
+    public endpointExpressRelay: string,
+    public chainId: string,
+    public privateKey: string,
+    public endpointSvm: string,
+    public apiKey?: string
+  ) {
+    this.client = new Client(
+      {
+        baseUrl: endpointExpressRelay,
+        apiKey,
+      },
+      undefined,
+      () => {
+        return Promise.resolve();
+      },
+      this.bidStatusHandler.bind(this)
+    );
+    this.connectionSvm = new Connection(endpointSvm, "confirmed");
+  }
+
+  async bidStatusHandler(bidStatus: BidStatusUpdate) {
+    let resultDetails = "";
+    if (bidStatus.type == "submitted" || bidStatus.type == "won") {
+      resultDetails = `, transaction ${bidStatus.result}`;
+    } else if (bidStatus.type == "lost") {
+      if (bidStatus.result) {
+        resultDetails = `, transaction ${bidStatus.result}`;
+      }
+    }
+    console.log(
+      `Bid status for bid ${bidStatus.id}: ${bidStatus.type.replaceAll(
+        "_",
+        " "
+      )}${resultDetails}`
+    );
+  }
+
+  async dummyBid() {
+    const secretKey = anchor.utils.bytes.bs58.decode(this.privateKey);
+    const searcher = Keypair.fromSecretKey(secretKey);
+
+    const provider = new AnchorProvider(
+      this.connectionSvm,
+      new anchor.Wallet(searcher),
+      {}
+    );
+    const dummy = new Program<Dummy>(dummyIdl as Dummy, provider);
+
+    const permission = PublicKey.default;
+    const router = Keypair.generate().publicKey;
+    const bidAmount = new anchor.BN(argv.bid);
+
+    const svmConstants = SVM_CONSTANTS[this.chainId];
+    if (!(this.chainId in DUMMY_PIDS)) {
+      throw new Error(`Dummy program id not found for chain ${this.chainId}`);
+    }
+    const dummyPid = DUMMY_PIDS[this.chainId];
+
+    const ixDummy = await dummy.methods
+      .doNothing()
+      .accountsStrict({
+        payer: searcher.publicKey,
+        expressRelay: svmConstants.expressRelayProgram,
+        sysvarInstructions: anchor.web3.SYSVAR_INSTRUCTIONS_PUBKEY,
+        permission,
+        router,
+      })
+      .instruction();
+    ixDummy.programId = dummyPid;
+
+    const txRaw = new anchor.web3.Transaction().add(ixDummy);
+
+    const bid = await this.client.constructSvmBid(
+      txRaw,
+      searcher.publicKey,
+      router,
+      permission,
+      bidAmount,
+      new anchor.BN(Math.round(Date.now() / 1000 + DAY_IN_SECONDS)),
+      this.chainId
+    );
+
+    try {
+      const { blockhash } = await this.connectionSvm.getLatestBlockhash();
+      bid.transaction.recentBlockhash = blockhash;
+      bid.transaction.sign(Keypair.fromSecretKey(secretKey));
+      const bidId = await this.client.submitBid(bid);
+      console.log(`Successful bid. Bid id ${bidId}`);
+    } catch (error) {
+      console.error(`Failed to bid: ${error}`);
+    }
+  }
+
+  async start() {
+    for (;;) {
+      await this.dummyBid();
+      await new Promise((resolve) => setTimeout(resolve, 2000));
+    }
+  }
+}
+
+const argv = yargs(hideBin(process.argv))
+  .option("endpoint-express-relay", {
+    description:
+      "Express relay endpoint. e.g: https://per-staging.dourolabs.app/",
+    type: "string",
+    demandOption: true,
+  })
+  .option("chain-id", {
+    description: "Chain id to fetch opportunities for. e.g: solana",
+    type: "string",
+    demandOption: true,
+  })
+  .option("bid", {
+    description: "Bid amount in lamports",
+    type: "string",
+    default: "100",
+  })
+  .option("private-key", {
+    description: "Private key to sign the bid with. In 64-byte base58 format",
+    type: "string",
+    demandOption: true,
+  })
+  .option("api-key", {
+    description:
+      "The API key of the searcher to authenticate with the server for fetching and submitting bids",
+    type: "string",
+    demandOption: false,
+  })
+  .option("endpoint-svm", {
+    description: "SVM RPC endpoint",
+    type: "string",
+    demandOption: true,
+  })
+  .help()
+  .alias("help", "h")
+  .parseSync();
+async function run() {
+  if (SVM_CONSTANTS[argv.chainId] === undefined) {
+    throw new Error(`SVM constants not found for chain ${argv.chainId}`);
+  }
+  const searcherSvm = Keypair.fromSecretKey(
+    anchor.utils.bytes.bs58.decode(argv.privateKey)
+  );
+  console.log(`Using searcher pubkey: ${searcherSvm.publicKey.toBase58()}`);
+
+  const simpleSearcher = new SimpleSearcherSvm(
+    argv.endpointExpressRelay,
+    argv.chainId,
+    argv.privateKey,
+    argv.endpointSvm,
+    argv.apiKey
+  );
+  await simpleSearcher.start();
+}
+
+run();