@privy-io/api-types 0.6.1 → 0.8.0

package/src/resources/shared.ts

@@ -0,0 +1,79 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+
+export class Shared extends APIResource {}
+
+/**
+ * A simple success response.
+ */
+export interface SuccessResponse {
+  success: boolean;
+}
+
+/**
+ * A P-256 (secp256r1) public key.
+ */
+export type P256PublicKey = string;
+
+/**
+ * A unique identifier for a key quorum.
+ */
+export type KeyQuorumID = string;
+
+/**
+ * Owner input specifying a Privy user ID.
+ */
+export interface OwnerInputUser {
+  user_id: string;
+}
+
+/**
+ * Owner input specifying a P-256 public key.
+ */
+export interface OwnerInputPublicKey {
+  /**
+   * A P-256 (secp256r1) public key.
+   */
+  public_key: P256PublicKey;
+}
+
+/**
+ * The owner of the resource, specified as a Privy user ID, a P-256 public key, or
+ * null to remove the current owner.
+ */
+export type OwnerInput = OwnerInputUser | OwnerInputPublicKey;
+
+/**
+ * The key quorum ID to set as the owner of the resource. If you provide this, do
+ * not specify an owner.
+ */
+export type OwnerIDInput = string | null;
+
+/**
+ * A monetary value with its currency denomination.
+ */
+export interface CurrencyAmount {
+  /**
+   * Currency code
+   */
+  currency: 'usd';
+
+  /**
+   * The monetary value as a string.
+   */
+  value: string;
+}
+
+export declare namespace Shared {
+  export {
+    type SuccessResponse as SuccessResponse,
+    type P256PublicKey as P256PublicKey,
+    type KeyQuorumID as KeyQuorumID,
+    type OwnerInputUser as OwnerInputUser,
+    type OwnerInputPublicKey as OwnerInputPublicKey,
+    type OwnerInput as OwnerInput,
+    type OwnerIDInput as OwnerIDInput,
+    type CurrencyAmount as CurrencyAmount,
+  };
+}

package/src/resources/swaps.ts

@@ -0,0 +1,136 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+
+export class Swaps extends APIResource {}
+
+/**
+ * Whether the swap amount refers to the input token or output token.
+ */
+export type SwapAmountType = 'exact_input' | 'exact_output';
+
+/**
+ * Input for requesting a token swap quote.
+ */
+export interface SwapQuoteRequest {
+  /**
+   * Amount in base units (e.g., wei for ETH).
+   */
+  amount: string;
+
+  /**
+   * Chain identifier (e.g., "eip155:1" for Ethereum mainnet).
+   */
+  caip2: string;
+
+  /**
+   * Token address to sell, or "native" for the chain's native token.
+   */
+  input_token: string;
+
+  /**
+   * Token address to buy, or "native" for the chain's native token.
+   */
+  output_token: string;
+
+  /**
+   * Whether the swap amount refers to the input token or output token.
+   */
+  amount_type?: SwapAmountType;
+
+  /**
+   * Maximum slippage tolerance in basis points (e.g., 50 for 0.5%). If omitted,
+   * auto-slippage is used.
+   */
+  slippage_bps?: number;
+}
+
+/**
+ * Pricing data for a token swap.
+ */
+export interface SwapQuoteResponse {
+  /**
+   * Chain identifier.
+   */
+  caip2: string;
+
+  /**
+   * Estimated amount of output token in base units.
+   */
+  est_output_amount: string;
+
+  /**
+   * Estimated gas cost in base units of the native token.
+   */
+  gas_estimate: string;
+
+  /**
+   * Amount of input token in base units.
+   */
+  input_amount: string;
+
+  /**
+   * Token address being sold.
+   */
+  input_token: string;
+
+  /**
+   * Minimum output amount accounting for slippage, in base units.
+   */
+  minimum_output_amount: string;
+
+  /**
+   * Token address being bought.
+   */
+  output_token: string;
+}
+
+/**
+ * Input for executing a token swap.
+ */
+export interface SwapRequest {
+  /**
+   * Amount in base units (e.g., wei for ETH).
+   */
+  amount: string;
+
+  /**
+   * Chain identifier (e.g., "eip155:1" for Ethereum mainnet).
+   */
+  caip2: string;
+
+  /**
+   * Token address to sell, or "native" for the chain's native token.
+   */
+  input_token: string;
+
+  /**
+   * Token address to buy, or "native" for the chain's native token.
+   */
+  output_token: string;
+
+  /**
+   * Whether the swap amount refers to the input token or output token.
+   */
+  amount_type?: SwapAmountType;
+
+  /**
+   * Address to receive the output tokens. Defaults to the wallet address if not
+   * specified.
+   */
+  recipient?: string;
+
+  /**
+   * Maximum slippage tolerance in basis points (e.g., 50 for 0.5%).
+   */
+  slippage_bps?: number;
+}
+
+export declare namespace Swaps {
+  export {
+    type SwapAmountType as SwapAmountType,
+    type SwapQuoteRequest as SwapQuoteRequest,
+    type SwapQuoteResponse as SwapQuoteResponse,
+    type SwapRequest as SwapRequest,
+  };
+}

