feat: #302 add btc info to blocks, #301 pull stacks-node from dockerhub image

Author: zone117x

client/package-lock.json

@@ -9,8 +9,6 @@ services:
       POSTGRES_PASSWORD: postgres
       POSTGRES_DB: stacks_blockchain_api
       POSTGRES_PORT: 5432
-    volumes:
-      - database-data:/var/lib/postgresql/data/ # persist data even if container shuts down
     networks:
       - backend
   stacks-blockchain:
@@ -60,6 +58,3 @@ services:
 
 networks:
   backend:
-
-volumes:
-  database-data:

docker-compose.yml

@@ -5,5 +5,8 @@
   "parent_block_hash": "0x75ab21ef25cbff2caa14c27d830ed7886a4d1522e1b6f9e5dc3b59ccf73ed49f",
   "burn_block_time": 1594233639,
   "burn_block_time_iso": "2020-08-27T16:41:26.000Z",
+  "burn_block_hash": "0xb154c008df2101023a6d0d54986b3964cee58119eed14f5bed98e15678e18fe2",
+  "burn_block_height": 654439,
+  "miner_txid": "0xd7d56070277ccd87b42acf0c91f915dd181f9db4cf878a4e95518bc397c240cc",
   "txs": ["0x66557c219c6b0cdb40681ecf79a69f03654d88ef1910651a7db0b078f58af5ca"]
 }

docs/entities/blocks/block.example.json

@@ -3,7 +3,7 @@
   "title": "Block",
   "description": "A block",
   "type": "object",
