mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-19 09:54:16 +01:00
b327bd30c3
Without this, we have hardly any enforcement. This is why the schema
mistake fixed in the previous patches weren't spotted immediately.
The hard work was done by:
```
$ for f in lightning-*.json; do grep -v '^ "additionalProperties": false,' $f | bagto $f; done
$ for f in lightning-*.json; do sed 's/"properties": {/"additionalProperties": false, "properties": {/' $f | bagto $f; done
$ make fmt-schemas
```
Then checking where 'additionalProperties: true' had been turned to
false (we deliberately use it in some places where there are if
statements in the schema, or occasionally where there can be arbitrary
fields).
[Including doc/rpc-schema-draft.json update by Shahana]
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
262 lines
8.2 KiB
JSON
262 lines
8.2 KiB
JSON
{
|
|
"$schema": "../rpc-schema-draft.json",
|
|
"type": "object",
|
|
"rpc": "fundchannel_start",
|
|
"title": "Command for initiating channel establishment for a lightning channel",
|
|
"description": [
|
|
"`fundchannel_start` is a lower level RPC command. It allows a user to initiate channel establishment with a connected peer.",
|
|
"",
|
|
"Note that the funding transaction MUST NOT be broadcast until after channel establishment has been successfully completed by running `fundchannel_complete`, as the commitment transactions for this channel are not secured until the complete command succeeds. Broadcasting transaction before that can lead to unrecoverable loss of funds."
|
|
],
|
|
"request": {
|
|
"required": [
|
|
"id",
|
|
"amount"
|
|
],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"id": {
|
|
"type": "pubkey",
|
|
"description": [
|
|
"The peer id obtained from connect."
|
|
]
|
|
},
|
|
"amount": {
|
|
"type": "sat",
|
|
"description": [
|
|
"Satoshi value that the channel will be funded at. This value MUST be accurate, otherwise the negotiated commitment transactions will not encompass the correct channel value."
|
|
]
|
|
},
|
|
"feerate": {
|
|
"type": "feerate",
|
|
"description": [
|
|
"Feerate for subsequent commitment transactions: see **fundchannel**. Note that this is ignored for channels with *option_anchors* (we always use a low commitment fee for these)."
|
|
]
|
|
},
|
|
"announce": {
|
|
"type": "boolean",
|
|
"description": [
|
|
"Whether or not to announce this channel."
|
|
]
|
|
},
|
|
"close_to": {
|
|
"type": "string",
|
|
"description": [
|
|
"Bitcoin address to which the channel funds should be sent to on close. Only valid if both peers have negotiated `option_upfront_shutdown_script`. Returns `close_to` set to closing script iff is negotiated."
|
|
]
|
|
},
|
|
"push_msat": {
|
|
"type": "msat",
|
|
"description": [
|
|
"Amount of millisatoshis to push to the channel peer at open. Note that this is a gift to the peer -- these satoshis are added to the initial balance of the peer at channel start and are largely unrecoverable once pushed."
|
|
]
|
|
},
|
|
"mindepth": {
|
|
"type": "u32",
|
|
"description": [
|
|
"Number of confirmations required before we consider the channel active."
|
|
]
|
|
},
|
|
"reserve": {
|
|
"type": "sat",
|
|
"description": [
|
|
"The amount we want the peer to maintain on its side."
|
|
]
|
|
},
|
|
"channel_type": {
|
|
"type": "array",
|
|
"description": [
|
|
"Each bit set in this channel_type."
|
|
],
|
|
"items": {
|
|
"type": "u32",
|
|
"description": [
|
|
"Bit number."
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"pairedWith": [
|
|
[
|
|
"feerate",
|
|
"announce",
|
|
"close_to",
|
|
"push_msat",
|
|
"channel_type",
|
|
"mindepth",
|
|
"reserve"
|
|
]
|
|
]
|
|
},
|
|
"response": {
|
|
"required": [
|
|
"funding_address",
|
|
"scriptpubkey",
|
|
"warning_usage"
|
|
],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"funding_address": {
|
|
"type": "string",
|
|
"description": [
|
|
"The address to send funding to for the channel. DO NOT SEND COINS TO THIS ADDRESS YET."
|
|
]
|
|
},
|
|
"scriptpubkey": {
|
|
"type": "hex",
|
|
"description": [
|
|
"The raw scriptPubkey for the address."
|
|
]
|
|
},
|
|
"channel_type": {
|
|
"type": "object",
|
|
"description": [
|
|
"Channel_type as negotiated with peer."
|
|
],
|
|
"added": "v24.02",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"bits",
|
|
"names"
|
|
],
|
|
"properties": {
|
|
"bits": {
|
|
"type": "array",
|
|
"added": "v24.02",
|
|
"description": [
|
|
"Each bit set in this channel_type."
|
|
],
|
|
"items": {
|
|
"type": "u32",
|
|
"description": [
|
|
"Bit number."
|
|
]
|
|
}
|
|
},
|
|
"names": {
|
|
"type": "array",
|
|
"description": [
|
|
"Feature name for each bit set in this channel_type. Note that *anchors_zero_fee_htlc_tx* is a deprecated synonym for *anchors*."
|
|
],
|
|
"added": "v24.02",
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"static_remotekey/even",
|
|
"anchor_outputs/even",
|
|
"anchors_zero_fee_htlc_tx/even",
|
|
"anchors/even",
|
|
"scid_alias/even",
|
|
"zeroconf/even"
|
|
],
|
|
"description": [
|
|
"Name of feature bit."
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"close_to": {
|
|
"type": "hex",
|
|
"description": [
|
|
"The raw scriptPubkey which mutual close will go to; only present if *close_to* parameter was specified and peer supports `option_upfront_shutdown_script`."
|
|
]
|
|
},
|
|
"warning_usage": {
|
|
"type": "string",
|
|
"description": [
|
|
"A warning not to prematurely broadcast the funding transaction (always present!)."
|
|
]
|
|
},
|
|
"mindepth": {
|
|
"type": "u32",
|
|
"description": [
|
|
"Number of confirmations before we consider the channel active."
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
"On error the returned object will contain `code` and `message` properties, with `code` being one of the following:",
|
|
"",
|
|
"- -32602: If the given parameters are wrong.",
|
|
"- -1: Catchall nonspecific error.",
|
|
"- 300: The amount exceeded the maximum configured funding amount.",
|
|
"- 301: The provided `push_msat` is greater than the provided `amount`.",
|
|
"- 304: Still syncing with bitcoin network",
|
|
"- 305: Peer is not connected.",
|
|
"- 306: Unknown peer id.",
|
|
"- 312: Peer negotiated `option_dual_fund`, must use `openchannel_init` not `fundchannel_start`. (Only if ``experimental-dual-fund` is enabled)"
|
|
],
|
|
"author": [
|
|
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
|
|
],
|
|
"see_also": [
|
|
"lightning-connect(7)",
|
|
"lightning-fundchannel(7)",
|
|
"lightning-multifundchannel(7)",
|
|
"lightning-fundchannel_complete(7)",
|
|
"lightning-fundchannel_cancel(7)",
|
|
"lightning-openchannel_init(7)",
|
|
"lightning-openchannel_update(7)",
|
|
"lightning-openchannel_signed(7)",
|
|
"lightning-openchannel_bump(7)",
|
|
"lightning-openchannel_abort(7)"
|
|
],
|
|
"resources": [
|
|
"Main web site: <https://github.com/ElementsProject/lightning>"
|
|
],
|
|
"examples": [
|
|
{
|
|
"request": {
|
|
"id": "example:fundchannel_start#1",
|
|
"method": "fundchannel_start",
|
|
"params": [
|
|
"027ba5906fad81fcdbb774b4c806eb572b7fac3bee4720b12c44e7f70931d4b7cc",
|
|
16777216
|
|
]
|
|
},
|
|
"response": {
|
|
"funding_address": "bcrt1q5ptrvwlgcldm2ygf3nzsl09zfpp7dmtduqlczer97xvc4x5z5zwsc2ulv4",
|
|
"scriptpubkey": "0020a056363be8c7dbb511098cc50fbca24843e6ed6de03f816465f1998a9a82a09d",
|
|
"channel_type": {
|
|
"bits": [
|
|
12,
|
|
22
|
|
],
|
|
"names": [
|
|
"static_remotekey/even",
|
|
"anchors/even"
|
|
]
|
|
},
|
|
"warning_usage": "The funding transaction MUST NOT be broadcast until after channel establishment has been successfully completed by running `fundchannel_complete`"
|
|
}
|
|
},
|
|
{
|
|
"request": {
|
|
"id": "example:fundchannel_start#2",
|
|
"method": "fundchannel_start",
|
|
"params": {
|
|
"id": "027ba5906fad81fcdbb774b4c806eb572b7fac3bee4720b12c44e7f70931d4b7cc",
|
|
"amount": 16777216
|
|
}
|
|
},
|
|
"response": {
|
|
"funding_address": "bcrt1q4hz6a4gtecfmy8z870cwkq2gzc0t7n9u9pu23689u55ghwewemqsv4v2zs",
|
|
"scriptpubkey": "0020adc5aed50bce13b21c47f3f0eb0148161ebf4cbc2878a8e8e5e5288bbb2ecec1",
|
|
"channel_type": {
|
|
"bits": [
|
|
12,
|
|
22
|
|
],
|
|
"names": [
|
|
"static_remotekey/even",
|
|
"anchors/even"
|
|
]
|
|
},
|
|
"warning_usage": "The funding transaction MUST NOT be broadcast until after channel establishment has been successfully completed by running `fundchannel_complete`"
|
|
}
|
|
}
|
|
]
|
|
}
|