machankura/phoenixd_enclave
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(cli) Add PhoenixCliCommand class for convenience

Browse Source 
This abstract class catches errors and echoes a short message
instead of printing a stacktrace. This is especially useful
when the CLI cannot connect to phoenixd (e.g. wrong port). We
can also factorise some of the code.
This commit is contained in:
Dominique Padiou 2024-03-18 19:33:33 +01:00
parent 4b59be44b5
commit 3d37e0adc7
No known key found for this signature in database
GPG Key ID: 574C8C6A1673E987
1 changed files with 82 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

209
src/commonMain/kotlin/fr/acinq/lightning/cli/PhoenixCli.kt
View File

@ -79,161 +79,116 @@ class PhoenixCli : CliktCommand() {
} }
} }
class GetInfo : CliktCommand(name = "getinfo", help = "Show basic info about your node") { abstract class PhoenixCliCommand(val name: String, val help: String, printHelpOnEmptyArgs: Boolean = false) : CliktCommand(name = name, help = help, printHelpOnEmptyArgs = printHelpOnEmptyArgs) {
private val commonOptions by requireObject<HttpConf>() internal val commonOptions by requireObject<HttpConf>()
abstract suspend fun httpRequest(): HttpResponse
override fun run() { override fun run() {
runBlocking { runBlocking {
val res = commonOptions.httpClient.get( try {
url = commonOptions.baseUrl / "getinfo" val res = httpRequest()
) echo(res.bodyAsText())
echo(res.bodyAsText()) } catch (e: Exception) {
} echo("[${this@PhoenixCliCommand.name}] error: ${e.message}")
}
}
class GetBalance : CliktCommand(name = "getbalance", help = "Returns your current balance") {
private val commonOptions by requireObject<HttpConf>()
override fun run() {
runBlocking {
val res = commonOptions.httpClient.get(
url = commonOptions.baseUrl / "getbalance"
)
echo(res.bodyAsText())
}
}
}
class ListChannels : CliktCommand(name = "listchannels", help = "List all channels") {
private val commonOptions by requireObject<HttpConf>()
override fun run() {
runBlocking {
val res = commonOptions.httpClient.get(
url = commonOptions.baseUrl / "listchannels"
)
echo(res.bodyAsText())
}
}
}
class GetOutgoingPayment : CliktCommand(name = "getoutgoingpayment", help = "Get outgoing payment") {
private val commonOptions by requireObject<HttpConf>()
private val uuid by option("--uuid").convert { UUID.fromString(it) }.required()
override fun run() {
runBlocking {
val res = commonOptions.httpClient.get(
url = commonOptions.baseUrl / "payments/outgoing/$uuid"
)
echo(res.bodyAsText())
}
}
}
class GetIncomingPayment : CliktCommand(name = "getincomingpayment", help = "Get incoming payment") {
private val commonOptions by requireObject<HttpConf>()
private val paymentHash by option("--paymentHash", "--h").convert { ByteVector32.fromValidHex(it) }.required()
override fun run() {
runBlocking {
val res = commonOptions.httpClient.get(
url = commonOptions.baseUrl / "payments/incoming/$paymentHash"
)
echo(res.bodyAsText())
}
}
}
class ListIncomingPayments : CliktCommand(name = "listincomingpayments", help = "List incoming payments matching the given externalId") {
private val commonOptions by requireObject<HttpConf>()
private val externalId by option("--externalId", "--eid").required()
override fun run() {
runBlocking {
val res = commonOptions.httpClient.get(
url = commonOptions.baseUrl / "payments/incoming",
) {
url {
parameters.append("externalId", externalId)
}
} }
echo(res.bodyAsText())
} }
} }
} }
class CreateInvoice : CliktCommand(name = "createinvoice", help = "Create a Lightning invoice", printHelpOnEmptyArgs = true) { class GetInfo : PhoenixCliCommand(name = "getinfo", help = "Show basic info about your node") {
private val commonOptions by requireObject<HttpConf>() override suspend fun httpRequest() = commonOptions.httpClient.get(
url = commonOptions.baseUrl / "getinfo"
)
}
class GetBalance : PhoenixCliCommand(name = "getbalance", help = "Returns your current balance") {
override suspend fun httpRequest() = commonOptions.httpClient.get(
url = commonOptions.baseUrl / "getbalance"
)
}
class ListChannels : PhoenixCliCommand(name = "listchannels", help = "List all channels") {
override suspend fun httpRequest() = commonOptions.httpClient.get(
url = commonOptions.baseUrl / "listchannels"
)
}
class GetOutgoingPayment : PhoenixCliCommand(name = "getoutgoingpayment", help = "Get outgoing payment") {
private val uuid by option("--uuid").convert { UUID.fromString(it) }.required()
override suspend fun httpRequest() = commonOptions.httpClient.get(
url = commonOptions.baseUrl / "payments/outgoing/$uuid"
)
}
class GetIncomingPayment : PhoenixCliCommand(name = "getincomingpayment", help = "Get incoming payment") {
private val paymentHash by option("--paymentHash", "--h").convert { ByteVector32.fromValidHex(it) }.required()
override suspend fun httpRequest() = commonOptions.httpClient.get(
url = commonOptions.baseUrl / "payments/incoming/$paymentHash"
)
}
class ListIncomingPayments : PhoenixCliCommand(name = "listincomingpayments", help = "List incoming payments matching the given externalId") {
private val externalId by option("--externalId", "--eid").required()
override suspend fun httpRequest() = commonOptions.httpClient.get(
url = commonOptions.baseUrl / "payments/incoming",
) {
url {
parameters.append("externalId", externalId)
}
}
}
class CreateInvoice : PhoenixCliCommand(name = "createinvoice", help = "Create a Lightning invoice", printHelpOnEmptyArgs = true) {
private val amountSat by option("--amountSat").long() private val amountSat by option("--amountSat").long()
private val description by option("--description", "--desc").required() private val description by option("--description", "--desc").required()
private val externalId by option("--externalId") private val externalId by option("--externalId")
override fun run() { override suspend fun httpRequest() = commonOptions.httpClient.submitForm(
runBlocking { url = (commonOptions.baseUrl / "createinvoice").toString(),
val res = commonOptions.httpClient.submitForm( formParameters = parameters {
url = (commonOptions.baseUrl / "createinvoice").toString(), amountSat?.let { append("amountSat", it.toString()) }
formParameters = parameters { externalId?.let { append("externalId", it) }
amountSat?.let { append("amountSat", it.toString()) } append("description", description)
externalId?.let { append("externalId", it) }
append("description", description)
}
)
echo(res.bodyAsText())
} }
} )
} }
class PayInvoice : CliktCommand(name = "payinvoice", help = "Pay a Lightning invoice", printHelpOnEmptyArgs = true) { class PayInvoice : PhoenixCliCommand(name = "payinvoice", help = "Pay a Lightning invoice", printHelpOnEmptyArgs = true) {
private val commonOptions by requireObject<HttpConf>()
private val amountSat by option("--amountSat").long() private val amountSat by option("--amountSat").long()
private val invoice by option("--invoice").required().check { Bolt11Invoice.read(it).isSuccess } private val invoice by option("--invoice").required().check { Bolt11Invoice.read(it).isSuccess }
override fun run() { override suspend fun httpRequest() = commonOptions.httpClient.submitForm(
runBlocking { url = (commonOptions.baseUrl / "payinvoice").toString(),
val res = commonOptions.httpClient.submitForm( formParameters = parameters {
url = (commonOptions.baseUrl / "payinvoice").toString(), amountSat?.let { append("amountSat", amountSat.toString()) }
formParameters = parameters { append("invoice", invoice)
amountSat?.let { append("amountSat", amountSat.toString()) }
append("invoice", invoice)
}
)
echo(res.bodyAsText())
} }
} )
} }
class SendToAddress : CliktCommand(name = "sendtoaddress", help = "Send to a Bitcoin address", printHelpOnEmptyArgs = true) { class SendToAddress : PhoenixCliCommand(name = "sendtoaddress", help = "Send to a Bitcoin address", printHelpOnEmptyArgs = true) {
private val commonOptions by requireObject<HttpConf>()
private val amountSat by option("--amountSat").long().required() private val amountSat by option("--amountSat").long().required()
private val address by option("--address").required().check { runCatching { Base58Check.decode(it) }.isSuccess || runCatching { Bech32.decodeWitnessAddress(it) }.isSuccess } private val address by option("--address").required().check { runCatching { Base58Check.decode(it) }.isSuccess || runCatching { Bech32.decodeWitnessAddress(it) }.isSuccess }
private val feerateSatByte by option("--feerateSatByte").int().required() private val feerateSatByte by option("--feerateSatByte").int().required()
override fun run() { override suspend fun httpRequest() = commonOptions.httpClient.submitForm(
runBlocking { url = (commonOptions.baseUrl / "sendtoaddress").toString(),
val res = commonOptions.httpClient.submitForm( formParameters = parameters {
url = (commonOptions.baseUrl / "sendtoaddress").toString(), append("amountSat", amountSat.toString())
formParameters = parameters { append("address", address)
append("amountSat", amountSat.toString()) append("feerateSatByte", feerateSatByte.toString())
append("address", address)
append("feerateSatByte", feerateSatByte.toString())
}
)
echo(res.bodyAsText())
} }
} )
} }
class CloseChannel : CliktCommand(name = "closechannel", help = "Close channel", printHelpOnEmptyArgs = true) { class CloseChannel : PhoenixCliCommand(name = "closechannel", help = "Close channel", printHelpOnEmptyArgs = true) {
private val commonOptions by requireObject<HttpConf>()
private val channelId by option("--channelId").convert { ByteVector32.fromValidHex(it) }.required() private val channelId by option("--channelId").convert { ByteVector32.fromValidHex(it) }.required()
private val address by option("--address").required().check { runCatching { Base58Check.decode(it) }.isSuccess || runCatching { Bech32.decodeWitnessAddress(it) }.isSuccess } private val address by option("--address").required().check { runCatching { Base58Check.decode(it) }.isSuccess || runCatching { Bech32.decodeWitnessAddress(it) }.isSuccess }
private val feerateSatByte by option("--feerateSatByte").int().required() private val feerateSatByte by option("--feerateSatByte").int().required()
override fun run() { override suspend fun httpRequest() = commonOptions.httpClient.submitForm(
runBlocking { url = (commonOptions.baseUrl / "closechannel").toString(),
val res = commonOptions.httpClient.submitForm( formParameters = parameters {
url = (commonOptions.baseUrl / "closechannel").toString(), append("channelId", channelId.toHex())
formParameters = parameters { append("address", address)
append("channelId", channelId.toHex()) append("feerateSatByte", feerateSatByte.toString())
append("address", address)
append("feerateSatByte", feerateSatByte.toString())
}
)
echo(res.bodyAsText())
} }
} )
} }
operator fun Url.div(path: String) = Url(URLBuilder(this).appendPathSegments(path)) operator fun Url.div(path: String) = Url(URLBuilder(this).appendPathSegments(path))