hirosystems · zone117x · Apr 15, 2024 · Jan 23, 2024 · Jan 25, 2024 · Jan 25, 2024
diff --git a/.env b/.env
@@ -178,4 +178,4 @@ STACKS_NODE_TYPE=L1
 # IBD_MODE_UNTIL_BLOCK=
 
 # Folder with events to be imported by the event-replay.
-STACKS_EVENTS_DIR=./eventssds
+STACKS_EVENTS_DIR=./events
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -855,7 +855,6 @@ jobs:
       - lint
       - lint-docs
       - test
-      - test-2_5
       - test-bns
       - test-rosetta
       - test-rosetta-cli-construction

diff --git a/.gitpod.yml b/.gitpod.yml
@@ -12,7 +12,7 @@ tasks:
   - init: npm ci
     command: npm run dev
   - openMode: split-right
-    command: stacks-node start --config=stacks-blockchain/Stacks-dev.toml
+    command: stacks-node start --config stacks-blockchain/Stacks-dev.toml
 
 github:
   prebuilds:

diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -55,6 +55,7 @@
       "skipFiles": [
         "<node_internals>/**"
       ],
+      "runtimeVersion": "20",
       "runtimeArgs": ["-r", "ts-node/register/transpile-only", "-r", "tsconfig-paths/register"],
       "args": ["${workspaceFolder}/src/index.ts"],
       "outputCapture": "std",

diff --git a/client/src/generated/models/RosettaOptions.ts b/client/src/generated/models/RosettaOptions.ts
@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Stacks Blockchain API
- * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>.  <a href=\"https://hirosystems.github.io/stacks-blockchain-api/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a> 
+ * Welcome to the API reference overview for the [Stacks Blockchain API](https://docs.hiro.so/get-started/stacks-blockchain-api).  [Download Postman collection](https://hirosystems.github.io/stacks-blockchain-api/collection.json) 
  *
  * The version of the OpenAPI document: STACKS_API_VERSION
  * 
@@ -139,6 +139,12 @@ export interface RosettaOptions {
      * @memberof RosettaOptions
      */
     pox_addr?: string;
+    /**
+     * The hex-encoded signer key (buff 33) for PoX.
+     * @type {string}
+     * @memberof RosettaOptions
+     */
+    signer_key?: string;
 }
 
 export function RosettaOptionsFromJSON(json: any): RosettaOptions {
@@ -171,6 +177,7 @@ export function RosettaOptionsFromJSONTyped(json: any, ignoreDiscriminator: bool
         'burn_block_height': !exists(json, 'burn_block_height') ? undefined : json['burn_block_height'],
         'delegate_to': !exists(json, 'delegate_to') ? undefined : json['delegate_to'],
         'pox_addr': !exists(json, 'pox_addr') ? undefined : json['pox_addr'],
+        'signer_key': !exists(json, 'signer_key') ? undefined : json['signer_key'],
     };
 }
 
@@ -203,6 +210,7 @@ export function RosettaOptionsToJSON(value?: RosettaOptions | null): any {
         'burn_block_height': value.burn_block_height,
         'delegate_to': value.delegate_to,
         'pox_addr': value.pox_addr,
+        'signer_key': value.signer_key,
     };
 }
 
diff --git a/docker/docker-compose.dev.stacks-blockchain-follower.yml b/docker/docker-compose.dev.stacks-blockchain-follower.yml
@@ -3,7 +3,7 @@ services:
   stacks-blockchain:
     build:
       context: ../stacks-blockchain/docker
-    command: stacks-node start --config=/app/config/Stacks-follower.toml
+    command: stacks-node start --config /app/config/Stacks-follower.toml
     restart: on-failure
     environment:
       STACKS_EVENT_OBSERVER: host.docker.internal:3700

diff --git a/docker/docker-compose.dev.stacks-blockchain.yml b/docker/docker-compose.dev.stacks-blockchain.yml
@@ -1,17 +1,17 @@
 version: '3.7'
 services:
   stacks-blockchain:
-    image: "hirosystems/stacks-api-e2e:stacks3.0-800259e"
+    image: 'hirosystems/stacks-api-e2e:stacks3.0-4d11d85'
     restart: on-failure
     environment:
       STACKS_EVENT_OBSERVER: host.docker.internal:3700
       BLOCKSTACK_USE_TEST_GENESIS_CHAINSTATE: 1
       NOP_BLOCKSTACK_DEBUG: 1
     ports:
-      - "20443:20443"
-      - "20444:20444"
+      - '20443:20443'
+      - '20444:20444'
     volumes:
       - ../stacks-blockchain/:/app/config
       - ../stacks-blockchain/.chaindata:/tmp/stacks-blockchain-data
     extra_hosts:
-      - "host.docker.internal:host-gateway" # fixes `host.docker.internal` on linux hosts
+      - 'host.docker.internal:host-gateway' # fixes `host.docker.internal` on linux hosts
diff --git a/docker/docker-compose.dev.stacks-krypton.yml b/docker/docker-compose.dev.stacks-krypton.yml
@@ -1,16 +1,16 @@
 version: '3.7'
 services:
   stacks-blockchain:
-    image: "hirosystems/stacks-api-e2e:stacks3.0-800259e"
+    image: 'hirosystems/stacks-api-e2e:stacks3.0-4d11d85'
     ports:
-      - "18443:18443" # bitcoin regtest JSON-RPC interface
-      - "18444:18444" # bitcoin regtest p2p
-      - "20443:20443" # stacks-node RPC interface
-      - "20444:20444" # stacks-node p2p
+      - '18443:18443' # bitcoin regtest JSON-RPC interface
+      - '18444:18444' # bitcoin regtest p2p
+      - '20443:20443' # stacks-node RPC interface
+      - '20444:20444' # stacks-node p2p
     environment:
       MINE_INTERVAL: 0.1s
       STACKS_EVENT_OBSERVER: host.docker.internal:3700
       # STACKS_LOG_TRACE: 1
       # STACKS_LOG_DEBUG: 1
     extra_hosts:
-      - "host.docker.internal:host-gateway" # fixes `host.docker.internal` on linux hosts
+      - 'host.docker.internal:host-gateway' # fixes `host.docker.internal` on linux hosts
diff --git a/docker/docker-compose.dev.subnets.yml b/docker/docker-compose.dev.subnets.yml
@@ -22,7 +22,7 @@ services:
     image: "hirosystems/stacks-subnets:7012d22"
     # build:
     #   dockerfile: ./subnet-node.Dockerfile
-    command: subnet-node start --config=/app/config/Stacks-subnet.toml
+    command: subnet-node start --config /app/config/Stacks-subnet.toml
     ports:
       - "30443:30443" # subnet-node RPC interface
       - "30444:30444" # subnet-node p2p

diff --git a/docker/docker-compose.override.yml b/docker/docker-compose.override.yml
@@ -1,4 +1,4 @@
 version: '3.7'
 services:
   stacks-blockchain:
-    command: stacks-node start --config=/app/config/Stacks-mocknet.toml
+    command: stacks-node start --config /app/config/Stacks-mocknet.toml
diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml
@@ -14,7 +14,7 @@ services:
   stacks-blockchain:
     build:
       context: ../stacks-blockchain/docker
-    command: stacks-node start --config=/app/config/Stacks-follower.toml
+    command: stacks-node start --config /app/config/Stacks-follower.toml
     restart: on-failure
     environment:
       STACKS_EVENT_OBSERVER: stacks-blockchain-api:3700

diff --git a/docker/rosetta.Dockerfile b/docker/rosetta.Dockerfile
@@ -152,7 +152,7 @@ case "${STACKS_NETWORK}" in
         ;;
 esac
 # start stacks-blockchain and store pid
-${STACKS_BLOCKCHAIN_DIR}/stacks-node start --config=${STACKS_BLOCKCHAIN_DIR}/${STACKS_NETWORK}-follower-conf.toml 2>&1 &
+${STACKS_BLOCKCHAIN_DIR}/stacks-node start --config ${STACKS_BLOCKCHAIN_DIR}/${STACKS_NETWORK}-follower-conf.toml 2>&1 &
 STACKS_BLOCKCHAIN_PID=$!
 
 # start stacks-blockchain-api and store pid

diff --git a/docker/standalone-regtest.Dockerfile b/docker/standalone-regtest.Dockerfile
@@ -295,7 +295,7 @@ RUN <<EOF
 
     export STACKS_EVENT_OBSERVER="127.0.0.1:3998"
     envsubst < config.toml.in > config.toml
-    stacks-node start --config=config.toml &
+    stacks-node start --config config.toml &
     STACKS_PID=$!
 
     while true; do
