rgb-cln/doc/schemas/fundchannel_start.request.json

52 lines
1.4 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"additionalProperties": false,
"required": [
"id",
"amount"
],
"properties": {
"id": {
"type": "pubkey",
"description": "id is the peer id obtained from connect."
},
"amount": {
"type": "msat_or_all",
"description": "The amount that the channel will be funded."
},
"feerate": {
"type": "feerate",
"description": "Sets the feerate for the subsequent commitment transaction."
},
"announce": {
"type": "boolean",
"description": "Whether or not to announce the channel."
},
"close_to": {
"type": "string",
"description": "A bitcoin address to which the channel funds should be sent to on close."
},
"push_msat": {
"type": "msat",
"description": "The amount of millisatoshis to push to the channel at open. This is a gift to the peer."
},
"mindepth": {
"type": "u32",
"description": "Number of confirmations required before we consider the channel active"
},
"reserve": {
"type": "msat",
"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"
}
}
}
}