@renegade-fi/renegade-sdk 0.1.6 → 0.1.7

package/examples/base_sepolia_match.ts

@@ -0,0 +1,117 @@
+/**
+ * Basic example of using the Renegade External Match Client
+ *
+ * This example demonstrates how to create a client, request a quote, assemble a match, and submit the transaction on-chain.
+ */
+
+import { ExternalMatchClient, OrderSide } from "../index";
+import type { ExternalOrder } from "../index";
+
+// Viem imports for on-chain transactions
+import { http, createWalletClient } from "viem";
+import { privateKeyToAccount } from "viem/accounts";
+import { baseSepolia } from "viem/chains";
+
+// Get API credentials from environment variables
+const API_KEY = process.env.EXTERNAL_MATCH_KEY || "";
+const API_SECRET = process.env.EXTERNAL_MATCH_SECRET || "";
+const PRIVATE_KEY = process.env.PKEY || "";
+const RPC_URL = process.env.RPC_URL || "https://sepolia.base.org";
+
+// Validate API credentials
+if (!API_KEY || !API_SECRET) {
+    console.error("Error: Missing API credentials");
+    console.error("Please set EXTERNAL_MATCH_KEY and EXTERNAL_MATCH_SECRET environment variables");
+    process.exit(1);
+}
+
+// Validate wallet private key
+if (!PRIVATE_KEY) {
+    console.error("Error: Missing private key");
+    console.error("Please set PKEY environment variable");
+    process.exit(1);
+}
+
+// Set up wallet client for blockchain transactions
+const privateKey = PRIVATE_KEY.startsWith("0x") ? PRIVATE_KEY : `0x${PRIVATE_KEY}`;
+const walletClient = createWalletClient({
+    account: privateKeyToAccount(privateKey as `0x${string}`),
+    chain: baseSepolia,
+    transport: http(RPC_URL),
+});
+
+// Create the external match client
+console.log("API KEY", API_KEY);
+const client = ExternalMatchClient.newBaseSepoliaClient(API_KEY, API_SECRET);
+
+// Example order for USDC/WETH pair
+const order: ExternalOrder = {
+    quote_mint: "0xD9961Bb4Cb27192f8dAd20a662be081f546b0E74", // USDC on testnet
+    base_mint: "0xb51a558c8E55DE1EE5391BDFe2aFA49968FC3B25", // cbBTC on testnet
+    side: OrderSide.BUY,
+    quote_amount: BigInt(20_000_000), // 20 USDC
+};
+
+/**
+ * Submit a transaction to the chain
+ * @param settlementTx The settlement transaction
+ * @returns The transaction hash
+ */
+async function submitTransaction(settlementTx: any): Promise<`0x${string}`> {
+    console.log("Submitting transaction...");
+
+    const tx = await walletClient.sendTransaction({
+        to: settlementTx.to as `0x${string}`,
+        data: settlementTx.data as `0x${string}`,
+        value: settlementTx.value ? BigInt(settlementTx.value) : BigInt(0),
+    });
+
+    return tx;
+}
+
+// Full example with on-chain submission
+async function fullExample() {
+    try {
+        // Step 1: Request a quote
+        console.log("Requesting quote...");
+        const quote = await client.requestQuote(order);
+
+        if (!quote) {
+            console.log("No quote available");
+            return;
+        }
+
+        console.log("Quote received!");
+
+        // Step 2: Assemble the quote into a match bundle
+        console.log("Assembling match...");
+        const bundle = await client.assembleQuote(quote);
+
+        if (!bundle) {
+            console.log("No match available");
+            return;
+        }
+
+        console.log("Match assembled!");
+
+        // Step 3: Submit the transaction on-chain
+        const txHash = await submitTransaction(bundle.match_bundle.settlement_tx);
+        console.log(
+            "Transaction submitted:",
+            `${walletClient.chain.blockExplorers?.default.url}/tx/${txHash}`,
+        );
+    } catch (error) {
+        console.error("Error:", error);
+    }
+}
+
+// Run the examples
+async function main() {
+    console.log("Running full example with on-chain submission...");
+    await fullExample();
+}
+
+// Only run if this file is being executed directly
+if (require.main === module) {
+    main().catch(console.error);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@renegade-fi/renegade-sdk",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "A TypeScript client for interacting with the Renegade Darkpool API",
   "module": "index.ts",
   "type": "module",

package/src/client.ts

@@ -22,6 +22,8 @@ import { VERSION } from "./version";
 // Constants for API URLs
 const ARBITRUM_SEPOLIA_BASE_URL = "https://arbitrum-sepolia.auth-server.renegade.fi";
 const ARBITRUM_ONE_BASE_URL = "https://arbitrum-one.auth-server.renegade.fi";
+const BASE_SEPOLIA_BASE_URL = "https://base-sepolia.auth-server.renegade.fi";
+const BASE_MAINNET_BASE_URL = "https://base-mainnet.auth-server.renegade.fi";
 
 // Header constants
 const RENEGADE_API_KEY_HEADER = "x-renegade-api-key";
@@ -290,6 +292,17 @@ export class ExternalMatchClient {
         return new ExternalMatchClient(apiKey, apiSecret, ARBITRUM_SEPOLIA_BASE_URL);
     }
 
+    /**
+     * Create a new client configured for the Base Sepolia testnet.
+     *
+     * @param apiKey The API key for authentication
+     * @param apiSecret The API secret for request signing
+     * @returns A new ExternalMatchClient configured for Sepolia
+     */
+    static newBaseSepoliaClient(apiKey: string, apiSecret: string): ExternalMatchClient {
+        return new ExternalMatchClient(apiKey, apiSecret, BASE_SEPOLIA_BASE_URL);
+    }
+
     /**
      * Create a new client configured for the Arbitrum One mainnet.
      *
@@ -310,6 +323,17 @@ export class ExternalMatchClient {
         return new ExternalMatchClient(apiKey, apiSecret, ARBITRUM_ONE_BASE_URL);
     }
 
+    /**
+     * Create a new client configured for the Base mainnet.
+     *
+     * @param apiKey The API key for authentication
+     * @param apiSecret The API secret for request signing
+     * @returns A new ExternalMatchClient configured for mainnet
+     */
+    static newBaseMainnetClient(apiKey: string, apiSecret: string): ExternalMatchClient {
+        return new ExternalMatchClient(apiKey, apiSecret, BASE_MAINNET_BASE_URL);
+    }
+
     /**
      * Request a quote for the given order.
      *

package/src/version.ts

@@ -1,7 +1,7 @@
 /**
  * SDK version information
  * This file is automatically updated during the build process
- * Last updated: 2025-05-21T22:43:53Z
+ * Last updated: 2025-05-30T00:51:32Z
  */
 
-export const VERSION = '0.1.6';
+export const VERSION = '0.1.7';