@compass-labs/api-sdk 2.2.62-rc.0 → 2.2.63-rc.0

package/src/funcs/tokenizedAssetsTokenizedAssetsTransfer.ts

@@ -0,0 +1,193 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.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";
+
+/**
+ * Deposit to / withdraw from a Tokenized Assets Account
+ *
+ * @remarks
+ * Move tokens between the owner's wallet and their Tokenized Assets Account.
+ *
+ * Use `DEPOSIT` to fund the account from the owner's wallet, or `WITHDRAW` to
+ * send tokens from the account back to the owner. Equity orders settle in
+ * USDC; RWA yield assets trade against USDC on Ethereum and Base.
+ *
+ * With `gas_sponsorship=true` the response is EIP-712 typed data the owner
+ * signs off-chain, then submits to `POST /v2/gas_sponsorship/prepare` so the
+ * sponsor broadcasts and pays the gas:
+ *
+ * - **DEPOSIT** returns a Permit2 `PermitTransferFrom`. The owner must first
+ *   grant a one-time token->Permit2 allowance (gaslessly via
+ *   `POST /v2/gas_sponsorship/approve_transfer`).
+ * - **WITHDRAW** returns a Safe transaction the account executes.
+ *
+ * With `gas_sponsorship=false` a DEPOSIT returns an unsigned ERC-20 transfer
+ * the owner broadcasts directly, and a WITHDRAW returns an unsigned Safe
+ * `execTransaction` the owner signs and broadcasts.
+ */
+export function tokenizedAssetsTokenizedAssetsTransfer(
+  client: CompassApiSDKCore,
+  request: components.TokenizedAssetsTransferRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.TokenizedAssetsTransferResponse,
+    | errors.TokenizedAssetsErrorResponse
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.TokenizedAssetsTransferRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.TokenizedAssetsTransferResponse,
+      | errors.TokenizedAssetsErrorResponse
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      components.TokenizedAssetsTransferRequest$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("/v2/tokenized_assets/transfer")();
+
+  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: "v2_tokenized_assets_transfer",
+    oAuth2Scopes: null,
+
+    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,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["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.TokenizedAssetsTransferResponse,
+    | errors.TokenizedAssetsErrorResponse
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.TokenizedAssetsTransferResponse$inboundSchema),
+    M.jsonErr(400, errors.TokenizedAssetsErrorResponse$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 }];
+}

package/src/models/components/index.ts

@@ -299,6 +299,8 @@ export * from "./tokenizedassetssubmitorderrequest.js";
 export * from "./tokenizedassetssubmitorderresponse.js";
 export * from "./tokenizedassetstraderequest.js";
 export * from "./tokenizedassetstraderesponse.js";
+export * from "./tokenizedassetstransferrequest.js";
+export * from "./tokenizedassetstransferresponse.js";
 export * from "./tokenlistresponse.js";
 export * from "./tokenmarketdata.js";
 export * from "./tokenpermissions.js";

package/src/models/components/tokenizedassetstransferrequest.ts

@@ -0,0 +1,124 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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";
+
+/**
+ * The amount of tokens to transfer (in token units, not wei).
+ */
+export type TokenizedAssetsTransferRequestAmount = number | string;
+
+/**
+ * Whether you are depositing to or withdrawing from your Tokenized Assets Account.
+ */
+export const TokenizedAssetsTransferRequestAction = {
+  Deposit: "DEPOSIT",
+  Withdraw: "WITHDRAW",
+} as const;
+/**
+ * Whether you are depositing to or withdrawing from your Tokenized Assets Account.
+ */
+export type TokenizedAssetsTransferRequestAction = ClosedEnum<
+  typeof TokenizedAssetsTransferRequestAction
+>;
+
+export type TokenizedAssetsTransferRequest = {
+  /**
+   * The owner's wallet address (EOA).
+   */
+  owner: string;
+  /**
+   * The chain to use.
+   */
+  chain?: Chain | undefined;
+  /**
+   * The token to transfer. Tokenized-asset orders settle in USDC.
+   */
+  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 Tokenized Assets Account.
+   */
+  action: TokenizedAssetsTransferRequestAction;
+  /**
+   * 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 Tokenized Assets 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 */
+export type TokenizedAssetsTransferRequestAmount$Outbound = number | string;
+
+/** @internal */
+export const TokenizedAssetsTransferRequestAmount$outboundSchema: z.ZodType<
+  TokenizedAssetsTransferRequestAmount$Outbound,
+  z.ZodTypeDef,
+  TokenizedAssetsTransferRequestAmount
+> = z.union([z.number(), z.string()]);
+
+export function tokenizedAssetsTransferRequestAmountToJSON(
+  tokenizedAssetsTransferRequestAmount: TokenizedAssetsTransferRequestAmount,
+): string {
+  return JSON.stringify(
+    TokenizedAssetsTransferRequestAmount$outboundSchema.parse(
+      tokenizedAssetsTransferRequestAmount,
+    ),
+  );
+}
+
+/** @internal */
+export const TokenizedAssetsTransferRequestAction$outboundSchema:
+  z.ZodNativeEnum<typeof TokenizedAssetsTransferRequestAction> = z.nativeEnum(
+    TokenizedAssetsTransferRequestAction,
+  );
+
+/** @internal */
+export type TokenizedAssetsTransferRequest$Outbound = {
+  owner: string;
+  chain?: string | undefined;
+  token: string;
+  amount: number | string;
+  action: string;
+  gas_sponsorship?: boolean | undefined;
+  spender?: string | null | undefined;
+};
+
+/** @internal */
+export const TokenizedAssetsTransferRequest$outboundSchema: z.ZodType<
+  TokenizedAssetsTransferRequest$Outbound,
+  z.ZodTypeDef,
+  TokenizedAssetsTransferRequest
+> = z.object({
+  owner: z.string(),
+  chain: Chain$outboundSchema.optional(),
+  token: z.string(),
+  amount: z.union([z.number(), z.string()]),
+  action: TokenizedAssetsTransferRequestAction$outboundSchema,
+  gasSponsorship: z.boolean().optional(),
+  spender: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    gasSponsorship: "gas_sponsorship",
+  });
+});
+
+export function tokenizedAssetsTransferRequestToJSON(
+  tokenizedAssetsTransferRequest: TokenizedAssetsTransferRequest,
+): string {
+  return JSON.stringify(
+    TokenizedAssetsTransferRequest$outboundSchema.parse(
+      tokenizedAssetsTransferRequest,
+    ),
+  );
+}

