Merge branch 'master' into develop

2026-01-12 16:53:19 +08:00 · 2021-12-20 16:29:06 +01:00
parent f02902cc5a 949a96d3fa
commit d47e51de27
4 changed files with 30 additions and 161 deletions
--- a/.github/workflows/stacks-blockchain-api.yml
+++ b/.github/workflows/stacks-blockchain-api.yml
@@ -3,8 +3,7 @@ name: stacks-blockchain-api
 on:
  push:
    branches:
-      - master
-      - develop
+      - '**'
    tags-ignore:
      - '**'
    paths-ignore:
--- a/docs/openapi.yaml
+++ b/docs/openapi.yaml
@@ -455,7 +455,7 @@ paths:
      summary: Broadcast raw transaction
      tags:
        - Transactions
-      description: Broadcast raw transactions on the network. You can use the [@stacks/transactions](https://github.com/blockstack/stacks.js) project to generate a raw transaction payload.
+      description: Broadcasts raw transactions on the network. You can use the [@stacks/transactions](https://github.com/blockstack/stacks.js) project to generate a raw transaction payload.
      operationId: post_core_node_transactions
      requestBody:
        content:
@@ -487,6 +487,7 @@ paths:
      tags:
        - Microblocks
      operationId: get_microblock_list
+      description: Retrieves a list of microblocks.
      parameters:
        - name: limit
          in: query
@@ -520,7 +521,7 @@ paths:
          type: string
    get:
      summary: Get microblock
-      description: Get a specific microblock by hash
+      description: Retrieves a specific microblock by `hash`
      tags:
        - Microblocks
      operationId: get_microblock_by_hash
@@ -839,7 +840,7 @@ paths:
  /extended/v1/burnchain/rewards/{address}/total:
    get:
      summary: Get total burnchain rewards for the given recipient
-      description: Retrieves the total burnchain (e.g. Bitcoin) rewards for a given recipient
+      description: Retrieves the total burnchain (e.g. Bitcoin) rewards for a given recipient `address`
      tags:
        - Stacking Rewards
      operationId: get_burnchain_rewards_total_by_address
@@ -863,7 +864,7 @@ paths:
  /extended/v1/contract/{contract_id}:
    get:
      summary: Get contract info
-      description: Retrieves details of a contract with a given contract ID
+      description: Retrieves details of a contract with a given `contract_id`
      tags:
        - Smart Contracts
      operationId: get_contract_by_id
@@ -932,7 +933,7 @@ paths:
  /extended/v1/contract/{contract_id}/events:
    get:
      summary: Get contract events
-      description: Retrieves a list of events that have been triggered by a given Contract Id
+      description: Retrieves a list of events that have been triggered by a given `contract_id`
      tags:
        - Smart Contracts
      operationId: get_contract_events_by_id
@@ -1014,7 +1015,7 @@ paths:
        - Smart Contracts
      operationId: get_contract_data_map_entry
      description: |
-        Attempt to fetch data from a contract data map. The contract is identified with [Stacks Address] and [Contract Name] in the URL path. The map is identified with [Map Name].
+        Attempt to fetch data from a contract data map. The contract is identified with Stacks Address `contract_address` and Contract Name `contract_address` in the URL path. The map is identified with [Map Name].

        The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom.

@@ -1301,7 +1302,7 @@ paths:
  /extended/v1/address/{principal}/{tx_id}/with_transfers:
    get:
      summary: Get account transaction information for specific transaction
-      description: Retrieves transaction details for a given Transcation Id, for a given account or contract Identifier.
+      description: Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
      tags:
        - Accounts
      operationId: get_single_transaction_with_transfers
@@ -1576,11 +1577,11 @@ paths:
        - Accounts
      operationId: get_account_info
      description: |
-        Retrieves the account data for the a given Account or a Contract Identifier
+        Retrieves the account data for a given Account or a Contract Identifier

-        Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is a unsigned 64-bit integer, and the proofs are provided as hex strings.
+        Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is an unsigned 64-bit integer, and the proofs are provided as hex strings.

-        For non-existent accounts, this does not 404, rather it returns an object with balance and nonce of 0.
+        For non-existent accounts, this does not return a 404 error, rather it returns an object with balance and nonce of 0.
      parameters:
        - name: principal
          in: path
@@ -1644,7 +1645,7 @@ paths:
  /extended/v1/status:
    get:
      summary: Get Blockchain API status
-      description: Retrieves Blockchain API status, including the server version
+      description: Retrieves the current status of the blockchain API, including the server version
      tags:
        - Info
      operationId: get_status
@@ -2417,7 +2418,7 @@ paths:
  /v1/names/{name}:
    get:
      summary: Get Name Details
-      description: Retrieves details of a given name including the address, status and last transaction id.
+      description: Retrieves details of a given name including the `address`, `status` and last transaction id - `last_txid`.
      tags:
        - Names
      operationId: get_name_info
--- a/src/migrations/1636741389602_latest_contract_txs.ts
+++ b/src/migrations/1636741389602_latest_contract_txs.ts
@@ -48,10 +48,25 @@ export async function up(pgm: MigrationBuilder): Promise<void> {
          PARTITION BY contract_id
          ORDER BY block_height DESC, microblock_sequence DESC, tx_index DESC
        ) AS r,
+        COUNT(*) OVER (
+          PARTITION BY contract_id
+        )::integer AS count,
        contract_txs.*
      FROM contract_txs
    )
-    SELECT numbered_txs.contract_id, txs.*
+    SELECT
+      numbered_txs.contract_id,
+      txs.*,
+      CASE
+        WHEN txs.type_id = 2 THEN (
+          SELECT abi
+          FROM smart_contracts
+          WHERE smart_contracts.contract_id = txs.contract_call_contract_id
+          ORDER BY abi != 'null' DESC, canonical DESC, microblock_canonical DESC, block_height DESC
+          LIMIT 1
+        )
+      END as abi,
+      numbered_txs.count
    FROM numbered_txs
    INNER JOIN txs USING (tx_id)
    WHERE numbered_txs.r <= 50
--- a/src/migrations/1639152689764_latest_contract_txs_abi.ts
+++ b/src/migrations/1639152689764_latest_contract_txs_abi.ts
@@ -1,146 +0,0 @@
-/* eslint-disable @typescript-eslint/camelcase */
-import { MigrationBuilder, ColumnDefinitions } from 'node-pg-migrate';
-
-export const shorthands: ColumnDefinitions | undefined = undefined;
-
-export async function up(pgm: MigrationBuilder): Promise<void> {
-  pgm.dropMaterializedView('latest_contract_txs', { ifExists: true, cascade: true });
-  pgm.createMaterializedView('latest_contract_txs', {}, `
-    WITH contract_txs AS (
-      SELECT
-        contract_call_contract_id AS contract_id, tx_id,
-        block_height, microblock_sequence, tx_index
-      FROM txs
-      WHERE
-        contract_call_contract_id IS NOT NULL
-        AND canonical = TRUE
-        AND microblock_canonical = TRUE
-      UNION
-      SELECT
-        smart_contract_contract_id AS contract_id, tx_id,
-        block_height, microblock_sequence, tx_index
-      FROM txs
-      WHERE
-        smart_contract_contract_id IS NOT NULL
-        AND canonical = TRUE
-        AND microblock_canonical = TRUE
-      UNION
-      SELECT
-        sender_address AS contract_id, tx_id,
-        block_height, microblock_sequence, tx_index
-      FROM txs
-      WHERE
-        sender_address LIKE '%.%'
-        AND canonical = TRUE
-        AND microblock_canonical = TRUE
-      UNION
-      SELECT
-        token_transfer_recipient_address AS contract_id, tx_id,
-        block_height, microblock_sequence, tx_index
-      FROM txs
-      WHERE
-        token_transfer_recipient_address LIKE '%.%'
-        AND canonical = TRUE
-        AND microblock_canonical = TRUE
-    ),
-    numbered_txs AS (
-      SELECT
-        ROW_NUMBER() OVER (
-          PARTITION BY contract_id
-          ORDER BY block_height DESC, microblock_sequence DESC, tx_index DESC
-        ) AS r,
-        COUNT(*) OVER (
-          PARTITION BY contract_id
-        )::integer AS count,
-        contract_txs.*
-      FROM contract_txs
-    )
-    SELECT
-      numbered_txs.contract_id,
-      txs.*,
-      CASE
-        WHEN txs.type_id = 2 THEN (
-          SELECT abi
-          FROM smart_contracts
-          WHERE smart_contracts.contract_id = txs.contract_call_contract_id
-          ORDER BY abi != 'null' DESC, canonical DESC, microblock_canonical DESC, block_height DESC
-          LIMIT 1
-        )
-      END as abi,
-      numbered_txs.count
-    FROM numbered_txs
-    INNER JOIN txs USING (tx_id)
-    WHERE numbered_txs.r <= 50
-  `);
-
-  pgm.createIndex('latest_contract_txs', 'contract_id');
-  pgm.createIndex('latest_contract_txs', [
-    { name: 'block_height', sort: 'DESC' },
-    { name: 'microblock_sequence', sort: 'DESC'},
-    { name: 'tx_index', sort: 'DESC' }
-  ]);
-}
-
-export async function down(pgm: MigrationBuilder): Promise<void> {
-  // Go back to the previous materialized view version, otherwise `pgm` complains it can't infer the down migration.
-  pgm.dropMaterializedView('latest_contract_txs', { ifExists: true, cascade: true });
-  pgm.createMaterializedView('latest_contract_txs', {}, `
-    WITH contract_txs AS (
-      SELECT
-        contract_call_contract_id AS contract_id, tx_id,
-        block_height, microblock_sequence, tx_index
-      FROM txs
-      WHERE
-        contract_call_contract_id IS NOT NULL
-        AND canonical = TRUE
-        AND microblock_canonical = TRUE
-      UNION
-      SELECT
-        smart_contract_contract_id AS contract_id, tx_id,
-        block_height, microblock_sequence, tx_index
-      FROM txs
-      WHERE
-        smart_contract_contract_id IS NOT NULL
-        AND canonical = TRUE
-        AND microblock_canonical = TRUE
-      UNION
-      SELECT
-        sender_address AS contract_id, tx_id,
-        block_height, microblock_sequence, tx_index
-      FROM txs
-      WHERE
-        sender_address LIKE '%.%'
-        AND canonical = TRUE
-        AND microblock_canonical = TRUE
-      UNION
-      SELECT
-        token_transfer_recipient_address AS contract_id, tx_id,
-        block_height, microblock_sequence, tx_index
-      FROM txs
-      WHERE
-        token_transfer_recipient_address LIKE '%.%'
-        AND canonical = TRUE
-        AND microblock_canonical = TRUE
-    ),
-    numbered_txs AS (
-      SELECT
-        ROW_NUMBER() OVER (
-          PARTITION BY contract_id
-          ORDER BY block_height DESC, microblock_sequence DESC, tx_index DESC
-        ) AS r,
-        contract_txs.*
-      FROM contract_txs
-    )
-    SELECT numbered_txs.contract_id, txs.*
-    FROM numbered_txs
-    INNER JOIN txs USING (tx_id)
-    WHERE numbered_txs.r <= 50
-  `);
-
-  pgm.createIndex('latest_contract_txs', 'contract_id');
-  pgm.createIndex('latest_contract_txs', [
-    { name: 'block_height', sort: 'DESC' },
-    { name: 'microblock_sequence', sort: 'DESC'},
-    { name: 'tx_index', sort: 'DESC' }
-  ]);
-}