Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
de45e5d
Update NODE_RUNNING.md with requirements for different profiles
max-sanchez Apr 2, 2025
cd9f26e
Add images for localnode running
max-sanchez Apr 2, 2025
b4fc904
Docker profile information
max-sanchez Apr 2, 2025
89708c2
Update images for localnode running
max-sanchez Apr 2, 2025
1e90514
Update images for localnode running to PNG
max-sanchez Apr 2, 2025
09067e6
Update images for localnode
max-sanchez Apr 2, 2025
5b608e3
Update links and other misc. documentation
max-sanchez Apr 2, 2025
f79fc64
Add image for overall Hemi network components
max-sanchez Apr 2, 2025
68fd276
Add image of overall Hemi network daemon stack
max-sanchez Apr 2, 2025
eaeacc7
Replace png with svg
max-sanchez Apr 2, 2025
5f70cd7
png -> svg
max-sanchez Apr 2, 2025
7d77535
Add l1 profile information + image
max-sanchez Apr 2, 2025
98e9731
Lots of doc updates
max-sanchez Apr 2, 2025
e3d89a9
Add hemi-min Docker profile and update `op-node` command line arguments
max-sanchez Apr 2, 2025
9c376db
Update bring your own l1 instructions
max-sanchez Apr 2, 2025
dd99486
Update op-node images
max-sanchez Apr 2, 2025
ca92c9e
Added quickstart summary
max-sanchez Apr 2, 2025
0a2f073
Update Table of Contents
max-sanchez Apr 2, 2025
bef98b5
sh -> bash in gen-files.sh
max-sanchez Apr 2, 2025
f26b07f
Formatting fix
max-sanchez Apr 2, 2025
667bc2e
Update op-node images
max-sanchez Apr 2, 2025
7ceb52b
Update op-geth images after merging hVM snap sync behavior
max-sanchez Apr 2, 2025
eac52ad
localnode: reformat node running docs
joshuasing Apr 2, 2025
debd0e5
localnode: add recommendation to monitor disk
joshuasing Apr 2, 2025
1a2a51b
localnode: split http/ssh clone
joshuasing Apr 2, 2025
cdd80d6
localnode: grammatical edits for components/profiles sections
joshuasing Apr 2, 2025
c878f15
localnode: edits for docker profiles last tip/notes
joshuasing Apr 2, 2025
b2d3bb5
localnode: make security warning a CAUTION alert
joshuasing Apr 2, 2025
2e570a0
localnode: fix typo and edit node sync type notes
joshuasing Apr 2, 2025
0ef56fb
localnode: make title capitalisation consistent
joshuasing Apr 2, 2025
b5cf65e
localnode: make gen-files.sh POSIX compatible and use /bin/sh
joshuasing Apr 2, 2025
d1650c5
localnode: make heminode.sh POSIX compatible
joshuasing Apr 2, 2025
d902ad6
Minor edits and fixes
max-sanchez Apr 3, 2025
9ea7071
Add mainnet static nodes
max-sanchez Apr 3, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
localnode: grammatical edits for components/profiles sections
  • Loading branch information
joshuasing committed Apr 2, 2025
commit cdd80d695f1a441a97e2fda2ecab17c8512eb6c3
21 changes: 10 additions & 11 deletions localnode/NODE_RUNNING.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ cd heminetwork
### Hemi Components

> [!TIP]
> You do not have to run all of the daemons, depending on your use-case. See the [Docker Profiles](#docker-profiles)
> You do not have to run all network daemons, depending on your use-case. See the [Docker Profiles](#docker-profiles)
> section to determine which configuration is appropriate for your use-case(s) and trust tolerance.

The following daemons comprise the Hemi stack. They are all run under Docker Compose:
Expand All @@ -144,10 +144,9 @@ The following daemons comprise the Hemi stack. They are all run under Docker Com
There are four different docker profiles you can choose from, depending on your use case and trust tolerance.

> [!TIP]
> This docker profile setting is independent from the [Node Synchronization Type](#node-synchronization-type) which
> determines how the `op-geth` instance performs it's one-time **initial** sync regardless of the stack setup. Any of
> the
> profiles that include an op-geth instance can be configured with either of the initial synchronization types.
> The Docker profile setting is independent of the [Node Synchronization Type](#node-synchronization-type), which
> determines how the `op-geth` instance performs its one-time **initial** sync regardless of the stack setup. Any of
> the profiles that include an op-geth instance can be configured to use either of the initial synchronization types.

The following table provides details on which components are run locally as part of each profile:

Expand All @@ -165,12 +164,12 @@ The following table provides details on which components are run locally as part

Different node configurations support different Hemi use cases:

| Profile | Standard RPC<br>(Wallets, most dApps, etc.) | Consensus RPC<br>(State Roots, Sync Status, etc.) | Extended Consensus RPC<br>(BTC Finality) | Fully Local PoP Mining | Trustless ETH Derivation | Trustless BTC Indexing |
|----------|---------------------------------------------|---------------------------------------------------|------------------------------------------|------------------------|---------------------------------------------------------|----------------------------------------------------------|
| full | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| hemi | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: | :x: |
| hemi-min | :white_check_mark: | :white_check_mark: | :x: | :x: | :x: | :x: |
| L1 | :x: | :x: | :x: | :x: | :white_check_mark: <br>(for paired hemi/hemi-min stack) | :white_check_mark: <br> (for paired hemi/hemi-min stack) |
| Profile | Standard RPC<br>(Wallets, most dApps, etc.) | Consensus RPC<br>(State Roots, Sync Status, etc.) | Extended Consensus RPC<br>(BTC Finality) | Fully Local PoP Mining | Trustless ETH Derivation | Trustless BTC Indexing |
|----------|---------------------------------------------|---------------------------------------------------|------------------------------------------|------------------------|--------------------------------------------------------|--------------------------------------------------------|
| full | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| hemi | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: | :x: |
| hemi-min | :white_check_mark: | :white_check_mark: | :x: | :x: | :x: | :x: |
| L1 | :x: | :x: | :x: | :x: | :white_check_mark:<br>(for paired hemi/hemi-min stack) | :white_check_mark:<br>(for paired hemi/hemi-min stack) |

> [!TIP]
> The `full` profile supports all features, operates entirely trustlessly, and does not pair with another profile.
Expand Down