lightning/lnd_methods/macaroon/methods.json

Lightning Network client library

{
  "addAdvertisedFeature": {
    "method": "updateNodeAnnouncement",
    "type": "peers"
  },
  "addExternalSocket": {
    "method": "updateNodeAnnouncement",
    "type": "peers"
  },
  "addPeer": {
    "method": "ConnectPeer",
    "type": "default"
  },
  "beginGroupSigningSession": {
    "depends_on": ["getPublicKey"],
    "method": "MuSig2CreateSession",
    "type": "signer"
  },
  "broadcastChainTransaction": {
    "method": "PublishTransaction",
    "type": "wallet"
  },
  "cancelHodlInvoice": {
    "method": "CancelInvoice",
    "type": "invoices"
  },
  "cancelPendingChannel": {
    "method": "FundingStateStep",
    "type": "default"
  },
  "closeChannel": {
    "depends_on": ["addPeer", "getChannel"],
    "method": "CloseChannel",
    "type": "default"
  },
  "connectWatchtower": {
    "method": "AddTower",
    "type": "tower_client"
  },
  "createChainAddress": {
    "depends_on": ["getMasterPublicKeys"],
    "method": "NewAddress",
    "type": "default"
  },
  "createFundedPsbt": {
    "method": "FundPsbt",
    "type": "wallet"
  },
  "createHodlInvoice": {
    "depends_on": ["createChainAddress"],
    "method": "AddHoldInvoice",
    "type": "invoices"
  },
  "createInvoice": {
    "depends_on": ["createChainAddress", "getInvoice"],
    "method": "AddInvoice",
    "type": "default"
  },
  "decodePaymentRequest": {
    "method": "DecodePayReq",
    "type": "default"
  },
  "deleteChainTransaction": {
    "method": "RemoveTransaction",
    "type": "wallet"
  },
  "deleteFailedPayAttempts": {
    "depends_on": ["deletePayment"],
    "method": "DeleteAllPayments",
    "type": "default"
  },
  "deleteFailedPayments": {
    "method": "DeleteAllPayments",
    "type": "default"
  },
  "deleteForwardingReputations": {
    "method": "ResetMissionControl",
    "type": "default"
  },
  "deletePayment": {
    "method": "DeletePayment",
    "type": "default"
  },
  "deletePayments": {
    "method": "DeleteAllPayments",
    "type": "default"
  },
  "deletePendingChannel": {
    "method": "AbandonChannel",
    "type": "default"
  },
  "diffieHellmanComputeSecret": {
    "method": "DeriveSharedKey",
    "type": "signer"
  },
  "disableChannel": {
    "method": "UpdateChanStatus",
    "type": "router"
  },
  "disconnectWatchtower": {
    "method": "RemoveTower",
    "type": "tower_client"
  },
  "enableChannel": {
    "method": "UpdateChanStatus",
    "type": "router"
  },
  "endGroupSigningSession": {
    "methods": ["MuSig2Cleanup", "MuSig2CombineSig"],
    "type": "signer"
  },
  "fundPendingChannels": {
    "method": "FundingStateStep",
    "type": "default"
  },
  "fundPsbt": {
    "method": "FundPsbt",
    "type": "wallet"
  },
  "getAccessIds": {
    "method": "ListMacaroonIDs",
    "type": "default"
  },
  "getAutopilot": {
    "methods": ["QueryScores", "Status"],
    "type": "autopilot"
  },
  "getBackup": {
    "method": "ExportChannelBackup",
    "type": "default"
  },
  "getBackups": {
    "method": "ExportAllChannelBackups",
    "type": "default"
  },
  "getBlock": {
    "methods": ["GetBestBlock", "GetBlock", "GetBlockHash"],
    "type": "blocks"
  },
  "getBlockHeader": {
    "methods": ["GetBestBlock", "GetBlockHash", "GetBlockHeader"],
    "type": "blocks"
  },
  "getChainAddresses": {
    "method": "ListAddresses",
    "type": "wallet"
  },
  "getChainBalance": {
    "method": "WalletBalance",
    "type": "default"
  },
  "getChainFeeEstimate": {
    "method": "EstimateFee",
    "type": "default"
  },
  "getChainFeeRate": {
    "method": "EstimateFee",
    "type": "wallet"
  },
  "getChainTransaction": {
    "method": "GetTransaction",
    "type": "wallet"
  },
  "getChainTransactions": {
    "method": "GetTransactions",
    "type": "default"
  },
  "getChannel": {
    "method": "GetChanInfo",
    "type": "default"
  },
  "getChannelBalance": {
    "method": "ChannelBalance",
    "type": "default"
  },
  "getChannels": {
    "method": "ListChannels",
    "type": "default"
  },
  "getClosedChannels": {
    "method": "ClosedChannels",
    "type": "default"
  },
  "getConfiguration": {
    "method": "GetDebugInfo",
    "type": "default"
  },
  "getConnectedWatchtowers": {
    "methods": ["ListTowers", "Policy", "Stats"],
    "type": "tower_client"
  },
  "getEphemeralChannelIds": {
    "method": "ListAliases",
    "type": "default"
  },
  "getFailedPayments": {
    "method": "ListPayments",
    "type": "default"
  },
  "getFeeRates": {
    "method": "FeeReport",
    "type": "default"
  },
  "getForwardingConfidence": {
    "method": "QueryProbability",
    "type": "router"
  },
  "getForwardingReputations": {
    "method": "QueryProbability",
    "type": "router"
  },
  "getForwards": {
    "method": "ForwardingHistory",
    "type": "default"
  },
  "getHeight": {
    "depends_on": ["getWalletInfo", "subscribeToBlocks"]
  },
  "getIdentity": {
    "depends_on": ["getPublicKey", "getWalletInfo"]
  },
  "getInvoice": {
    "method": "LookupInvoice",
    "type": "default"
  },
  "getInvoices": {
    "method": "ListInvoices",
    "type": "default"
  },
  "getLockedUtxos": {
    "method": "ListLeases",
    "type": "wallet"
  },
  "getMasterPublicKeys": {
    "method": "ListAccounts",
    "type": "wallet"
  },
  "getMethods": {
    "method": "ListPermissions",
    "type": "default"
  },
  "getNetworkCentrality": {
    "method": "GetNodeMetrics",
    "type": "default"
  },
  "getNetworkGraph": {
    "method": "DescribeGraph",
    "type": "default"
  },
  "getNetworkInfo": {
    "method": "GetNetworkInfo",
    "type": "default"
  },
  "getNode": {
    "depends_on": ["getWalletVersion"],
    "method": "GetNodeInfo",
    "type": "default"
  },
  "getPathfindingSettings": {
    "method": "GetMissionControlConfig",
    "type": "router"
  },
  "getPayment": {
    "method": "TrackPaymentV2",
    "type": "router"
  },
  "getPayments": {
    "method": "ListPayments",
    "type": "default"
  },
  "getPeers": {
    "method": "ListPeers",
    "type": "default"
  },
  "getPendingChainBalance": {
    "method": "WalletBalance",
    "type": "default"
  },
  "getPendingChannels": {
    "method": "PendingChannels",
    "type": "default"
  },
  "getPendingPayments": {
    "method": "ListPayments",
    "type": "default"
  },
  "getPendingSweeps": {
    "method": "PendingSweeps",
    "type": "wallet"
  },
  "getPublicKey": {
    "methods": ["DeriveKey", "DeriveNextKey"],
    "type": "wallet"
  },
  "getPublicKey": {
    "methods": ["DeriveKey", "DeriveNextKey"],
    "type": "wallet"
  },
  "getRouteConfidence": {
    "depends_on": [
      "getForwardingConfidence",
      "getForwardingReputations",
      "getIdentity"
    ]
  },
  "getRouteThroughHops": {
    "method": "BuildRoute",
    "type": "router"
  },
  "getRouteToDestination": {
    "depends_on": ["getHeight"],
    "method": "QueryRoutes",
    "type": "default"
  },
  "getRoutingFeeEstimate": {
    "method": "EstimateRouteFee",
    "type": "router"
  },
  "getSettlementStatus": {
    "method": "LookupHtlcResolution",
    "type": "default"
  },
  "getSweepTransactions": {
    "method": "ListSweeps",
    "type": "default"
  },
  "getTowerServerInfo": {
    "method": "GetInfo",
    "type": "tower_server"
  },
  "getUtxos": {
    "method": "ListUnspent",
    "type": "default"
  },
  "getWalletInfo": {
    "method": "GetInfo",
    "type": "default"
  },
  "getWalletStatus": {
    "method": "GetInfo",
    "type": "default"
  },
  "getWalletVersion": {
    "method": "GetVersion",
    "type": "version"
  },
  "grantAccess": {
    "method": "BakeMacaroon",
    "type": "default"
  },
  "isDestinationPayable": {
    "depends_on": ["subscribeToPayViaDetails"]
  },
  "lockUtxo": {
    "method": "LeaseOutput",
    "type": "wallet"
  },
  "openChannel": {
    "method": "OpenChannel",
    "type": "default"
  },
  "openChannels": {
    "method": "OpenChannel",
    "type": "default"
  },
  "partiallySignPsbt": {
    "method": "SignPsbt",
    "type": "wallet"
  },
  "payViaPaymentDetails": {
    "depends_on": ["subscribeToPayViaDetails"]
  },
  "payViaPaymentRequest": {
    "depends_on": ["subscribeToPayViaRequest"]
  },
  "payViaRoutes": {
    "depends_on": ["subscribeToPayViaRoutes"]
  },
  "pay": {
    "depends_on": ["payViaPaymentRequest", "payViaRoutes"]
  },
  "prepareForChannelProposal": {
    "depends_on": ["getPublicKey"],
    "method": "FundingStateStep",
    "type": "default"
  },
  "probeForRoute": {
    "depends_on": ["subscribeToProbeForRoute"]
  },
  "proposeChannel": {
    "depends_on": ["getPublicKey"],
    "method": "OpenChannel",
    "type": "default"
  },
  "recoverFundsFromChannel": {
    "method": "RestoreChannelBackups",
    "type": "default"
  },
  "recoverFundsFromChannels": {
    "method": "restoreChannelBackups",
    "type": "default"
  },
  "removeAdvertisedFeature": {
    "method": "updateNodeAnnouncement",
    "type": "peers"
  },
  "removeExternalSocket": {
    "method": "updateNodeAnnouncement",
    "type": "peers"
  },
  "removePeer": {
    "method": "DisconnectPeer",
    "type": "default"
  },
  "requestBatchedFeeIncrease": {
    "depends_on": ["getHeight"],
    "method": "BumpFee",
    "type": "wallet"
  },
  "requestChainFeeIncrease": {
    "method": "BumpFee",
    "type": "wallet"
  },
  "revokeAccess": {
    "method": "DeleteMacaroonId",
    "type": "default"
  },
  "sendMessageToPeer": {
    "method": "SendCustomMessage",
    "type": "default"
  },
  "sendToChainAddress": {
    "method": "SendCoins",
    "type": "default"
  },
  "sendToChainAddresses": {
    "method": "SendMany",
    "type": "default"
  },
  "sendToChainOutputScripts": {
    "method": "SendOutputs",
    "type": "wallet"
  },
  "setAutopilot": {
    "depends_on": ["getAutopilot"],
    "methods": ["ModifyStatus", "SetScores"],
    "type": "autopilot"
  },
  "settleHodlInvoice": {
    "method": "SettleInvoice",
    "type": "invoices"
  },
  "signBytes": {
    "method": "SignMessage",
    "type": "signer"
  },
  "signChainAddressMessage": {
    "method": "SignMessageWithAddr",
    "type": "wallet"
  },
  "signMessage": {
    "method": "SignMessage",
    "type": "default"
  },
  "signPsbt": {
    "method": "FinalizePsbt",
    "type": "wallet"
  },
  "signTransaction": {
    "method": "SignOutputRaw",
    "type": "signer"
  },
  "stopDaemon": {
    "method": "StopDaemon",
    "type": "default"
  },
  "subscribeToBackups": {
    "method": "SubscribeChannelBackups",
    "type": "default"
  },
  "subscribeToBlocks": {
    "method": "RegisterBlockEpochNtfn",
    "type": "chain"
  },
  "subscribeToChainAddress": {
    "method": "RegisterConfirmationsNtfn",
    "type": "chain"
  },
  "subscribeToChainSpend": {
    "method": "RegisterSpendNtfn",
    "type": "chain"
  },
  "subscribeToChannels": {
    "method": "SubscribeChannelEvents",
    "type": "default"
  },
  "subscribeToForwardRequests": {
    "method": "HtlcInterceptor",
    "type": "router"
  },
  "subscribeToForwards": {
    "method": "SubscribeHtlcEvents",
    "type": "router"
  },
  "subscribeToGraph": {
    "method": "SubscribeChannelGraph",
    "type": "default"
  },
  "subscribeToInvoice": {
    "method": "SubscribeSingleInvoice",
    "type": "invoices"
  },
  "subscribeToInvoices": {
    "method": "SubscribeInvoices",
    "type": "default"
  },
  "subscribeToOpenRequests": {
    "method": "ChannelAcceptor",
    "type": "default"
  },
  "subscribeToPastPayment": {
    "method": "TrackPaymentV2",
    "type": "router"
  },
  "subscribeToPastPayments": {
    "depends_on": ["getPayment"],
    "method": "SubscribeHtlcEvents",
    "type": "router"
  },
  "subscribeToPayViaDetails": {
    "depends_on": ["getHeight"],
    "method": "SendPaymentV2",
    "type": "router"
  },
  "subscribeToPayViaRequest": {
    "depends_on": ["getHeight"],
    "method": "SendPaymentV2",
    "type": "router"
  },
  "subscribeToPayViaRoutes": {
    "depends_on": ["deletePayment"],
    "method": "SendToRouteV2",
    "type": "router"
  },
  "subscribeToPayments": {
    "method": "TrackPayments",
    "type": "router"
  },
  "subscribeToPeerMessages": {
    "method": "SubscribeCustomMessages",
    "type": "default"
  },
  "subscribeToPeers": {
    "method": "SubscribePeerEvents",
    "type": "default"
  },
  "subscribeToProbeForRoute": {
    "depends_on": [
      "getIdentity",
      "getRouteToDestination",
      "subscribeToPayViaRoutes"
    ]
  },
  "subscribeToRpcRequests": {
    "method": "RegisterRPCMiddleware",
    "type": "default"
  },
  "subscribeToTransactions": {
    "method": "SubscribeTransactions",
    "type": "default"
  },
  "unlockUtxo": {
    "method": "releaseOutput",
    "type": "wallet"
  },
  "updateAlias": {
    "method": "updateNodeAnnouncement",
    "type": "peers"
  },
  "updateChainTransaction": {
    "method": "LabelTransaction",
    "type": "wallet"
  },
  "updateColor": {
    "method": "updateNodeAnnouncement",
    "type": "peers"
  },
  "updateConnectedWatchtower": {
    "methods": ["AddTower", "RemoveTower"],
    "type": "tower_client"
  },
  "updateGroupSigningSession": {
    "methods": ["MuSig2RegisterNonces", "MuSig2Sign"],
    "type": "signer"
  },
  "updatePathfindingSettings": {
    "method": "SetMissionControlConfig",
    "type": "router"
  },
  "updateRoutingFees": {
    "method": "UpdateChannelPolicy",
    "type": "default"
  },
  "verifyAccess": {
    "method": "CheckMacaroonPermissions",
    "type": "default"
  },
  "verifyBackup": {
    "method": "VerifyChanBackup",
    "type": "default"
  },
  "verifyBackups": {
    "method": "VerifyChanBackup",
    "type": "default"
  },
  "verifyBytesSignature": {
    "method": "VerifyMessage",
    "type": "signer"
  },
  "verifyChainAddressMessage": {
    "method": "VerifyMessageWithAddr",
    "type": "wallet"
  },
  "verifyMessage": {
    "method": "VerifyMessage",
    "type": "default"
  }
}