package/src/models/components/tokenizedassetstransferresponse.ts

@@ -0,0 +1,93 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * EIP-712 typed data for gas-sponsored execution. Present when `gas_sponsorship=true`. A Permit2 `PermitTransferFrom` for DEPOSIT, or a Safe transaction for WITHDRAW. The owner signs it and submits to `/v2/gas_sponsorship/prepare`.
+ */
+export type TokenizedAssetsTransferResponseEip712 =
+  | BatchedSafeOperationsResponseOutput
+  | Permit2TypedDataOutput;
+
+export type TokenizedAssetsTransferResponse = {
+  /**
+   * Unsigned transaction for direct execution. Present when `gas_sponsorship=false`.
+   */
+  transaction?: UnsignedTransaction | null | undefined;
+  /**
+   * EIP-712 typed data for gas-sponsored execution. Present when `gas_sponsorship=true`. A Permit2 `PermitTransferFrom` for DEPOSIT, or a Safe transaction for WITHDRAW. The owner signs it and submits to `/v2/gas_sponsorship/prepare`.
+   */
+  eip712?:
+    | BatchedSafeOperationsResponseOutput
+    | Permit2TypedDataOutput
+    | null
+    | undefined;
+};
+
+/** @internal */
+export const TokenizedAssetsTransferResponseEip712$inboundSchema: z.ZodType<
+  TokenizedAssetsTransferResponseEip712,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  BatchedSafeOperationsResponseOutput$inboundSchema,
+  Permit2TypedDataOutput$inboundSchema,
+]);
+
+export function tokenizedAssetsTransferResponseEip712FromJSON(
+  jsonString: string,
+): SafeParseResult<TokenizedAssetsTransferResponseEip712, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TokenizedAssetsTransferResponseEip712$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TokenizedAssetsTransferResponseEip712' from JSON`,
+  );
+}
+
+/** @internal */
+export const TokenizedAssetsTransferResponse$inboundSchema: z.ZodType<
+  TokenizedAssetsTransferResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  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",
+  });
+});
+
+export function tokenizedAssetsTransferResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TokenizedAssetsTransferResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TokenizedAssetsTransferResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TokenizedAssetsTransferResponse' from JSON`,
+  );
+}

package/src/sdk/tokenizedassets.ts

@@ -13,6 +13,7 @@ import { tokenizedAssetsTokenizedAssetsPositions } from "../funcs/tokenizedAsset
 import { tokenizedAssetsTokenizedAssetsQuote } from "../funcs/tokenizedAssetsTokenizedAssetsQuote.js";
 import { tokenizedAssetsTokenizedAssetsTransactBuy } from "../funcs/tokenizedAssetsTokenizedAssetsTransactBuy.js";
 import { tokenizedAssetsTokenizedAssetsTransactSell } from "../funcs/tokenizedAssetsTokenizedAssetsTransactSell.js";
+import { tokenizedAssetsTokenizedAssetsTransfer } from "../funcs/tokenizedAssetsTokenizedAssetsTransfer.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
@@ -160,6 +161,40 @@ export class TokenizedAssets extends ClientSDK {
     ));
   }
 
+  /**
+   * Deposit to / withdraw from a Tokenized Assets Account
+   *
+   * @remarks
+   * Move tokens between the owner's wallet and their Tokenized Assets Account.
+   *
+   * Use `DEPOSIT` to fund the account from the owner's wallet, or `WITHDRAW` to
+   * send tokens from the account back to the owner. Equity orders settle in
+   * USDC; RWA yield assets trade against USDC on Ethereum and Base.
+   *
+   * With `gas_sponsorship=true` the response is EIP-712 typed data the owner
+   * signs off-chain, then submits to `POST /v2/gas_sponsorship/prepare` so the
+   * sponsor broadcasts and pays the gas:
+   *
+   * - **DEPOSIT** returns a Permit2 `PermitTransferFrom`. The owner must first
+   *   grant a one-time token->Permit2 allowance (gaslessly via
+   *   `POST /v2/gas_sponsorship/approve_transfer`).
+   * - **WITHDRAW** returns a Safe transaction the account executes.
+   *
+   * With `gas_sponsorship=false` a DEPOSIT returns an unsigned ERC-20 transfer
+   * the owner broadcasts directly, and a WITHDRAW returns an unsigned Safe
+   * `execTransaction` the owner signs and broadcasts.
+   */
+  async tokenizedAssetsTransfer(
+    request: components.TokenizedAssetsTransferRequest,
+    options?: RequestOptions,
+  ): Promise<components.TokenizedAssetsTransferResponse> {
+    return unwrapAsync(tokenizedAssetsTokenizedAssetsTransfer(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Preview a buy/sell quote
    *