@renegade-fi/renegade-sdk 0.1.1 → 0.1.3

package/biome.json

@@ -0,0 +1,44 @@
+{
+    "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+    "files": {
+        "ignore": [
+            "CHANGELOG.md",
+            "pnpm-lock.yaml",
+            "package.json",
+            "tsconfig.base.json",
+            "wasm/**",
+            "dist/**",
+            "renegade-utils/**",
+            "*.d.ts"
+        ]
+    },
+    "formatter": {
+        "indentStyle": "space",
+        "indentWidth": 4,
+        "lineWidth": 100
+    },
+    "linter": {
+        "rules": {
+            "recommended": true,
+            "correctness": {
+                "noUnusedVariables": "error",
+                "useExhaustiveDependencies": "error",
+                "noUnusedImports": "error"
+            },
+            "style": {
+                "useShorthandArrayType": "error"
+            },
+            "suspicious": {
+                "noExplicitAny": "off"
+            }
+        }
+    },
+    "organizeImports": {
+        "enabled": true
+    },
+    "vcs": {
+        "enabled": true,
+        "clientKind": "git",
+        "useIgnoreFile": true
+    }
+}

package/examples/basic.ts

@@ -1,43 +1,39 @@
 /**
  * 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';
-import { stringifyBigJSON } from '../src/http';
+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 { arbitrumSepolia } from 'viem/chains';
+import { http, createWalletClient } from "viem";
+import { privateKeyToAccount } from "viem/accounts";
+import { arbitrumSepolia } 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-rollup.arbitrum.io/rpc';
+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-rollup.arbitrum.io/rpc";
 
 // 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');
+    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 PRIVATE_KEY environment variable');
+    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 privateKey = PRIVATE_KEY.startsWith("0x") ? PRIVATE_KEY : `0x${PRIVATE_KEY}`;
 const walletClient = createWalletClient({
     account: privateKeyToAccount(privateKey as `0x${string}`),
     chain: arbitrumSepolia,
@@ -45,13 +41,13 @@ const walletClient = createWalletClient({
 });
 
 // Create the external match client
-console.log('API KEY', API_KEY);
+console.log("API KEY", API_KEY);
 const client = ExternalMatchClient.newSepoliaClient(API_KEY, API_SECRET);
 
 // Example order for USDC/WETH pair
 const order: ExternalOrder = {
-    quote_mint: '0xdf8d259c04020562717557f2b5a3cf28e92707d1', // USDC
-    base_mint: '0xc3414a7ef14aaaa9c4522dfc00a4e66e74e9c25a',  // WETH
+    quote_mint: "0xdf8d259c04020562717557f2b5a3cf28e92707d1", // USDC
+    base_mint: "0xc3414a7ef14aaaa9c4522dfc00a4e66e74e9c25a", // WETH
     side: OrderSide.BUY,
     quote_amount: BigInt(20_000_000), // 20 USDC
 };
@@ -62,7 +58,7 @@ const order: ExternalOrder = {
  * @returns The transaction hash
  */
 async function submitTransaction(settlementTx: any): Promise<`0x${string}`> {
-    console.log('Submitting transaction...');
+    console.log("Submitting transaction...");
 
     const tx = await walletClient.sendTransaction({
         to: settlementTx.to as `0x${string}`,
@@ -77,45 +73,45 @@ async function submitTransaction(settlementTx: any): Promise<`0x${string}`> {
 async function fullExample() {
     try {
         // Step 1: Request a quote
-        console.log('Requesting quote...');
+        console.log("Requesting quote...");
         const quote = await client.requestQuote(order);
 
         if (!quote) {
-            console.log('No quote available');
+            console.log("No quote available");
             return;
         }
 
-        console.log('Quote received!');
+        console.log("Quote received!");
 
         // Step 2: Assemble the quote into a match bundle
-        console.log('Assembling match...');
+        console.log("Assembling match...");
         const bundle = await client.assembleQuote(quote);
 
         if (!bundle) {
-            console.log('No match available');
+            console.log("No match available");
             return;
         }
 
-        console.log('Match assembled!');
+        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}`
+            "Transaction submitted:",
+            `${walletClient.chain.blockExplorers?.default.url}/tx/${txHash}`,
         );
     } catch (error) {
-        console.error('Error:', error);
+        console.error("Error:", error);
     }
 }
 
 // Run the examples
 async function main() {
-    console.log('Running full example with on-chain submission...');
+    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/examples/malleable_external_match.ts

@@ -0,0 +1,149 @@
+/**
+ * Fetch a quote from the external api and execute a malleable match
+ *
+ * Malleable matches allow the exact swap amount to be determined at settlement
+ * time within a predefined range, offering more flexibility than standard
+ * matches.
+ */
+
+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 { arbitrumSepolia } 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-rollup.arbitrum.io/rpc";
+
+// 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: arbitrumSepolia,
+    transport: http(RPC_URL),
+});
+
+// Create the external match client
+console.log("API KEY", API_KEY);
+const client = ExternalMatchClient.newSepoliaClient(API_KEY, API_SECRET);
+
+// Example order for USDC/WETH pair
+const order: ExternalOrder = {
+    quote_mint: "0xdf8d259c04020562717557f2b5a3cf28e92707d1", // USDC
+    base_mint: "0xc3414a7ef14aaaa9c4522dfc00a4e66e74e9c25a", // WETH
+    side: OrderSide.SELL,
+    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;
+}
+
+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.assembleMalleableQuote(quote);
+
+        if (!bundle) {
+            console.log("No match available");
+            return;
+        }
+
+        // Print bundle info
+        console.log("Bundle info:");
+        const [minBase, maxBase] = bundle.baseBounds();
+        console.log(`Base bounds: ${minBase} - ${maxBase}`);
+
+        // Pick a random base amount and see the send and receive amounts at that base amount
+        const dummyBaseAmount = randomInRange(minBase, maxBase);
+        const dummySendAmount = bundle.sendAmountAtBase(dummyBaseAmount);
+        const dummyReceiveAmount = bundle.receiveAmountAtBase(dummyBaseAmount);
+        console.log(`Hypothetical base amount: ${dummyBaseAmount}`);
+        console.log(`Hypothetical send amount: ${dummySendAmount}`);
+        console.log(`Hypothetical receive amount: ${dummyReceiveAmount}`);
+
+        // Pick an actual base amount to swap with
+        const swappedBaseAmount = randomInRange(minBase, maxBase);
+
+        // Setting the base amount will return the receive amount at the new base
+        // You can also call sendAmount and receiveAmount to get the amounts at the
+        // currently set base amount
+        const _recv = bundle.setBaseAmount(swappedBaseAmount);
+        const send = bundle.sendAmount();
+        const recv = bundle.receiveAmount();
+        console.log(`Swapped base amount: ${swappedBaseAmount}`);
+        console.log(`Send amount: ${send}`);
+        console.log(`Receive amount: ${recv}`);
+
+        // 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);
+    }
+}
+
+/**
+ * Generate a random value in the given range
+ */
+function randomInRange(min: bigint, max: bigint): bigint {
+    return min + BigInt(Math.floor(Math.random() * (Number(max) - Number(min))));
+}
+
+// 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/examples/order_book_depth.ts

@@ -0,0 +1,41 @@
+/**
+ * Example of using the Renegade External Match Client to fetch order book depth.
+ *
+ * This example demonstrates how to create a client and request order book depth for a given base token mint.
+ */
+
+import { ExternalMatchClient } from "../index";
+import type { OrderBookDepth } from "../src/types";
+
+// Get API credentials from environment variables
+const API_KEY = process.env.EXTERNAL_MATCH_KEY || "";
+const API_SECRET = process.env.EXTERNAL_MATCH_SECRET || "";
+
+// 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);
+}
+
+// Create the external match client
+console.log("API KEY", API_KEY);
+const client = ExternalMatchClient.newSepoliaClient(API_KEY, API_SECRET);
+
+// Example base token mint (USDC)
+const WETH = "0xc3414a7ef14aaaa9c4522dfc00a4e66e74e9c25a";
+
+async function main() {
+    try {
+        console.log("Fetching order book depth for", WETH);
+        const depth = (await client.getOrderBookDepth(WETH)) as OrderBookDepth;
+        console.log("Order book depth:", JSON.stringify(depth, null, 2));
+    } catch (error) {
+        console.error("Error:", error);
+    }
+}
+
+// Only run if this file is being executed directly
+if (require.main === module) {
+    main().catch(console.error);
+}

package/examples/shared_bundle.ts

@@ -0,0 +1,112 @@
+/**
+ * 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 { AssembleExternalMatchOptions, 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 { arbitrumSepolia } 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-rollup.arbitrum.io/rpc";
+
+// 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: arbitrumSepolia,
+    transport: http(RPC_URL),
+});
+
+// Create the external match client
+console.log("API KEY", API_KEY);
+const client = ExternalMatchClient.newSepoliaClient(API_KEY, API_SECRET);
+
+// Example order for USDC/WETH pair
+const order: ExternalOrder = {
+    quote_mint: "0xdf8d259c04020562717557f2b5a3cf28e92707d1", // USDC
+    base_mint: "0xc3414a7ef14aaaa9c4522dfc00a4e66e74e9c25a", // WETH
+    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;
+}
+
+// Run the examples
+async function main() {
+    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 options = AssembleExternalMatchOptions.new().withAllowShared(true);
+        const bundle = await client.assembleQuoteWithOptions(quote, options);
+
+        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);
+    }
+}
+
+// Only run if this file is being executed directly
+if (require.main === module) {
+    main().catch(console.error);
+}

package/index.ts

@@ -4,7 +4,12 @@
  */
 
 // Export main client
-export { ExternalMatchClient, ExternalMatchClientError, RequestQuoteOptions, AssembleExternalMatchOptions } from './src/client';
+export {
+    ExternalMatchClient,
+    ExternalMatchClientError,
+    RequestQuoteOptions,
+    AssembleExternalMatchOptions,
+} from "./src/client";
 
 // Export types
 export type {
@@ -23,8 +28,8 @@ export type {
     ExternalQuoteRequest,
     ExternalQuoteResponse,
     AssembleExternalMatchRequest,
-    ExternalMatchResponse
-} from './src/types';
+    ExternalMatchResponse,
+} from "./src/types/index";
 
 // Export enums
-export { OrderSide } from './src/types';
+export { OrderSide } from "./src/types/index";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@renegade-fi/renegade-sdk",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "A TypeScript client for interacting with the Renegade Darkpool API",
   "module": "index.ts",
   "type": "module",
@@ -9,7 +9,8 @@
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "update-version": "bash scripts/update-version.sh",
-    "prepublishOnly": "npm run update-version && npm run build"
+    "prepublishOnly": "npm run update-version && npm run build",
+    "check": "biome check --write ."
   },
   "keywords": [
     "renegade",
@@ -24,13 +25,14 @@
   "license": "MIT",
   "dependencies": {
     "@noble/hashes": "^1.7.1",
-    "json-bigint": "^1.0.0"
+    "json-bigint": "^1.0.0",
+    "viem": "^2.23.15"
   },
   "devDependencies": {
+    "@biomejs/biome": "^1.9.4",
     "@types/bun": "latest",
     "@types/json-bigint": "^1.0.4",
-    "typescript": "^5",
-    "viem": "^2.23.15"
+    "typescript": "^5"
   },
   "repository": {
     "type": "git",
@@ -39,4 +41,4 @@
   "engines": {
     "node": ">=18"
   }
-}
+}