Merge pull request #1185 from hirosystems/beta

release api v4.0.0

Author: rafaelcr

.env

@@ -51,6 +51,11 @@ PG_APPLICATION_NAME=stacks-blockchain-api
 # (with both Event Server and API endpoints).
 # STACKS_API_MODE=
 
+# Stacks nodes automatically perform garbage-collection by dropping transactions from the mempool if they
+# are pending for more than 256 blocks. This variable controls the block age threshold at which the API will do
+# the same.
+# STACKS_MEMPOOL_TX_GARBAGE_COLLECTION_THRESHOLD=256
+
 # If specified, an http server providing profiling capability endpoints will be opened on the given port.
 # This port should not be publicly exposed.
 # STACKS_PROFILER_PORT=9119
@@ -100,11 +105,21 @@ MAINNET_SEND_MANY_CONTRACT_ID=SP3FBR2AGK5H9QBDH3EEN6DF8EK8JY7RX8QJ5SVTE.send-man
 # STACKS_API_ENABLE_FT_METADATA=1
 # STACKS_API_ENABLE_NFT_METADATA=1
 
+# If token metadata processing is enabled, this variable determines how the API reacts to metadata processing failures.
+# When strict mode is enabled, any failures caused by recoverable errors will be retried indefinitely. Otherwise,
+# the API will give up after `STACKS_API_TOKEN_METADATA_MAX_RETRIES` is reached for that smart contract.
+# STACKS_API_TOKEN_METADATA_STRICT_MODE=1
+
+# Maximum number of times we'll try processing FT/NFT metadata for a specific smart contract if we've failed
+# because of a recoverable error.
+# Only used if `STACKS_API_TOKEN_METADATA_STRICT_MODE` is disabled.
+# STACKS_API_TOKEN_METADATA_MAX_RETRIES=5
+
 # Controls the token metadata error handling mode. The possible values are:
 # * `warning`: If required metadata is not found, the API will issue a warning and not display data for that token.
 # * `error`: If required metadata is not found, the API will throw an error.
 # If not specified or any other value is provided, the mode will be set to `warning`.
-# STACKS_API_TOKEN_METADATA_ERROR_MODE=
+# STACKS_API_TOKEN_METADATA_ERROR_MODE=warning
 
 # Configure a script to handle image URLs during token metadata processing.
 # This example script uses the `imgix.net` service to create CDN URLs.

.eslintrc.js

@@ -30,5 +30,6 @@ module.exports = {
 
     // TODO: temporarily disable this until the express async handler is typed correctly
     '@typescript-eslint/no-misused-promises': 'off',
+    '@typescript-eslint/no-unsafe-argument': 'off',
   },
 };

.github/workflows/ci.yml

@@ -160,6 +160,14 @@ jobs:
         uses: codecov/codecov-action@v2
         if: always()
 
+      - name: Upload coverage to Coveralls
+        uses: coverallsapp/github-action@master
+        if: always()
+        with:
+          github-token: ${{ secrets.github_token }}
+          flag-name: run-${{ github.job }}
+          parallel: true
+
   test-bns:
     runs-on: ubuntu-latest
     steps:
@@ -211,6 +219,14 @@ jobs:
         uses: codecov/codecov-action@v2
         if: always()
 
+      - name: Upload coverage to Coveralls
+        uses: coverallsapp/github-action@master
+        if: always()
+        with:
+          github-token: ${{ secrets.github_token }}
+          flag-name: run-${{ github.job }}
+          parallel: true
+
   test-rosetta:
     runs-on: ubuntu-latest
     steps:
@@ -262,6 +278,14 @@ jobs:
         uses: codecov/codecov-action@v2
         if: always()
 
+      - name: Upload coverage to Coveralls
+        uses: coverallsapp/github-action@master
+        if: always()
+        with:
+          github-token: ${{ secrets.github_token }}
+          flag-name: run-${{ github.job }}
+          parallel: true
+
   test-rosetta-cli-data:
     runs-on: ubuntu-latest
     steps:
@@ -321,6 +345,14 @@ jobs:
         uses: codecov/codecov-action@v2
         if: always()
 
+      - name: Upload coverage to Coveralls
+        uses: coverallsapp/github-action@master
+        if: always()
+        with:
+          github-token: ${{ secrets.github_token }}
+          flag-name: run-${{ github.job }}
+          parallel: true
+
   test-rosetta-cli-construction:
     runs-on: ubuntu-latest
     steps:
