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

Comparing version 0.71.2 to 1.0.0

api/bns/name-querying/bns-get-subdomain-at-tx-response.schema.json

@@ -5,3 +5,3 @@ {
   "title": "BnsGetSubdomainAtTx",
-  "description": "Fetches the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Blockstack transaction that introduced new subdomain operations, and empty array will be returned.",
+  "description": "Fetches the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Stacks transaction that introduced new subdomain operations, and empty array will be returned.",
   "required": [
@@ -8,0 +8,0 @@ "accepted",

api/search/search-address.schema.json

@@ -27,2 +27,10 @@ {
           "enum": ["standard_address"]
+        },
+        "metadata": {
+          "type": "object",
+          "anyOf": [
+            {
+              "$ref": "../address/get-address-stx-balance.schema.json"
+            }
+          ]
         }
@@ -29,0 +37,0 @@ }

api/search/search-block.schema.json

@@ -52,2 +52,11 @@ {
           }
+        },
+        "metadata": {
+          "type": "object",
+          "anyOf": [
+            {
+              "$ref": "../../entities/blocks/block.schema.json"
+            }
+          ],
+          "additionalItems": false
         }
@@ -54,0 +63,0 @@ }

api/search/search-contract.schema.json

@@ -55,2 +55,14 @@ {
           }
+        },
+        "metadata": {
+          "type": "object",
+          "anyOf": [
+            {
+              "$ref": "../../entities/mempool-transactions/transaction.schema.json"
+            },
+            {
+              "$ref": "../../entities/transactions/transaction.schema.json"
+            }
+          ],
+          "additionalItems": false
         }
@@ -57,0 +69,0 @@ }

api/search/search-mempool.schema.json

@@ -38,2 +38,11 @@ {
           }
+        },
+        "metadata": {
+          "type": "object",
+          "anyOf": [
+            {
+              "$ref": "../../entities/mempool-transactions/transaction.schema.json"
+            }
+          ],
+          "additionalItems": false
         }
@@ -40,0 +49,0 @@ }

api/search/search-tx-id.schema.json

@@ -52,2 +52,11 @@ {
           }
+        },
+        "metadata": {
+          "type": "object",
+          "anyOf": [
+            {
+              "$ref": "../../entities/transactions/transaction.schema.json"
+            }
+          ],
+          "additionalItems": false
         }
@@ -54,0 +63,0 @@ }

entities/address/transaction-with-transfers.schema.json

@@ -91,4 +91,14 @@ {
           "value": {
-            "type": "string",
-            "description": "Non Fungible Token asset value."
+            "type": "object",
+            "description": "Non Fungible Token asset value.",
+            "additionalProperties": false,
+            "required": ["hex", "repr"],
+            "properties": {
+              "hex": {
+                "type": "string"
+              },
+              "repr": {
+                "type": "string"
+              }
+            }
           },
@@ -95,0 +105,0 @@ "sender": {

entities/blocks/block.example.json

@@ -28,3 +28,8 @@ {
     "0xde2fc8d99872c827f144c752c002d29f9315dfc09472a09572ac7447ae623dea"
-  ]
+  ],
+  "execution_cost_read_count": 2477,
+  "execution_cost_read_length": 1659409,
+  "execution_cost_runtime": 2520952000,
+  "execution_cost_write_count": 608,
+  "execution_cost_write_length": 80170
 }

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

@@ -10,2 +10,3 @@ {
   ],
