docs: clarify static address derivation

This commit is contained in:
Slyghtning 2026-08-12 09:43:10 +02:00
parent e9f1b839e4
commit 54e696a080
No known key found for this signature in database
GPG key ID: F82D456EA023C9BF
4 changed files with 16 additions and 4 deletions

View file

@ -15,6 +15,12 @@
`ListReservations`, `InstantOut`, `InstantOutQuote`, or `ListInstantOuts`.
[PR #1194](https://github.com/lightninglabs/loop/pull/1194)
* Calling `NewStaticAddress` without `send_coins_request.addr` now derives and
returns a fresh receive address instead of reusing the address associated
with the client's L402. Integrations must not assume that repeated calls are
idempotent or return the same address.
[PR #1139](https://github.com/lightninglabs/loop/pull/1139)
#### Bug Fixes
* Loop Out requests now account for channel reserves when checking outbound

View file

@ -163,7 +163,9 @@ service SwapClient {
returns (ListInstantOutsResponse);
/* loop: `static newstaticaddress`
NewStaticAddress requests a new static address for loop-ins from the server.
NewStaticAddress derives a fresh static receive address on every request
without send_coins_request.addr, or funds an existing address when addr is
set.
*/
rpc NewStaticAddress (NewStaticAddressRequest)
returns (NewStaticAddressResponse);

View file

@ -870,7 +870,7 @@
},
"/v1/staticaddr": {
"post": {
"summary": "loop: `static newstaticaddress`\nNewStaticAddress requests a new static address for loop-ins from the server.",
"summary": "loop: `static newstaticaddress`\nNewStaticAddress derives a fresh static receive address on every request\nwithout send_coins_request.addr, or funds an existing address when addr is\nset.",
"operationId": "SwapClient_NewStaticAddress",
"responses": {
"200": {

View file

@ -114,7 +114,9 @@ type SwapClientClient interface {
// their current status.
ListInstantOuts(ctx context.Context, in *ListInstantOutsRequest, opts ...grpc.CallOption) (*ListInstantOutsResponse, error)
// loop: `static newstaticaddress`
// NewStaticAddress requests a new static address for loop-ins from the server.
// NewStaticAddress derives a fresh static receive address on every request
// without send_coins_request.addr, or funds an existing address when addr is
// set.
NewStaticAddress(ctx context.Context, in *NewStaticAddressRequest, opts ...grpc.CallOption) (*NewStaticAddressResponse, error)
// loop: `static listunspentdeposits`
// ListUnspentDeposits returns a list of utxos deposited at a static address.
@ -574,7 +576,9 @@ type SwapClientServer interface {
// their current status.
ListInstantOuts(context.Context, *ListInstantOutsRequest) (*ListInstantOutsResponse, error)
// loop: `static newstaticaddress`
// NewStaticAddress requests a new static address for loop-ins from the server.
// NewStaticAddress derives a fresh static receive address on every request
// without send_coins_request.addr, or funds an existing address when addr is
// set.
NewStaticAddress(context.Context, *NewStaticAddressRequest) (*NewStaticAddressResponse, error)
// loop: `static listunspentdeposits`
// ListUnspentDeposits returns a list of utxos deposited at a static address.