@@ -359,7 +359,7 @@ cat > run.sh <<'EOM'
 
   export STACKS_EVENT_OBSERVER="127.0.0.1:3700"
   envsubst < config.toml.in > config.toml
-  stacks-node start --config=config.toml &
+  stacks-node start --config config.toml &
   STACKS_PID=$!
 
   while true; do

diff --git a/docs/api/stacking/get-pox-cycle-signer-stackers.example.json b/docs/api/stacking/get-pox-cycle-signer-stackers.example.json
@@ -0,0 +1,12 @@
+{
+  "limit": 20,
+  "offset": 0,
+  "total": 1,
+  "results": [
+    {
+      "pox_address": "15Z2sAvjgVDpcBh4vx9g2XKU8FVHYcXNaj",
+      "stacked_amount": "686251350000000000",
+      "stacker_address": "STRYYQQ9M8KAF4NS7WNZQYY59X93XEKR31JP64CP"
+    }
+  ]
+}
diff --git a/docs/api/stacking/get-pox-cycle-signer-stackers.schema.json b/docs/api/stacking/get-pox-cycle-signer-stackers.schema.json
@@ -0,0 +1,29 @@
+{
+  "description": "GET request that returns stackers for a signer in a PoX cycle",
+  "additionalProperties": false,
+  "title": "PoxCycleSignerStackersListResponse",
+  "type": "object",
+  "required": ["results", "limit", "offset", "total"],
+  "properties": {
+    "limit": {
+      "type": "integer",
+      "maximum": 200,
+      "description": "The number of stackers to return"
+    },
+    "offset": {
+      "type": "integer",
+      "description": "The number to stackers to skip (starting at `0`)",
+      "default": 0
+    },
+    "total": {
+      "type": "integer",
+      "description": "The total number of stackers"
+    },
+    "results": {
+      "type": "array",
+      "items": {
+        "$ref": "../../entities/stacking/stacker.schema.json"
+      }
+    }
+  }
+}
diff --git a/docs/api/stacking/get-pox-cycle-signers.example.json b/docs/api/stacking/get-pox-cycle-signers.example.json
@@ -0,0 +1,28 @@
+{
+  "limit": 20,
+  "offset": 0,
+  "total": 3,
+  "results": [
+    {
+      "signing_key": "0x038e3c4529395611be9abf6fa3b6987e81d402385e3d605a073f42f407565a4a3d",
+      "stacked_amount": "686251350000000000",
+      "stacked_amount_percent": 50,
+      "weight": 5,
+      "weight_percent": 55.55555555555556
+    },
+    {
+      "signing_key": "0x029874497a7952483aa23890e9d0898696f33864d3df90939930a1f45421fe3b09",
+      "stacked_amount": "457500900000000000",
+      "stacked_amount_percent": 33.333333333333336,
+      "weight": 3,
+      "weight_percent": 33.33333333333333
+    },
+    {
+      "signing_key": "0x02dcde79b38787b72d8e5e0af81cffa802f0a3c8452d6b46e08859165f49a72736",
+      "stacked_amount": "228750450000000000",
+      "stacked_amount_percent": 16.666666666666668,
+      "weight": 1,
+      "weight_percent": 11.11111111111111
+    }
+  ]
+}
diff --git a/docs/api/stacking/get-pox-cycle-signers.schema.json b/docs/api/stacking/get-pox-cycle-signers.schema.json
@@ -0,0 +1,29 @@
+{
+  "description": "GET request that returns signers for a PoX cycle",
+  "additionalProperties": false,
+  "title": "PoxCycleSignersListResponse",
+  "type": "object",
+  "required": ["results", "limit", "offset", "total"],
+  "properties": {
+    "limit": {
+      "type": "integer",
+      "maximum": 200,
+      "description": "The number of signers to return"
+    },
+    "offset": {
+      "type": "integer",
+      "description": "The number to signers to skip (starting at `0`)",
+      "default": 0
+    },
+    "total": {
+      "type": "integer",
+      "description": "The total number of signers"
+    },
+    "results": {
+      "type": "array",
+      "items": {
+        "$ref": "../../entities/stacking/signer.schema.json"
+      }
+    }
+  }
+}
diff --git a/docs/api/stacking/get-pox-cycles.example.json b/docs/api/stacking/get-pox-cycles.example.json
@@ -0,0 +1,31 @@
+{
+  "limit": 20,
+  "offset": 0,
+  "total": 3,
+  "results": [
+    {
+      "block_height": 50,
+      "cycle_number": 14,
+      "index_block_hash": "0xf5be33abc4e508bdaf2191e88339372edcb3358c44e2a31e1b9b44f2880dde09",
+      "total_signers": 3,
+      "total_stacked_amount": "1372502700000000000",
+      "total_weight": 9
+    },
+    {
+      "block_height": 22,
+      "cycle_number": 13,
+      "index_block_hash": "0x5077c7d971dd83cd3ba19dca579e3cc8dcf17913186b66093c94520e50d3b7b2",
+      "total_signers": 3,
+      "total_stacked_amount": "1372502700000000000",
+      "total_weight": 9
+    },
+    {
+      "block_height": 13,
+      "cycle_number": 12,
+      "index_block_hash": "0x62d06851fe03f17cb45a488ae70bd8e0c5c308c523f37814ad4df36bd2108713",
+      "total_signers": 3,
+      "total_stacked_amount": "1372502700000000000",
+      "total_weight": 9
+    }
+  ]
+}
diff --git a/docs/api/stacking/get-pox-cycles.schema.json b/docs/api/stacking/get-pox-cycles.schema.json
@@ -0,0 +1,29 @@
+{
+  "description": "GET request that returns PoX cycles",
+  "additionalProperties": false,
+  "title": "PoxCycleListResponse",
+  "type": "object",
+  "required": ["results", "limit", "offset", "total"],
+  "properties": {
+    "limit": {
+      "type": "integer",
+      "maximum": 200,
+      "description": "The number of cycles to return"
+    },
+    "offset": {
+      "type": "integer",
+      "description": "The number to cycles to skip (starting at `0`)",
+      "default": 0
+    },
+    "total": {
+      "type": "integer",
+      "description": "The total number of cycles"
+    },
+    "results": {
+      "type": "array",
+      "items": {
+        "$ref": "../../entities/stacking/pox-cycle.schema.json"
+      }
+    }
+  }
+}
diff --git a/docs/entities/blocks/block.example.json b/docs/entities/blocks/block.example.json
@@ -2,6 +2,8 @@
   "canonical": true,
   "height": 3275,
   "hash": "0xe77ba8cf6bb7c0e4f64adc83356289ed467d31a22354907b4bb814590058430f",
