@compass-labs/api-sdk 2.2.21 → 2.2.22-rc.0

package/docs/models/components/credittransferresponseeip712.md

@@ -0,0 +1,97 @@
+# CreditTransferResponseEip712
+
+
+## Supported Types
+
+### `components.BatchedSafeOperationsResponseOutput`
+
+```typescript
+const value: components.BatchedSafeOperationsResponseOutput = {
+  domain: {
+    chainId: 359509,
+    verifyingContract: "<value>",
+  },
+  types: {
+    eip712Domain: [],
+    safeTx: [],
+  },
+  primaryType: "SafeTx",
+  message: {
+    to: "<value>",
+    value: "<value>",
+    data: "<value>",
+    operation: 0,
+    safeTxGas: "<value>",
+    baseGas: "<value>",
+    gasPrice: "<value>",
+    gasToken: "<value>",
+    refundReceiver: "<value>",
+    nonce: "<value>",
+  },
+};
+```
+
+### `components.Permit2TypedDataOutput`
+
+```typescript
+const value: components.Permit2TypedDataOutput = {
+  types: {
+    eip712Domain: [
+      {
+        name: "name",
+        type: "string",
+      },
+      {
+        name: "chainId",
+        type: "uint256",
+      },
+      {
+        name: "verifyingContract",
+        type: "address",
+      },
+    ],
+    tokenPermissions: [
+      {
+        name: "token",
+        type: "address",
+      },
+      {
+        name: "amount",
+        type: "uint256",
+      },
+    ],
+    permitTransferFrom: [
+      {
+        name: "permitted",
+        type: "TokenPermissions",
+      },
+      {
+        name: "spender",
+        type: "address",
+      },
+      {
+        name: "nonce",
+        type: "uint256",
+      },
+      {
+        name: "deadline",
+        type: "uint256",
+      },
+    ],
+  },
+  domain: {
+    chainId: 659817,
+    verifyingContract: "<value>",
+  },
+  message: {
+    permitted: {
+      token: "<value>",
+      amount: 387057,
+    },
+    spender: "<value>",
+    nonce: 382019,
+    deadline: 22738,
+  },
+};
+```
+

package/docs/sdks/credit/README.md

