Skip to content

docs: Answer the second round of operator onboarding questions#814

Merged
Bridgerz merged 2 commits into
mainfrom
docs-operator-feedback-2
Jul 14, 2026
Merged

docs: Answer the second round of operator onboarding questions#814
Bridgerz merged 2 commits into
mainfrom
docs-operator-feedback-2

Conversation

@Bridgerz

Copy link
Copy Markdown
Contributor

Stacked on #804 (same sections of the runbook). Fixes from the second wave of validator-channel feedback, all claims verified against code before documenting:

Offline signing commands (asked by Coinage x DAIC, answered in-thread by Nodes.Guru)

§2.3 now shows the exact sui keytool sign --address ... --data ... and sui client execute-signed-tx --tx-bytes ... --signatures ... invocations (flags verified against the current sui CLI), with a note for hardware/multisig custody. §5.3 cross-references instead of repeating.

Operator address derivation (Coinage x DAIC)

Operators who generated their key with openssl had no documented way to compute its Sui address. §2.4 now covers both paths: sui keytool generate prints it, and for an existing PEM there's a one-liner (pubkey DER → blake2b-256 over 0x00 || pubkey) that I verified derives the identical address to sui keytool for a test key.

Fund the operator with at least 2 SUI (hit by Brightlystake)

sweep_to_address_balance bootstraps the account's address balance with exactly 1 SUI at startup (sui_tx_executor.rs:2101), so an operator holding exactly 1 SUI fails the simulation with InsufficientCoinBalance — precisely the error reported. §2.4 now says to fund with at least 2 SUI and explains why.

Metadata updates are automatic (asked by Brightlystake, Triton.One)

Verified: the register builder diffs config vs the on-chain member record and sends only stale fields, and the node runs it at startup. §2.4 now states that editing the config and restarting is sufficient; no manual re-register.

"Where do operator steps end?" (Galaxy)

§5.4 gains an explicit last operator step marker; steps 4-6 are admin/network.

@Bridgerz
Bridgerz requested a review from bmwill as a code owner July 14, 2026 15:40
@github-actions

github-actions Bot commented Jul 14, 2026

Copy link
Copy Markdown
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-07-14 22:11 UTC

Base automatically changed from docs-operator-config-fixes to main July 14, 2026 15:47
@jessiemongeon1

Copy link
Copy Markdown
Collaborator

Style Guide Audit

Audited 1 file(s) against the Sui Documentation Style Guide.

3 violation(s) found. All must be fixed before merge.

design/docs/node-operator-runbook.mdx (3 violation(s))

3 violation(s) (1 regex, 2 claude)

  • Line 268 — "on-chain" is one word → "onchain"
    • Current: on-chain
    • Fix: onchain
  • Line 215 — no-italic-text
    • Current: *not*
    • Fix: **not**
  • Line 257 — no-italic-text
    • Current: *and*
    • Fix: **and**

Automated audit using the Sui Documentation Style Guide.

Bridgerz added 2 commits July 14, 2026 14:49
From the validator channel:

- 2.3 shows the concrete sui keytool sign / sui client
  execute-signed-tx commands for the offline registration flow
  (operators were assembling these from chat).
- 2.4 documents how to find the operator address for an openssl PEM
  (derivation one-liner, verified against sui keytool output) and
  says to fund the operator with at least 2 SUI: the node's startup
  address-balance bootstrap moves exactly 1 SUI, so 1 SUI total fails
  with InsufficientCoinBalance (hit by an operator).
- 2.4 states that metadata updates are automatic: the node diffs its
  config against the on-chain record at startup, so editing
  endpoint-url and restarting is enough.
- 5.3 placeholder unified with 2.3/2.4; 5.4 gains an explicit
  'last operator step' marker (operators asked where to stop).
@Bridgerz
Bridgerz force-pushed the docs-operator-feedback-2 branch from 54eed46 to 2123f50 Compare July 14, 2026 21:50
@Bridgerz
Bridgerz merged commit fb6c0a6 into main Jul 14, 2026
16 checks passed
@Bridgerz
Bridgerz deleted the docs-operator-feedback-2 branch July 14, 2026 22:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants