@privy-io/api-types 0.7.0 → 0.9.0

package/resources/transactions.d.ts

@@ -15,123 +15,175 @@ export declare class Transactions extends APIResource {
      * );
      * ```
      */
-    get(transactionID: string, options?: RequestOptions): APIPromise<TransactionGetResponse>;
+    get(transactionID: string, options?: RequestOptions): APIPromise<Transaction>;
 }
 /**
  * The request body for scanning a transaction.
  */
 export interface TransactionScanningRequestBody {
     chain_id: string;
-    metadata: TransactionScanningRequestBody.Metadata;
-    request: TransactionScanningRequestBody.Request;
-}
-export declare namespace TransactionScanningRequestBody {
-    interface Metadata {
-        domain: string;
-    }
-    interface Request {
-        method: string;
-        params: Array<unknown>;
-    }
+    /**
+     * Additional information for Blockaid to validate against.
+     */
+    metadata: TransactionScanningMetadata;
+    /**
+     * Raw RPC request to execute with the wallet.
+     */
+    request: TransactionScanningRpcRequest;
 }
 /**
  * The response from scanning a transaction.
  */
 export interface TransactionScanningResponseBody {
-    simulation: TransactionScanningResponseBody.UnionMember0 | TransactionScanningResponseBody.UnionMember1;
-    validation: TransactionScanningResponseBody.UnionMember0 | TransactionScanningResponseBody.UnionMember1;
-}
-export declare namespace TransactionScanningResponseBody {
-    interface UnionMember0 {
-        error: string;
-        status: 'Error';
-    }
-    interface UnionMember1 {
-        assets_diffs: Array<UnionMember1.AssetsDiff>;
-        exposures: Array<UnionMember1.Exposure>;
-        status: 'Success';
-        params?: UnionMember1.Params;
-    }
-    namespace UnionMember1 {
-        interface AssetsDiff {
-            asset: AssetsDiff.Asset;
-            in: Array<AssetsDiff.In>;
-            out: Array<AssetsDiff.Out>;
-        }
-        namespace AssetsDiff {
-            interface Asset {
-                decimals?: number;
-                logo_url?: string;
-                name?: string;
-                symbol?: string;
-                type?: string;
-            }
-            interface In {
-                usd_price?: string;
-                value?: string;
-            }
-            interface Out {
-                usd_price?: string;
-                value?: string;
-            }
-        }
-        interface Exposure {
-            asset: Exposure.Asset;
-            spenders: {
-                [key: string]: Exposure.Spenders;
-            };
-        }
-        namespace Exposure {
-            interface Asset {
-                decimals?: number;
-                logo_url?: string;
-                name?: string;
-                symbol?: string;
-                type?: string;
-            }
-            interface Spenders {
-                usd_price?: string;
-                value?: string;
-            }
-        }
-        interface Params {
-            block_tag?: string;
-            calldata?: Params.Calldata;
-            chain?: string;
-            data?: string;
-            from?: string;
-            gas?: string;
-            gas_price?: string;
-            to?: string;
-            value?: string;
-        }
-        namespace Params {
-            interface Calldata {
-                function_selector: string;
-                function_declaration?: string;
-                function_signature?: string;
-            }
-        }
-    }
-    interface UnionMember0 {
-        error: string;
-        status: 'Error';
-    }
-    interface UnionMember1 {
-        result_type: string;
-        status: 'Success';
-    }
-}
-export interface TransactionGetResponse {
+    /**
+     * The simulation result from a transaction scan.
+     */
+    simulation: TransactionScanningSimulationResult;
+    /**
+     * The validation result from a transaction scan.
+     */
+    validation: TransactionScanningValidationResult;
+}
+/**
+ * Additional information for Blockaid to validate against.
+ */
+export interface TransactionScanningMetadata {
+    domain: string;
+}
+/**
+ * Raw RPC request to execute with the wallet.
+ */
+export interface TransactionScanningRpcRequest {
+    method: string;
+    params: Array<unknown>;
+}
+/**
+ * A failed validation result from a transaction scan.
+ */
+export interface TransactionScanningValidationErrorResult {
+    error: string;
+    status: 'Error';
+}
+/**
+ * A successful validation result from a transaction scan.
+ */
+export interface TransactionScanningValidationSuccessResult {
+    result_type: string;
+    status: 'Success';
+}
+/**
+ * The validation result from a transaction scan.
+ */
+export type TransactionScanningValidationResult = TransactionScanningValidationErrorResult | TransactionScanningValidationSuccessResult;
+/**
+ * Information about the moving asset in a transaction scan.
+ */
+export interface TransactionScanningAssetInfo {
+    decimals?: number;
+    logo_url?: string;
+    name?: string;
+    symbol?: string;
+    type?: string;
+}
+/**
+ * The value of an asset in a transaction scan result.
+ */
+export interface TransactionScanningAssetValue {
+    usd_price?: string;
+    value?: string;
+}
+/**
+ * An asset diff representing assets entering/leaving a wallet.
+ */
+export interface TransactionScanningAssetDiff {
+    /**
+     * Information about the moving asset in a transaction scan.
+     */
+    asset: TransactionScanningAssetInfo;
+    in: Array<TransactionScanningAssetValue>;
+    out: Array<TransactionScanningAssetValue>;
+}
+/**
+ * An exposure representing assets approved to spend.
+ */
+export interface TransactionScanningExposure {
+    /**
+     * Information about the moving asset in a transaction scan.
+     */
+    asset: TransactionScanningAssetInfo;
+    spenders: {
+        [key: string]: TransactionScanningAssetValue;
+    };
+}
+/**
+ * Decoded calldata from a scanned transaction.
+ */
+export interface TransactionScanningCalldata {
+    function_selector: string;
+    function_declaration?: string;
+    function_signature?: string;
+}
+/**
+ * The parameters of the scanned transaction.
+ */
+export interface TransactionScanningParams {
+    block_tag?: string;
+    /**
+     * Decoded calldata from a scanned transaction.
+     */
+    calldata?: TransactionScanningCalldata;
+    chain?: string;
+    data?: string;
+    from?: string;
+    gas?: string;
+    gas_price?: string;
+    to?: string;
+    value?: string;
+}
+/**
+ * A failed simulation result from a transaction scan.
+ */
+export interface TransactionScanningSimulationErrorResult {
+    error: string;
+    status: 'Error';
+}
+/**
+ * A successful simulation result from a transaction scan.
+ */
+export interface TransactionScanningSimulationSuccessResult {
+    assets_diffs: Array<TransactionScanningAssetDiff>;
+    exposures: Array<TransactionScanningExposure>;
+    status: 'Success';
+    /**
+     * The parameters of the scanned transaction.
+     */
+    params?: TransactionScanningParams;
+}
+/**
+ * The simulation result from a transaction scan.
+ */
+export type TransactionScanningSimulationResult = TransactionScanningSimulationErrorResult | TransactionScanningSimulationSuccessResult;
+/**
+ * A transaction from a Privy wallet.
+ */
+export interface Transaction {
     id: string;
     caip2: string;
     created_at: number;
     status: 'broadcasted' | 'confirmed' | 'execution_reverted' | 'failed' | 'replaced' | 'finalized' | 'provider_error' | 'pending';
     transaction_hash: string | null;
     wallet_id: string;
+    reference_id?: string | null;
     sponsored?: boolean;
+    user_operation_hash?: string;
+}
+/**
+ * A list of transactions.
+ */
+export interface TransactionList {
+    transactions: Array<Transaction>;
 }
 export declare namespace Transactions {
-    export { type TransactionScanningRequestBody as TransactionScanningRequestBody, type TransactionScanningResponseBody as TransactionScanningResponseBody, type TransactionGetResponse as TransactionGetResponse, };
+    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 Transaction as Transaction, type TransactionList as TransactionList, };
 }
 //# sourceMappingURL=transactions.d.ts.map

package/resources/transactions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transactions.d.ts","sourceRoot":"","sources":["../src/resources/transactions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGzF;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,EAAE,MAAM,CAAC;IAEjB,QAAQ,EAAE,8BAA8B,CAAC,QAAQ,CAAC;IAElD,OAAO,EAAE,8BAA8B,CAAC,OAAO,CAAC;CACjD;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,QAAQ;QACvB,MAAM,EAAE,MAAM,CAAC;KAChB;IAED,UAAiB,OAAO;QACtB,MAAM,EAAE,MAAM,CAAC;QAEf,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;KACxB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,UAAU,EAAE,+BAA+B,CAAC,YAAY,GAAG,+BAA+B,CAAC,YAAY,CAAC;IAExG,UAAU,EAAE,+BAA+B,CAAC,YAAY,GAAG,+BAA+B,CAAC,YAAY,CAAC;CACzG;AAED,yBAAiB,+BAA+B,CAAC;IAC/C,UAAiB,YAAY;QAC3B,KAAK,EAAE,MAAM,CAAC;QAEd,MAAM,EAAE,OAAO,CAAC;KACjB;IAED,UAAiB,YAAY;QAC3B,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAE7C,SAAS,EAAE,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAExC,MAAM,EAAE,SAAS,CAAC;QAElB,MAAM,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC;KAC9B;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,UAAU;YACzB,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;YAExB,EAAE,EAAE,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAEzB,GAAG,EAAE,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SAC5B;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,KAAK;gBACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEd,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEhB,IAAI,CAAC,EAAE,MAAM,CAAC;aACf;YAED,UAAiB,EAAE;gBACjB,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB,KAAK,CAAC,EAAE,MAAM,CAAC;aAChB;YAED,UAAiB,GAAG;gBAClB,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB,KAAK,CAAC,EAAE,MAAM,CAAC;aAChB;SACF;QAED,UAAiB,QAAQ;YACvB,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC;YAEtB,QAAQ,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAA;aAAE,CAAC;SAChD;QAED,UAAiB,QAAQ,CAAC;YACxB,UAAiB,KAAK;gBACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEd,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEhB,IAAI,CAAC,EAAE,MAAM,CAAC;aACf;YAED,UAAiB,QAAQ;gBACvB,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB,KAAK,CAAC,EAAE,MAAM,CAAC;aAChB;SACF;QAED,UAAiB,MAAM;YACrB,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC;YAE3B,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,GAAG,CAAC,EAAE,MAAM,CAAC;YAEb,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB,EAAE,CAAC,EAAE,MAAM,CAAC;YAEZ,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,MAAM,CAAC;YACtB,UAAiB,QAAQ;gBACvB,iBAAiB,EAAE,MAAM,CAAC;gBAE1B,oBAAoB,CAAC,EAAE,MAAM,CAAC;gBAE9B,kBAAkB,CAAC,EAAE,MAAM,CAAC;aAC7B;SACF;KACF;IAED,UAAiB,YAAY;QAC3B,KAAK,EAAE,MAAM,CAAC;QAEd,MAAM,EAAE,OAAO,CAAC;KACjB;IAED,UAAiB,YAAY;QAC3B,WAAW,EAAE,MAAM,CAAC;QAEpB,MAAM,EAAE,SAAS,CAAC;KACnB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IAEX,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EACF,aAAa,GACb,WAAW,GACX,oBAAoB,GACpB,QAAQ,GACR,UAAU,GACV,WAAW,GACX,gBAAgB,GAChB,SAAS,CAAC;IAEd,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
+{"version":3,"file":"transactions.d.ts","sourceRoot":"","sources":["../src/resources/transactions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;CAG9E;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,2BAA2B,CAAC;IAEtC;;OAEG;IACH,OAAO,EAAE,6BAA6B,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,UAAU,EAAE,mCAAmC,CAAC;IAEhD;;OAEG;IACH,UAAU,EAAE,mCAAmC,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EAAE,MAAM,CAAC;IAEf,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,wCAAwC;IACvD,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,0CAA0C;IACzD,WAAW,EAAE,MAAM,CAAC;IAEpB,MAAM,EAAE,SAAS,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAC3C,wCAAwC,GACxC,0CAA0C,CAAC;AAE/C;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,KAAK,EAAE,4BAA4B,CAAC;IAEpC,EAAE,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAEzC,GAAG,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,KAAK,EAAE,4BAA4B,CAAC;IAEpC,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,6BAA6B,CAAA;KAAE,CAAC;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,iBAAiB,EAAE,MAAM,CAAC;IAE1B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;IAEvC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,wCAAwC;IACvD,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,0CAA0C;IACzD,YAAY,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAElD,SAAS,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAE9C,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,yBAAyB,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAC3C,wCAAwC,GACxC,0CAA0C,CAAC;AAE/C;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IAEX,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EACF,aAAa,GACb,WAAW,GACX,oBAAoB,GACpB,QAAQ,GACR,UAAU,GACV,WAAW,GACX,gBAAgB,GAChB,SAAS,CAAC;IAEd,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,SAAS,EAAE,MAAM,CAAC;IAElB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,YAAY,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;CAClC;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}