+  "block_time": 1594233639,
+  "block_time_iso": "2020-08-27T16:41:26.000Z",
   "index_block_hash": "0x918697ef63f9d8bdf844c3312b299e72a231cde542f3173f7755bb8c1cdaf3a7",
   "parent_block_hash": "0x75ab21ef25cbff2caa14c27d830ed7886a4d1522e1b6f9e5dc3b59ccf73ed49f",
   "burn_block_time": 1594233639,

diff --git a/docs/entities/blocks/block.schema.json b/docs/entities/blocks/block.schema.json
@@ -7,6 +7,8 @@
     "canonical",
     "height",
     "hash",
+    "block_time",
+    "block_time_iso",
     "index_block_hash",
     "parent_block_hash",
     "txs",
@@ -39,6 +41,14 @@
       "type": "string",
       "description": "Hash representing the block"
     },
+    "block_time": {
+      "type": "number",
+      "description": "Unix timestamp (in seconds) indicating when this block was mined."
+    },
+    "block_time_iso": {
+      "type": "string",
+      "description": "An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined."
+    },
     "index_block_hash": {
       "type": "string",
       "description": "The only hash that can uniquely identify an anchored block or an unconfirmed state trie"

diff --git a/docs/entities/blocks/nakamoto-block.example.json b/docs/entities/blocks/nakamoto-block.example.json
@@ -2,6 +2,8 @@
   "canonical": true,
   "height": 3275,
   "hash": "0xe77ba8cf6bb7c0e4f64adc83356289ed467d31a22354907b4bb814590058430f",
+  "block_time": 1594233639,
+  "block_time_iso": "2020-08-27T16:41:26.000Z",
   "index_block_hash": "0x918697ef63f9d8bdf844c3312b299e72a231cde542f3173f7755bb8c1cdaf3a7",
   "parent_block_hash": "0x75ab21ef25cbff2caa14c27d830ed7886a4d1522e1b6f9e5dc3b59ccf73ed49f",
   "parent_index_block_hash": "0x4262db117659d1ca9406970c8f44ffd3d8f11f8e18c591d2e3960f4070107756",