@@ -7,7 +7,7 @@
 * [creditPositions](#creditpositions) - List credit positions
 * [creditCreateAccount](#creditcreateaccount) - Create credit account
 * [creditBorrow](#creditborrow) - Borrow against collateral
-* [creditTransfer](#credittransfer) - Get Permit2 signature data for Credit Account transfer
+* [creditTransfer](#credittransfer) - Transfer tokens to/from Credit Account
 * [creditRepay](#creditrepay) - Repay debt and withdraw collateral
 * [creditBundle](#creditbundle) - Execute multiple credit actions atomically
 
@@ -277,16 +277,17 @@ run();
 
 ## creditTransfer
 
-Generate Permit2 EIP-712 typed data for transferring tokens from the owner's EOA
-to a Credit Account.
+Transfer tokens between the owner's EOA and their Credit Account.
 
-The owner signs the returned EIP-712 data, then includes the signature in a `/v2/credit/borrow`
-or `/v2/credit/repay` request to atomically pull tokens from their EOA as part of the bundle.
+**DEPOSIT** (EOA → Credit Account):
+- With `gas_sponsorship=true`: returns Permit2 EIP-712 typed data to sign. The gas sponsor
+  calls `permitTransferFrom` to pull tokens (1 signature).
+- With `gas_sponsorship=false`: returns an unsigned ERC-20 transfer transaction.
 
-**Flow:**
-1. Call this endpoint to get the Permit2 typed data
-2. Sign the typed data with the owner's wallet
-3. Call `/v2/credit/borrow` or `/v2/credit/repay` with the `permit2_signature`, `permit2_nonce`, and `permit2_deadline` fields
+**WITHDRAW** (Credit Account → EOA):
+- With `gas_sponsorship=true`: returns SafeTx EIP-712 typed data to sign. The gas sponsor
+  broadcasts the `execTransaction` (1 signature).
+- With `gas_sponsorship=false`: returns an unsigned `execTransaction`.
 
 ### Example Usage
 
@@ -304,6 +305,7 @@ async function run() {
     chain: "base",
     token: "USDC",
     amount: 100,
+    action: "DEPOSIT",
   });
 
   console.log(result);
@@ -332,6 +334,7 @@ async function run() {
     chain: "base",
     token: "USDC",
     amount: 100,
+    action: "DEPOSIT",
   });
   if (res.ok) {
     const { value: result } = res;

package/docs/sdks/gassponsorship/README.md

@@ -14,12 +14,12 @@ Prepare a gas-sponsored transaction from signed EIP-712 typed data.
 Submit the `owner`'s off-chain signature along with the EIP-712 typed data that was signed. Returns an unsigned transaction for the `sender` to sign and broadcast.
 
 **How gas sponsorship works:**
-1. Call an endpoint with `gas_sponsorship=true` (e.g., [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account), [/earn/manage](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position)) to get EIP-712 typed data
+1. Call an endpoint with `gas_sponsorship=true` (e.g., [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account), [/earn/manage](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position), [/credit/transfer](https://docs.compasslabs.ai/v2/api-reference/credit/transfer-tokens-tofrom-account)) to get EIP-712 typed data
 2. Owner signs the typed data off-chain
 3. Submit signature + typed data to this endpoint
 4. Sender signs and broadcasts the returned transaction, paying gas on behalf of the owner
 
-**Note:** For gas-sponsored deposits via [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account), the owner must first set up a Permit2 allowance using [/approve_transfer](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/approve-token-transfer) (once per token).
+**Note:** For gas-sponsored deposits via [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account) or [/credit/transfer](https://docs.compasslabs.ai/v2/api-reference/credit/transfer-tokens-tofrom-account), the owner must first set up a Permit2 allowance using [/approve_transfer](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/approve-token-transfer) (once per token).
 
 ### Example Usage
 
@@ -217,7 +217,7 @@ run();
 
 Set up a one-time Permit2 allowance for gas-sponsored token transfers.
 
-Only required when using [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account) with `gas_sponsorship=true`. This allowance only needs to be set up once per token.
+Required when using [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account) or [/credit/transfer](https://docs.compasslabs.ai/v2/api-reference/credit/transfer-tokens-tofrom-account) with `gas_sponsorship=true`. This allowance only needs to be set up once per token.
 
 **With gas sponsorship (`gas_sponsorship=true`):**
 - Returns EIP-712 typed data for the owner to sign off-chain

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compass-labs/api-sdk",
-  "version": "2.2.21",
+  "version": "2.2.22-rc.0",
   "author": "royalnine",
   "type": "module",
   "tshy": {

package/src/funcs/creditCreditTransfer.ts

@@ -26,19 +26,20 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get Permit2 signature data for Credit Account transfer
+ * Transfer tokens to/from Credit Account
  *
  * @remarks
- * Generate Permit2 EIP-712 typed data for transferring tokens from the owner's EOA
- * to a Credit Account.
+ * Transfer tokens between the owner's EOA and their Credit Account.
  *
- * The owner signs the returned EIP-712 data, then includes the signature in a `/v2/credit/borrow`
- * or `/v2/credit/repay` request to atomically pull tokens from their EOA as part of the bundle.
+ * **DEPOSIT** (EOA → Credit Account):
+ * - With `gas_sponsorship=true`: returns Permit2 EIP-712 typed data to sign. The gas sponsor
+ *   calls `permitTransferFrom` to pull tokens (1 signature).
+ * - With `gas_sponsorship=false`: returns an unsigned ERC-20 transfer transaction.
  *
- * **Flow:**
- * 1. Call this endpoint to get the Permit2 typed data
- * 2. Sign the typed data with the owner's wallet
- * 3. Call `/v2/credit/borrow` or `/v2/credit/repay` with the `permit2_signature`, `permit2_nonce`, and `permit2_deadline` fields
+ * **WITHDRAW** (Credit Account → EOA):
+ * - With `gas_sponsorship=true`: returns SafeTx EIP-712 typed data to sign. The gas sponsor
+ *   broadcasts the `execTransaction` (1 signature).
+ * - With `gas_sponsorship=false`: returns an unsigned `execTransaction`.
  */
 export function creditCreditTransfer(
   client: CompassApiSDKCore,

package/src/funcs/gasSponsorshipGasSponsorshipApproveTransfer.ts

@@ -31,7 +31,7 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Set up a one-time Permit2 allowance for gas-sponsored token transfers.
  *
- * Only required when using [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account) with `gas_sponsorship=true`. This allowance only needs to be set up once per token.
+ * Required when using [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account) or [/credit/transfer](https://docs.compasslabs.ai/v2/api-reference/credit/transfer-tokens-tofrom-account) with `gas_sponsorship=true`. This allowance only needs to be set up once per token.
  *
  * **With gas sponsorship (`gas_sponsorship=true`):**
  * - Returns EIP-712 typed data for the owner to sign off-chain

package/src/funcs/gasSponsorshipGasSponsorshipPrepare.ts

@@ -34,12 +34,12 @@ import { Result } from "../types/fp.js";
  * Submit the `owner`'s off-chain signature along with the EIP-712 typed data that was signed. Returns an unsigned transaction for the `sender` to sign and broadcast.
  *
  * **How gas sponsorship works:**
- * 1. Call an endpoint with `gas_sponsorship=true` (e.g., [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account), [/earn/manage](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position)) to get EIP-712 typed data
+ * 1. Call an endpoint with `gas_sponsorship=true` (e.g., [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account), [/earn/manage](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position), [/credit/transfer](https://docs.compasslabs.ai/v2/api-reference/credit/transfer-tokens-tofrom-account)) to get EIP-712 typed data
  * 2. Owner signs the typed data off-chain
  * 3. Submit signature + typed data to this endpoint
  * 4. Sender signs and broadcasts the returned transaction, paying gas on behalf of the owner
  *
- * **Note:** For gas-sponsored deposits via [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account), the owner must first set up a Permit2 allowance using [/approve_transfer](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/approve-token-transfer) (once per token).
+ * **Note:** For gas-sponsored deposits via [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account) or [/credit/transfer](https://docs.compasslabs.ai/v2/api-reference/credit/transfer-tokens-tofrom-account), the owner must first set up a Permit2 allowance using [/approve_transfer](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/approve-token-transfer) (once per token).
  */
 export function gasSponsorshipGasSponsorshipPrepare(
   client: CompassApiSDKCore,

package/src/lib/config.ts

@@ -62,7 +62,7 @@ export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.1",
   sdkVersion: "2.0.0",
-  genVersion: "2.839.0",
+  genVersion: "2.841.0",
   userAgent:
-    "speakeasy-sdk/typescript 2.0.0 2.839.0 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 2.0.0 2.841.0 0.0.1 @compass-labs/api-sdk",
 } as const;

package/src/models/components/credittransferrequest.ts

@@ -3,6 +3,8 @@
  */
 
 import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
 import { Chain, Chain$outboundSchema } from "./chain.js";
 
 /**
@@ -10,6 +12,20 @@ import { Chain, Chain$outboundSchema } from "./chain.js";
  */
 export type CreditTransferRequestAmount = number | string;
 
+/**
+ * Whether you are depositing to or withdrawing from your credit account.
+ */
+export const CreditTransferRequestAction = {
+  Deposit: "DEPOSIT",
+  Withdraw: "WITHDRAW",
+} as const;
+/**
+ * Whether you are depositing to or withdrawing from your credit account.
+ */
+export type CreditTransferRequestAction = ClosedEnum<
+  typeof CreditTransferRequestAction
+>;
+
 export type CreditTransferRequest = {
   /**
    * The owner's wallet address (EOA).
@@ -20,13 +36,25 @@ export type CreditTransferRequest = {
    */
   chain: Chain;
   /**
-   * The token to transfer from the EOA to the Credit Account.
+   * The token to transfer.
    */
   token: string;
   /**
    * The amount of tokens to transfer (in token units, not wei).
    */
   amount: number | string;
+  /**
+   * Whether you are depositing to or withdrawing from your credit account.
+   */
+  action: CreditTransferRequestAction;
+  /**
+   * Optionally request gas sponsorship. If set to `true`, EIP-712 signature data will be returned that must be signed by the `owner` and submitted to the `/gas_sponsorship/prepare` endpoint.
+   */
+  gasSponsorship?: boolean | undefined;
+  /**
+   * The address that will call Permit2's permitTransferFrom to execute the transfer. When `action` is 'DEPOSIT' and `gas_sponsorship` is `true`: - If provided, the signature will authorize this address (typically a gas sponsor) to pull tokens. - If not provided, defaults to the Credit Account (Safe) address, allowing the transfer to be included in a bundle transaction where the Safe pulls the tokens itself.
+   */
+  spender?: string | null | undefined;
 };
 
 /** @internal */
@@ -49,12 +77,20 @@ export function creditTransferRequestAmountToJSON(
   );
 }
 
+/** @internal */
+export const CreditTransferRequestAction$outboundSchema: z.ZodNativeEnum<
+  typeof CreditTransferRequestAction
+> = z.nativeEnum(CreditTransferRequestAction);
+
 /** @internal */
 export type CreditTransferRequest$Outbound = {
   owner: string;
   chain: string;
   token: string;
   amount: number | string;
+  action: string;
+  gas_sponsorship?: boolean | undefined;
+  spender?: string | null | undefined;
 };
 
 /** @internal */
@@ -67,6 +103,13 @@ export const CreditTransferRequest$outboundSchema: z.ZodType<
   chain: Chain$outboundSchema,
   token: z.string(),
   amount: z.union([z.number(), z.string()]),
+  action: CreditTransferRequestAction$outboundSchema,
+  gasSponsorship: z.boolean().optional(),
+  spender: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    gasSponsorship: "gas_sponsorship",
+  });
 });
 
 export function creditTransferRequestToJSON(

package/src/models/components/credittransferresponse.ts

@@ -7,22 +7,65 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  BatchedSafeOperationsResponseOutput,
+  BatchedSafeOperationsResponseOutput$inboundSchema,
+} from "./batchedsafeoperationsresponseoutput.js";
 import {
   Permit2TypedDataOutput,
   Permit2TypedDataOutput$inboundSchema,
 } from "./permit2typeddataoutput.js";
+import {
+  UnsignedTransaction,
+  UnsignedTransaction$inboundSchema,
+} from "./unsignedtransaction.js";
+
+export type CreditTransferResponseEip712 =
+  | BatchedSafeOperationsResponseOutput
+  | Permit2TypedDataOutput;
 
 export type CreditTransferResponse = {
-  eip712: Permit2TypedDataOutput;
+  transaction?: UnsignedTransaction | null | undefined;
+  eip712?:
+    | BatchedSafeOperationsResponseOutput
+    | Permit2TypedDataOutput
+    | null
+    | undefined;
 };
 
+/** @internal */
+export const CreditTransferResponseEip712$inboundSchema: z.ZodType<
+  CreditTransferResponseEip712,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  BatchedSafeOperationsResponseOutput$inboundSchema,
+  Permit2TypedDataOutput$inboundSchema,
+]);
+
+export function creditTransferResponseEip712FromJSON(
+  jsonString: string,
+): SafeParseResult<CreditTransferResponseEip712, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreditTransferResponseEip712$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreditTransferResponseEip712' from JSON`,
+  );
+}
+
 /** @internal */
 export const CreditTransferResponse$inboundSchema: z.ZodType<
   CreditTransferResponse,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  eip_712: Permit2TypedDataOutput$inboundSchema,
+  transaction: z.nullable(UnsignedTransaction$inboundSchema).optional(),
+  eip_712: z.nullable(
+    z.union([
+      BatchedSafeOperationsResponseOutput$inboundSchema,
+      Permit2TypedDataOutput$inboundSchema,
+    ]),
+  ).optional(),
 }).transform((v) => {
   return remap$(v, {
     "eip_712": "eip712",

package/src/sdk/credit.ts

@@ -84,19 +84,20 @@ export class Credit extends ClientSDK {
   }
 
   /**
-   * Get Permit2 signature data for Credit Account transfer
+   * Transfer tokens to/from Credit Account
    *
    * @remarks
-   * Generate Permit2 EIP-712 typed data for transferring tokens from the owner's EOA
-   * to a Credit Account.
+   * Transfer tokens between the owner's EOA and their Credit Account.
    *
-   * The owner signs the returned EIP-712 data, then includes the signature in a `/v2/credit/borrow`
-   * or `/v2/credit/repay` request to atomically pull tokens from their EOA as part of the bundle.
+   * **DEPOSIT** (EOA → Credit Account):
+   * - With `gas_sponsorship=true`: returns Permit2 EIP-712 typed data to sign. The gas sponsor
+   *   calls `permitTransferFrom` to pull tokens (1 signature).
+   * - With `gas_sponsorship=false`: returns an unsigned ERC-20 transfer transaction.
    *
-   * **Flow:**
-   * 1. Call this endpoint to get the Permit2 typed data
-   * 2. Sign the typed data with the owner's wallet
-   * 3. Call `/v2/credit/borrow` or `/v2/credit/repay` with the `permit2_signature`, `permit2_nonce`, and `permit2_deadline` fields
+   * **WITHDRAW** (Credit Account → EOA):
+   * - With `gas_sponsorship=true`: returns SafeTx EIP-712 typed data to sign. The gas sponsor
+   *   broadcasts the `execTransaction` (1 signature).
+   * - With `gas_sponsorship=false`: returns an unsigned `execTransaction`.
    */
   async creditTransfer(
     request: components.CreditTransferRequest,

package/src/sdk/gassponsorship.ts

@@ -18,12 +18,12 @@ export class GasSponsorship extends ClientSDK {
    * Submit the `owner`'s off-chain signature along with the EIP-712 typed data that was signed. Returns an unsigned transaction for the `sender` to sign and broadcast.
    *
    * **How gas sponsorship works:**
-   * 1. Call an endpoint with `gas_sponsorship=true` (e.g., [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account), [/earn/manage](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position)) to get EIP-712 typed data
+   * 1. Call an endpoint with `gas_sponsorship=true` (e.g., [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account), [/earn/manage](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position), [/credit/transfer](https://docs.compasslabs.ai/v2/api-reference/credit/transfer-tokens-tofrom-account)) to get EIP-712 typed data
    * 2. Owner signs the typed data off-chain
    * 3. Submit signature + typed data to this endpoint
    * 4. Sender signs and broadcasts the returned transaction, paying gas on behalf of the owner
    *
-   * **Note:** For gas-sponsored deposits via [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account), the owner must first set up a Permit2 allowance using [/approve_transfer](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/approve-token-transfer) (once per token).
+   * **Note:** For gas-sponsored deposits via [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account) or [/credit/transfer](https://docs.compasslabs.ai/v2/api-reference/credit/transfer-tokens-tofrom-account), the owner must first set up a Permit2 allowance using [/approve_transfer](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/approve-token-transfer) (once per token).
    */
   async gasSponsorshipPrepare(
     request: components.SponsorGasRequest,
@@ -42,7 +42,7 @@ export class GasSponsorship extends ClientSDK {
    * @remarks
    * Set up a one-time Permit2 allowance for gas-sponsored token transfers.
    *
-   * Only required when using [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account) with `gas_sponsorship=true`. This allowance only needs to be set up once per token.
+   * Required when using [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account) or [/credit/transfer](https://docs.compasslabs.ai/v2/api-reference/credit/transfer-tokens-tofrom-account) with `gas_sponsorship=true`. This allowance only needs to be set up once per token.
    *
    * **With gas sponsorship (`gas_sponsorship=true`):**
    * - Returns EIP-712 typed data for the owner to sign off-chain