Merge pull request #1052 from hirosystems/develop

Merge develop in master -- release v2.1.0

Author: zone117x

.env

@@ -5,6 +5,10 @@ PG_PASSWORD=postgres
 PG_DATABASE=stacks_blockchain_api
 PG_SCHEMA=public
 PG_SSL=false
+
+# Can be any string, use to specify a use case specific to a deployment
+PG_APPLICATION_NAME=stacks-blockchain-api
+
 # The connection URI below can be used in place of the PG variables above,
 # but if enabled it must be defined without others or omitted.
 # PG_CONNECTION_URI=
@@ -96,6 +100,12 @@ MAINNET_SEND_MANY_CONTRACT_ID=SP3FBR2AGK5H9QBDH3EEN6DF8EK8JY7RX8QJ5SVTE.send-man
 # STACKS_API_ENABLE_FT_METADATA=1
 # STACKS_API_ENABLE_NFT_METADATA=1
 
+# 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=
+
 # Configure a script to handle image URLs during token metadata processing.
 # This example script uses the `imgix.net` service to create CDN URLs.
 # Must be an executable script that accepts the URL as the first program argument

.github/workflows/ci.yml

@@ -57,6 +57,8 @@ jobs:
         working-directory: ./docs
     steps:
       - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
 
       - name: Use Node.js
         uses: actions/setup-node@v2
@@ -290,12 +292,12 @@ jobs:
         run: echo "STACKS_CORE_EVENT_HOST=http://0.0.0.0">> $GITHUB_ENV
 
       - name: Setup cli enviroment variable
-        run: | 
+        run: |
           echo STACKS_BLOCKCHAIN_API_HOST=0.0.0.0>> .env
           echo STACKS_CORE_PROXY_HOST=0.0.0.0 >> .env
           echo STACKS_CORE_RPC_HOST=0.0.0.0 >> .env
           echo STACKS_CORE_EVENT_HOST=0.0.0.0 >> .env 
-          echo BTC_RPC_HOST=http://0.0.0.0 >> .env 
+          echo BTC_RPC_HOST=http://0.0.0.0 >> .env
 
       - name: Setup integration environment
         run: |
@@ -347,14 +349,14 @@ jobs:
 
       - name: Setup env vars
         run: echo "STACKS_CORE_EVENT_HOST=http://0.0.0.0">> $GITHUB_ENV
-      
+
       - name: Setup cli enviroment variable
-        run: | 
+        run: |
           echo STACKS_BLOCKCHAIN_API_HOST=0.0.0.0>> .env
           echo STACKS_CORE_PROXY_HOST=0.0.0.0 >> .env
           echo STACKS_CORE_RPC_HOST=0.0.0.0 >> .env
           echo STACKS_CORE_EVENT_HOST=0.0.0.0 >> .env 
-          echo BTC_RPC_HOST=http://0.0.0.0 >> .env 
+          echo BTC_RPC_HOST=http://0.0.0.0 >> .env
 
       - name: Setup integration environment
         run: |

docs/package.json

@@ -13,7 +13,7 @@
     "lint:openapi": "lint-openapi ./openapi.yaml",
     "generate:types": "ts-node ./scripts/generate-types.ts",
     "generate:schemas": "gulp && npm run generate:types",
-    "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:git-info": "npm run generate: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,schemaFaker=false 2>/dev/null",
     "validate:schemas": "rimraf .tmp && gulp flattenSchemas --silent && ts-node ./scripts/validate-schemas.ts",

git-info-generator.mjs

@@ -0,0 +1,23 @@
+import { execSync } from 'child_process';
+import { writeFileSync } from 'fs';
+
+try {
+  execSync('git --version');
+} catch (error) {
+  console.error(error.message);
+  throw new Error(`git is missing, please install git and retry`);
+}
+const gitInfo = [
+  'git rev-parse --abbrev-ref HEAD',
+  'git log -1 --pretty=format:%h',
+  'git describe --tags --abbrev=0',
+].map((r, index) => {
+  try {
+    return execSync(r, { encoding: 'utf8' }).trim();
+  } catch (error) {
+    console.error(error.message);
+    if (index === 2) throw new Error(`no tag found fetch tags by running "git fetch --all --tags"`);
+    throw error;
+  }
+});
+writeFileSync('.git-info', gitInfo.join('\n'));

package-lock.json

@@ -20,8 +20,8 @@
     "test:integration:bns": "npm run devenv:deploy -- -d && cross-env NODE_ENV=development jest --config ./jest.config.bns.js --coverage --no-cache --runInBand; npm run devenv:stop",
     "test:integration:microblocks": "npm run devenv:deploy:pg -- -d && cross-env NODE_ENV=development jest --config ./jest.config.microblocks.js --coverage --no-cache --runInBand; npm run devenv:stop:pg",
     "test:integration:tokens": "npm run devenv:deploy -- -d && cross-env NODE_ENV=development jest --config ./jest.config.tokens.js --coverage --no-cache --runInBand; npm run devenv:stop",
