updates for newest changes in SDK

scroll-tech · Aug 1, 2024 · 29b7d9e · 29b7d9e
1 parent 6702a03
commit 29b7d9e
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 6 deletions.
diff --git a/src/content/docs/en/sdk/guides/run-on-arm64-mac.mdx b/src/content/docs/en/sdk/guides/run-on-arm64-mac.mdx
@@ -144,7 +144,7 @@ These are all a work-around for ingress-dns not working on arm MacOS and hopeful
     Your chain is now starting! Run `kubectl get pods` to check in on their progress. In the next section we’ll expose the chain to your local machine so you can interact with the stack.
 
     <Aside>
-    Right now (July 22, 2024), the whole start process for the various containers can take about 10 minutes. We’ll be looking to reduce this.
+    Right now (July 22, 2024), the whole start process for the various containers can take up to 10 minutes. We’ll be looking to reduce this.
     </Aside>
 </Steps>
 

diff --git a/src/content/docs/en/sdk/technical-stack/contracts.mdx b/src/content/docs/en/sdk/technical-stack/contracts.mdx
@@ -55,7 +55,9 @@ During deployment, a simulation is first done to determine what address a contra
 
 {/* <!-- TODO: modify URL to develop branch --> */}
 
-Then, after the `scroll-stack` chart is installed during `make install`, you will need to fund your SDK accounts and run `make deploy-contracts` to deploy all contracts on L1 and L2 using actual transactions.
+{/* Then, after the `scroll-stack` chart is installed during `make install`, you will need to fund your SDK accounts and run `make deploy-contracts` to deploy all contracts on L1 and L2 using actual transactions. */}
+
+Then, during `make install`, the `contracts` pod will connect to the cluster's RPCs and deploy the necessary contracts. 
 
 To view the complete logs from the deployment process, see the `broadcast` folder in `/charts/scroll-stack/`.
 

diff --git a/src/content/docs/en/sdk/technical-stack/services.mdx b/src/content/docs/en/sdk/technical-stack/services.mdx
@@ -57,7 +57,8 @@ Below, we describe three configurations for services:
 | blockscout-sc-verifier  | ❔ |                        |                                                    |
 | bridge-history-api [^1]     | ✅                       | ✅                | ✅                                                  |
 | bridge-history-fetcher [^1] | ✅                       | ✅             | ✅                                                  |
-| chain-monitor           | ✅                        | ✅                       | ✅                                                  |
+| chain-monitor           |                         | ✅                       | ✅                                                  |
+| contracts               | ✅                       | ✅                  | ✅                                                  |
 | coordinator-api [^2]                           |                         | | ✅                                                  |
 | coordinator-cron [^2]       |                         |                        | ✅                                                  |
 | frontends               | ✅                       |                        | ⚠️                                                  |
@@ -75,7 +76,6 @@ Below, we describe three configurations for services:
 | rollup-node             | ✅                       | ✅                      | ✅                                                  |
 | rpc-gateway             | ✅                       |                        | ✅                                                  |
 
-{/* | contracts               | ✅                       | ✅ [^2]                 | ✅                                                  | */}
 {/* | event-watcher           | ✅                       | ❔  | ❔                                                  | */}
 
 [^1]: Services necessary for claiming funds bridged from L2 to L1 and used by bridge frontend. Could be replaced by [Bridge History SDK](https://github.com/scroll-tech/scroll-bridge-sdk) for other usage.
@@ -108,12 +108,16 @@ The Balance Checker is a simple service to track and monitor the balances of som
 
 The [Chain Monitor](https://github.com/scroll-tech/chain-monitor) is a security service that short-circuits batch finalization if certain invariants are not satisfied. While optional, it is recommended for enhanced security.
 
+<Aside type="danger">
+As of July 31, 2024, `chain-monitor` does not allow for finalization in any context. This is a known issue that we're looking into.
+</Aside>
+
 #### Contracts (`contracts`)
 
 The Contracts service contains scripts to deploy necessary [chain contracts](https://github.com/scroll-tech/scroll-contracts) (rollup and bridge) on both L1 and L2. It ensures that the required smart contracts are in place for the Scroll SDK to function properly.
 
 <Aside type="tip">
-To be removed as a service and migrated to a docker image that runs once via Make command.
+In future iterations, this may be removed as a service and migrated to a docker image that runs once via Make command.
 </Aside>
 
 #### Coordinator API (`coordinator-api`)
@@ -152,6 +156,10 @@ The Rollup Node (also called the [Rollup Relayer](https://github.com/scroll-tech
 
 The L1 Explorer is a [Blockscout]((https://docs.blockscout.com/)) instance for providing a block explorer interface for the L1 devnet service. It allows users to inspect transactions and blocks on the base layer when deployments are made to local networks.
 
+<Aside type="danger">
+L1 Explorer does not currently function correctly -- blocks and transactions are not successfully indexed and do not display on the site.
+</Aside>
+
 #### L2 Sequencer (`l2-sequencer`)
 
 The L2 Sequencer is the node responsible for producing L2 blocks using Clique Proof of Authority (PoA) consensus. It maintains the order of transactions on the L2 chain. It is an archive node of the network, running [`l2geth`](https://github.com/scroll-tech/go-ethereum), Scroll's fork of geth.
@@ -279,4 +287,4 @@ flowchart LR
 		GR[grafana]
 		LKI[loki]
 	end */}
-</span>
+