Add /metrics endpoint - #99

Merged
tnull merged 3 commits into
lightningdevkit:mainfrom
tankyleo:2026-05-health-check
May 19, 2026
Merged

Add /metrics endpoint#99
tnull merged 3 commits into
lightningdevkit:mainfrom
tankyleo:2026-05-health-check

Conversation

@tankyleo

@tankyleotankyleo commented May 6, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor

Compatible with prometheus

@ldk-reviews-bot

ldk-reviews-bot commented May 6, 2026•
edited
Loading

Copy link
Copy Markdown

👋 Thanks for assigning @tnull as a reviewer!
I'll wait for their review and will help manage the review process.
Once they submit their review, I'll check if a second reviewer would be helpful.

@tankyleo
tankyleo requested a review from tnullMay 6, 2026 01:25
tnull
tnull reviewed May 6, 2026
View reviewed changes
Comment threadrust/api/src/lib.rs Outdated
pub mod kv_store;

/// Contains request/response types generated from the API definition of VSS.
#[rustfmt::skip]

@tnulltnullMay 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why skip rather than formatting post-generation?

@tankyleotankyleoMay 6, 2026

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So that we don't need to run format post-generation ? Happy to drop if you prefer.

@tnulltnullMay 7, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it's always a debate whether to format or not format auto-generated code. I always lean towards yes, others towards no.

In the end it doesn't matter much, so I'd say I'd leave it up to you / your preference. Feel free to leave as-is.

@tankyleotankyleoMay 7, 2026

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I removed the skip and now format this file too.

