mirror/lnd
1
0 Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #3661 from guggero/deprecate-rest-string

Browse Source 
proto: deprecate duplicate string fields in requests
This commit is contained in:
Wilmer Paulino authored and GitHub committed 2019-11-07 10:52:45 -08:00
2 parents 2bec35a3d2 7e9c4f0f87
commit b0dc3b76fd
3 files changed
+760 -646
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

lnrpc/rpc.pb.go
+620 -575
View File
File diff suppressed because it is too large. Load diff
lnrpc/rpc.proto
+100 -33
View File
@@ -94,13 +94,15 @@ service WalletUnlocker {
message GenSeedRequest { message GenSeedRequest {
/** /**
aezeed_passphrase is an optional user provided passphrase that will be used aezeed_passphrase is an optional user provided passphrase that will be used
to encrypt the generated aezeed cipher seed. to encrypt the generated aezeed cipher seed. When using REST, this field
must be encoded as base64.
*/ */
bytes aezeed_passphrase = 1; bytes aezeed_passphrase = 1;
/** /**
seed_entropy is an optional 16-bytes generated via CSPRNG. If not seed_entropy is an optional 16-bytes generated via CSPRNG. If not
specified, then a fresh set of randomness will be used to create the seed. specified, then a fresh set of randomness will be used to create the seed.
When using REST, this field must be encoded as base64.
*/ */
bytes seed_entropy = 2; bytes seed_entropy = 2;
} }
@@ -125,7 +127,8 @@ message InitWalletRequest {
/** /**
wallet_password is the passphrase that should be used to encrypt the wallet_password is the passphrase that should be used to encrypt the
wallet. This MUST be at least 8 chars in length. After creation, this wallet. This MUST be at least 8 chars in length. After creation, this
password is required to unlock the daemon. password is required to unlock the daemon. When using REST, this field
must be encoded as base64.
*/ */
bytes wallet_password = 1; bytes wallet_password = 1;
@@ -138,7 +141,8 @@ message InitWalletRequest {
/** /**
aezeed_passphrase is an optional user provided passphrase that will be used aezeed_passphrase is an optional user provided passphrase that will be used
to encrypt the generated aezeed cipher seed. to encrypt the generated aezeed cipher seed. When using REST, this field
must be encoded as base64.
*/ */
bytes aezeed_passphrase = 3; bytes aezeed_passphrase = 3;
@@ -168,7 +172,7 @@ message UnlockWalletRequest {
/** /**
wallet_password should be the current valid passphrase for the daemon. This wallet_password should be the current valid passphrase for the daemon. This
will be required to decrypt on-disk material that the daemon requires to will be required to decrypt on-disk material that the daemon requires to
function properly. function properly. When using REST, this field must be encoded as base64.
*/ */
bytes wallet_password = 1; bytes wallet_password = 1;
@@ -196,13 +200,13 @@ message UnlockWalletResponse {}
message ChangePasswordRequest { message ChangePasswordRequest {
/** /**
current_password should be the current valid passphrase used to unlock the current_password should be the current valid passphrase used to unlock the
daemon. daemon. When using REST, this field must be encoded as base64.
*/ */
bytes current_password = 1; bytes current_password = 1;
/** /**
new_password should be the new passphrase that will be needed to unlock the new_password should be the new passphrase that will be needed to unlock the
daemon. daemon. When using REST, this field must be encoded as base64.
*/ */
bytes new_password = 2; bytes new_password = 2;
} }
@@ -857,20 +861,32 @@ message FeeLimit {
} }
message SendRequest { message SendRequest {
/// The identity pubkey of the payment recipient /**
The identity pubkey of the payment recipient. When using REST, this field
must be encoded as base64.
*/
bytes dest = 1; bytes dest = 1;
/// The hex-encoded identity pubkey of the payment recipient /**
string dest_string = 2; The hex-encoded identity pubkey of the payment recipient. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.
*/
string dest_string = 2 [deprecated = true];
/// Number of satoshis to send. /// Number of satoshis to send.
int64 amt = 3; int64 amt = 3;
/// The hash to use within the payment's HTLC /**
The hash to use within the payment's HTLC. When using REST, this field
must be encoded as base64.
*/
bytes payment_hash = 4; bytes payment_hash = 4;
/// The hex-encoded hash to use within the payment's HTLC /**
string payment_hash_string = 5; The hex-encoded hash to use within the payment's HTLC. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.
*/
string payment_hash_string = 5 [deprecated = true];
/** /**
A bare-bones invoice for a payment within the Lightning Network. With the A bare-bones invoice for a payment within the Lightning Network. With the
@@ -909,7 +925,8 @@ message SendRequest {
/** /**
An optional field that can be used to pass an arbitrary set of TLV records An optional field that can be used to pass an arbitrary set of TLV records
to a peer which understands the new records. This can be used to pass to a peer which understands the new records. This can be used to pass
application specific data during the payment attempt. application specific data during the payment attempt. When using REST, the
values must be encoded as base64.
*/ */
map<uint64, bytes> dest_tlv = 11; map<uint64, bytes> dest_tlv = 11;
} }
@@ -922,11 +939,17 @@ message SendResponse {
} }
message SendToRouteRequest { message SendToRouteRequest {
/// The payment hash to use for the HTLC. /**
The payment hash to use for the HTLC. When using REST, this field must be
encoded as base64.
*/
bytes payment_hash = 1; bytes payment_hash = 1;
/// An optional hex-encoded payment hash to be used for the HTLC. /**
string payment_hash_string = 2; An optional hex-encoded payment hash to be used for the HTLC. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.
*/
string payment_hash_string = 2 [deprecated = true];
reserved 3; reserved 3;
@@ -988,10 +1011,16 @@ message ChannelAcceptResponse {
message ChannelPoint { message ChannelPoint {
oneof funding_txid { oneof funding_txid {
/// Txid of the funding transaction /**
Txid of the funding transaction. When using REST, this field must be
encoded as base64.
*/
bytes funding_txid_bytes = 1 [json_name = "funding_txid_bytes"]; bytes funding_txid_bytes = 1 [json_name = "funding_txid_bytes"];
/// Hex-encoded string representing the funding transaction /**
Hex-encoded string representing the byte-reversed hash of the funding
transaction.
*/
string funding_txid_str = 2 [json_name = "funding_txid_str"]; string funding_txid_str = 2 [json_name = "funding_txid_str"];
} }
@@ -1109,7 +1138,10 @@ message NewAddressResponse {
} }
message SignMessageRequest { message SignMessageRequest {
/// The message to be signed /**
The message to be signed. When using REST, this field must be encoded as
base64.
*/
bytes msg = 1 [ json_name = "msg" ]; bytes msg = 1 [ json_name = "msg" ];
} }
message SignMessageResponse { message SignMessageResponse {
@@ -1118,7 +1150,10 @@ message SignMessageResponse {
} }
message VerifyMessageRequest { message VerifyMessageRequest {
/// The message over which the signature is to be verified /**
The message over which the signature is to be verified. When using REST,
this field must be encoded as base64.
*/
bytes msg = 1 [ json_name = "msg" ]; bytes msg = 1 [ json_name = "msg" ];
/// The signature to be verified over the given message /// The signature to be verified over the given message
@@ -1506,11 +1541,17 @@ message PendingUpdate {
} }
message OpenChannelRequest { message OpenChannelRequest {
/// The pubkey of the node to open a channel with /**
The pubkey of the node to open a channel with. When using REST, this field
must be encoded as base64.
*/
bytes node_pubkey = 2 [json_name = "node_pubkey"]; bytes node_pubkey = 2 [json_name = "node_pubkey"];
/// The hex encoded pubkey of the node to open a channel with /**
string node_pubkey_string = 3 [json_name = "node_pubkey_string"]; The hex encoded pubkey of the node to open a channel with. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.
*/
string node_pubkey_string = 3 [json_name = "node_pubkey_string", deprecated = true];
/// The number of satoshis the wallet should commit to the channel /// The number of satoshis the wallet should commit to the channel
int64 local_funding_amount = 4 [json_name = "local_funding_amount"]; int64 local_funding_amount = 4 [json_name = "local_funding_amount"];
@@ -1742,7 +1783,8 @@ message QueryRoutesRequest {
FeeLimit fee_limit = 5; FeeLimit fee_limit = 5;
/** /**
A list of nodes to ignore during path finding. A list of nodes to ignore during path finding. When using REST, these fields
must be encoded as base64.
*/ */
repeated bytes ignored_nodes = 6; repeated bytes ignored_nodes = 6;
@@ -1777,10 +1819,16 @@ message QueryRoutesRequest {
} }
message NodePair { message NodePair {
/// The sending node of the pair. /**
The sending node of the pair. When using REST, this field must be encoded as
base64.
*/
bytes from = 1; bytes from = 1;
/// The receiving node of the pair. /**
The receiving node of the pair. When using REST, this field must be encoded
as base64.
*/
bytes to = 2; bytes to = 2;
} }
@@ -2138,11 +2186,15 @@ message Invoice {
/** /**
The hex-encoded preimage (32 byte) which will allow settling an incoming The hex-encoded preimage (32 byte) which will allow settling an incoming
HTLC payable to this preimage HTLC payable to this preimage. When using REST, this field must be encoded
as base64.
*/ */
bytes r_preimage = 3 [json_name = "r_preimage"]; bytes r_preimage = 3 [json_name = "r_preimage"];
/// The hash of the preimage /**
The hash of the preimage. When using REST, this field must be encoded as
base64.
*/
bytes r_hash = 4 [json_name = "r_hash"]; bytes r_hash = 4 [json_name = "r_hash"];
/// The value of this invoice in satoshis /// The value of this invoice in satoshis
@@ -2167,7 +2219,8 @@ message Invoice {
/** /**
Hash (SHA-256) of a description of the payment. Used if the description of Hash (SHA-256) of a description of the payment. Used if the description of
payment (memo) is too long to naturally fit within the description field payment (memo) is too long to naturally fit within the description field
of an encoded payment request. of an encoded payment request. When using REST, this field must be encoded
as base64.
*/ */
bytes description_hash = 10 [json_name = "description_hash"]; bytes description_hash = 10 [json_name = "description_hash"];
@@ -2299,10 +2352,15 @@ message PaymentHash {
/** /**
The hex-encoded payment hash of the invoice to be looked up. The passed The hex-encoded payment hash of the invoice to be looked up. The passed
payment hash must be exactly 32 bytes, otherwise an error is returned. payment hash must be exactly 32 bytes, otherwise an error is returned.
Deprecated now that the REST gateway supports base64 encoding of bytes
fields.
*/ */
string r_hash_str = 1 [json_name = "r_hash_str"]; string r_hash_str = 1 [json_name = "r_hash_str", deprecated = true];
/// The payment hash of the invoice to be looked up. /**
The payment hash of the invoice to be looked up. When using REST, this field
must be encoded as base64.
*/
bytes r_hash = 2 [json_name = "r_hash"]; bytes r_hash = 2 [json_name = "r_hash"];
} }
@@ -2582,7 +2640,8 @@ message ChannelBackup {
/** /**
Is an encrypted single-chan backup. this can be passed to Is an encrypted single-chan backup. this can be passed to
RestoreChannelBackups, or the WalletUnlocker Init and Unlock methods in RestoreChannelBackups, or the WalletUnlocker Init and Unlock methods in
order to trigger the recovery protocol. order to trigger the recovery protocol. When using REST, this field must be
encoded as base64.
*/ */
bytes chan_backup = 2 [ json_name = "chan_backup" ]; bytes chan_backup = 2 [ json_name = "chan_backup" ];
} }
@@ -2596,7 +2655,8 @@ message MultiChanBackup {
/** /**
A single encrypted blob containing all the static channel backups of the A single encrypted blob containing all the static channel backups of the
channel listed above. This can be stored as a single file or blob, and channel listed above. This can be stored as a single file or blob, and
safely be replaced with any prior/future versions. safely be replaced with any prior/future versions. When using REST, this
field must be encoded as base64.
*/ */
bytes multi_chan_backup = 2 [ json_name = "multi_chan_backup" ]; bytes multi_chan_backup = 2 [ json_name = "multi_chan_backup" ];
} }
@@ -2625,8 +2685,15 @@ message ChannelBackups {
message RestoreChanBackupRequest { message RestoreChanBackupRequest {
oneof backup { oneof backup {
/**
The channels to restore as a list of channel/backup pairs.
*/
ChannelBackups chan_backups = 1 [ json_name = "chan_backups" ]; ChannelBackups chan_backups = 1 [ json_name = "chan_backups" ];
/**
The channels to restore in the packed multi backup format. When using
REST, this field must be encoded as base64.
*/
bytes multi_chan_backup = 2 [ json_name = "multi_chan_backup" ]; bytes multi_chan_backup = 2 [ json_name = "multi_chan_backup" ];
} }
} }
lnrpc/rpc.swagger.json
+40 -38
View File
@@ -163,7 +163,7 @@
"parameters": [ "parameters": [
{ {
"name": "channel_point.funding_txid_str", "name": "channel_point.funding_txid_str",
"description": "/ Hex-encoded string representing the funding transaction", "description": "*\nHex-encoded string representing the byte-reversed hash of the funding\ntransaction.",
"in": "path", "in": "path",
"required": true, "required": true,
"type": "string" "type": "string"
@@ -178,7 +178,7 @@
}, },
{ {
"name": "channel_point.funding_txid_bytes", "name": "channel_point.funding_txid_bytes",
"description": "/ Txid of the funding transaction.", "description": "*\nTxid of the funding transaction. When using REST, this field must be\nencoded as base64.",
"in": "query", "in": "query",
"required": false, "required": false,
"type": "string", "type": "string",
@@ -276,7 +276,7 @@
"parameters": [ "parameters": [
{ {
"name": "chan_point.funding_txid_str", "name": "chan_point.funding_txid_str",
"description": "/ Hex-encoded string representing the funding transaction", "description": "*\nHex-encoded string representing the byte-reversed hash of the funding\ntransaction.",
"in": "path", "in": "path",
"required": true, "required": true,
"type": "string" "type": "string"
@@ -291,7 +291,7 @@
}, },
{ {
"name": "chan_point.funding_txid_bytes", "name": "chan_point.funding_txid_bytes",
"description": "/ Txid of the funding transaction.", "description": "*\nTxid of the funding transaction. When using REST, this field must be\nencoded as base64.",
"in": "query", "in": "query",
"required": false, "required": false,
"type": "string", "type": "string",
@@ -450,7 +450,7 @@
"parameters": [ "parameters": [
{ {
"name": "channel_point.funding_txid_str", "name": "channel_point.funding_txid_str",
"description": "/ Hex-encoded string representing the funding transaction", "description": "*\nHex-encoded string representing the byte-reversed hash of the funding\ntransaction.",
"in": "path", "in": "path",
"required": true, "required": true,
"type": "string" "type": "string"
@@ -465,7 +465,7 @@
}, },
{ {
"name": "channel_point.funding_txid_bytes", "name": "channel_point.funding_txid_bytes",
"description": "/ Txid of the funding transaction.", "description": "*\nTxid of the funding transaction. When using REST, this field must be\nencoded as base64.",
"in": "query", "in": "query",
"required": false, "required": false,
"type": "string", "type": "string",
@@ -561,7 +561,7 @@
"parameters": [ "parameters": [
{ {
"name": "aezeed_passphrase", "name": "aezeed_passphrase",
"description": "*\naezeed_passphrase is an optional user provided passphrase that will be used\nto encrypt the generated aezeed cipher seed.", "description": "*\naezeed_passphrase is an optional user provided passphrase that will be used\nto encrypt the generated aezeed cipher seed. When using REST, this field\nmust be encoded as base64.",
"in": "query", "in": "query",
"required": false, "required": false,
"type": "string", "type": "string",
@@ -569,7 +569,7 @@
}, },
{ {
"name": "seed_entropy", "name": "seed_entropy",
"description": "*\nseed_entropy is an optional 16-bytes generated via CSPRNG. If not\nspecified, then a fresh set of randomness will be used to create the seed.", "description": "*\nseed_entropy is an optional 16-bytes generated via CSPRNG. If not\nspecified, then a fresh set of randomness will be used to create the seed.\nWhen using REST, this field must be encoded as base64.",
"in": "query", "in": "query",
"required": false, "required": false,
"type": "string", "type": "string",
@@ -757,7 +757,7 @@
}, },
{ {
"name": "ignored_nodes", "name": "ignored_nodes",
"description": "*\nA list of nodes to ignore during path finding.", "description": "*\nA list of nodes to ignore during path finding. When using REST, these fields\nmust be encoded as base64.",
"in": "query", "in": "query",
"required": false, "required": false,
"type": "array", "type": "array",
@@ -839,14 +839,14 @@
"parameters": [ "parameters": [
{ {
"name": "r_hash_str", "name": "r_hash_str",
"description": "*\nThe hex-encoded payment hash of the invoice to be looked up. The passed\npayment hash must be exactly 32 bytes, otherwise an error is returned.", "description": "*\nThe hex-encoded payment hash of the invoice to be looked up. The passed\npayment hash must be exactly 32 bytes, otherwise an error is returned.\nDeprecated now that the REST gateway supports base64 encoding of bytes\nfields.",
"in": "path", "in": "path",
"required": true, "required": true,
"type": "string" "type": "string"
}, },
{ {
"name": "r_hash", "name": "r_hash",
"description": "/ The payment hash of the invoice to be looked up.", "description": "*\nThe payment hash of the invoice to be looked up. When using REST, this field\nmust be encoded as base64.",
"in": "query", "in": "query",
"required": false, "required": false,
"type": "string", "type": "string",
@@ -1646,12 +1646,12 @@
"current_password": { "current_password": {
"type": "string", "type": "string",
"format": "byte", "format": "byte",
"description": "*\ncurrent_password should be the current valid passphrase used to unlock the\ndaemon." "description": "*\ncurrent_password should be the current valid passphrase used to unlock the\ndaemon. When using REST, this field must be encoded as base64."
}, },
"new_password": { "new_password": {
"type": "string", "type": "string",
"format": "byte", "format": "byte",
"description": "*\nnew_password should be the new passphrase that will be needed to unlock the\ndaemon." "description": "*\nnew_password should be the new passphrase that will be needed to unlock the\ndaemon. When using REST, this field must be encoded as base64."
} }
} }
}, },
@@ -1862,7 +1862,7 @@
"chan_backup": { "chan_backup": {
"type": "string", "type": "string",
"format": "byte", "format": "byte",
"description": "*\nIs an encrypted single-chan backup. this can be passed to\nRestoreChannelBackups, or the WalletUnlocker Init and Unlock methods in\norder to trigger the recovery protocol." "description": "*\nIs an encrypted single-chan backup. this can be passed to\nRestoreChannelBackups, or the WalletUnlocker Init and Unlock methods in\norder to trigger the recovery protocol. When using REST, this field must be\nencoded as base64."
} }
} }
}, },
@@ -2094,11 +2094,11 @@
"funding_txid_bytes": { "funding_txid_bytes": {
"type": "string", "type": "string",
"format": "byte", "format": "byte",
"title": "/ Txid of the funding transaction" "description": "*\nTxid of the funding transaction. When using REST, this field must be\nencoded as base64."
}, },
"funding_txid_str": { "funding_txid_str": {
"type": "string", "type": "string",
"title": "/ Hex-encoded string representing the funding transaction" "description": "*\nHex-encoded string representing the byte-reversed hash of the funding\ntransaction."
}, },
"output_index": { "output_index": {
"type": "integer", "type": "integer",
@@ -2572,7 +2572,7 @@
"wallet_password": { "wallet_password": {
"type": "string", "type": "string",
"format": "byte", "format": "byte",
"description": "*\nwallet_password is the passphrase that should be used to encrypt the\nwallet. This MUST be at least 8 chars in length. After creation, this\npassword is required to unlock the daemon." "description": "*\nwallet_password is the passphrase that should be used to encrypt the\nwallet. This MUST be at least 8 chars in length. After creation, this\npassword is required to unlock the daemon. When using REST, this field\nmust be encoded as base64."
}, },
"cipher_seed_mnemonic": { "cipher_seed_mnemonic": {
"type": "array", "type": "array",
@@ -2584,7 +2584,7 @@
"aezeed_passphrase": { "aezeed_passphrase": {
"type": "string", "type": "string",
"format": "byte", "format": "byte",
"description": "*\naezeed_passphrase is an optional user provided passphrase that will be used\nto encrypt the generated aezeed cipher seed." "description": "*\naezeed_passphrase is an optional user provided passphrase that will be used\nto encrypt the generated aezeed cipher seed. When using REST, this field\nmust be encoded as base64."
}, },
"recovery_window": { "recovery_window": {
"type": "integer", "type": "integer",
@@ -2615,12 +2615,12 @@
"r_preimage": { "r_preimage": {
"type": "string", "type": "string",
"format": "byte", "format": "byte",
"title": "*\nThe hex-encoded preimage (32 byte) which will allow settling an incoming\nHTLC payable to this preimage" "description": "*\nThe hex-encoded preimage (32 byte) which will allow settling an incoming\nHTLC payable to this preimage. When using REST, this field must be encoded\nas base64."
}, },
"r_hash": { "r_hash": {
"type": "string", "type": "string",
"format": "byte", "format": "byte",
"title": "/ The hash of the preimage" "description": "*\nThe hash of the preimage. When using REST, this field must be encoded as\nbase64."
}, },
"value": { "value": {
"type": "string", "type": "string",
@@ -2649,7 +2649,7 @@
"description_hash": { "description_hash": {
"type": "string", "type": "string",
"format": "byte", "format": "byte",
"description": "*\nHash (SHA-256) of a description of the payment. Used if the description of\npayment (memo) is too long to naturally fit within the description field\nof an encoded payment request." "description": "*\nHash (SHA-256) of a description of the payment. Used if the description of\npayment (memo) is too long to naturally fit within the description field\nof an encoded payment request. When using REST, this field must be encoded\nas base64."
}, },
"expiry": { "expiry": {
"type": "string", "type": "string",
@@ -2918,7 +2918,7 @@
"multi_chan_backup": { "multi_chan_backup": {
"type": "string", "type": "string",
"format": "byte", "format": "byte",
"description": "*\nA single encrypted blob containing all the static channel backups of the\nchannel listed above. This can be stored as a single file or blob, and\nsafely be replaced with any prior/future versions." "description": "*\nA single encrypted blob containing all the static channel backups of the\nchannel listed above. This can be stored as a single file or blob, and\nsafely be replaced with any prior/future versions. When using REST, this\nfield must be encoded as base64."
} }
} }
}, },
@@ -3024,12 +3024,12 @@
"from": { "from": {
"type": "string", "type": "string",
"format": "byte", "format": "byte",
"description": "/ The sending node of the pair." "description": "*\nThe sending node of the pair. When using REST, this field must be encoded as\nbase64."
}, },
"to": { "to": {
"type": "string", "type": "string",
"format": "byte", "format": "byte",
"description": "/ The receiving node of the pair." "description": "*\nThe receiving node of the pair. When using REST, this field must be encoded\nas base64."
} }
} }
}, },
@@ -3063,11 +3063,11 @@
"node_pubkey": { "node_pubkey": {
"type": "string", "type": "string",
"format": "byte", "format": "byte",
"title": "/ The pubkey of the node to open a channel with" "description": "*\nThe pubkey of the node to open a channel with. When using REST, this field\nmust be encoded as base64."
}, },
"node_pubkey_string": { "node_pubkey_string": {
"type": "string", "type": "string",
"title": "/ The hex encoded pubkey of the node to open a channel with" "description": "*\nThe hex encoded pubkey of the node to open a channel with. Deprecated now\nthat the REST gateway supports base64 encoding of bytes fields."
}, },
"local_funding_amount": { "local_funding_amount": {
"type": "string", "type": "string",
@@ -3444,11 +3444,13 @@
"type": "object", "type": "object",
"properties": { "properties": {
"chan_backups": { "chan_backups": {
"$ref": "#/definitions/lnrpcChannelBackups" "$ref": "#/definitions/lnrpcChannelBackups",
"description": "*\nThe channels to restore as a list of channel/backup pairs."
}, },
"multi_chan_backup": { "multi_chan_backup": {
"type": "string", "type": "string",
"format": "byte" "format": "byte",
"description": "*\nThe channels to restore in the packed multi backup format. When using\nREST, this field must be encoded as base64."
} }
} }
}, },
@@ -3588,11 +3590,11 @@
"dest": { "dest": {
"type": "string", "type": "string",
"format": "byte", "format": "byte",
"title": "/ The identity pubkey of the payment recipient" "description": "*\nThe identity pubkey of the payment recipient. When using REST, this field\nmust be encoded as base64."
}, },
"dest_string": { "dest_string": {
"type": "string", "type": "string",
"title": "/ The hex-encoded identity pubkey of the payment recipient" "description": "*\nThe hex-encoded identity pubkey of the payment recipient. Deprecated now\nthat the REST gateway supports base64 encoding of bytes fields."
}, },
"amt": { "amt": {
"type": "string", "type": "string",
@@ -3602,11 +3604,11 @@
"payment_hash": { "payment_hash": {
"type": "string", "type": "string",
"format": "byte", "format": "byte",
"title": "/ The hash to use within the payment's HTLC" "description": "*\nThe hash to use within the payment's HTLC. When using REST, this field\nmust be encoded as base64."
}, },
"payment_hash_string": { "payment_hash_string": {
"type": "string", "type": "string",
"title": "/ The hex-encoded hash to use within the payment's HTLC" "description": "*\nThe hex-encoded hash to use within the payment's HTLC. Deprecated now\nthat the REST gateway supports base64 encoding of bytes fields."
}, },
"payment_request": { "payment_request": {
"type": "string", "type": "string",
@@ -3637,7 +3639,7 @@
"type": "string", "type": "string",
"format": "byte" "format": "byte"
}, },
"description": "* \nAn optional field that can be used to pass an arbitrary set of TLV records\nto a peer which understands the new records. This can be used to pass\napplication specific data during the payment attempt." "description": "* \nAn optional field that can be used to pass an arbitrary set of TLV records\nto a peer which understands the new records. This can be used to pass\napplication specific data during the payment attempt. When using REST, the\nvalues must be encoded as base64."
} }
} }
}, },
@@ -3666,11 +3668,11 @@
"payment_hash": { "payment_hash": {
"type": "string", "type": "string",
"format": "byte", "format": "byte",
"description": "/ The payment hash to use for the HTLC." "description": "*\nThe payment hash to use for the HTLC. When using REST, this field must be\nencoded as base64."
}, },
"payment_hash_string": { "payment_hash_string": {
"type": "string", "type": "string",
"description": "/ An optional hex-encoded payment hash to be used for the HTLC." "description": "*\nAn optional hex-encoded payment hash to be used for the HTLC. Deprecated now\nthat the REST gateway supports base64 encoding of bytes fields."
}, },
"route": { "route": {
"$ref": "#/definitions/lnrpcRoute", "$ref": "#/definitions/lnrpcRoute",
@@ -3684,7 +3686,7 @@
"msg": { "msg": {
"type": "string", "type": "string",
"format": "byte", "format": "byte",
"title": "/ The message to be signed" "description": "*\nThe message to be signed. When using REST, this field must be encoded as\nbase64."
} }
} }
}, },
@@ -3767,7 +3769,7 @@
"wallet_password": { "wallet_password": {
"type": "string", "type": "string",
"format": "byte", "format": "byte",
"description": "*\nwallet_password should be the current valid passphrase for the daemon. This\nwill be required to decrypt on-disk material that the daemon requires to\nfunction properly." "description": "*\nwallet_password should be the current valid passphrase for the daemon. This\nwill be required to decrypt on-disk material that the daemon requires to\nfunction properly. When using REST, this field must be encoded as base64."
}, },
"recovery_window": { "recovery_window": {
"type": "integer", "type": "integer",
@@ -3823,7 +3825,7 @@
"msg": { "msg": {
"type": "string", "type": "string",
"format": "byte", "format": "byte",
"title": "/ The message over which the signature is to be verified" "description": "*\nThe message over which the signature is to be verified. When using REST,\nthis field must be encoded as base64."
}, },
"signature": { "signature": {
"type": "string", "type": "string",