@stacks/stacks-blockchain-api-types - npm Package Compare versions

Comparing version 5.0.0 to 6.0.0-beta.1

entities/blocks/block.example.json

@@ -34,3 +34,8 @@ {
   "execution_cost_write_count": 608,
-  "execution_cost_write_length": 80170
+  "execution_cost_write_length": 80170,
+  "microblock_tx_count": {
+    "0xce0b1a4099d3fc7d5885cc7a3baa952b6d999f9709d0683b98b843597208231c": 5,
+    "0x4c0529b6448a5885991c5021bd869cc97f1692c128a98b382729dc962203c326": 6,
+    "0x64968846291dfea1015228a9d4bbd60aac81378cd6774b810b08e59e6b0e7494": 9
+  }
 }

entities/blocks/block.schema.json

@@ -26,3 +26,4 @@ {
     "execution_cost_write_count",
-    "execution_cost_write_length"
+    "execution_cost_write_length",
+    "microblock_tx_count"
   ],
@@ -121,4 +122,11 @@ "properties": {
       "description": "Execution cost write length."
+    },
+    "microblock_tx_count": {
+      "type": "object",
+      "description": "List of txs counts in each accepted microblock",
+      "additionalProperties": {
+        "type": "number"
+      }
     }
   }
 }

entities/contracts/smart-contract.schema.json

@@ -5,9 +5,3 @@ {
   "description": "A Smart Contract Detail",
-  "required": [
-    "tx_id",
-    "canonical",
-    "block_height",
-    "source_code",
-    "abi"
-  ],
+  "required": ["tx_id", "canonical", "block_height", "source_code", "contract_id", "abi"],
   "properties": {
@@ -20,2 +14,5 @@ "tx_id": {
     },
+    "contract_id": {
+      "type": "string"
+    },
     "block_height": {
@@ -22,0 +19,0 @@ "type": "integer"

entities/nft-events/nft-event.schema.json

@@ -6,8 +6,9 @@ {
   "required": [
-    "sender",
-    "recipient",
     "asset_identifier",
     "value",
     "tx_id",
-    "block_height"
+    "tx_index",
+    "event_index",
+    "block_height",
+    "asset_event_type"
   ],
@@ -24,2 +25,5 @@ "properties": {
     },
+    "asset_event_type": {
+      "type": "string"
+    },
     "value": {
@@ -44,6 +48,12 @@ "type": "object",
     },
+    "tx_index": {
+      "type": "number"
+    },
     "block_height": {
       "type": "number"
+    },
+    "event_index": {
+      "type": "number"
     }
   }
 }

entities/ws-rpc/rpc-address-balance-notification-response.schema.json

@@ -21,5 +21,20 @@ {
     "params": {
-      "$ref": "./rpc-address-balance-notification-params.schema.json"
+      "title": "RpcAddressBalanceNotificationParams",
+      "allOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["address"],
+          "properties": {
+            "address": {
+              "type": "string"
+            }
+          }
+        },
+        {
+          "$ref": "../../api/address/get-address-stx-balance.schema.json"
+        }
+      ]
     }
   }
 }

entities/ws-rpc/rpc-address-tx-notification-response.schema.json

@@ -21,5 +21,29 @@ {
     "params": {
-      "$ref": "./rpc-address-tx-notification-params.schema.json"
+      "title": "RpcAddressTxNotificationParams",
+      "allOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["address", "tx_id", "tx_type", "tx_status"],
+          "properties": {
+            "address": {
+              "type": "string"
+            },
+            "tx_id": {
+              "type": "string"
+            },
+            "tx_type": {
+              "$ref": "../transactions/transaction-type.schema.json"
+            },
+            "tx_status": {
+              "$ref": "../transactions/transaction-status.schema.json"
+            }
+          }
+        },
+        {
+          "$ref": "../../entities/address/transaction-with-transfers.schema.json"
+        }
+      ]
     }
   }
 }

entities/ws-rpc/rpc-subscription-type.schema.json

@@ -11,4 +11,7 @@ {
     "microblock",
-    "mempool"
+    "mempool",
+    "nft_event",
+    "nft_asset_event",
+    "nft_collection_event"
   ]
 }

entities/ws-rpc/rpc-tx-update-notification-response.schema.json

@@ -21,5 +21,12 @@ {
     "params": {
-      "$ref": "./rpc-tx-update-notification-params.schema.json"
+      "anyOf": [
+        {
+          "$ref": "../transactions/transaction.schema.json"
+        },
+        {
+          "$ref": "../mempool-transactions/transaction.schema.json"
+        }
+      ]
     }
   }
 }

package.json

 {
   "name": "@stacks/stacks-blockchain-api-types",
-  "version": "5.0.0",
+  "version": "6.0.0-beta.1",
   "access": "public",
@@ -5,0 +5,0 @@ "description": "TypeScript descriptions of Stacks 2.0 blockchain API entities",

socket-io/index.d.ts

@@ -7,3 +7,4 @@ import type {
   Transaction,
-  MempoolTransaction
+  MempoolTransaction,
+  NftEvent
 } from '..';
@@ -14,2 +15,4 @@
 export type TransactionTopic = `transaction:${string}`;
+export type NftAssetEventTopic = `nft-asset-event:${string}+${string}`;
+export type NftCollectionEventTopic = `nft-collection-event:${string}`;
 export type Topic =
@@ -19,5 +22,8 @@ | 'block'
   | 'mempool'
+  | 'nft-event'
   | AddressTransactionTopic
   | AddressStxBalanceTopic
-  | TransactionTopic;
+  | TransactionTopic
+  | NftAssetEventTopic
+  | NftCollectionEventTopic;
 
@@ -36,2 +42,14 @@ export interface ClientToServerMessages {
   // @ts-ignore scheduled for support in TS v4.3 https://github.com/microsoft/TypeScript/pull/26797
+  [key: 'nft-event']: (event: NftEvent) => void;
+  'nft-event': (event: NftEvent) => void;
+
+  // @ts-ignore scheduled for support in TS v4.3 https://github.com/microsoft/TypeScript/pull/26797
+  [key: NftAssetEventTopic]: (assetIdentifier: string, value: string, event: NftEvent) => void;
+  'nft-asset-event': (assetIdentifier: string, value: string, event: NftEvent) => void;
+
+  // @ts-ignore scheduled for support in TS v4.3 https://github.com/microsoft/TypeScript/pull/26797
+  [key: NftCollectionEventTopic]: (assetIdentifier: string, event: NftEvent) => void;
+  'nft-collection-event': (assetIdentifier: string, event: NftEvent) => void;
+
+  // @ts-ignore scheduled for support in TS v4.3 https://github.com/microsoft/TypeScript/pull/26797
   [key: AddressTransactionTopic]: (address: string, stxBalance: AddressTransactionWithTransfers) => void;
@@ -38,0 +56,0 @@ 'address-transaction': (address: string, tx: AddressTransactionWithTransfers) => void;

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

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

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

537444

increased by3.94%

Number of package files

350

increased by1.74%

Lines of code

13007

increased by6.57%

Worsened metrics

Number of low quality alerts

2

increased by100%

No dependency changes