Merge pull request #1335 from hirosystems/beta

release v6.0.0

Author: rafaelcr

.env

@@ -35,9 +35,6 @@ PG_APPLICATION_NAME=stacks-blockchain-api
 # See https://node-postgres.com/api/pool
 # PG_CONNECTION_POOL_MAX=10
 
-# Enable to have stacks-node events streamed to a file while the application is running
-# STACKS_EXPORT_EVENTS_FILE=/tmp/stacks-events.tsv
-
 # If specified, controls the Stacks Blockchain API mode. The possible values are:
 # * `readonly`: Runs the API endpoints without an Event Server that listens to events from a node and
 #       writes them to the local database. The API will only read data from the PG database

.gitpod.Dockerfile

@@ -1,4 +1,4 @@
-FROM blockstack/stacks-blockchain:2.05.0.0.0-stretch as corenode
+FROM blockstack/stacks-blockchain:2.05.0.3.0-stretch as corenode
 
 FROM gitpod/workspace-postgres
 

.npmrc

@@ -0,0 +1 @@
+save-exact=true

.vscode/launch.json

@@ -206,6 +206,48 @@
       "preLaunchTask": "stacks-node:deploy-dev",
       "postDebugTask": "stacks-node:stop-dev"
     },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Jest: rosetta-cli-data",
+      "program": "${workspaceFolder}/node_modules/.bin/jest",
+      "args": [
+        "--testTimeout=3600000",
+        "--runInBand",
+        "--no-cache",
+        "--config",
+        "${workspaceRoot}/jest.config.rosetta-cli-data.js"
+      ],
+      "outputCapture": "std",
+      "console": "integratedTerminal",
+      "preLaunchTask": "stacks-node:deploy-dev",
+      "postDebugTask": "stacks-node:stop-dev",
+      "env": {
+        "NODE_ENV": "development",
+        "STACKS_CHAIN_ID": "0x80000000"
+      }
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Jest: rosetta-cli-construction",
+      "program": "${workspaceFolder}/node_modules/.bin/jest",
+      "args": [
+        "--testTimeout=3600000",
+        "--runInBand",
+        "--no-cache",
+        "--config",
+        "${workspaceRoot}/jest.config.rosetta-cli-construction.js"
+      ],
+      "outputCapture": "std",
+      "console": "integratedTerminal",
+      "preLaunchTask": "stacks-node:deploy-dev",
+      "postDebugTask": "stacks-node:stop-dev",
+      "env": {
+        "NODE_ENV": "development",
+        "STACKS_CHAIN_ID": "0x80000000"
+      }
+    },
     {
       "type": "node",
       "request": "launch",

CHANGELOG.md

@@ -1,8 +1,107 @@
-## [5.0.1](https://github.com/hirosystems/stacks-blockchain-api/compare/v5.0.0...v5.0.1) (2022-09-20)
+## [6.0.0-beta.10](https://github.com/hirosystems/stacks-blockchain-api/compare/v6.0.0-beta.9...v6.0.0-beta.10) (2022-10-06)
+
+
+### Reverts
+
+* Revert "chore!: remove deprecated `/nft_events` endpoint (#1329)" (#1343) ([c537ee4](https://github.com/hirosystems/stacks-blockchain-api/commit/c537ee4c6f333c0a43c9e9e1ca1e073f03c58fc5)), closes [#1329](https://github.com/hirosystems/stacks-blockchain-api/issues/1329) [#1343](https://github.com/hirosystems/stacks-blockchain-api/issues/1343)
+
+## [6.0.0-beta.9](https://github.com/hirosystems/stacks-blockchain-api/compare/v6.0.0-beta.8...v6.0.0-beta.9) (2022-09-30)
+
+
+### Bug Fixes
+
+* support multiple BNS name events in the same transaction ([#1337](https://github.com/hirosystems/stacks-blockchain-api/issues/1337)) ([1edb256](https://github.com/hirosystems/stacks-blockchain-api/commit/1edb25697df689dbf1da5d412f5d40e4aac024f3))
+
+## [6.0.0-beta.8](https://github.com/hirosystems/stacks-blockchain-api/compare/v6.0.0-beta.7...v6.0.0-beta.8) (2022-09-29)
+
+
+### Bug Fixes
+
+* add owner index on subdomains table ([#1323](https://github.com/hirosystems/stacks-blockchain-api/issues/1323)) ([c9c6d05](https://github.com/hirosystems/stacks-blockchain-api/commit/c9c6d053fd8896187a26a788aaaa56fb48285e61))
 
+## [6.0.0-beta.7](https://github.com/hirosystems/stacks-blockchain-api/compare/v6.0.0-beta.6...v6.0.0-beta.7) (2022-09-28)
+
+
+### ⚠ BREAKING CHANGES
+
+* remove deprecated `/nft_events` endpoint (#1329)
 
 ### Bug Fixes
 
+* event_observer_requests json writes ([#1334](https://github.com/hirosystems/stacks-blockchain-api/issues/1334)) ([465aa0b](https://github.com/hirosystems/stacks-blockchain-api/commit/465aa0b42ca3dda57d06f6c0756b03d591e7f027))
+
+
+### Miscellaneous Chores
+
+* remove deprecated `/nft_events` endpoint ([#1329](https://github.com/hirosystems/stacks-blockchain-api/issues/1329)) ([65bb4e5](https://github.com/hirosystems/stacks-blockchain-api/commit/65bb4e55fabf21a70183d2b16c8bc1f6f742d04e))
+
+## [6.0.0-beta.6](https://github.com/hirosystems/stacks-blockchain-api/compare/v6.0.0-beta.5...v6.0.0-beta.6) (2022-09-23)
+
+
+### Features
+
+* add token_type metadata for rosetta ft operations ([#1332](https://github.com/hirosystems/stacks-blockchain-api/issues/1332)) ([09af27b](https://github.com/hirosystems/stacks-blockchain-api/commit/09af27b24be8e30a840707707b79d65cd45f2351))
+
+## [6.0.0-beta.5](https://github.com/hirosystems/stacks-blockchain-api/compare/v6.0.0-beta.4...v6.0.0-beta.5) (2022-09-22)
+
+
+### Features
+
+* add owner index to subdomains table ([#1331](https://github.com/hirosystems/stacks-blockchain-api/issues/1331)) ([a6c5e12](https://github.com/hirosystems/stacks-blockchain-api/commit/a6c5e12faa256633a7c9ae4c7cf8524013d187d6))
+
+## [6.0.0-beta.4](https://github.com/hirosystems/stacks-blockchain-api/compare/v6.0.0-beta.3...v6.0.0-beta.4) (2022-09-22)
+
+
+### Bug Fixes
+
+* upgrade stacks node versions to 2.05.0.3.0 ([#1328](https://github.com/hirosystems/stacks-blockchain-api/issues/1328)) ([e30636e](https://github.com/hirosystems/stacks-blockchain-api/commit/e30636e30f716a7335792914a142fa54f423dc9a))
+
+## [6.0.0-beta.3](https://github.com/hirosystems/stacks-blockchain-api/compare/v6.0.0-beta.2...v6.0.0-beta.3) (2022-09-21)
+
+
+### Bug Fixes
+
+* refresh materialized views concurrently in new pg format ([#1324](https://github.com/hirosystems/stacks-blockchain-api/issues/1324)) ([20b284f](https://github.com/hirosystems/stacks-blockchain-api/commit/20b284fa381041fb842bf61d8a184be6ea84810f))
+* retry pg connection on new library code ([#1326](https://github.com/hirosystems/stacks-blockchain-api/issues/1326)) ([35db939](https://github.com/hirosystems/stacks-blockchain-api/commit/35db939199a2d826e7ee4dbe31af48cc42364ea2))
+
+## [6.0.0-beta.2](https://github.com/hirosystems/stacks-blockchain-api/compare/v6.0.0-beta.1...v6.0.0-beta.2) (2022-09-13)
+
+
+### Bug Fixes
+
+* remove live tsv append ([#1315](https://github.com/hirosystems/stacks-blockchain-api/issues/1315)) ([e2a1247](https://github.com/hirosystems/stacks-blockchain-api/commit/e2a124710f955d9d32ff5a928af7da08823689d4))
+
+## [6.0.0-beta.1](https://github.com/hirosystems/stacks-blockchain-api/compare/v5.0.0...v6.0.0-beta.1) (2022-09-13)
+
+
+### ⚠ BREAKING CHANGES
+
+* mark breaking change
+
+### Features
+
+* add `transaction_count` for `microblocks_accepted` in block ([#1162](https://github.com/hirosystems/stacks-blockchain-api/issues/1162)) ([78d7d9c](https://github.com/hirosystems/stacks-blockchain-api/commit/78d7d9c9f72db8ce6c59e0ea59a2579aceec014e))
+* add API version in response header ([#1216](https://github.com/hirosystems/stacks-blockchain-api/issues/1216)) ([1e998db](https://github.com/hirosystems/stacks-blockchain-api/commit/1e998db7d1c87c064376cb950d05b073d9d3f076))
+* mark breaking change ([669fd0d](https://github.com/hirosystems/stacks-blockchain-api/commit/669fd0d8c00b8ca9224c9b5411a070b32c3b0529))
+* mempool stats endpoint and prometheus metrics ([#1241](https://github.com/hirosystems/stacks-blockchain-api/issues/1241)) ([9482238](https://github.com/hirosystems/stacks-blockchain-api/commit/9482238599549fd651c8c87b545c175d8a219521))
+* refactor pg classes, switch to postgres.js ([#1148](https://github.com/hirosystems/stacks-blockchain-api/issues/1148)) ([3ff4177](https://github.com/hirosystems/stacks-blockchain-api/commit/3ff41779f844c611fbd95429aeefbdb085a59026)), closes [#1168](https://github.com/hirosystems/stacks-blockchain-api/issues/1168)
+* send nft updates through websocket channels ([#1218](https://github.com/hirosystems/stacks-blockchain-api/issues/1218)) ([920a7b8](https://github.com/hirosystems/stacks-blockchain-api/commit/920a7b892a39f0f1e76363211573d935ae2c75da))
+
+### Bug Fixes
+
+* consolidate db migrations ([#1314](https://github.com/hirosystems/stacks-blockchain-api/issues/1314)) ([d6bdf9f](https://github.com/hirosystems/stacks-blockchain-api/commit/d6bdf9faff905d5e208e61b04c34321e954a2fb1))
+* included query params in redirecting to prefix 0x in tx endpoint ([#1205](https://github.com/hirosystems/stacks-blockchain-api/issues/1205)) ([664cce7](https://github.com/hirosystems/stacks-blockchain-api/commit/664cce744d1aecc0b3226ae07ac81e5d0cd13871))
+* incorrect websocket/socket.io transaction updates ([#1197](https://github.com/hirosystems/stacks-blockchain-api/issues/1197)) ([8ee1da8](https://github.com/hirosystems/stacks-blockchain-api/commit/8ee1da840bfa3fcecac79e09e375b720cd0ccc04))
+* mobx breakage by locking package dependencies ([#1206](https://github.com/hirosystems/stacks-blockchain-api/issues/1206)) ([5f8bc9f](https://github.com/hirosystems/stacks-blockchain-api/commit/5f8bc9fd4f45877eedbfbce29c7feb5905ba8836))
+* optimize `getMicroblocks` query ([#1179](https://github.com/hirosystems/stacks-blockchain-api/issues/1179)) ([7691109](https://github.com/hirosystems/stacks-blockchain-api/commit/769110926eb7b7c9a4d2754af8ce6f1213e2c56f))
+* optimize block endpoint ([#1190](https://github.com/hirosystems/stacks-blockchain-api/issues/1190)) ([943e2d1](https://github.com/hirosystems/stacks-blockchain-api/commit/943e2d1c555473f7f0fb61959ed89185e89ed062))
+* remove duplicate txs in microblock responses ([#1167](https://github.com/hirosystems/stacks-blockchain-api/issues/1167)) ([15c0c11](https://github.com/hirosystems/stacks-blockchain-api/commit/15c0c1124a2c91756389274c8a6ebfa8aa44228b))
+* tests ([1c1fd16](https://github.com/hirosystems/stacks-blockchain-api/commit/1c1fd1619c8ea97c2636082203fb678f06493786))
+* upsert nft and ft metadata ([#1193](https://github.com/hirosystems/stacks-blockchain-api/issues/1193)) ([c4eec5d](https://github.com/hirosystems/stacks-blockchain-api/commit/c4eec5d060666b660c48d326e74b4f989b9ee21d))
+
+## [5.0.1](https://github.com/hirosystems/stacks-blockchain-api/compare/v5.0.0...v5.0.1) (2022-09-20)
+
+
 * add owner index on subdomains table ([#1323](https://github.com/hirosystems/stacks-blockchain-api/issues/1323)) ([c9c6d05](https://github.com/hirosystems/stacks-blockchain-api/commit/c9c6d053fd8896187a26a788aaaa56fb48285e61))
 
 ## [5.0.0](https://github.com/hirosystems/stacks-blockchain-api/compare/v4.1.2...v5.0.0) (2022-09-07)

client/.npmrc

@@ -0,0 +1 @@
+save-exact=true

client/README.md

@@ -287,61 +287,77 @@ Sent every time a transaction is sent or received by a specific Stacks address.
 Example message if subscribed to updates for an address `SP3C5SSYVKPAWTR8Y63CVYBR65GD3MG7K80526D1Q`:
 ```json
 {
-  "tx_id": "0x1f9e737dfbebcb57f0879a44518c1cc909be0ceb8ab0bc9b38ce63e3b6847917",
-  "nonce": 6,
-  "fee_rate": "277600",
-  "sender_address": "SP3C5SSYVKPAWTR8Y63CVYBR65GD3MG7K80526D1Q",
-  "sponsored": false,
-  "post_condition_mode": "deny",
-  "post_conditions": [
-    {
-      "type": "stx",
-      "condition_code": "sent_less_than_or_equal_to",
-      "amount": "25000000",
-      "principal": {
-        "type_id": "principal_standard",
-        "address": "SP3C5SSYVKPAWTR8Y63CVYBR65GD3MG7K80526D1Q"
-      }
-    },
-    {
-      "type": "non_fungible",
-      "condition_code": "not_sent",
-      "principal": {
-        "type_id": "principal_contract",
-        "contract_name": "stacks-skaters",
-        "address": "SPJW1XE278YMCEYMXB8ZFGJMH8ZVAAEDP2S2PJYG"
-      },
-      "asset": {
-        "contract_name": "stacks-skaters",
-        "asset_name": "stacks-skaters",
-        "contract_address": "SPJW1XE278YMCEYMXB8ZFGJMH8ZVAAEDP2S2PJYG"
-      },
-      "asset_value": {
-        "hex": "0x0100000000000000000000000000000000",
-        "repr": "u0"
+  "tx": {
+    "tx_id": "0x0c818b9af6356a2eb4d64ee1b2490193d97a82392c02e7264e006ae5979aa726",
+    "nonce": 32,
+    "fee_rate": "3000",
+    "sender_address": "SP3BK1NNSWN719Z6KDW05RBGVS940YCN6X84STYPR",
+    "sponsored": false,
+    "post_condition_mode": "deny",
+    "post_conditions": [
+      {
+        "type": "stx",
+        "condition_code": "sent_equal_to",
+        "amount": "4375722",
+        "principal": {
+          "type_id": "principal_contract",
+          "contract_name": "newyorkcitycoin-core-v1",
+          "address": "SP2H8PY27SEZ03MWRKS5XABZYQN17ETGQS3527SA5"
+        }
       }
+    ],
+    "anchor_mode": "any",
+    "is_unanchored": false,
+    "block_hash": "0xe2a811451fed35331cf462a9107e3453fdebba1682dfad83cbbcdc603f644ed3",
+    "parent_block_hash": "0x6d8653da23188d4d78ab9b6448229be68abe1bca001f8c574c094289107bce15",
+    "block_height": 58775,
+    "burn_block_time": 1651720813,
+    "burn_block_time_iso": "2022-05-05T03:20:13.000Z",
+    "parent_burn_block_time": 1651720368,
+    "parent_burn_block_time_iso": "2022-05-05T03:12:48.000Z",
+    "canonical": true,
+    "tx_index": 36,
+    "tx_status": "success",
+    "tx_result": {
+      "hex": "0x0703",
+      "repr": "(ok true)"
     },
+    "microblock_hash": "",
+    "microblock_sequence": 2147483647,
+    "microblock_canonical": true,
+    "event_count": 1,
+    "events": [],
+    "execution_cost_read_count": 15,
+    "execution_cost_read_length": 31147,
+    "execution_cost_runtime": 81975,
+    "execution_cost_write_count": 2,
+    "execution_cost_write_length": 123,
+    "tx_type": "contract_call",
+    "contract_call": {
+      "contract_id": "SP2H8PY27SEZ03MWRKS5XABZYQN17ETGQS3527SA5.newyorkcitycoin-core-v1",
+      "function_name": "claim-stacking-reward",
+      "function_signature": "(define-public (claim-stacking-reward (targetCycle uint)))",
+      "function_args": [
+        {
+          "hex": "0x0100000000000000000000000000000008",
+          "repr": "u8",
+          "name": "targetCycle",
+          "type": "uint"
+        }
+      ]
+    }
+  },
+  "stx_sent": "3000",
+  "stx_received": "4375722",
+  "stx_transfers": [
     {
-      "type": "stx",
-      "condition_code": "sent_less_than_or_equal_to",
-      "amount": "20000000",
-      "principal": {
-        "type_id": "principal_contract",
-        "contract_name": "stacks-skaters",
-        "address": "SPJW1XE278YMCEYMXB8ZFGJMH8ZVAAEDP2S2PJYG"
-      }
+      "amount": "4375722",
+      "sender": "SP2H8PY27SEZ03MWRKS5XABZYQN17ETGQS3527SA5.newyorkcitycoin-core-v1",
+      "recipient": "SP3BK1NNSWN719Z6KDW05RBGVS940YCN6X84STYPR"
     }
   ],
-  "anchor_mode": "any",
-  "tx_status": "pending",
-  "receipt_time": 1637172946,
-  "receipt_time_iso": "2021-11-17T18:15:46.000Z",
-  "tx_type": "contract_call",
-  "contract_call": {
-    "contract_id": "SPJW1XE278YMCEYMXB8ZFGJMH8ZVAAEDP2S2PJYG.stacks-skaters",
-    "function_name": "mint",
-    "function_signature": ""
-  }
+  "ft_transfers": [],
+  "nft_transfers": []
 }
 ```
 Subscribe via WebSockets:
@@ -399,6 +415,52 @@ Subscribe via Socket.io:
 sc.subscribeAddressStxBalance('SP3C5SSYVKPAWTR8Y63CVYBR65GD3MG7K80526D1Q');
 ```
 
+### NFT event updates
+
+Sent every time an NFT event occurs. You can subscribe to all events or events scoped to a single
+collection or a single asset.
+
+```json
+{
+  "asset_event_type": "transfer",
+  "asset_identifier": "SP176ZMV706NZGDDX8VSQRGMB7QN33BBDVZ6BMNHD.project-indigo-act1::Project-Indigo-Act1",
+  "value": {
+    "hex": "0x0100000000000000000000000000000095",
+    "repr": "u149"
+  },
+  "tx_id": "0xfb4bfc274007825dfd2d8f6c3f429407016779e9954775f82129108282d4c4ce",
+  "tx_index": 0,
+  "sender": null,
+  "recipient": "SP3BK1NNSWN719Z6KDW05RBGVS940YCN6X84STYPR",
+  "block_height": 45231,
+  "event_index": 0,
+}
+```
+Subscribe via WebSockets:
+```js
+client.subscribeNftEventUpdates(event => {});
+client.subscribeNftAssetEventUpdates(
+  'SP176ZMV706NZGDDX8VSQRGMB7QN33BBDVZ6BMNHD.project-indigo-act1::Project-Indigo-Act1',
+  '0x0100000000000000000000000000000095',
+  event => {}
+);
+client.subscribeNftCollectionEventUpdates(
+  'SP176ZMV706NZGDDX8VSQRGMB7QN33BBDVZ6BMNHD.project-indigo-act1::Project-Indigo-Act1',
+  event => {}
+);
+```
+Subscribe via Socket.io:
+```js
+sc.subscribeNftEventUpdates();
+sc.subscribeNftAssetEventUpdates(
+  'SP176ZMV706NZGDDX8VSQRGMB7QN33BBDVZ6BMNHD.project-indigo-act1::Project-Indigo-Act1',
+  '0x0100000000000000000000000000000095',
+);
+sc.subscribeNftCollectionEventUpdates(
+  'SP176ZMV706NZGDDX8VSQRGMB7QN33BBDVZ6BMNHD.project-indigo-act1::Project-Indigo-Act1',
+);
+```
+
 ## Known Issues
 
 - The TypeScript definitions for several objects involving type unions, including transactions, are incorrectly specified as only `object`.