@@ -380,6 +412,14 @@ jobs:
         uses: codecov/codecov-action@v2
         if: always()
 
+      - name: Upload coverage to Coveralls
+        uses: coverallsapp/github-action@master
+        if: always()
+        with:
+          github-token: ${{ secrets.github_token }}
+          flag-name: run-${{ github.job }}
+          parallel: true
+
   test-tokens:
     runs-on: ubuntu-latest
     steps:
@@ -417,6 +457,30 @@ jobs:
         uses: codecov/codecov-action@v2
         if: always()
 
+      - name: Upload coverage to Coveralls
+        uses: coverallsapp/github-action@master
+        if: always()
+        with:
+          github-token: ${{ secrets.github_token }}
+          flag-name: run-${{ github.job }}
+          parallel: true
+
+  upload-coveralls:
+    runs-on: ubuntu-latest
+    needs:
+      - test
+      - test-bns
+      - test-rosetta
+      - test-rosetta-cli-construction
+      - test-rosetta-cli-data
+      - test-tokens
+    steps:
+    - name: Coveralls Finished
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.github_token }}
+        parallel-finished: true
+
   build-publish:
     runs-on: ubuntu-latest
     needs:
@@ -504,3 +568,18 @@ jobs:
           cache-to: type=gha,mode=max
           # Only push if (there's a new release on main branch, or if building a non-main branch) and (Only run on non-PR events or only PRs that aren't from forks)
           push: ${{ (github.ref != 'refs/heads/master' || steps.semantic.outputs.new_release_version != '') && (github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository) }}
+
+      - name: API Discord notification
+        if: steps.semantic.outputs.new_release_version != ''
+        uses: Ilshidur/action-discord@f1ed8844d9b33c17221fab0f36672cde39800eed
+        env:
+          DISCORD_WEBHOOK: ${{ secrets.DISCORD_API_WEBHOOK }}
+          DISCORD_USERNAME: Hiro Team
+          DISCORD_AVATAR: 'https://i.imgur.com/z9Iy6ug.png'
+          DISCORD_EMBEDS: |
+            [{
+              "title": "API Release: ${{ steps.semantic.outputs.new_release_version }}",
+              "url": "https://github.com/hirosystems/stacks-blockchain-api/releases/tag/v${{ steps.semantic.outputs.new_release_version }}"
+            }]
+        with:
+          args: ":rocket: A new version (${{ steps.semantic.outputs.new_release_version }}) of the Stacks Blockchain API is available on Github!"

.gitpod.Dockerfile

@@ -15,7 +15,6 @@ ENV STACKS_CORE_EVENT_PORT 3700
 ENV STACKS_CORE_EVENT_HOST http://0.0.0.0
 ENV STACKS_BLOCKCHAIN_API_PORT 3999
 ENV STACKS_BLOCKCHAIN_API_HOST 0.0.0.0
-ENV STACKS_BLOCKCHAIN_API_DB pg
 ENV STACKS_CORE_RPC_HOST 127.0.0.1
 ENV STACKS_CORE_RPC_PORT 20443
 ENV NODE_ENV development

.prettierignore

