Add bootstrap and bundle ValidateLedger contract #261

jnmt · 2025-09-16T10:47:15Z

Description

This PR adds the bootstrap interface and command that registers identity and ValidateLedger contract (imported from the scalardl-java-client-sdk repository and bundled).

Different from TableStoreClientService and HashStoreClientService, ClientService does not automatically bootstrap by default for backward compatibility. By using the bootstrap interface or command instead of register-certificate and register-secret, users don't have to care about the ValidateLedger contract. Maybe we can discuss whether we should deprecate register-certificate and register-secret in 4.x.

Related issues and/or PRs

Changes made

Add a bootstrap interface in ClientService, which registers identity and the ValidateLedger contract
Add the bootstrap subcommand as well
Refactor (remove) main methods from subcommands since we only provide these commands via the top-level command

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

I have commented my code, particularly in hard-to-understand areas.
I have updated the documentation to reflect the changes.
I have considered whether similar issues could occur in other products, components, or modules if this PR is for bug fixes.
Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
Tests (unit, integration, etc.) have been added for the changes.
My changes generate no new warnings.
Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

N/A

Release notes

Added a bootstrap feature that registers identity and ValidateLedger contract.

gemini-code-assist

Summary of Changes

Hello @jnmt, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a significant enhancement to the ScalarDL client by implementing a new "bootstrap" mechanism. This feature automates the essential initial setup steps, specifically the registration of the client's identity (certificate or secret key) and the ValidateLedger system contract. This automation occurs by default when a ClientService instance is initialized, greatly reducing manual configuration effort. For command-line users, a new bootstrap command has been added to the ScalarDL CLI, providing a unified and simplified way to perform these registrations. The ValidateLedger contract itself, which enables comprehensive ledger validation by scanning assets based on ID and age, is now bundled with the client, ensuring a more self-contained and user-friendly experience.

Highlights

Automated Client Setup: Identity (certificate or secret key) and the ValidateLedger contract are now automatically registered when a ClientService instance is created, simplifying initial client configuration.
New bootstrap CLI Command: A dedicated bootstrap command has been added to the ScalarDL CLI, allowing users to register identity and the ValidateLedger contract with a single, convenient command.
Bundled ValidateLedger Contract: The ValidateLedger system contract, imported from scalardl-java-client-sdk, is now bundled directly within the client, ensuring its availability for ledger validation.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request introduces a bootstrap mechanism to automatically register identity and the ValidateLedger system contract. The feature is well-integrated, with a new bootstrap CLI command and default activation when creating a ClientService. The changes are extensive, affecting the client service, its factory, and numerous CLI tool classes, and are accompanied by thorough tests. My review identifies one high-severity issue in the error handling logic within the new bootstrap() method, which could mask unexpected errors by being too broad in the exceptions it suppresses. I've provided a code suggestion to correct this.

client/src/main/java/com/scalar/dl/client/service/ClientService.java

jnmt · 2025-09-17T06:27:36Z

client/src/main/java/com/scalar/dl/client/service/ClientService.java

+      Class<?> clazz = ValidateLedger.class;
+      try {
+        registerContract(
+            config.getAuditorLinearizableValidationContractId(),


For this version (the first version that bundles the ValidateLedger contract), we register the validation contract with the same fixed contract ID that we have used before, for backward compatibility.

jnmt · 2025-09-17T06:31:38Z

table-store/src/main/java/com/scalar/dl/tablestore/client/service/TableStoreClientService.java

-      }
-    }
-
+    clientService.bootstrap();


By calling bootstrap() of the primitive client service, we can simplify bootstrap() for both table and hash store to register cert/secret and the ValidateLedger contract.

…el command

choplin

LGTM!

feeblefakie

LGTM! Thank you!

…ntract (#260) * Add bootstrap command for the table store * Add bootstrap and bundle ValidateLedger contract (#261)

Add bootstrap and bundle ValidateLedger contract

4b44a46

gemini-code-assist bot reviewed Sep 16, 2025

View reviewed changes

client/src/main/java/com/scalar/dl/client/service/ClientService.java Show resolved Hide resolved

jnmt added 2 commits September 17, 2025 08:37

Revert to disable auto registration in ClientService

2bf9d01

Bundle ValidateLedger for hash and table store

1df55e1

jnmt commented Sep 17, 2025

View reviewed changes

jnmt self-assigned this Sep 17, 2025

jnmt added the improvement label Sep 17, 2025

jnmt requested review from choplin and feeblefakie September 17, 2025 06:35

Refactor (remove) main methods since we only provide them via top-lev…

1936506

…el command

choplin approved these changes Sep 18, 2025

View reviewed changes

feeblefakie approved these changes Sep 19, 2025

View reviewed changes

feeblefakie merged commit c0abd37 into add-bootstrap-for-table-store Sep 19, 2025
10 checks passed

feeblefakie deleted the bundle-validate-ledger-contract branch September 19, 2025 02:47

jnmt added a commit that referenced this pull request Sep 19, 2025

Add bootstrap for client and table-store and bundle ValidateLedger co…

8ef5049

…ntract (#260) * Add bootstrap command for the table store * Add bootstrap and bundle ValidateLedger contract (#261)

feeblefakie pushed a commit that referenced this pull request Sep 19, 2025

Add bootstrap for client and table-store and bundle ValidateLedger co…

d7cb500

…ntract (#260) * Add bootstrap command for the table store * Add bootstrap and bundle ValidateLedger contract (#261)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add bootstrap and bundle ValidateLedger contract #261

Add bootstrap and bundle ValidateLedger contract #261

Uh oh!

jnmt commented Sep 16, 2025 •

edited

Loading

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

Uh oh!

jnmt Sep 17, 2025

Uh oh!

jnmt Sep 17, 2025

Uh oh!

choplin left a comment

Uh oh!

feeblefakie left a comment

Uh oh!

Uh oh!

Uh oh!

Add bootstrap and bundle ValidateLedger contract #261

Add bootstrap and bundle ValidateLedger contract #261

Uh oh!

Conversation

jnmt commented Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related issues and/or PRs

Changes made

Checklist

Additional notes (optional)

Release notes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

jnmt Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

jnmt Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

choplin left a comment

Choose a reason for hiding this comment

Uh oh!

feeblefakie left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jnmt commented Sep 16, 2025 •

edited

Loading