aljaz/breez-lnd
1
0
Fork 0
mirror of https://github.com/aljazceru/breez-lnd.git synced 2026-01-27 02:04:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

lnrpc: add new PSBT funding step messages

Browse Source
This commit is contained in:
Oliver Gugger
2020-03-31 09:13:13 +02:00
parent f97339c3e8
commit 357f5978ad
3 changed files with 1313 additions and 837 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1964
lnrpc/rpc.pb.go
View File

File diff suppressed because it is too large Load Diff

105
lnrpc/rpc.proto
View File

@@ -1775,6 +1775,28 @@ message PendingUpdate {
uint32 output_index = 2;
}
message ReadyForPsbtFunding {
/**
The P2WSH address of the channel funding multisig address that the below
specified amount in satoshis needs to be sent to.
*/
string funding_address = 1;
/**
The exact amount in satoshis that needs to be sent to the above address to
fund the pending channel.
*/
int64 funding_amount = 2;
/**
A raw PSBT that contains the pending channel output. If a base PSBT was
provided in the PsbtShim, this is the base PSBT with one additional output.
If no base PSBT was specified, this is an otherwise empty PSBT with exactly
one output.
*/
bytes psbt = 3;
}
message OpenChannelRequest {
/**
The pubkey of the node to open a channel with. When using REST, this field
@@ -1846,8 +1868,23 @@ message OpenChannelRequest {
}
message OpenStatusUpdate {
oneof update {
/**
Signals that the channel is now fully negotiated and the funding
transaction published.
*/
PendingUpdate chan_pending = 1;
/**
Signals that the channel's funding transaction has now reached the
required number of confirmations on chain and can be used.
*/
ChannelOpenUpdate chan_open = 3;
/**
Signals that the funding process has been suspended and the construction
of a PSBT that funds the channel PK script is now required.
*/
ReadyForPsbtFunding psbt_fund = 5;
}
/**
@@ -1910,9 +1947,34 @@ message ChanPointShim {
uint32 thaw_height = 6;
}
message PsbtShim {
/**
A unique identifier of 32 random bytes that will be used as the pending
channel ID to identify the PSBT state machine when interacting with it and
on the wire protocol to initiate the funding request.
*/
bytes pending_chan_id = 1;
/**
An optional base PSBT the new channel output will be added to. If this is
non-empty, it must be a binary serialized PSBT.
*/
bytes base_psbt = 2;
}
message FundingShim {
oneof shim {
/**
A channel shim where the channel point was fully constructed outside
of lnd's wallet and the transaction might already be published.
*/
ChanPointShim chan_point_shim = 1;
/**
A channel shim that uses a PSBT to fund and sign the channel funding
transaction.
*/
PsbtShim psbt_shim = 2;
}
}
@@ -1921,17 +1983,56 @@ message FundingShimCancel {
bytes pending_chan_id = 1;
}
message FundingPsbtVerify {
/**
The funded but not yet signed PSBT that sends the exact channel capacity
amount to the PK script returned in the open channel message in a previous
step.
*/
bytes funded_psbt = 1;
/// The pending channel ID of the channel to get the PSBT for.
bytes pending_chan_id = 2;
}
message FundingPsbtFinalize {
/**
The funded PSBT that contains all witness data to send the exact channel
capacity amount to the PK script returned in the open channel message in a
previous step.
*/
bytes signed_psbt = 1;
/// The pending channel ID of the channel to get the PSBT for.
bytes pending_chan_id = 2;
}
message FundingTransitionMsg {
oneof trigger {
/**
The funding shim to regsiter. This should be used before any
The funding shim to register. This should be used before any
channel funding has began by the remote party, as it is intended as a
prepatory step for the full channel funding.
preparatory step for the full channel funding.
*/
FundingShim shim_register = 1;
/// Used to cancel an existing registered funding shim.
FundingShimCancel shim_cancel = 2;
/**
Used to continue a funding flow that was initiated to be executed
through a PSBT. This step verifies that the PSBT contains the correct
outputs to fund the channel.
*/
FundingPsbtVerify psbt_verify = 3;
/**
Used to continue a funding flow that was initiated to be executed
through a PSBT. This step finalizes the funded and signed PSBT, finishes
negotiation with the peer and finally publishes the resulting funding
transaction.
*/
FundingPsbtFinalize psbt_finalize = 4;
}
}

81
lnrpc/rpc.swagger.json
View File

@@ -2825,11 +2825,46 @@
}
}
},
"lnrpcFundingPsbtFinalize": {
"type": "object",
"properties": {
"signed_psbt": {
"type": "string",
"format": "byte",
"description": "*\nThe funded PSBT that contains all witness data to send the exact channel\ncapacity amount to the PK script returned in the open channel message in a\nprevious step."
},
"pending_chan_id": {
"type": "string",
"format": "byte",
"description": "/ The pending channel ID of the channel to get the PSBT for."
}
}
},
"lnrpcFundingPsbtVerify": {
"type": "object",
"properties": {
"funded_psbt": {
"type": "string",
"format": "byte",
"description": "*\nThe funded but not yet signed PSBT that sends the exact channel capacity\namount to the PK script returned in the open channel message in a previous\nstep."
},
"pending_chan_id": {
"type": "string",
"format": "byte",
"description": "/ The pending channel ID of the channel to get the PSBT for."
}
}
},
"lnrpcFundingShim": {
"type": "object",
"properties": {
"chan_point_shim": {
"$ref": "#/definitions/lnrpcChanPointShim"
"$ref": "#/definitions/lnrpcChanPointShim",
"description": "*\nA channel shim where the channel point was fully constructed outside\nof lnd's wallet and the transaction might already be published."
},
"psbt_shim": {
"$ref": "#/definitions/lnrpcPsbtShim",
"description": "*\nA channel shim that uses a PSBT to fund and sign the channel funding\ntransaction."
}
}
},
@@ -3753,10 +3788,16 @@
"type": "object",
"properties": {
"chan_pending": {
"$ref": "#/definitions/lnrpcPendingUpdate"
"$ref": "#/definitions/lnrpcPendingUpdate",
"description": "*\nSignals that the channel is now fully negotiated and the funding\ntransaction published."
},
"chan_open": {
"$ref": "#/definitions/lnrpcChannelOpenUpdate"
"$ref": "#/definitions/lnrpcChannelOpenUpdate",
"description": "*\nSignals that the channel's funding transaction has now reached the\nrequired number of confirmations on chain and can be used."
},
"psbt_fund": {
"$ref": "#/definitions/lnrpcReadyForPsbtFunding",
"description": "*\nSignals that the funding process has been suspended and the construction\nof a PSBT that funds the channel PK script is now required."
},
"pending_chan_id": {
"type": "string",
@@ -4120,6 +4161,21 @@
"lnrpcPolicyUpdateResponse": {
"type": "object"
},
"lnrpcPsbtShim": {
"type": "object",
"properties": {
"pending_chan_id": {
"type": "string",
"format": "byte",
"description": "*\nA unique identifier of 32 random bytes that will be used as the pending\nchannel ID to identify the PSBT state machine when interacting with it and\non the wire protocol to initiate the funding request."
},
"base_psbt": {
"type": "string",
"format": "byte",
"description": "*\nAn optional base PSBT the new channel output will be added to. If this is\nnon-empty, it must be a binary serialized PSBT."
}
}
},
"lnrpcQueryRoutesResponse": {
"type": "object",
"properties": {
@@ -4137,6 +4193,25 @@
}
}
},
"lnrpcReadyForPsbtFunding": {
"type": "object",
"properties": {
"funding_address": {
"type": "string",
"description": "*\nThe P2WSH address of the channel funding multisig address that the below\nspecified amount in satoshis needs to be sent to."
},
"funding_amount": {
"type": "string",
"format": "int64",
"description": "*\nThe exact amount in satoshis that needs to be sent to the above address to\nfund the pending channel."
},
"psbt": {
"type": "string",
"format": "byte",
"description": "*\nA raw PSBT that contains the pending channel output. If a base PSBT was\nprovided in the PsbtShim, this is the base PSBT with one additional output.\nIf no base PSBT was specified, this is an otherwise empty PSBT with exactly\none output."
}
}
},
"lnrpcRestoreBackupResponse": {
"type": "object"
},