@@ -3,3 +3,4 @@ src/migrations/*
 src/tests-rosetta/
 src/tests-rosetta-cli/
 src/tests-bns/
+src/tests/synthetic-tx-payloads/

.vscode/launch.json

@@ -42,7 +42,6 @@
       "preLaunchTask": "stacks-node:deploy-dev",
       "postDebugTask": "stacks-node:stop-dev",
       "env": {
-        "STACKS_BLOCKCHAIN_API_DB": "pg",
         "STACKS_CHAIN_ID": "0x80000000",
         "NODE_ENV": "development",
         "TS_NODE_SKIP_IGNORE": "true"
@@ -64,7 +63,6 @@
       "postDebugTask": "stacks-node:stop-dev",
       "env": {
         "STACKS_API_MODE": "writeonly",
-        "STACKS_BLOCKCHAIN_API_DB": "pg",
         "STACKS_CHAIN_ID": "0x80000000",
         "NODE_ENV": "development",
         "TS_NODE_SKIP_IGNORE": "true"
@@ -92,9 +90,8 @@
       "env": {
         "STACKS_BLOCKCHAIN_API_PORT": "3998",
         "STACKS_API_MODE": "readonly",
-        "STACKS_BLOCKCHAIN_API_DB": "pg",
-        "STACKS_CHAIN_ID": "0x80000000",
-        "NODE_ENV": "development",
+        "STACKS_CHAIN_ID": "0x00000001",
+        "NODE_ENV": "production",
         "TS_NODE_SKIP_IGNORE": "true"
       },
       "killBehavior": "polite",
@@ -110,7 +107,6 @@
       "preLaunchTask": "stacks-node:deploy-follower",
       "postDebugTask": "stacks-node:stop-dev",
       "env": {
-        "STACKS_BLOCKCHAIN_API_DB": "pg",
         "STACKS_CHAIN_ID": "0x00000001",
         "NODE_ENV": "development",
         "TS_NODE_SKIP_IGNORE": "true"
@@ -239,7 +235,7 @@
       "runtimeArgs": ["-r", "ts-node/register/transpile-only"],
       "cwd": "${workspaceFolder}/utils",
       "args": ["${workspaceFolder}/utils/src/chaintip-cache-control-test.ts"]
-    }
+    },
   ],
   "compounds": [
     {

CHANGELOG.md

@@ -1,3 +1,78 @@
+# [4.0.0-beta.8](https://github.com/hirosystems/stacks-blockchain-api/compare/v4.0.0-beta.7...v4.0.0-beta.8) (2022-05-26)
+
+
+### Bug Fixes
+
+* treat incorrect `get-token-uri` none values as undefined ([#1183](https://github.com/hirosystems/stacks-blockchain-api/issues/1183)) ([33313b1](https://github.com/hirosystems/stacks-blockchain-api/commit/33313b1d78e75a1900de9162cd97a76ff0a64ee0))
+
+# [4.0.0-beta.7](https://github.com/hirosystems/stacks-blockchain-api/compare/v4.0.0-beta.6...v4.0.0-beta.7) (2022-05-25)
+
+
+### Bug Fixes
+
+* use 128 max size when deserializing contract principals [#1181](https://github.com/hirosystems/stacks-blockchain-api/issues/1181) ([#1182](https://github.com/hirosystems/stacks-blockchain-api/issues/1182)) ([f4d4733](https://github.com/hirosystems/stacks-blockchain-api/commit/f4d4733ad4956c6acc36f73337cc55b6aae5c5fb))
+
+# [4.0.0-beta.6](https://github.com/hirosystems/stacks-blockchain-api/compare/v4.0.0-beta.5...v4.0.0-beta.6) (2022-05-20)
+
+
+### Bug Fixes
+
+* propagate chain id correctly to bns router ([#1180](https://github.com/hirosystems/stacks-blockchain-api/issues/1180)) ([3a0ead1](https://github.com/hirosystems/stacks-blockchain-api/commit/3a0ead18fd3d65ec8221feada334477ebb576805))
+
+# [4.0.0-beta.5](https://github.com/hirosystems/stacks-blockchain-api/compare/v4.0.0-beta.4...v4.0.0-beta.5) (2022-05-17)
+
+
+### Features
+
+* add strict ft/nft metadata processing mode for better error handling ([#1165](https://github.com/hirosystems/stacks-blockchain-api/issues/1165)) ([b9ca4bb](https://github.com/hirosystems/stacks-blockchain-api/commit/b9ca4bb69d7f78c634c076855652937e0e1743f1))
+
+# [4.0.0-beta.4](https://github.com/hirosystems/stacks-blockchain-api/compare/v4.0.0-beta.3...v4.0.0-beta.4) (2022-05-17)
+
+
+### Bug Fixes
+
+* resolve bns names correctly in `/v1/addresses/stacks/[:address]` ([#1175](https://github.com/hirosystems/stacks-blockchain-api/issues/1175)) ([8797ded](https://github.com/hirosystems/stacks-blockchain-api/commit/8797ded691acab322c6c671403ea60bf1bc27294))
+
+# [4.0.0-beta.3](https://github.com/hirosystems/stacks-blockchain-api/compare/v4.0.0-beta.2...v4.0.0-beta.3) (2022-05-11)
+
+
+### Features
+
+* add block height to responses in `/extended/v1/tokens/nft/holdings` ([#1151](https://github.com/hirosystems/stacks-blockchain-api/issues/1151)) ([7cc8bd0](https://github.com/hirosystems/stacks-blockchain-api/commit/7cc8bd06339a9bf53ef5d133ef4885b26e48cd18))
+
+# [4.0.0-beta.2](https://github.com/hirosystems/stacks-blockchain-api/compare/v4.0.0-beta.1...v4.0.0-beta.2) (2022-05-04)
+
+
+### Bug Fixes
+
+* `/v1/names/[:name]` name resolution ([#1159](https://github.com/hirosystems/stacks-blockchain-api/issues/1159)) ([e656520](https://github.com/hirosystems/stacks-blockchain-api/commit/e656520701bea584fe7336c1a26388406cd167fe))
+
+# [4.0.0-beta.1](https://github.com/hirosystems/stacks-blockchain-api/compare/v3.0.3...v4.0.0-beta.1) (2022-04-20)
+
+
+### Bug Fixes
+
+* bns download script download path ([#1091](https://github.com/hirosystems/stacks-blockchain-api/issues/1091)) ([55fa41e](https://github.com/hirosystems/stacks-blockchain-api/commit/55fa41eb31fcc1869a4c16de36ad4f01be9565a9))
+* disable notifier for tests that don't need it ([#1102](https://github.com/hirosystems/stacks-blockchain-api/issues/1102)) ([9765cf0](https://github.com/hirosystems/stacks-blockchain-api/commit/9765cf06819767cae88eab6c106bc1d0bd87e47e))
+* shorten token metadata pg notifications ([#1143](https://github.com/hirosystems/stacks-blockchain-api/issues/1143)) ([1f09c0e](https://github.com/hirosystems/stacks-blockchain-api/commit/1f09c0e2bffb42a680e899848980b13a6652d51f))
+
+
+* feat!: prune garbage collected (256 blocks old) mempool txs (#1101) ([fe56756](https://github.com/hirosystems/stacks-blockchain-api/commit/fe56756cdeb3c71dbd2ebbbf820bc2a56fc35f02)), closes [#1101](https://github.com/hirosystems/stacks-blockchain-api/issues/1101)
+
+
+### Features
+
+* [CPU optimizations] use native rust module for decoding Clarity values, binary transaction blobs, post-condition binary blobs, Stacks addresses ([#1094](https://github.com/hirosystems/stacks-blockchain-api/issues/1094)) ([f5c4da7](https://github.com/hirosystems/stacks-blockchain-api/commit/f5c4da7b87e7eacecc6cd5d7075ecd0a39127ea0))
+* add `pruned` event import mode that ignores some historical events ([#1125](https://github.com/hirosystems/stacks-blockchain-api/issues/1125)) ([da992d7](https://github.com/hirosystems/stacks-blockchain-api/commit/da992d77b18bd49eef36e32b1d96d7e924d84cfc))
+* events-only endpoint for address and tx_id ([#1027](https://github.com/hirosystems/stacks-blockchain-api/issues/1027)) ([508afc7](https://github.com/hirosystems/stacks-blockchain-api/commit/508afc7b09641b79d5c8136b70088fc471f94433))
+* fetch subdomain list for bns name ([#1132](https://github.com/hirosystems/stacks-blockchain-api/issues/1132)) ([e34120f](https://github.com/hirosystems/stacks-blockchain-api/commit/e34120f70bcad5c6474f7631cad31fb04b9dfdfa))
+* pin exact dependencies in package.json ([#1068](https://github.com/hirosystems/stacks-blockchain-api/issues/1068)) ([303eaaa](https://github.com/hirosystems/stacks-blockchain-api/commit/303eaaa8cd520cf8db89a4ef359ca739a945cbbc))
+
+
+### BREAKING CHANGES
+
+* use event-replay to upgrade, this version includes breaking changes to the db sql schema
+
 ## [3.0.3](https://github.com/hirosystems/stacks-blockchain-api/compare/v3.0.2...v3.0.3) (2022-04-04)
 
 

docker/docker-compose.dev.postgres.yml

@@ -1,7 +1,7 @@
 version: '3.7'
 services:
   postgres:
-    image: "postgres:12.2"
+    image: "postgres:14"
     ports:
       - "5490:5432"
     environment:

docker/docker-compose.yml

@@ -1,7 +1,7 @@
 version: '3.7'
 services:
   postgres:
-    image: "postgres:12.2"
+    image: "postgres:14"
     ports:
       - "5490:5432"
     environment:
@@ -42,7 +42,6 @@ services:
       STACKS_CORE_EVENT_HOST: http://0.0.0.0
       STACKS_BLOCKCHAIN_API_PORT: 3999
       STACKS_BLOCKCHAIN_API_HOST: 0.0.0.0
-      STACKS_BLOCKCHAIN_API_DB: pg
       STACKS_CORE_RPC_HOST: stacks-blockchain
       STACKS_CORE_RPC_PORT: 20443
       NODE_ENV: development