-    "git-info": "echo \"$(git rev-parse --abbrev-ref HEAD)\n$(git log -1 --pretty=format:%h)\n$(git describe --tags --abbrev=0)\" > ./.git-info",
-    "build": "npm run git-info && rimraf ./lib && tsc -p tsconfig.build.json",
+    "generate:git-info": "node ./git-info-generator.mjs",
+    "build": "npm run generate:git-info && rimraf ./lib && tsc -p tsconfig.build.json",
     "build:tests": "tsc -p tsconfig.json",
     "build:docs": "npm i --prefix docs && npm run build --prefix docs && npm i --prefix client && npm run generate:docs --prefix client",
     "start": "node ./lib/index.js",
@@ -127,7 +127,7 @@
     "lru-cache": "^6.0.0",
     "micro-base58": "^0.5.0",
     "node-fetch": "^2.6.0",
-    "node-pg-migrate": "^5.9.0",
+    "node-pg-migrate": "^6.2.1",
     "p-queue": "^6.3.0",
     "path-to-regexp": "^6.2.0",
     "pg": "^8.2.1",

package.json

@@ -695,7 +695,7 @@ export function parseContractCallMetadata(tx: BaseTx): ContractCallTransactionMe
   let functionAbi: ClarityAbiFunction | undefined;
   const abi = tx.abi;
   if (abi) {
-    const contractAbi: ClarityAbi = typeof abi === 'string' ? JSON.parse(abi) : abi;
+    const contractAbi: ClarityAbi = JSON.parse(abi);
     functionAbi = contractAbi.functions.find(fn => fn.name === functionName);
     if (!functionAbi) {
       throw new Error(`Could not find function name "${functionName}" in ABI for ${contractId}`);

src/api/controllers/db-controller.ts

@@ -32,7 +32,7 @@ export function createContractRouter(db: DataStore): express.Router {
       }
       const contractResults = smartContracts.result.map(contract => ({
         ...contract,
-        abi: JSON.stringify(contract.abi),
+        abi: contract.abi,
       }));
       res.json({ limit, offset, results: contractResults });
     })
@@ -49,7 +49,7 @@ export function createContractRouter(db: DataStore): express.Router {
       }
       const contractResult = {
         ...contractQuery.result,
-        abi: JSON.stringify(contractQuery.result.abi),
+        abi: contractQuery.result.abi,
       };
       res.json(contractResult);
     })

src/api/routes/contract.ts

@@ -755,7 +755,7 @@ export function createDebugRouter(db: DataStore): express.Router {
         res.status(404).json({ error: `cannot find contract by ID ${contract_id}` });
         return;
       }
-      const contractAbi: ClarityAbi = dbContractQuery.result.abi as any;
+      const contractAbi: ClarityAbi = JSON.parse(dbContractQuery.result.abi as string);
       let formHtml = contractCallHtml;
       let funcHtml = '';
 
@@ -805,7 +805,7 @@ export function createDebugRouter(db: DataStore): express.Router {
         res.status(404).json({ error: `could not find contract by ID ${contractId}` });
         return;
       }
-      const contractAbi: ClarityAbi = dbContractQuery.result.abi as any;
+      const contractAbi: ClarityAbi = JSON.parse(dbContractQuery.result.abi as string);
 
       const body = req.body as Record<string, string>;
       const originKey = body['origin_key'];

src/api/routes/debug.ts

@@ -27,7 +27,7 @@ export function createRosettaAccountRouter(db: DataStore, chainId: ChainID): exp
     asyncHandler(async (req, res) => {
       const valid: ValidSchema = await rosettaValidateRequest(req.originalUrl, req.body, chainId);
       if (!valid.valid) {
-        res.status(500).json(makeRosettaError(valid));
+        res.status(400).json(makeRosettaError(valid));
         return;
       }
 
@@ -38,7 +38,7 @@ export function createRosettaAccountRouter(db: DataStore, chainId: ChainID): exp
       let blockHash: string = '0x';
 
       if (accountIdentifier === undefined) {
-        res.status(500).json(RosettaErrors[RosettaErrorsTypes.emptyAccountIdentifier]);
+        res.status(400).json(RosettaErrors[RosettaErrorsTypes.emptyAccountIdentifier]);
         return;
       }
 
@@ -55,7 +55,7 @@ export function createRosettaAccountRouter(db: DataStore, chainId: ChainID): exp
         }
         blockQuery = await db.getBlock({ hash: blockHash });
       } else {
-        res.status(500).json(RosettaErrors[RosettaErrorsTypes.invalidBlockIdentifier]);
+        res.status(400).json(RosettaErrors[RosettaErrorsTypes.invalidBlockIdentifier]);
         return;
       }
 
@@ -67,7 +67,7 @@ export function createRosettaAccountRouter(db: DataStore, chainId: ChainID): exp
       const block = blockQuery.result;
 
       if (blockIdentifier?.hash !== undefined && block.block_hash !== blockIdentifier.hash) {
-        res.status(500).json(RosettaErrors[RosettaErrorsTypes.invalidBlockHash]);
+        res.status(400).json(RosettaErrors[RosettaErrorsTypes.invalidBlockHash]);
         return;
       }
 
@@ -114,7 +114,7 @@ export function createRosettaAccountRouter(db: DataStore, chainId: ChainID): exp
             }
             break;
           default:
-            res.status(500).json(RosettaErrors[RosettaErrorsTypes.invalidSubAccount]);
+            res.status(400).json(RosettaErrors[RosettaErrorsTypes.invalidSubAccount]);
             return;
         }
       }