Skip to content

Add base REST Client and CLI setup. - #6

Merged
G8XSU merged 10 commits into
lightningdevkit:mainfrom
G8XSU:cli-base-setup
Sep 12, 2024
Merged

Add base REST Client and CLI setup.#6
G8XSU merged 10 commits into
lightningdevkit:mainfrom
G8XSU:cli-base-setup

Conversation

@G8XSU

@G8XSUG8XSU commented Sep 6, 2024

Copy link
Copy Markdown
Contributor
  • Add base REST client setup.
  • Add base cli setup.
  • Add initial set of api methods to rest-client.

@G8XSUG8XSU changed the title [Draft PR] Add base REST Client and CLI setup.Add base REST Client and CLI setup.Sep 10, 2024
@G8XSU
G8XSU requested a review from jkczyzSeptember 10, 2024 22:12
Comment threadcli/Cargo.toml Outdated
Comment threadclient/src/client.rs Outdated
Comment threadclient/src/client.rs
async fn post_request<Rq: Message, Rs: Message + Default>(
&self, request: &Rq, url: &str,
) -> Result<Rs, LdkNodeServerError> {
let request_body = request.encode_to_vec();

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.

Instead of allocating a Vec, should we instead use something like async_prost (https://docs.rs/async-prost/latest/async_prost/) or prost_stream (https://docs.rs/prost-stream/latest/prost_stream/) with Body::wrap_stream (https://docs.rs/reqwest/latest/reqwest/struct.Body.html#method.wrap_stream)? Not sure how reliable those are or if we want to take on the dependencies, though I suppose we could implement TryStream ourselves.

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.

Both of libs aren't maintained at all, prost is maintained by tokio.
Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this.
Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now.
Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that. In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
    It mentions "// The Stream trait isn't stable, so the impl isn't public.".

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.

Both of libs aren't maintained at all, prost is maintained by tokio. Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this. Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now. Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

Fair enough! Thanks for investigating though.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

Which clones are avoided? Or are you saying in another PR?

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
It mentions "// The Stream trait isn't stable, so the impl isn't public.".

Hmm... I see it as an optional feature not unstable.

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.

Which clones are avoided? Or are you saying in another PR?

Yes, mostly while creating these proto objects if we already have access to a byte slice or buffer.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

Reqwest returns Bytes, it will read raw bytes from wire and place them on buffer. if we change generated protos to use Bytes, it can refer to a slice from that buffer, whereas if we use vec it has to clone that part of memory and allocate while converting from slice iiuc.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

Yeah this doesn't change much of anything. It is mostly some minor optimizations that bytes might do internally like buffer allocation/reuse or optimizing storage of small Bytes objects.

Hmm... I see it as an optional feature not unstable.

It was mentioned in code: https://github.com/seanmonstar/reqwest/blame/cf69fd4bfe22855d576497eb94e9eb549e742475/src/async_impl/body.rs#L22
Iiuc, support for streaming as public api was only exposed last week: seanmonstar/reqwest#2255

Comment threadcli/src/main.rs Outdated
Comment threadcli/src/main.rs
Comment threadcli/src/main.rs Outdated
Comment threadclient/src/client.rs
async fn post_request<Rq: Message, Rs: Message + Default>(
&self, request: &Rq, url: &str,
) -> Result<Rs, LdkNodeServerError> {
let request_body = request.encode_to_vec();

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.

Both of libs aren't maintained at all, prost is maintained by tokio. Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this. Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now. Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

Fair enough! Thanks for investigating though.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

Which clones are avoided? Or are you saying in another PR?

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
It mentions "// The Stream trait isn't stable, so the impl isn't public.".

Hmm... I see it as an optional feature not unstable.

Comment threadclient/src/client.rs
@G8XSU
G8XSU requested a review from jkczyzSeptember 12, 2024 17:58

@jkczyzjkczyz 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. Please squash.

@G8XSU

Copy link
Copy Markdown
ContributorAuthor

Rebased on main and squashed.

@G8XSU
G8XSU merged commit 06f986c into lightningdevkit:mainSep 12, 2024
rsafier pushed a commit to rsafier/ldk-server that referenced this pull request Apr 20, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@G8XSU@tnull@jkczyz
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add base REST Client and CLI setup. by G8XSU · Pull Request #6 · lightningdevkit/ldk-server · GitHub
Skip to content

Add base REST Client and CLI setup. - #6

Merged
G8XSU merged 10 commits into
lightningdevkit:mainfrom
G8XSU:cli-base-setup
Sep 12, 2024
Merged

Add base REST Client and CLI setup.#6
G8XSU merged 10 commits into
lightningdevkit:mainfrom
G8XSU:cli-base-setup

Conversation

@G8XSU

@G8XSUG8XSU commented Sep 6, 2024

Copy link
Copy Markdown
Contributor
  • Add base REST client setup.
  • Add base cli setup.
  • Add initial set of api methods to rest-client.

@G8XSUG8XSU changed the title [Draft PR] Add base REST Client and CLI setup.Add base REST Client and CLI setup.Sep 10, 2024
@G8XSU
G8XSU requested a review from jkczyzSeptember 10, 2024 22:12
Comment threadcli/Cargo.toml Outdated
Comment threadclient/src/client.rs Outdated
Comment threadclient/src/client.rs
async fn post_request<Rq: Message, Rs: Message + Default>(
&self, request: &Rq, url: &str,
) -> Result<Rs, LdkNodeServerError> {
let request_body = request.encode_to_vec();

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.

Instead of allocating a Vec, should we instead use something like async_prost (https://docs.rs/async-prost/latest/async_prost/) or prost_stream (https://docs.rs/prost-stream/latest/prost_stream/) with Body::wrap_stream (https://docs.rs/reqwest/latest/reqwest/struct.Body.html#method.wrap_stream)? Not sure how reliable those are or if we want to take on the dependencies, though I suppose we could implement TryStream ourselves.

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.

Both of libs aren't maintained at all, prost is maintained by tokio.
Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this.
Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now.
Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that. In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
    It mentions "// The Stream trait isn't stable, so the impl isn't public.".

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.

Both of libs aren't maintained at all, prost is maintained by tokio. Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this. Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now. Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

Fair enough! Thanks for investigating though.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

Which clones are avoided? Or are you saying in another PR?

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
It mentions "// The Stream trait isn't stable, so the impl isn't public.".

Hmm... I see it as an optional feature not unstable.

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.

Which clones are avoided? Or are you saying in another PR?

Yes, mostly while creating these proto objects if we already have access to a byte slice or buffer.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

Reqwest returns Bytes, it will read raw bytes from wire and place them on buffer. if we change generated protos to use Bytes, it can refer to a slice from that buffer, whereas if we use vec it has to clone that part of memory and allocate while converting from slice iiuc.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

Yeah this doesn't change much of anything. It is mostly some minor optimizations that bytes might do internally like buffer allocation/reuse or optimizing storage of small Bytes objects.

Hmm... I see it as an optional feature not unstable.

It was mentioned in code: https://github.com/seanmonstar/reqwest/blame/cf69fd4bfe22855d576497eb94e9eb549e742475/src/async_impl/body.rs#L22
Iiuc, support for streaming as public api was only exposed last week: seanmonstar/reqwest#2255

Comment threadcli/src/main.rs Outdated
Comment threadcli/src/main.rs
Comment threadcli/src/main.rs Outdated
Comment threadclient/src/client.rs
async fn post_request<Rq: Message, Rs: Message + Default>(
&self, request: &Rq, url: &str,
) -> Result<Rs, LdkNodeServerError> {
let request_body = request.encode_to_vec();

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.

Both of libs aren't maintained at all, prost is maintained by tokio. Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this. Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now. Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

Fair enough! Thanks for investigating though.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

Which clones are avoided? Or are you saying in another PR?

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
It mentions "// The Stream trait isn't stable, so the impl isn't public.".

Hmm... I see it as an optional feature not unstable.

Comment threadclient/src/client.rs
@G8XSU
G8XSU requested a review from jkczyzSeptember 12, 2024 17:58

@jkczyzjkczyz 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. Please squash.

@G8XSU

Copy link
Copy Markdown
ContributorAuthor

Rebased on main and squashed.

@G8XSU
G8XSU merged commit 06f986c into lightningdevkit:mainSep 12, 2024
rsafier pushed a commit to rsafier/ldk-server that referenced this pull request Apr 20, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@G8XSU@tnull@jkczyz
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add base REST Client and CLI setup. by G8XSU · Pull Request #6 · lightningdevkit/ldk-server · GitHub
Skip to content

Add base REST Client and CLI setup. - #6

Merged
G8XSU merged 10 commits into
lightningdevkit:mainfrom
G8XSU:cli-base-setup
Sep 12, 2024
Merged

Add base REST Client and CLI setup.#6
G8XSU merged 10 commits into
lightningdevkit:mainfrom
G8XSU:cli-base-setup

Conversation

@G8XSU

@G8XSUG8XSU commented Sep 6, 2024

Copy link
Copy Markdown
Contributor
  • Add base REST client setup.
  • Add base cli setup.
  • Add initial set of api methods to rest-client.

@G8XSUG8XSU changed the title [Draft PR] Add base REST Client and CLI setup.Add base REST Client and CLI setup.Sep 10, 2024
@G8XSU
G8XSU requested a review from jkczyzSeptember 10, 2024 22:12
Comment threadcli/Cargo.toml Outdated
Comment threadclient/src/client.rs Outdated
Comment threadclient/src/client.rs
async fn post_request<Rq: Message, Rs: Message + Default>(
&self, request: &Rq, url: &str,
) -> Result<Rs, LdkNodeServerError> {
let request_body = request.encode_to_vec();

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.

Instead of allocating a Vec, should we instead use something like async_prost (https://docs.rs/async-prost/latest/async_prost/) or prost_stream (https://docs.rs/prost-stream/latest/prost_stream/) with Body::wrap_stream (https://docs.rs/reqwest/latest/reqwest/struct.Body.html#method.wrap_stream)? Not sure how reliable those are or if we want to take on the dependencies, though I suppose we could implement TryStream ourselves.

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.

Both of libs aren't maintained at all, prost is maintained by tokio.
Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this.
Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now.
Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that. In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
    It mentions "// The Stream trait isn't stable, so the impl isn't public.".

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.

Both of libs aren't maintained at all, prost is maintained by tokio. Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this. Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now. Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

Fair enough! Thanks for investigating though.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

Which clones are avoided? Or are you saying in another PR?

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
It mentions "// The Stream trait isn't stable, so the impl isn't public.".

Hmm... I see it as an optional feature not unstable.

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.

Which clones are avoided? Or are you saying in another PR?

Yes, mostly while creating these proto objects if we already have access to a byte slice or buffer.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

Reqwest returns Bytes, it will read raw bytes from wire and place them on buffer. if we change generated protos to use Bytes, it can refer to a slice from that buffer, whereas if we use vec it has to clone that part of memory and allocate while converting from slice iiuc.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

Yeah this doesn't change much of anything. It is mostly some minor optimizations that bytes might do internally like buffer allocation/reuse or optimizing storage of small Bytes objects.

Hmm... I see it as an optional feature not unstable.

It was mentioned in code: https://github.com/seanmonstar/reqwest/blame/cf69fd4bfe22855d576497eb94e9eb549e742475/src/async_impl/body.rs#L22
Iiuc, support for streaming as public api was only exposed last week: seanmonstar/reqwest#2255

Comment threadcli/src/main.rs Outdated
Comment threadcli/src/main.rs
Comment threadcli/src/main.rs Outdated
Comment threadclient/src/client.rs
async fn post_request<Rq: Message, Rs: Message + Default>(
&self, request: &Rq, url: &str,
) -> Result<Rs, LdkNodeServerError> {
let request_body = request.encode_to_vec();

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.

Both of libs aren't maintained at all, prost is maintained by tokio. Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this. Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now. Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

Fair enough! Thanks for investigating though.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

Which clones are avoided? Or are you saying in another PR?

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
It mentions "// The Stream trait isn't stable, so the impl isn't public.".

Hmm... I see it as an optional feature not unstable.

Comment threadclient/src/client.rs
@G8XSU
G8XSU requested a review from jkczyzSeptember 12, 2024 17:58

@jkczyzjkczyz 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. Please squash.

@G8XSU

Copy link
Copy Markdown
ContributorAuthor

Rebased on main and squashed.

@G8XSU
G8XSU merged commit 06f986c into lightningdevkit:mainSep 12, 2024
rsafier pushed a commit to rsafier/ldk-server that referenced this pull request Apr 20, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

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

Add base REST Client and CLI setup. - #6

Merged
G8XSU merged 10 commits into
lightningdevkit:mainfrom
G8XSU:cli-base-setup
Sep 12, 2024
Merged

Add base REST Client and CLI setup.#6
G8XSU merged 10 commits into
lightningdevkit:mainfrom
G8XSU:cli-base-setup

Conversation

@G8XSU

@G8XSUG8XSU commented Sep 6, 2024

Copy link
Copy Markdown
Contributor
  • Add base REST client setup.
  • Add base cli setup.
  • Add initial set of api methods to rest-client.

@G8XSUG8XSU changed the title [Draft PR] Add base REST Client and CLI setup.Add base REST Client and CLI setup.Sep 10, 2024
@G8XSU
G8XSU requested a review from jkczyzSeptember 10, 2024 22:12
Comment threadcli/Cargo.toml Outdated
Comment threadclient/src/client.rs Outdated
Comment threadclient/src/client.rs
async fn post_request<Rq: Message, Rs: Message + Default>(
&self, request: &Rq, url: &str,
) -> Result<Rs, LdkNodeServerError> {
let request_body = request.encode_to_vec();

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.

Instead of allocating a Vec, should we instead use something like async_prost (https://docs.rs/async-prost/latest/async_prost/) or prost_stream (https://docs.rs/prost-stream/latest/prost_stream/) with Body::wrap_stream (https://docs.rs/reqwest/latest/reqwest/struct.Body.html#method.wrap_stream)? Not sure how reliable those are or if we want to take on the dependencies, though I suppose we could implement TryStream ourselves.

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.

Both of libs aren't maintained at all, prost is maintained by tokio.
Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this.
Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now.
Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that. In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
    It mentions "// The Stream trait isn't stable, so the impl isn't public.".

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.

Both of libs aren't maintained at all, prost is maintained by tokio. Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this. Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now. Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

Fair enough! Thanks for investigating though.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

Which clones are avoided? Or are you saying in another PR?

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
It mentions "// The Stream trait isn't stable, so the impl isn't public.".

Hmm... I see it as an optional feature not unstable.

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.

Which clones are avoided? Or are you saying in another PR?

Yes, mostly while creating these proto objects if we already have access to a byte slice or buffer.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

Reqwest returns Bytes, it will read raw bytes from wire and place them on buffer. if we change generated protos to use Bytes, it can refer to a slice from that buffer, whereas if we use vec it has to clone that part of memory and allocate while converting from slice iiuc.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

Yeah this doesn't change much of anything. It is mostly some minor optimizations that bytes might do internally like buffer allocation/reuse or optimizing storage of small Bytes objects.

Hmm... I see it as an optional feature not unstable.

It was mentioned in code: https://github.com/seanmonstar/reqwest/blame/cf69fd4bfe22855d576497eb94e9eb549e742475/src/async_impl/body.rs#L22
Iiuc, support for streaming as public api was only exposed last week: seanmonstar/reqwest#2255

Comment threadcli/src/main.rs Outdated
Comment threadcli/src/main.rs
Comment threadcli/src/main.rs Outdated
Comment threadclient/src/client.rs
async fn post_request<Rq: Message, Rs: Message + Default>(
&self, request: &Rq, url: &str,
) -> Result<Rs, LdkNodeServerError> {
let request_body = request.encode_to_vec();

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.

Both of libs aren't maintained at all, prost is maintained by tokio. Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this. Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now. Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

Fair enough! Thanks for investigating though.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

Which clones are avoided? Or are you saying in another PR?

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
It mentions "// The Stream trait isn't stable, so the impl isn't public.".

Hmm... I see it as an optional feature not unstable.

Comment threadclient/src/client.rs
@G8XSU
G8XSU requested a review from jkczyzSeptember 12, 2024 17:58

@jkczyzjkczyz 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. Please squash.

@G8XSU

Copy link
Copy Markdown
ContributorAuthor

Rebased on main and squashed.

@G8XSU
G8XSU merged commit 06f986c into lightningdevkit:mainSep 12, 2024
rsafier pushed a commit to rsafier/ldk-server that referenced this pull request Apr 20, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@G8XSU@tnull@jkczyz
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Add base REST Client and CLI setup. by G8XSU · Pull Request #6 · lightningdevkit/ldk-server · GitHub
Skip to content

Add base REST Client and CLI setup. - #6

Merged
G8XSU merged 10 commits into
lightningdevkit:mainfrom
G8XSU:cli-base-setup
Sep 12, 2024
Merged

Add base REST Client and CLI setup.#6
G8XSU merged 10 commits into
lightningdevkit:mainfrom
G8XSU:cli-base-setup

Conversation

@G8XSU

@G8XSUG8XSU commented Sep 6, 2024

Copy link
Copy Markdown
Contributor
  • Add base REST client setup.
  • Add base cli setup.
  • Add initial set of api methods to rest-client.

@G8XSUG8XSU changed the title [Draft PR] Add base REST Client and CLI setup.Add base REST Client and CLI setup.Sep 10, 2024
@G8XSU
G8XSU requested a review from jkczyzSeptember 10, 2024 22:12
Comment threadcli/Cargo.toml Outdated
Comment threadclient/src/client.rs Outdated
Comment threadclient/src/client.rs
async fn post_request<Rq: Message, Rs: Message + Default>(
&self, request: &Rq, url: &str,
) -> Result<Rs, LdkNodeServerError> {
let request_body = request.encode_to_vec();

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.

Instead of allocating a Vec, should we instead use something like async_prost (https://docs.rs/async-prost/latest/async_prost/) or prost_stream (https://docs.rs/prost-stream/latest/prost_stream/) with Body::wrap_stream (https://docs.rs/reqwest/latest/reqwest/struct.Body.html#method.wrap_stream)? Not sure how reliable those are or if we want to take on the dependencies, though I suppose we could implement TryStream ourselves.

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.

Both of libs aren't maintained at all, prost is maintained by tokio.
Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this.
Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now.
Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that. In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
    It mentions "// The Stream trait isn't stable, so the impl isn't public.".

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.

Both of libs aren't maintained at all, prost is maintained by tokio. Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this. Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now. Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

Fair enough! Thanks for investigating though.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

Which clones are avoided? Or are you saying in another PR?

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
It mentions "// The Stream trait isn't stable, so the impl isn't public.".

Hmm... I see it as an optional feature not unstable.

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.

Which clones are avoided? Or are you saying in another PR?

Yes, mostly while creating these proto objects if we already have access to a byte slice or buffer.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

Reqwest returns Bytes, it will read raw bytes from wire and place them on buffer. if we change generated protos to use Bytes, it can refer to a slice from that buffer, whereas if we use vec it has to clone that part of memory and allocate while converting from slice iiuc.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

Yeah this doesn't change much of anything. It is mostly some minor optimizations that bytes might do internally like buffer allocation/reuse or optimizing storage of small Bytes objects.

Hmm... I see it as an optional feature not unstable.

It was mentioned in code: https://github.com/seanmonstar/reqwest/blame/cf69fd4bfe22855d576497eb94e9eb549e742475/src/async_impl/body.rs#L22
Iiuc, support for streaming as public api was only exposed last week: seanmonstar/reqwest#2255

Comment threadcli/src/main.rs Outdated
Comment threadcli/src/main.rs
Comment threadcli/src/main.rs Outdated
Comment threadclient/src/client.rs
async fn post_request<Rq: Message, Rs: Message + Default>(
&self, request: &Rq, url: &str,
) -> Result<Rs, LdkNodeServerError> {
let request_body = request.encode_to_vec();

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.

Both of libs aren't maintained at all, prost is maintained by tokio. Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this. Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now. Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

Fair enough! Thanks for investigating though.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

Which clones are avoided? Or are you saying in another PR?

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
It mentions "// The Stream trait isn't stable, so the impl isn't public.".

Hmm... I see it as an optional feature not unstable.

Comment threadclient/src/client.rs
@G8XSU
G8XSU requested a review from jkczyzSeptember 12, 2024 17:58

@jkczyzjkczyz 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. Please squash.

@G8XSU

Copy link
Copy Markdown
ContributorAuthor

Rebased on main and squashed.

@G8XSU
G8XSU merged commit 06f986c into lightningdevkit:mainSep 12, 2024
rsafier pushed a commit to rsafier/ldk-server that referenced this pull request Apr 20, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@G8XSU@tnull@jkczyz
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add base REST Client and CLI setup. by G8XSU · Pull Request #6 · lightningdevkit/ldk-server · GitHub
Skip to content

Add base REST Client and CLI setup. - #6

Merged
G8XSU merged 10 commits into
lightningdevkit:mainfrom
G8XSU:cli-base-setup
Sep 12, 2024
Merged

Add base REST Client and CLI setup.#6
G8XSU merged 10 commits into
lightningdevkit:mainfrom
G8XSU:cli-base-setup

Conversation

@G8XSU

@G8XSUG8XSU commented Sep 6, 2024

Copy link
Copy Markdown
Contributor
  • Add base REST client setup.
  • Add base cli setup.
  • Add initial set of api methods to rest-client.

@G8XSUG8XSU changed the title [Draft PR] Add base REST Client and CLI setup.Add base REST Client and CLI setup.Sep 10, 2024
@G8XSU
G8XSU requested a review from jkczyzSeptember 10, 2024 22:12
Comment threadcli/Cargo.toml Outdated
Comment threadclient/src/client.rs Outdated
Comment threadclient/src/client.rs
async fn post_request<Rq: Message, Rs: Message + Default>(
&self, request: &Rq, url: &str,
) -> Result<Rs, LdkNodeServerError> {
let request_body = request.encode_to_vec();

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.

Instead of allocating a Vec, should we instead use something like async_prost (https://docs.rs/async-prost/latest/async_prost/) or prost_stream (https://docs.rs/prost-stream/latest/prost_stream/) with Body::wrap_stream (https://docs.rs/reqwest/latest/reqwest/struct.Body.html#method.wrap_stream)? Not sure how reliable those are or if we want to take on the dependencies, though I suppose we could implement TryStream ourselves.

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.

Both of libs aren't maintained at all, prost is maintained by tokio.
Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this.
Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now.
Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that. In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
    It mentions "// The Stream trait isn't stable, so the impl isn't public.".

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.

Both of libs aren't maintained at all, prost is maintained by tokio. Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this. Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now. Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

Fair enough! Thanks for investigating though.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

Which clones are avoided? Or are you saying in another PR?

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
It mentions "// The Stream trait isn't stable, so the impl isn't public.".

Hmm... I see it as an optional feature not unstable.

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.

Which clones are avoided? Or are you saying in another PR?

Yes, mostly while creating these proto objects if we already have access to a byte slice or buffer.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

Reqwest returns Bytes, it will read raw bytes from wire and place them on buffer. if we change generated protos to use Bytes, it can refer to a slice from that buffer, whereas if we use vec it has to clone that part of memory and allocate while converting from slice iiuc.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

Yeah this doesn't change much of anything. It is mostly some minor optimizations that bytes might do internally like buffer allocation/reuse or optimizing storage of small Bytes objects.

Hmm... I see it as an optional feature not unstable.

It was mentioned in code: https://github.com/seanmonstar/reqwest/blame/cf69fd4bfe22855d576497eb94e9eb549e742475/src/async_impl/body.rs#L22
Iiuc, support for streaming as public api was only exposed last week: seanmonstar/reqwest#2255

Comment threadcli/src/main.rs Outdated
Comment threadcli/src/main.rs
Comment threadcli/src/main.rs Outdated
Comment threadclient/src/client.rs
async fn post_request<Rq: Message, Rs: Message + Default>(
&self, request: &Rq, url: &str,
) -> Result<Rs, LdkNodeServerError> {
let request_body = request.encode_to_vec();

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.

Both of libs aren't maintained at all, prost is maintained by tokio. Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this. Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now. Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

Fair enough! Thanks for investigating though.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

Which clones are avoided? Or are you saying in another PR?

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
It mentions "// The Stream trait isn't stable, so the impl isn't public.".

Hmm... I see it as an optional feature not unstable.

Comment threadclient/src/client.rs
@G8XSU
G8XSU requested a review from jkczyzSeptember 12, 2024 17:58

@jkczyzjkczyz 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. Please squash.

@G8XSU

Copy link
Copy Markdown
ContributorAuthor

Rebased on main and squashed.

@G8XSU
G8XSU merged commit 06f986c into lightningdevkit:mainSep 12, 2024
rsafier pushed a commit to rsafier/ldk-server that referenced this pull request Apr 20, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@G8XSU@tnull@jkczyz
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add base REST Client and CLI setup. by G8XSU · Pull Request #6 · lightningdevkit/ldk-server · GitHub
Skip to content

Add base REST Client and CLI setup. - #6

Merged
G8XSU merged 10 commits into
lightningdevkit:mainfrom
G8XSU:cli-base-setup
Sep 12, 2024
Merged

Add base REST Client and CLI setup.#6
G8XSU merged 10 commits into
lightningdevkit:mainfrom
G8XSU:cli-base-setup

Conversation

@G8XSU

@G8XSUG8XSU commented Sep 6, 2024

Copy link
Copy Markdown
Contributor
  • Add base REST client setup.
  • Add base cli setup.
  • Add initial set of api methods to rest-client.

@G8XSUG8XSU changed the title [Draft PR] Add base REST Client and CLI setup.Add base REST Client and CLI setup.Sep 10, 2024
@G8XSU
G8XSU requested a review from jkczyzSeptember 10, 2024 22:12
Comment threadcli/Cargo.toml Outdated
Comment threadclient/src/client.rs Outdated
Comment threadclient/src/client.rs
async fn post_request<Rq: Message, Rs: Message + Default>(
&self, request: &Rq, url: &str,
) -> Result<Rs, LdkNodeServerError> {
let request_body = request.encode_to_vec();

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.

Instead of allocating a Vec, should we instead use something like async_prost (https://docs.rs/async-prost/latest/async_prost/) or prost_stream (https://docs.rs/prost-stream/latest/prost_stream/) with Body::wrap_stream (https://docs.rs/reqwest/latest/reqwest/struct.Body.html#method.wrap_stream)? Not sure how reliable those are or if we want to take on the dependencies, though I suppose we could implement TryStream ourselves.

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.

Both of libs aren't maintained at all, prost is maintained by tokio.
Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this.
Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now.
Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that. In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
    It mentions "// The Stream trait isn't stable, so the impl isn't public.".

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.

Both of libs aren't maintained at all, prost is maintained by tokio. Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this. Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now. Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

Fair enough! Thanks for investigating though.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

Which clones are avoided? Or are you saying in another PR?

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
It mentions "// The Stream trait isn't stable, so the impl isn't public.".

Hmm... I see it as an optional feature not unstable.

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.

Which clones are avoided? Or are you saying in another PR?

Yes, mostly while creating these proto objects if we already have access to a byte slice or buffer.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

Reqwest returns Bytes, it will read raw bytes from wire and place them on buffer. if we change generated protos to use Bytes, it can refer to a slice from that buffer, whereas if we use vec it has to clone that part of memory and allocate while converting from slice iiuc.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

Yeah this doesn't change much of anything. It is mostly some minor optimizations that bytes might do internally like buffer allocation/reuse or optimizing storage of small Bytes objects.

Hmm... I see it as an optional feature not unstable.

It was mentioned in code: https://github.com/seanmonstar/reqwest/blame/cf69fd4bfe22855d576497eb94e9eb549e742475/src/async_impl/body.rs#L22
Iiuc, support for streaming as public api was only exposed last week: seanmonstar/reqwest#2255

Comment threadcli/src/main.rs Outdated
Comment threadcli/src/main.rs
Comment threadcli/src/main.rs Outdated
Comment threadclient/src/client.rs
async fn post_request<Rq: Message, Rs: Message + Default>(
&self, request: &Rq, url: &str,
) -> Result<Rs, LdkNodeServerError> {
let request_body = request.encode_to_vec();

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.

Both of libs aren't maintained at all, prost is maintained by tokio. Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this. Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now. Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

Fair enough! Thanks for investigating though.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

Which clones are avoided? Or are you saying in another PR?

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
It mentions "// The Stream trait isn't stable, so the impl isn't public.".

Hmm... I see it as an optional feature not unstable.

Comment threadclient/src/client.rs
@G8XSU
G8XSU requested a review from jkczyzSeptember 12, 2024 17:58

@jkczyzjkczyz 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. Please squash.

@G8XSU

Copy link
Copy Markdown
ContributorAuthor

Rebased on main and squashed.

@G8XSU
G8XSU merged commit 06f986c into lightningdevkit:mainSep 12, 2024
rsafier pushed a commit to rsafier/ldk-server that referenced this pull request Apr 20, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

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

Add base REST Client and CLI setup. - #6

Merged
G8XSU merged 10 commits into
lightningdevkit:mainfrom
G8XSU:cli-base-setup
Sep 12, 2024
Merged

Add base REST Client and CLI setup.#6
G8XSU merged 10 commits into
lightningdevkit:mainfrom
G8XSU:cli-base-setup

Conversation

@G8XSU

@G8XSUG8XSU commented Sep 6, 2024

Copy link
Copy Markdown
Contributor
  • Add base REST client setup.
  • Add base cli setup.
  • Add initial set of api methods to rest-client.

@G8XSUG8XSU changed the title [Draft PR] Add base REST Client and CLI setup.Add base REST Client and CLI setup.Sep 10, 2024
@G8XSU
G8XSU requested a review from jkczyzSeptember 10, 2024 22:12
Comment threadcli/Cargo.toml Outdated
Comment threadclient/src/client.rs Outdated
Comment threadclient/src/client.rs
async fn post_request<Rq: Message, Rs: Message + Default>(
&self, request: &Rq, url: &str,
) -> Result<Rs, LdkNodeServerError> {
let request_body = request.encode_to_vec();

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.

Instead of allocating a Vec, should we instead use something like async_prost (https://docs.rs/async-prost/latest/async_prost/) or prost_stream (https://docs.rs/prost-stream/latest/prost_stream/) with Body::wrap_stream (https://docs.rs/reqwest/latest/reqwest/struct.Body.html#method.wrap_stream)? Not sure how reliable those are or if we want to take on the dependencies, though I suppose we could implement TryStream ourselves.

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.

Both of libs aren't maintained at all, prost is maintained by tokio.
Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this.
Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now.
Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that. In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
    It mentions "// The Stream trait isn't stable, so the impl isn't public.".

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.

Both of libs aren't maintained at all, prost is maintained by tokio. Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this. Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now. Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

Fair enough! Thanks for investigating though.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

Which clones are avoided? Or are you saying in another PR?

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
It mentions "// The Stream trait isn't stable, so the impl isn't public.".

Hmm... I see it as an optional feature not unstable.

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.

Which clones are avoided? Or are you saying in another PR?

Yes, mostly while creating these proto objects if we already have access to a byte slice or buffer.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

Reqwest returns Bytes, it will read raw bytes from wire and place them on buffer. if we change generated protos to use Bytes, it can refer to a slice from that buffer, whereas if we use vec it has to clone that part of memory and allocate while converting from slice iiuc.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

Yeah this doesn't change much of anything. It is mostly some minor optimizations that bytes might do internally like buffer allocation/reuse or optimizing storage of small Bytes objects.

Hmm... I see it as an optional feature not unstable.

It was mentioned in code: https://github.com/seanmonstar/reqwest/blame/cf69fd4bfe22855d576497eb94e9eb549e742475/src/async_impl/body.rs#L22
Iiuc, support for streaming as public api was only exposed last week: seanmonstar/reqwest#2255

Comment threadcli/src/main.rs Outdated
Comment threadcli/src/main.rs
Comment threadcli/src/main.rs Outdated
Comment threadclient/src/client.rs
async fn post_request<Rq: Message, Rs: Message + Default>(
&self, request: &Rq, url: &str,
) -> Result<Rs, LdkNodeServerError> {
let request_body = request.encode_to_vec();

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.

Both of libs aren't maintained at all, prost is maintained by tokio. Imo, we should stick with the popular and well-used lib for now and piggyback on them improving performance for having future optimizations like this. Since both encode and decode are internal details, we can change them at any time without any breakage, so i am not too worried about this optimization for now. Also, currently our messages have limited size and don't really contain any big blobs, so its upside is limited.

Fair enough! Thanks for investigating though.

  • However it did motivate me to look into some other optimization which is to replace all vec with Bytes, which is easily doable and could avoid some vec clones at some of the places.

Which clones are avoided? Or are you saying in another PR?

  • While in decode, prost has special handling for ref-counted byte buffers, it will not clone them, will return a ref to slice instead. Reqwest already returns ref-counted Bytes as response.

Not sure how this is relevant. Aren't we talking about encoding objects that we've created in memory?

  • Also, I am not sure how much of improvement it is if any, we can send reqwest a Bytes object instead of vec and it can create body from that.

Isn't that just a wrapper around a Vec in how we are using it? Nothing needs to be shared, IIUC.

In the current version of reqwest that we are using, stream trait for body isn't stable iiuc.
It mentions "// The Stream trait isn't stable, so the impl isn't public.".

Hmm... I see it as an optional feature not unstable.

Comment threadclient/src/client.rs
@G8XSU
G8XSU requested a review from jkczyzSeptember 12, 2024 17:58

@jkczyzjkczyz 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. Please squash.

@G8XSU

Copy link
Copy Markdown
ContributorAuthor

Rebased on main and squashed.

@G8XSU
G8XSU merged commit 06f986c into lightningdevkit:mainSep 12, 2024
rsafier pushed a commit to rsafier/ldk-server that referenced this pull request Apr 20, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@G8XSU@tnull@jkczyz