@blockaid/client - npm Package Compare versions

Comparing version 0.15.0 to 0.16.0

CHANGELOG.md

 # Changelog
 
+## 0.16.0 (2024-07-30)
+
+Full Changelog: [v0.15.0...v0.16.0](https://github.com/blockaid-official/blockaid-client-node/compare/v0.15.0...v0.16.0)
+
+### Features
+
+* **api:** OpenAPI spec update via Stainless API ([#125](https://github.com/blockaid-official/blockaid-client-node/issues/125)) ([57c1bf0](https://github.com/blockaid-official/blockaid-client-node/commit/57c1bf02596ebdf58a32e79602b6c029bf001836))
+* **api:** OpenAPI spec update via Stainless API ([#127](https://github.com/blockaid-official/blockaid-client-node/issues/127)) ([74e90fe](https://github.com/blockaid-official/blockaid-client-node/commit/74e90fee05679a8a2f79a88203b7e75a02a114e6))
+
+
+### Chores
+
+* **internal:** add constant for default timeout ([#128](https://github.com/blockaid-official/blockaid-client-node/issues/128)) ([75872ae](https://github.com/blockaid-official/blockaid-client-node/commit/75872aeb5ed1a48ba1be26de4555d52b701f71a2))
+
 ## 0.15.0 (2024-07-28)
@@ -4,0 +18,0 @@

index.d.ts

@@ -89,2 +89,3 @@ import * as Errors from "./error.js";
     static Blockaid: typeof Blockaid;
+    static DEFAULT_TIMEOUT: number;
     static BlockaidError: typeof Errors.BlockaidError;
@@ -91,0 +92,0 @@ static APIError: typeof Errors.APIError;

index.js

@@ -89,2 +89,3 @@ "use strict";
 Blockaid.Blockaid = _a;
+Blockaid.DEFAULT_TIMEOUT = 60000; // 1 minute
 Blockaid.BlockaidError = Errors.BlockaidError;
@@ -91,0 +92,0 @@ Blockaid.APIError = Errors.APIError;

package.json

 {
   "name": "@blockaid/client",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "The official TypeScript library for the Blockaid API",
@@ -5,0 +5,0 @@ "author": "Blockaid <[e-mail]>",

resources/evm/post-transaction.d.ts

@@ -18,2 +18,5 @@ import { APIResource } from "../../resource.js";
 export interface PostTransactionReportParams {
+    /**
+     * Details about the report.
+     */
     details: string;
@@ -24,2 +27,5 @@ /**
     event: 'FALSE_POSITIVE' | 'FALSE_NEGATIVE';
+    /**
+     * The report parameters.
+     */
     report: PostTransactionReportParams.ParamReportChainTransactionHashParams | PostTransactionReportParams.RequestIDReport;
@@ -38,2 +44,5 @@ }
             chain: EvmAPI.TransactionScanSupportedChain;
+            /**
+             * The transaction hash to report on.
+             */
             tx_hash: string;
@@ -40,0 +49,0 @@ }

resources/evm/transaction.d.ts

@@ -19,2 +19,5 @@ import { APIResource } from "../../resource.js";
 export interface TransactionReportParams {
+    /**
+     * Details about the report.
+     */
     details: string;
@@ -25,2 +28,5 @@ /**
     event: 'FALSE_POSITIVE' | 'FALSE_NEGATIVE';
+    /**
+     * The report parameters.
+     */
     report: TransactionReportParams.ParamReportTransactionReportParams | TransactionReportParams.RequestIDReport;
@@ -35,2 +41,6 @@ }
         interface Params {
+            /**
+             * The address to relate the transaction to. Account address determines in which
+             * perspective the transaction is simulated and validated.
+             */
             account_address: string;
@@ -41,5 +51,49 @@ /**
             chain: EvmAPI.TransactionScanSupportedChain;
-            data: unknown;
-            metadata: unknown;
+            /**
+             * Transaction parameters
+             */
+            data: Params.Transaction | Params.JsonRpc;
+            /**
+             * Object of additional information to validate against.
+             */
+            metadata: EvmAPI.Metadata;
         }
+        namespace Params {
+            interface Transaction {
+                /**
+                 * The source address of the transaction in hex string format
+                 */
+                from: string;
+                /**
+                 * The encoded call data of the transaction in hex string format
+                 */
+                data?: string;
+                /**
+                 * The gas required for the transaction in hex string format.
+                 */
+                gas?: string;
+                /**
+                 * The gas price for the transaction in hex string format.
+                 */
+                gas_price?: string;
+                /**
+                 * The destination address of the transaction in hex string format
+                 */
+                to?: string;
+                /**
+                 * The value of the transaction in Wei in hex string format
+                 */
+                value?: string;
+            }
+            interface JsonRpc {
+                /**
+                 * The method of the JSON-RPC request
+                 */
+                method: string;
+                /**
+                 * The parameters of the JSON-RPC request in JSON format
+                 */
+                params: Array<unknown>;
+            }
+        }
     }
@@ -46,0 +100,0 @@ interface RequestIDReport {

resources/site.d.ts

@@ -49,2 +49,5 @@ import { APIResource } from "../resource.js";
 export interface SiteReportParams {
+    /**
+     * Details about the report.
+     */
     details: string;
@@ -55,2 +58,5 @@ /**
     event: 'FALSE_POSITIVE' | 'FALSE_NEGATIVE';
+    /**
+     * The report parameters.
+     */
     report: SiteReportParams.ParamReportSiteReportParams | SiteReportParams.RequestIDReport;
@@ -65,2 +71,5 @@ }
         interface Params {
+            /**
+             * The url of the site to report on.
+             */
             url: string;
@@ -67,0 +76,0 @@ }

resources/token.d.ts

@@ -48,2 +48,5 @@ import { APIResource } from "../resource.js";
 export interface TokenReportParams {
+    /**
+     * Details about the report.
+     */
     details: string;
@@ -54,11 +57,17 @@ /**
     event: 'FALSE_POSITIVE' | 'FALSE_NEGATIVE';
-    report: TokenReportParams.ParamReportAddressChainReportParams | TokenReportParams.RequestIDReport;
+    /**
+     * The report parameters.
+     */
+    report: TokenReportParams.ParamReportTokenReportParams | TokenReportParams.RequestIDReport;
 }
 export declare namespace TokenReportParams {
-    interface ParamReportAddressChainReportParams {
-        params: ParamReportAddressChainReportParams.Params;
+    interface ParamReportTokenReportParams {
+        params: ParamReportTokenReportParams.Params;
         type: 'params';
     }
-    namespace ParamReportAddressChainReportParams {
+    namespace ParamReportTokenReportParams {
         interface Params {
+            /**
+             * The address of the token to report on.
+             */
             address: string;
@@ -65,0 +74,0 @@ /**

src/index.ts

@@ -144,2 +144,3 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
   static Blockaid = this;
+  static DEFAULT_TIMEOUT = 60000; // 1 minute
 
@@ -146,0 +147,0 @@ static BlockaidError = Errors.BlockaidError;

src/resources/evm/post-transaction.ts

@@ -31,2 +31,5 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 export interface PostTransactionReportParams {
+  /**
+   * Details about the report.
+   */
   details: string;
@@ -39,2 +42,5 @@
 
+  /**
+   * The report parameters.
+   */
   report:
@@ -59,2 +65,5 @@ | PostTransactionReportParams.ParamReportChainTransactionHashParams
 
+      /**
+       * The transaction hash to report on.
+       */
       tx_hash: string;
@@ -61,0 +70,0 @@ }

src/resources/evm/transaction.ts

@@ -32,2 +32,5 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 export interface TransactionReportParams {
+  /**
+   * Details about the report.
+   */
   details: string;
@@ -40,2 +43,5 @@
 
+  /**
+   * The report parameters.
+   */
   report:
@@ -55,2 +61,6 @@ | TransactionReportParams.ParamReportTransactionReportParams
     export interface Params {
+      /**
+       * The address to relate the transaction to. Account address determines in which
+       * perspective the transaction is simulated and validated.
+       */
       account_address: string;
@@ -63,6 +73,58 @@
 
-      data: unknown;
+      /**
+       * Transaction parameters
+       */
+      data: Params.Transaction | Params.JsonRpc;
 
-      metadata: unknown;
+      /**
+       * Object of additional information to validate against.
+       */
+      metadata: EvmAPI.Metadata;
     }
+
+    export namespace Params {
+      export interface Transaction {
+        /**
+         * The source address of the transaction in hex string format
+         */
+        from: string;
+
+        /**
+         * The encoded call data of the transaction in hex string format
+         */
+        data?: string;
+
+        /**
+         * The gas required for the transaction in hex string format.
+         */
+        gas?: string;
+
+        /**
+         * The gas price for the transaction in hex string format.
+         */
+        gas_price?: string;
+
+        /**
+         * The destination address of the transaction in hex string format
+         */
+        to?: string;
+
+        /**
+         * The value of the transaction in Wei in hex string format
+         */
+        value?: string;
+      }
+
+      export interface JsonRpc {
+        /**
+         * The method of the JSON-RPC request
+         */
+        method: string;
+
+        /**
+         * The parameters of the JSON-RPC request in JSON format
+         */
+        params: Array<unknown>;
+      }
+    }
   }
@@ -69,0 +131,0 @@

src/resources/site.ts

@@ -80,2 +80,5 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 export interface SiteReportParams {
+  /**
+   * Details about the report.
+   */
   details: string;
@@ -88,2 +91,5 @@
 
+  /**
+   * The report parameters.
+   */
   report: SiteReportParams.ParamReportSiteReportParams | SiteReportParams.RequestIDReport;
@@ -101,2 +107,5 @@ }
     export interface Params {
+      /**
+       * The url of the site to report on.
+       */
       url: string;
@@ -103,0 +112,0 @@ }

src/resources/token.ts

@@ -64,2 +64,5 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 export interface TokenReportParams {
+  /**
+   * Details about the report.
+   */
   details: string;
@@ -72,8 +75,11 @@
 
-  report: TokenReportParams.ParamReportAddressChainReportParams | TokenReportParams.RequestIDReport;
+  /**
+   * The report parameters.
+   */
+  report: TokenReportParams.ParamReportTokenReportParams | TokenReportParams.RequestIDReport;
 }
 
 export namespace TokenReportParams {
-  export interface ParamReportAddressChainReportParams {
-    params: ParamReportAddressChainReportParams.Params;
+  export interface ParamReportTokenReportParams {
+    params: ParamReportTokenReportParams.Params;
 
@@ -83,4 +89,7 @@ type: 'params';
 
-  export namespace ParamReportAddressChainReportParams {
+  export namespace ParamReportTokenReportParams {
     export interface Params {
+      /**
+       * The address of the token to report on.
+       */
       address: string;
@@ -87,0 +96,0 @@

src/version.ts

@@ -1,1 +0,1 @@
-export const VERSION = '0.15.0'; // x-release-please-version
+export const VERSION = '0.16.0'; // x-release-please-version

version.d.ts

@@ -1,2 +0,2 @@
-export declare const VERSION = "0.15.0";
+export declare const VERSION = "0.16.0";
 //# sourceMappingURL=version.d.ts.map

version.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.15.0'; // x-release-please-version
+exports.VERSION = '0.16.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

710906

increased by0.86%

Lines of code

12388

increased by1.36%

No dependency changes