Merge branch 'develop' into beta

Author: zone117x

.env

@@ -87,6 +87,12 @@ STACKS_CORE_RPC_PORT=20443
 ## configure the chainID/networkID; testnet: 0x80000000, mainnet: 0x00000001
 STACKS_CHAIN_ID=0x00000001
 
+# configure custom testnet and mainnet chainIDs for other networks such as subnets,
+# multiple values can be set using comma-separated key-value pairs.
+# TODO: currently configured with the default subnet testnet ID, the mainnet values
+# are placeholders that should be replaced with the actual subnet mainnet chainID
+CUSTOM_CHAIN_IDS=testnet=0x55005500,mainnet=12345678,mainnet=0xdeadbeaf
+
 # Seconds to allow API components to shut down gracefully before force-killing them, defaults to 60
 # STACKS_SHUTDOWN_FORCE_KILL_TIMEOUT=60
 

.github/workflows/ci.yml

@@ -955,7 +955,7 @@ jobs:
           context: .
           build-args: |
             STACKS_API_VERSION=${{ github.head_ref || github.ref_name }}
-          file: docker/stx-rosetta.Dockerfile
+          file: docker/rosetta.Dockerfile
           tags: ${{ steps.meta_standalone.outputs.tags }}
           labels: ${{ steps.meta_standalone.outputs.labels }}
           # 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)

README-rosetta.md

@@ -1,16 +1,22 @@
 # Testing the Rosetta APIs
 
-Build and run the `stx-rosetta.Dockerfile` image:
+Build and run the `rosetta.Dockerfile` image:
 
-    docker build -t stx-rosetta:stable -f stx-rosetta.Dockerfile .
+    docker build -t rosetta:stable -f rosetta.Dockerfile .
     docker run -d -p 3999:3999 --mount source=rosetta-data,target=/data \
-        --name stx-rosetta stx-rosetta:stable
+        --name rosetta rosetta:stable
 
 By default, this will connect to the testnet.  To run a local node, run
 
 
     docker run -d -p 3999:3999 --mount source=rosetta-data,target=/data \
-        --name stx-rosetta -e STACKS_NETWORK=mocknet stx-rosetta:stable
+        --name rosetta -e STACKS_NETWORK=mocknet rosetta:stable
+
+Optionally, you can seed the chainstate for testnet/mainnet using [Hiro archive data](https://docs.hiro.so/references/hiro-archive#what-is-the-hiro-archive):
+
+
+    docker run -d -p 3999:3999 --mount source=rosetta-data,target=/data \
+            --name rosetta -e SEED_CHAINSTATE=true rosetta:stable
 
 Use a recent version of [rosetta-cli](https://github.com/coinbase/rosetta-cli) to test the endpoints:
 

content/feature-guides/rosetta-support.md

@@ -8,19 +8,51 @@ The Stacks Blockchain API supports [v1.4.6 of the Rosetta specification](https:/
 
 # Testing the Rosetta APIs
 
-To build and run the `stx-rosetta.Dockerfile` image, run the following command:
-
-```docker build -t stx-rosetta:stable -f stx-rosetta.Dockerfile .
-docker run -d -p 3999:3999 --mount source=rosetta-data,target=/data \
---name stx-rosetta stx-rosetta:stable```
-By default, this will connect to the testnet. To run a local node, run the following command:
-```docker run -d -p 3999:3999 --mount source=rosetta-data,target=/data \
---name stx-rosetta -e STACKS_NETWORK=mocknet stx-rosetta:stable```
+To build and run the `rosetta.Dockerfile` image, run the following command:
+
+```
+docker build -t rosetta:stable -f rosetta.Dockerfile .
+docker run -d \
+  -p 3999:3999 \
+  --mount source=rosetta-data,target=/data \
+  --name rosetta \
+rosetta:stable
+```
+
+To build and run the `rosetta.Dockerfile` image using an [archived chainstate](https://docs.hiro.so/references/hiro-archive#what-is-the-hiro-archive), run the following command:
+
+```
+docker build -t rosetta:stable -f rosetta.Dockerfile .
+docker run -d \
+  -p 3999:3999 \
+  -e SEED_CHAINSTATE=true \
+  --mount source=rosetta-data,target=/data \
+  --name rosetta \
+rosetta:stable
+```
+
+
+By default, this will connect to the mainnet. To run a local node, run the following command:
+
+```
+docker run -d \
+  -p 3999:3999 \
+  -e STACKS_NETWORK=mocknet \
+  --mount source=rosetta-data,target=/data \
+  --name rosetta \
+rosetta:stable
+```
+
 To use a recent version of [rosetta-cli](https://github.com/coinbase/rosetta-cli) to test the endpoints, use the following command:
-```rosetta-cli --configuration-file rosetta-cli-config/rosetta-config.json \
-view:block 1
-rosetta-cli --configuration-file rosetta-cli-config/rosetta-config.json \
-check:data```
+```
+rosetta-cli \
+  --configuration-file rosetta-cli-config/rosetta-config.json \
+  view:block 1
+rosetta-cli \
+  --configuration-file rosetta-cli-config/rosetta-config.json \
+  check:data
+```
+
 `rosetta-cli` will then sync with the blockchain until it reaches the tip, and then exit, displaying the test results.
 Currently, account reconciliation is disabled; proper testing of that feature requires token transfer transactions while `rosetta-cli` is running.
 Documentation for the Rosetta APIs can be found [here](https://hirosystems.github.io/stacks-blockchain-api/)