-  "required": ["canonical", "height", "hash", "parent_block_hash", "txs", "burn_block_time", "burn_block_time_iso"],
+  "required": ["canonical", "height", "hash", "parent_block_hash", "txs", "burn_block_time", "burn_block_time_iso", "burn_block_hash", "burn_block_height", "miner_txid"],
   "properties": {
     "canonical": {
       "type": "boolean",
@@ -19,7 +19,7 @@
     },
     "parent_block_hash": {
       "type": "string",
-      "description": "Hash of the prant block"
+      "description": "Hash of the parent block"
     },
     "burn_block_time": {
       "type": "number",
@@ -29,6 +29,18 @@
       "type": "string",
       "description": "An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined."
     },
+    "burn_block_hash": {
+      "type": "string",
+      "description": "Hash of the anchor chain block"
+    },
+    "burn_block_height": {
+      "type": "integer",
+      "description": "Height of the anchor chain block"
+    },
+    "miner_txid": {
+      "type": "string",
+      "description": "Anchor chain transaction ID"
+    },
     "txs": {
       "type": "array",
       "description": "List of transactions included in the block",

docs/entities/blocks/block.schema.json

@@ -696,7 +696,7 @@ export interface Block {
    */
   hash: string;
   /**
-   * Hash of the prant block
+   * Hash of the parent block
    */
   parent_block_hash: string;
   /**
@@ -707,6 +707,18 @@ export interface Block {
    * An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined.
    */
   burn_block_time_iso: string;
+  /**
+   * Hash of the anchor chain block
+   */
+  burn_block_hash: string;
+  /**
+   * Height of the anchor chain block
+   */
+  burn_block_height: number;
+  /**
+   * Anchor chain transaction ID
+   */
+  miner_txid: string;
   /**
    * List of transactions included in the block
    */

docs/index.d.ts

@@ -8,17 +8,8 @@ RUN npm install
 RUN npm run build
 RUN npm prune --production
 
-
 ### Fetch stacks-node binary
-FROM everpeace/curl-jq as stacks-node-build
-ENV ARTIFACTS "http://blockstack-stacks-blockchain_artifacts.storage.googleapis.com/index.json"
-RUN curl -s "$ARTIFACTS" --output ./artifacts-resp.json \
-  && cat ./artifacts-resp.json | jq -r '."stacks-node-krypton"."linux-x64".latest.url' > ./url \
-  && mkdir -p /app \
-  && echo "Fetching $(cat ./url)" \
-  && curl --compressed $(cat ./url) --output /stacks-node \
-  && chmod +x /stacks-node
-
+FROM blockstack/stacks-blockchain:v23.0.0.10-krypton-stretch as stacks-node-build
 
 ### Begin building base image
 FROM ubuntu:focal
@@ -53,7 +44,7 @@ ENV PATH=$PATH:/home/stacky/.nvm/versions/node/v${NODE_VERSION}/bin
 RUN node -e 'console.log("Node.js runs")'
 
 ### Setup stacks-node
-COPY --from=stacks-node-build /stacks-node stacks-node/
+COPY --from=stacks-node-build /bin/stacks-node stacks-node/
 ENV PATH="$PATH:$HOME/stacks-node"
 
 #### Copy stacks-node mocknet config

follower.Dockerfile

@@ -24,7 +24,7 @@
     "devenv:follower": "docker-compose -f docker-compose.dev.postgres.yml -f docker-compose.dev.stacks-blockchain-follower.yml up",
     "devenv:stop": "docker-compose -f docker-compose.dev.postgres.yml -f docker-compose.dev.stacks-blockchain.yml -f docker-compose.dev.bitcoind.yml down -v -t 0",
     "devenv:logs": "docker-compose -f docker-compose.dev.postgres.yml -f docker-compose.dev.stacks-blockchain.yml -f docker-compose.dev.bitcoind.yml logs -t -f",
-    "docs:generate": "cd docs && npm run generate:types && npm run generate:docs && cd ../client && typedoc",
+    "docs:generate": "cd docs && npm run generate:types && npm run generate:docs && cd ../client && npm run generate:docs",
     "docs:deploy": "npm run docs:generate && cd docs && gulp deployDocs"
   },
   "repository": {

package.json

@@ -293,6 +293,9 @@ export async function getBlockFromDataStore(
     parent_block_hash: dbBlock.parent_block_hash,
     burn_block_time: dbBlock.burn_block_time,
     burn_block_time_iso: unixEpochToIso(dbBlock.burn_block_time),
+    burn_block_hash: dbBlock.burn_block_hash,
+    burn_block_height: dbBlock.burn_block_height,
+    miner_txid: dbBlock.miner_txid,
     txs: txIds.results,
   };
   return { found: true, result: apiBlock };

src/api/controllers/db-controller.ts

@@ -16,6 +16,9 @@ import { getTxSenderAddress } from '../event-stream/reader';
 export interface DbBlock {
   block_hash: string;
   burn_block_time: number;
+  burn_block_hash: string;
+  burn_block_height: number;
+  miner_txid: string;
   index_block_hash: string;
   parent_index_block_hash: string;
   parent_block_hash: string;

src/datastore/common.ts

@@ -151,7 +151,8 @@ const MEMPOOL_TX_ID_COLUMNS = `
 `;
 
 const BLOCK_COLUMNS = `
-  block_hash, index_block_hash, parent_index_block_hash, parent_block_hash, parent_microblock, block_height, burn_block_time, canonical
+  block_hash, index_block_hash, parent_index_block_hash, parent_block_hash, parent_microblock, block_height, 
+  burn_block_time, burn_block_hash, burn_block_height, miner_txid, canonical
 `;
 
 interface BlockQueryResult {
@@ -162,6 +163,9 @@ interface BlockQueryResult {
   parent_microblock: Buffer;
   block_height: number;
   burn_block_time: number;
+  burn_block_hash: Buffer;
+  burn_block_height: number;
+  miner_txid: Buffer;
   canonical: boolean;
 }
 
@@ -787,8 +791,9 @@ export class PgDataStore extends (EventEmitter as { new (): DataStoreEventEmitte
     const result = await client.query(
       `
       INSERT INTO blocks(
-        block_hash, index_block_hash, parent_index_block_hash, parent_block_hash, parent_microblock, block_height, burn_block_time, canonical
-      ) values($1, $2, $3, $4, $5, $6, $7, $8)
+        block_hash, index_block_hash, parent_index_block_hash, parent_block_hash, parent_microblock, block_height, 
+        burn_block_time, burn_block_hash, burn_block_height, miner_txid, canonical
+      ) values($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11)
       ON CONFLICT (index_block_hash)
       DO NOTHING
       `,
@@ -800,6 +805,9 @@ export class PgDataStore extends (EventEmitter as { new (): DataStoreEventEmitte
         hexToBuffer(block.parent_microblock),
         block.block_height,
         block.burn_block_time,
+        hexToBuffer(block.burn_block_hash),
+        block.burn_block_height,
+        hexToBuffer(block.miner_txid),
         block.canonical,
       ]
     );
@@ -815,6 +823,9 @@ export class PgDataStore extends (EventEmitter as { new (): DataStoreEventEmitte
       parent_microblock: bufferToHexPrefixString(row.parent_microblock),
       block_height: row.block_height,
       burn_block_time: row.burn_block_time,
+      burn_block_hash: bufferToHexPrefixString(row.burn_block_hash),
+      burn_block_height: row.burn_block_height,
+      miner_txid: bufferToHexPrefixString(row.miner_txid),
       canonical: row.canonical,
     };
     return block;