mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-12-28 17:44:47 +01:00
Code Issues Projects Releases Wiki Activity
8f6afedafe
core-lightning/doc/schemas/keysend.request.json

72 lines
1.3 KiB
JSON
Raw Normal View History

grpc: Map `sendonion` and `createonion`
2022-04-01 06:12:45 +02:00
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
doc: set additionalProperties to false in all request schemas. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-04-01 06:12:45 +02:00
"additionalProperties": false,
grpc: Map `sendonion` and `createonion`
2022-04-01 06:12:45 +02:00
"required": [
"destination",
lightningd: change `msatoshi` args to `amount_msat`. This is consistent with our output changes, and increases consistency. It also keeps future sanity checks happy, that we only use JSON msat helpers with '_msat' fields. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Changed: JSON-RPC: `invoice`, `sendonion`, `sendpay`, `pay`, `keysend`, `fetchinvoice`, `sendinvoice`: `msatoshi` argument is now called `amount_msat` to match other fields. Changelog-Deprecated: JSON-RPC: `invoice`, `sendonion`, `sendpay`, `pay`, `keysend`, `fetchinvoice`, `sendinvoice` `msatoshi` (use `amount_msat`)
2022-06-19 09:20:11 +02:00
"amount_msat"
grpc: Map `sendonion` and `createonion`
2022-04-01 06:12:45 +02:00
],
"properties": {
"destination": {
"type": "pubkey"
},
lightningd: change `msatoshi` args to `amount_msat`. This is consistent with our output changes, and increases consistency. It also keeps future sanity checks happy, that we only use JSON msat helpers with '_msat' fields. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Changed: JSON-RPC: `invoice`, `sendonion`, `sendpay`, `pay`, `keysend`, `fetchinvoice`, `sendinvoice`: `msatoshi` argument is now called `amount_msat` to match other fields. Changelog-Deprecated: JSON-RPC: `invoice`, `sendonion`, `sendpay`, `pay`, `keysend`, `fetchinvoice`, `sendinvoice` `msatoshi` (use `amount_msat`)
2022-06-19 09:20:11 +02:00
"amount_msat": {
grpc: Map `sendonion` and `createonion`
2022-04-01 06:12:45 +02:00
"type": "msat"
},
"label": {
"type": "string"
},
"maxfeepercent": {
doc/schemas: fixes for request schemas. Types are fixed, in particular: * rename "OutputDesc" to more consistent "outputdesc". * rename "utxo" to more consistent "outpoint". * it's "boolean" not "bool". * "number" means int or float, usually it should be u32. Specific commands: * close `id` can be by channel id, scid. * close `feerange` is a feerate type. * datastore/deldatastore/listdatastore `key` can be singleton. * delexpiredinvoice: `maxexpirytime` is not required, is a u64. * invoice/delinvoice/listinvoice `label` can be an integer * fundpsbt: many fields are u32 not number (JSON for int or float). * invoice: `msatoshi` can be "any". * invoice: `expiry` has a type (now must be numeric). * invoice: `exposeprivatechannels` can be bool or array of scids. * invoice: `deschashonly` added * keysend: there's no "float" type, use "number" or "u32" etc. * keysend: `routehints` is a valid arg, as is `extratlvs` (EXPERIMENTAL_FEATURES) * listdatastore: `key` is not required. * newaddr: `addresstype` can be "all" * pay: `exemptfee` is "msat", new fields `locaofferid` and `exclude` * sendonion: was mis-formatted, missed `localofferid` and `groupid` fields. * sendpay: add `localofferid` and `groupid` params. * signpsbt: add `signonly` param. * txprepare "outptus" typo. * waitsendpay: add `groupid` and fix `partid` type. * withdraw: `destination` is a bitcoin address, not a pubkey. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-04-01 06:13:34 +02:00
"type": "number"
grpc: Map `sendonion` and `createonion`
2022-04-01 06:12:45 +02:00
},
"retry_for": {
doc/schemas: fixes for request schemas. Types are fixed, in particular: * rename "OutputDesc" to more consistent "outputdesc". * rename "utxo" to more consistent "outpoint". * it's "boolean" not "bool". * "number" means int or float, usually it should be u32. Specific commands: * close `id` can be by channel id, scid. * close `feerange` is a feerate type. * datastore/deldatastore/listdatastore `key` can be singleton. * delexpiredinvoice: `maxexpirytime` is not required, is a u64. * invoice/delinvoice/listinvoice `label` can be an integer * fundpsbt: many fields are u32 not number (JSON for int or float). * invoice: `msatoshi` can be "any". * invoice: `expiry` has a type (now must be numeric). * invoice: `exposeprivatechannels` can be bool or array of scids. * invoice: `deschashonly` added * keysend: there's no "float" type, use "number" or "u32" etc. * keysend: `routehints` is a valid arg, as is `extratlvs` (EXPERIMENTAL_FEATURES) * listdatastore: `key` is not required. * newaddr: `addresstype` can be "all" * pay: `exemptfee` is "msat", new fields `locaofferid` and `exclude` * sendonion: was mis-formatted, missed `localofferid` and `groupid` fields. * sendpay: add `localofferid` and `groupid` params. * signpsbt: add `signonly` param. * txprepare "outptus" typo. * waitsendpay: add `groupid` and fix `partid` type. * withdraw: `destination` is a bitcoin address, not a pubkey. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-04-01 06:13:34 +02:00
"type": "u32"
grpc: Map `sendonion` and `createonion`
2022-04-01 06:12:45 +02:00
},
"maxdelay": {
doc/schemas: fixes for request schemas. Types are fixed, in particular: * rename "OutputDesc" to more consistent "outputdesc". * rename "utxo" to more consistent "outpoint". * it's "boolean" not "bool". * "number" means int or float, usually it should be u32. Specific commands: * close `id` can be by channel id, scid. * close `feerange` is a feerate type. * datastore/deldatastore/listdatastore `key` can be singleton. * delexpiredinvoice: `maxexpirytime` is not required, is a u64. * invoice/delinvoice/listinvoice `label` can be an integer * fundpsbt: many fields are u32 not number (JSON for int or float). * invoice: `msatoshi` can be "any". * invoice: `expiry` has a type (now must be numeric). * invoice: `exposeprivatechannels` can be bool or array of scids. * invoice: `deschashonly` added * keysend: there's no "float" type, use "number" or "u32" etc. * keysend: `routehints` is a valid arg, as is `extratlvs` (EXPERIMENTAL_FEATURES) * listdatastore: `key` is not required. * newaddr: `addresstype` can be "all" * pay: `exemptfee` is "msat", new fields `locaofferid` and `exclude` * sendonion: was mis-formatted, missed `localofferid` and `groupid` fields. * sendpay: add `localofferid` and `groupid` params. * signpsbt: add `signonly` param. * txprepare "outptus" typo. * waitsendpay: add `groupid` and fix `partid` type. * withdraw: `destination` is a bitcoin address, not a pubkey. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-04-01 06:13:34 +02:00
"type": "u32"
grpc: Map `sendonion` and `createonion`
2022-04-01 06:12:45 +02:00
},
"exemptfee": {
"type": "msat"
doc/schemas: fixes for request schemas. Types are fixed, in particular: * rename "OutputDesc" to more consistent "outputdesc". * rename "utxo" to more consistent "outpoint". * it's "boolean" not "bool". * "number" means int or float, usually it should be u32. Specific commands: * close `id` can be by channel id, scid. * close `feerange` is a feerate type. * datastore/deldatastore/listdatastore `key` can be singleton. * delexpiredinvoice: `maxexpirytime` is not required, is a u64. * invoice/delinvoice/listinvoice `label` can be an integer * fundpsbt: many fields are u32 not number (JSON for int or float). * invoice: `msatoshi` can be "any". * invoice: `expiry` has a type (now must be numeric). * invoice: `exposeprivatechannels` can be bool or array of scids. * invoice: `deschashonly` added * keysend: there's no "float" type, use "number" or "u32" etc. * keysend: `routehints` is a valid arg, as is `extratlvs` (EXPERIMENTAL_FEATURES) * listdatastore: `key` is not required. * newaddr: `addresstype` can be "all" * pay: `exemptfee` is "msat", new fields `locaofferid` and `exclude` * sendonion: was mis-formatted, missed `localofferid` and `groupid` fields. * sendpay: add `localofferid` and `groupid` params. * signpsbt: add `signonly` param. * txprepare "outptus" typo. * waitsendpay: add `groupid` and fix `partid` type. * withdraw: `destination` is a bitcoin address, not a pubkey. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-04-01 06:13:34 +02:00
},
"routehints": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"scid",
"feebase",
"feeprop",
"expirydelta"
],
"properties": {
"id": {
"type": "pubkey"
},
"scid": {
"type": "short_channel_id"
},
"feebase": {
"type": "msat"
},
"feeprop": {
"type": "u32"
},
"expirydelta": {
"type": "u16"
}
}
}
}
},
"extratlvs": {
"type": "object",
"additionalProperties": true,
"required": []
grpc: Map `sendonion` and `createonion`
2022-04-01 06:12:45 +02:00
}
}
}
Reference in New Issue Copy Permalink