Comment threadrust/api/build.rs
#[cfg(genproto)]
fn generate_protos() {
download_file(
"https://raw.githubusercontent.com/lightningdevkit/vss-server/7f492fcac0c561b212f49ca40f7d16075822440f/app/src/main/proto/vss.proto",

@tnulltnullMay 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIU, the original intention here was to pin the protocol version to a specific commit. But you're right that we probably should do that via the new protocol versioning, and proper vss-server tags/releases.

Comment threadrust/api/Cargo.toml

[target.'cfg(genproto)'.build-dependencies]
prost-build = { version = "0.11.3" }
reqwest = { version = "0.11.13", default-features = false, features = ["rustls-tls", "blocking"] }

@tnulltnullMay 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉

Comment threadrust/server/src/vss_service.rs Outdated
let prefix_stripped_path = path.strip_prefix(BASE_PATH_PREFIX).unwrap_or_default();

match prefix_stripped_path {
"/version" => {

@tnulltnullMay 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding this endpoint is great, but shouldn't we also add a (I guess optional, for backwards compat) protocol_version field to all other messages? Otherwise, if we require the client to always manually first call this endpoint and wait on the response a) it's error prone b) it would require another full RTT on startup which is not great. So maybe we make version negotiation implicit and only fail the flow on mismatch? Thoughts?

@tankyleotankyleoMay 6, 2026

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I add a vss-protocol-version header to every response, clients can read the protocol version from any response they get back from the server.

@tnulltnullMay 7, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool. Now that we did this, maybe the endpoint could be a more general /health or /status endpoint? Or maybe this shouldn't even be a VSS-style proto response but rather a prometheus-compatible endpoint then?

@tankyleotankyleoMay 7, 2026

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I remove /version, and add /metrics, which offers a prometheus-style gauge for now

@tankyleo
tankyleo requested a review from tnullMay 6, 2026 16:44
@tankyleotankyleo changed the title Add /version endpointAdd /metrics endpointMay 7, 2026
@tankyleotankyleo self-assigned this May 7, 2026
@tankyleotankyleo moved this to Goal: Merge in Weekly GoalsMay 7, 2026
@ldk-reviews-bot

ldk-reviews-bot commented May 9, 2026

Copy link
Copy Markdown

🔔 1st Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

@ldk-reviews-bot

ldk-reviews-bot commented May 11, 2026

Copy link
Copy Markdown

🔔 2nd Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

@ldk-reviews-bot

ldk-reviews-bot commented May 13, 2026

Copy link
Copy Markdown

🔔 3rd Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

@tankyleotankyleo mentioned this pull request May 13, 2026
Closed
@ldk-reviews-bot

ldk-reviews-bot commented May 16, 2026

Copy link
Copy Markdown

🔔 4th Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

@ldk-reviews-bot

ldk-reviews-bot commented May 18, 2026

Copy link
Copy Markdown

🔔 5th Reminder

Hey @tnull! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

tnull
tnull reviewed May 18, 2026
View reviewed changes

@tnulltnull left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, feel free to squash.

Comment threadrust/server/src/vss_service.rs
.header(PROTOCOL_VERSION_HEADER, PROTOCOL_VERSION.as_bytes())
.body(Full::new(body))
// unwrap safety: body only errors when previous chained calls failed.
.unwrap()

@tnulltnullMay 18, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we're touching this, should we avoid the unwrap and start bubbling up the error?

@tankyleotankyleoMay 18, 2026

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm so far, I buy the unwrap safety do you not buy it ? I carefully checked all the previous calls, and I don't see any panics possible here.

Comment threadrust/server/src/vss_service.rs Outdated

const MAXIMUM_REQUEST_BODY_SIZE: usize = 1024 * 1024 * 1024;
const PROTOCOL_VERSION_HEADER: &str = "vss-protocol-version";
const PROTOCOL_VERSION: &str = "0.1.0";

@tnulltnullMay 18, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, protocol version usally are simple integer numbers, given they are only changed if we break the API. Do we think SemVer makes sense here?

@tankyleotankyleoMay 18, 2026

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done below thank you

@tankyleo
Read vss.proto from the local repository instead of github
01893d2
We now read `vss.proto` from the local repository instead of downloading
it from a previous commit on github.
We will use protocol versioning, tags, and releases to coordinate
clients and servers.
@tankyleo
Add vss-protocol-version header
0e046d3
Clients will use this header to check the version of the VSS protocol
currently served.
This header is added to all responses from the server. We avoid creating
a new roundtrip to optimize startup time.
@tankyleo
Expose /metrics endpoint
922123e
This endpoint serves as a health check for operators of this VSS
implementation.
The endpoint also exposes a Prometheus gauge metric.
@tankyleo
tankyleoforce-pushed the 2026-05-health-check branch 3 times, most recently from 5b9efbd to 6871771CompareMay 18, 2026 19:19
@tankyleo

tankyleo commented May 18, 2026•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review tnull, I appended commit so that the gauge metric now tracks a successful roundtrip to the KvStore backend let me know what you think.

@tankyleo
tankyleo requested a review from tnullMay 18, 2026 19:27
@tankyleo

tankyleo commented May 18, 2026

Copy link
Copy Markdown
ContributorAuthor

I'm still debating that last commit, as the metrics endpoint is unauthenticated, so with JWTs someone could hit the database for free.

@tankyleo
tankyleoforce-pushed the 2026-05-health-check branch from 6871771 to 922123eCompareMay 18, 2026 19:40
@tankyleo

tankyleo commented May 18, 2026•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Ended up dropping it, now only changed to const PROTOCOL_VERSION: &str = "0"; from last review.

tnull
tnull approved these changes May 19, 2026
View reviewed changes

@tnulltnull left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I assume versioning support in vss-client is up next?

@tnull
tnull merged commit f728209 into lightningdevkit:mainMay 19, 2026
11 of 12 checks passed
@github-project-automationgithub-project-automationBot moved this from Goal: Merge to Done in Weekly GoalsMay 19, 2026
@tankyleo

tankyleo commented May 19, 2026

Copy link
Copy Markdown
ContributorAuthor

LGTM, I assume versioning support in vss-client is up next?

Yes thanks for the review

@tankyleotankyleo mentioned this pull request Jun 3, 2026
Closed
@tnulltnull mentioned this pull request Aug 20, 2026
Open
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tnulltnulltnull approved these changes

Assignees

@tankyleotankyleo

Labels

None yet

Projects

Weekly Goals
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@tankyleo@ldk-reviews-bot@tnull
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Add /metrics endpoint - #99
Merged
tnull merged 3 commits into
lightningdevkit:mainfrom 
tankyleo:2026-05-health-check
May 19, 2026
Merged
Add /metrics endpoint#99
tnull merged 3 commits into
lightningdevkit:mainfrom 
tankyleo:2026-05-health-check
Conversation
@tankyleo
@tankyleotankyleo
commented
May 6, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Compatible with prometheus
@ldk-reviews-bot
ldk-reviews-bot
commented
May 6, 2026•

edited

Loading

Copy link


Copy Markdown

👋 Thanks for assigning @tnull as a reviewer!

I'll wait for their review and will help manage the review process.

Once they submit their review, I'll check if a second reviewer would be helpful.
@tankyleo
tankyleo
requested a review
from tnullMay 6, 2026 01:25
tnull
tnull
reviewed
May 6, 2026
View reviewed changes
Comment threadrust/api/src/lib.rs
Outdated

pub mod kv_store;

/// Contains request/response types generated from the API definition of VSS.
#[rustfmt::skip]
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why skip rather than formatting post-generation?
@tankyleotankyleoMay 6, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So that we don't need to run format post-generation ? Happy to drop if you prefer.
@tnulltnullMay 7, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it's always a debate whether to format or not format auto-generated code. I always lean towards yes, others towards no.
In the end it doesn't matter much, so I'd say I'd leave it up to you / your preference. Feel free to leave as-is.
@tankyleotankyleoMay 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I removed the skip and now format this file too.
Comment threadrust/api/build.rs
#[cfg(genproto)]
fn generate_protos() {
	download_file(
 "https://raw.githubusercontent.com/lightningdevkit/vss-server/7f492fcac0c561b212f49ca40f7d16075822440f/app/src/main/proto/vss.proto",
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIU, the original intention here was to pin the protocol version to a specific commit. But you're right that we probably should do that via the new protocol versioning, and proper vss-server tags/releases.
Comment threadrust/api/Cargo.toml

[target.'cfg(genproto)'.build-dependencies]
prost-build = { version = "0.11.3" }
reqwest = { version = "0.11.13", default-features = false, features = ["rustls-tls", "blocking"] }
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉
Comment threadrust/server/src/vss_service.rs
Outdated

 let prefix_stripped_path = path.strip_prefix(BASE_PATH_PREFIX).unwrap_or_default();

 match prefix_stripped_path {
 "/version" => {
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding this endpoint is great, but shouldn't we also add a (I guess optional, for backwards compat) protocol_version field to all other messages? Otherwise, if we require the client to always manually first call this endpoint and wait on the response a) it's error prone b) it would require another full RTT on startup which is not great. So maybe we make version negotiation implicit and only fail the flow on mismatch? Thoughts?
@tankyleotankyleoMay 6, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I add a vss-protocol-version header to every response, clients can read the protocol version from any response they get back from the server.
@tnulltnullMay 7, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool. Now that we did this, maybe the endpoint could be a more general /health or /status endpoint? Or maybe this shouldn't even be a VSS-style proto response but rather a prometheus-compatible endpoint then?
@tankyleotankyleoMay 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I remove /version, and add /metrics, which offers a prometheus-style gauge for now
@tankyleo
tankyleo
requested a review
from tnullMay 6, 2026 16:44
@tankyleotankyleo
changed the title
Add /version endpointAdd /metrics endpointMay 7, 2026
@tankyleotankyleo
self-assigned this
May 7, 2026
@tankyleotankyleo
moved this to Goal: Merge
in Weekly GoalsMay 7, 2026
@ldk-reviews-bot
ldk-reviews-bot
commented
May 9, 2026

Copy link


Copy Markdown

🔔 1st Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 11, 2026

Copy link


Copy Markdown

🔔 2nd Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 13, 2026

Copy link


Copy Markdown

🔔 3rd Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@tankyleotankyleo
mentioned this pull request
May 13, 2026
 Closed

@ldk-reviews-bot
ldk-reviews-bot
commented
May 16, 2026

Copy link


Copy Markdown

🔔 4th Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 18, 2026

Copy link


Copy Markdown

🔔 5th Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
tnull
tnull
reviewed
May 18, 2026
View reviewed changes
@tnulltnull
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, feel free to squash.
Comment threadrust/server/src/vss_service.rs
 .header(PROTOCOL_VERSION_HEADER, PROTOCOL_VERSION.as_bytes())
 .body(Full::new(body))
 // unwrap safety: body only errors when previous chained calls failed.
 .unwrap()
@tnulltnullMay 18, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we're touching this, should we avoid the unwrap and start bubbling up the error?
@tankyleotankyleoMay 18, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm so far, I buy the unwrap safety do you not buy it ? I carefully checked all the previous calls, and I don't see any panics possible here.
Comment threadrust/server/src/vss_service.rs
Outdated


const MAXIMUM_REQUEST_BODY_SIZE: usize = 1024 * 1024 * 1024;
const PROTOCOL_VERSION_HEADER: &str = "vss-protocol-version";
const PROTOCOL_VERSION: &str = "0.1.0";
@tnulltnullMay 18, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, protocol version usally are simple integer numbers, given they are only changed if we break the API. Do we think SemVer makes sense here?
@tankyleotankyleoMay 18, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done below thank you
@tankyleo
Read vss.proto from the local repository instead of github
01893d2
We now read `vss.proto` from the local repository instead of downloading
it from a previous commit on github.
We will use protocol versioning, tags, and releases to coordinate
clients and servers.
@tankyleo
Add vss-protocol-version header
0e046d3
Clients will use this header to check the version of the VSS protocol
currently served.
This header is added to all responses from the server. We avoid creating
a new roundtrip to optimize startup time.
@tankyleo
Expose /metrics endpoint
922123e
This endpoint serves as a health check for operators of this VSS
implementation.
The endpoint also exposes a Prometheus gauge metric.
@tankyleo
tankyleoforce-pushed
the
2026-05-health-check
branch
3 times, most recently
from
5b9efbd to
6871771CompareMay 18, 2026 19:19
@tankyleo
tankyleo
commented
May 18, 2026•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Thanks for the review tnull, I appended commit so that the gauge metric now tracks a successful roundtrip to the KvStore backend let me know what you think.
@tankyleo
tankyleo
requested a review
from tnullMay 18, 2026 19:27
@tankyleo
tankyleo
commented
May 18, 2026

Copy link


Copy Markdown

ContributorAuthor
I'm still debating that last commit, as the metrics endpoint is unauthenticated, so with JWTs someone could hit the database for free.
@tankyleo
tankyleoforce-pushed
the
2026-05-health-check
branch
from
6871771 to
922123eCompareMay 18, 2026 19:40
@tankyleo
tankyleo
commented
May 18, 2026•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Ended up dropping it, now only changed to const PROTOCOL_VERSION: &str = "0"; from last review.
tnull
tnull
approved these changes
May 19, 2026
View reviewed changes
@tnulltnull
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I assume versioning support in vss-client is up next?
@tnull
tnull
merged commit f728209
into
lightningdevkit:mainMay 19, 2026

11 of 12 checks passed

@github-project-automationgithub-project-automationBot
moved this from Goal: Merge
to Done
in Weekly GoalsMay 19, 2026
@tankyleo
tankyleo
commented
May 19, 2026

Copy link


Copy Markdown

ContributorAuthor
LGTM, I assume versioning support in vss-client is up next?
Yes thanks for the review
@tankyleotankyleo
mentioned this pull request
Jun 3, 2026

Closed

@tnulltnull
mentioned this pull request
Aug 20, 2026

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@tnulltnulltnull approved these changes

Assignees

@tankyleotankyleo

Labels


None yet


Projects

Weekly Goals

Status: Done


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@tankyleo@ldk-reviews-bot@tnull

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add /metrics endpoint - #99
Merged
tnull merged 3 commits into
lightningdevkit:mainfrom 
tankyleo:2026-05-health-check
May 19, 2026
Merged
Add /metrics endpoint#99
tnull merged 3 commits into
lightningdevkit:mainfrom 
tankyleo:2026-05-health-check
Conversation
@tankyleo
@tankyleotankyleo
commented
May 6, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Compatible with prometheus
@ldk-reviews-bot
ldk-reviews-bot
commented
May 6, 2026•

edited

Loading

Copy link


Copy Markdown

👋 Thanks for assigning @tnull as a reviewer!

I'll wait for their review and will help manage the review process.

Once they submit their review, I'll check if a second reviewer would be helpful.
@tankyleo
tankyleo
requested a review
from tnullMay 6, 2026 01:25
tnull
tnull
reviewed
May 6, 2026
View reviewed changes
Comment threadrust/api/src/lib.rs
Outdated

pub mod kv_store;

/// Contains request/response types generated from the API definition of VSS.
#[rustfmt::skip]
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why skip rather than formatting post-generation?
@tankyleotankyleoMay 6, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So that we don't need to run format post-generation ? Happy to drop if you prefer.
@tnulltnullMay 7, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it's always a debate whether to format or not format auto-generated code. I always lean towards yes, others towards no.
In the end it doesn't matter much, so I'd say I'd leave it up to you / your preference. Feel free to leave as-is.
@tankyleotankyleoMay 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I removed the skip and now format this file too.
Comment threadrust/api/build.rs
#[cfg(genproto)]
fn generate_protos() {
	download_file(
 "https://raw.githubusercontent.com/lightningdevkit/vss-server/7f492fcac0c561b212f49ca40f7d16075822440f/app/src/main/proto/vss.proto",
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIU, the original intention here was to pin the protocol version to a specific commit. But you're right that we probably should do that via the new protocol versioning, and proper vss-server tags/releases.
Comment threadrust/api/Cargo.toml

[target.'cfg(genproto)'.build-dependencies]
prost-build = { version = "0.11.3" }
reqwest = { version = "0.11.13", default-features = false, features = ["rustls-tls", "blocking"] }
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉
Comment threadrust/server/src/vss_service.rs
Outdated

 let prefix_stripped_path = path.strip_prefix(BASE_PATH_PREFIX).unwrap_or_default();

 match prefix_stripped_path {
 "/version" => {
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding this endpoint is great, but shouldn't we also add a (I guess optional, for backwards compat) protocol_version field to all other messages? Otherwise, if we require the client to always manually first call this endpoint and wait on the response a) it's error prone b) it would require another full RTT on startup which is not great. So maybe we make version negotiation implicit and only fail the flow on mismatch? Thoughts?
@tankyleotankyleoMay 6, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I add a vss-protocol-version header to every response, clients can read the protocol version from any response they get back from the server.
@tnulltnullMay 7, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool. Now that we did this, maybe the endpoint could be a more general /health or /status endpoint? Or maybe this shouldn't even be a VSS-style proto response but rather a prometheus-compatible endpoint then?
@tankyleotankyleoMay 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I remove /version, and add /metrics, which offers a prometheus-style gauge for now
@tankyleo
tankyleo
requested a review
from tnullMay 6, 2026 16:44
@tankyleotankyleo
changed the title
Add /version endpointAdd /metrics endpointMay 7, 2026
@tankyleotankyleo
self-assigned this
May 7, 2026
@tankyleotankyleo
moved this to Goal: Merge
in Weekly GoalsMay 7, 2026
@ldk-reviews-bot
ldk-reviews-bot
commented
May 9, 2026

Copy link


Copy Markdown

🔔 1st Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 11, 2026

Copy link


Copy Markdown

🔔 2nd Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 13, 2026

Copy link


Copy Markdown

🔔 3rd Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@tankyleotankyleo
mentioned this pull request
May 13, 2026
 Closed

@ldk-reviews-bot
ldk-reviews-bot
commented
May 16, 2026

Copy link


Copy Markdown

🔔 4th Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 18, 2026

Copy link


Copy Markdown

🔔 5th Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
tnull
tnull
reviewed
May 18, 2026
View reviewed changes
@tnulltnull
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, feel free to squash.
Comment threadrust/server/src/vss_service.rs
 .header(PROTOCOL_VERSION_HEADER, PROTOCOL_VERSION.as_bytes())
 .body(Full::new(body))
 // unwrap safety: body only errors when previous chained calls failed.
 .unwrap()
@tnulltnullMay 18, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we're touching this, should we avoid the unwrap and start bubbling up the error?
@tankyleotankyleoMay 18, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm so far, I buy the unwrap safety do you not buy it ? I carefully checked all the previous calls, and I don't see any panics possible here.
Comment threadrust/server/src/vss_service.rs
Outdated


const MAXIMUM_REQUEST_BODY_SIZE: usize = 1024 * 1024 * 1024;
const PROTOCOL_VERSION_HEADER: &str = "vss-protocol-version";
const PROTOCOL_VERSION: &str = "0.1.0";
@tnulltnullMay 18, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, protocol version usally are simple integer numbers, given they are only changed if we break the API. Do we think SemVer makes sense here?
@tankyleotankyleoMay 18, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done below thank you
@tankyleo
Read vss.proto from the local repository instead of github
01893d2
We now read `vss.proto` from the local repository instead of downloading
it from a previous commit on github.
We will use protocol versioning, tags, and releases to coordinate
clients and servers.
@tankyleo
Add vss-protocol-version header
0e046d3
Clients will use this header to check the version of the VSS protocol
currently served.
This header is added to all responses from the server. We avoid creating
a new roundtrip to optimize startup time.
@tankyleo
Expose /metrics endpoint
922123e
This endpoint serves as a health check for operators of this VSS
implementation.
The endpoint also exposes a Prometheus gauge metric.
@tankyleo
tankyleoforce-pushed
the
2026-05-health-check
branch
3 times, most recently
from
5b9efbd to
6871771CompareMay 18, 2026 19:19
@tankyleo
tankyleo
commented
May 18, 2026•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Thanks for the review tnull, I appended commit so that the gauge metric now tracks a successful roundtrip to the KvStore backend let me know what you think.
@tankyleo
tankyleo
requested a review
from tnullMay 18, 2026 19:27
@tankyleo
tankyleo
commented
May 18, 2026

Copy link


Copy Markdown

ContributorAuthor
I'm still debating that last commit, as the metrics endpoint is unauthenticated, so with JWTs someone could hit the database for free.
@tankyleo
tankyleoforce-pushed
the
2026-05-health-check
branch
from
6871771 to
922123eCompareMay 18, 2026 19:40
@tankyleo
tankyleo
commented
May 18, 2026•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Ended up dropping it, now only changed to const PROTOCOL_VERSION: &str = "0"; from last review.
tnull
tnull
approved these changes
May 19, 2026
View reviewed changes
@tnulltnull
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I assume versioning support in vss-client is up next?
@tnull
tnull
merged commit f728209
into
lightningdevkit:mainMay 19, 2026

11 of 12 checks passed

@github-project-automationgithub-project-automationBot
moved this from Goal: Merge
to Done
in Weekly GoalsMay 19, 2026
@tankyleo
tankyleo
commented
May 19, 2026

Copy link


Copy Markdown

ContributorAuthor
LGTM, I assume versioning support in vss-client is up next?
Yes thanks for the review
@tankyleotankyleo
mentioned this pull request
Jun 3, 2026

Closed

@tnulltnull
mentioned this pull request
Aug 20, 2026

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@tnulltnulltnull approved these changes

Assignees

@tankyleotankyleo

Labels


None yet


Projects

Weekly Goals

Status: Done


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@tankyleo@ldk-reviews-bot@tnull

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add /metrics endpoint - #99
Merged
tnull merged 3 commits into
lightningdevkit:mainfrom 
tankyleo:2026-05-health-check
May 19, 2026
Merged
Add /metrics endpoint#99
tnull merged 3 commits into
lightningdevkit:mainfrom 
tankyleo:2026-05-health-check
Conversation
@tankyleo
@tankyleotankyleo
commented
May 6, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Compatible with prometheus
@ldk-reviews-bot
ldk-reviews-bot
commented
May 6, 2026•

edited

Loading

Copy link


Copy Markdown

👋 Thanks for assigning @tnull as a reviewer!

I'll wait for their review and will help manage the review process.

Once they submit their review, I'll check if a second reviewer would be helpful.
@tankyleo
tankyleo
requested a review
from tnullMay 6, 2026 01:25
tnull
tnull
reviewed
May 6, 2026
View reviewed changes
Comment threadrust/api/src/lib.rs
Outdated

pub mod kv_store;

/// Contains request/response types generated from the API definition of VSS.
#[rustfmt::skip]
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why skip rather than formatting post-generation?
@tankyleotankyleoMay 6, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So that we don't need to run format post-generation ? Happy to drop if you prefer.
@tnulltnullMay 7, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it's always a debate whether to format or not format auto-generated code. I always lean towards yes, others towards no.
In the end it doesn't matter much, so I'd say I'd leave it up to you / your preference. Feel free to leave as-is.
@tankyleotankyleoMay 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I removed the skip and now format this file too.
Comment threadrust/api/build.rs
#[cfg(genproto)]
fn generate_protos() {
	download_file(
 "https://raw.githubusercontent.com/lightningdevkit/vss-server/7f492fcac0c561b212f49ca40f7d16075822440f/app/src/main/proto/vss.proto",
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIU, the original intention here was to pin the protocol version to a specific commit. But you're right that we probably should do that via the new protocol versioning, and proper vss-server tags/releases.
Comment threadrust/api/Cargo.toml

[target.'cfg(genproto)'.build-dependencies]
prost-build = { version = "0.11.3" }
reqwest = { version = "0.11.13", default-features = false, features = ["rustls-tls", "blocking"] }
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉
Comment threadrust/server/src/vss_service.rs
Outdated

 let prefix_stripped_path = path.strip_prefix(BASE_PATH_PREFIX).unwrap_or_default();

 match prefix_stripped_path {
 "/version" => {
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding this endpoint is great, but shouldn't we also add a (I guess optional, for backwards compat) protocol_version field to all other messages? Otherwise, if we require the client to always manually first call this endpoint and wait on the response a) it's error prone b) it would require another full RTT on startup which is not great. So maybe we make version negotiation implicit and only fail the flow on mismatch? Thoughts?
@tankyleotankyleoMay 6, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I add a vss-protocol-version header to every response, clients can read the protocol version from any response they get back from the server.
@tnulltnullMay 7, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool. Now that we did this, maybe the endpoint could be a more general /health or /status endpoint? Or maybe this shouldn't even be a VSS-style proto response but rather a prometheus-compatible endpoint then?
@tankyleotankyleoMay 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I remove /version, and add /metrics, which offers a prometheus-style gauge for now
@tankyleo
tankyleo
requested a review
from tnullMay 6, 2026 16:44
@tankyleotankyleo
changed the title
Add /version endpointAdd /metrics endpointMay 7, 2026
@tankyleotankyleo
self-assigned this
May 7, 2026
@tankyleotankyleo
moved this to Goal: Merge
in Weekly GoalsMay 7, 2026
@ldk-reviews-bot
ldk-reviews-bot
commented
May 9, 2026

Copy link


Copy Markdown

🔔 1st Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 11, 2026

Copy link


Copy Markdown

🔔 2nd Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 13, 2026

Copy link


Copy Markdown

🔔 3rd Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@tankyleotankyleo
mentioned this pull request
May 13, 2026
 Closed

@ldk-reviews-bot
ldk-reviews-bot
commented
May 16, 2026

Copy link


Copy Markdown

🔔 4th Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 18, 2026

Copy link


Copy Markdown

🔔 5th Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
tnull
tnull
reviewed
May 18, 2026
View reviewed changes
@tnulltnull
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, feel free to squash.
Comment threadrust/server/src/vss_service.rs
 .header(PROTOCOL_VERSION_HEADER, PROTOCOL_VERSION.as_bytes())
 .body(Full::new(body))
 // unwrap safety: body only errors when previous chained calls failed.
 .unwrap()
@tnulltnullMay 18, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we're touching this, should we avoid the unwrap and start bubbling up the error?
@tankyleotankyleoMay 18, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm so far, I buy the unwrap safety do you not buy it ? I carefully checked all the previous calls, and I don't see any panics possible here.
Comment threadrust/server/src/vss_service.rs
Outdated


const MAXIMUM_REQUEST_BODY_SIZE: usize = 1024 * 1024 * 1024;
const PROTOCOL_VERSION_HEADER: &str = "vss-protocol-version";
const PROTOCOL_VERSION: &str = "0.1.0";
@tnulltnullMay 18, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, protocol version usally are simple integer numbers, given they are only changed if we break the API. Do we think SemVer makes sense here?
@tankyleotankyleoMay 18, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done below thank you
@tankyleo
Read vss.proto from the local repository instead of github
01893d2
We now read `vss.proto` from the local repository instead of downloading
it from a previous commit on github.
We will use protocol versioning, tags, and releases to coordinate
clients and servers.
@tankyleo
Add vss-protocol-version header
0e046d3
Clients will use this header to check the version of the VSS protocol
currently served.
This header is added to all responses from the server. We avoid creating
a new roundtrip to optimize startup time.
@tankyleo
Expose /metrics endpoint
922123e
This endpoint serves as a health check for operators of this VSS
implementation.
The endpoint also exposes a Prometheus gauge metric.
@tankyleo
tankyleoforce-pushed
the
2026-05-health-check
branch
3 times, most recently
from
5b9efbd to
6871771CompareMay 18, 2026 19:19
@tankyleo
tankyleo
commented
May 18, 2026•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Thanks for the review tnull, I appended commit so that the gauge metric now tracks a successful roundtrip to the KvStore backend let me know what you think.
@tankyleo
tankyleo
requested a review
from tnullMay 18, 2026 19:27
@tankyleo
tankyleo
commented
May 18, 2026

Copy link


Copy Markdown

ContributorAuthor
I'm still debating that last commit, as the metrics endpoint is unauthenticated, so with JWTs someone could hit the database for free.
@tankyleo
tankyleoforce-pushed
the
2026-05-health-check
branch
from
6871771 to
922123eCompareMay 18, 2026 19:40
@tankyleo
tankyleo
commented
May 18, 2026•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Ended up dropping it, now only changed to const PROTOCOL_VERSION: &str = "0"; from last review.
tnull
tnull
approved these changes
May 19, 2026
View reviewed changes
@tnulltnull
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I assume versioning support in vss-client is up next?
@tnull
tnull
merged commit f728209
into
lightningdevkit:mainMay 19, 2026

11 of 12 checks passed

@github-project-automationgithub-project-automationBot
moved this from Goal: Merge
to Done
in Weekly GoalsMay 19, 2026
@tankyleo
tankyleo
commented
May 19, 2026

Copy link


Copy Markdown

ContributorAuthor
LGTM, I assume versioning support in vss-client is up next?
Yes thanks for the review
@tankyleotankyleo
mentioned this pull request
Jun 3, 2026

Closed

@tnulltnull
mentioned this pull request
Aug 20, 2026

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@tnulltnulltnull approved these changes

Assignees

@tankyleotankyleo

Labels


None yet


Projects

Weekly Goals

Status: Done


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@tankyleo@ldk-reviews-bot@tnull

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Add /metrics endpoint - #99
Merged
tnull merged 3 commits into
lightningdevkit:mainfrom 
tankyleo:2026-05-health-check
May 19, 2026
Merged
Add /metrics endpoint#99
tnull merged 3 commits into
lightningdevkit:mainfrom 
tankyleo:2026-05-health-check
Conversation
@tankyleo
@tankyleotankyleo
commented
May 6, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Compatible with prometheus
@ldk-reviews-bot
ldk-reviews-bot
commented
May 6, 2026•

edited

Loading

Copy link


Copy Markdown

👋 Thanks for assigning @tnull as a reviewer!

I'll wait for their review and will help manage the review process.

Once they submit their review, I'll check if a second reviewer would be helpful.
@tankyleo
tankyleo
requested a review
from tnullMay 6, 2026 01:25
tnull
tnull
reviewed
May 6, 2026
View reviewed changes
Comment threadrust/api/src/lib.rs
Outdated

pub mod kv_store;

/// Contains request/response types generated from the API definition of VSS.
#[rustfmt::skip]
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why skip rather than formatting post-generation?
@tankyleotankyleoMay 6, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So that we don't need to run format post-generation ? Happy to drop if you prefer.
@tnulltnullMay 7, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it's always a debate whether to format or not format auto-generated code. I always lean towards yes, others towards no.
In the end it doesn't matter much, so I'd say I'd leave it up to you / your preference. Feel free to leave as-is.
@tankyleotankyleoMay 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I removed the skip and now format this file too.
Comment threadrust/api/build.rs
#[cfg(genproto)]
fn generate_protos() {
	download_file(
 "https://raw.githubusercontent.com/lightningdevkit/vss-server/7f492fcac0c561b212f49ca40f7d16075822440f/app/src/main/proto/vss.proto",
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIU, the original intention here was to pin the protocol version to a specific commit. But you're right that we probably should do that via the new protocol versioning, and proper vss-server tags/releases.
Comment threadrust/api/Cargo.toml

[target.'cfg(genproto)'.build-dependencies]
prost-build = { version = "0.11.3" }
reqwest = { version = "0.11.13", default-features = false, features = ["rustls-tls", "blocking"] }
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉
Comment threadrust/server/src/vss_service.rs
Outdated

 let prefix_stripped_path = path.strip_prefix(BASE_PATH_PREFIX).unwrap_or_default();

 match prefix_stripped_path {
 "/version" => {
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding this endpoint is great, but shouldn't we also add a (I guess optional, for backwards compat) protocol_version field to all other messages? Otherwise, if we require the client to always manually first call this endpoint and wait on the response a) it's error prone b) it would require another full RTT on startup which is not great. So maybe we make version negotiation implicit and only fail the flow on mismatch? Thoughts?
@tankyleotankyleoMay 6, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I add a vss-protocol-version header to every response, clients can read the protocol version from any response they get back from the server.
@tnulltnullMay 7, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool. Now that we did this, maybe the endpoint could be a more general /health or /status endpoint? Or maybe this shouldn't even be a VSS-style proto response but rather a prometheus-compatible endpoint then?
@tankyleotankyleoMay 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I remove /version, and add /metrics, which offers a prometheus-style gauge for now
@tankyleo
tankyleo
requested a review
from tnullMay 6, 2026 16:44
@tankyleotankyleo
changed the title
Add /version endpointAdd /metrics endpointMay 7, 2026
@tankyleotankyleo
self-assigned this
May 7, 2026
@tankyleotankyleo
moved this to Goal: Merge
in Weekly GoalsMay 7, 2026
@ldk-reviews-bot
ldk-reviews-bot
commented
May 9, 2026

Copy link


Copy Markdown

🔔 1st Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 11, 2026

Copy link


Copy Markdown

🔔 2nd Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 13, 2026

Copy link


Copy Markdown

🔔 3rd Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@tankyleotankyleo
mentioned this pull request
May 13, 2026
 Closed

@ldk-reviews-bot
ldk-reviews-bot
commented
May 16, 2026

Copy link


Copy Markdown

🔔 4th Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 18, 2026

Copy link


Copy Markdown

🔔 5th Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
tnull
tnull
reviewed
May 18, 2026
View reviewed changes
@tnulltnull
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, feel free to squash.
Comment threadrust/server/src/vss_service.rs
 .header(PROTOCOL_VERSION_HEADER, PROTOCOL_VERSION.as_bytes())
 .body(Full::new(body))
 // unwrap safety: body only errors when previous chained calls failed.
 .unwrap()
@tnulltnullMay 18, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we're touching this, should we avoid the unwrap and start bubbling up the error?
@tankyleotankyleoMay 18, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm so far, I buy the unwrap safety do you not buy it ? I carefully checked all the previous calls, and I don't see any panics possible here.
Comment threadrust/server/src/vss_service.rs
Outdated


const MAXIMUM_REQUEST_BODY_SIZE: usize = 1024 * 1024 * 1024;
const PROTOCOL_VERSION_HEADER: &str = "vss-protocol-version";
const PROTOCOL_VERSION: &str = "0.1.0";
@tnulltnullMay 18, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, protocol version usally are simple integer numbers, given they are only changed if we break the API. Do we think SemVer makes sense here?
@tankyleotankyleoMay 18, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done below thank you
@tankyleo
Read vss.proto from the local repository instead of github
01893d2
We now read `vss.proto` from the local repository instead of downloading
it from a previous commit on github.
We will use protocol versioning, tags, and releases to coordinate
clients and servers.
@tankyleo
Add vss-protocol-version header
0e046d3
Clients will use this header to check the version of the VSS protocol
currently served.
This header is added to all responses from the server. We avoid creating
a new roundtrip to optimize startup time.
@tankyleo
Expose /metrics endpoint
922123e
This endpoint serves as a health check for operators of this VSS
implementation.
The endpoint also exposes a Prometheus gauge metric.
@tankyleo
tankyleoforce-pushed
the
2026-05-health-check
branch
3 times, most recently
from
5b9efbd to
6871771CompareMay 18, 2026 19:19
@tankyleo
tankyleo
commented
May 18, 2026•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Thanks for the review tnull, I appended commit so that the gauge metric now tracks a successful roundtrip to the KvStore backend let me know what you think.
@tankyleo
tankyleo
requested a review
from tnullMay 18, 2026 19:27
@tankyleo
tankyleo
commented
May 18, 2026

Copy link


Copy Markdown

ContributorAuthor
I'm still debating that last commit, as the metrics endpoint is unauthenticated, so with JWTs someone could hit the database for free.
@tankyleo
tankyleoforce-pushed
the
2026-05-health-check
branch
from
6871771 to
922123eCompareMay 18, 2026 19:40
@tankyleo
tankyleo
commented
May 18, 2026•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Ended up dropping it, now only changed to const PROTOCOL_VERSION: &str = "0"; from last review.
tnull
tnull
approved these changes
May 19, 2026
View reviewed changes
@tnulltnull
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I assume versioning support in vss-client is up next?
@tnull
tnull
merged commit f728209
into
lightningdevkit:mainMay 19, 2026

11 of 12 checks passed

@github-project-automationgithub-project-automationBot
moved this from Goal: Merge
to Done
in Weekly GoalsMay 19, 2026
@tankyleo
tankyleo
commented
May 19, 2026

Copy link


Copy Markdown

ContributorAuthor
LGTM, I assume versioning support in vss-client is up next?
Yes thanks for the review
@tankyleotankyleo
mentioned this pull request
Jun 3, 2026

Closed

@tnulltnull
mentioned this pull request
Aug 20, 2026

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@tnulltnulltnull approved these changes

Assignees

@tankyleotankyleo

Labels


None yet


Projects

Weekly Goals

Status: Done


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@tankyleo@ldk-reviews-bot@tnull

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add /metrics endpoint - #99
Merged
tnull merged 3 commits into
lightningdevkit:mainfrom 
tankyleo:2026-05-health-check
May 19, 2026
Merged
Add /metrics endpoint#99
tnull merged 3 commits into
lightningdevkit:mainfrom 
tankyleo:2026-05-health-check
Conversation
@tankyleo
@tankyleotankyleo
commented
May 6, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Compatible with prometheus
@ldk-reviews-bot
ldk-reviews-bot
commented
May 6, 2026•

edited

Loading

Copy link


Copy Markdown

👋 Thanks for assigning @tnull as a reviewer!

I'll wait for their review and will help manage the review process.

Once they submit their review, I'll check if a second reviewer would be helpful.
@tankyleo
tankyleo
requested a review
from tnullMay 6, 2026 01:25
tnull
tnull
reviewed
May 6, 2026
View reviewed changes
Comment threadrust/api/src/lib.rs
Outdated

pub mod kv_store;

/// Contains request/response types generated from the API definition of VSS.
#[rustfmt::skip]
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why skip rather than formatting post-generation?
@tankyleotankyleoMay 6, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So that we don't need to run format post-generation ? Happy to drop if you prefer.
@tnulltnullMay 7, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it's always a debate whether to format or not format auto-generated code. I always lean towards yes, others towards no.
In the end it doesn't matter much, so I'd say I'd leave it up to you / your preference. Feel free to leave as-is.
@tankyleotankyleoMay 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I removed the skip and now format this file too.
Comment threadrust/api/build.rs
#[cfg(genproto)]
fn generate_protos() {
	download_file(
 "https://raw.githubusercontent.com/lightningdevkit/vss-server/7f492fcac0c561b212f49ca40f7d16075822440f/app/src/main/proto/vss.proto",
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIU, the original intention here was to pin the protocol version to a specific commit. But you're right that we probably should do that via the new protocol versioning, and proper vss-server tags/releases.
Comment threadrust/api/Cargo.toml

[target.'cfg(genproto)'.build-dependencies]
prost-build = { version = "0.11.3" }
reqwest = { version = "0.11.13", default-features = false, features = ["rustls-tls", "blocking"] }
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉
Comment threadrust/server/src/vss_service.rs
Outdated

 let prefix_stripped_path = path.strip_prefix(BASE_PATH_PREFIX).unwrap_or_default();

 match prefix_stripped_path {
 "/version" => {
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding this endpoint is great, but shouldn't we also add a (I guess optional, for backwards compat) protocol_version field to all other messages? Otherwise, if we require the client to always manually first call this endpoint and wait on the response a) it's error prone b) it would require another full RTT on startup which is not great. So maybe we make version negotiation implicit and only fail the flow on mismatch? Thoughts?
@tankyleotankyleoMay 6, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I add a vss-protocol-version header to every response, clients can read the protocol version from any response they get back from the server.
@tnulltnullMay 7, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool. Now that we did this, maybe the endpoint could be a more general /health or /status endpoint? Or maybe this shouldn't even be a VSS-style proto response but rather a prometheus-compatible endpoint then?
@tankyleotankyleoMay 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I remove /version, and add /metrics, which offers a prometheus-style gauge for now
@tankyleo
tankyleo
requested a review
from tnullMay 6, 2026 16:44
@tankyleotankyleo
changed the title
Add /version endpointAdd /metrics endpointMay 7, 2026
@tankyleotankyleo
self-assigned this
May 7, 2026
@tankyleotankyleo
moved this to Goal: Merge
in Weekly GoalsMay 7, 2026
@ldk-reviews-bot
ldk-reviews-bot
commented
May 9, 2026

Copy link


Copy Markdown

🔔 1st Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 11, 2026

Copy link


Copy Markdown

🔔 2nd Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 13, 2026

Copy link


Copy Markdown

🔔 3rd Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@tankyleotankyleo
mentioned this pull request
May 13, 2026
 Closed

@ldk-reviews-bot
ldk-reviews-bot
commented
May 16, 2026

Copy link


Copy Markdown

🔔 4th Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 18, 2026

Copy link


Copy Markdown

🔔 5th Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
tnull
tnull
reviewed
May 18, 2026
View reviewed changes
@tnulltnull
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, feel free to squash.
Comment threadrust/server/src/vss_service.rs
 .header(PROTOCOL_VERSION_HEADER, PROTOCOL_VERSION.as_bytes())
 .body(Full::new(body))
 // unwrap safety: body only errors when previous chained calls failed.
 .unwrap()
@tnulltnullMay 18, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we're touching this, should we avoid the unwrap and start bubbling up the error?
@tankyleotankyleoMay 18, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm so far, I buy the unwrap safety do you not buy it ? I carefully checked all the previous calls, and I don't see any panics possible here.
Comment threadrust/server/src/vss_service.rs
Outdated


const MAXIMUM_REQUEST_BODY_SIZE: usize = 1024 * 1024 * 1024;
const PROTOCOL_VERSION_HEADER: &str = "vss-protocol-version";
const PROTOCOL_VERSION: &str = "0.1.0";
@tnulltnullMay 18, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, protocol version usally are simple integer numbers, given they are only changed if we break the API. Do we think SemVer makes sense here?
@tankyleotankyleoMay 18, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done below thank you
@tankyleo
Read vss.proto from the local repository instead of github
01893d2
We now read `vss.proto` from the local repository instead of downloading
it from a previous commit on github.
We will use protocol versioning, tags, and releases to coordinate
clients and servers.
@tankyleo
Add vss-protocol-version header
0e046d3
Clients will use this header to check the version of the VSS protocol
currently served.
This header is added to all responses from the server. We avoid creating
a new roundtrip to optimize startup time.
@tankyleo
Expose /metrics endpoint
922123e
This endpoint serves as a health check for operators of this VSS
implementation.
The endpoint also exposes a Prometheus gauge metric.
@tankyleo
tankyleoforce-pushed
the
2026-05-health-check
branch
3 times, most recently
from
5b9efbd to
6871771CompareMay 18, 2026 19:19
@tankyleo
tankyleo
commented
May 18, 2026•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Thanks for the review tnull, I appended commit so that the gauge metric now tracks a successful roundtrip to the KvStore backend let me know what you think.
@tankyleo
tankyleo
requested a review
from tnullMay 18, 2026 19:27
@tankyleo
tankyleo
commented
May 18, 2026

Copy link


Copy Markdown

ContributorAuthor
I'm still debating that last commit, as the metrics endpoint is unauthenticated, so with JWTs someone could hit the database for free.
@tankyleo
tankyleoforce-pushed
the
2026-05-health-check
branch
from
6871771 to
922123eCompareMay 18, 2026 19:40
@tankyleo
tankyleo
commented
May 18, 2026•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Ended up dropping it, now only changed to const PROTOCOL_VERSION: &str = "0"; from last review.
tnull
tnull
approved these changes
May 19, 2026
View reviewed changes
@tnulltnull
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I assume versioning support in vss-client is up next?
@tnull
tnull
merged commit f728209
into
lightningdevkit:mainMay 19, 2026

11 of 12 checks passed

@github-project-automationgithub-project-automationBot
moved this from Goal: Merge
to Done
in Weekly GoalsMay 19, 2026
@tankyleo
tankyleo
commented
May 19, 2026

Copy link


Copy Markdown

ContributorAuthor
LGTM, I assume versioning support in vss-client is up next?
Yes thanks for the review
@tankyleotankyleo
mentioned this pull request
Jun 3, 2026

Closed

@tnulltnull
mentioned this pull request
Aug 20, 2026

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@tnulltnulltnull approved these changes

Assignees

@tankyleotankyleo

Labels


None yet


Projects

Weekly Goals

Status: Done


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@tankyleo@ldk-reviews-bot@tnull

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add /metrics endpoint - #99
Merged
tnull merged 3 commits into
lightningdevkit:mainfrom 
tankyleo:2026-05-health-check
May 19, 2026
Merged
Add /metrics endpoint#99
tnull merged 3 commits into
lightningdevkit:mainfrom 
tankyleo:2026-05-health-check
Conversation
@tankyleo
@tankyleotankyleo
commented
May 6, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Compatible with prometheus
@ldk-reviews-bot
ldk-reviews-bot
commented
May 6, 2026•

edited

Loading

Copy link


Copy Markdown

👋 Thanks for assigning @tnull as a reviewer!

I'll wait for their review and will help manage the review process.

Once they submit their review, I'll check if a second reviewer would be helpful.
@tankyleo
tankyleo
requested a review
from tnullMay 6, 2026 01:25
tnull
tnull
reviewed
May 6, 2026
View reviewed changes
Comment threadrust/api/src/lib.rs
Outdated

pub mod kv_store;

/// Contains request/response types generated from the API definition of VSS.
#[rustfmt::skip]
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why skip rather than formatting post-generation?
@tankyleotankyleoMay 6, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So that we don't need to run format post-generation ? Happy to drop if you prefer.
@tnulltnullMay 7, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it's always a debate whether to format or not format auto-generated code. I always lean towards yes, others towards no.
In the end it doesn't matter much, so I'd say I'd leave it up to you / your preference. Feel free to leave as-is.
@tankyleotankyleoMay 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I removed the skip and now format this file too.
Comment threadrust/api/build.rs
#[cfg(genproto)]
fn generate_protos() {
	download_file(
 "https://raw.githubusercontent.com/lightningdevkit/vss-server/7f492fcac0c561b212f49ca40f7d16075822440f/app/src/main/proto/vss.proto",
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIU, the original intention here was to pin the protocol version to a specific commit. But you're right that we probably should do that via the new protocol versioning, and proper vss-server tags/releases.
Comment threadrust/api/Cargo.toml

[target.'cfg(genproto)'.build-dependencies]
prost-build = { version = "0.11.3" }
reqwest = { version = "0.11.13", default-features = false, features = ["rustls-tls", "blocking"] }
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉
Comment threadrust/server/src/vss_service.rs
Outdated

 let prefix_stripped_path = path.strip_prefix(BASE_PATH_PREFIX).unwrap_or_default();

 match prefix_stripped_path {
 "/version" => {
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding this endpoint is great, but shouldn't we also add a (I guess optional, for backwards compat) protocol_version field to all other messages? Otherwise, if we require the client to always manually first call this endpoint and wait on the response a) it's error prone b) it would require another full RTT on startup which is not great. So maybe we make version negotiation implicit and only fail the flow on mismatch? Thoughts?
@tankyleotankyleoMay 6, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I add a vss-protocol-version header to every response, clients can read the protocol version from any response they get back from the server.
@tnulltnullMay 7, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool. Now that we did this, maybe the endpoint could be a more general /health or /status endpoint? Or maybe this shouldn't even be a VSS-style proto response but rather a prometheus-compatible endpoint then?
@tankyleotankyleoMay 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I remove /version, and add /metrics, which offers a prometheus-style gauge for now
@tankyleo
tankyleo
requested a review
from tnullMay 6, 2026 16:44
@tankyleotankyleo
changed the title
Add /version endpointAdd /metrics endpointMay 7, 2026
@tankyleotankyleo
self-assigned this
May 7, 2026
@tankyleotankyleo
moved this to Goal: Merge
in Weekly GoalsMay 7, 2026
@ldk-reviews-bot
ldk-reviews-bot
commented
May 9, 2026

Copy link


Copy Markdown

🔔 1st Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 11, 2026

Copy link


Copy Markdown

🔔 2nd Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 13, 2026

Copy link


Copy Markdown

🔔 3rd Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@tankyleotankyleo
mentioned this pull request
May 13, 2026
 Closed

@ldk-reviews-bot
ldk-reviews-bot
commented
May 16, 2026

Copy link


Copy Markdown

🔔 4th Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 18, 2026

Copy link


Copy Markdown

🔔 5th Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
tnull
tnull
reviewed
May 18, 2026
View reviewed changes
@tnulltnull
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, feel free to squash.
Comment threadrust/server/src/vss_service.rs
 .header(PROTOCOL_VERSION_HEADER, PROTOCOL_VERSION.as_bytes())
 .body(Full::new(body))
 // unwrap safety: body only errors when previous chained calls failed.
 .unwrap()
@tnulltnullMay 18, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we're touching this, should we avoid the unwrap and start bubbling up the error?
@tankyleotankyleoMay 18, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm so far, I buy the unwrap safety do you not buy it ? I carefully checked all the previous calls, and I don't see any panics possible here.
Comment threadrust/server/src/vss_service.rs
Outdated


const MAXIMUM_REQUEST_BODY_SIZE: usize = 1024 * 1024 * 1024;
const PROTOCOL_VERSION_HEADER: &str = "vss-protocol-version";
const PROTOCOL_VERSION: &str = "0.1.0";
@tnulltnullMay 18, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, protocol version usally are simple integer numbers, given they are only changed if we break the API. Do we think SemVer makes sense here?
@tankyleotankyleoMay 18, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done below thank you
@tankyleo
Read vss.proto from the local repository instead of github
01893d2
We now read `vss.proto` from the local repository instead of downloading
it from a previous commit on github.
We will use protocol versioning, tags, and releases to coordinate
clients and servers.
@tankyleo
Add vss-protocol-version header
0e046d3
Clients will use this header to check the version of the VSS protocol
currently served.
This header is added to all responses from the server. We avoid creating
a new roundtrip to optimize startup time.
@tankyleo
Expose /metrics endpoint
922123e
This endpoint serves as a health check for operators of this VSS
implementation.
The endpoint also exposes a Prometheus gauge metric.
@tankyleo
tankyleoforce-pushed
the
2026-05-health-check
branch
3 times, most recently
from
5b9efbd to
6871771CompareMay 18, 2026 19:19
@tankyleo
tankyleo
commented
May 18, 2026•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Thanks for the review tnull, I appended commit so that the gauge metric now tracks a successful roundtrip to the KvStore backend let me know what you think.
@tankyleo
tankyleo
requested a review
from tnullMay 18, 2026 19:27
@tankyleo
tankyleo
commented
May 18, 2026

Copy link


Copy Markdown

ContributorAuthor
I'm still debating that last commit, as the metrics endpoint is unauthenticated, so with JWTs someone could hit the database for free.
@tankyleo
tankyleoforce-pushed
the
2026-05-health-check
branch
from
6871771 to
922123eCompareMay 18, 2026 19:40
@tankyleo
tankyleo
commented
May 18, 2026•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Ended up dropping it, now only changed to const PROTOCOL_VERSION: &str = "0"; from last review.
tnull
tnull
approved these changes
May 19, 2026
View reviewed changes
@tnulltnull
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I assume versioning support in vss-client is up next?
@tnull
tnull
merged commit f728209
into
lightningdevkit:mainMay 19, 2026

11 of 12 checks passed

@github-project-automationgithub-project-automationBot
moved this from Goal: Merge
to Done
in Weekly GoalsMay 19, 2026
@tankyleo
tankyleo
commented
May 19, 2026

Copy link


Copy Markdown

ContributorAuthor
LGTM, I assume versioning support in vss-client is up next?
Yes thanks for the review
@tankyleotankyleo
mentioned this pull request
Jun 3, 2026

Closed

@tnulltnull
mentioned this pull request
Aug 20, 2026

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@tnulltnulltnull approved these changes

Assignees

@tankyleotankyleo

Labels


None yet


Projects

Weekly Goals

Status: Done


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@tankyleo@ldk-reviews-bot@tnull

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Add /metrics endpoint - #99
Merged
tnull merged 3 commits into
lightningdevkit:mainfrom 
tankyleo:2026-05-health-check
May 19, 2026
Merged
Add /metrics endpoint#99
tnull merged 3 commits into
lightningdevkit:mainfrom 
tankyleo:2026-05-health-check
Conversation
@tankyleo
@tankyleotankyleo
commented
May 6, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Compatible with prometheus
@ldk-reviews-bot
ldk-reviews-bot
commented
May 6, 2026•

edited

Loading

Copy link


Copy Markdown

👋 Thanks for assigning @tnull as a reviewer!

I'll wait for their review and will help manage the review process.

Once they submit their review, I'll check if a second reviewer would be helpful.
@tankyleo
tankyleo
requested a review
from tnullMay 6, 2026 01:25
tnull
tnull
reviewed
May 6, 2026
View reviewed changes
Comment threadrust/api/src/lib.rs
Outdated

pub mod kv_store;

/// Contains request/response types generated from the API definition of VSS.
#[rustfmt::skip]
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why skip rather than formatting post-generation?
@tankyleotankyleoMay 6, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So that we don't need to run format post-generation ? Happy to drop if you prefer.
@tnulltnullMay 7, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it's always a debate whether to format or not format auto-generated code. I always lean towards yes, others towards no.
In the end it doesn't matter much, so I'd say I'd leave it up to you / your preference. Feel free to leave as-is.
@tankyleotankyleoMay 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I removed the skip and now format this file too.
Comment threadrust/api/build.rs
#[cfg(genproto)]
fn generate_protos() {
	download_file(
 "https://raw.githubusercontent.com/lightningdevkit/vss-server/7f492fcac0c561b212f49ca40f7d16075822440f/app/src/main/proto/vss.proto",
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIU, the original intention here was to pin the protocol version to a specific commit. But you're right that we probably should do that via the new protocol versioning, and proper vss-server tags/releases.
Comment threadrust/api/Cargo.toml

[target.'cfg(genproto)'.build-dependencies]
prost-build = { version = "0.11.3" }
reqwest = { version = "0.11.13", default-features = false, features = ["rustls-tls", "blocking"] }
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉
Comment threadrust/server/src/vss_service.rs
Outdated

 let prefix_stripped_path = path.strip_prefix(BASE_PATH_PREFIX).unwrap_or_default();

 match prefix_stripped_path {
 "/version" => {
@tnulltnullMay 6, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding this endpoint is great, but shouldn't we also add a (I guess optional, for backwards compat) protocol_version field to all other messages? Otherwise, if we require the client to always manually first call this endpoint and wait on the response a) it's error prone b) it would require another full RTT on startup which is not great. So maybe we make version negotiation implicit and only fail the flow on mismatch? Thoughts?
@tankyleotankyleoMay 6, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I add a vss-protocol-version header to every response, clients can read the protocol version from any response they get back from the server.
@tnulltnullMay 7, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool. Now that we did this, maybe the endpoint could be a more general /health or /status endpoint? Or maybe this shouldn't even be a VSS-style proto response but rather a prometheus-compatible endpoint then?
@tankyleotankyleoMay 7, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below, I remove /version, and add /metrics, which offers a prometheus-style gauge for now
@tankyleo
tankyleo
requested a review
from tnullMay 6, 2026 16:44
@tankyleotankyleo
changed the title
Add /version endpointAdd /metrics endpointMay 7, 2026
@tankyleotankyleo
self-assigned this
May 7, 2026
@tankyleotankyleo
moved this to Goal: Merge
in Weekly GoalsMay 7, 2026
@ldk-reviews-bot
ldk-reviews-bot
commented
May 9, 2026

Copy link


Copy Markdown

🔔 1st Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 11, 2026

Copy link


Copy Markdown

🔔 2nd Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 13, 2026

Copy link


Copy Markdown

🔔 3rd Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@tankyleotankyleo
mentioned this pull request
May 13, 2026
 Closed

@ldk-reviews-bot
ldk-reviews-bot
commented
May 16, 2026

Copy link


Copy Markdown

🔔 4th Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
@ldk-reviews-bot
ldk-reviews-bot
commented
May 18, 2026

Copy link


Copy Markdown

🔔 5th Reminder
Hey @tnull! This PR has been waiting for your review.

Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.
tnull
tnull
reviewed
May 18, 2026
View reviewed changes
@tnulltnull
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, feel free to squash.
Comment threadrust/server/src/vss_service.rs
 .header(PROTOCOL_VERSION_HEADER, PROTOCOL_VERSION.as_bytes())
 .body(Full::new(body))
 // unwrap safety: body only errors when previous chained calls failed.
 .unwrap()
@tnulltnullMay 18, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we're touching this, should we avoid the unwrap and start bubbling up the error?
@tankyleotankyleoMay 18, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm so far, I buy the unwrap safety do you not buy it ? I carefully checked all the previous calls, and I don't see any panics possible here.
Comment threadrust/server/src/vss_service.rs
Outdated


const MAXIMUM_REQUEST_BODY_SIZE: usize = 1024 * 1024 * 1024;
const PROTOCOL_VERSION_HEADER: &str = "vss-protocol-version";
const PROTOCOL_VERSION: &str = "0.1.0";
@tnulltnullMay 18, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, protocol version usally are simple integer numbers, given they are only changed if we break the API. Do we think SemVer makes sense here?
@tankyleotankyleoMay 18, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done below thank you
@tankyleo
Read vss.proto from the local repository instead of github
01893d2
We now read `vss.proto` from the local repository instead of downloading
it from a previous commit on github.
We will use protocol versioning, tags, and releases to coordinate
clients and servers.
@tankyleo
Add vss-protocol-version header
0e046d3
Clients will use this header to check the version of the VSS protocol
currently served.
This header is added to all responses from the server. We avoid creating
a new roundtrip to optimize startup time.
@tankyleo
Expose /metrics endpoint
922123e
This endpoint serves as a health check for operators of this VSS
implementation.
The endpoint also exposes a Prometheus gauge metric.
@tankyleo
tankyleoforce-pushed
the
2026-05-health-check
branch
3 times, most recently
from
5b9efbd to
6871771CompareMay 18, 2026 19:19
@tankyleo
tankyleo
commented
May 18, 2026•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Thanks for the review tnull, I appended commit so that the gauge metric now tracks a successful roundtrip to the KvStore backend let me know what you think.
@tankyleo
tankyleo
requested a review
from tnullMay 18, 2026 19:27
@tankyleo
tankyleo
commented
May 18, 2026

Copy link


Copy Markdown

ContributorAuthor
I'm still debating that last commit, as the metrics endpoint is unauthenticated, so with JWTs someone could hit the database for free.
@tankyleo
tankyleoforce-pushed
the
2026-05-health-check
branch
from
6871771 to
922123eCompareMay 18, 2026 19:40
@tankyleo
tankyleo
commented
May 18, 2026•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Ended up dropping it, now only changed to const PROTOCOL_VERSION: &str = "0"; from last review.
tnull
tnull
approved these changes
May 19, 2026
View reviewed changes
@tnulltnull
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I assume versioning support in vss-client is up next?
@tnull
tnull
merged commit f728209
into
lightningdevkit:mainMay 19, 2026

11 of 12 checks passed

@github-project-automationgithub-project-automationBot
moved this from Goal: Merge
to Done
in Weekly GoalsMay 19, 2026
@tankyleo
tankyleo
commented
May 19, 2026

Copy link


Copy Markdown

ContributorAuthor
LGTM, I assume versioning support in vss-client is up next?
Yes thanks for the review
@tankyleotankyleo
mentioned this pull request
Jun 3, 2026

Closed

@tnulltnull
mentioned this pull request
Aug 20, 2026

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@tnulltnulltnull approved these changes

Assignees

@tankyleotankyleo

Labels


None yet


Projects

Weekly Goals

Status: Done


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@tankyleo@ldk-reviews-bot@tnull