@renegade-fi/renegade-sdk 0.1.7 → 0.1.8

package/bun.lock

@@ -0,0 +1,80 @@
+{
+  "lockfileVersion": 1,
+  "workspaces": {
+    "": {
+      "name": "renegade-sdk",
+      "dependencies": {
+        "@noble/hashes": "^1.7.1",
+        "json-bigint": "^1.0.0",
+      },
+      "devDependencies": {
+        "@biomejs/biome": "^1.9.4",
+        "@types/bun": "latest",
+        "@types/json-bigint": "^1.0.4",
+        "typescript": "^5",
+        "viem": "^2.23.15",
+      },
+    },
+  },
+  "packages": {
+    "@adraffy/ens-normalize": ["@adraffy/ens-normalize@1.11.0", "", {}, "sha512-/3DDPKHqqIqxUULp8yP4zODUY1i+2xvVWsv8A79xGWdCAG+8sb0hRh0Rk2QyOJUnnbyPUAZYcpBuRe3nS2OIUg=="],
+
+    "@biomejs/biome": ["@biomejs/biome@1.9.4", "", { "optionalDependencies": { "@biomejs/cli-darwin-arm64": "1.9.4", "@biomejs/cli-darwin-x64": "1.9.4", "@biomejs/cli-linux-arm64": "1.9.4", "@biomejs/cli-linux-arm64-musl": "1.9.4", "@biomejs/cli-linux-x64": "1.9.4", "@biomejs/cli-linux-x64-musl": "1.9.4", "@biomejs/cli-win32-arm64": "1.9.4", "@biomejs/cli-win32-x64": "1.9.4" }, "bin": { "biome": "bin/biome" } }, "sha512-1rkd7G70+o9KkTn5KLmDYXihGoTaIGO9PIIN2ZB7UJxFrWw04CZHPYiMRjYsaDvVV7hP1dYNRLxSANLaBFGpog=="],
+
+    "@biomejs/cli-darwin-arm64": ["@biomejs/cli-darwin-arm64@1.9.4", "", { "os": "darwin", "cpu": "arm64" }, "sha512-bFBsPWrNvkdKrNCYeAp+xo2HecOGPAy9WyNyB/jKnnedgzl4W4Hb9ZMzYNbf8dMCGmUdSavlYHiR01QaYR58cw=="],
+
+    "@biomejs/cli-darwin-x64": ["@biomejs/cli-darwin-x64@1.9.4", "", { "os": "darwin", "cpu": "x64" }, "sha512-ngYBh/+bEedqkSevPVhLP4QfVPCpb+4BBe2p7Xs32dBgs7rh9nY2AIYUL6BgLw1JVXV8GlpKmb/hNiuIxfPfZg=="],
+
+    "@biomejs/cli-linux-arm64": ["@biomejs/cli-linux-arm64@1.9.4", "", { "os": "linux", "cpu": "arm64" }, "sha512-fJIW0+LYujdjUgJJuwesP4EjIBl/N/TcOX3IvIHJQNsAqvV2CHIogsmA94BPG6jZATS4Hi+xv4SkBBQSt1N4/g=="],
+
+    "@biomejs/cli-linux-arm64-musl": ["@biomejs/cli-linux-arm64-musl@1.9.4", "", { "os": "linux", "cpu": "arm64" }, "sha512-v665Ct9WCRjGa8+kTr0CzApU0+XXtRgwmzIf1SeKSGAv+2scAlW6JR5PMFo6FzqqZ64Po79cKODKf3/AAmECqA=="],
+
+    "@biomejs/cli-linux-x64": ["@biomejs/cli-linux-x64@1.9.4", "", { "os": "linux", "cpu": "x64" }, "sha512-lRCJv/Vi3Vlwmbd6K+oQ0KhLHMAysN8lXoCI7XeHlxaajk06u7G+UsFSO01NAs5iYuWKmVZjmiOzJ0OJmGsMwg=="],
+
+    "@biomejs/cli-linux-x64-musl": ["@biomejs/cli-linux-x64-musl@1.9.4", "", { "os": "linux", "cpu": "x64" }, "sha512-gEhi/jSBhZ2m6wjV530Yy8+fNqG8PAinM3oV7CyO+6c3CEh16Eizm21uHVsyVBEB6RIM8JHIl6AGYCv6Q6Q9Tg=="],
+
+    "@biomejs/cli-win32-arm64": ["@biomejs/cli-win32-arm64@1.9.4", "", { "os": "win32", "cpu": "arm64" }, "sha512-tlbhLk+WXZmgwoIKwHIHEBZUwxml7bRJgk0X2sPyNR3S93cdRq6XulAZRQJ17FYGGzWne0fgrXBKpl7l4M87Hg=="],
+
+    "@biomejs/cli-win32-x64": ["@biomejs/cli-win32-x64@1.9.4", "", { "os": "win32", "cpu": "x64" }, "sha512-8Y5wMhVIPaWe6jw2H+KlEm4wP/f7EW3810ZLmDlrEEy5KvBsb9ECEfu/kMWD484ijfQ8+nIi0giMgu9g1UAuuA=="],
+
+    "@noble/curves": ["@noble/curves@1.8.1", "", { "dependencies": { "@noble/hashes": "1.7.1" } }, "sha512-warwspo+UYUPep0Q+vtdVB4Ugn8GGQj8iyB3gnRWsztmUHTI3S1nhdiWNsPUGL0vud7JlRRk1XEu7Lq1KGTnMQ=="],
+
+    "@noble/hashes": ["@noble/hashes@1.7.1", "", {}, "sha512-B8XBPsn4vT/KJAGqDzbwztd+6Yte3P4V7iafm24bxgDe/mlRuK6xmWPuCNrKt2vDafZ8MfJLlchDG/vYafQEjQ=="],
+
+    "@scure/base": ["@scure/base@1.2.4", "", {}, "sha512-5Yy9czTO47mqz+/J8GM6GIId4umdCk1wc1q8rKERQulIoc8VP9pzDcghv10Tl2E7R96ZUx/PhND3ESYUQX8NuQ=="],
+
+    "@scure/bip32": ["@scure/bip32@1.6.2", "", { "dependencies": { "@noble/curves": "~1.8.1", "@noble/hashes": "~1.7.1", "@scure/base": "~1.2.2" } }, "sha512-t96EPDMbtGgtb7onKKqxRLfE5g05k7uHnHRM2xdE6BP/ZmxaLtPek4J4KfVn/90IQNrU1IOAqMgiDtUdtbe3nw=="],
+
+    "@scure/bip39": ["@scure/bip39@1.5.4", "", { "dependencies": { "@noble/hashes": "~1.7.1", "@scure/base": "~1.2.4" } }, "sha512-TFM4ni0vKvCfBpohoh+/lY05i9gRbSwXWngAsF4CABQxoaOHijxuaZ2R6cStDQ5CHtHO9aGJTr4ksVJASRRyMA=="],
+
+    "@types/bun": ["@types/bun@1.2.6", "", { "dependencies": { "bun-types": "1.2.6" } }, "sha512-fY9CAmTdJH1Llx7rugB0FpgWK2RKuHCs3g2cFDYXUutIy1QGiPQxKkGY8owhfZ4MXWNfxwIbQLChgH5gDsY7vw=="],
+
+    "@types/json-bigint": ["@types/json-bigint@1.0.4", "", {}, "sha512-ydHooXLbOmxBbubnA7Eh+RpBzuaIiQjh8WGJYQB50JFGFrdxW7JzVlyEV7fAXw0T2sqJ1ysTneJbiyNLqZRAag=="],
+
+    "@types/node": ["@types/node@22.13.13", "", { "dependencies": { "undici-types": "~6.20.0" } }, "sha512-ClsL5nMwKaBRwPcCvH8E7+nU4GxHVx1axNvMZTFHMEfNI7oahimt26P5zjVCRrjiIWj6YFXfE1v3dEp94wLcGQ=="],
+
+    "@types/ws": ["@types/ws@8.5.14", "", { "dependencies": { "@types/node": "*" } }, "sha512-bd/YFLW+URhBzMXurx7lWByOu+xzU9+kb3RboOteXYDfW+tr+JZa99OyNmPINEGB/ahzKrEuc8rcv4gnpJmxTw=="],
+
+    "abitype": ["abitype@1.0.8", "", { "peerDependencies": { "typescript": ">=5.0.4", "zod": "^3 >=3.22.0" }, "optionalPeers": ["typescript", "zod"] }, "sha512-ZeiI6h3GnW06uYDLx0etQtX/p8E24UaHHBj57RSjK7YBFe7iuVn07EDpOeP451D06sF27VOz9JJPlIKJmXgkEg=="],
+
+    "bignumber.js": ["bignumber.js@9.1.2", "", {}, "sha512-2/mKyZH9K85bzOEfhXDBFZTGd1CTs+5IHpeFQo9luiBG7hghdC851Pj2WAhb6E3R6b9tZj/XKhbg4fum+Kepug=="],
+
+    "bun-types": ["bun-types@1.2.6", "", { "dependencies": { "@types/node": "*", "@types/ws": "~8.5.10" } }, "sha512-FbCKyr5KDiPULUzN/nm5oqQs9nXCHD8dVc64BArxJadCvbNzAI6lUWGh9fSJZWeDIRD38ikceBU8Kj/Uh+53oQ=="],
+
+    "eventemitter3": ["eventemitter3@5.0.1", "", {}, "sha512-GWkBvjiSZK87ELrYOSESUYeVIc9mvLLf/nXalMOS5dYrgZq9o5OVkbZAVM06CVxYsCwH9BDZFPlQTlPA1j4ahA=="],
+
+    "isows": ["isows@1.0.6", "", { "peerDependencies": { "ws": "*" } }, "sha512-lPHCayd40oW98/I0uvgaHKWCSvkzY27LjWLbtzOm64yQ+G3Q5npjjbdppU65iZXkK1Zt+kH9pfegli0AYfwYYw=="],
+
+    "json-bigint": ["json-bigint@1.0.0", "", { "dependencies": { "bignumber.js": "^9.0.0" } }, "sha512-SiPv/8VpZuWbvLSMtTDU8hEfrZWg/mH/nV/b4o0CYbSxu1UIQPLdwKOCIyLQX+VIPO5vrLX3i8qtqFyhdPSUSQ=="],
+
+    "ox": ["ox@0.6.9", "", { "dependencies": { "@adraffy/ens-normalize": "^1.10.1", "@noble/curves": "^1.6.0", "@noble/hashes": "^1.5.0", "@scure/bip32": "^1.5.0", "@scure/bip39": "^1.4.0", "abitype": "^1.0.6", "eventemitter3": "5.0.1" }, "peerDependencies": { "typescript": ">=5.4.0" }, "optionalPeers": ["typescript"] }, "sha512-wi5ShvzE4eOcTwQVsIPdFr+8ycyX+5le/96iAJutaZAvCes1J0+RvpEPg5QDPDiaR0XQQAvZVl7AwqQcINuUug=="],
+
+    "typescript": ["typescript@5.8.2", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-aJn6wq13/afZp/jT9QZmwEjDqqvSGp1VT5GVg+f/t6/oVyrgXM6BY1h9BRh/O5p3PlUPAe+WuiEZOmb/49RqoQ=="],
+
+    "undici-types": ["undici-types@6.20.0", "", {}, "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg=="],
+
+    "viem": ["viem@2.23.15", "", { "dependencies": { "@noble/curves": "1.8.1", "@noble/hashes": "1.7.1", "@scure/bip32": "1.6.2", "@scure/bip39": "1.5.4", "abitype": "1.0.8", "isows": "1.0.6", "ox": "0.6.9", "ws": "8.18.1" }, "peerDependencies": { "typescript": ">=5.0.4" }, "optionalPeers": ["typescript"] }, "sha512-2t9lROkSzj/ciEZ08NqAHZ6c+J1wKLwJ4qpUxcHdVHcLBt6GfO9+ycuZycTT05ckfJ6TbwnMXMa3bMonvhtUMw=="],
+
+    "ws": ["ws@8.18.1", "", { "peerDependencies": { "bufferutil": "^4.0.1", "utf-8-validate": ">=5.0.2" }, "optionalPeers": ["bufferutil", "utf-8-validate"] }, "sha512-RKW2aJZMXeMxVpnZ6bck+RswznaxmzdULiBr6KY7XkTnW8uvt0iT9H5DkHUChXrc+uurzwa0rVI16n/Xzjdz1w=="],
+  }
+}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Renegade External Match Client
+ * A TypeScript client for interacting with the Renegade Darkpool API.
+ */
+export { ExternalMatchClient, ExternalMatchClientError, RequestQuoteOptions, AssembleExternalMatchOptions, } from "./src/client";
+export type { ApiExternalAssetTransfer, ApiTimestampedPrice, ApiExternalMatchResult, FeeTake, ExternalOrder, ApiExternalQuote, ApiSignedExternalQuote, GasSponsorshipInfo, SignedGasSponsorshipInfo, SignedExternalQuote, SettlementTransaction, AtomicMatchApiBundle, ExternalQuoteRequest, ExternalQuoteResponse, AssembleExternalMatchRequest, ExternalMatchResponse, } from "./src/types/index";
+export { OrderSide } from "./src/types/index";

package/dist/index.js

@@ -0,0 +1,8 @@
+/**
+ * Renegade External Match Client
+ * A TypeScript client for interacting with the Renegade Darkpool API.
+ */
+// Export main client
+export { ExternalMatchClient, ExternalMatchClientError, RequestQuoteOptions, AssembleExternalMatchOptions, } from "./src/client";
+// Export enums
+export { OrderSide } from "./src/types/index";

package/dist/src/client.d.ts

@@ -0,0 +1,229 @@
+/**
+ * Client for interacting with the Renegade external matching API.
+ *
+ * This client handles authentication and provides methods for requesting quotes,
+ * assembling matches, and executing trades.
+ */
+import { type ExternalMatchResponse, type ExternalOrder, MalleableExternalMatchResponse, type OrderBookDepth, type SignedExternalQuote, type SupportedTokensResponse, type TokenPricesResponse } from "./types/index";
+/**
+ * Options for requesting a quote.
+ */
+export declare class RequestQuoteOptions {
+    disableGasSponsorship: boolean;
+    gasRefundAddress?: string;
+    refundNativeEth: boolean;
+    /**
+     * Create a new instance of RequestQuoteOptions.
+     */
+    static new(): RequestQuoteOptions;
+    /**
+     * Set whether gas sponsorship should be disabled.
+     */
+    withGasSponsorshipDisabled(disableGasSponsorship: boolean): RequestQuoteOptions;
+    /**
+     * Set the gas refund address.
+     */
+    withGasRefundAddress(gasRefundAddress: string): RequestQuoteOptions;
+    /**
+     * Set whether to refund in native ETH.
+     */
+    withRefundNativeEth(refundNativeEth: boolean): RequestQuoteOptions;
+    /**
+     * Build the request path with query parameters.
+     */
+    buildRequestPath(): string;
+}
+/**
+ * Options for assembling an external match.
+ */
+export declare class AssembleExternalMatchOptions {
+    doGasEstimation: boolean;
+    allowShared: boolean;
+    receiverAddress?: string;
+    updatedOrder?: ExternalOrder;
+    requestGasSponsorship: boolean;
+    gasRefundAddress?: string;
+    /**
+     * Create a new instance of AssembleExternalMatchOptions.
+     */
+    static new(): AssembleExternalMatchOptions;
+    /**
+     * Set whether to do gas estimation.
+     */
+    withGasEstimation(doGasEstimation: boolean): AssembleExternalMatchOptions;
+    /**
+     * Set whether to allow shared gas sponsorship.
+     */
+    withAllowShared(allowShared: boolean): AssembleExternalMatchOptions;
+    /**
+     * Set the receiver address.
+     */
+    withReceiverAddress(receiverAddress: string): AssembleExternalMatchOptions;
+    /**
+     * Set the updated order.
+     */
+    withUpdatedOrder(updatedOrder: ExternalOrder): AssembleExternalMatchOptions;
+    /**
+     * Set whether to request gas sponsorship.
+     * @deprecated Request gas sponsorship when requesting a quote instead
+     */
+    withGasSponsorship(requestGasSponsorship: boolean): AssembleExternalMatchOptions;
+    /**
+     * Set the gas refund address.
+     * @deprecated Request gas sponsorship when requesting a quote instead
+     */
+    withGasRefundAddress(gasRefundAddress: string): AssembleExternalMatchOptions;
+    /**
+     * Build the request path with query parameters.
+     */
+    buildRequestPath(): string;
+}
+/**
+ * Options for assembling a malleable external match.
+ */
+export declare class AssembleMalleableExternalMatchOptions extends AssembleExternalMatchOptions {
+    /**
+     * Create a new instance of AssembleExternalMatchOptions.
+     */
+    static new(): AssembleMalleableExternalMatchOptions;
+    /**
+     * Build the request path with query parameters.
+     */
+    buildRequestPath(): string;
+}
+/**
+ * Error thrown by the ExternalMatchClient.
+ */
+export declare class ExternalMatchClientError extends Error {
+    statusCode?: number;
+    constructor(message: string, statusCode?: number);
+}
+/**
+ * Client for interacting with the Renegade external matching API.
+ */
+export declare class ExternalMatchClient {
+    private apiKey;
+    private httpClient;
+    private relayerHttpClient;
+    /**
+     * Initialize a new ExternalMatchClient.
+     *
+     * @param apiKey The API key for authentication
+     * @param apiSecret The API secret for request signing
+     * @param baseUrl The base URL of the Renegade API
+     */
+    constructor(apiKey: string, apiSecret: string, baseUrl: string, relayerUrl: string);
+    /**
+     * Create a new client configured for the Arbitrum Sepolia testnet.
+     *
+     * @deprecated Use {@link ExternalMatchClient.newArbitrumSepoliaClient} instead
+     */
+    static newSepoliaClient(apiKey: string, apiSecret: string): ExternalMatchClient;
+    /**
+     * Create a new client configured for the Arbitrum Sepolia testnet.
+     *
+     * @param apiKey The API key for authentication
+     * @param apiSecret The API secret for request signing
+     * @param relayerUrl The relayer URL for the client
+     * @returns A new ExternalMatchClient configured for Sepolia
+     */
+    static newArbitrumSepoliaClient(apiKey: string, apiSecret: string): ExternalMatchClient;
+    /**
+     * 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;
+    /**
+     * Create a new client configured for the Arbitrum One mainnet.
+     *
+     * @deprecated Use {@link ExternalMatchClient.newArbitrumOneClient} instead
+     */
+    static newMainnetClient(apiKey: string, apiSecret: string): ExternalMatchClient;
+    /**
+     * Create a new client configured for the Arbitrum One mainnet.
+     *
+     * @param apiKey The API key for authentication
+     * @param apiSecret The API secret for request signing
+     * @returns A new ExternalMatchClient configured for mainnet
+     */
+    static newArbitrumOneClient(apiKey: string, apiSecret: string): ExternalMatchClient;
+    /**
+     * 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;
+    /**
+     * Request a quote for the given order.
+     *
+     * @param order The order to request a quote for
+     * @returns A promise that resolves to a signed quote if one is available, null otherwise
+     * @throws ExternalMatchClientError if the request fails
+     */
+    requestQuote(order: ExternalOrder): Promise<SignedExternalQuote | null>;
+    /**
+     * Request a quote for the given order with custom options.
+     *
+     * @param order The order to request a quote for
+     * @param options Custom options for the quote request
+     * @returns A promise that resolves to a signed quote if one is available, null otherwise
+     * @throws ExternalMatchClientError if the request fails
+     */
+    requestQuoteWithOptions(order: ExternalOrder, options: RequestQuoteOptions): Promise<SignedExternalQuote | null>;
+    /**
+     * Assemble a quote into a match bundle with default options.
+     *
+     * @param quote The signed quote to assemble
+     * @returns A promise that resolves to a match response if assembly succeeds, null otherwise
+     * @throws ExternalMatchClientError if the request fails
+     */
+    assembleQuote(quote: SignedExternalQuote): Promise<ExternalMatchResponse | null>;
+    /**
+     * Assemble a quote into a match bundle with custom options.
+     *
+     * @param quote The signed quote to assemble
+     * @param options Custom options for quote assembly
+     * @returns A promise that resolves to a match response if assembly succeeds, null otherwise
+     * @throws ExternalMatchClientError if the request fails
+     */
+    assembleQuoteWithOptions(quote: SignedExternalQuote, options: AssembleExternalMatchOptions): Promise<ExternalMatchResponse | null>;
+    /**
+     * Assemble a quote into a malleable match bundle with default options.
+     *
+     * @param quote The signed quote to assemble
+     * @returns A promise that resolves to a match response if assembly succeeds, null otherwise
+     * @throws ExternalMatchClientError if the request fails
+     */
+    assembleMalleableQuote(quote: SignedExternalQuote): Promise<MalleableExternalMatchResponse | null>;
+    /**
+     * Assemble a quote into a malleable match bundle with custom options.
+     */
+    assembleMalleableQuoteWithOptions(quote: SignedExternalQuote, options: AssembleMalleableExternalMatchOptions): Promise<MalleableExternalMatchResponse | null>;
+    /**
+     * Get order book depth for a given base token mint.
+     *
+     * @param mint The base token mint address
+     * @returns A promise that resolves to the order book depth
+     * @throws ExternalMatchClientError if the request fails
+     */
+    getOrderBookDepth(mint: string): Promise<OrderBookDepth>;
+    /**
+     * Get a list of supported tokens for external matches
+     */
+    getSupportedTokens(): Promise<SupportedTokensResponse>;
+    /**
+     * Get a list of token prices
+     */
+    getTokenPrices(): Promise<TokenPricesResponse>;
+    /**
+     * Get the headers required for API requests.
+     *
+     * @returns Headers containing the API key and SDK version
+     */
+    private getHeaders;
+}