@compass-labs/api-sdk 0.5.13 → 0.5.14

package/docs/sdks/transactionbatching/README.md

@@ -0,0 +1,318 @@
+# TransactionBatching
+(*transactionBatching*)
+
+## Overview
+
+### Available Operations
+
+* [authorization](#authorization) - Enable transaction bundling.
+* [execute](#execute) - Construct Bundled Transaction
+* [aaveLoop](#aaveloop) - AAVE leverage long/short
+
+## authorization
+
+Get authorization for bundling transactions.
+
+Currently this is required for every transaction bundle to prevent replay attacks
+and ensure transaction ordering when batching multiple actions into a single
+transaction. The authorization includes a nonce and chain ID to guarantee
+transaction uniqueness and proper network targeting.
+
+### Example Usage
+
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.transactionBatching.authorization({
+    chain: "ethereum:mainnet",
+    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { transactionBatchingAuthorization } from "@compass-labs/api-sdk/funcs/transactionBatchingAuthorization.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await transactionBatchingAuthorization(compassApiSDK, {
+    chain: "ethereum:mainnet",
+    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("transactionBatchingAuthorization failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.MulticallAuthorizationRequest](../../models/components/multicallauthorizationrequest.md)                                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.MulticallAuthorizationResponse](../../models/components/multicallauthorizationresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## execute
+
+Bundle arbitrary transactions together into a single multicall transaction using
+EIP-7702.
+
+This endpoint allows bundling multiple contract calls into a single atomic
+transaction, reducing gas costs and ensuring all operations succeed or fail
+together. The transaction must be authorized using the /authorization endpoint to
+prevent replay attacks.
+
+### Example Usage
+
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.transactionBatching.execute({
+    chain: "base:mainnet",
+    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    signedAuthorization: {
+      nonce: 1000,
+      address: "0xcA11bde05977b3631167028862bE2a173976CA11",
+      chainId: 42161,
+      r: 4.3251085460800106e+76,
+      s: 5.471500338403868e+76,
+      yParity: 0,
+    },
+    actions: [
+      {
+        body: {
+          token: "WETH",
+          contractName: "UniswapV3Router",
+          amount: "1000",
+        },
+      },
+    ],
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { transactionBatchingExecute } from "@compass-labs/api-sdk/funcs/transactionBatchingExecute.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await transactionBatchingExecute(compassApiSDK, {
+    chain: "base:mainnet",
+    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    signedAuthorization: {
+      nonce: 1000,
+      address: "0xcA11bde05977b3631167028862bE2a173976CA11",
+      chainId: 42161,
+      r: 4.3251085460800106e+76,
+      s: 5.471500338403868e+76,
+      yParity: 0,
+    },
+    actions: [
+      {
+        body: {
+          token: "WETH",
+          contractName: "UniswapV3Router",
+          amount: "1000",
+        },
+      },
+    ],
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("transactionBatchingExecute failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.MulticallExecuteRequest](../../models/components/multicallexecuterequest.md)                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.UnsignedMulticallTransaction](../../models/components/unsignedmulticalltransaction.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## aaveLoop
+
+Execute an Aave looping strategy that involves repeated supply and borrow
+operations.
+
+This endpoint creates a multicall transaction that performs a series of operations:
+1. Approves and supplies initial token
+2. For each loop:
+    - Borrows another token
+    - Swaps borrowed token back to supply token
+    - Supplies the swapped tokens
+
+The transaction must be authorized using the /authorization endpoint to prevent replay attacks.
+
+### Example Usage
+
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.transactionBatching.aaveLoop({
+    chain: "base:mainnet",
+    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    signedAuthorization: {
+      nonce: 1000,
+      address: "0xcA11bde05977b3631167028862bE2a173976CA11",
+      chainId: 42161,
+      r: 4.3251085460800106e+76,
+      s: 5.471500338403868e+76,
+      yParity: 0,
+    },
+    collateralToken: "MKR",
+    borrowToken: "FXS",
+    initialCollateralAmount: "1000",
+    multiplier: "2.5",
+    maxSlippagePercent: 2.5,
+    loanToValue: 20.5,
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { transactionBatchingAaveLoop } from "@compass-labs/api-sdk/funcs/transactionBatchingAaveLoop.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await transactionBatchingAaveLoop(compassApiSDK, {
+    chain: "base:mainnet",
+    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    signedAuthorization: {
+      nonce: 1000,
+      address: "0xcA11bde05977b3631167028862bE2a173976CA11",
+      chainId: 42161,
+      r: 4.3251085460800106e+76,
+      s: 5.471500338403868e+76,
+      yParity: 0,
+    },
+    collateralToken: "MKR",
+    borrowToken: "FXS",
+    initialCollateralAmount: "1000",
+    multiplier: "2.5",
+    maxSlippagePercent: 2.5,
+    loanToValue: 20.5,
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("transactionBatchingAaveLoop failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.AaveLoopRequest](../../models/components/aavelooprequest.md)                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.UnsignedMulticallTransaction](../../models/components/unsignedmulticalltransaction.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@compass-labs/api-sdk",
-  "version": "0.5.13",
+  "version": "0.5.14",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compass-labs/api-sdk",
-  "version": "0.5.13",
+  "version": "0.5.14",
   "author": "royalnine",
   "type": "module",
   "bin": {

package/src/funcs/transactionBatchingAaveLoop.ts

@@ -0,0 +1,179 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { CompassAPISDKError } from "../models/errors/compassapisdkerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * AAVE leverage long/short
+ *
+ * @remarks
+ * Execute an Aave looping strategy that involves repeated supply and borrow
+ * operations.
+ *
+ * This endpoint creates a multicall transaction that performs a series of operations:
+ * 1. Approves and supplies initial token
+ * 2. For each loop:
+ *     - Borrows another token
+ *     - Swaps borrowed token back to supply token
+ *     - Supplies the swapped tokens
+ *
+ * The transaction must be authorized using the /authorization endpoint to prevent replay attacks.
+ */
+export function transactionBatchingAaveLoop(
+  client: CompassApiSDKCore,
+  request: components.AaveLoopRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.UnsignedMulticallTransaction,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.AaveLoopRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.UnsignedMulticallTransaction,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.AaveLoopRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v0/multicall/aave/loop")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "multicall_aave_loop",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["422", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.UnsignedMulticallTransaction,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.UnsignedMulticallTransaction$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}