package/src/resources/transactions.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Operations related to transactions
+ */
 export class Transactions extends APIResource {
   /**
    * Get a transaction by transaction ID.
@@ -27,151 +30,226 @@ export class Transactions extends APIResource {
 export interface TransactionScanningRequestBody {
   chain_id: string;
 
-  metadata: TransactionScanningRequestBody.Metadata;
+  /**
+   * Additional information for Blockaid to validate against.
+   */
+  metadata: TransactionScanningMetadata;
 
-  request: TransactionScanningRequestBody.Request;
+  /**
+   * Raw RPC request to execute with the wallet.
+   */
+  request: TransactionScanningRpcRequest;
 }
 
-export namespace TransactionScanningRequestBody {
-  export interface Metadata {
-    domain: string;
-  }
+/**
+ * The response from scanning a transaction.
+ */
+export interface TransactionScanningResponseBody {
+  /**
+   * The simulation result from a transaction scan.
+   */
+  simulation: TransactionScanningSimulationResult;
 
-  export interface Request {
-    method: string;
+  /**
+   * The validation result from a transaction scan.
+   */
+  validation: TransactionScanningValidationResult;
+}
 
-    params: Array<unknown>;
-  }
+/**
+ * Additional information for Blockaid to validate against.
+ */
+export interface TransactionScanningMetadata {
+  domain: string;
 }
 
 /**
- * The response from scanning a transaction.
+ * Raw RPC request to execute with the wallet.
  */
-export interface TransactionScanningResponseBody {
-  simulation: TransactionScanningResponseBody.UnionMember0 | TransactionScanningResponseBody.UnionMember1;
+export interface TransactionScanningRpcRequest {
+  method: string;
 
-  validation: TransactionScanningResponseBody.UnionMember0 | TransactionScanningResponseBody.UnionMember1;
+  params: Array<unknown>;
 }
 
-export namespace TransactionScanningResponseBody {
-  export interface UnionMember0 {
-    error: string;
+/**
+ * A failed validation result from a transaction scan.
+ */
+export interface TransactionScanningValidationErrorResult {
+  error: string;
 
-    status: 'Error';
-  }
+  status: 'Error';
+}
 
-  export interface UnionMember1 {
-    assets_diffs: Array<UnionMember1.AssetsDiff>;
+/**
+ * A successful validation result from a transaction scan.
+ */
+export interface TransactionScanningValidationSuccessResult {
+  result_type: string;
 
-    exposures: Array<UnionMember1.Exposure>;
+  status: 'Success';
+}
 
-    status: 'Success';
+/**
+ * The validation result from a transaction scan.
+ */
+export type TransactionScanningValidationResult =
+  | TransactionScanningValidationErrorResult
+  | TransactionScanningValidationSuccessResult;
 
-    params?: UnionMember1.Params;
-  }
+/**
+ * Information about the moving asset in a transaction scan.
+ */
+export interface TransactionScanningAssetInfo {
+  decimals?: number;
 
-  export namespace UnionMember1 {
-    export interface AssetsDiff {
-      asset: AssetsDiff.Asset;
+  logo_url?: string;
 
-      in: Array<AssetsDiff.In>;
+  name?: string;
 
-      out: Array<AssetsDiff.Out>;
-    }
+  symbol?: string;
 
-    export namespace AssetsDiff {
-      export interface Asset {
-        decimals?: number;
+  type?: string;
+}
 
-        logo_url?: string;
+/**
+ * The value of an asset in a transaction scan result.
+ */
+export interface TransactionScanningAssetValue {
+  usd_price?: string;
 
-        name?: string;
+  value?: string;
+}
 
-        symbol?: string;
+/**
+ * An asset diff representing assets entering/leaving a wallet.
+ */
+export interface TransactionScanningAssetDiff {
+  /**
+   * Information about the moving asset in a transaction scan.
+   */
+  asset: TransactionScanningAssetInfo;
 
-        type?: string;
-      }
+  in: Array<TransactionScanningAssetValue>;
 
-      export interface In {
-        usd_price?: string;
+  out: Array<TransactionScanningAssetValue>;
+}
 
-        value?: string;
-      }
+/**
+ * An exposure representing assets approved to spend.
+ */
+export interface TransactionScanningExposure {
+  /**
+   * Information about the moving asset in a transaction scan.
+   */
+  asset: TransactionScanningAssetInfo;
 
-      export interface Out {
-        usd_price?: string;
+  spenders: { [key: string]: TransactionScanningAssetValue };
+}
 
-        value?: string;
-      }
-    }
+/**
+ * Decoded calldata from a scanned transaction.
+ */
+export interface TransactionScanningCalldata {
+  function_selector: string;
 
-    export interface Exposure {
-      asset: Exposure.Asset;
+  function_declaration?: string;
 
-      spenders: { [key: string]: Exposure.Spenders };
-    }
+  function_signature?: string;
+}
 
-    export namespace Exposure {
-      export interface Asset {
-        decimals?: number;
+/**
+ * The parameters of the scanned transaction.
+ */
+export interface TransactionScanningParams {
+  block_tag?: string;
 
-        logo_url?: string;
+  /**
+   * Decoded calldata from a scanned transaction.
+   */
+  calldata?: TransactionScanningCalldata;
 
-        name?: string;
+  chain?: string;
 
-        symbol?: string;
+  data?: string;
 
-        type?: string;
-      }
+  from?: string;
 
-      export interface Spenders {
-        usd_price?: string;
+  gas?: string;
 
-        value?: string;
-      }
-    }
+  gas_price?: string;
 
-    export interface Params {
-      block_tag?: string;
+  to?: string;
 
-      calldata?: Params.Calldata;
+  value?: string;
+}
 
-      chain?: string;
+/**
+ * A failed simulation result from a transaction scan.
+ */
+export interface TransactionScanningSimulationErrorResult {
+  error: string;
 
-      data?: string;
+  status: 'Error';
+}
+
+/**
+ * A successful simulation result from a transaction scan.
+ */
+export interface TransactionScanningSimulationSuccessResult {
+  assets_diffs: Array<TransactionScanningAssetDiff>;
+
+  exposures: Array<TransactionScanningExposure>;
 
-      from?: string;
+  status: 'Success';
+
+  /**
+   * The parameters of the scanned transaction.
+   */
+  params?: TransactionScanningParams;
+}
 
-      gas?: string;
+/**
+ * The simulation result from a transaction scan.
+ */
+export type TransactionScanningSimulationResult =
+  | TransactionScanningSimulationErrorResult
+  | TransactionScanningSimulationSuccessResult;
 
-      gas_price?: string;
+/**
+ * A list of transactions.
+ */
+export interface TransactionList {
+  transactions: Array<TransactionList.Transaction>;
+}
 
-      to?: string;
+export namespace TransactionList {
+  export interface Transaction {
+    id: string;
 
-      value?: string;
-    }
+    caip2: string;
 
-    export namespace Params {
-      export interface Calldata {
-        function_selector: string;
+    created_at: number;
 
-        function_declaration?: string;
+    status:
+      | 'broadcasted'
+      | 'confirmed'
+      | 'execution_reverted'
+      | 'failed'
+      | 'replaced'
+      | 'finalized'
+      | 'provider_error'
+      | 'pending';
 
-        function_signature?: string;
-      }
-    }
-  }
+    transaction_hash: string | null;
 
-  export interface UnionMember0 {
-    error: string;
+    wallet_id: string;
 
-    status: 'Error';
-  }
+    reference_id?: string | null;
 
-  export interface UnionMember1 {
-    result_type: string;
+    sponsored?: boolean;
 
-    status: 'Success';
+    user_operation_hash?: string;
   }
 }
 
@@ -196,13 +274,32 @@ export interface TransactionGetResponse {
 
   wallet_id: string;
 
+  reference_id?: string | null;
+
   sponsored?: boolean;
+
+  user_operation_hash?: string;
 }
 
 export declare namespace Transactions {
   export {
     type TransactionScanningRequestBody as TransactionScanningRequestBody,
     type TransactionScanningResponseBody as TransactionScanningResponseBody,
+    type TransactionScanningMetadata as TransactionScanningMetadata,
+    type TransactionScanningRpcRequest as TransactionScanningRpcRequest,
+    type TransactionScanningValidationErrorResult as TransactionScanningValidationErrorResult,
+    type TransactionScanningValidationSuccessResult as TransactionScanningValidationSuccessResult,
+    type TransactionScanningValidationResult as TransactionScanningValidationResult,
+    type TransactionScanningAssetInfo as TransactionScanningAssetInfo,
+    type TransactionScanningAssetValue as TransactionScanningAssetValue,
+    type TransactionScanningAssetDiff as TransactionScanningAssetDiff,
+    type TransactionScanningExposure as TransactionScanningExposure,
+    type TransactionScanningCalldata as TransactionScanningCalldata,
+    type TransactionScanningParams as TransactionScanningParams,
+    type TransactionScanningSimulationErrorResult as TransactionScanningSimulationErrorResult,
+    type TransactionScanningSimulationSuccessResult as TransactionScanningSimulationSuccessResult,
+    type TransactionScanningSimulationResult as TransactionScanningSimulationResult,
+    type TransactionList as TransactionList,
     type TransactionGetResponse as TransactionGetResponse,
   };
 }