+  "additionalProperties": false,
   "properties": {
@@ -12,0 +13,0 @@ "address": {

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

@@ -11,2 +11,3 @@ {
   ],
+  "additionalProperties": false,
   "properties": {
@@ -13,0 +14,0 @@ "jsonrpc": {

entities/ws-rpc/rpc-address-balance-subscription-params.schema.json

@@ -10,2 +10,3 @@ {
   ],
+  "additionalProperties": false,
   "properties": {
@@ -12,0 +13,0 @@ "event": {

entities/ws-rpc/rpc-address-balance-subscription-request.schema.json

@@ -12,2 +12,3 @@ {
   ],
+  "additionalProperties": false,
   "properties": {
@@ -14,0 +15,0 @@ "jsonrpc": {

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

@@ -12,2 +12,3 @@ {
   ],
+  "additionalProperties": false,
   "properties": {
@@ -14,0 +15,0 @@ "address": {

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

@@ -11,2 +11,3 @@ {
   ],
+  "additionalProperties": false,
   "properties": {
@@ -13,0 +14,0 @@ "jsonrpc": {

entities/ws-rpc/rpc-address-tx-subscription-params.schema.json

@@ -10,2 +10,3 @@ {
   ],
+  "additionalProperties": false,
   "properties": {
@@ -12,0 +13,0 @@ "event": {

entities/ws-rpc/rpc-address-tx-subscription-request.schema.json

@@ -12,2 +12,3 @@ {
   ],
+  "additionalProperties": false,
   "properties": {
@@ -14,0 +15,0 @@ "jsonrpc": {

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

@@ -6,3 +6,10 @@ {
   "type": "string",
-  "enum": ["tx_update", "address_tx_update", "address_balance_update"]
+  "enum": [
+    "tx_update",
+    "address_tx_update",
+    "address_balance_update",
+    "block",
+    "microblock",
+    "mempool"
+  ]
 }

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

@@ -11,2 +11,3 @@ {
   ],
+  "additionalProperties": false,
   "properties": {
@@ -13,0 +14,0 @@ "tx_id": {

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

@@ -11,2 +11,3 @@ {
   ],
+  "additionalProperties": false,
   "properties": {
@@ -13,0 +14,0 @@ "jsonrpc": {

entities/ws-rpc/rpc-tx-update-subscription-params.schema.json

@@ -10,2 +10,3 @@ {
   ],
+  "additionalProperties": false,
   "properties": {
@@ -12,0 +13,0 @@ "event": {

entities/ws-rpc/rpc-tx-update-subscription-request.schema.json

@@ -12,2 +12,3 @@ {
   ],
+  "additionalProperties": false,
   "properties": {
@@ -14,0 +15,0 @@ "jsonrpc": {

package.json

 {
   "name": "@stacks/stacks-blockchain-api-types",
-  "version": "0.71.2",
+  "version": "1.0.0",
   "access": "public",
@@ -9,4 +9,4 @@ "description": "TypeScript descriptions of Stacks 2.0 blockchain API entities",
   "scripts": {
-    "build": "npm run generate:schemas",
-    "test": "npm run build && npm run lint:json && npm run lint:yaml && npm run validate:schemas && npm run deploy:docs",
+    "build": "rimraf .tmp && run-s generate:schemas generate:git-info generate:docs generate:postman",
+    "test": "rimraf .tmp && run-s lint:yaml lint:json lint:openapi validate:schemas",
     "lint:yaml": "yamllint ./openapi.yaml",
@@ -17,13 +17,13 @@ "lint:json": "jsonlint-cli ./api/**/*.json ./entities/**/*.json",
     "generate:schemas": "gulp && npm run generate:types",
-    "generate:resolved-spec": "export API_VERSION=$(shx tail -n 1 ../.git-info) && speccy resolve --output .tmp/openapi.resolved.yaml openapi.yaml && shx sed -i 'STACKS_API_VERSION' ${API_VERSION:-1.0.0} .tmp/openapi.resolved.yaml > /dev/null",
+    "generate:git-info": "npm run git-info --prefix .. && export API_VERSION=$(shx tail -n 1 ../.git-info) && speccy resolve --output .tmp/openapi.resolved.yaml openapi.yaml && shx sed -i 'STACKS_API_VERSION' ${API_VERSION:-1.0.0} .tmp/openapi.resolved.yaml > /dev/null",
     "generate:docs": "redoc-cli bundle --output .tmp/index.html .tmp/openapi.resolved.yaml",
-    "generate:postman": "openapi2postmanv2 --spec .tmp/openapi.resolved.yaml --output .tmp/collection.json --options folderStrategy=Tags,requestParametersResolution=Example,exampleParametersResolution=Example",
+    "generate:postman": "openapi2postmanv2 --spec .tmp/openapi.resolved.yaml --output .tmp/collection.json --options folderStrategy=Tags,requestParametersResolution=Example,exampleParametersResolution=Example,schemaFaker=false 2>/dev/null",
     "validate:schemas": "rimraf .tmp && gulp flattenSchemas --silent && ts-node ./scripts/validate-schemas.ts",
-    "deploy:docs": "npm run generate:types && npm run generate:docs && gulp deployDocs"
+    "deploy:docs": "npm run build && gulp deployDocs"
   },
-  "author": "@blockstack",
+  "author": "@hirosystems",
   "license": "ISC",
   "repository": {
     "type": "git",
-    "url": "https://github.com/blockstack/stacks-blockchain-api.git",
+    "url": "https://github.com/hirosystems/stacks-blockchain-api.git",
     "directory": "docs"
@@ -54,3 +54,4 @@ },
     "jsonlint-cli": "^1.0.1",
-    "openapi-to-postmanv2": "^2.10.1",
+    "npm-run-all": "^4.1.5",
+    "openapi-to-postmanv2": "^2.13.0",
     "redoc-cli": "^0.9.8",
@@ -57,0 +58,0 @@ "shx": "^0.3.3",

socket-io/index.d.ts

@@ -1,6 +0,20 @@
-import type { AddressStxBalanceResponse, AddressTransactionWithTransfers, Block, Microblock, MempoolTransaction } from '..';
+import type {
+  AddressStxBalanceResponse,
+  AddressTransactionWithTransfers,
+  Block,
+  Microblock,
+  Transaction,
+  MempoolTransaction
+} from '..';
 
 export type AddressTransactionTopic = `address-transaction:${string}`;
 export type AddressStxBalanceTopic = `address-stx-balance:${string}`;
-export type Topic = 'block' | 'microblock' | 'mempool' | AddressTransactionTopic | AddressStxBalanceTopic;
+export type TransactionTopic = `transaction:${string}`;
+export type Topic =
+  | 'block'
+  | 'microblock'
+  | 'mempool'
+  | AddressTransactionTopic
+  | AddressStxBalanceTopic
+  | TransactionTopic;
 
@@ -16,2 +30,3 @@ export interface ClientToServerMessages {
   mempool: (transaction: MempoolTransaction) => void;
+  transaction: (transaction: Transaction | MempoolTransaction) => void;
 
@@ -18,0 +33,0 @@ // @ts-ignore scheduled for support in TS v4.3 https://github.com/microsoft/TypeScript/pull/26797

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

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

Improved metrics

Total package byte prevSize

463611

increased by11.98%

Number of package files

298

increased by6.43%

Lines of code

10941

increased by7.16%

Number of low quality alerts

1

decreased by-50%

Worsened metrics

Dev dependency count

22

increased by4.76%

No dependency changes